@vouchfor/embeds 0.0.0-experiment.f4df018 → 0.0.0-experiment.f6e3687

package/src/components/PlayerEmbed/controllers/tracking/index.ts

@@ -0,0 +1,224 @@
+import type { PlayerEmbed } from '../..';
+import type { VideoEventDetail } from '@vouchfor/media-player';
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+
+import { findVouchId, getReportingMetadata, getUids } from './utils';
+import { getEnvUrls } from '~/utils/env';
+
+const MINIMUM_SEND_THRESHOLD = 1;
+
+type PlayerEmbedHost = ReactiveControllerHost & PlayerEmbed;
+
+type TrackingEvent = 'VOUCH_LOADED' | 'VOUCH_RESPONSE_VIEWED' | 'VIDEO_PLAYED' | 'VIDEO_STREAMED';
+type TrackingPayload = {
+  vouchId?: string;
+  answerId?: string;
+  streamStart?: number;
+  streamEnd?: number;
+};
+
+type BatchEvent = {
+  event: TrackingEvent;
+  payload: TrackingPayload & {
+    time: string;
+  };
+};
+
+type TimeMap = {
+  [key: string]: number;
+};
+
+type BooleanMap = {
+  [key: string]: boolean;
+};
+
+class TrackingController implements ReactiveController {
+  host: PlayerEmbedHost;
+
+  private _batchedEvents: BatchEvent[] = [];
+  private _hasPlayed = false;
+  private _hasLoaded: BooleanMap = {};
+  private _answersViewed: BooleanMap = {};
+  private _streamStartTime: TimeMap = {};
+  private _streamLatestTime: TimeMap = {};
+  private _currentlyPlayingVideo: VideoEventDetail | null = null;
+
+  constructor(host: PlayerEmbedHost) {
+    this.host = host;
+    host.addController(this);
+  }
+
+  private _createTrackingEvent = (event: TrackingEvent, payload?: TrackingPayload) => {
+    const vouchId = findVouchId(payload, this.host.vouch);
+
+    if (!vouchId || this.host.disableTracking) {
+      return;
+    }
+
+    this._batchedEvents.push({
+      event,
+      payload: {
+        ...payload,
+        vouchId,
+        time: new Date().toISOString()
+      }
+    });
+  };
+
+  private _sendTrackingEvent = () => {
+    if (this._batchedEvents.length <= 0) {
+      return;
+    }
+
+    const { publicApiUrl } = getEnvUrls(this.host.env);
+    const { client, tab, request, visitor } = getUids(this.host.env);
+
+    navigator.sendBeacon(
+      `${publicApiUrl}/api/batchevents`,
+      JSON.stringify({
+        payload: {
+          events: this._batchedEvents
+        },
+        context: {
+          'x-uid-client': client,
+          'x-uid-tab': tab,
+          'x-uid-request': request,
+          'x-uid-visitor': visitor,
+          'x-reporting-metadata': getReportingMetadata(this.host.trackingSource)
+        }
+      })
+    );
+
+    this._batchedEvents = [];
+  };
+
+  private _streamEnded = () => {
+    if (this._currentlyPlayingVideo) {
+      const { id, key } = this._currentlyPlayingVideo;
+      // Don't send a tracking event when seeking backwards
+      if (this._streamLatestTime[key] > this._streamStartTime[key] + MINIMUM_SEND_THRESHOLD) {
+        // Send a video streamed event any time the stream ends to capture the time between starting
+        // the video and the video stopping for any reason (pausing, deleting the embed node or closing the browser)
+        this._createTrackingEvent('VIDEO_STREAMED', {
+          answerId: id,
+          streamStart: this._streamStartTime[key],
+          streamEnd: this._streamLatestTime[key]
+        });
+      }
+
+      // Make sure these events are only sent once by deleting the start and latest times
+      delete this._streamStartTime[key];
+      delete this._streamLatestTime[key];
+    }
+  };
+
+  private _handleVouchLoaded = ({ detail: vouchId }: CustomEvent<string>) => {
+    if (!vouchId) {
+      return;
+    }
+
+    // Only send loaded event once per session
+    if (!this._hasLoaded[vouchId]) {
+      this._createTrackingEvent('VOUCH_LOADED', { vouchId });
+      this._hasLoaded[vouchId] = true;
+    }
+  };
+
+  private _handlePlay = () => {
+    // Only send the video played event once per session
+    if (!this._hasPlayed) {
+      this._createTrackingEvent('VIDEO_PLAYED', {
+        streamStart: this.host.currentTime
+      });
+      this._hasPlayed = true;
+    }
+  };
+
+  private _handleVideoPlay = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+    // Only increment play count once per session
+    if (!this._answersViewed[key]) {
+      this._createTrackingEvent('VOUCH_RESPONSE_VIEWED', {
+        answerId: id
+      });
+      this._answersViewed[key] = true;
+    }
+  };
+
+  private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
+    if (
+      // We only want to count any time that the video is actually playing
+      !this.host.paused &&
+      // Only update the latest time if this event fires for the currently active video
+      id === this.host.scene?.video?.id
+    ) {
+      this._currentlyPlayingVideo = { id, key, node };
+      this._streamLatestTime[key] = node.currentTime;
+
+      if (!this._streamStartTime[key]) {
+        this._streamStartTime[key] = node.currentTime;
+        this._streamLatestTime[key] = node.currentTime;
+      }
+    }
+  };
+
+  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+    if (this._streamLatestTime[key] > this._streamStartTime[key] + MINIMUM_SEND_THRESHOLD) {
+      this._createTrackingEvent('VIDEO_STREAMED', {
+        answerId: id,
+        streamStart: this._streamStartTime[key],
+        streamEnd: this._streamLatestTime[key]
+      });
+    }
+    delete this._streamStartTime[key];
+    delete this._streamLatestTime[key];
+  };
+
+  private _pageUnloading = () => {
+    this._streamEnded();
+    this._sendTrackingEvent();
+  };
+
+  private _handleVisibilityChange = () => {
+    if (document.visibilityState === 'hidden') {
+      this._pageUnloading();
+    }
+  };
+
+  private _handlePageHide = () => {
+    this._pageUnloading();
+  };
+
+  hostConnected() {
+    requestAnimationFrame(() => {
+      if ('onvisibilitychange' in document) {
+        document.addEventListener('visibilitychange', this._handleVisibilityChange);
+      } else {
+        window.addEventListener('pagehide', this._handlePageHide);
+      }
+      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:pause', this._handleVideoPause);
+      this.host.mediaPlayer?.addEventListener('video:timeupdate', this._handleVideoTimeUpdate);
+    });
+  }
+
+  hostDisconnected() {
+    // Send events if DOM node is destroyed
+    this._pageUnloading();
+
+    if ('onvisibilitychange' in document) {
+      document.removeEventListener('visibilitychange', this._handleVisibilityChange);
+    } else {
+      window.removeEventListener('pagehide', this._handlePageHide);
+    }
+    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:pause', this._handleVideoPause);
+    this.host.mediaPlayer?.removeEventListener('video:timeupdate', this._handleVideoTimeUpdate);
+  }
+}
+
+export { TrackingController };
+export type { TrackingEvent, TrackingPayload };

