@vouchfor/embeds 0.0.0-experiment.4e05d59 → 0.0.0-experiment.4eb5f06

package/package.json

@@ -1,17 +1,14 @@
 {
   "name": "@vouchfor/embeds",
-  "version": "0.0.0-experiment.4e05d59",
+  "version": "0.0.0-experiment.4eb5f06",
   "license": "MIT",
   "author": "Aaron Williams",
   "main": "dist/es/embeds.js",
   "module": "dist/es/embeds.js",
   "type": "module",
-  "types": "dist/src/index.d.ts",
+  "types": "dist/es/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/es/embeds.js",
-      "script": "./dist/iife/embeds.iife.js"
-    }
+    ".": "./dist/es/embeds.js"
   },
   "files": ["dist", "src"],
   "publishConfig": {
@@ -29,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"
   },
@@ -38,10 +35,12 @@
     "**/*.{md,json,yml}": "prettier --write"
   },
   "dependencies": {
-    "@vouchfor/media-player": "0.0.0-experiment.4e05d59"
+    "@lit/task": "^1.0.0",
+    "@vouchfor/media-player": "0.0.0-experiment.4eb5f06",
+    "uuid": "^9.0.1"
   },
   "peerDependencies": {
-    "lit": "^2.7.5"
+    "lit": "^3.1.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4-fix.0",
@@ -63,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

@@ -0,0 +1,66 @@
+import { html } from 'lit';
+import { ifDefined } from 'lit/directives/if-defined.js';
+
+import type { EmbedProps } from './';
+import type { Meta, StoryObj } from '@storybook/web-components';
+
+import './';
+
+type EmbedArgs = EmbedProps & {
+  showVouch?: boolean;
+};
+
+const _Embed = ({ vouchId, templateId, preload, autoplay, env, apiKey, controls, aspectRatio }: EmbedArgs) => {
+  return html`
+    <div style="height: 100vh">
+      <vouch-embed
+        env=${ifDefined(env)}
+        apiKey=${ifDefined(apiKey)}
+        vouchId=${ifDefined(vouchId)}
+        templateId=${ifDefined(templateId)}
+        .controls=${controls}
+        ?autoplay=${autoplay}
+        preload=${ifDefined(preload)}
+        aspectRatio=${ifDefined(aspectRatio)}
+      ></vouch-embed>
+    </div>
+  `;
+};
+
+// More on how to set up stories at: https://storybook.js.org/docs/web-components/writing-stories/introduction
+const meta = {
+  title: 'Embed',
+  tags: ['autodocs'],
+  render: (args) => _Embed(args),
+  component: 'vouch-embed'
+} satisfies Meta<EmbedProps>;
+
+type Story = StoryObj<EmbedArgs>;
+
+const Embed: Story = {
+  args: {
+    env: 'local',
+    apiKey: 'TVik9uTMgE-PD25UTHIS6gyl0hMBWC7AT4dkpdlLBT4VIfDWZJrQiCk6Ak7m1',
+    vouchId: '6JQEIPeStt',
+    templateId: '357fc118-e179-4171-9446-ff2b8e9d1b29',
+    aspectRatio: 0,
+    preload: 'none',
+    autoplay: false
+  },
+  argTypes: {
+    env: {
+      control: 'radio',
+      options: ['local', 'dev', 'staging', 'prod']
+    },
+    preload: {
+      control: 'radio',
+      options: ['auto', 'none']
+    }
+  },
+  parameters: {
+    layout: 'fullscreen'
+  }
+};
+
+export default meta;
+export { Embed };

package/src/components/Embed/controllers/event-forwarder.ts

@@ -0,0 +1,47 @@
+import { createRef, ref } from 'lit/directives/ref.js';
+
+import type { Embed } from '..';
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+import type { Ref } from 'lit/directives/ref.js';
+
+import { forwardEvent } from '~/utils/events';
+
+type EmbedHost = ReactiveControllerHost & Embed;
+
+class EventForwardController implements ReactiveController {
+  host: EmbedHost;
+
+  private _events: string[] = [];
+  private _cleanup: (() => void)[] = [];
+  private _forwardElementRef: Ref<HTMLElement> = createRef();
+
+  constructor(host: EmbedHost, events: string[]) {
+    this.host = host;
+    this._events = events;
+    host.addController(this);
+  }
+
+  register() {
+    return ref(this._forwardElementRef);
+  }
+
+  hostConnected() {
+    // Guaranteed to have the element ref in the RAF callback because of how the lit lifecycle works
+    requestAnimationFrame(() => {
+      this._events.forEach((event) => {
+        if (this._forwardElementRef.value) {
+          this._cleanup.push(forwardEvent(event, this._forwardElementRef.value, this.host));
+        }
+      });
+    });
+  }
+
+  hostDisconnected() {
+    this._cleanup.forEach((fn) => {
+      fn();
+    });
+    this._cleanup = [];
+  }
+}
+
+export { EventForwardController };

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

@@ -0,0 +1,133 @@
+import { Task } from '@lit/task';
+import { v4 as uuidv4 } from 'uuid';
+
+import type { Embed, EmbedProps } from '..';
+import type { ReactiveControllerHost } from 'lit';
+import type { Environment } from '~/utils/env';
+
+import { getEnvUrls } from '~/utils/env';
+
+type EmbedHost = ReactiveControllerHost & Embed;
+
+type TaskDeps = [
+  EmbedProps['env'],
+  EmbedProps['apiKey'],
+  EmbedProps['data'],
+  EmbedProps['vouchId'],
+  EmbedProps['templateId']
+];
+
+class FetcherController {
+  host: EmbedHost;
+
+  private _fetching = false;
+
+  set fetching(value) {
+    if (this._fetching !== value) {
+      this._fetching = value;
+      this.host.requestUpdate();
+    }
+  }
+  get fetching() {
+    return this._fetching;
+  }
+
+  private getVouch = async (env: Environment, apiKey: string, vouchId: string) => {
+    const { embedApiUrl } = getEnvUrls(env);
+
+    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: vouchId }));
+
+    // 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) {
+      fetch(`${embedApiUrl}/vouches/${vouchId}`, {
+        method: 'GET',
+        headers: [
+          ['X-Api-Key', apiKey],
+          ['Cache-Control', 'max-age=0']
+        ]
+      });
+    }
+
+    return vouch;
+  };
+
+  private getTemplate = async (env: Environment, apiKey: string, templateId: string) => {
+    const { embedApiUrl } = getEnvUrls(env);
+
+    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 && resCacheCheck !== cacheCheck) {
+      fetch(`${embedApiUrl}/templates/${templateId}`, {
+        method: 'GET',
+        headers: [
+          ['X-Api-Key', apiKey],
+          ['Cache-Control', 'max-age=0']
+        ]
+      });
+    }
+
+    return template;
+  };
+
+  constructor(host: EmbedHost) {
+    this.host = host;
+    new Task<TaskDeps, void>(
+      this.host,
+      async ([env, apiKey, data, vouchId, templateId]: TaskDeps) => {
+        try {
+          host.vouch = undefined;
+          host.template = undefined;
+
+          if (data) {
+            let template;
+            if (templateId) {
+              this.fetching = true;
+              template = await this.getTemplate(env, apiKey, templateId);
+            }
+            host.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),
+              templateId ? this.getTemplate(env, apiKey, templateId) : null
+            ]);
+            host.vouch = vouch;
+            host.template = template ?? vouch?.settings?.template?.instance;
+          }
+        } finally {
+          this.fetching = false;
+        }
+      },
+      () => [host.env, host.apiKey, host.data, host.vouchId, host.templateId]
+    );
+  }
+}
+
+export { FetcherController };

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

