@vouchfor/embeds 0.0.0-experiment.b7c103f → 0.0.0-experiment.bb5f326

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.b7c103f",
+  "version": "0.0.0-experiment.bb5f326",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@lit/task": "^1.0.0",
-    "@vouchfor/media-player": "0.0.0-experiment.b7c103f",
+    "@vouchfor/media-player": "0.0.0-experiment.bb5f326",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

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

@@ -45,13 +45,13 @@ class FetcherController {
     });
 
     const vouch = await res.json();
-    this.host.dispatchEvent(new CustomEvent('vouch:loaded', { detail: vouchId }));
+    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 && resCacheCheck !== cacheCheck) {
+    if (resCacheCheck !== cacheCheck) {
       fetch(`${embedApiUrl}/vouches/${vouchId}`, {
         method: 'GET',
         headers: [
@@ -81,7 +81,7 @@ class FetcherController {
     // 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 && resCacheCheck !== cacheCheck) {
+    if (resCacheCheck !== cacheCheck) {
       fetch(`${embedApiUrl}/templates/${templateId}`, {
         method: 'GET',
         headers: [

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

@@ -1,19 +1,19 @@
-/* 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 packageJson from '../../../../package.json';
 import { getEnvUrls } from '~/utils/env';
 
-const STREAMED_THROTTLE = 10000;
+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;
@@ -37,22 +37,23 @@ class TrackingController implements ReactiveController {
   private _hasPlayed = false;
   private _hasLoaded: BooleanMap = {};
   private _answersViewed: BooleanMap = {};
-  private _streamedTime: TimeMap = {};
+  private _streamStartTime: TimeMap = {};
   private _streamLatestTime: TimeMap = {};
-  private _streamedPrevTimestamp: TimeMap = {};
+  private _currentlyPlayingVideo: VideoEventDetail | null = null;
 
   constructor(host: EmbedHost) {
     this.host = host;
     host.addController(this);
   }
 
-  private _findVouchId() {
+  private _findVouchId(payload?: TrackingPayload) {
+    if (payload && 'vouchId' in payload) {
+      return payload.vouchId;
+    }
     if (this.host.vouch) {
-      if ('uuid' in this.host.vouch) {
-        return this.host.vouch.uuid;
-      }
       return this.host.vouch.id;
     }
+    return null;
   }
 
   private _createVisitor = (visitorId: string) => {
@@ -130,30 +131,56 @@ class TrackingController implements ReactiveController {
     };
   };
 
-  private _sendTrackingEvent = (event: TrackingEvent, payload: TrackingPayload) => {
-    const { publicApiUrl } = getEnvUrls(this.host.env);
-    const { client, tab, request, visitor } = this._getUids();
+  private _sendTrackingEvent = (event: TrackingEvent, payload?: TrackingPayload) => {
+    const vouchId = this._findVouchId(payload);
 
-    if (this.host.disableTracking) {
+    if (!vouchId || this.host.disableTracking) {
       return;
     }
 
+    const { publicApiUrl } = getEnvUrls(this.host.env);
+    const { client, tab, request, visitor } = this._getUids();
+
     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;
@@ -161,24 +188,15 @@ 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;
@@ -186,118 +204,86 @@ class TrackingController implements ReactiveController {
   };
 
   private _handleVideoPlay = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
     // Only increment play count once per session
     if (!this._answersViewed[key]) {
       this._sendTrackingEvent('VOUCH_RESPONSE_VIEWED', {
-        vouchId,
         answerId: id
       });
       this._answersViewed[key] = true;
     }
 
-    this._streamedTime[key] = node.currentTime;
-    this._streamLatestTime[key] = node.currentTime;
-    this._streamedPrevTimestamp[key] = Date.now();
-  };
-
-  private _handleVideoSeeking = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
+    if (!this._streamStartTime[key]) {
+      this._streamStartTime[key] = node.currentTime;
+      this._streamLatestTime[key] = node.currentTime;
     }
-
-    if (this._streamLatestTime[key]) {
-      this._sendTrackingEvent('VIDEO_STREAMED', {
-        vouchId,
-        answerId: id,
-        streamStart: this._streamedTime[key],
-        streamEnd: this._streamLatestTime[key]
-      });
-    }
-
-    delete this._streamedTime[key];
-    delete this._streamLatestTime[key];
-    delete this._streamedPrevTimestamp[key];
   };
 
   private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
-    }
-
-    const currentTimestamp = Date.now();
     if (
-      node.currentTime &&
-      !node.paused &&
+      // 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[key] > 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[key],
-        streamEnd: node.currentTime
+        streamStart: this._streamStartTime[key],
+        streamEnd: this._streamLatestTime[key]
       });
-      this._streamedTime[key] = node.currentTime;
-      this._streamedPrevTimestamp[key] = currentTimestamp;
     }
-
-    this._streamLatestTime[key] = node.currentTime;
+    delete this._streamStartTime[key];
+    delete this._streamLatestTime[key];
   };
 
-  private _handleVideoPause = ({ detail: { id, key, 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();
+  };
 
-    // Don't send a tracking event if the video pauses when seeking backwards
-    if (node.currentTime > this._streamedTime[key]) {
-      // 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[key],
-        streamEnd: node.currentTime
-      });
+  private _handleVisibilityChange = () => {
+    if (document.visibilityState === 'hidden') {
+      this._pageUnloading();
     }
+  };
 
-    delete this._streamedTime[key];
-    delete this._streamLatestTime[key];
-    delete this._streamedPrevTimestamp[key];
+  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:seeking', this._handleVideoSeeking);
       this.host.mediaPlayer?.addEventListener('video:pause', this._handleVideoPause);
       this.host.mediaPlayer?.addEventListener('video:timeupdate', this._handleVideoTimeUpdate);
     });
   }
 
   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);
-    this.host.mediaPlayer?.removeEventListener('video:seeking', this._handleVideoSeeking);
     this.host.mediaPlayer?.removeEventListener('video:pause', this._handleVideoPause);
     this.host.mediaPlayer?.removeEventListener('video:timeupdate', this._handleVideoTimeUpdate);
   }

package/src/components/Embed/index.ts

@@ -3,7 +3,7 @@ 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';
@@ -149,6 +149,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;
   }