rx-player 4.0.0-dev.2023121900 → 4.0.0-rc.2

package/scripts/launch_static_server.mjs

@@ -1,163 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Launch static server
- * ====================
- *
- * 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.
- */
-
-import express from "express";
-import { readFile } from "fs";
-import { promisify } from "util";
-import https from "https";
-import getHumanReadableHours from "./utils/get_human_readable_hours.mjs";
-
-/**
- * Launch the static server and begin to serve on the configured port.
- * @param {string} path - Root path that will be served by the static server.
- * @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.
- * 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, 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, 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.
- */
- export default 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));
-
-  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 });
-      }
-    });
-
-    if (!shouldStartHttps) {
-      return;
-    }
-
-    Promise.all([
-      promisify(readFile)(config.certificatePath),
-      promisify(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 static HTTPS server:",
-                        err);
-        }
-        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/list-npm-scripts.mjs

@@ -1,207 +0,0 @@
-/**
- * # list-npm-scripts
- *
- * Script displaying a readable preview of all nom scripts by relying on the
- * `scripts-list` key in a package.json.
- *
- * The basic idea what to start from/take inspiration from what the
- * `npm-scripts-info` npm package does and adapt it to a case where a lot of
- * scripts for very different matters are present.
- */
-
-import { existsSync, readFileSync } from "fs";
-import readline from "readline";
-import { join } from "path";
-import { spawn } from "child_process";
-readline.emitKeypressEvents(process.stdin);
-
-run();
-
-async function run() {
-  const pkg = getPackageJSONContent();
-  if (!("scripts-list" in pkg)) {
-    console.log('No "scripts-list" key in the `package.json` file.');
-    process.exit(0);
-  }
-
-  // Display groups
-  const scriptsList = pkg["scripts-list"];
-  const groupNames = Object.keys(scriptsList);
-  if (groupNames.length === 0) {
-    console.log('Nothing found in "scripts-list" in the `package.json` file.');
-    process.exit(0);
-  }
-  console.log("\x1b[33m~~~~~~~~~~~~~~~~ RxPlayer scripts ~~~~~~~~~~~~~~~~\n");
-  console.log("\x1b[34m============ What do you want to do? =============\n");
-  groupNames.forEach((key, groupIdx) => {
-    console.log(`\x1b[32m${groupIdx + 1}.\x1b[37m ${key}`);
-  });
-  console.log("");
-  const groupChoiceNum = await getChoice(groupNames.length);
-  console.log("");
-  const wantedGroupName = groupNames[groupChoiceNum - 1];
-  console.log(`\x1b[34m>>>> ${wantedGroupName}\x1b[37m`);
-  console.log("");
-  const subGroup = scriptsList[wantedGroupName];
-  const subGroupEntries = Object.entries(subGroup);
-  if (subGroupEntries.length === 0) {
-    console.log("Nothing found in in the chosen category.");
-    process.exit(0);
-  }
-
-  // Display commands
-  {
-    let currCommandNb = 1;
-    const commandArray = [];
-    recusivelyDiplayGroupCommands(subGroupEntries);
-    const cmdChoiceNum = await getChoice(commandArray.length);
-    const wantedScript = commandArray[cmdChoiceNum - 1];
-    console.log("\n");
-    executeNpmScript(wantedScript);
-
-    function recusivelyDiplayGroupCommands(groupEntries, indentation = "") {
-      groupEntries.forEach(([name, val]) => {
-        if (typeof val === "string") {
-          commandArray.push(name);
-          console.log(
-            `${indentation}${emphasize(currCommandNb + ".")} [${emphasize(
-              `npm run ${name}`
-            )}]:`
-          );
-          console.log(`${indentation}   ${val}\n`);
-          currCommandNb++;
-        } else if (typeof val === "object") {
-          console.log(`${indentation}\x1b[33m${name}\x1b[37m\n`);
-          const deeper = Object.entries(val);
-          recusivelyDiplayGroupCommands(deeper, indentation + "  ");
-          console.log("");
-        }
-      });
-    }
-  }
-}
-
-/**
- * Ask for a numbered input between `1` and the `maxNb` given.
- *
- * Directly exits script in case of invalid input or in cases where the user
- * asked to exit.
- *
- * The returned number is guaranteed to be between `1` and `maxNb` included.
- * @param {number} maxNb
- * @returns {Promise.<number>}
- */
-async function getChoice(maxNb) {
-  const answer =
-    maxNb <= 9 ? await getSingleCharChoice() : await readAnyLengthChoice();
-  if (
-    answer == null ||
-    answer == "" ||
-    (answer.length === 1 &&
-      [
-        3, // ^C
-        4, // ^D
-        13, // enter
-        32, // space
-      ].includes(answer.charCodeAt(0)))
-  ) {
-    process.exit(0);
-  }
-  const val = Number(answer);
-  if (isNaN(val) || val <= 0 || val > maxNb) {
-    console.error("Invalid number given");
-    process.exit(1);
-  }
-  return val;
-}
-
-/**
- * Execute the given npm script.
- *
- * Redirect its stdin and stdout to ours, communicate signals, and exit when
- * the script exits.
- *
- * @param {string} cmd
- */
-function executeNpmScript(script) {
-  const emphasizedCmdStr = emphasize(`npm run ${script}`);
-  console.log(`Executing: ${emphasizedCmdStr}`);
-  const cmd = spawn("npm", ["run", script], {
-    stdio: "inherit",
-    stderr: "inherit",
-  });
-  process.on("SIGINT", function () {
-    cmd.kill("SIGINT");
-  });
-  process.on("SIGTERM", function () {
-    cmd.kill("SIGTERM");
-  });
-  cmd.on("error", (d) => {
-    process.stderr.write(`Error while executing command: ${d}`);
-  });
-  cmd.on("exit", (c) => process.exit(c));
-}
-
-/**
- * Emphasize the given string with ANSI escape codes for the console.
- * @param {string} str
- * @returns {string}
- */
-function emphasize(str) {
-  return `\x1b[32m${str}\x1b[37m`;
-}
-
-/**
- * Read input string of any length.
- * @returns {Promise.<string>}
- */
-function readAnyLengthChoice() {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-  return new Promise((resolve) =>
-    rl.question("Your choice (leave empty to exit): ", (ans) => {
-      rl.close();
-      resolve(ans);
-    })
-  );
-}
-
-/**
- * Read single-character input.
- *
- * The advantage of this function when compared to `readAnyLengthChoice` is that
- * you won't need to enter a newline to validate your choice.
- * @returns {Promise.<string>}
- */
-function getSingleCharChoice() {
-  return new Promise((res) => {
-    process.stdin.setRawMode(true);
-    process.stdout.write("Your choice (leave empty to exit): ");
-    process.stdin.on("keypress", onKeyPress);
-    function onKeyPress(char) {
-      process.stdin.setRawMode(false);
-      process.stdin.off("keypress", onKeyPress);
-      res(char);
-    }
-  });
-}
-
-/**
- * Read the content of the `package.json` file in the current directory and
- * parses its input into a JS Object.
- *
- * Throws if no `package.json` exists in the current directory.
- *
- * @returns {Object}
- */
-function getPackageJSONContent() {
-  const filename = join(process.cwd(), "package.json");
-  if (!existsSync(filename)) {
-    throw new Error(
-      "`package.json` was not found in the current working directory."
-    );
-  }
-  return JSON.parse(readFileSync(filename, "utf8"));
-}

package/scripts/make-dev-releases

@@ -1,65 +0,0 @@
-#!/bin/bash
-
-# make-dev-releases
-# =================
-#
-# This script produces pre-releases on top of the current branch for the
-# `dev-v4` and `canal-v4` versions (as per their npm tags).
-#
-# To use it:
-#
-#   1. Be sure that you're on the branch corresponding to the pre-release you
-#      want to publish, at the repository's root directory.
-#
-#   2. Call this script followed with the corresponding version number it would
-#      have as an official release in the `MAJOR.MINOR.PATCH` format (e.g.
-#      `./update-version 4.1.3`). Special suffix corresponding to the date and
-#      tag will be added automatically by this script.
-#
-#   3. When the script ask you to confirm, check that the preceding commands did
-#      not output any issue and if it didn't you can confirm.
-#
-#   4. That's it!
-
-set -e
-
-current_branch=$(git branch | sed -n -e 's/^\* \(.*\)/\1/p')
-version=$1
-date=$(date "+%Y%m%d")
-dev_branch="release/v${version}-dev.${date}00"
-canal_branch="release/v${version}-canal.${date}00"
-
-git checkout -b ${dev_branch}
-./scripts/update-version $1-dev.${date}00
-git add --all
-git commit -m "update version"
-while true; do
-  read -n1 -p "Do you wish to push and publish the dev build? [y/n] " yn
-  echo ""
-  case $yn in
-    [Yy]* ) break;;
-    [Nn]* ) exit;;
-    * ) echo "Please answer y or n.";;
-  esac
-done
-git push origin ${dev_branch}
-npm publish --tag dev-v4
-
-git checkout $current_branch
-
-git checkout -b ${canal_branch}
-git apply ./scripts/canal-release.patch
-./scripts/update-version $1-canal.${date}00
-git add --all
-git commit -m "update version"
-git push origin ${canal_branch}
-while true; do
-  read -n1 -p "Do you wish to push and publish the canal build? [y/n] " yn
-  echo ""
-  case $yn in
-    [Yy]* ) break;;
-    [Nn]* ) exit;;
-    * ) echo "Please answer y or n.";;
-  esac
-done
-npm publish --tag canal-v4