package/src/components/PlayerEmbed/controllers/tracking/utils.ts

@@ -0,0 +1,95 @@
+import { TEMPLATE_VERSION } from '@vouchfor/canvas-video';
+import { v4 as uuidv4 } from 'uuid';
+
+import type { TrackingPayload } from '.';
+import type { Vouch } from '@vouchfor/media-player';
+import type { Environment } from '~/utils/env';
+
+import packageJson from '~/../package.json';
+import { getEnvUrls } from '~/utils/env';
+
+function createVisitor(env: Environment) {
+  const { publicApiUrl } = getEnvUrls(env);
+  const visitorId = uuidv4();
+  navigator.sendBeacon(`${publicApiUrl}/api/visitor`, JSON.stringify({ visitorId }));
+  return visitorId;
+}
+
+function getUids(env: Environment) {
+  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
+  let visitorId = window.localStorage?.getItem?.('vouch-uid-visitor');
+  // Persisted for a user for the same device + browser, so we can e.g. search for all logs related to that browser
+  let clientId = window.localStorage?.getItem?.('vouch-uid-client');
+  // Persisted in session storage, so we can search for everything the user has done in a specific tab
+  let tabId = window.sessionStorage?.getItem?.('vouch-uid-tab');
+  // 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 uids
+  if (!visitorId) {
+    visitorId = createVisitor(env);
+    window.localStorage?.setItem?.('vouch-uid-visitor', visitorId);
+  }
+
+  if (!clientId) {
+    clientId = uuidv4();
+    window.localStorage?.setItem?.('vouch-uid-client', clientId);
+  }
+
+  if (!tabId) {
+    tabId = uuidv4();
+    window.sessionStorage?.setItem?.('vouch-uid-tab', tabId);
+  }
+
+  return {
+    client: clientId,
+    tab: tabId,
+    request: requestId,
+    visitor: visitorId
+  };
+}
+
+function findVouchId(payload?: TrackingPayload, vouch?: Vouch) {
+  if (payload && 'vouchId' in payload) {
+    return payload.vouchId;
+  }
+  return vouch?.id ?? null;
+}
+
+function getReportingMetadata(source = 'embedded_player') {
+  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,
+    time: new Date(),
+    region,
+    country,
+    screenHeight: window.screen.height,
+    screenWidth: window.screen.width,
+    referrer: document.referrer,
+    currentUrl: location.href,
+    embedType: 'media-player-embed',
+    embedVersion: packageJson.version,
+    templateVersion: TEMPLATE_VERSION,
+    ...utmParams
+  };
+}
+
+export { getUids, findVouchId, getReportingMetadata };

