rx-player 3.33.0 → 3.33.1

package/scripts/update_gh-pages_demo

@@ -1,132 +0,0 @@
-#!/bin/bash
-
-# Update gh-pages demo
-# ====================
-#
-# This script allows to automatically update the full demo on the gh-pages
-# branch.
-#
-# To use it:
-#
-#   1. Be sure that you're on a clean (no staged files and no diff) master
-#      branch.
-#
-#   2. Call this script.
-#      Some user interactions will be needed to avoid doing unwanted commits.
-#
-#   3. That's it!
-#      A commit should have been pushed to the gh-pages.
-
-set -e
-
-current_branch=$(git branch | sed -n -e 's/^\* \(.*\)/\1/p')
-current_version=$(cat VERSION)
-
-if ! [ "$current_branch" == "master" ]; then
-  echo $current_branch
-  echo "ERROR: The current branch should be master"
-  exit 1;
-fi
-
-# Generate demo
-npm run demo:min
-
-if [ -n "$(git status --porcelain doc)" ]; then
-  echo "ERROR: Please commit your modifications to master"
-  exit 1;
-fi
-
-tmpFontsDir=$(mktemp -d)
-tmpAssetsDir=$(mktemp -d)
-tmpStylesDir=$(mktemp -d)
-tmpDemoFile=$(mktemp)
-tmpRxPlayerFile=$(mktemp)
-tmpIndexFile=$(mktemp)
-tmpFaviconFile=$(mktemp)
-tmpDemoList=$(mktemp)
-
-cp -r demo/full/fonts $tmpFontsDir -v
-cp -r demo/full/assets $tmpAssetsDir -v
-cp -r demo/full/styles $tmpStylesDir -v
-cp demo/full/bundle.js $tmpDemoFile -v
-cp demo/full/index.html $tmpIndexFile -v
-cp demo/full/plus.ico $tmpFaviconFile -v
-cp scripts/generate_demo_list.js $tmpDemoList -v
-
-# update gh-pages
-git checkout gh-pages
-git pull origin gh-pages
-
-rm -rf "versions/$current_version/demo"
-mkdir -p "versions/$current_version/demo"
-rm index.html
-rm plus.ico
-rm bundle.js
-rm -rf fonts
-rm -rf assets
-rm -rf styles
-mv $tmpIndexFile "versions/$current_version/demo/index.html"
-mv $tmpFaviconFile "versions/$current_version/demo/plus.ico"
-mv $tmpDemoFile "versions/$current_version/demo/bundle.js"
-mv $tmpFontsDir/fonts "versions/$current_version/demo/fonts"
-mv $tmpAssetsDir/assets "versions/$current_version/demo/assets"
-mv $tmpStylesDir/styles "versions/$current_version/demo/styles"
-mv $tmpDemoList generate_demo_list.js
-ln -s "./versions/$current_version/demo/index.html" index.html
-ln -s "./versions/$current_version/demo/plus.ico" plus.ico
-ln -s "./versions/$current_version/demo/bundle.js" bundle.js
-ln -s "./versions/$current_version/demo/fonts" fonts
-ln -s "./versions/$current_version/demo/assets" assets
-ln -s "./versions/$current_version/demo/styles" styles
-
-node generate_demo_list.js
-rm generate_demo_list.js
-
-if [ -n "$(git status --porcelain bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html)" ]; then
-  echo "-- Current Status on gh-pages: --"
-  echo ""
-  git status bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html
-
-  while : ; do
-    echo ""
-    echo "We will push the demo to gh-pages."
-    REPLY=""
-    read -p "do you want to continue [y/d/s/a/c/t/h] (h for help) ? " -n 1 -r
-    echo ""
-
-    if [[ $REPLY =~ ^[Hh](elp)?$ ]]; then
-      echo ""
-      echo ""
-      echo "+- help -------------------------------------------------+"
-      echo "| y: commit and continue                                 |"
-      echo "| d: see diff                                            |"
-      echo "| s: see status                                          |"
-      echo "| a: abort script from here                              |"
-      echo "| c: checkout from this commit and go to the next one    |"
-      echo "| t: stash this commit and go to the next one            |"
-      echo "| h: see this help                                       |"
-      echo "+--------------------------------------------------------+"
-    elif [[ $REPLY =~ ^[Yy](es)?$ ]]; then
-      git add bundle.js styles fonts assets index.html plus.ico "versions/$current_version/demo" demo_page_by_version.html
-      git commit -m "demo: deploy $current_version to the gh-pages" -S
-      git push origin gh-pages
-      break
-    elif [[ $REPLY =~ ^[Dd](iff)?$ ]]; then
-      git diff bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html || true # ignore when return 1
-    elif [[ $REPLY =~ ^[Ss](tatus)?$ ]]; then
-      git status bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html
-    elif [[ $REPLY =~ ^[Aa](bort)?$ ]]; then
-      echo "exiting"
-      exit 0
-    elif [[ $REPLY =~ ^[Cc](heckout)?$ ]]; then
-      git checkout bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html
-    elif [[ $REPLY =~ ^([Tt]|([Ss]tash))?$ ]]; then
-      git stash -u push bundle.js styles fonts assets index.html "versions/$current_version/demo" demo_page_by_version.html
-      break
-    fi
-  done
-else
-  echo "nothing to do on the gh-pages branch"
-fi
-
-git checkout master