package/scripts/run_standalone_demo.mjs

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Run the standalone demo 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.
- */
-
-import { join } from "path";
-import launchStaticServer from "./launch_static_server.mjs";
-import generateStandaloneDemo from "./generate_standalone_demo.mjs";
-import projectRootDirectory from "./utils/project_root_directory.mjs";
-
-generateStandaloneDemo({
-  production: false,
-  minify: false,
-  reportSize: false,
-});
-launchStaticServer(join(projectRootDirectory, "demo/standalone/"),
-                   { certificatePath: join(projectRootDirectory, "localhost.crt"),
-                     keyPath: join(projectRootDirectory, "localhost.key"),
-                     verbose: true,
-                     httpPort: 8001,
-                     httpsPort: 8444 });

package/scripts/start_demo_web_server.mjs

@@ -1,59 +0,0 @@
-#!/usr/bin/env node
-/* eslint-env node */
-
-/**
- * Run the full demo server
- * =========================
- *
- * This script allows to build the full 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 8000 and 8443 respectively.
- *
- * You can run it as a script through `node start_demo_web_server.mjs`.
- * Be aware that this demo will be built again every time either one of the
- * full demo file or one of the library file is updated.
- */
-
-import { join } from "path";
-import buildDemo from "./build_demo.mjs";
-import projectRootDirectory from "./utils/project_root_directory.mjs";
-import launchStaticServer from "./launch_static_server.mjs";
-
-if (process.argv.includes("-h") || process.argv.includes("--help")) {
-  displayHelp();
-  process.exit(0);
-}
-
-const includeWasmParser = process.argv.includes("--include-wasm");
-const production = process.argv.includes("--production-mode");
-const shouldMinify = process.argv.includes("--minify");
-
-buildDemo({ watch: true,
-            minify: shouldMinify,
-            production,
-           includeWasmParser });
-
-launchStaticServer(join(projectRootDirectory, "demo/full/"),
-                   { certificatePath: join(projectRootDirectory, "localhost.crt"),
-                     keyPath: join(projectRootDirectory, "localhost.key"),
-                     verbose: true,
-                     httpPort: 8000,
-                     httpsPort: 8443 });
-
-/**
- * Display through `console.log` an helping message relative to how to run this
- * script.
- */
-function displayHelp() {
-  /* eslint-disable no-console */
-  console.log(
-  /* eslint-disable indent */
-`Usage: node start_demo_web_server.mjs [options]
-Options:
-  -h, --help             Display this help
-  -m, --minify           Minify the built demo
-  -p, --production-mode  Build all files in production mode (less runtime checks, mostly).`,
-  /* eslint-enable indent */
-  );
-  /* eslint-enable no-console */
-}

