@vouchfor/embeds 0.0.0-experiment.bdda3d0 → 0.0.0-experiment.beea728

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.bdda3d0",
+  "version": "0.0.0-experiment.beea728",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -26,7 +26,7 @@
     "lint:staged": "lint-staged",
     "prepublishOnly": "yarn build",
     "size": "size-limit",
-    "storybook": "yarn prebuild && storybook dev -p 6006",
+    "storybook": "yarn prebuild && storybook dev -p 6007",
     "prebuild": "yarn build:deps && yarn generate:manifest",
     "test": "true"
   },
@@ -35,12 +35,12 @@
     "**/*.{md,json,yml}": "prettier --write"
   },
   "dependencies": {
-    "@lit/task": "1.0.0",
-    "@vouchfor/media-player": "0.0.0-experiment.bdda3d0",
+    "@lit/task": "^1.0.0",
+    "@vouchfor/media-player": "0.0.0-experiment.beea728",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
-    "lit": "^3.0.2"
+    "lit": "^3.1.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4-fix.0",
@@ -62,7 +62,7 @@
     "eslint": "^8.50.0",
     "eslint-plugin-import": "^2.28.1",
     "lint-staged": "^14.0.1",
-    "lit": "^2.8.0",
+    "lit": "^3.1.0",
     "prettier": "^3.0.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

package/src/components/Embed/Embed.stories.ts

@@ -10,7 +10,17 @@ type EmbedArgs = EmbedProps & {
   showVouch?: boolean;
 };
 
-const _Embed = ({ vouchId, templateId, preload, autoplay, env, apiKey, controls, aspectRatio }: EmbedArgs) => {
+const _Embed = ({
+  vouchId,
+  templateId,
+  questions,
+  preload,
+  autoplay,
+  env,
+  apiKey,
+  controls,
+  aspectRatio
+}: EmbedArgs) => {
   return html`
     <div style="height: 100vh">
       <vouch-embed
@@ -18,10 +28,12 @@ const _Embed = ({ vouchId, templateId, preload, autoplay, env, apiKey, controls,
         apiKey=${ifDefined(apiKey)}
         vouchId=${ifDefined(vouchId)}
         templateId=${ifDefined(templateId)}
+        .questions=${questions}
         .controls=${controls}
         ?autoplay=${autoplay}
         preload=${ifDefined(preload)}
         aspectRatio=${ifDefined(aspectRatio)}
+        @error=${console.log}
       ></vouch-embed>
     </div>
   `;
@@ -39,10 +51,11 @@ type Story = StoryObj<EmbedArgs>;
 
 const Embed: Story = {
   args: {
-    env: 'dev',
+    env: 'local',
     apiKey: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
     vouchId: '6JQEIPeStt',
-    templateId: '7d0113f7-3f9a-4bdd-97e3-07ee6eec5730',
+    templateId: '357fc118-e179-4171-9446-ff2b8e9d1b29',
+    questions: [],
     aspectRatio: 0,
     preload: 'none',
     autoplay: false
@@ -50,7 +63,7 @@ const Embed: Story = {
   argTypes: {
     env: {
       control: 'radio',
-      options: ['prod', 'staging', 'dev']
+      options: ['local', 'dev', 'staging', 'prod']
     },
     preload: {
       control: 'radio',

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

@@ -1,7 +1,7 @@
 import { Task } from '@lit/task';
+import { v4 as uuidv4 } from 'uuid';
 
 import type { Embed, EmbedProps } from '..';
-import type { TemplateInstance } from '@vouchfor/canvas-video';
 import type { ReactiveControllerHost } from 'lit';
 import type { Environment } from '~/utils/env';
 
@@ -9,7 +9,7 @@ import { getEnvUrls } from '~/utils/env';
 
 type EmbedHost = ReactiveControllerHost & Embed;
 
-type TaskDeps = [
+type FetchTaskDeps = [
   EmbedProps['env'],
   EmbedProps['apiKey'],
   EmbedProps['data'],
@@ -17,12 +17,13 @@ type TaskDeps = [
   EmbedProps['templateId']
 ];
 
+type FilterTaskDeps = [EmbedProps['data'], EmbedProps['questions']];
+
 class FetcherController {
   host: EmbedHost;
 
   private _fetching = false;
-  private _vouch?: EmbedProps['data'];
-  private _template?: TemplateInstance;
+  private _vouch: EmbedProps['data'];
 
   set fetching(value) {
     if (this._fetching !== value) {
@@ -34,74 +35,94 @@ class FetcherController {
     return this._fetching;
   }
 
-  set vouch(value) {
-    if (this._vouch !== value) {
-      this._vouch = value;
-      this.host.requestUpdate();
-    }
-  }
-  get vouch() {
-    return this._vouch;
-  }
-
-  set template(value) {
-    if (this._template !== value) {
-      this._template = value;
-      this.host.requestUpdate();
-    }
-  }
-  get template() {
-    return this._template;
-  }
-
-  private async getVouch(env: Environment, apiKey: string, vouchId?: string) {
+  private getVouch = async (env: Environment, apiKey: string, vouchId: string) => {
     const { embedApiUrl } = getEnvUrls(env);
 
-    if (vouchId) {
-      return fetch(`${embedApiUrl}/vouches/${vouchId}`, {
+    const cacheCheck = uuidv4();
+    const res = await fetch(`${embedApiUrl}/vouches/${vouchId}`, {
+      method: 'GET',
+      headers: [
+        ['X-Api-Key', apiKey],
+        ['X-Cache-Check', cacheCheck]
+      ]
+    });
+
+    const vouch = await res.json();
+    this.host.dispatchEvent(new CustomEvent('vouch:loaded', { detail: vouch?.id }));
+
+    // HACK: we're currently using API Gateway caching on the embed API without any invalidation logic,
+    // so to ensure that the cache stays up to date, whenever we detect a cache hit we trigger another
+    // API call with the `Cache-Control` header which will re-fill the cache
+    const resCacheCheck = res?.headers?.get('X-Cache-Check');
+    if (resCacheCheck !== cacheCheck) {
+      fetch(`${embedApiUrl}/vouches/${vouchId}`, {
         method: 'GET',
-        headers: [['X-Api-Key', apiKey]]
-      }).then((response) => response.json());
+        headers: [
+          ['X-Api-Key', apiKey],
+          ['Cache-Control', 'max-age=0']
+        ]
+      });
     }
 
-    return null;
-  }
+    return vouch;
+  };
 
-  private async getTemplate(env: Environment, apiKey: string, templateId?: string) {
+  private getTemplate = async (env: Environment, apiKey: string, templateId: string) => {
     const { embedApiUrl } = getEnvUrls(env);
 
-    if (templateId) {
-      return fetch(`${embedApiUrl}/templates/${templateId}`, {
+    const cacheCheck = uuidv4();
+    const res = await fetch(`${embedApiUrl}/templates/${templateId}`, {
+      method: 'GET',
+      headers: [
+        ['X-Api-Key', apiKey],
+        ['X-Cache-Check', cacheCheck]
+      ]
+    });
+    const template = await res.json();
+
+    // HACK: we're currently using API Gateway caching on the embed API without any invalidation logic,
+    // so to ensure that the cache stays up to date, whenever we detect a cache hit we trigger another
+    // API call with the `Cache-Control` header which will re-fill the cache
+    const resCacheCheck = res?.headers?.get('X-Cache-Check');
+    if (resCacheCheck !== cacheCheck) {
+      fetch(`${embedApiUrl}/templates/${templateId}`, {
         method: 'GET',
-        headers: [['X-Api-Key', apiKey]]
-      }).then((response) => response.json());
+        headers: [
+          ['X-Api-Key', apiKey],
+          ['Cache-Control', 'max-age=0']
+        ]
+      });
     }
 
-    return null;
-  }
+    return template;
+  };
 
   constructor(host: EmbedHost) {
     this.host = host;
-    new Task<TaskDeps, void>(
+    new Task<FetchTaskDeps, void>(
       this.host,
-      async ([env, apiKey, data, vouchId, templateId]: TaskDeps) => {
+      async ([env, apiKey, data, vouchId, templateId]: FetchTaskDeps) => {
         try {
-          this.vouch = undefined;
-          this.template = undefined;
+          host.vouch = undefined;
+          host.template = undefined;
 
           if (data) {
-            const template = await this.getTemplate(env, apiKey, templateId);
-            this.vouch = data;
-            this.template = data?.settings?.template?.instance ?? template;
+            let template;
+            if (templateId) {
+              this.fetching = true;
+              template = await this.getTemplate(env, apiKey, templateId);
+            }
+            this._vouch = data;
+            host.template = template ?? data?.settings?.template?.instance;
           } else if (vouchId) {
             this.fetching = true;
 
             const [vouch, template] = await Promise.all([
               this.getVouch(env, apiKey, vouchId),
-              this.getTemplate(env, apiKey, templateId)
+              templateId ? this.getTemplate(env, apiKey, templateId) : null
             ]);
-            this.vouch = vouch;
-            this.template = vouch?.settings?.template?.instance ?? template;
+            this._vouch = vouch;
+            host.template = template ?? vouch?.settings?.template?.instance;
           }
         } finally {
           this.fetching = false;
@@ -109,6 +130,22 @@ class FetcherController {
       },
       () => [host.env, host.apiKey, host.data, host.vouchId, host.templateId]
     );
+
+    // This second task is to be able to filter the vouch without fetching it again if only the questions changed
+    new Task<FilterTaskDeps, void>(
+      this.host,
+      ([vouch, questions]: FilterTaskDeps) => {
+        host.vouch = vouch
+          ? {
+              ...vouch,
+              questions: {
+                items: vouch?.questions.items.filter((_, index) => !questions?.length || questions?.includes(index + 1))
+              }
+            }
+          : undefined;
+      },
+      () => [this._vouch, host.questions]
+    );
   }
 }
 

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

@@ -4,15 +4,16 @@ import type { Embed } from '..';
 import type { VideoEventDetail } from '@vouchfor/media-player';
 import type { ReactiveController, ReactiveControllerHost } from 'lit';
 
+import packageJson from '../../../../package.json';
 import { getEnvUrls } from '~/utils/env';
 
-const STREAMED_THROTTLE = 2000;
+const MINIMUM_SEND_THRESHOLD = 1;
 
 type EmbedHost = ReactiveControllerHost & Embed;
 
 type TrackingEvent = 'VOUCH_LOADED' | 'VOUCH_RESPONSE_VIEWED' | 'VIDEO_PLAYED' | 'VIDEO_STREAMED';
 type TrackingPayload = {
-  vouchId: string;
+  vouchId?: string;
   answerId?: string;
   streamStart?: number;
   streamEnd?: number;
@@ -36,21 +37,23 @@ class TrackingController implements ReactiveController {
   private _hasPlayed = false;
   private _hasLoaded: BooleanMap = {};
   private _answersViewed: BooleanMap = {};
-  private _streamedTime: TimeMap = {};
-  private _streamedPrevTimestamp: TimeMap = {};
+  private _streamStartTime: TimeMap = {};
+  private _streamLatestTime: TimeMap = {};
+  private _currentlyPlayingVideo: VideoEventDetail | null = null;
 
   constructor(host: EmbedHost) {
     this.host = host;
     host.addController(this);
   }
 
-  private _findVouchId() {
-    if (this.host.data) {
-      if ('uuid' in this.host.data) {
-        return this.host.data.uuid;
-      }
-      return this.host.data.id;
+  private _findVouchId(payload?: TrackingPayload) {
+    if (payload && 'vouchId' in payload) {
+      return payload.vouchId;
+    }
+    if (this.host.vouch) {
+      return this.host.vouch.id;
     }
+    return null;
   }
 
   private _createVisitor = (visitorId: string) => {
@@ -116,7 +119,7 @@ class TrackingController implements ReactiveController {
     });
 
     return {
-      source: 'media_player',
+      source: this.host.trackingSource,
       time: new Date(),
       region,
       country,
@@ -128,27 +131,56 @@ class TrackingController implements ReactiveController {
     };
   };
 
-  private _sendTrackingEvent = (event: TrackingEvent, payload: TrackingPayload) => {
+  private _sendTrackingEvent = (event: TrackingEvent, payload?: TrackingPayload) => {
+    const vouchId = this._findVouchId(payload);
+
+    if (!vouchId || this.host.disableTracking) {
+      return;
+    }
+
     const { publicApiUrl } = getEnvUrls(this.host.env);
     const { client, tab, request, visitor } = this._getUids();
 
-    // Don't send tracking if we don't have a source
     navigator.sendBeacon(
-      `${publicApiUrl}/api/events`,
+      `${publicApiUrl}/api/v2/events`,
       JSON.stringify({
         event,
-        payload,
+        payload: {
+          ...payload,
+          vouchId
+        },
         context: {
           'x-uid-client': client,
           'x-uid-tab': tab,
           'x-uid-request': request,
           'x-uid-visitor': visitor,
-          'x-reporting-metadata': this._getReportingMetadata()
+          'x-reporting-metadata': this._getReportingMetadata(),
+          'x-embeds-version': packageJson.version
         }
       })
     );
   };
 
+  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._sendTrackingEvent('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;
@@ -156,91 +188,84 @@ class TrackingController implements ReactiveController {
 
     // Only send loaded event once per session
     if (!this._hasLoaded[vouchId]) {
-      this._sendTrackingEvent('VOUCH_LOADED', {
-        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;
-    }
+  private _handleVideoPlay = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
     // Only increment play count once per session
-    if (!this._answersViewed[id]) {
+    if (!this._answersViewed[key]) {
       this._sendTrackingEvent('VOUCH_RESPONSE_VIEWED', {
-        vouchId,
         answerId: id
       });
-      this._answersViewed[id] = true;
+      this._answersViewed[key] = true;
     }
-    this._streamedTime[id] = node.currentTime;
-    this._streamedPrevTimestamp[id] = Date.now();
-  };
 
-  private _handleVideoTimeUpdate = ({ detail: { id, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-    if (!vouchId) {
-      return;
+    if (!this._streamStartTime[key]) {
+      this._streamStartTime[key] = node.currentTime;
+      this._streamLatestTime[key] = node.currentTime;
     }
-    const currentTimestamp = Date.now();
+  };
+
+  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 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
+      // 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;
+    }
+  };
+
+  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+    if (this._streamLatestTime[key] > this._streamStartTime[key] + MINIMUM_SEND_THRESHOLD) {
       this._sendTrackingEvent('VIDEO_STREAMED', {
-        vouchId,
         answerId: id,
-        streamStart: this._streamedTime[id],
-        streamEnd: node.currentTime
+        streamStart: this._streamStartTime[key],
+        streamEnd: this._streamLatestTime[key]
       });
-      this._streamedTime[id] = node.currentTime;
-      this._streamedPrevTimestamp[id] = currentTimestamp;
     }
+    delete this._streamStartTime[key];
+    delete this._streamLatestTime[key];
   };
 
-  private _handleVideoPause = ({ detail: { id, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-    if (!vouchId) {
-      return;
+  private _pageUnloading = () => {
+    this._streamEnded();
+    // This will try to send the same stream event again so we delete the start and latest
+    // time in stream ended so that there is no times to send and the pause event does nothing
+    this.host.pause();
+  };
+
+  private _handleVisibilityChange = () => {
+    if (document.visibilityState === 'hidden') {
+      this._pageUnloading();
     }
-    // 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._streamedPrevTimestamp[id];
+  };
+
+  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);
@@ -250,6 +275,12 @@ class TrackingController implements ReactiveController {
   }
 
   hostDisconnected() {
+    this._streamEnded();
+    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);

package/src/components/Embed/index.ts

@@ -1,9 +1,9 @@
 import { html, LitElement } from 'lit';
-import { customElement, property } from 'lit/decorators.js';
+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';
@@ -17,20 +17,27 @@ 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;
+  // 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: Object }) data: EmbedProps['data'];
   @property({ type: String }) vouchId: EmbedProps['vouchId'];
   @property({ type: String }) templateId: EmbedProps['templateId'];
+  @property({ type: Array }) questions: EmbedProps['questions'];
 
   @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';
@@ -55,6 +62,7 @@ class Embed extends LitElement {
     'waiting',
 
     'video:loadeddata',
+    'video:seeking',
     'video:seeked',
     'video:play',
     'video:playing',
@@ -69,13 +77,8 @@ class Embed extends LitElement {
   // @ts-ignore
   private _trackingController = new TrackingController(this);
 
-  get vouch() {
-    return this._fetcherController.vouch;
-  }
-
-  get template(): TemplateInstance | undefined {
-    return this._fetcherController.template;
-  }
+  @state() vouch: EmbedProps['data'];
+  @state() template: TemplateInstance | undefined;
 
   get fetching() {
     return this._fetcherController.fetching;
@@ -149,6 +152,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;
   }