Merge pull request #1373 from canalplus/misc/auto-install-script

Auto-install Rust compiler toolchain locally for CI and JS devs of other projects

.github/workflows/checks.yml

@@ -64,13 +64,9 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
     # needed for integration & memory tests codecs support
     - run: sudo add-apt-repository multiverse && sudo apt update && sudo apt install -y ubuntu-restricted-extras
     - run: npm install
-    - run: rustup target add wasm32-unknown-unknown
     - run: npm run build
     # Firefox seems to have issue with integration tests on GitHub actions only
     # TODO to check

.gitignore

@@ -1,3 +1,4 @@
+/tmp
 /*.keys
 /*.log
 /.scannerwork

package.json

@@ -158,7 +158,7 @@
     "build:dev": "./scripts/generate_build.mjs --dev-mode",
     "build:all": "npm run build:wasm:release && npm run bundle && npm run bundle:min && npm run build",
     "build:wasm:debug": "mkdir -p dist && cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown && cp target/wasm32-unknown-unknown/debug/mpd_node_parser.wasm ../../../../../dist/mpd-parser.wasm",
-    "build:wasm:release": "mkdir -p dist && cd ./src/parsers/manifest/dash/wasm-parser && cargo build --target wasm32-unknown-unknown --release && node ../../../../../scripts/wasm-optimize.mjs target/wasm32-unknown-unknown/release/mpd_node_parser.wasm ../../../../../dist/mpd-parser.wasm && cd ../../../../../ && npm run wasm-strip",
+    "build:wasm:release": "./scripts/build_wasm_release.sh",
     "bundle": "webpack --progress --config webpack.config.mjs --env production",
     "bundle:min": "webpack --progress --config webpack.config.mjs --env minify --env production",
     "bundle:min:watch": "webpack --progress --config webpack.config.mjs -w --env production --env minify",

scripts/build_wasm_release.sh

@@ -0,0 +1,64 @@
+#!/bin/sh
+
+# TODO documentation
+
+print_toolchain_installation_notice() {
+  echo " +----------------------------------------------------------------------------------+"
+  echo " |  A rust toolchain will be installed locally in a temporary directory (./tmp).    |"
+  echo " |                                                                                  |"
+  echo " |  If you intend to develop on the RxPlayer regularly, it is recommended that you  |"
+  echo " |  install globally rustup (with the \"wasm32-unknown-unknown\" target) as well as   |"
+  echo " |  binaryen. Once done, please remove this \"tmp\" directory.                        |"
+  echo " +----------------------------------------------------------------------------------+"
+}
+
+has_local_cargo=false
+has_local_wasmopt=false
+has_installed=false
+
+mkdir -p dist
+
+if [ -f tmp/cargo/bin/cargo ]; then
+  has_local_cargo=true
+elif ! cargo_loc="$(type -p "cargo")" || [[ -z $cargo_loc ]]; then
+  echo "WARNING: cargo command not found."
+  print_toolchain_installation_notice
+  sleep 1
+  ./scripts/install_rust_toolchain.sh
+  has_local_cargo=true
+  has_installed=true
+fi
+
+if [ -f tmp/binaryen/bin/wasm-opt ]; then
+  has_local_wasmopt=true
+elif ! wasmopt_loc="$(type -p "wasm-opt")" || [[ -z $wasmopt_loc ]]; then
+  if $has_installed; then
+    >&2 echo "Error: did not succeed to install binaryen dependency. Please install it manually."
+    exit 1
+  fi
+
+  echo "WARNING: wasm-opt command not found."
+  print_toolchain_installation_notice
+  sleep 1
+  ./scripts/install_rust_toolchain.sh
+  has_local_wasmopt=true
+  has_installed=true
+fi
+
+# Move to MPD parser directory
+cd ./src/parsers/manifest/dash/wasm-parser
+echo "Building mpd-parser WebAssembly file with Cargo..."
+if $has_local_cargo; then
+  echo "⚠️  NOTE  ⚠️ : Relying on local cargo in ./tmp/cargo/bin/cargo"
+  ../../../../../tmp/cargo/bin/cargo build --target wasm32-unknown-unknown --release
+else
+  cargo build --target wasm32-unknown-unknown --release
+fi
+
+echo "Optimizing mpd-parser WebAssembly build..."
+if $has_local_wasmopt; then
+  echo "⚠️  NOTE  ⚠️ : Relying on local wasm-opt in ./tmp/binaryen/bin/wasm-opt"
+  ../../../../../tmp/binaryen/bin/wasm-opt target/wasm32-unknown-unknown/release/mpd_node_parser.wasm --signext-lowering --strip-dwarf -O4 -o ../../../../../dist/mpd-parser.wasm
+else
+  wasm-opt target/wasm32-unknown-unknown/release/mpd_node_parser.wasm --signext-lowering --strip-dwarf -O4 -o ../../../../../dist/mpd-parser.wasm
+fi

scripts/install_rust_toolchain.sh

@@ -0,0 +1,146 @@
+#!/bin/sh
+
+# TODO Documentation
+
+# Log a line to stdout, prefixing it with the name of this script
+log() {
+  printf 'install_rust_toolchain: %s\n' "$1"
+}
+
+# Log a line to sterr, prefixing it with the name of this script
+err() {
+  log "ERROR: $1" >&2
+  echo ""
+  echo "Please install a rust toolchain (with the \"wasm32-unknown-unknown\" target) and binaryen manually" >&2
+  exit 1
+}
+
+# Checks that the command in argument exists, exits after printing the issue to
+# stderr if that's not the case
+requires_cmd() {
+  if ! command -v "$1" > /dev/null 2>&1; then
+    err "Need '$1' (command not found)"
+  fi
+}
+
+# Run a command that should never fail. If the command fails execution
+# will immediately terminate with an error showing the failing
+# command.
+ensure() {
+  if ! "$@"; then
+    err "Command failed: $*"
+  fi
+}
+
+log "This script will only install dependencies locally in a ./tmp directory"
+
+requires_cmd curl
+requires_cmd tar
+
+ensure mkdir -p tmp
+
+# Install RustUp in tmp directory with the right target
+log "Fetching rustup..."
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | CARGO_HOME=./tmp/cargo RUSTUP_HOME=./tmp/rustup RUSTUP_INIT_SKIP_PATH_CHECK=yes sh -s -- --no-modify-path --profile minimal --target wasm32-unknown-unknown -y
+if ! [ $? -eq 0 ]; then
+  err "Failed to install rustup"
+fi
+
+if ! [ -f tmp/cargo/bin/cargo ]; then
+  err "Error while installing rustup: Cargo not available in ./tmp/cargo/bin/cargo"
+fi
+
+# Should normally not be needed but CI have shown weird results
+ensure tmp/cargo/bin/rustup target add wasm32-unknown-unknown
+
+ostype="$(uname -s)"
+cpuarch="$(uname -m)"
+
+if [ "$ostype" = Linux ]; then
+  if [ "$(uname -o)" = Android ]; then
+    err "Unhandled OS type (Android), please install binaryen manually"
+  fi
+fi
+
+if [ "$ostype" = Darwin ] && [ "$cpuarch" = i386 ]; then
+  # Darwin `uname -m` lies
+  if sysctl hw.optional.x86_64 | grep -q ': 1'; then
+    cpuarch=x86_64
+  fi
+fi
+
+case "$ostype" in
+  Linux)
+    ;;
+  Darwin)
+    ;;
+  MINGW* | MSYS* | CYGWIN* | Windows_NT)
+    ostype=Windows
+    ;;
+  *)
+    err "Unhandled OS type ($ostype), please install binaryen manually"
+    ;;
+esac
+
+case "$cpuarch" in
+  aarch64 | arm64)
+    cpuarch=aarch64
+    ;;
+  x86_64 | x86-64 | x64 | amd64)
+    cpuarch=x86_64
+    ;;
+  *)
+    err "Unhandled CPU type ($cpuarch), please install binaryen manually"
+esac
+
+# TODO automatically download last binaryen?
+# We might need to detect which build is available. Targeting version 116 is
+# good enough for now
+if [ "${ostype}" = Darwin ]; then
+  if [ "${cpuarch}" = aarch64 ]; then
+    log "Architecture detected -> MacOS ARM"
+    binaryen_url=https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-arm64-macos.tar.gz
+  else
+    log "Architecture detected -> MacOS x86_64"
+    binaryen_url=https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-x86_64-macos.tar.gz
+  fi
+elif [ "${ostype}" = Linux ]; then
+  if [ "${cpuarch}" != x86_64 ]; then
+    err "For Linux, only x86_64 is supported by our auto-install script. Please install binaryen manually."
+  fi
+  log "Architecture detected -> Linux x86_64"
+  binaryen_url=https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-x86_64-linux.tar.gz
+elif [ "${ostype}" = Windows ]; then
+  if [ "${cpuarch}" != x86_64 ]; then
+    err "For Windows, only x86_64 is supported by our auto-install script. Please install binaryen manually."
+  fi
+  log "Architecture detected -> Windows x86_64"
+  binaryen_url=https://github.com/WebAssembly/binaryen/releases/download/version_116/binaryen-version_116-x86_64-windows.tar.gz
+fi
+
+log "Fetching binaryen 116..."
+curl -L $binaryen_url > tmp/binaryen.tar.gz
+if ! [ $? -eq 0 ]; then
+  err "Failed to fetch binaryen"
+fi
+
+
+cd tmp
+ensure tar xzf binaryen.tar.gz
+
+ensure mv binaryen-version_116 binaryen
+
+# TODO I don't know my windows, does that still work as an executable or is it just dumb?
+if [ "${ostype}" = Windows ]; then
+  ensure cp binaryen/bin/wasm-opt.exe binaryen/bin/wasm-opt
+fi
+
+rm binaryen.tar.gz
+cd ..
+
+if ! [ -f tmp/binaryen/bin/wasm-opt ]; then
+  err "Error after installing binaryen: wasm-opt not available in ./tmp/binaryen/bin/wasm-opt"
+fi
+
+echo ""
+echo "All dependencies have been installed with success!"