package/scripts/update_gh-pages_doc

@@ -1,106 +0,0 @@
-#!/bin/bash
-
-# Update gh-pages doc
-# ====================
-#
-# This script allows to automatically update the generated documentation on the
-# gh-pages branch.
-#
-# To use it:
-#
-#   1. Be sure that you're on a clean (no staged files and no diff) master
-#      branch.
-#
-#   2. Call this script.
-#      Some user interactions will be needed to avoid doing unwanted commits.
-#
-#   3. That's it!
-#      A commit should have been pushed to the gh-pages.
-
-set -e
-
-current_branch=$(git branch | sed -n -e 's/^\* \(.*\)/\1/p')
-current_version=$(cat VERSION)
-
-if ! [ "$current_branch" == "master" ]; then
-  echo $current_branch
-  echo "ERROR: The current branch should be master"
-  exit 1;
-fi
-
-# Generate documentation
-npm run doc
-
-if [ -n "$(git status --porcelain doc)" ]; then
-  echo "ERROR: Please commit your modifications to master"
-  exit 1;
-fi
-
-tmpDir=$(mktemp -d)
-tmpDocList=$(mktemp)
-
-cp -r doc/generated/* $tmpDir
-cp scripts/generate_documentation_list.js $tmpDocList -v
-
-# update gh-pages
-git checkout gh-pages
-git pull origin gh-pages
-
-rm -rf "versions/$current_version/doc"
-mkdir -p "versions/$current_version/doc"
-rm -rf doc
-mv $tmpDir/* "versions/$current_version/doc"
-ln -s "./versions/$current_version/doc" doc
-mv $tmpDocList  generate_documentation_list.js
-
-node generate_documentation_list.js
-rm generate_documentation_list.js
-
-if [ -n "$(git status --porcelain doc "versions/$current_version/doc" documentation_pages_by_version.html)" ]; then
-  echo "-- Current Status on gh-pages: --"
-  echo ""
-  git status doc "versions/$current_version/doc" documentation_pages_by_version.html
-
-  while : ; do
-    echo ""
-    echo "We will push the documentation to gh-pages."
-    REPLY=""
-    read -p "do you want to continue [y/d/s/a/c/t/h] (h for help) ? " -n 1 -r
-    echo ""
-
-    if [[ $REPLY =~ ^[Hh](elp)?$ ]]; then
-      echo ""
-      echo ""
-      echo "+- help -------------------------------------------------+"
-      echo "| y: commit and continue                                 |"
-      echo "| d: see diff                                            |"
-      echo "| s: see status                                          |"
-      echo "| a: abort script from here                              |"
-      echo "| c: checkout from this commit and go to the next one    |"
-      echo "| t: stash this commit and go to the next one            |"
-      echo "| h: see this help                                       |"
-      echo "+--------------------------------------------------------+"
-    elif [[ $REPLY =~ ^[Yy](es)?$ ]]; then
-      git add doc "versions/$current_version/doc" documentation_pages_by_version.html
-      git commit -m "doc: deploy $current_version to the gh-pages" -S
-      git push origin gh-pages
-      break
-    elif [[ $REPLY =~ ^[Dd](iff)?$ ]]; then
-      git diff doc "versions/$current_version/doc" documentation_pages_by_version.html || true # ignore when return 1
-    elif [[ $REPLY =~ ^[Ss](tatus)?$ ]]; then
-      git status doc "versions/$current_version/doc" documentation_pages_by_version.html
-    elif [[ $REPLY =~ ^[Aa](bort)?$ ]]; then
-      echo "exiting"
-      exit 0
-    elif [[ $REPLY =~ ^[Cc](heckout)?$ ]]; then
-      git checkout doc "versions/$current_version/doc" documentation_pages_by_version.html
-    elif [[ $REPLY =~ ^([Tt]|([Ss]tash))?$ ]]; then
-      git stash -u push doc "versions/$current_version/doc" documentation_pages_by_version.html
-      break
-    fi
-  done
-else
-  echo "nothing to do on the gh-pages branch"
-fi
-
-git checkout master

package/scripts/utils/display_webpack_errors.js

@@ -1,33 +0,0 @@
-/* eslint-env node */
-
-/**
- * Format errors returned by webpack and display it through a `console.log`
- * call.
- * @param {Array.<Object>} errors
- * @param {Array.<Object>} warnings
- */
-module.exports = function displayWebpackErrors(errors, warnings) {
-  /* eslint-disable no-console */
-  for (let i = 0; i < warnings.length; i++) {
-    const warning = warnings[i];
-    if (warning.loaderSource != null) {
-      console.error(`\nWarning from ${warning.loaderSource}:`);
-    } else {
-      console.error("\nWarning:");
-    }
-    console.error(warning.message);
-  }
-  for (let i = 0; i < errors.length; i++) {
-    const error = errors[i];
-    if (error.loaderSource != null) {
-      console.error(`\nError from ${error.loaderSource}:`);
-    } else {
-      console.error("\nError:");
-    }
-    console.error(error.message);
-  }
-  if (errors.length || warnings.length) {
-    console.log();
-  }
-  /* eslint-enable no-console */
-};