package/scripts/update-version

@@ -1,45 +0,0 @@
-#!/bin/bash
-
-# Update version
-# ==============
-#
-# This script updates the version number in files where it is indicated and
-# builds the rx-player for this new version.
-#
-# /!\ It does not create a new git tag
-#
-# To use it:
-#
-#   1. Be sure that you're on the branch corresponding to the next version.
-#
-#   2. Call this script followed with the version number in the
-#      `MAJOR.MINOR.PATCH` format (e.g. `./update-version 3.22.0`).
-#
-#   3. Wait for all the script to finish and stay attentive to what it says
-#
-#   4. That's it!
-
-set -e
-
-if [ $# -eq 0 ]; then
- echo "no version in argument"
- exit 1
-fi
-
-version=$1
-date_iso=$(date "+%Y-%m-%d")
-
-sed -i.bak -e "s/^\#\# Unreleased/\#\# v${version} \(${date_iso}\)/gi" CHANGELOG.md && rm CHANGELOG.md.bak
-sed -i.bak -e "s/\/\\* PLAYER_VERSION \\*\/\"\(.*\)\";/\/* PLAYER_VERSION *\/\"${version}\";/g" src/core/api/public_api.ts && rm src/core/api/public_api.ts.bak
-sed -i.bak -e "s/\"version\":\s*\"[0-9]\+\.[0-9]\+\.[0-9]\+[^\"]*\"/\"version\": \"${version}\"/g" package.json && rm package.json.bak
-sed -i.bak -e "s/sonar\.projectVersion= *.*/sonar.projectVersion=${version}/g" sonar-project.properties && rm sonar-project.properties.bak
-echo $version > VERSION
-
-npm install
-npm run build:all
-
-echo "creating types for legacy code bases..."
-rm -f dist/rx-player.d.ts rx-player.min.d.ts
-echo "${copyright_text}
-import RxPlayer from \"./es2017/index\";
-export default RxPlayer;" | tee dist/rx-player.d.ts dist/rx-player.min.d.ts > /dev/null