feat: capture request_url for HLS/DASH chunks, add browser env checks, fix destroyHlsMonitoring error, update UUID for web/mobile

Author: HarishKumar097

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.4]
+- Added `request_url` to capture each video chunk URL in hls and dash players.
+- Implemented strict checks for `document` and `window` objects to ensure execution only in browser environments.
+- Fixed bug where `destroyHlsMonitoring` could throw a runtime error.
+- Updated UUID generation method to work seamlessly across both web and mobile applications.
+
 ## [1.0.3]
 - Updated `package.json` to include additional keywords related to video analytics, HLS, and DASH players.
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastpix/video-data-core",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "author": "FastPix, Inc",
   "license": "MIT",
   "description": "FastPix Video Data SDK for real-time monitoring of HTML5 video players.",
@@ -41,8 +41,5 @@
     "esbuild": "^0.25.4",
     "prettier": "^3.3.3",
     "typescript": "^5.3.2"
-  },
-  "dependencies": {
-    "uuid": "^11.0.5"
   }
 }

package.json

@@ -1,5 +1,3 @@
-import { v4 as uuidv4 } from "uuid";
-
 const idCharacter = "000000";
 
 // Returns 6 characters id
@@ -12,13 +10,23 @@ const generateIdToken: () => string = function () {
   return idCharacter.slice(idPart.length) + idPart;
 };
 
