@newrelic/video-core 4.1.0-beta → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/video-core",
-  "version": "4.1.0-beta",
+  "version": "4.1.0",
   "description": "New Relic video tracking core library",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -10,7 +10,7 @@
     "watch": "webpack --mode production --progress --color --watch",
     "watch:dev": "webpack --progress --color --watch",
     "clean": "rm -rf dist coverage doc",
-    "test": "nyc --reporter=html --reporter=text mocha --require @babel/register",
+    "test": "jest --coverage",
     "doc": "jsdoc -c jsdoc.json -d documentation",
     "deploy": "node scripts/deploy.js",
     "third-party-updates": "oss third-party manifest --includeOptDeps && oss third-party notices --includeOptDeps && git add THIRD_PARTY_NOTICES.md third_party_manifest.json"
@@ -33,9 +33,11 @@
     "@babel/preset-env": "^7.24.5",
     "@babel/register": "^7.24.6",
     "aws-sdk": "^2.920.0",
+    "babel-jest": "^30.2.0",
     "babel-loader": "^9.1.3",
-    "chai": "^4.3.4",
     "diff": "^5.0.0",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
     "jsdom": "^25.0.1",
     "mocha": "^10.4.0",
     "nyc": "^15.1.0",

package/src/constants.js

@@ -45,7 +45,11 @@ Constants.INTERVAL = 10000; //10 seconds
 Constants.QOE_AGGREGATE_KEYS = [
     "coreVersion", "instrumentation.name",
     "instrumentation.provider", "instrumentation.version", "isBackgroundEvent", "playerName", "playerVersion",
-    "src", "viewId", "viewSession", "contentIsAutoplayed"
+    "src", "viewId", "viewSession", "contentIsAutoplayed", "contentIsMuted", "contentRenditionHeight", "contentRenditionWidth",
+    "contentSrc", "numberOfVideos", "pageUrl", "trackerName", "trackerVersion", "contentDuration", "contentPlayrate", "contentPlayhead",
+    "contentPreload", "elapsedTime", "contentTitle", "contentId", "contentIsLive", "deviceType", "deviceGroup", "deviceManufacturer",
+    "deviceModel", "deviceName", "deviceSize", "deviceUuid", "contentRenditionName", "contentIsFullscreen", "contentCdn",
+    "contentFps", "asnOrganization", "asnLongitude", "asnLatitude", "asn", "timeSinceRequested", "timeSinceStarted"
 ]
 
 export default Constants;

package/src/core.js

