fix(pillarbox-monitoring): use capital case to align with spec

This fix mainly conforms to the latest version of the specification, as some
values were not in capital case.

- srgssr middleware: rename tracker instance from `srgMonitoring` to
`pillarboxMonitoring`
- srgssr middleware: start a session directly by calling the `sessionStart`
function instead of sending an event
- pillarbox-monitoring: delete `pillarbox-monitoring/sessionstart` event
- pillarbox-monitoring: stringify error log
- srgssr middleware: add test cases for tracker initialization

src/middleware/srgssr.js

@@ -472,7 +472,9 @@ class SrgSsr {
    * @returns {Promise<import('./typedef').ComposedSrcMediaData>} - The composed source media data.
    */
   static async getSrcMediaObj(player, srcObj) {
-    player.trigger('pillarbox-monitoring/sessionstart');
+    if (SrgSsr.pillarboxMonitoring(player)) {
+      SrgSsr.pillarboxMonitoring(player).sessionStart();
+    }
 
     const { src: urn, ...srcOptions } = srcObj;
     const mediaComposition = await SrgSsr.getMediaComposition(
@@ -601,30 +603,30 @@ class SrgSsr {
   }
 
   /**
-   * SRG monitoring singleton.
+   * PillarboxMonitoring monitoring singleton.
    *
    * @param {import('video.js/dist/types/player').default} player
    *
    * @returns {PillarboxMonitoring} instance of PillarboxMonitoring
    */
-  static srgMonitoring(player) {
-    if (player.options().trackers.srgMonitoring === false) return;
+  static pillarboxMonitoring(player) {
+    if (player.options().trackers.pillarboxMonitoring === false) return;
 
-    if (!player.options().trackers.srgMonitoring) {
-      const srgMonitoring = new PillarboxMonitoring(player, {
+    if (!player.options().trackers.pillarboxMonitoring) {
+      const pillarboxMonitoring = new PillarboxMonitoring(player, {
         debug: player.debug(),
         playerVersion: Pillarbox.VERSION.pillarbox,
         playerName: 'Pillarbox',
       });
 
       player.options({
         trackers: {
-          srgMonitoring,
+          pillarboxMonitoring,
         },
       });
     }
 
-    return player.options().trackers.srgMonitoring;
+    return player.options().trackers.pillarboxMonitoring;
   }
 
   /**
@@ -665,7 +667,7 @@ class SrgSsr {
    * @returns {Object}
    */
   static middleware(player) {
-    SrgSsr.srgMonitoring(player);
+    SrgSsr.pillarboxMonitoring(player);
     SrgSsr.cuechangeEventProxy(player);
 
     return {

src/trackers/PillarboxMonitoring.js

@@ -21,7 +21,7 @@ class PillarboxMonitoring {
   constructor(player, {
     playerName = 'none',
     playerVersion = 'none',
-    platform = 'web',
+    platform = 'Web',
     schemaVersion = 1,
     heartbeatInterval = 30_000,
     beaconUrl = 'http://sse-broker-alb-1501344577.eu-central-1.elb.amazonaws.com/api/events'
@@ -114,7 +114,6 @@ class PillarboxMonitoring {
 
     this.player.on('loadstart', this.loadStart);
     this.player.on('loadeddata', this.loadedData);
-    this.player.on('pillarbox-monitoring/sessionstart', this.sessionStart);
     this.player.on('playing', this.playbackStart);
     this.player.on('pause', this.playbackStop);
     this.player.on('error', this.error);
@@ -141,13 +140,11 @@ class PillarboxMonitoring {
    * Binds the callback functions to the current instance.
    */
   bindCallBacks() {
-
     this.error = this.error.bind(this);
     this.loadedData = this.loadedData.bind(this);
     this.loadStart = this.loadStart.bind(this);
     this.playbackStart = this.playbackStart.bind(this);
     this.playbackStop = this.playbackStop.bind(this);
-    this.sessionStart = this.sessionStart.bind(this);
     this.stalled = this.stalled.bind(this);
     this.sessionStop = this.sessionStop.bind(this);
   }
@@ -246,12 +243,12 @@ class PillarboxMonitoring {
     }
 
     this.sendEvent('ERROR', {
-      log: error.metadata || JSON
-        .stringify(pillarbox.log.history().slice(-15)),
+      log: JSON
+        .stringify(error.metadata || pillarbox.log.history().slice(-15)),
       message: error.message,
       name: error.code,
       ...playbackPosition,
-      severity: 'FATAL',
+      severity: 'Fatal',
       url
     });
 
@@ -470,7 +467,7 @@ class PillarboxMonitoring {
     this.lastPlaybackDuration +=
       PillarboxMonitoring.timestamp() - this.lastPlaybackStartTimestamp;
 
-    this.lastPlaybackStartTimestamp = undefined;
+    this.lastPlaybackStartTimestamp = 0;
   }
 
   /**
@@ -553,7 +550,6 @@ class PillarboxMonitoring {
   removeListeners() {
     this.player.off('loadstart', this.loadStart);
     this.player.off('loadeddata', this.loadedData);
-    this.player.off('pillarbox-monitoring/sessionstart', this.sessionStart);
     this.player.off('playing', this.playbackStart);
     this.player.off('pause', this.playbackStop);
     this.player.off('error', this.error);
@@ -657,7 +653,7 @@ class PillarboxMonitoring {
     this.sessionStartTimestamp = PillarboxMonitoring.timestamp();
     // At this stage currentSource().src is the media identifier
     // and not the playable source.
-    this.mediaId = this.player.currentSource().src;
+    this.mediaId = this.player.currentSource().src || undefined;
   }
 
   /**

test/middleware/srgssr.spec.js

@@ -933,6 +933,44 @@ describe('SrgSsr', () => {
     });
   });
 
+  /**
+   *****************************************************************************
+   * pillarboxMonitoring *******************************************************
+   *****************************************************************************
+   */
+  describe('pillarboxMonitoring', () => {
+    it('should not initialize the pillarboxMonitoring', () => {
+      player.options().trackers.pillarboxMonitoring = false;
+
+      const spyOnOptions = jest.spyOn(player, 'options');
+
+      SrgSsr.pillarboxMonitoring(player);
+
+      expect(player.options().trackers.pillarboxMonitoring).toBe(false);
+      expect(spyOnOptions).not.toHaveBeenLastCalledWith(expect.objectContaining({ trackers: { pillarboxMonitoring: expect.any(Object) }}));
+    });
+
+    it('should initialize the pillarboxMonitoring', () => {
+      player.options().trackers.pillarboxMonitoring = undefined;
+
+      const spyOnOptions = jest.spyOn(player, 'options');
+
+      SrgSsr.pillarboxMonitoring(player);
+
+      expect(spyOnOptions).toHaveBeenNthCalledWith(4, expect.objectContaining({ trackers: { pillarboxMonitoring: expect.any(Object) }}));
+    });
+
+    it('should not reinitialize the pillarboxMonitoring', () => {
+      player.options().trackers.pillarboxMonitoring = {};
+
+      const spyOnOptions = jest.spyOn(player, 'options');
+
+      SrgSsr.pillarboxMonitoring(player);
+
+      expect(spyOnOptions).not.toHaveBeenLastCalledWith(expect.objectContaining({ trackers: { pillarboxMonitoring: expect.any(Object) }}));
+    });
+  });
+
   /**
    *****************************************************************************
    * updatePoster **************************************************************

test/trackers/pillarbox-monitoring.spec.js

@@ -494,7 +494,7 @@ describe('PillarboxMonitoring', () => {
 
       monitoring.removeListeners();
 
-      expect(spyOnOff).toHaveBeenCalledTimes(8);
+      expect(spyOnOff).toHaveBeenCalledTimes(7);
       expect(spyOnRemoveEventListener).toHaveBeenCalledTimes(1);
     });
   });