@@ -0,0 +1,281 @@
+/* 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';
+
+// 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;
+};
+
+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 = {};
+
+  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, 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;
+  };
+
+  private _handleVideoTimeUpdate = ({ detail: { id, key, node } }: CustomEvent<VideoEventDetail>) => {
+    const vouchId = this._findVouchId();
+
+    if (!vouchId) {
+      return;
+    }
+
+    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
+      node.currentTime - this._streamedTime[key] > STREAMED_THROTTLE
+    ) {
+      this._sendTrackingEvent('VIDEO_STREAMED', {
+        vouchId,
+        answerId: id,
+        streamStart: this._streamedTime[key],
+        streamEnd: node.currentTime
+      });
+      this._streamedTime[key] = node.currentTime;
+    }
+
+    if (!this.host.paused) {
+      this._streamLatestTime[key] = node.currentTime;
+    }
+  };
+
+  private _handleVideoPause = ({ detail: { id, key } }: CustomEvent<VideoEventDetail>) => {
+    const vouchId = this._findVouchId();
+
+    if (!vouchId) {
+      return;
+    }
+
+    // Don't send a tracking event if the video pauses when seeking backwards
+    if (this._streamLatestTime[key] > this._streamedTime[key] + 0.5) {
+      // 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: this._streamLatestTime[key]
+      });
+    }
+
+    delete this._streamedTime[key];
+    delete this._streamLatestTime[key];
+  };
+
+  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: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:pause', this._handleVideoPause);
+    this.host.mediaPlayer?.removeEventListener('video:timeupdate', this._handleVideoTimeUpdate);
+  }
+}
+
+export { TrackingController };