Provide compatibility with Node 18 and a few more little things

stronk7 · stronk7 · commit fd8ce7bdf15f · 2023-02-07T14:23:46.000+01:00
We need to support Node 18 from the CI tools (see MDL-75012). So
this commit provides that, basically.

The main difference is that the `npm bin` command is not available
anymore, and that's what we used both for:

1) Search if a given binary has been installed (say, grunt-cli...)
2) Launch a number of binaries (grunt, eslint, gherkin-lint....)

So here we are geting rid of all those uses, changing them by:

1) `npm list` to verify if a package is already installed.
2) `npx` to launch the binaries.

Also, we have removed some very-old conditional blocks in the code, that
were providing compatibility with very, very old Moodle branches, before
we used grunt and friends.

Finally, we are now installing stylelint-checkstyle-formatter if
it's detected that core has not installed it. After all, it's a CI
dependency, not a core one, so maybe the more correct thing is to
delegate its installation to the CI / testing tools.

And, basically, that is. I've tested it with both Node 16 (current
master) and Node 18 (MDL-75012) and seems to be working ok.

Going to run some tests now...
diff --git a/grunt_process/grunt_process.sh b/grunt_process/grunt_process.sh
@@ -38,9 +38,9 @@ if [[ -n ${npminstall} ]]; then
     source ${mydir}/../prepare_npm_stuff/prepare_npm_stuff.sh
 fi
 
-# Ensure we have grunt cli available before continue.
-gruntcmd="$(${npmcmd} bin)"/grunt
-if [ ! -x $gruntcmd ]; then
+# Ensure we have grunt binary available before continue.
+#
+if [[ ! -x node_modules/.bin/grunt ]]; then
     echo "Error: grunt executable not found" | tee "${outputfile}"
     exitstatus=1
 else
@@ -63,7 +63,7 @@ else
     fi
 
     set +e
-    $gruntcmd $tasks --no-color > >(tee "${outputfile}") 2> >(tee "${outputfile}".stderr >&2)
+    npx grunt $tasks --no-color > >(tee "${outputfile}") 2> >(tee "${outputfile}".stderr >&2)
     exitstatus=$?
     set -e
 fi
diff --git a/prepare_npm_stuff/prepare_npm_stuff.sh b/prepare_npm_stuff/prepare_npm_stuff.sh
@@ -90,72 +90,40 @@ if [[ -f ${gitdir}/package.json ]]; then
 
     echo "INFO: Installing npm stuff following package/shrinkwrap details"
 
+    if ! hash ${npmcmd} 2>/dev/null; then
+        echo "ERROR: npm not found in the system. Use .nvmrc OR install it in the PATH"
+        exit 2
+    fi
+
     # Always run npm install to keep our npm packages correct
     ${npmcmd} --no-color install
 
-    # Verify there is a grunt executable available, installing if missing
-    gruntcmd="$(${npmcmd} bin)"/grunt
-    if [[ ! -f ${gruntcmd} ]]; then
-        echo "WARN: grunt-cli executable not found. Installing everything"
-        ${npmcmd} --no-color --no-save install grunt-cli
-    fi
-else
-
-    # Install shifter version if there is not package.json
-    # (this is required for branches < 29_STABLE)
-    shifterinstall=""
-    shiftercmd="$(${npmcmd} bin)"/shifter
-    if [[ ! -f ${shiftercmd} ]]; then
-        echo "WARN: shifter executable not found. Installing it"
-        shifterinstall=1
-    else
-        # Have shifter, look its version matches expected one
-        # Cannot use --version because it's varying (performing calls to verify latest). Use --help instead
-        shiftercurrent=$(${shiftercmd} --no-color --help | head -1 | cut -d "@" -f2)
-        if [[ "${shiftercurrent}" != "${shifterversion}" ]]; then
-            echo "WARN: shifter executable "${shiftercurrent}" found, "${shifterversion}" expected. Installing it"
-            shifterinstall=1
-        else
-            # All right, shifter found and version matches
-            echo "INFO: shifter executable (${shifterversion}) found"
+    # Verify that grunt-cli is available (locally), installing if missing
+    if ! ${npmcmd} list --parseable | grep -q grunt-cli; then
+        # Last chance, look for the binary itself.
+        if [[ ! -x node_modules/.bin/grunt ]]; then
+            echo "WARN: grunt binary not found. Installing it now"
+            ${npmcmd} --no-color --no-save install grunt-cli
         fi
     fi
