feat: update @svta/cml-cmcd to 2.4.0 - [Cursor]

package.json

@@ -91,11 +91,11 @@
   },
   "dependencies": {
     "@svta/cml-608": "1.0.2",
-    "@svta/cml-cmcd": "2.3.2",
+    "@svta/cml-cmcd": "2.4.0",
     "@svta/cml-cmsd": "1.0.6",
     "@svta/cml-dash": "1.0.6",
     "@svta/cml-id3": "1.0.6",
-    "@svta/cml-request": "1.0.12",
+    "@svta/cml-request": "1.0.13",
     "@svta/cml-xml": "1.1.4",
     "bcp-47-match": "^2.0.3",
     "codem-isoboxer": "0.3.10",

src/streaming/controllers/CmcdController.js

@@ -165,12 +165,35 @@ function CmcdController() {
         });
     }
 
-    function _onPlaybackStateChange(state) {
-        // Update CmcdReporter with the new player state
-        if (cmcdReporter) {
-            cmcdReporter.update({ sta: state });
+    function _partialHasStateField(partial) {
+        const stateFields = ['sta', 'pr', 'cid', 'bg', 'br'];
+        return stateFields.some((field) => field in partial);
+    }
+
+    function _updateCmcdReporter(partial = {}) {
+        if (!cmcdReporter) {
+            return;
+        }
+
+        _rebuildReporterIfNeeded();
+
+        const msdData = cmcdModel.calculateMsd();
+        const metrics = _partialHasStateField(partial)
+            ? cmcdModel.getEventModeData()
+            : cmcdModel.getContinuousCmcdData();
+        const payload = {
+            ...metrics,
+            ...partial,
+        };
+        if (msdData.msd !== undefined) {
+            payload.msd = msdData.msd;
         }
-        triggerCmcdEventMode(Constants.CMCD_REPORTING_EVENTS.PLAY_STATE);
+
+        cmcdReporter.update(payload);
+    }
+
+    function _onPlaybackStateChange(state) {
+        _updateCmcdReporter({ sta: state });
     }
 
     function _createCmcdReporter() {
@@ -250,15 +273,12 @@ function CmcdController() {
         if (errorData.error?.data?.request?.type === HTTPRequest.CMCD_EVENT) {
             return;
         }
-        // Update CmcdReporter with the error code
-        if (cmcdReporter) {
-            const errorCode = errorData.error?.code || errorData.error?.data?.code;
-            if (errorCode) {
-                cmcdReporter.update({ ec: errorCode });
-            }
+        const errorCode = errorData.error?.code || errorData.error?.data?.code;
+        const eventData = cmcdModel.getEventModeData();
+        if (errorCode !== undefined) {
+            eventData.ec = Array.isArray(errorCode) ? errorCode : [String(errorCode)];
         }
-
-        triggerCmcdEventMode(Constants.CMCD_REPORTING_EVENTS.ERROR);
+        triggerCmcdEventMode(Constants.CMCD_REPORTING_EVENTS.ERROR, eventData);
     }
 
     function _rebuildReporterIfNeeded() {
@@ -289,23 +309,23 @@ function CmcdController() {
      * The handler that is triggered for CMCD event mode events (e.g., play, pause, error). Note that response recevived (rr) events are handled by getCmcdResponseReceivedInterceptors.
      * @param event
      */
-    function triggerCmcdEventMode(event) {
+    function triggerCmcdEventMode(event, eventData) {
         if (!cmcdReporter) {
             return;
         }
 
         _rebuildReporterIfNeeded();
 
-        const cmcdData = cmcdModel.getEventModeData();
-
-        // Route media start delay (MSD) through update() for the reporter's internal send-once tracking
         const msdData = cmcdModel.calculateMsd();
         if (msdData.msd !== undefined) {
             cmcdReporter.update(msdData);
         }
 
-        // Pass event-mode data as transient per-event data (not persisted)
-        cmcdReporter.recordEvent(event, cmcdData);
+        const data = eventData !== undefined
+            ? eventData
+            : cmcdModel.getEventModeData();
+
+        cmcdReporter.recordEvent(event, data);
     }
 
     /**
@@ -324,13 +344,9 @@ function CmcdController() {
         _rebuildReporterIfNeeded();
 
         try {
-            const cmcdData = cmcdModel.deriveCmcdDataForRequest(request);
+            _updateCmcdReporter();
 
-            // Route MSD through update() for the reporter's internal send-once tracking
-            const msdData = cmcdModel.calculateMsd();
-            if (msdData.msd !== undefined) {
-                cmcdReporter.update(msdData);
-            }
+            const cmcdData = cmcdModel.deriveCmcdDataForRequest(request);
 
             const decorated = cmcdReporter.createRequestReport(request, cmcdData);
             request.url = decorated.url;
@@ -457,9 +473,10 @@ function CmcdController() {
 
     function _onPlaybackRateChanged(data) {
         const prData = cmcdModel.onPlaybackRateChanged(data);
-        if (cmcdReporter && prData) {
-            cmcdReporter.update(prData);
+        if (!prData) {
+            return;
         }
+        _updateCmcdReporter(prData);
     }
 
     function _onManifestLoaded(data) {

src/streaming/models/CmcdModel.js

@@ -554,20 +554,21 @@ function CmcdModel() {
         return Date.now() - _playbackStartedTime;
     }
 
-    function getGenericCmcdData(mediaType) {
+    function getGenericCmcdData(mediaType, options = {}) {
         const data = {};
+        const includeBackground = options.includeBackground !== false;
 
-        // Note: ts, st, sf, pr are handled by CmcdReporter:
-        // - ts: auto-generated by recordEvent() / recordResponseReceived()
-        // - st, sf: persisted via cmcdReporter.update() in _onManifestLoaded
-        // - pr: persisted via cmcdReporter.update() in _onPlaybackRateChanged
+        // Note: ts is auto-generated by CmcdReporter recordEvent / recordResponseReceived.
+        // st, sf: persisted via cmcdReporter.update() on manifest load (CmcdController).
+        // sta, pr: persisted and state-change events fired via _updateCmcdReporter() in CmcdController.
+        // bl, mtp, ab, etc.: refreshed via _updateCmcdReporter() for TIME_INTERVAL and state transitions.
 
         let ltc = playbackController.getCurrentLiveLatency() * 1000;
         if (!isNaN(ltc)) {
             data.ltc = ltc;
         }
 
-        if (typeof document !== 'undefined' && document.hidden) {
+        if (includeBackground && typeof document !== 'undefined' && document.hidden) {
             data.bg = true;
         }
 
@@ -587,18 +588,24 @@ function CmcdModel() {
                mediaType === Constants.OTHER;
     }
 
-    function getEventModeData(){
-        const cmcdData = {
-            ...getGenericCmcdData(),
+    function _getMetricsCmcdData({ includeEncodedBitrate = true, includeBackground = true } = {}) {
+        return {
+            ...getGenericCmcdData(undefined, { includeBackground }),
             ..._getAggregatedBitrateData(),
-            ..._getEncodedBitrateData(),
+            ...(includeEncodedBitrate ? _getEncodedBitrateData() : {}),
             ..._getBufferLevelData(),
             ..._getMeasuredThroughputData(),
             ..._getPlayheadBitrateData(),
             ..._getTopBitrateData(),
         };
+    }
+
+    function getEventModeData() {
+        return _getMetricsCmcdData();
+    }
 
-        return cmcdData;
+    function getContinuousCmcdData() {
+        return _getMetricsCmcdData({ includeEncodedBitrate: false, includeBackground: false });
     }
 
 
@@ -861,6 +868,7 @@ function CmcdModel() {
         deriveCmcdDataForRequest,
         getCmcdParametersFromManifest,
         getEventModeData,
+        getContinuousCmcdData,
         getLastMediaTypeRequest,
         isIncludedInRequestFilter,
         onBufferLevelStateChanged,

test/functional/config/test-configurations/streams/cmcd.json

@@ -0,0 +1,27 @@
+{
+  "testfiles": {
+    "included": [
+      "feature-support/cmcd",
+      "feature-support/cmcd-v2"
+    ],
+    "excluded": []
+  },
+  "testvectors": [
+    {
+      "name": "DASH-IF Live Sim - Segment Template without manifest updates",
+      "type": "live",
+      "url": "https://livesim2.dashif.org/livesim2/testpic_2s/Manifest.mpd",
+      "includedTestfiles": [
+        "feature-support/cmcd"
+      ]
+    },
+    {
+      "name": "BBB 30fps VoD CMCD v2",
+      "type": "vod",
+      "url": "https://dash.akamaized.net/akamai/bbb_30fps/bbb_30fps.mpd",
+      "includedTestfiles": [
+        "feature-support/cmcd-v2"
+      ]
+    }
+  ]
+}