@vouchfor/embeds 0.0.0-experiment.93ea548 → 0.0.0-experiment.a2cd27b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.93ea548",
+  "version": "0.0.0-experiment.a2cd27b",
   "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.93ea548",
+    "@vouchfor/media-player": "0.0.0-experiment.a2cd27b",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

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

@@ -51,7 +51,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}/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,4 +1,3 @@
-/* eslint-disable max-lines */
 import { v4 as uuidv4 } from 'uuid';
 
 import type { Embed } from '..';
@@ -7,13 +6,13 @@ import type { ReactiveController, ReactiveControllerHost } from 'lit';
 
 import { getEnvUrls } from '~/utils/env';
 
-const STREAMED_THROTTLE = 10000;
+// In seconds due to checking against node.currentTime
+const STREAMED_THROTTLE = 10;
 
 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;
@@ -37,9 +36,9 @@ 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;
@@ -130,14 +129,16 @@ 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();
 
-    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`,
       JSON.stringify({
@@ -161,24 +162,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');
       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,100 +178,58 @@ 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._streamStartTime[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._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;
+    // We only want to count any time that the video is actually playing
+    if (!this.host.paused) {
+      this._currentlyPlayingVideo = { id, key, node };
+      this._streamLatestTime[key] = node.currentTime;
     }
 
-    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[key] > STREAMED_THROTTLE
+      this._streamLatestTime[key] - this._streamStartTime[key] > STREAMED_THROTTLE
     ) {
       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;
-  };
-
-  private _handleVideoPause = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
-    const vouchId = this._findVouchId();
-
-    if (!vouchId) {
-      return;
+      this._streamStartTime[key] = node.currentTime;
     }
+  };
 
-    // Don't send a tracking event if the video pauses when seeking backwards
-    if (node.currentTime > this._streamedTime[key]) {
+  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+    // Don't send a tracking event when seeking backwards
+    if (this._streamLatestTime[key] > this._streamStartTime[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
+        streamStart: this._streamStartTime[key],
+        streamEnd: this._streamLatestTime[key]
       });
     }
-
-    delete this._streamedTime[key];
+    this._currentlyPlayingVideo = null;
+    delete this._streamStartTime[key];
     delete this._streamLatestTime[key];
-    delete this._streamedPrevTimestamp[key];
   };
 
   hostConnected() {
@@ -287,17 +237,29 @@ class TrackingController implements ReactiveController {
       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() {
+    if (this._currentlyPlayingVideo) {
+      const { id, key } = this._currentlyPlayingVideo;
+      if (this._streamLatestTime[key] > this._streamStartTime[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', {
+          answerId: id,
+          streamStart: this._streamStartTime[key],
+          streamEnd: this._streamLatestTime[key]
+        });
+      }
+    }
+
     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);
   }