@newrelic/video-core 4.1.8 → 5.0.1

package/src/videoConfiguration.js

@@ -1,5 +1,6 @@
 import Log from "./log";
 import Constants from "./constants";
+import { ENDPOINT_URL } from "./connectedDevice/connectedDeviceConstants";
 
 const { COLLECTOR } = Constants;
 
@@ -15,18 +16,42 @@ class VideoConfiguration {
    * @returns {boolean} True if configuration is valid and set
    */
 
-  setConfiguration(userInfo, config) {
-    if (!this.validateRequiredFields(userInfo)) {
+  setConfiguration(userInfo, config, src) {
+    const validated = src === "Vega"
+      ? this.validateVegaFields(userInfo)
+      : this.validateRequiredFields(userInfo);
+    if (!validated) {
       return false;
     }
     if (!this.validateConfigFields(config)) {
       return false;
     }
-    this.initializeGlobalConfig(userInfo, config);
+    this.initializeGlobalConfig(userInfo, config, src);
     Log.notice("Video analytics configuration initialized successfully");
     return true;
   }
 
+  /**
+   * Validates required Vega configuration fields.
+   * @param {object} info
+   * @returns {boolean} True if valid
+   */
+  validateVegaFields(info) {
+    if (!info || typeof info !== "object") {
+      Log.error("Configuration must be an object");
+      return false;
+    }
+    if (!info.applicationToken) {
+      Log.error("applicationToken is required");
+      return false;
+    }
+    if (!(info.endpoint?.toLowerCase() in ENDPOINT_URL)) {
+      Log.error("Invalid endpoint (must be us, eu, staging, gov, or jp)");
+      return false;
+    }
+    return true;
+  }
+
   /**
    * Validates required configuration fields.
    * @param {object} config - Configuration to validate
@@ -126,15 +151,16 @@ class VideoConfiguration {
   }
 
   /**
-   * Sanitizes qoeIntervalFactor, defaulting to 2 if the value is not a positive integer.
+   * Sanitizes qoeIntervalFactor, defaulting to Constants.DEFAULT_QOE_INTERVAL_FACTOR
+   * if the value is not a positive integer.
    * @param {*} value
    * @returns {number}
    */
   sanitizeQoeIntervalFactor(value) {
-    if (value === undefined || value === null) return 2;
+    if (value === undefined || value === null) return Constants.DEFAULT_QOE_INTERVAL_FACTOR;
     if (typeof value === "number" && Number.isInteger(value) && value >= 1) return value;
-    Log.warn(`Invalid qoeIntervalFactor "${value}" — must be a positive integer. Defaulting to 2.`);
-    return 2;
+    Log.warn(`Invalid qoeIntervalFactor "${value}" — must be a positive integer. Defaulting to ${Constants.DEFAULT_QOE_INTERVAL_FACTOR}.`);
+    return Constants.DEFAULT_QOE_INTERVAL_FACTOR;
   }
 
   /**
@@ -142,7 +168,28 @@ class VideoConfiguration {
    * @param {object} userInfo - User provided configuration
    * @param {object} [config] - Optional configuration object
    */
-  initializeGlobalConfig(userInfo, config) {
+  initializeGlobalConfig(userInfo, config, src) {
+    // Vega path: write `globalThis.__NRVIDEO_CD__` with info+config only.
+    // The harvester is owned by `connectedDeviceAgent.js` as a module singleton — no
+    // harvester field on this global.
+    if (src === "Vega") {
+      globalThis.__NRVIDEO_CD__ = {
+        info: {
+          accountId: userInfo.accountId,
+          applicationToken: userInfo.applicationToken,
+          endpoint: userInfo.endpoint?.toLowerCase(),
+          ...(userInfo.appName ? { appName: userInfo.appName } : {}),
+          ...(userInfo.applicationID ? { applicationID: userInfo.applicationID } : {}),
+          ...(userInfo.deviceInfo ? { deviceInfo: userInfo.deviceInfo } : {}),
+        },
+        config: {
+          qoeAggregate: config?.qoeAggregate ?? true,
+          qoeIntervalFactor: this.sanitizeQoeIntervalFactor(config?.qoeIntervalFactor),
+          obfuscate: this.filterObfuscateRules(config?.obfuscate),
+        },
+      };
+      return;
+    }
 
     let { licenseKey, appName, region, beacon, applicationID } = userInfo;
 
@@ -179,8 +226,8 @@ const videoConfiguration = new VideoConfiguration();
  * @param {object} [config] - Optional configuration object
  * @returns {boolean} True if configuration was set successfully
  */
-export function setVideoConfig(info, config) {
-  return videoConfiguration.setConfiguration(info, config);
+export function setVideoConfig(info, config, src) {
+  return videoConfiguration.setConfiguration(info, config, src);
 }
 
 export { videoConfiguration };

package/src/videotracker.js

@@ -1,7 +1,6 @@
 import Log from "./log";
 import Tracker from "./tracker";
 import TrackerState from "./videotrackerstate";
-import { videoAnalyticsHarvester } from "./agent";
 import pkg from "../package.json";
 
 /**
@@ -45,6 +44,7 @@ class VideoTracker extends Tracker {
      */
     this._lastBufferType = null;
     this._userId = null;
+    this._src = null;
 
     options = options || {};
     this.setOptions(options);
@@ -84,6 +84,16 @@ class VideoTracker extends Tracker {
       if (typeof options.isAd === "boolean") {
         this.setIsAd(options.isAd);
       }
+      if (options.src !== undefined) {
+        if (this._src !== null && this._src !== options.src) {
+          Log.warn(`setOptions: src is locked to '${this._src}'. Ignoring override '${options.src}'.`);
+        } else {
+          this._src = options.src;
+          if (this.adsTracker && this.adsTracker._src == null) {
+            this.adsTracker._src = this._src;
+          }
+        }
+      }
       Tracker.prototype.setOptions.apply(this, arguments);
     }
   }
@@ -135,6 +145,12 @@ class VideoTracker extends Tracker {
       this.adsTracker = tracker;
       this.adsTracker.setIsAd(true);
       this.adsTracker.parentTracker = this;
+      // Propagate src so ads events route to the same pipeline as content events.
+      // Covers the case where setAdsTracker is called after the content tracker
+      // is fully initialised and this._src is already set.
+      if (this._src != null && tracker._src == null) {
+        tracker._src = this._src;
+      }
       this.adsTracker.on("*", funnelAdEvents.bind(this));
     }
   }
@@ -465,7 +481,7 @@ class VideoTracker extends Tracker {
     att["instrumentation.name"] = this.getInstrumentationName();
     att["instrumentation.version"] = this.getInstrumentationVersion();
     att["enduser.id"] = this._userId;
-    att["src"] = "Browser";
+    att["src"] = this._src || "Browser";
 
     if (type === "customAction") return att;
 
@@ -639,11 +655,11 @@ class VideoTracker extends Tracker {
         this.state.setStartupTime(totalAdsTime)
         this.sendVideoAction(ev, att);
 
-        // Register callback to refresh QoE KPIs with latest state before each drain
-        videoAnalyticsHarvester.setBeforeDrainCallback(() => {
+        const harvester = this.getHarvester?.();
+        harvester?.setBeforeDrainCallback(() => {
           if (this.state) {
             const freshKpis = this.state.getQoeAttributes({}).qoe;
-            videoAnalyticsHarvester.refreshQoeKpis(freshKpis, this.getViewId());
+            harvester.refreshQoeKpis(freshKpis, this.getViewId());
           }
         });
       }
@@ -688,14 +704,15 @@ class VideoTracker extends Tracker {
       this.state.goViewCountUp();
       this.state.totalPlaytime = 0;
       if(!this.isAd()) {
+        const harvester = this.getHarvester?.();
         // Force QoE to be included in the next harvest cycle at content end
-          videoAnalyticsHarvester.forceNextQoeCycle();
+        harvester?.forceNextQoeCycle?.();
         // Clear the before-drain callback so the next harvest doesn't overwrite
         // the final QoE (already in buffer) with zeroed-out state values
-          videoAnalyticsHarvester.setBeforeDrainCallback(null);
+        harvester?.setBeforeDrainCallback?.(null);
         // reset the states after the view count is up
-          if(this.adsTracker) this.adsTracker.state.clearTotalAdsTime();
-          this.state.resetViewIdTrackedState();
+        if(this.adsTracker) this.adsTracker.state.clearTotalAdsTime();
+        this.state.resetViewIdTrackedState();
       }
     }
   }