package/scripts/utils/get_human_readable_hours.js

@@ -1,14 +0,0 @@
-/* eslint-env node */
-
-/**
- * Return the current date into a more readable `HH:mm:ss.fff`
- * (hours:minutes:seconds.milliseconds) format.
- * @returns {string}
- */
-module.exports = function getHumanReadableHours() {
-  const date = new Date();
-  return String(date.getHours()).padStart(2, "0") + ":" +
-    String(date.getMinutes()).padStart(2, "0") + ":" +
-    String(date.getSeconds()).padStart(2, "0") + "." +
-    String(date.getMilliseconds()).padStart(4, "0");
-};

package/scripts/wasm-strip.js

@@ -1,359 +0,0 @@
-/**
- * ============= wasm-strip util =============
- *
- * == What is this?
- *
- * This file allows to remove debugging information from a WebAssembly binary
- * file (`.wasm`).
- *
- *
- * == Why?
- *
- * This is necessary because the tool which normally perform that tasks for
- * Rust code is `wasm-bindgen` (or is it `wasm-pack`) which we don't use here.
- *
- * Without it, our wasm files becomes bloated for no real advantage when
- * building for production.
- *
- *
- * == How?
- *
- * As it turns out, this task is pretty simple as WebAssembly files are very
- * easy to parse and have a very clear specification.
- *
- * The most important specification page for that util is the one describing the
- * format of "modules" in the binary format:
- * https://webassembly.github.io/spec/core/binary/modules.html
- *
- * To ensure I was not going in a totally wrong direction, I also read the
- * code of the equivalent "wasm-strip" C util - part of the `wabt` toolkit.
- * The issue with that tool - and the reason I chose to re-write that in
- * node.js - was that this tool would both bring yet another language in the
- * code and also needs to be compiled.
- *
- * Turns out that I felt node.js stream-oriented filesystem APIs much more
- * painful to exploit than I first expected, but I hope it turned out OK.
- */
-
-const fs = require("fs");
-
-// Promise versions will be easier to work with here
-const { access, stat } = require("fs/promises");
-
-/** Magic number a WebAssembly file should start with. */
-const WASM_MAGIC_NUMBER = 0x0061736D;
-
-/**
- * Id for the "Custom" sections of a WebAssembly files.
- * Those are either for debugging information or non-standard extensions.
- *
- * Those sections is what this tool remove.
- */
-const CUSTOM_SECTION_ID = 0;
-
-run();
-
-async function run() {
-
-  let fileName, tmpName;
-
-  try {
-    fileName = extractFileNameFromArgs();
-  } catch (err) {
-    onFatalError(err);
-  }
-  console.log("Starting logic to strip wasm file:", fileName);
-
-  /**
-   * Promise emitting the size of the original file.
-   * We need it much later, in the result, but as this is async better doing it
-   * ASAP.
-   */
-  const initialFileSizeProm = stat(fileName).then(s => s.size);
-
-  try {
-    tmpName = await getTmpName(fileName);
-  } catch (err) {
-    onFatalError(err);
-  }
-  console.log("A temporary file will be created:", tmpName);
-
-  const readStream = fs.createReadStream(fileName);
-  const writeStream = fs.createWriteStream(tmpName);
-
-  let result;
-  try {
-    result = await readAndStripWasm(readStream, writeStream);
-  } catch (err) {
-    onFatalError(err, tmpName);
-  }
-  readStream.close();
-
-  try {
-    await waitForWriteStreamFinish(writeStream);
-  } catch (err) {
-    onFatalError(err, tmpName);
-  }
-  console.log("Stripping has been done, checking...");
-
-  const nbBytesRemoved = result.removedSections
-    .reduce((acc, r) => acc + r.length, 0);
-
-  let initialFileSize;
-  try {
-    initialFileSize = await initialFileSizeProm;
-  } catch (err) {
-    onFatalError(err, tmpName);
-  }
-
-  let newFileSize;
-  try {
-    newFileSize = await stat(tmpName).then(s => s.size);
-  } catch (err) {
-    onFatalError(err, tmpName);
-  }
-
-  // TODO better validation?
-  if (initialFileSize - nbBytesRemoved !== newFileSize) {
-    const expected = initialFileSize - nbBytesRemoved;
-    const err = new Error(`Expected a file of ${expected} bytes, ` +
-                          `actually got ${newFileSize} bytes.`);
-    onFatalError(err, tmpName);
-  }
-  console.log("Check succeed! Moving temporary file back to original file...");
-  try {
-    fs.renameSync(tmpName, fileName);
-  } catch (err) {
-    onFatalError(err, tmpName);
-  }
-
-  if (nbBytesRemoved === 0) {
-    console.log("Nothing was removed, your wasm file was already devoid of the " +
-                "sections stripped by this tool.");
-  } else {
-    console.log(`Success!\nRemoved ${nbBytesRemoved} bytes by stripping ` +
-                `out ${result.removedSections.length} sections.\n` +
-                `Size went from ${initialFileSize}B to ${newFileSize}B.`);
-  }
-  process.exit(0);
-}
-
-function onFatalError(err, tmpName) {
-  console.error("Error:", err?.message ?? "Unknown");
-  if (tmpName !== undefined) {
-    try {
-      fs.unlinkSync(tmpName);
-    } catch (err) {
-      console.error("Error: Could not remove temporary file:", tmpName);
-    }
-  }
-  process.exit(1);
-}
-
-function waitForWriteStreamFinish(writeStream) {
-  return new Promise((res, rej) => {
-    writeStream.on("finish", () => {
-      res();
-    });
-    writeStream.on("error", rej);
-    writeStream.end();
-  });
-
-}
-
-/**
- * TODO exploit writeStream.write "drain" response?
- * TODO add writeStream.write callback? (Maybe a wrapper might be the easiest
- * way to do both)
- * @param {fs.ReadStream} readStream
- * @param {fs.WriteStream} writeStream
- * @returns {Promise.<Object>}
- */
-function readAndStripWasm(readStream, writeStream) {
-  return new Promise((res, rej) => {
-    const result = {
-      keptSections: [],
-      removedSections: [],
-    };
-    let prevBuffered = null
-    let checkedMagicAndVersion = false;
-    let currOffset = 0;
-    let nextSectionOffset = 8;
-    let maxOffsetInChunk = 0;
-    let skipCurrentSection = false;
-
-    readStream.on("end", () => {
-      if (prevBuffered !== null) {
-        onNext(prevBuffered);
-      }
-
-      if (maxOffsetInChunk !== nextSectionOffset) {
-        rej(new Error("EOF encountered before the end"));
-        return;
-      }
-      res(result);
-    });
-
-    readStream.on("data", chunk => {
-      const buff = prevBuffered === null ?
-        chunk.buffer :
-        concatArrayBuffers(prevBuffered, chunk.buffer);
-      onNext(buff);
-    });
-
-    function onNext(buff) {
-      maxOffsetInChunk = currOffset + buff.byteLength;
-      const chunkBaseOffset = currOffset;
-
-      if (!checkedMagicAndVersion) {
-        if (buff.byteLength < 8) {
-          prevBuffered = buff;
-          return;
-        }
-        checkMagicNumberAndVersion(buff);
-        checkedMagicAndVersion = true;
-        writeStream.write(Buffer.from(buff.slice(0, 8)));
-        currOffset += 8;
-      }
-
-      while (currOffset < maxOffsetInChunk) {
-        if (nextSectionOffset === currOffset) {
-          const relativeOffset = currOffset - chunkBaseOffset;
-          if (buff.byteLength - relativeOffset < 6 /* id + max LEB128 u32 size */) {
-            prevBuffered = buff.slice(relativeOffset);
-            return;
-          }
-          const dataView = new DataView(buff);
-          const sectionType = dataView.getUint8(relativeOffset);
-          const [size, sizeOfSize] = readULeb128(dataView,
-                                                 relativeOffset + 1);
-
-          const sectionInfo = { sectionType,
-                                offset: currOffset,
-                                contentSize: size,
-                                length: size + 1 + sizeOfSize };
-          currOffset += 1 + sizeOfSize; // Section id + size
-
-          if (sectionType === CUSTOM_SECTION_ID) {
-            skipCurrentSection = true;
-            result.removedSections.push(sectionInfo);
-          } else {
-            skipCurrentSection = false;
-            writeStream.write(Buffer.from(buff.slice(relativeOffset,
-                                                     currOffset - chunkBaseOffset)));
-            result.keptSections.push(sectionInfo);
-          }
-          nextSectionOffset = size + currOffset;
-        }
-        const newOffset = Math.min(maxOffsetInChunk, nextSectionOffset);
-        if (!skipCurrentSection) {
-          writeStream.write(Buffer.from(buff.slice(currOffset - chunkBaseOffset,
-                                                   newOffset - chunkBaseOffset)));
-        }
-        currOffset = newOffset;
-      }
-    }
-  });
-}
-
-function checkMagicNumberAndVersion(buff) {
-  if (buff.byteLength < 8) {
-    throw new Error("Error: Not a valid WebAssembly file: file too short");
-  }
-  const dataView = new DataView(buff);
-  if (dataView.getUint32(0) !== WASM_MAGIC_NUMBER) {
-    throw new Error("Error: Not a valid WebAssembly file: no magic number");
-  }
-  if (dataView.getUint32(4, true) !== 1) {
-    throw new Error("Error: Unsupported WebAssembly version: ",
-                    dataView.getUint32(4, true));
-  }
-}
-
-function concatArrayBuffers(...buffers) {
-  const ret = new Uint8Array(buffers.reduce((acc, buff) => acc + buff.byteLength, 0));
-  let currOffset = 0;
-  for (let i = 0; i < buffers.length; i++) {
-    const buffer = buffers[i];
-    ret.set(buffer, currOffset);
-    currOffset += buffer.byteLength;
-  }
-  return ret.buffer;
-}
-
-/**
- * WebAssembly got that weird "LEB128" integer format.
- *
- * This function parses the unsigned version into a JS number.
- * @param {DataView} dv
- * @param {number} offset - Offset, in bytes, in the buffer where that number
- * starts.
- * @returns {Array.<number>}
- */
-function readULeb128(dv, offset) {
-  let res = 0;
-  let currShift = 0;
-  let currOffset = offset;
-  let nbSize = 0;
-  while (currOffset < dv.byteLength) {
-    // take next bytesize=0x00000070
-    const byte = dv.getInt8(currOffset);
-
-    // do some shenanigans to extract the interesting value.
-    // (all but the highest bit, which just tells us when this is the end).
-    const val = byte & 0x7F;
-
-    res |= (val << currShift);
-    nbSize++;
-
-    // higher bit set to 0 == end of number
-    // Note: the parentheses seems to be VERY important there, lost too much
-    // time on that one
-    if ((byte & 0x80) === 0) {
-      return [res, nbSize];
-    }
-    currShift += 7;
-    currOffset += 1;
-  }
-  throw new Error("Error: EOF in parsed integer");
-}
-
-/**
- * Generate name of the temporary file by adding ".tmp" at the end of it.
- * If that file already exists, adds ".tmp_2" instead.
- * If that file also already exists, adds ".tmp_3" instead.
- * And so on.
- * @param {string} fileName - The original file name.
- * @returns {Promise.<string>} - Emit the generated name.
- * Reject if unable to do so;
- * never reject.
- */
-async function getTmpName(fileName) {
-  let i = 1;
-  while (true) {
-    if (i > 1000) {
-      throw new Error("Error: Too many temporary files, check if there's " +
-                      "something wrong with this script.");
-    }
-
-    let tmpFileName;
-    try {
-      tmpFileName = fileName + ".tmp" + (i === 1 ? "" :
-                                                   `_${i}`);
-      await access(tmpFileName);
-      i++;
-    } catch (e) {
-      return tmpFileName;
-    }
-  }
-}
-
-function extractFileNameFromArgs() {
-  const processArgs = process.argv.slice(2);
-
-  if (processArgs.length === 0) {
-   throw new Error("Error: Missing filename argument");
-  }
-
-  return processArgs[0];
-}

package/sonar-project.properties

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