legacySupport: Run node 10 with '--experimental_worker' flags (#4392)

* Run node 10 with '--experimental_worker' flags
* Use dedicated function to retrieve node/npm program version

The goal of this commit is to ensure that any linux based node 10 deployments run with the experimental_worker flag.  This flag is required for workers to "work" in node 10.  This will not affect other versions of node.  This resolves #4335 where Docker would fail due to being based on node 10.

Dockerfile

@@ -51,4 +51,4 @@ COPY --chown=etherpad:0 ./settings.json.docker /opt/etherpad-lite/settings.json
 RUN chmod -R g=u .
 
 EXPOSE 9001
-CMD ["node", "node_modules/ep_etherpad-lite/node/server.js"]
+CMD ["node", "--experimental-worker", "node_modules/ep_etherpad-lite/node/server.js"]

bin/cleanRun.sh

@@ -1,7 +1,10 @@
 #!/bin/sh
 
 # Move to the folder where ep-lite is installed
-cd $(dirname $0)
+cd "$(dirname "$0")"/..
+
+# Source constants and usefull functions
+. bin/functions.sh
 
 #Was this script started in the bin folder? if yes move out
 if [ -d "../bin" ]; then
@@ -38,4 +41,4 @@ bin/installDeps.sh "$@" || exit 1
 echo "Started Etherpad..."
 
 SCRIPTPATH=$(pwd -P)
-node "${SCRIPTPATH}/node_modules/ep_etherpad-lite/node/server.js" "$@"
+node $(compute_node_args) "${SCRIPTPATH}/node_modules/ep_etherpad-lite/node/server.js" "$@"

bin/debugRun.sh

@@ -3,6 +3,9 @@
 # Move to the folder where ep-lite is installed
 cd "$(dirname "$0")"/..
 
+# Source constants and usefull functions
+. bin/functions.sh
+
 # Prepare the environment
 bin/installDeps.sh || exit 1
 
@@ -12,4 +15,4 @@ echo "Open 'chrome://inspect' on Chrome to start debugging."
 
 # Use 0.0.0.0 to allow external connections to the debugger
 # (ex: running Etherpad on a docker container). Use default port # (9229)
-node --inspect=0.0.0.0:9229 node_modules/ep_etherpad-lite/node/server.js "$@"
+node $(compute_node_args) --inspect=0.0.0.0:9229 node_modules/ep_etherpad-lite/node/server.js "$@"

bin/fastRun.sh

@@ -12,6 +12,9 @@ set -eu
 # source: https://stackoverflow.com/questions/59895/how-to-get-the-source-directory-of-a-bash-script-from-within-the-script-itself#246128
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
 
+# Source constants and usefull functions
+. ${DIR}/../bin/functions.sh
+
 echo "Running directly, without checking/installing dependencies"
 
 # move to the base Etherpad directory. This will be necessary until Etherpad
@@ -19,4 +22,4 @@ echo "Running directly, without checking/installing dependencies"
 cd "${DIR}/.."
 
 # run Etherpad main class
-node "${DIR}/../node_modules/ep_etherpad-lite/node/server.js" "${@}"
+node $(compute_node_args) "${DIR}/../node_modules/ep_etherpad-lite/node/server.js" "$@"

bin/functions.sh

@@ -0,0 +1,74 @@
+# minimum required node version
+REQUIRED_NODE_MAJOR=10
+REQUIRED_NODE_MINOR=13
+
+# minimum required npm version
+REQUIRED_NPM_MAJOR=5
+REQUIRED_NPM_MINOR=5
+
+pecho() { printf %s\\n "$*"; }
+log() { pecho "$@"; }
+error() { log "ERROR: $@" >&2; }
+fatal() { error "$@"; exit 1; }
+is_cmd() { command -v "$@" >/dev/null 2>&1; }
+
+
+get_program_version() {
+  PROGRAM="$1"
+  KIND="${2:-full}"
+  PROGRAM_VERSION_STRING=$($PROGRAM --version)
+  PROGRAM_VERSION_STRING=${PROGRAM_VERSION_STRING#"v"}
+
+  DETECTED_MAJOR=$(pecho "$PROGRAM_VERSION_STRING" | cut -s -d "." -f 1)
+  [ -n "$DETECTED_MAJOR" ] || fatal "Cannot extract $PROGRAM major version from version string \"$PROGRAM_VERSION_STRING\""
+  case "$DETECTED_MAJOR" in
+      ''|*[!0-9]*)
+        fatal "$PROGRAM_LABEL major version from \"$VERSION_STRING\" is not a number. Detected: \"$DETECTED_MAJOR\""
+        ;;
+  esac
+
+  DETECTED_MINOR=$(pecho "$PROGRAM_VERSION_STRING" | cut -s -d "." -f 2)
+  [ -n "$DETECTED_MINOR" ] || fatal "Cannot extract $PROGRAM minor version from version string \"$PROGRAM_VERSION_STRING\""
+  case "$DETECTED_MINOR" in
+      ''|*[!0-9]*)
+        fatal "$PROGRAM_LABEL minor version from \"$VERSION_STRING\" is not a number. Detected: \"$DETECTED_MINOR\""
+  esac
+
+  case $KIND in
+    major)
+      echo $DETECTED_MAJOR
+      exit;;
+    minor)
+      echo $DETECTED_MINOR
+      exit;;
+    *)
+      echo $DETECTED_MAJOR.$DETECTED_MINOR
+      exit;;
+  esac
+
+  echo $VERSION
+}
+
+
+compute_node_args() {
+  ARGS=""
+
+  NODE_MAJOR=$(get_program_version "node" "major")
+  [ "$NODE_MAJOR" -eq "10" ] && ARGS="$ARGS --experimental-worker"
+
+  echo $ARGS
+}
+
+
+require_minimal_version() {
+  PROGRAM_LABEL="$1"
+  VERSION="$2"
+  REQUIRED_MAJOR="$3"
+  REQUIRED_MINOR="$4"
+
+  VERSION_MAJOR=$(pecho "$VERSION" | cut -s -d "." -f 1)
+  VERSION_MINOR=$(pecho "$VERSION" | cut -s -d "." -f 2)
+
+  [ "$VERSION_MAJOR" -gt "$REQUIRED_MAJOR" ] || ([ "$VERSION_MAJOR" -eq "$REQUIRED_MAJOR" ] && [ "$VERSION_MINOR" -ge "$REQUIRED_MINOR" ]) \
+    || fatal "Your $PROGRAM_LABEL version \"$VERSION_MAJOR.$VERSION_MINOR\" is too old. $PROGRAM_LABEL $REQUIRED_MAJOR.$REQUIRED_MINOR.x or higher is required."
+}

