@newrelic/video-core 4.1.3 → 4.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/video-core",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "New Relic video tracking core library",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

package/src/agent.js

@@ -50,8 +50,16 @@ class VideoAnalyticsAgent {
 
     try {
       if(eventObject.actionName && eventObject.actionName === Tracker.Events.QOE_AGGREGATE) {
-          // Ensure only one QOE_AGGREGATE event exists in buffer per harvest cycle.
+          // Ensure only one QOE_AGGREGATE event per (actionName + viewId) in buffer per harvest cycle.
+          // Each player has a unique viewId, so multi-player scenarios are handled correctly.
           // Dirty-check dedup happens at drain time in HarvestScheduler._qoeKpisUnchanged().
+          if (eventObject.viewId) {
+              return this.eventBuffer.addOrReplaceByActionNameAndViewId(
+                  Tracker.Events.QOE_AGGREGATE,
+                  eventObject.viewId,
+                  eventObject
+              );
+          }
           return this.eventBuffer.addOrReplaceByActionName(Tracker.Events.QOE_AGGREGATE, eventObject);
       }
       return this.eventBuffer.add(eventObject);
@@ -96,12 +104,15 @@ class VideoAnalyticsAgent {
 
   /**
    * Updates QoE KPI fields on the existing QOE_AGGREGATE event in the buffer.
-   * Uses addOrReplaceByActionName to keep payload size tracking accurate.
+   * Scoped to a specific viewId to support multiple players on the same page.
    * @param {object} freshKpis - Object with latest KPI values
+   * @param {string} [viewId] - The viewId of the player whose QoE event to update
    */
-  refreshQoeKpis(freshKpis) {
+  refreshQoeKpis(freshKpis, viewId) {
     if (!this.eventBuffer || !freshKpis) return;
-    const existing = this.eventBuffer.findByActionName(Tracker.Events.QOE_AGGREGATE);
+    const existing = viewId
+      ? this.eventBuffer.findByActionNameAndViewId(Tracker.Events.QOE_AGGREGATE, viewId)
+      : this.eventBuffer.findByActionName(Tracker.Events.QOE_AGGREGATE);
     if (existing) {
       const updated = { ...existing };
       for (const key of Constants.QOE_KPI_KEYS) {
@@ -109,7 +120,11 @@ class VideoAnalyticsAgent {
           updated[key] = freshKpis[key];
         }
       }
-      this.eventBuffer.addOrReplaceByActionName(Tracker.Events.QOE_AGGREGATE, updated);
+      if (viewId) {
+        this.eventBuffer.addOrReplaceByActionNameAndViewId(Tracker.Events.QOE_AGGREGATE, viewId, updated);
+      } else {
+        this.eventBuffer.addOrReplaceByActionName(Tracker.Events.QOE_AGGREGATE, updated);
+      }
     }
   }
 }

package/src/eventAggregator.js

@@ -55,6 +55,44 @@ export class NrVideoEventAggregator {
       }
     }
 
+  /**
+   * If an event with the specified actionName and viewId already exists in the buffer, it will be replaced.
+   * Otherwise, the event will be added as a new entry.
+   * @param {string} actionName - The actionName to search for in the buffer
+   * @param {string} viewId - The viewId to scope the lookup to
+   * @param {object} eventObject - The event object to add or use as replacement.
+   * @returns {boolean} True if the operation succeeded, false if an error occurred
+   */
+  addOrReplaceByActionNameAndViewId(actionName, viewId, eventObject) {
+      const i = this.buffer.findIndex(
+          e => e.actionName === actionName && e.viewId === viewId
+      );
+      try {
+          if (i === -1) {
+              this.add(eventObject);
+          } else {
+              this.add(eventObject, i);
+          }
+          return true;
+      } catch (error) {
+          Log.error("Failed to set or replace the event to buffer:", error.message);
+          return false;
+      }
+  }
+
+  /**
+   * Returns the existing event in buffer matching the given actionName and viewId, or null.
+   * @param {string} actionName
+   * @param {string} viewId
+   * @returns {object|null}
+   */
+  findByActionNameAndViewId(actionName, viewId) {
+      const event = this.buffer.find(
+          e => e.actionName === actionName && e.viewId === viewId
+      );
+      return event || null;
+  }
+
   /**
    * Returns the existing event in buffer matching the given actionName, or null.
    * @param {string} actionName

package/src/harvestScheduler.js

@@ -35,7 +35,7 @@ export class HarvestScheduler {
     this.qoeCycleCount = 1;
     this.forceNextQoeCycle = false;
     this.beforeDrainCallback = null;
-    this._lastSentQoeKpis = null;
+    this._lastSentQoeKpis = {};
 
     // Page lifecycle handling
     this.setupPageLifecycleHandlers();
@@ -476,22 +476,24 @@ export class HarvestScheduler {
    * @private
    */
   _qoeKpisUnchanged(event) {
-    if (!this._lastSentQoeKpis) return false;
+    const snapshot = this._lastSentQoeKpis[event.viewId];
+    if (!snapshot) return false;
     for (const key of Constants.QOE_KPI_KEYS) {
-      if (event[key] !== this._lastSentQoeKpis[key]) return false;
+      if (event[key] !== snapshot[key]) return false;
     }
     return true;
   }
 
   /**
-   * Saves QoE KPI values after sending.
+   * Saves QoE KPI values after sending, keyed by viewId to support multiple players.
    * @param {object} event - QoE event that was sent
    * @private
    */
   _saveQoeKpis(event) {
-    this._lastSentQoeKpis = {};
+    const snapshot = {};
     for (const key of Constants.QOE_KPI_KEYS) {
-      this._lastSentQoeKpis[key] = event[key];
+      snapshot[key] = event[key];
     }
+    this._lastSentQoeKpis[event.viewId] = snapshot;
   }
 }

package/src/obfuscate.js

@@ -0,0 +1,33 @@
+import Log from "./log";
+
+/**
+ * Applies obfuscation rules to a JSON string before sending to the collector.
+ * Each rule replaces matches of `regex` with `replacement` in the string.
+ *
+ * @param {string} jsonString - Serialized JSON payload
+ * @param {Array<{regex: string|RegExp, replacement: string}>} rules - Obfuscation rules
+ * @returns {string} Obfuscated string
+ */
+export function applyObfuscationRules(jsonString, rules) {
+  if (!rules || rules.length === 0) return jsonString;
+
+  return rules.reduce((str, rule) => {
+    let pattern;
+    try {
+      if (rule.regex instanceof RegExp) {
+        // Ensure global flag so all occurrences are replaced
+        const flags = rule.regex.flags.includes("g")
+          ? rule.regex.flags
+          : rule.regex.flags + "g";
+        pattern = new RegExp(rule.regex.source, flags);
+      } else {
+        pattern = new RegExp(rule.regex, "g");
+      }
+    } catch (e) {
+      Log.warn("applyObfuscationRules: invalid regex, skipping rule:", rule.regex, e.message);
+      return str;
+    }
+    let s = str.replace(pattern, rule.replacement);
+    return s;
+  }, jsonString);
+}

package/src/optimizedHttpClient.js

@@ -1,5 +1,6 @@
-import { dataSize, shouldRetry } from "./utils";
+import { shouldRetry } from "./utils";
 import Log from "./log";
+import { applyObfuscationRules } from "./obfuscate";
 
 /**
  * Optimized HTTP client for video analytics data transmission with
@@ -50,7 +51,10 @@ export class OptimizedHttpClient {
     const startTime = Date.now();
 
     try {
-      const requestBody = JSON.stringify(payload.body);
+      const requestBody = applyObfuscationRules(
+        JSON.stringify(payload.body),
+        window.NRVIDEO?.config?.obfuscate
+      );
 
       // Handle final harvest with sendBeacon
       if (options.isFinalHarvest && navigator.sendBeacon) {

package/src/videoConfiguration.js

@@ -92,16 +92,39 @@ class VideoConfiguration {
       return false;
     }
 
-    const { qoeAggregate } = config;
+    const { qoeAggregate, obfuscate } = config;
 
     if (qoeAggregate !== undefined && typeof qoeAggregate !== "boolean") {
       Log.error("qoeAggregate must be a boolean");
       return false;
     }
 
+    if (obfuscate !== undefined && !Array.isArray(obfuscate)) {
+      Log.error("obfuscate must be an array");
+      return false;
+    }
+
     return true;
   }
 
+  /**
+   * Filters obfuscation rules, warning about and removing invalid ones.
+   * @param {Array} rules - Raw obfuscation rules
+   * @returns {Array} Valid rules only
+   */
+  filterObfuscateRules(rules) {
+    if (!rules) return [];
+    return rules.filter((rule) => {
+      const hasRegex = rule.regex !== undefined && (typeof rule.regex === "string" || rule.regex instanceof RegExp);
+      const hasReplacement = rule.replacement !== undefined && typeof rule.replacement === "string";
+      if (!hasRegex || !hasReplacement) {
+        Log.warn("obfuscate rule missing required 'regex' (string|RegExp) and/or 'replacement' (string), skipping:", rule);
+        return false;
+      }
+      return true;
+    });
+  }
+
   /**
    * Sanitizes qoeIntervalFactor, defaulting to 1 if the value is not a positive integer.
    * @param {*} value
@@ -141,6 +164,7 @@ class VideoConfiguration {
       config: {
         qoeAggregate: config?.qoeAggregate ?? false,
         qoeIntervalFactor: this.sanitizeQoeIntervalFactor(config?.qoeIntervalFactor),
+        obfuscate: this.filterObfuscateRules(config?.obfuscate),
       }
     };
   }

package/src/videotracker.js

@@ -647,7 +647,7 @@ class VideoTracker extends Tracker {
         videoAnalyticsHarvester.setBeforeDrainCallback(() => {
           if (this.state) {
             const freshKpis = this.state.getQoeAttributes({}).qoe;
-            videoAnalyticsHarvester.refreshQoeKpis(freshKpis);
+            videoAnalyticsHarvester.refreshQoeKpis(freshKpis, this.getViewId());
           }
         });
       }