package/src/components/{Embed → PlayerEmbed}/index.ts

@@ -1,11 +1,10 @@
-import { html, LitElement } from 'lit';
+import { css, 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 { Scene, Scenes, 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';
@@ -14,30 +13,41 @@ import { TrackingController } from './controllers/tracking';
 
 import '@vouchfor/media-player';
 
-type EmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
+type PlayerEmbedProps = Pick<MediaPlayerProps, 'data' | 'aspectRatio' | 'preload' | 'autoplay' | 'controls'> & {
   env: Environment;
   apiKey: string;
+  disableTracking?: boolean;
   trackingSource?: string;
   vouchId?: string;
   templateId?: string;
+  // Index of the questions to include starting from 1
+  questions?: number[];
 };
 
-@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: 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;
+@customElement('vouch-embed-player')
+class PlayerEmbed extends LitElement {
+  static styles = [
+    css`
+      :host {
+        display: flex;
+      }
+    `
+  ];
+
+  @property({ type: Object }) data: PlayerEmbedProps['data'];
+  @property({ type: String }) vouchId: PlayerEmbedProps['vouchId'];
+  @property({ type: String }) templateId: PlayerEmbedProps['templateId'];
+  @property({ type: Array }) questions: PlayerEmbedProps['questions'];
+
+  @property({ type: String }) env: PlayerEmbedProps['env'] = 'prod';
+  @property({ type: String }) apiKey: PlayerEmbedProps['apiKey'] = '';
+  @property({ type: Boolean }) disableTracking: PlayerEmbedProps['disableTracking'] = false;
+  @property({ type: String }) trackingSource: PlayerEmbedProps['trackingSource'] = 'embedded_player';
+
+  @property({ type: Array }) controls: PlayerEmbedProps['controls'];
+  @property({ type: String }) preload: PlayerEmbedProps['preload'] = 'auto';
+  @property({ type: Boolean }) autoplay: PlayerEmbedProps['autoplay'] = false;
+  @property({ type: Number }) aspectRatio: PlayerEmbedProps['aspectRatio'] = 0;
 
   private eventController = new EventForwardController(this, [
     'durationchange',
@@ -57,6 +67,7 @@ class Embed extends LitElement {
     'waiting',
 
     'video:loadeddata',
+    'video:seeking',
     'video:seeked',
     'video:play',
     'video:playing',
@@ -71,17 +82,23 @@ class Embed extends LitElement {
   // @ts-ignore
   private _trackingController = new TrackingController(this);
 
-  @state() vouch: EmbedProps['data'];
+  @state() vouch: PlayerEmbedProps['data'];
   @state() template: TemplateInstance | undefined;
 
   get fetching() {
     return this._fetcherController.fetching;
   }
 
+  private _mediaPlayerRef = createRef<MediaPlayer>();
+
   get waiting() {
     return this._mediaPlayerRef.value?.waiting;
   }
 
+  get initialised() {
+    return this._mediaPlayerRef.value?.initialised;
+  }
+
   get seeking() {
     return this._mediaPlayerRef.value?.seeking;
   }
@@ -146,6 +163,10 @@ class Embed extends LitElement {
     return this._mediaPlayerRef.value?.scenes ?? [];
   }
 
+  get sceneConfig(): Scenes | null {
+    return this._mediaPlayerRef.value?.sceneConfig ?? null;
+  }
+
   get videoState() {
     return this._mediaPlayerRef.value?.videoState;
   }
@@ -162,13 +183,43 @@ class Embed extends LitElement {
     this._mediaPlayerRef.value?.pause();
   }
 
+  reset(time = 0, play = false) {
+    this._mediaPlayerRef.value?.reset(time, play);
+  }
+
   setScene(index: number) {
     this._mediaPlayerRef.value?.setScene(index);
   }
 
+  private _renderStyles() {
+    if (!this.aspectRatio) {
+      return html`
+        <style>
+          :host {
+            width: 100%;
+            height: 100%;
+          }
+        </style>
+      `;
+    }
+
+    if (typeof this.aspectRatio === 'number') {
+      return html`
+        <style>
+          :host {
+            aspect-ratio: ${this.aspectRatio};
+          }
+        </style>
+      `;
+    }
+
+    return null;
+  }
+
   render() {
     return html`
-      <vmp-new-media-player
+      ${this._renderStyles()}
+      <vmp-media-player
         ${ref(this._mediaPlayerRef)}
         ${this.eventController.register()}
         ?autoplay=${this.autoplay}
@@ -178,22 +229,22 @@ class Embed extends LitElement {
         aspectRatio=${ifDefined(this.aspectRatio)}
         preload=${ifDefined(this.preload)}
         .controls=${this.controls}
-      ></vmp-new-media-player>
+      ></vmp-media-player>
     `;
   }
 }
 
 declare global {
   interface HTMLElementTagNameMap {
-    'vouch-embed': Embed;
+    'vouch-embed-player': PlayerEmbed;
   }
 
   namespace JSX {
     interface IntrinsicElements {
-      'vouch-embed': Embed;
+      'vouch-embed-player': PlayerEmbed;
     }
   }
 }
 
-export { Embed };
-export type { EmbedProps };
+export { PlayerEmbed };
+export type { PlayerEmbedProps };

package/src/components/PlayerEmbed/tests/PlayerEmbed.spec.ts

@@ -0,0 +1,80 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+import { expect, fixture, waitUntil } from '@open-wc/testing';
+import { html } from 'lit';
+import sinon from 'sinon';
+
+import type { PlayerEmbed } from '../index.js';
+import type { VideoMap } from '@vouchfor/media-player';
+
+import { data } from './data.js';
+
+// Can't use typescript aliases with esbuild file transforms apparently
+// No idea what a good way to actually build before testing is, the examples give nothing
+// https://modern-web.dev/guides/test-runner/typescript/
+import '../../../test/lib/embeds.js';
+
+function getVideo(videos: VideoMap) {
+  return Object.values(videos)[0];
+}
+
+function playerLoaded(player: PlayerEmbed) {
+  return waitUntil(
+    () => {
+      return player.mediaPlayer?.initialised;
+    },
+    'Player has not loaded video',
+    { timeout: 20000 }
+  );
+}
+
+describe('Embeds', () => {
+  it('passes', async () => {
+    const player = await fixture<PlayerEmbed>(
+      html`<vouch-embed-player env="dev" .data=${data} aspectratio=${1}></vouch-embed-player>`
+    );
+    // @ts-ignore - accessing private property
+    const sendTrackingSpy = sinon.spy(player._trackingController, '_sendTrackingEvent');
+    // @ts-ignore - accessing private property
+    const createTrackingSpy = sinon.spy(player._trackingController, '_createTrackingEvent');
+
+    await playerLoaded(player);
+    // Have to mute the player because we can't programmatically play videos with sound
+    player.muted = true;
+    player.play();
+    expect(player.paused).eq(false);
+    await waitUntil(
+      () => {
+        // Video plays for 3 seconds
+        return (getVideo(player.mediaPlayer!.videos)?.node?.currentTime ?? 0) > 3;
+      },
+      'Video did not play for 3 seconds',
+      { timeout: 20000 }
+    );
+    expect(getVideo(player.mediaPlayer!.videos)?.node?.paused).eq(false);
+    player.pause();
+    expect(getVideo(player.mediaPlayer!.videos)?.node?.paused).eq(true);
+    expect(sendTrackingSpy.callCount).to.be.eq(0);
+    // Destroy node because events are sent when node is removed from the document
+    player.remove();
+    expect(sendTrackingSpy.callCount).to.be.eq(1);
+    expect(createTrackingSpy.args[0]).to.eql([
+      'VIDEO_PLAYED',
+      {
+        streamStart: 0
+      }
+    ]);
+    expect(createTrackingSpy.args[1]).to.eql([
+      'VOUCH_RESPONSE_VIEWED',
+      {
+        answerId: '5c66bb3a-ed68-41a0-a601-a49865104418'
+      }
+    ]);
+    expect(createTrackingSpy.args[2][0]).to.eq('VIDEO_STREAMED');
+    // Remove streamStart and streamEnd as these are non-deterministic
+    expect({ ...createTrackingSpy.args[2][1], streamStart: undefined, streamEnd: undefined }).to.eql({
+      answerId: '5c66bb3a-ed68-41a0-a601-a49865104418',
+      streamStart: undefined,
+      streamEnd: undefined
+    });
+  });
+});