bin/installDeps.sh

@@ -1,52 +1,11 @@
 #!/bin/sh
 
-# minimum required node version
-REQUIRED_NODE_MAJOR=10
-REQUIRED_NODE_MINOR=13
-
-# minimum required npm version
-REQUIRED_NPM_MAJOR=5
-REQUIRED_NPM_MINOR=5
-
-pecho() { printf %s\\n "$*"; }
-log() { pecho "$@"; }
-error() { log "ERROR: $@" >&2; }
-fatal() { error "$@"; exit 1; }
-is_cmd() { command -v "$@" >/dev/null 2>&1; }
-
-require_minimal_version() {
-  PROGRAM_LABEL="$1"
-  VERSION_STRING="$2"
-  REQUIRED_MAJOR="$3"
-  REQUIRED_MINOR="$4"
-
-  # Flag -s (--only-delimited on GNU cut) ensures no string is returned
-  # when there is no match
-  DETECTED_MAJOR=$(pecho "$VERSION_STRING" | cut -s -d "." -f 1)
-  DETECTED_MINOR=$(pecho "$VERSION_STRING" | cut -s -d "." -f 2)
-
-  [ -n "$DETECTED_MAJOR" ] || fatal "Cannot extract $PROGRAM_LABEL major version from version string \"$VERSION_STRING\""
-
-  [ -n "$DETECTED_MINOR" ] || fatal "Cannot extract $PROGRAM_LABEL minor version from version string \"$VERSION_STRING\""
-
-  case "$DETECTED_MAJOR" in
-      ''|*[!0-9]*)
-        fatal "$PROGRAM_LABEL major version from \"$VERSION_STRING\" is not a number. Detected: \"$DETECTED_MAJOR\""
-        ;;
-  esac
-
-  case "$DETECTED_MINOR" in
-      ''|*[!0-9]*)
-        fatal "$PROGRAM_LABEL minor version from \"$VERSION_STRING\" is not a number. Detected: \"$DETECTED_MINOR\""
-  esac
-
-  [ "$DETECTED_MAJOR" -gt "$REQUIRED_MAJOR" ] || ([ "$DETECTED_MAJOR" -eq "$REQUIRED_MAJOR" ] && [ "$DETECTED_MINOR" -ge "$REQUIRED_MINOR" ]) \
-    || fatal "Your $PROGRAM_LABEL version \"$VERSION_STRING\" is too old. $PROGRAM_LABEL $REQUIRED_MAJOR.$REQUIRED_MINOR.x or higher is required."
-}
-
 # Move to the folder where ep-lite is installed
 cd "$(dirname "$0")"/..
 
