@vouchfor/embeds 0.0.0-experiment.af36011 → 0.0.0-experiment.b192b60

package/src/components/Embed/controllers/tracking.ts

@@ -1,306 +0,0 @@
-/* eslint-disable max-lines */
-import { v4 as uuidv4 } from 'uuid';
-
-import type { Embed } from '..';
-import type { VideoEventDetail } from '@vouchfor/media-player';
-import type { ReactiveController, ReactiveControllerHost } from 'lit';
-
-import { getEnvUrls } from '~/utils/env';
-
-const STREAMED_THROTTLE = 10000;
-
-type EmbedHost = ReactiveControllerHost & Embed;
-
-type TrackingEvent = 'VOUCH_LOADED' | 'VOUCH_RESPONSE_VIEWED' | 'VIDEO_PLAYED' | 'VIDEO_STREAMED';
-type TrackingPayload = {
-  vouchId: string;
-  answerId?: string;
-  streamStart?: number;
-  streamEnd?: number;
-};
-
-type TimeMap = {
-  [key: string]: number;
-};
-
-type BooleanMap = {
-  [key: string]: boolean;
-};
-
-class TrackingController implements ReactiveController {
-  host: EmbedHost;
-
-  private _tabId: string | undefined = undefined;
-  private _clientId: string | undefined = undefined;
-  private _visitorId: string | undefined = undefined;
-
-  private _hasPlayed = false;
-  private _hasLoaded: BooleanMap = {};
-  private _answersViewed: BooleanMap = {};
-  private _streamedTime: TimeMap = {};
-  private _streamLatestTime: TimeMap = {};
-  private _streamedPrevTimestamp: TimeMap = {};
-
-  constructor(host: EmbedHost) {
-    this.host = host;
-    host.addController(this);
-  }
-
-  private _findVouchId() {
-    if (this.host.vouch) {
-      if ('uuid' in this.host.vouch) {
-        return this.host.vouch.uuid;
-      }
-      return this.host.vouch.id;
-    }
-  }
-
-  private _createVisitor = (visitorId: string) => {
-    const { publicApiUrl } = getEnvUrls(this.host.env);
-    window.localStorage?.setItem?.('vouch-uid-visitor', visitorId);
-    navigator.sendBeacon(`${publicApiUrl}/api/visitor`, JSON.stringify({ visitorId }));
-    return visitorId;
-  };
-
-  private _getUids() {
-    if (typeof window === 'undefined') {
-      return {
-        client: null,
-        tab: null,
-        request: uuidv4()
-      };
-    }
-
-    // Persisted for a user for the same device + browser, so we can e.g. search for all logs related to that browser
-    const visitorId =
-      this._visitorId || window.localStorage?.getItem?.('vouch-uid-visitor') || this._createVisitor(uuidv4());
-    // Persisted for a user for the same device + browser, so we can e.g. search for all logs related to that browser
-    const clientId = this._clientId || window.localStorage?.getItem?.('vouch-uid-client') || uuidv4();
-    // Persisted in session storage, so we can search for everything the user has done in a specific tab
-    const tabId = this._tabId || window.sessionStorage?.getItem?.('vouch-uid-tab') || uuidv4();
-    // Not persisted, allows us to search for any logs related to a single FE request
-    // E.g. BE should pass this request ID through all other services to be able to group logs
-    const requestId = uuidv4();
-
-    // Cache and persist uids
-    if (visitorId !== this._visitorId) {
-      this._visitorId = visitorId;
-      window.localStorage?.setItem?.('vouch-uid-visitor', visitorId);
-    }
-
-    if (clientId !== this._clientId) {
-      this._clientId = clientId;
-      window.localStorage?.setItem?.('vouch-uid-client', clientId);
-    }
-
-    if (tabId !== this._tabId) {
-      this._tabId = tabId;
-      window.sessionStorage?.setItem?.('vouch-uid-tab', tabId);
-    }
-
-    return {
-      client: clientId,
-      tab: tabId,
-      request: requestId,
-      visitor: visitorId
-    };
-  }
-
-  private _getReportingMetadata = () => {
-    const [country, region] = Intl.DateTimeFormat().resolvedOptions().timeZone?.split?.('/') ?? [];
-
-    const utmParams: any = {};
-    [...new URLSearchParams(location.search).entries()].forEach(([key, value]) => {
-      if (/utm/.test(key)) {
-        const param = key.toLowerCase().replace(/[-_][a-z0-9]/g, (group) => group.slice(-1).toUpperCase());
-        utmParams[param] = value;
-      }
-    });
-
-    return {
-      source: this.host.trackingSource,
-      time: new Date(),
-      region,
-      country,
-      screenHeight: window.screen.height,
-      screenWidth: window.screen.width,
-      referrer: document.referrer,
-      currentUrl: location.href,
-      ...utmParams
-    };
-  };
-
-  private _sendTrackingEvent = (event: TrackingEvent, payload: TrackingPayload) => {
-    const { publicApiUrl } = getEnvUrls(this.host.env);
-    const { client, tab, request, visitor } = this._getUids();
-
-    if (this.host.disableTracking) {
-      return;
-    }
-
-    navigator.sendBeacon(
-      `${publicApiUrl}/api/events`,
-      JSON.stringify({
-        event,
-        payload,
-        context: {
-          'x-uid-client': client,
-          'x-uid-tab': tab,
-          'x-uid-request': request,
-          'x-uid-visitor': visitor,
-          'x-reporting-metadata': this._getReportingMetadata()
-        }
-      })
-    );
-  };
-
-  private _handleVouchLoaded = ({ detail: vouchId }: CustomEvent<string>) => {
-    if (!vouchId) {
-      return;
-    }
-
-    // Only send loaded event once per session
-    if (!this._hasLoaded[vouchId]) {
-      this._sendTrackingEvent('VOUCH_LOADED', {
-        vouchId
-      });
-      this._hasLoaded[vouchId] = true;
-    }
-  };
-
-  private _handlePlay = () => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    // Only send the video played event once per session
-    if (!this._hasPlayed) {
-      this._sendTrackingEvent('VIDEO_PLAYED', {
-        vouchId,
-        streamStart: this.host.currentTime
-      });
-      this._hasPlayed = true;
-    }
-  };
-
-  private _handleVideoPlay = ({ detail: { id, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    // Only increment play count once per session
-    if (!this._answersViewed[id]) {
-      this._sendTrackingEvent('VOUCH_RESPONSE_VIEWED', {
-        vouchId,
-        answerId: id
-      });
-      this._answersViewed[id] = true;
-    }
-
-    this._streamedTime[id] = node.currentTime;
-    this._streamLatestTime[id] = node.currentTime;
-    this._streamedPrevTimestamp[id] = Date.now();
-  };
-
-  private _handleVideoSeeking = ({ detail: { id } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    if (this._streamLatestTime[id]) {
-      this._sendTrackingEvent('VIDEO_STREAMED', {
-        vouchId,
-        answerId: id,
-        streamStart: this._streamedTime[id],
-        streamEnd: this._streamLatestTime[id]
-      });
-    }
-
-    delete this._streamedTime[id];
-    delete this._streamLatestTime[id];
-    delete this._streamedPrevTimestamp[id];
-  };
-
-  private _handleVideoTimeUpdate = ({ detail: { id, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    const currentTimestamp = Date.now();
-    if (
-      node.currentTime &&
-      !node.paused &&
-      !this.host.paused &&
-      // Only fire the video seeked event when this video is the active one
-      id === this.host.scene?.video?.id &&
-      // Throttle the frequency that we send streamed events while playing
-      currentTimestamp - this._streamedPrevTimestamp[id] > STREAMED_THROTTLE
-    ) {
-      this._sendTrackingEvent('VIDEO_STREAMED', {
-        vouchId,
-        answerId: id,
-        streamStart: this._streamedTime[id],
-        streamEnd: node.currentTime
-      });
-      this._streamedTime[id] = node.currentTime;
-      this._streamedPrevTimestamp[id] = currentTimestamp;
-    }
-
-    this._streamLatestTime[id] = node.currentTime;
-  };
-
-  private _handleVideoPause = ({ detail: { id, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    // Don't send a tracking event if the video pauses when seeking backwards
-    if (node.currentTime > this._streamedTime[id]) {
-      // Send a video streamed event any time the video pauses then reset the streamed state
-      // We do this to capture the last bit of time that the video was played between the previous
-      // stream event and the video being paused manually or stopping because it ended
-      this._sendTrackingEvent('VIDEO_STREAMED', {
-        vouchId,
-        answerId: id,
-        streamStart: this._streamedTime[id],
-        streamEnd: node.currentTime
-      });
-    }
-
-    delete this._streamedTime[id];
-    delete this._streamLatestTime[id];
-    delete this._streamedPrevTimestamp[id];
-  };
-
-  hostConnected() {
-    requestAnimationFrame(() => {
-      this.host.addEventListener('vouch:loaded', this._handleVouchLoaded);
-      this.host.mediaPlayer?.addEventListener('play', this._handlePlay);
-      this.host.mediaPlayer?.addEventListener('video:play', this._handleVideoPlay);
-      this.host.mediaPlayer?.addEventListener('video:seeking', this._handleVideoSeeking);
-      this.host.mediaPlayer?.addEventListener('video:pause', this._handleVideoPause);
-      this.host.mediaPlayer?.addEventListener('video:timeupdate', this._handleVideoTimeUpdate);
-    });
-  }
-
-  hostDisconnected() {
-    this.host.removeEventListener('vouch:loaded', this._handleVouchLoaded);
-    this.host.mediaPlayer?.removeEventListener('play', this._handlePlay);
-    this.host.mediaPlayer?.removeEventListener('video:play', this._handleVideoPlay);
-    this.host.mediaPlayer?.removeEventListener('video:seeking', this._handleVideoSeeking);
-    this.host.mediaPlayer?.removeEventListener('video:pause', this._handleVideoPause);
-    this.host.mediaPlayer?.removeEventListener('video:timeupdate', this._handleVideoTimeUpdate);
-  }
-}
-
-export { TrackingController };

package/src/components/Embed/index.ts

@@ -1,202 +0,0 @@
-import { html, LitElement } from 'lit';
-import { customElement, property, state } from 'lit/decorators.js';
-import { ifDefined } from 'lit/directives/if-defined.js';
-import { createRef, ref } from 'lit/directives/ref.js';
-
-import type { Scene, TemplateInstance } from '@vouchfor/canvas-video';
-import type { MediaPlayer, MediaPlayerProps } from '@vouchfor/media-player';
-import type { Ref } from 'lit/directives/ref.js';
-import type { Environment } from '~/utils/env';
-
-import { EventForwardController } from './controllers/event-forwarder';
-import { FetcherController } from './controllers/fetcher';
-import { TrackingController } from './controllers/tracking';
-
-import '@vouchfor/media-player';
-
-type EmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
-  env: Environment;
-  apiKey: string;
-  disableTracking?: boolean;
-  trackingSource?: string;
-  vouchId?: string;
-  templateId?: string;
-};
-
-@customElement('vouch-embed')
-class Embed extends LitElement {
-  private _mediaPlayerRef: Ref<MediaPlayer> = createRef();
-
-  @property({ type: Object, attribute: 'data' }) data: EmbedProps['data'];
-  @property({ type: String }) vouchId: EmbedProps['vouchId'];
-  @property({ type: String }) templateId: EmbedProps['templateId'];
-
-  @property({ type: String }) env: EmbedProps['env'] = 'prod';
-  @property({ type: String }) apiKey: EmbedProps['apiKey'] = '';
-  @property({ type: Boolean }) disableTracking: EmbedProps['disableTracking'] = false;
-  @property({ type: String }) trackingSource: EmbedProps['trackingSource'] = 'embed';
-
-  @property({ type: Array }) controls: EmbedProps['controls'];
-  @property({ type: String }) preload: EmbedProps['preload'] = 'auto';
-  @property({ type: Boolean }) autoplay: EmbedProps['autoplay'] = false;
-  @property({ type: Number }) aspectRatio: EmbedProps['aspectRatio'] = 0;
-
-  private eventController = new EventForwardController(this, [
-    'durationchange',
-    'ended',
-    'error',
-    'loadeddata',
-    'pause',
-    'stalled',
-    'play',
-    'playing',
-    'ratechange',
-    'scenechange',
-    'seeking',
-    'seeked',
-    'timeupdate',
-    'volumechange',
-    'waiting',
-
-    'video:loadeddata',
-    'video:seeking',
-    'video:seeked',
-    'video:play',
-    'video:playing',
-    'video:pause',
-    'video:stalled',
-    'video:timeupdate',
-    'video:ended',
-    'video:error'
-  ]);
-  private _fetcherController = new FetcherController(this);
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  private _trackingController = new TrackingController(this);
-
-  @state() vouch: EmbedProps['data'];
-  @state() template: TemplateInstance | undefined;
-
-  get fetching() {
-    return this._fetcherController.fetching;
-  }
-
-  get waiting() {
-    return this._mediaPlayerRef.value?.waiting;
-  }
-
-  get seeking() {
-    return this._mediaPlayerRef.value?.seeking;
-  }
-
-  get paused() {
-    return this._mediaPlayerRef.value?.paused;
-  }
-
-  get captions() {
-    return this._mediaPlayerRef.value?.captions;
-  }
-
-  get fullscreen() {
-    return this._mediaPlayerRef.value?.fullscreen;
-  }
-
-  get duration() {
-    return this._mediaPlayerRef.value?.duration;
-  }
-
-  set currentTime(value: number) {
-    if (this._mediaPlayerRef.value) {
-      this._mediaPlayerRef.value.currentTime = value;
-    }
-  }
-  get currentTime() {
-    return this._mediaPlayerRef.value?.currentTime ?? 0;
-  }
-
-  set playbackRate(value: number) {
-    if (this._mediaPlayerRef.value) {
-      this._mediaPlayerRef.value.playbackRate = value;
-    }
-  }
-  get playbackRate() {
-    return this._mediaPlayerRef.value?.playbackRate ?? 1;
-  }
-
-  set volume(value: number) {
-    if (this._mediaPlayerRef.value) {
-      this._mediaPlayerRef.value.volume = value;
-    }
-  }
-  get volume() {
-    return this._mediaPlayerRef.value?.volume ?? 1;
-  }
-
-  set muted(value: boolean) {
-    if (this._mediaPlayerRef.value) {
-      this._mediaPlayerRef.value.muted = value;
-    }
-  }
-  get muted() {
-    return this._mediaPlayerRef.value?.muted ?? false;
-  }
-
-  get scene(): Scene | null {
-    return this._mediaPlayerRef.value?.scene ?? null;
-  }
-
-  get scenes(): Scene[] {
-    return this._mediaPlayerRef.value?.scenes ?? [];
-  }
-
-  get videoState() {
-    return this._mediaPlayerRef.value?.videoState;
-  }
-
-  get mediaPlayer() {
-    return this._mediaPlayerRef.value;
-  }
-
-  play() {
-    this._mediaPlayerRef.value?.play();
-  }
-
-  pause() {
-    this._mediaPlayerRef.value?.pause();
-  }
-
-  setScene(index: number) {
-    this._mediaPlayerRef.value?.setScene(index);
-  }
-
-  render() {
-    return html`
-      <vmp-new-media-player
-        ${ref(this._mediaPlayerRef)}
-        ${this.eventController.register()}
-        ?autoplay=${this.autoplay}
-        ?loading=${this.fetching}
-        .data=${this.vouch}
-        .template=${this.template}
-        aspectRatio=${ifDefined(this.aspectRatio)}
-        preload=${ifDefined(this.preload)}
-        .controls=${this.controls}
-      ></vmp-new-media-player>
-    `;
-  }
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'vouch-embed': Embed;
-  }
-
-  namespace JSX {
-    interface IntrinsicElements {
-      'vouch-embed': Embed;
-    }
-  }
-}
-
-export { Embed };
-export type { EmbedProps };