-    if [[ -n ${shifterinstall} ]]; then
-        ${npmcmd} --no-color install shifter@${shifterversion}
-        echo "INFO: shifter executable (${shifterversion}) installed"
-    fi
 
-    # Install recess version if there is not package.json
-    # (this is required for branches < 29_STABLE)
-    recessinstall=""
-    recesscmd="$(${npmcmd} bin)"/recess
-    if [[ ! -f ${recesscmd} ]]; then
-        echo "WARN: recess executable not found. Installing it"
-        recessinstall=1
-    else
-        # Have recess, look its version matches expected one
-        recesscurrent=$(${recesscmd} --no-color --version)
-        if [[ "${recesscurrent}" != "${recessversion}" ]]; then
-            echo "WARN: recess executable "${recesscurrent}" found, "${recessversion}" expected. Installing it"
-            recessinstall=1
-        else
-            # All right, recess found and version matches
-            echo "INFO: recess executable (${recessversion}) found"
-        fi
-    fi
-    if [[ -n ${recessinstall} ]]; then
-        ${npmcmd} --no-color install recess@${recessversion}
-        echo "INFO: recess executable (${recessversion}) installed"
+    # Verify that stylelint-checkstyle-formatter is available (locally), installing if missing
+    if ! ${npmcmd} list --parseable | grep -q stylelint-checkstyle-formatter; then
+        echo "WARN: stylelint-checkstyle-formatter package not found. Installing it now"
+        ${npmcmd} --no-color --no-save install stylelint-checkstyle-formatter
     fi
+else
+    echo "ERROR: Something is wrong. Missing package.json"
 fi
 
 # Move back to base directory.
 cd ${gitdir}
 
 # Output information about installed binaries.
 echo "INFO: Installation ended"
-echo "INFO: Available binaries @ ${gitdir}"
-echo "INFO: (Contents of $(${npmcmd} bin))"
-for binary in $(ls $(${npmcmd} bin)); do
-    echo "INFO:    - Installed ${binary}"
+echo "INFO: Installed packages @ $(npm root)"
+echo "INFO: (Contents of ${npmcmd} list --depth=1)"
+for package in $(${npmcmd} list --depth=1 --parseable); do
+    echo "INFO:    - Installed $(basename ${package})"
 done
+echo "============== END OF LIST =============="
diff --git a/remote_branch_checker/remote_branch_checker.sh b/remote_branch_checker/remote_branch_checker.sh
@@ -370,14 +370,14 @@ cat "${WORKSPACE}/work/mustachelint.txt" | ${phpcmd} ${mydir}/checkstyle_convert
 
 if [ -f $WORKSPACE/.gherkin-lintrc ]; then
     echo "Info: Running gherkin-lint..."
-    gherkinlintcmd="$(${npmcmd} bin)"/gherkin-lint
-    if [ -x $gherkinlintcmd ]; then
-        $gherkinlintcmd --format=json '**/tests/behat/*.feature' 2> "${WORKSPACE}/work/gherkin-lint.txt"
-        cat "${WORKSPACE}/work/gherkin-lint.txt" | ${phpcmd} ${mydir}/checkstyle_converter.php --format=gherkinlint > "${WORKSPACE}/work/gherkin-lint.xml"
-    else
-        echo "Error: .gherkin-lintrc file found, but /gherkin-lint executable not found" | tee -a ${errorfile}
+    if ! ${npmcmd} list --depth=1 --parseable | grep -q gherkin-lint; then
+        echo "Error: .gherkin-lintrc file found, but gherkin-lint package not found" | tee -a ${errorfile}
         exit 1
     fi
