@newrelic/video-core 4.1.7 → 4.1.8

package/package.json

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

package/src/videotracker.js

@@ -289,7 +289,7 @@ class VideoTracker extends Tracker {
    * saving the current rendition and thus preventing interferences with RENDITION_CHANGE events.
    */
   getRenditionShift(saveNewRendition) {
-    let current = this.getRenditionBitrate();
+    let current = this.getManifestBitrate();
     let last;
     if (this.isAd()) {
       last = this._lastAdRendition;
@@ -544,26 +544,24 @@ class VideoTracker extends Tracker {
 
     if(this.state.isStarted && !this.isAd()) {
       this.state.trackContentBitrateState(att.contentBitrate);
+      this.state.trackDownloadRate(att.contentNetworkDownloadBitrate);
+      this.state.addPlayedRendition(att.contentRenditionHeight, att.contentRenditionWidth);
     }
 
     for (let key in this.customData) {
       att[key] = this.customData[key];
     }
 
-    /**
-     * Adds all the attributes and custom attributes for qoe event
-     */
-    this.addQoeAttributes(att);
-
-    return att;
-  }
-
-  addQoeAttributes(att) {
-      att = this.state.getQoeAttributes(att);
+    // Add QOE v1.1 attributes (for content only, not ads)
+    if (!this.isAd()) {
+      this.state.getQoeAttributes(att);
       const qoe = att.qoe;
       for (let key in this.customData) {
-          qoe[key] = this.customData[key];
+        qoe[key] = this.customData[key];
       }
+    }
+
+    return att;
   }
 
   /**
@@ -669,7 +667,10 @@ class VideoTracker extends Tracker {
         ev = VideoTracker.Events.AD_END;
         att.timeSinceAdRequested = this.state.timeSinceRequested.getDeltaTime();
         att.timeSinceAdStarted = this.state.timeSinceStarted.getDeltaTime();
-        if (this.parentTracker) this.parentTracker.state.isPlaying = true;
+        if (this.parentTracker) {
+          this.parentTracker.state.isPlaying = true;
+          this.parentTracker.state.timeSincePaused.reset();
+        }
         this.state.stopAdsTime();
       } else {
         ev = VideoTracker.Events.CONTENT_END;
@@ -713,8 +714,6 @@ class VideoTracker extends Tracker {
       this.isAd()
         ? this.sendVideoAdAction(ev, att)
         : this.sendVideoAction(ev, att);
-
-      //this.send(ev, att);
     }
   }
 
@@ -899,7 +898,25 @@ class VideoTracker extends Tracker {
     att = att || {};
     att.timeSinceLastRenditionChange =
       this.state.timeSinceLastRenditionChange.getDeltaTime();
-    att.shift = this.getRenditionShift(true);
+
+    const {oldBitrate, newBitrate} = att;
+
+    if (!this.isAd() && oldBitrate !== undefined && newBitrate !== undefined) {
+      if (newBitrate > oldBitrate) {
+        att.shift = "up";
+        this.state.totalSwitchUps += 1;
+      } else if (newBitrate < oldBitrate) {
+        att.shift = "down";
+        this.state.totalSwitchDowns += 1;
+      } else {
+        att.shift = null;
+      }
+    }
+
+    // Remove internal tracking fields before sending to analytics
+    delete att.oldBitrate;
+    delete att.newBitrate;
+
     let ev;
     if (this.isAd()) {
       ev = VideoTracker.Events.AD_RENDITION_CHANGE;

package/src/videotrackerstate.js

@@ -89,24 +89,45 @@ class VideoTrackerState {
     this.peakBitrate = 0;
 
     /**
-     * Last tracked bitrate
+     * Time-weighted bitrate calculation accumulators
      */
+    this.partialAverageBitrate = 0;
+    this._totalBitrateDuration = 0;
+    this.weightedBitrate = 0;
     this._lastBitrate = null;
+    this._lastBitrateChangeTimestamp = null;
 
     /**
-     * Tracks the last updated timestamp for bitrate
-     * */
-    this._lastBitrateChangeTimestamp = null;
+     * Array of changed network download bitrate values (only values that differ from previous).
+     * Used for calculating simple mean, min, max (not time-weighted).
+     */
+    this._downloadBitrates = [];
 
     /**
-     * total bitrate partial value for average weighted average bitrate
+     * Previous download bitrate value to detect changes.
      */
-    this.partialAverageBitrate = 0;
+    this._lastDownloadBitrate = null;
 
     /**
-     * Total duration (ms) of all closed bitrate segments for weighted average
+     * QOE v1.1: Total number of rendition/quality switches where bitrate increased.
      */
-    this._totalBitrateDuration = 0;
+    this.totalSwitchUps = 0;
+
+    /**
+     * QOE v1.1: Total number of rendition/quality switches where bitrate decreased.
+     */
+    this.totalSwitchDowns = 0;
+
+    /**
+     * QOE v1.1: Total time in milliseconds spent in paused state (intentional pauses only).
+     * Calculated from timeSincePaused chrono accumulation.
+     */
+    this.totalPauseTime = 0;
+
+    /**
+     * QOE v1.1: Set of distinct renditions played, keyed by "heightxwidth" (e.g., "1080x1920").
+     */
+    this._playedRenditions = new Set();
 
     /**
      * Had Startup Error: TRUE if CONTENT_ERROR occurs before CONTENT_START.
@@ -352,7 +373,7 @@ class VideoTrackerState {
       const kpi = {};
 
       try {
-          // QoE KPIs - Content only
+          // QoE v1 KPIs
           if (this.startupTime !== null) {
               kpi["startupTime"] = this.startupTime;
           }
@@ -362,13 +383,35 @@ class VideoTrackerState {
           kpi["hadStartupError"] = this.hadStartupError;
           kpi["hadPlaybackError"] = this.hadPlaybackError;
           kpi["totalRebufferingTime"] = this.totalRebufferingTime;
-          // Calculate rebuffering ratio as percentage (avoid division by zero)
           kpi["rebufferingRatio"] = this.totalPlaytime > 0
               ? (this.totalRebufferingTime / this.totalPlaytime) * 100
               : 0;
           kpi["totalPlaytime"] = this.totalPlaytime;
           kpi["averageBitrate"] = this.weightedBitrate;
           kpi["numberOfErrors"] = this.numberOfErrors;
+
+          // QoE v1.1 KPIs - Download rate (simple mean of changed values)
+          if (this._downloadBitrates.length > 0) {
+              const sum = this._downloadBitrates.reduce((a, b) => a + b, 0);
+              kpi["avgDownloadRate"] = Math.round(sum / this._downloadBitrates.length);
+              kpi["minDownloadRate"] = Math.min(...this._downloadBitrates);
+              kpi["maxDownloadRate"] = Math.max(...this._downloadBitrates);
+          }
+
+          // QoE v1.1 KPIs - Rendition switching
+          kpi["totalSwitchUps"] = this.totalSwitchUps;
+          kpi["totalSwitchDowns"] = this.totalSwitchDowns;
+
+          // QoE v1.1 KPIs - Pause and session timing
+          kpi["totalPauseTime"] = this.timeSincePaused.getDuration();
+          kpi["totalViewSessionTime"] = this.totalPlaytime;
+
+          // QoE v1.1 KPIs - Renditions
+          kpi["totalRenditions"] = this._playedRenditions.size;
+
+          // Version tag
+          kpi["qoeAggregateVersion"] = "1.1.0";
+
       } catch (error) {
           Log.error("Failed to add attributes for QOE KPIs", error.message);
       }
@@ -696,7 +739,7 @@ class VideoTrackerState {
   }
 
   /**
-   * Updates peak bitrate with current bitrate value (content only).
+   * Updates peak bitrate and time-weighted average bitrate (content only).
    * @param {number} bitrate Current content bitrate in bps.
    */
   trackContentBitrateState(bitrate) {
@@ -757,16 +800,47 @@ class VideoTrackerState {
     }
   }
 
+  /**
+   * Records network download bitrate observation. Only tracks values that differ from previous.
+   * @param {number} bps Network throughput in bits per second.
+   */
+  trackDownloadRate(bps) {
+    if (!bps || typeof bps !== "number" || bps <= 0) return;
+    if (bps !== this._lastDownloadBitrate) {
+      this._downloadBitrates.push(bps);
+      this._lastDownloadBitrate = bps;
+    }
+  }
+
+  /**
+   * Records a rendition play event (height x width combination).
+   * @param {number} height Rendition height in pixels.
+   * @param {number} width Rendition width in pixels.
+   */
+  addPlayedRendition(height, width) {
+    if (height && width) {
+      this._playedRenditions.add(`${height}x${width}`);
+    }
+  }
+
+
   /**
    * Resets tracked variable for view id change
    * */
   resetViewIdTrackedState() {
     this.peakBitrate = 0;
+    this.startupTime = null;
     this.partialAverageBitrate = 0;
     this._totalBitrateDuration = 0;
-    this.startupTime = null;
+    this.weightedBitrate = 0;
     this._lastBitrate = null;
     this._lastBitrateChangeTimestamp = null;
+    this._downloadBitrates = [];
+    this._lastDownloadBitrate = null;
+    this.totalSwitchUps = 0;
+    this.totalSwitchDowns = 0;
+    this.timeSincePaused.reset();
+    this._playedRenditions = new Set();
   }
 
   /** Methods to manage total ads time chrono */