+# Source constants and usefull functions
+. bin/functions.sh
+
 # Is node installed?
 # Not checking io.js, default installation creates a symbolic link to node
 is_cmd node || fatal "Please install node.js ( https://nodejs.org )"
@@ -55,15 +14,10 @@ is_cmd node || fatal "Please install node.js ( https://nodejs.org )"
 is_cmd npm || fatal "Please install npm ( https://npmjs.org )"
 
 # Check npm version
-NPM_VERSION_STRING=$(npm --version)
+require_minimal_version "npm" $(get_program_version "npm") "$REQUIRED_NPM_MAJOR" "$REQUIRED_NPM_MINOR"
-
-require_minimal_version "npm" "$NPM_VERSION_STRING" "$REQUIRED_NPM_MAJOR" "$REQUIRED_NPM_MINOR"
 
 # Check node version
-NODE_VERSION_STRING=$(node --version)
+require_minimal_version "nodejs" $(get_program_version "node") "$REQUIRED_NODE_MAJOR" "$REQUIRED_NODE_MINOR"
-NODE_VERSION_STRING=${NODE_VERSION_STRING#"v"}
-
-require_minimal_version "nodejs" "$NODE_VERSION_STRING" "$REQUIRED_NODE_MAJOR" "$REQUIRED_NODE_MINOR"
 
 # Get the name of the settings file
 settings="settings.json"

bin/run.sh

@@ -1,13 +1,11 @@
 #!/bin/sh
 
-pecho() { printf %s\\n "$*"; }
-log() { pecho "$@"; }
-error() { log "ERROR: $@" >&2; }
-fatal() { error "$@"; exit 1; }
-
 # Move to the folder where ep-lite is installed
 cd "$(dirname "$0")"/..
 
+# Source constants and usefull functions
+. bin/functions.sh
+
 ignoreRoot=0
 for ARG in "$@"; do
   if [ "$ARG" = "--root" ]; then
@@ -34,4 +32,4 @@ bin/installDeps.sh "$@" || exit 1
 log "Starting Etherpad..."
 
 SCRIPTPATH=$(pwd -P)
-exec node "$SCRIPTPATH/node_modules/ep_etherpad-lite/node/server.js" "$@"
+exec node $(compute_node_args) "$SCRIPTPATH/node_modules/ep_etherpad-lite/node/server.js" "$@"