fix: add script to use node 18.20 for e2e tests (#937)

* add 18.20 node installation to build_windows

* remove extra empty line

* add 18.20 node installation to buildLinux

* setup node version in _setupGen2E2ETestsLinux

* update setupNode in _setupGen2E2ETests

* remove redundant code

* add refreshenv

* refresh env in powerShell

* refresh env var in linux

* update refresh env var

* change node setup location

* try cmd //c refreshenv

* manually update PATH

* add more debug statements

* use shell: true to properly execute the .cmd file on Windows

* remove debug statements

* refresh env var using export PATH=$PATH, remove manual update

* remove comment

* update the comment doc for getAmpxPath, scope down the shell option to windows only

* setup node version for _buildLinux and _buildWindows

* fix typo

* not setup node version for _buildLinux and _buildWindows for now

* set up node version for build linux and build windows again

* typo

Author: bobbyu99

packages/amplify-codegen-e2e-tests/src/gen2-codegen-tests-base/commands.ts

@@ -8,13 +8,30 @@ import { spawnSync } from 'child_process';
  * @returns the local `npx` executable path.
  */
 const getNpxPath = (): string => (process.platform === 'win32' ? getScriptRunnerPath().replace('node.exe', 'npx.cmd') : 'npx');
+
 /**
- * Retrieve the path to the `ampx` executable for interacting with the amplify gen2 cli.
+ * Retrieve the path to the `ampx` executable for interacting with the Amplify Gen2 CLI.
  * @param cwd current working directory
  * @returns the local `ampx` executable path
+ *
+ * Note:
+ * On Windows, batch files (like npx.cmd) must be executed through a shell.
+ * Therefore, this function uses `shell: process.platform === 'win32'` to ensure that the command
+ * is run via the shell on Windows. This change was required after upgrading to Node 18,
+ * where a security update now causes an EINVAL error if a .cmd file is executed without the shell option.
+ *
+ * See: https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2#command-injection-via-args-parameter-of-child_processspawn-without-shell-option-enabled-on-windows-cve-2024-27980---high
+ *
+ * Warning:
+ * Command arguments **must** be sanitized to avoid injection risks.
  */
 const getAmpxPath = (cwd: string): string =>
-  spawnSync(getNpxPath(), ['which', 'ampx'], { cwd, env: process.env, stdio: 'pipe' }).stdout.toString().trim();
+  spawnSync(getNpxPath(), ['which', 'ampx'], {
+    cwd,
+    env: process.env,
+    stdio: 'pipe',
+    shell: process.platform === 'win32',
+  }).stdout.toString().trim();
 
 const codegenPackagesInGen2 = [
   '@aws-amplify/graphql-generator',

shared-scripts.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+AMPLIFY_NODE_VERSION=18.20.4
+
 # set exit on error to true
 set -e
 
@@ -131,13 +133,17 @@ function _setShell {
 
 function _buildLinux {
   _setShell
+  echo "Setup Node Version $AMPLIFY_NODE_VERSION for Linux"
+  _setupNodeVersionLinux $AMPLIFY_NODE_VERSION
   echo "Linux Build"
   yarn run production-build
   storeCacheForLinuxBuildJob
 }
 
 function _buildWindows {
   echo "Linux Build"
+  echo "Setup Node Version $AMPLIFY_NODE_VERSION for Windows"
+  _setupNodeVersionWindows $AMPLIFY_NODE_VERSION
   yarn run production-build
   storeCacheForWindowsBuildJob
 }
@@ -288,7 +294,6 @@ function _setupGen2E2ETestsWindows {
     _setShell
 }
 
-
 function _runE2ETestsLinux {
     echo "RUN E2E Tests Linux"
     retry runE2eTest
@@ -301,11 +306,15 @@ function _runE2ETestsWindows {
 
 function _runGen2E2ETestsLinux {
     echo "RUN Gen2 E2E Tests Linux"
+    echo "Setup Node Version"
+    _setupNodeVersionLinux $AMPLIFY_NODE_VERSION
     retry runGen2E2eTest
 }
 
 function _runGen2E2ETestsWindows {
     echo "RUN Gen2 E2E Tests Windows"
+    echo "Setup Node Version"
+    _setupNodeVersionWindows $AMPLIFY_NODE_VERSION
     retry runGen2E2eTest
 }
 
@@ -529,4 +538,46 @@ function _emitRegionalizedCanaryMetric {
     --value $CODEBUILD_BUILD_SUCCEEDING \
     --dimensions branch=release,region=$CLI_REGION \
     --region us-west-2
-}
+}
+
+function _setupNodeVersionLinux {
+  local version=$1  # Version number passed as an argument
+  
+  echo "Installing NVM and setting Node.js version to $version"
+  
+  # Install NVM
+  curl -o - https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
+  
+  # Load NVM
+  export NVM_DIR="$HOME/.nvm"
+  [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+  
+  # Install and use the specified Node.js version
+  nvm install "$version"
+  nvm use "$version"
+
+  # Refresh environment variables
+  source ~/.bashrc  # Or source the appropriate shell profile file like ~/.bash_profile or ~/.zshrc
+  
+  # Verify the Node.js version in use
+  echo "Node.js version in use:"
+  node -v
+}
+
+function _setupNodeVersionWindows {
+  local version=$1  # Version number passed as an argument
+  
+  echo "Installing Node.js version $version on Windows"
+  
+  # Install Node.js using Chocolatey
+  echo "Installing Node.js version $version using Chocolatey"
+  choco install -fy nodejs-lts --version=$version
+
+  # Refresh environment variables
+  echo "Refreshing environment variables"
+  export PATH=$PATH
+  
+  # Verify the Node.js version in use
+  nodeVersion=$(node -v)
+  echo "Node version: $nodeVersion"
+}