senza-sdk 4.2.12 → 4.2.13

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.2.12",
+    "version": "4.2.13",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",
@@ -38,10 +38,10 @@
         ],
         "coverageThreshold": {
             "global": {
-                "branches": 85,
-                "functions": 90,
-                "lines": 92,
-                "statements": 92
+                "branches": 85.5,
+                "functions": 90.5,
+                "lines": 92.5,
+                "statements": 92.5
             }
         }
     },

package/src/api.js

@@ -180,7 +180,7 @@ export async function init() {
         }
 
         await remotePlayer._init(sessionInfoObj?.settings?.["ui-streamer"], originalTriggerEvent);
-        await lifecycle._init();
+        await lifecycle._init(sessionInfoObj?.settings?.["ui-streamer"]);
 
         const devSequence = sessionInfoObj?.settings?.["ui-streamer"]?.devSequence;
         if (devSequence) {

package/src/lifecycle.js

@@ -1,7 +1,7 @@
 import { getPlatformInfo } from "./api";
-import { getFCID, isAudioSyncEnabled, sdkLogger, StreamType, SwitchMode } from "./utils";
+import {getFCID, isAudioSyncEnabled, clearTimer, sdkLogger, StreamType, SwitchMode, SenzaError} from "./utils";
 import { sessionInfo } from "./SessionInfo";
-import { remotePlayer } from "./remotePlayer";
+import { DEFAULT_PLAY_TIMEOUT, DEFAULT_STOP_TIMEOUT, remotePlayer } from "./remotePlayer";
 
 /**
   * Lifecycle is a singleton class that manages the application lifecycle states.<br>
@@ -74,7 +74,7 @@ class Lifecycle extends EventTarget {
 
     /** @private Initialize the lifecycle
      */
-    async _init() {
+    async _init(uiStreamerSettings) {
         if (window.cefQuery) {
             this._state = await new Promise((resolve) => {
                 window.cefQuery({
@@ -91,6 +91,8 @@ class Lifecycle extends EventTarget {
                 });
             });
             this._isInitialized = true;
+            this._playTimeout = uiStreamerSettings?.playTimeout ?? DEFAULT_PLAY_TIMEOUT;
+            this._stopTimeout = uiStreamerSettings?.stopTimeout ?? DEFAULT_STOP_TIMEOUT;
         }
     }
 
@@ -152,7 +154,7 @@ class Lifecycle extends EventTarget {
                 return Promise.resolve(false);
             }
             this._inTransition = true;
-
+            const FCID = getFCID();
             if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
                 return new Promise((resolve, reject) => {
                     const FCID = getFCID();
@@ -162,27 +164,41 @@ class Lifecycle extends EventTarget {
                         type: "remotePlayer.stop",
                         class: "remotePlayer",
                         action: "stop",
-                        streamType: isAudioSyncEnabled() ? StreamType.VIDEO | StreamType.SUBTITLE : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE
+                        streamType: isAudioSyncEnabled() ? StreamType.VIDEO | StreamType.SUBTITLE : StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE,
+                        fcid: FCID
                     };
-                    window.cefQuery({
-                        request: JSON.stringify({ target: "TC", waitForResponse: false, internalAction: "uiActive", message: JSON.stringify(message) }),
+                    let timerId = 0;
+                    const timeBeforeSendingRequest = Date.now();
+                    const queryId = window.cefQuery({
+                        request: JSON.stringify({ target: "TC", waitForResponse: true, internalAction: "uiActive", message: JSON.stringify(message) }),
                         persistent: false,
                         onSuccess: () => {
-                            logger.log("stop successfully sent");
+                            const duration = Date.now() - timeBeforeSendingRequest;
+                            logger.withFields({ duration }).log(`stop completed successfully after ${duration} ms`);
                             this._inTransition = false;
+                            timerId = clearTimer(timerId);
                             resolve(true);
                         },
                         onFailure: (code, msg) => {
-                            logger.error(`stop failed: ${code} ${msg}`);
+                            const duration = Date.now() - timeBeforeSendingRequest;
+                            logger.withFields({ duration }).log(`stop failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
                             this._inTransition = false;
-                            reject(`stop failed: ${code} ${msg}`);
+                            timerId = clearTimer(timerId);
+                            reject(new SenzaError(code, msg));
                         }
                     });
+                    logger.log(`window.cefQuery for stop returned query id ${queryId}`);
+                    const stopTimeout = this._stopTimeout + 1000;
+                    timerId = setTimeout(() => {
+                        logger.log(`stop reached timeout of ${stopTimeout} ms, canceling query id ${queryId}`);
+                        this._inTransition = false;
+                        window.cefQueryCancel(queryId);
+                        reject(new SenzaError(6000, `stop reached timeout of ${stopTimeout} ms`));
+                    }, stopTimeout, queryId);
                 });
             }
 
             return new Promise((resolve, reject) => {
-                const FCID = getFCID();
                 const logger = sdkLogger.withFields({ FCID });
                 logger.log("lifecycle moveToForeground: sending uiActiveRequest action");
                 window.cefQuery({
@@ -246,24 +262,45 @@ class Lifecycle extends EventTarget {
                     message.class = "remotePlayer";
                     message.switchMode = isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                     message.streamType = StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE;
-                    request = { target: "TC", waitForResponse: false, internalAction: "uiExit", message: JSON.stringify(message) };
+                    request = {
+                        target: "TC",
+                        waitForResponse: true,
+                        internalAction: "uiExit",
+                        message: JSON.stringify(message)
+                    };
                 } else {
                     request = message;
                 }
-                window.cefQuery({
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
                     request: JSON.stringify(request),
                     persistent: false,
                     onSuccess: () => {
-                        logger.log("[ moveToBackground ] play successfully sent");
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`play completed successfully after ${duration} ms`);
                         this._inTransition = false;
-                        resolve(true);
+                        timerId = clearTimer(timerId);
+                        resolve();
                     },
                     onFailure: (code, msg) => {
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`play failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
                         this._inTransition = false;
-                        logger.error(`[ moveToBackground ] play failed: ${code} ${msg}`);
-                        reject(`[ moveToBackground ] play failed: ${code} ${msg}`);
+                        timerId = clearTimer(timerId);
+                        reject(new SenzaError(code, msg));
                     }
                 });
+                if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
+                    logger.log(`window.cefQuery for play returned query id ${queryId}`);
+                    const playTimeout = this._playTimeout + 1000;
+                    timerId = setTimeout(() => {
+                        logger.log(`play reached timeout of ${playTimeout} ms, canceling query id ${queryId}`);
+                        this._inTransition = false;
+                        window.cefQueryCancel(queryId);
+                        reject(new SenzaError(6000, `play reached timeout of ${playTimeout} ms`));
+                    }, playTimeout, queryId);
+                }
             });
         }
         sdkLogger.warn("lifecycle moveToBackground: window.cefQuery is undefined");

package/src/remotePlayer.js

@@ -1,5 +1,5 @@
 
-import { getFCID, isAudioSyncEnabled, sdkLogger, StreamType, SwitchMode } from "./utils";
+import { getFCID, isAudioSyncEnabled, clearTimer, sdkLogger, StreamType, SwitchMode } from "./utils";
 import { lifecycle } from "./lifecycle";
 import { writeLicenseResponse } from "./api";
 import { mergeAutoTranslationLanguages } from "./subtitlesUtils";
@@ -8,6 +8,8 @@ import { sessionInfo } from "./SessionInfo";
 const INVALID_SET_PLAYABLE_URI_CODE = 99;
 const DEFAULT_SET_PLAYABLE_URI_TIMEOUT = 5000;
 const DEFAULT_UNLOAD_TIMEOUT = 5000;
+export const DEFAULT_PLAY_TIMEOUT = 5000;
+export const DEFAULT_STOP_TIMEOUT = 5000;
 
 const cloneDeep = (element) => {
     return JSON.parse(JSON.stringify(element));
@@ -17,7 +19,7 @@ const cloneDeep = (element) => {
 /** Error object to be thrown on remotePlayer api failures.
  * [See error list]{@link RemotePlayer#error}
  */
-class RemotePlayerError extends Error {
+export class RemotePlayerError extends Error {
     constructor(code, message) {
         super(message);
         this.code = code;
@@ -258,7 +260,7 @@ class RemotePlayer extends EventTarget {
          * | 3403      | Player            | Problem accessing segments, server authentication issue                                         |
          * | 3404      | Player            | Problem accessing segments, server returned not found                                           |
          * | 3900-3999 | Player            | Internal player error                                                                           |
-         * | 6000      | Player            | The call to load() has reached the configurable timeout with no response from the remote player |
+         * | 6000      | Player            | The remote player api call has reached the configurable timeout with no response from the remote player |
          * | 6001      | Player            | play() was called while the remote player is not loaded                                         |
          * | 6002      | Player            | load() was called while the application was in state 'background' or 'inTransitionToBackground' |
          * | 6500      | Player            | remotePlayer api was called before initializing remotePlayer                                    |
@@ -413,6 +415,7 @@ class RemotePlayer extends EventTarget {
         this._isInitialized = true;
         this._setPlayableUriTimeout = uiStreamerSettings?.setPlayableUriTimeout ?? DEFAULT_SET_PLAYABLE_URI_TIMEOUT;
         this._unloadTimeout = uiStreamerSettings?.unloadTimeout ?? DEFAULT_UNLOAD_TIMEOUT;
+        this._playTimeout = uiStreamerSettings?.playTimeout ?? DEFAULT_PLAY_TIMEOUT;
         this._requestVideoFrameInfo = uiStreamerSettings?.requestVideoFrameInfo ?? true;
 
         let playbackMetadata = {};
@@ -644,10 +647,7 @@ class RemotePlayer extends EventTarget {
                         if (position > 0) {
                             setPlaybackInfo({ playbackPosition: position });
                         }
-                        if (timerId) {
-                            clearTimeout(timerId);
-                            timerId = 0;
-                        }
+                        timerId = clearTimer(timerId);
                         this._changeLoadMode(this.LoadMode.LOADED);
                         this._loadedUrl = url;
                         this.dispatchEvent(new Event("canplay"));
@@ -656,10 +656,7 @@ class RemotePlayer extends EventTarget {
                     onFailure: (code, msg) => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`setPlayableUri failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        if (timerId) {
-                            clearTimeout(timerId);
-                            timerId = 0;
-                        }
+                        timerId = clearTimer(timerId);
                         // If setPlayableUri failed because the request was invalid, we want to retain the previous load mode
                         if (code === INVALID_SET_PLAYABLE_URI_CODE) {
                             this._changeLoadMode(previousLoadMode);
@@ -721,10 +718,7 @@ class RemotePlayer extends EventTarget {
                     onSuccess: () => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`unload completed successfully after ${duration} ms`);
-                        if (timerId) {
-                            clearTimeout(timerId);
-                            timerId = 0;
-                        }
+                        timerId = clearTimer(timerId);
                         this._reset();
                         this._changeLoadMode(this.LoadMode.NOT_LOADED);
                         this._loadedUrl = undefined;
@@ -733,10 +727,7 @@ class RemotePlayer extends EventTarget {
                     onFailure: (code, msg) => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`unload failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        if (timerId) {
-                            clearTimeout(timerId);
-                            timerId = 0;
-                        }
+                        timerId = clearTimer(timerId);
                         this._changeLoadMode(previousLoadMode);
                         reject(new RemotePlayerError(code, msg));
                     }
@@ -792,29 +783,46 @@ class RemotePlayer extends EventTarget {
                 subtitlesLanguage,
                 playbackPosition: this.currentTime
             };
+            let waitForResponse = false;
             if (sessionInfo.sessionInfoObj?.settings?.["ui-streamer"]?.remotePlayerApiVersion >= 2) {
                 if (isAudioSyncEnabled()) {
                     message.switchMode = SwitchMode.SEAMLESS;
                     message.streamType = StreamType.AUDIO;
+                    waitForResponse = true;
                 } else {
                     logger.log("remotePlayer play request ignored and will be sent with the lifecycle.moveToBackground()");
                     return Promise.resolve();
                 }
             }
-            const request = { target: "TC", waitForResponse: false, message: JSON.stringify(message) };
+            const request = { target: "TC", waitForResponse: waitForResponse, message: JSON.stringify(message) };
             return new Promise((resolve, reject) => {
-                window.cefQuery({
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
                     request: JSON.stringify(request),
                     persistent: false,
                     onSuccess: () => {
-                        logger.log("remotePlayer play request successfully sent");
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`play completed successfully after ${duration} ms`);
+                        timerId = clearTimer(timerId);
                         resolve();
                     },
                     onFailure: (code, msg) => {
-                        logger.error(`remotePlayer play request failed: ${code} ${msg}`);
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        logger.withFields({ duration }).log(`play failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
+                        timerId = clearTimer(timerId);
                         reject(new RemotePlayerError(code, msg));
                     }
                 });
+                logger.log(`window.cefQuery for play returned query id ${queryId}`);
+                if (waitForResponse) {
+                    const playTimeout = this._playTimeout + 1000;
+                    timerId = setTimeout(() => {
+                        logger.log(`play reached timeout of ${playTimeout} ms, canceling query id ${queryId}`);
+                        window.cefQueryCancel(queryId);
+                        reject(new RemotePlayerError(6000, `play reached timeout of ${playTimeout} ms`));
+                    }, playTimeout, queryId);
+                }
             });
         }
         sdkLogger.error("remotePlayer play: window.cefQuery is undefined");

package/src/utils.js

@@ -9,6 +9,14 @@ export function getFCID() {
     return Math.round(Math.random() * 100000) + "-" + getPlatformInfo().sessionInfo?.connectionId;
 }
 
+export class SenzaError extends Error {
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.msg = message;
+    }
+}
+
 /* eslint-disable no-console */
 class SdkLogger {
 
@@ -90,6 +98,14 @@ export async function getRestResponse(messageName) {
     });
 }
 
+export function clearTimer(timerId) {
+    if (timerId) {
+        clearTimeout(timerId);
+        timerId = 0;
+    }
+    return timerId;
+}
+
 export function isAudioSyncEnabled() {
     const clientUiAudioSettings = sessionInfo.sessionInfoObj?.settings?.client?.["ui_audio"];
     return clientUiAudioSettings?.enabled && clientUiAudioSettings?.from_cdn && clientUiAudioSettings?.ui_sync_enabled;