@@ -16,7 +16,7 @@ class Core {
   static addTracker(tracker, options) {
     // Set video analytics configuration
     if (options?.info) {
-      setVideoConfig(options.info);
+      setVideoConfig(options.info, options?.config);
     }
     
     if (tracker.on && tracker.emit) {

package/src/eventAggregator.js

@@ -53,7 +53,6 @@ export class NrVideoEventAggregator {
           Log.error("Failed to set or replace the event to buffer:", error.message);
           return false;
       }
-      return false;
     }
 
   /**

package/src/recordEvent.js

@@ -47,6 +47,7 @@ export function recordEvent(eventType, attributes = {}) {
         qoeEventObject = {
             eventType: "VideoAction",
             actionName: Tracker.Events.QOE_AGGREGATE,
+            qoeAggregateVersion: '1.0.0',
             ...qoeAttrs,
             ...metadataAttributes,
             ...otherAttrs,
@@ -56,7 +57,7 @@ export function recordEvent(eventType, attributes = {}) {
     // Send to video analytics harvester
     const success = videoAnalyticsHarvester.addEvent(eventObject);
 
-    if(qoeEventObject) {
+    if(qoeEventObject && window?.NRVIDEO?.config?.qoeAggregate) {
         const successQoe = videoAnalyticsHarvester.addEvent(qoeEventObject);
         return success && successQoe;
     }

package/src/videoConfiguration.js

@@ -10,12 +10,19 @@ const { COLLECTOR } = Constants;
 class VideoConfiguration {
   /**
    * Validates and sets the video analytics configuration.
-   * @param {object} userConfig - User provided configuration
+   * @param {object} userInfo - User provided configuration
+   * @param {object} [config] - Optional configuration object
    * @returns {boolean} True if configuration is valid and set
    */
 
-  setConfiguration(userInfo) {
-    this.initializeGlobalConfig(userInfo);
+  setConfiguration(userInfo, config) {
+    if (!this.validateRequiredFields(userInfo)) {
+      return false;
+    }
+    if (!this.validateConfigFields(config)) {
+      return false;
+    }
+    this.initializeGlobalConfig(userInfo, config);
     Log.notice("Video analytics configuration initialized successfully");
     return true;
   }
@@ -70,11 +77,37 @@ class VideoConfiguration {
     return true;
   }
 
+  /**
+   * Validates optional config fields.
+   * @param {object} config - Config to validate
+   * @returns {boolean} True if valid
+   */
+  validateConfigFields(config) {
+    if (config === null || config === undefined) {
+      return true;
+    }
+
+    if (typeof config !== "object" || Array.isArray(config)) {
+      Log.error("config must be an object");
+      return false;
+    }
+
+    const { qoeAggregate } = config;
+
+    if (qoeAggregate !== undefined && typeof qoeAggregate !== "boolean") {
+      Log.error("qoeAggregate must be a boolean");
+      return false;
+    }
+
+    return true;
+  }
+
   /**
    * Initializes the global NRVIDEO configuration object.
+   * @param {object} userInfo - User provided configuration
+   * @param {object} [config] - Optional configuration object
    */
-  initializeGlobalConfig(userInfo) {
-    if (!this.validateRequiredFields(userInfo)) return;
+  initializeGlobalConfig(userInfo, config) {
 
     let { licenseKey, appName, region, beacon, applicationID } = userInfo;
 
@@ -93,6 +126,9 @@ class VideoConfiguration {
         applicationID,
         ...(applicationID ? {} : { appName }), // Only include appName when no applicationID
       },
+      config: {
+        qoeAggregate: config?.qoeAggregate ?? false,
+      }
     };
   }
 }
@@ -102,11 +138,12 @@ const videoConfiguration = new VideoConfiguration();
 
 /**
  * Sets the video analytics configuration.
- * @param {object} config - Configuration object
+ * @param {object} info - Info configuration object
+ * @param {object} [config] - Optional configuration object
  * @returns {boolean} True if configuration was set successfully
  */
-export function setVideoConfig(info) {
-  return videoConfiguration.setConfiguration(info);
+export function setVideoConfig(info, config) {
+  return videoConfiguration.setConfiguration(info, config);
 }
 
 export { videoConfiguration };

package/src/videotracker.js

@@ -465,12 +465,17 @@ class VideoTracker extends Tracker {
       att.adTitle = this.getTitle();
       att.adSrc = this.getSrc();
       att.adCdn = this.getCdn();
-      att.adBitrate =
-        this.getBitrate() ||
-        this.getWebkitBitrate() ||
-        this.getRenditionBitrate();
+
+      // Only add bitrate attributes after ad has started
+      if (this.state.isStarted) {
+        att.adBitrate =
+          this.getBitrate() ||
+          this.getWebkitBitrate() ||
+          this.getRenditionBitrate();
+        att.adRenditionBitrate = this.getRenditionBitrate();
+      }
+
       att.adRenditionName = this.getRenditionName();
-      att.adRenditionBitrate = this.getRenditionBitrate();
       att.adRenditionHeight = this.getRenditionHeight();
       att.adRenditionWidth = this.getRenditionWidth();
       att.adDuration = this.getDuration();
@@ -492,13 +497,17 @@ class VideoTracker extends Tracker {
       att.contentPlayhead = this.getPlayhead();
 
       att.contentIsLive = this.isLive();
-      att.contentBitrate =
-        this.getBitrate() ||
-        this.getWebkitBitrate() ||
-        this.getRenditionBitrate();
+
+      // Only add bitrate attributes after content has started
+      if (this.state.isStarted) {
+        att.contentBitrate =
+          this.getBitrate() ||
+          this.getWebkitBitrate() ||
+          this.getRenditionBitrate();
+        att.contentRenditionBitrate = this.getRenditionBitrate();
+      }
 
       att.contentRenditionName = this.getRenditionName();
-      att.contentRenditionBitrate = this.getRenditionBitrate();
       att.contentRenditionHeight = this.getRenditionHeight();
       att.contentRenditionWidth = this.getRenditionWidth();
       att.contentDuration = this.getDuration();

package/src/videotrackerstate.js

@@ -93,6 +93,11 @@ class VideoTrackerState {
      */
     this._lastBitrate = null;
 
+    /**
+     * Tracks the last updated timestamp for bitrate
+     * */
+    this._lastBitrateChangeTimestamp = null;
+
     /**
      * total bitrate partial value for average weighted average bitrate
      */
@@ -358,6 +363,7 @@ class VideoTrackerState {
               : 0;
           kpi["totalPlaytime"] = this.totalPlaytime;
           kpi["averageBitrate"] = this.weightedBitrate;
+          kpi["numberOfErrors"] = this.numberOfErrors;
       } catch (error) {
           Log.error("Failed to add attributes for QOE KPIs", error.message);
       }
@@ -691,11 +697,12 @@ class VideoTrackerState {
       this.peakBitrate = Math.max(this.peakBitrate, bitrate);
 
       if(this._lastBitrate === null || this._lastBitrate !== bitrate) {
-        const totalPlaytime = this.timeSinceLastRenditionChange.getDeltaTime() || this.totalPlaytime;
-        const currentWeightedBitrate = (bitrate * totalPlaytime);
+        const deltaPlaytime = this._lastBitrateChangeTimestamp === null ? this.totalPlaytime : Date.now() - this._lastBitrateChangeTimestamp;
+        const currentWeightedBitrate = (bitrate * deltaPlaytime);
         this.partialAverageBitrate += currentWeightedBitrate;
-        this.weightedBitrate = currentWeightedBitrate / totalPlaytime;
+        this.weightedBitrate = currentWeightedBitrate / deltaPlaytime;
         this._lastBitrate = bitrate;
+        this._lastBitrateChangeTimestamp = Date.now();
       }
     }
   }
@@ -708,6 +715,7 @@ class VideoTrackerState {
     this.partialAverageBitrate = 0;
     this.startupTime = null;
     this._lastBitrate = null;
+    this._lastBitrateChangeTimestamp = null;
   }
 
   /** Methods to manage total ads time chrono */