+function generateFallbackUUID(): string {
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(
+    /[xy]/g,
+    function (char) {
+      const random = (Math.random() * 16) | 0;
+      const value = char === "x" ? random : (random & 0x3) | 0x8;
+      return value.toString(16);
+    },
+  );
+}
+
 // Returns unique UUID
 const buildUUID: () => string = function () {
-  return uuidv4();
+  return generateFallbackUUID();
 };
 
 const generateRandomIdentifier: () => string = function () {
-  
   return (
     idCharacter + ((Math.random() * Math.pow(36, 6)) << 0).toString(36)
   ).slice(-6);

src/IdGenerationMethod/index.ts

@@ -14,10 +14,10 @@ interface Emitter {
 }
 
 export class PlaybackPulseHandler {
-  pulseInterval: boolean = false;
   playheadProgressing: boolean = false;
   pulse: Pulse;
   emitter: Emitter;
+  pulseIntervalId: ReturnType<typeof setInterval> | null = null;
 
   constructor(pulse: Pulse, emitter: Emitter) {
     this.pulse = pulse;
@@ -26,15 +26,21 @@ export class PlaybackPulseHandler {
   }
 
   callPulseInterval() {
-    if (this.pulse.worker) {
-      this.pulse.worker.postMessage({ command: "initiatePulseInterval" });
+    if (!this.pulseIntervalId) {
+      this.pulse.dispatch("pulseStart");
+      this.pulseIntervalId = setInterval(() => {
+        this.pulse.dispatch("pulseStart");
+      }, 25);
     }
   }
 
   endPulseInterval() {
     this.pulse.playheadProgressing = false;
-    if (this.pulse.worker) {
-      this.pulse.worker.postMessage({ command: "demolishPulseInterval" });
+
+    if (this.pulseIntervalId) {
+      clearInterval(this.pulseIntervalId);
+      this.pulse.dispatch("pulseEnd");
+      this.pulseIntervalId = null;
     }
   }
 
@@ -56,7 +62,7 @@ export class PlaybackPulseHandler {
   };
 
   handleTimeUpdate = () => {
-    if (this.pulseInterval) {
+    if (this.pulseIntervalId) {
       this.pulse.dispatch("pulseStart");
     }
   };

src/MonitorMetrics/PlaybackPulseHandler.ts

@@ -87,9 +87,13 @@ export class PlaybackEventHandler {
     this.previousBeaconData = null;
     this.sdkPageDetails = {
       viewer_connection_type: getNetworkConnection(),
-      page_url: window?.location?.href ?? "",
+      page_url: typeof window !== "undefined" ? window?.location?.href : "",
     };
-    this.userData = this.disableCookies ? {} : getViewerCookie();
+
+    const canAccessDocument = typeof document !== "undefined";
+    this.userData = (this.disableCookies || !canAccessDocument)
+      ? {}
+      : getViewerCookie();
   }
 
   sendData(event: string, obj: EventMetaData): void {
@@ -107,8 +111,13 @@ export class PlaybackEventHandler {
       );
       return;
     }
-    const data = this.prepareEventData(event, obj);
-    
+    let data = this.prepareEventData(event, obj);
+    data = Object.fromEntries(
+      Object.entries(data).filter(
+        ([_, value]) => value !== undefined && !Number.isNaN(value),
+      ),
+    );
+
     this.eventQueue.scheduleEvent(data);
 
     if (event === "viewCompleted") {
@@ -143,11 +152,15 @@ export class PlaybackEventHandler {
   }
 
   prepareEventData(event: string, obj: EventMetaData) {
-    const cookieUpdater = this.disableCookies ? {} : this.updateCookies();
+    const cookieSessionData =
+      this.disableCookies || typeof document === "undefined"
+        ? {}
+        : this.updateCookies();
+
     const data = mergeObjects(
       this.sdkPageDetails,
       obj,
-      cookieUpdater,
+      cookieSessionData,
       this.userData,
       {
         event_name: event,
@@ -230,12 +243,16 @@ export class PlaybackEventHandler {
     }
   }
 
-  updateCookies(): {
-    session_id: string;
-    session_start: string;
-    session_expiry_time: number;
-  } {
-    const data = getViewerData();
+  updateCookies():
+    | {
+      session_id: string;
+      session_start: string;
+      session_expiry_time: number | string;
+    }
+    | {} {
+    if (typeof document === "undefined") return {};
+
+    const data: any = getViewerData();
     const cookieTimer = Date.now();
 
     if (

src/MonitorMetrics/PlayerEventHandler.ts

@@ -8,7 +8,6 @@ import {
   ListenerManager,
 } from "../CommonMethods/index";
 import { buildUUID } from "../IdGenerationMethod/index";
-import { createTimerWorker, inlineWorkerText } from "../Worker/index";
 import { BufferMonitor, BufferProcessor } from "./VideoBufferMonitor";
 import { ErrorManager } from "./ErrorManager";
 import { PlaybackEventHandler } from "./PlayerEventHandler";
@@ -56,14 +55,15 @@ function nucleusState(
     disableCookies: actionableData.disableCookies ?? false,
     respectDoNotTrack: actionableData.respectDoNotTrack ?? false,
     allowRebufferTracking: false,
-    disablePlayheadRebufferTracking: false,
+    disablePlayheadRebufferTracking:
+      actionableData.disablePlayheadRebufferTracking ?? false,
     errorConverter: function (errAttr: any) {
       return errAttr;
     },
   };
   actionableData = {
-    actionableData,
     ...defaultConfig,
+    actionableData,
   };
   fileInstance.userConfigData = actionableData;
   fileInstance.fetchPlayheadTime =
@@ -90,34 +90,7 @@ function nucleusState(
   fileInstance.data.view_sequence_number = 1;
   fileInstance.data.player_sequence_number = 1;
   fileInstance.lastCheckedEventTime = void 0;
-
-  // Initiating web workers
-  fileInstance.worker = createTimerWorker(inlineWorkerText);
-
-  // Message from web worker
-  fileInstance.worker.onmessage = function (message: any) {
-    let messageCommand: string = message.data.command;
-
-    switch (messageCommand) {
-      case "pulseStart":
-        fileInstance.dispatch(messageCommand);
-        fileInstance.handlePulse.pulseInterval = true;
-        break;
-
-      case "pulseEnd":
-        fileInstance.playheadProgressing = false;
-        fileInstance.dispatch(messageCommand);
-        fileInstance.handlePulse.pulseInterval = false;
-        break;
-
-      case "emitPulse":
-        fileInstance.dispatch("pulse");
-        break;
-
-      default:
-        return;
-    }
-  };
+  fileInstance.throbTimeoutId = undefined;
 
   fileInstance.dispatch = function (
     name: string,
@@ -176,7 +149,10 @@ function nucleusState(
     fileInstance.demolishView();
   };
 
-  if (window && typeof window !== "undefined") {
+  if (
+    typeof window !== "undefined" &&
+    typeof window.addEventListener !== "undefined"
+  ) {
     window.addEventListener(
       "pagehide",
       function (event) {
@@ -389,8 +365,6 @@ nucleusState.prototype.validateData = function () {
 };
 
 nucleusState.prototype.filterData = function (str: string) {
-  const workerInstance = this;
-
   if (this.data.view_id) {
     if (
       this.data.player_source_duration > 0 ||
@@ -413,18 +387,29 @@ nucleusState.prototype.filterData = function (str: string) {
     this.eventsDispatcher.sendData(str, updatedata);
     this.data.view_sequence_number++;
     this.data.player_sequence_number++;
-    workerInstance.worker.postMessage({
-      command: "checkPulse",
-      pausestate: workerInstance.data.player_is_paused,
-      errortracker: workerInstance.warning.hasErrorOccurred,
-    });
+
+    this.handlePulseEvent(this);
 
     if (str === "viewCompleted") {
       delete this.data.view_id;
     }
   }
 };
 
+nucleusState.prototype.handlePulseEvent = (instance: any) => {
+  if (instance.throbTimeoutId) {
+    clearTimeout(instance.throbTimeoutId);
+  }
+
+  if (!instance.warning.hasErrorOccurred) {
+    instance.throbTimeoutId = setTimeout(() => {
+      if (!instance.data.player_is_paused) {
+        instance.dispatch("pulse");
+      }
+    }, 10000);
+  }
+};
+
 nucleusState.prototype.refreshViewData = function () {
   const view = this;
   Object.keys(this.data).forEach(function (k) {

src/MonitorMetrics/index.ts

@@ -29,6 +29,7 @@ export const setupHlsMonitoring = (
       request_response_end: timerData.responseEnd,
       request_type: "manifest",
       request_hostname: getHostName(url),
+      request_url: url ?? "",
       request_response_headers: headers,
       ...details,
     };
@@ -135,7 +136,7 @@ export const setupHlsMonitoring = (
   ) => {
     const switchLevel = hlstag.levels[lvl.level];
     if (!switchLevel?.attrs?.BANDWIDTH) {
-       return;
+      return;
     }
 
     const levelSwitchEvent = {