+
+    # Run gherkin-lint
+    npx gherkin-lint --format=json '**/tests/behat/*.feature' 2> "${WORKSPACE}/work/gherkin-lint.txt"
+    cat "${WORKSPACE}/work/gherkin-lint.txt" | ${phpcmd} ${mydir}/checkstyle_converter.php --format=gherkinlint > "${WORKSPACE}/work/gherkin-lint.xml"
 fi
 
 # Run the grunt checker if Gruntfile exists. node stuff has been already installed.
@@ -425,28 +425,27 @@ set +e
 
 if [ -f $WORKSPACE/.eslintrc ]; then
     echo "Info: Running eslint..."
-    eslintcmd="$(${npmcmd} bin)"/eslint
-    if [ -x $eslintcmd ]; then
-        # TODO: Remove this once everybody is using nodejs 14 or up.
-        # We need to invoke eslint differently depending of the installed version.
-        # (new versions v6.8 and up have this option to avoid exiting with error if there aren't JS files)
-        eslintarg="--no-error-on-unmatched-pattern"
-        # Old versions don't have this option, they exit without error if there aren't JS files, so don't use it.
-        if ! $eslintcmd --help | grep -q -- $eslintarg; then
-            eslintarg=""
-        fi
-        $eslintcmd -f checkstyle $eslintarg $WORKSPACE > "${WORKSPACE}/work/eslint.xml"
-    else
-        echo "Error: .eslintrc file found, but eslint executable not found" | tee -a ${errorfile}
+    if ! ${npmcmd} list --depth=1 --parseable | grep -q eslint; then
+        echo "Error: .eslintrc file found, but eslint package not found" | tee -a ${errorfile}
         exit 1
     fi
+
+    # Run eslint
+    # TODO: Remove this once everybody is using nodejs 14 or up.
+    # We need to invoke eslint differently depending of the installed version.
+    # (new versions v6.8 and up have this option to avoid exiting with error if there aren't JS files)
+    eslintarg="--no-error-on-unmatched-pattern"
+    # Old versions don't have this option, they exit without error if there aren't JS files, so don't use it.
+    if ! npx eslint --help | grep -q -- $eslintarg; then
+        eslintarg=""
+    fi
+    npx eslint -f checkstyle $eslintarg $WORKSPACE > "${WORKSPACE}/work/eslint.xml"
 fi
 
 if [ -f $WORKSPACE/.stylelintrc ]; then
     echo "Info: Running stylelint..."
-    stylelintcmd="$(${npmcmd} bin)"/stylelint
-    if [ ! -x $stylelintcmd ]; then
-        echo "Error: .stylelintrc file found, but stylelint executable not found" | tee -a ${errorfile}
+    if ! ${npmcmd} list --depth=1 --parseable | grep -q stylelint; then
+        echo "Error: .stylelintrc file found, but stylelint package not found" | tee -a ${errorfile}
         exit 1
     fi
 
@@ -456,10 +455,10 @@ if [ -f $WORKSPACE/.stylelintrc ]; then
     # (new versions 7.7.0 and up have this option to avoid exiting with error if there aren't CSS files)
     stylelintarg="--allow-empty-input"
     # Old versions don't have this option, they exit without error if there aren't CSS files, so don't use it.
-    if ! $stylelintcmd --help | grep -q -- $stylelintarg; then
+    if ! npx stylelint --help | grep -q -- $stylelintarg; then
         eslintarg=""
     fi
-    if $stylelintcmd $stylelintarg --customFormatter 'node_modules/stylelint-checkstyle-formatter' "*/**/*.{css,less,scss}" > "${WORKSPACE}/work/stylelint.xml"
+    if npx stylelint $stylelintarg --customFormatter 'node_modules/stylelint-checkstyle-formatter' "*/**/*.{css,less,scss}" > "${WORKSPACE}/work/stylelint.xml"
     then
         echo "Info: stylelint completed without errors."
     else
