rx-player 3.26.2 → 3.26.3-dev.2022021400

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rx-player",
   "author": "Canal+",
-  "version": "3.26.2",
+  "version": "3.26.3-dev.2022021400",
   "description": "Canal+ HTML5 Video Player",
   "main": "./dist/rx-player.js",
   "keywords": [
@@ -105,10 +105,10 @@
     "esm": "3.2.25",
     "express": "4.17.2",
     "highlight.js": "11.3.1",
-    "html-entities": "^2.3.2",
+    "html-entities": "2.3.2",
     "istanbul-instrumenter-loader": "3.0.1",
     "jest": "27.4.5",
-    "karma": "6.3.9",
+    "karma": "6.3.14",
     "karma-chrome-launcher": "3.1.0",
     "karma-coverage-istanbul-reporter": "3.0.3",
     "karma-firefox-launcher": "2.1.2",
@@ -122,7 +122,6 @@
     "react-dom": "17.0.2",
     "regenerator-runtime": "0.13.9",
     "rimraf": "3.0.2",
-    "sanitize-html": "2.6.1",
     "semver": "7.3.5",
     "sinon": "12.0.1",
     "terser-webpack-plugin": "5.3.0",

package/scripts/doc-generator/generate_header_html.js

@@ -1,7 +1,6 @@
 const path = require("path");
 const { encode } = require("html-entities");
 const {
-  encodeHtmlAttributeValue,
   toUriCompatibleRelativePath,
   getGithubSvg,
 } = require("./utils");
@@ -30,12 +29,12 @@ function generateHeaderHtml(config, currentLinkIdx, currentPath, logoInfo) {
       case "local-doc": {
         const relativeUri = toUriCompatibleRelativePath(l.firstPage, currentDir);
         const activeClass = i === currentLinkIdx ? " navbar-active" : "";
-        const cleanedHref = encodeHtmlAttributeValue(relativeUri);
+        const cleanedHref = encode(relativeUri);
         return `<a class="navbar-item${activeClass}${customClass} hideable"` +
           `href="${cleanedHref}">${encode(l.displayName)}</a>`;
       }
       case "external-link": {
-        const cleanedHref = encodeHtmlAttributeValue(l.link);
+        const cleanedHref = encode(l.link);
         return `<a class="navbar-item${customClass} hideable"` +
           `href="${cleanedHref}">${encode(l.displayName)}</a>`;
       }
@@ -84,7 +83,7 @@ function constructVersionLinkHtmlInHeaderBar(versionInfo, customClass) {
   if (typeof versionInfo.link === "string") {
     hasLink = true;
     element += `<a class="navbar-item${customClass}"` +
-      `href="${encodeHtmlAttributeValue(versionInfo.link)}">`;
+      `href="${encode(versionInfo.link)}">`;
   } else {
     element += `<span class="navbar-item${customClass}">`;
   }
@@ -101,7 +100,7 @@ function constructVersionLinkHtmlInHeaderBar(versionInfo, customClass) {
  * @returns {string}
  */
 function constructGithubLinkHtmlInHeaderBar(githubLnk, customClass) {
-  const cleanedHref = encodeHtmlAttributeValue(githubLnk);
+  const cleanedHref = encode(githubLnk);
   return `<a aria-label="Link to repository" class="navbar-item${customClass} hideable" href="${cleanedHref}">` +
     getGithubSvg() +
     "</a>";
@@ -133,11 +132,11 @@ function constructLogoHtmlInHeaderBar(logoInfo) {
   let hasLink = false;
   if (typeof logoInfo.link === "string") {
     hasLink = true;
-    logoHtml += `<a href="${encodeHtmlAttributeValue(logoInfo.link)}">`;
+    logoHtml += `<a href="${encode(logoInfo.link)}">`;
   }
   if (typeof logoInfo.url === "string") {
     logoHtml += `<img alt="Logo" class="navbar-item navbar-item-logo"` +
-      ` src="${encodeHtmlAttributeValue(logoInfo.url)}" />`;
+      ` src="${encode(logoInfo.url)}" />`;
   }
   if (hasLink) {
     logoHtml += "</a>";

package/scripts/doc-generator/generate_page_html.js

@@ -1,5 +1,4 @@
 const { encode } = require("html-entities");
-const { encodeHtmlAttributeValue } = require("./utils");
 
 /**
  * Generate HTML page for the given documentation.
@@ -42,7 +41,7 @@ function generatePageHtml(
   const styles = constructStylesHtml(cssUrls);
   const scripts = constructScriptsHtml(scriptUrls);
   const faviconHtml = typeof faviconUrl === "string" ?
-    `<link rel="icon" type="image/png" href="${encodeHtmlAttributeValue(faviconUrl)}">` :
+    `<link rel="icon" type="image/png" href="${encode(faviconUrl)}">` :
     "";
   const hamburgerHtml = constructHamburgerBarHtml(pageListHtml);
 
@@ -98,7 +97,7 @@ function constructHamburgerBarHtml(pageListHtml) {
  */
 function constructStylesHtml(cssUrls) {
   return cssUrls.map(cssUrl =>
-    `<link rel="stylesheet" href="${encodeHtmlAttributeValue(cssUrl)}"/>`)
+    `<link rel="stylesheet" href="${encode(cssUrl)}"/>`)
     .join("");
 }
 
@@ -108,7 +107,7 @@ function constructStylesHtml(cssUrls) {
  */
 function constructScriptsHtml(scriptUrls) {
   return scriptUrls.map(scriptUrl =>
-    `<script type="text/javascript" src="${encodeHtmlAttributeValue(scriptUrl)}" ` +
+    `<script type="text/javascript" src="${encode(scriptUrl)}" ` +
     `charset="utf-8"></script>`
   ).join("");
 }

package/scripts/doc-generator/generate_page_list_html.js

@@ -1,7 +1,6 @@
 const { encode } = require("html-entities");
 const path = require("path");
 const {
-  encodeHtmlAttributeValue,
   getGithubSvg,
   toUriCompatibleRelativePath,
 } = require("./utils");
@@ -39,7 +38,7 @@ function generatePageListHtml(
             const pageActiveClasses = isPageActive ? " active" : "";
             const relativeUri = toUriCompatibleRelativePath(outputFile, currentDir);
             return `<li class="page-list-item${pageActiveClasses}">` +
-              `<a href="${encodeHtmlAttributeValue(relativeUri)}">` +
+              `<a href="${encode(relativeUri)}">` +
               encode(displayName) +
               `</a></li>`;
           }
@@ -54,7 +53,7 @@ function generatePageListHtml(
             const { displayName, outputFile } = currentSubPage;
             const relativeUri = toUriCompatibleRelativePath(outputFile, currentDir);
             return `<li class="page-list-item${spActiveClasses}">` +
-              `<a href="${encodeHtmlAttributeValue(relativeUri)}">` +
+              `<a href="${encode(relativeUri)}">` +
               encode(displayName) +
               `</a></li>`;
           }).join("\n") + "</ul></li>";
@@ -62,7 +61,7 @@ function generatePageListHtml(
       }
 
       case "external-link": {
-        const cleanedHref = encodeHtmlAttributeValue(l.link);
+        const cleanedHref = encode(l.link);
         return `<li class="page-list-item">` +
           `<a href="${cleanedHref}">` +
           encode(l.displayName) +
@@ -70,7 +69,7 @@ function generatePageListHtml(
       }
 
       case "github-link":
-        const cleanedHref = encodeHtmlAttributeValue(l.link);
+        const cleanedHref = encode(l.link);
         return `<li class="page-list-item">` +
           `<a aria-label="Link to repository" href="${cleanedHref}">` +
             getGithubSvg() +

package/scripts/doc-generator/generate_sidebar_html.js

@@ -1,9 +1,6 @@
 const path = require("path");
 const { encode } = require("html-entities");
-const {
-  encodeHtmlAttributeValue,
-  toUriCompatibleRelativePath,
-} = require("./utils");
+const { toUriCompatibleRelativePath } = require("./utils");
 
 /**
  * Construct HTML element, as a string, which corresponds to the sidebar for
@@ -52,7 +49,7 @@ function generateSidebarHtml(
       path.dirname(currentPath)
     );
     const activeClass = isActive ? " active" : "";
-    const cleanedHref = encodeHtmlAttributeValue(relativeUri);
+    const cleanedHref = encode(relativeUri);
     return "<li class=\"sidebar-item\">" +
       `<a class="sidebar-link${activeClass}" href="` +
       cleanedHref +
@@ -71,11 +68,11 @@ function constructSidebarHeaderHtml(logoInfo) {
     let hasLink = false;
     if (typeof logoInfo.link === "string") {
       hasLink = true;
-      sidebarHeaderHtml += `<a href="${encodeHtmlAttributeValue(logoInfo.link)}">`;
+      sidebarHeaderHtml += `<a href="${encode(logoInfo.link)}">`;
     }
     if (typeof logoInfo.url === "string") {
       sidebarHeaderHtml += `<img alt="logo" class="sidebar-header-logo"` +
-        ` src="${encodeHtmlAttributeValue(logoInfo.url)}" />`;
+        ` src="${encode(logoInfo.url)}" />`;
     }
     if (hasLink) {
       sidebarHeaderHtml += "</a>";

package/scripts/doc-generator/utils.js

@@ -20,16 +20,6 @@ async function mkdirParent(dirPath, mode) {
   }
 };
 
-/**
- * @param {string} val
- * @returns {string}
- */
-function encodeHtmlAttributeValue(val) {
-  return val
-    .replace(/&/g, "&")
-    .replace(/"/g, """);
-}
-
 /**
  * @param {string} target
  * @param {string} currentDir
@@ -77,7 +67,6 @@ function getGithubSvg() {
 }
 
 module.exports = {
-  encodeHtmlAttributeValue,
   getGithubSvg,
   mkdirParent,
   pathToUrl,

package/scripts/generate_demo_list.js

@@ -36,7 +36,7 @@
 
 const fs = require("fs");
 const path = require("path");
-const sanitizeHTML = require("sanitize-html");
+const { encode } = require("html-entities");
 const semver = require("semver");
 
 const INITIAL_PATH = "./versions";
@@ -88,8 +88,8 @@ if (versions.length <= 0) {
     const version = sortedVersions[i];
     // const versionAsNumber = +version.split(".").join();
     const dirPath = path.join(INITIAL_PATH, version, "demo/index.html");
-    body += `<li><a href=${sanitizeHTML(dirPath)}>` +
-      sanitizeHTML(version) +
+    body += `<li><a href=${encode(dirPath)}>` +
+      encode(version) +
       "</a></li>";
   }
   body += "</ul>";

package/scripts/generate_documentation_list.js

@@ -36,7 +36,7 @@
 
 const fs = require("fs");
 const path = require("path");
-const sanitizeHTML = require("sanitize-html");
+const { encode } = require("html-entities");
 const semver = require("semver");
 
 const INITIAL_PATH = "./versions";
@@ -92,8 +92,8 @@ if (versions.length <= 0) {
       path.join(INITIAL_PATH, version, "doc/api/Overview.html") :
       path.join(INITIAL_PATH, version, "doc/pages/index.html");
 
-    body += `<li><a href=${sanitizeHTML(dirPath)}>` +
-      sanitizeHTML(version) +
+    body += `<li><a href=${encode(dirPath)}>` +
+      encode(version) +
       "</a></li>";
   }
   body += "</ul>";

package/scripts/launch_static_server.js

@@ -2,16 +2,11 @@
 /* eslint-env node */
 
 /**
- * Run the standalone demo server
- * ==============================
+ * Launch static server
+ * ====================
  *
- * This script allows to build the standalone demo locally and start both an
- * HTTP and an HTTPS (only if a certificate and key have been generated) server
- * to serve it, on the port 8001 and 8444 respectively.
- *
- * You can run it as a script through `node run_standalone_demo.js`.
- * Be aware that this demo will be built again every time one of the library
- * file is updated.
+ * This script allows to start both an HTTP and an HTTPS (only if a certificate
+ * path and a key path have been given) static file server.
  */
 
 const express = require("express");
@@ -26,78 +21,143 @@ const getHumanReadableHours = require("./utils/get_human_readable_hours");
  * @param {Object} config - Associated configuration.
  * @param {number} config.httpPort - Port on which the server will be listening
  * for HTTP traffic.
- * @param {number} config.httpsPort - Port on which the server will be listening
- * for HTTPS traffic.
+ * @param {number} [config.httpsPort] - Port on which the server will be
+ * listening for HTTPS traffic.
+ * If not defined, the server won't listen for HTTPS traffic.
+ * @param {boolean} [config.verbose] - If set to `true` the server will output
+ * when the server start listening and when anything failed.
  * @param {string} [config.certificatePath] - Path to the TLS certificate that
  * will be used in HTTPS connections.
- * If not defined or if it doesn't lead to any file, the server won't listen for
- * HTTPS traffic.
- * @param {string} config.keyPath - Path to the public key allowing to encrypt
+ * If not defined, the server won't listen for HTTPS traffic.
+ * @param {string} [config.keyPath] - Path to the public key allowing to encrypt
  * the HTTPS connection.
- * If not defined or if it doesn't lead to any file, the server won't listen for
- * HTTPS traffic.
+ * If not defined, the server won't listen for HTTPS traffic.
+ * @returns {Object} Object with two properties:
+ *   - `listeningPromise` (Promise.<Object>): This promise rejects if the HTTP
+ *     server could not start but resolves in any other case (listening to HTTP
+ *     alone or both HTTP and HTTPS), even if the asked HTTPS server could not
+ *     be started.
+ *
+ *     The resolved object contains two boolean properties: `http` and `https`,
+ *     which are set to `true` when the corresponding server has been started.
+ *
+ *     You can know the reason for the HTTPS server not starting by setting the
+ *     `verbose` option to `true`. In that case, it will be logged.
+ *
+ *   - `close` (Function): Method allowing to stop the servers from listening
+ *     and to free their resources.
  */
 module.exports = function launchStaticServer(path, config) {
+  const shouldStartHttps = config.httpsPort !== undefined &&
+                           config.certificatePath !== undefined &&
+                           config.keyPath !== undefined;
+  let isHttpServerStarted = false
+  let isHttpsServerStarted = false;
+
   const app = express();
   app.use(express.static(path));
 
-  if (config.certificatePath === undefined || config.keyPath === undefined) {
-    console.warn(`[${getHumanReadableHours()}] ` +
-                 "Not launching the demo in HTTPS: certificate not generated.\n" +
-                 "You can run `npm run certificate` to generate a certificate.");
-  }
+  let server;
+  const listeningPromise = new Promise((res, rej) => {
+    server = app.listen(config.httpPort, (err) => {
+      if (err) {
+        if (config.verbose) {
+          /* eslint-disable-next-line no-console */
+          console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
+                        "Could not start static HTTP server:",
+                        err);
+        }
+        server.close();
+        return rej(err);
+      }
+      if (config.verbose) {
+        /* eslint-disable-next-line no-console */
+        console.log(`[${getHumanReadableHours()}] ` +
+                    `Listening HTTP at http://localhost:${config.httpPort}`);
+      }
+      isHttpServerStarted = true;
+      if (!shouldStartHttps || isHttpsServerStarted) {
+        res({ http: true, https: isHttpsServerStarted });
+      }
+    });
 
-  app.listen(config.httpPort, (err) => {
-    if (err) {
-      /* eslint-disable no-console */
-      console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
-                    "Could not start HTTP server:",
-                    err);
-      /* eslint-enable no-console */
+    if (!shouldStartHttps) {
       return;
     }
-    /* eslint-disable no-console */
-    console.log(`[${getHumanReadableHours()}] ` +
-                `Listening HTTP at http://localhost:${config.httpPort}`);
-    /* eslint-enable no-console */
-  });
 
-  Promise.all([
-    promisify(fs.readFile)(config.certificatePath),
-    promisify(fs.readFile)(config.keyPath),
-  ]).then(([pubFile, privFile]) => {
-    if (pubFile != null && privFile != null) {
-      https.createServer({
-        key: privFile,
-        cert: pubFile,
-      }, app).listen(config.httpsPort, (err) => {
-        if (err) {
-          /* eslint-disable no-console */
+    Promise.all([
+      promisify(fs.readFile)(config.certificatePath),
+      promisify(fs.readFile)(config.keyPath),
+    ]).then(([certFile, keyFile]) => {
+      if (certFile != null && keyFile != null) {
+        https.createServer({
+          key: keyFile,
+          cert: certFile,
+        }, app).listen(config.httpsPort, (err) => {
+          if (err) {
+            if (config.verbose) {
+              /* eslint-disable-next-line no-console */
+              console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
+                            "Could not start static HTTPS server:",
+                            err);
+            }
+            if (isHttpServerStarted) {
+              res({ http: true, https: false });
+            }
+            return;
+          }
+          /* eslint-disable-next-line no-console */
+          console.log(`[${getHumanReadableHours()}] ` +
+                      `Listening HTTPS at https://localhost:${config.httpsPort}`);
+        });
+        if (isHttpServerStarted) {
+          res();
+        }
+        isHttpsServerStarted = true;
+      } else {
+        const err = new Error("Impossible to load the certificate and/or key file");
+        if (config.verbose === true) {
+          /* eslint-disable-next-line no-console */
           console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
-                        "Could not start HTTPS server:",
+                        "Could not start static HTTPS server:",
                         err);
-          /* eslint-enable no-console */
-          return;
         }
-        /* eslint-disable no-console */
-        console.log(`[${getHumanReadableHours()}] ` +
-                    `Listening HTTPS at https://localhost:${config.httpsPort}`);
-        /* eslint-enable no-console */
-      });
-    }
-  }, (err) => {
-    if (err.code === "ENOENT") {
-      /* eslint-disable no-console */
-      console.warn(`[${getHumanReadableHours()}] ` +
-                   "Not launching the demo in HTTPS: certificate not generated.\n" +
-                   "You can run `npm run certificate` to generate a certificate.");
-      /* eslint-enable no-console */
-    } else {
-      /* eslint-disable no-console */
-      console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
-                    "Could not readt keys and certificate:",
-                    err);
-      /* eslint-enable no-console */
-    }
+        if (isHttpServerStarted) {
+          res({ http: true, https: false });
+        }
+        return;
+      }
+    }, (err) => {
+      if (err.code === "ENOENT") {
+        if (config.verbose) {
+          /* eslint-disable-next-line no-console */
+          console.warn(`[${getHumanReadableHours()}] ` +
+                       "Could not start static HTTPS server: ",
+                       "Certificate not generated.\n" +
+                       "(You can run `npm run certificate` to generate a certificate.)");
+        }
+        if (isHttpServerStarted) {
+          res({ http: true, https: false });
+        }
+        return;
+      } else {
+        const err = new Error("Could not read key and certificate file.");
+        if (config.verbose) {
+          /* eslint-disable-next-line no-console */
+          console.error(`\x1b[31m[${getHumanReadableHours()}]\x1b[0m ` +
+                        "Could not start static HTTPS server:",
+                        err);
+        }
+        if (isHttpServerStarted) {
+          res({ http: true, https: false });
+        }
+        return;
+      }
+    });
   });
+
+  return {
+    listeningPromise,
+    close() { server.close() },
+  };
 };

package/scripts/run_standalone_demo.js

@@ -22,5 +22,6 @@ require("./generate_standalone_demo");
 launchStaticServer(path.join(__dirname, "../demo/standalone/"),
                    { certificatePath: path.join(__dirname, "../localhost.crt"),
                      keyPath: path.join(__dirname, "../localhost.key"),
+                     verbose: true,
                      httpPort: 8001,
                      httpsPort: 8444 });

package/scripts/start_demo_web_server.js

@@ -35,5 +35,6 @@ if (shouldRunFastVersion) {
 launchStaticServer(path.join(__dirname, "../demo/full/"),
                    { certificatePath: path.join(__dirname, "../localhost.crt"),
                      keyPath: path.join(__dirname, "../localhost.key"),
+                     verbose: true,
                      httpPort: 8000,
                      httpsPort: 8443 });

package/sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.projectKey=rx-player
 sonar.organization=rx-player
 sonar.projectName=rx-player
-sonar.projectVersion=3.26.2
+sonar.projectVersion=3.26.3-dev.2022021400
 sonar.sources=./src,./demo,./tests
 sonar.exclusions=demo/full/bundle.js,demo/standalone/lib.js,demo/bundle.js
 sonar.host.url=https://sonarcloud.io

package/src/compat/__tests__/fullscreen.test.ts

@@ -23,15 +23,15 @@
 
 interface IFakeDocument {
   createElement(eltType: string) : HTMLElement;
-  fullscreenElement? : Element | null;
-  mozCancelFullScreen? : () => void;
-  mozFullScreenElement? : HTMLElement;
-  msExitFullscreen? : () => void;
-  exitFullscreen? : () => void;
-  msFullscreenElement? : Element | null;
+  fullscreenElement? : Element | null | undefined;
+  mozCancelFullScreen? : (() => void) | undefined;
+  mozFullScreenElement? : HTMLElement | undefined;
+  msExitFullscreen? : (() => void) | undefined;
+  exitFullscreen? : (() => void) | undefined;
+  msFullscreenElement? : Element | null | undefined;
   webkitExitFullscreen : () => void;
   webkitFullscreenElement : Element | null | undefined;
-  webkitHidden? : boolean;
+  webkitHidden? : boolean | undefined;
 }
 
 const doc = document as unknown as IFakeDocument;

package/src/compat/__tests__/is_vtt_cue.test.ts

@@ -63,7 +63,7 @@ describe("Compat - isVTTCue", () => {
     const originalVTTCue = window.VTTCue;
     win.VTTCue = MockVTTCue;
     const cue = new VTTCue(0, 10, "");
-    win.VTTCue = undefined;
+    delete win.VTTCue;
     const isVTTCue = require("../is_vtt_cue").default;
     expect(isVTTCue(cue)).toEqual(false);
     window.VTTCue = originalVTTCue;

package/src/compat/eme/custom_media_keys/ie11_media_keys.ts

@@ -45,7 +45,7 @@ class IE11MediaKeySession
   public keyStatuses: ICustomMediaKeyStatusMap;
   private readonly _mk: MSMediaKeys;
   private readonly _closeSession$: Subject<void>;
-  private _ss?: MSMediaKeySession;
+  private _ss: MSMediaKeySession | undefined;
   constructor(mk: MSMediaKeys) {
     super();
     this.expiration = NaN;

package/src/compat/eme/custom_media_keys/index.ts

@@ -173,14 +173,18 @@ if (isNode ||
       supported = supported && (distinctiveIdentifier !== "required");
 
       if (supported) {
-        const keySystemConfigurationResponse = {
-          videoCapabilities,
-          audioCapabilities,
+        const keySystemConfigurationResponse : MediaKeySystemConfiguration = {
           initDataTypes: ["cenc"],
           distinctiveIdentifier: "not-allowed" as const,
           persistentState: "required" as const,
           sessionTypes: ["temporary", "persistent-license"],
         };
+        if (videoCapabilities !== undefined) {
+          keySystemConfigurationResponse.videoCapabilities = videoCapabilities;
+        }
+        if (audioCapabilities !== undefined) {
+          keySystemConfigurationResponse.audioCapabilities = audioCapabilities;
+        }
 
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const customMediaKeys = createCustomMediaKeys(keyType);