Merge branch 'master' of github.com:roshan04/browserstack-cypress-cli

Author: roshan04

bin/commands/runs.js

@@ -97,6 +97,9 @@ module.exports = function run(args, rawArgs) {
     // set record feature caps
     utils.setRecordCaps(bsConfig, args);
 
+    // set node version
+    utils.setNodeVersion(bsConfig, args);
+
     //set browsers
     await utils.setBrowsers(bsConfig, args);
 

bin/helpers/capabilityHelper.js

@@ -254,6 +254,9 @@ const validate = (bsConfig, args) => {
       }
     }
 
+    if (!Utils.isUndefined(bsConfig.run_settings.nodeVersion) && typeof(bsConfig.run_settings.nodeVersion) === 'string' && !bsConfig.run_settings.nodeVersion.match(/^(\d+\.)?(\d+\.)?(\*|\d+)$/))
+        logger.warn(Constants.validationMessages.NODE_VERSION_PARSING_ERROR);
+
     resolve(cypressJson);
   });
 }

bin/helpers/constants.js

@@ -104,7 +104,8 @@ const validationMessages = {
   SPEC_TIMEOUT_LIMIT_ERROR: "The maximum allowed value of 'spec_timeout' is 120. Read more on https://browserstack.com/docs/automate/cypress/spec-timeout ",
   SPEC_TIMEOUT_NOT_PASSED_ERROR: "'spec_timeout' key not specified. Going ahead with 30 mins as the default spec timeout. Read more about how to specify the option in https://browserstack.com/docs/automate/cypress/spec-timeout ",
   PROJECT_ID_MISSING: "You have specified '--record' flag but you've not provided the 'projectId' in cypress.json or in browserstack.json. Your record functionality on cypress.io dashboard might not work as it needs both the key and the projectId",
-  RECORD_KEY_MISSING: "You have specified '--record' flag but you've not provided the '--record-key' and we could not find any value in 'CYPRESS_RECORD_KEY' environment variable. Your record functionality on cypress.io dashboard might not work as it needs the key and projectId"
+  RECORD_KEY_MISSING: "You have specified '--record' flag but you've not provided the '--record-key' and we could not find any value in 'CYPRESS_RECORD_KEY' environment variable. Your record functionality on cypress.io dashboard might not work as it needs the key and projectId",
+  NODE_VERSION_PARSING_ERROR: "We weren't able to successfully parse the specified nodeVersion. We will be using the default nodeVersion to run your tests."
 };
 
 const cliMessages = {
@@ -151,7 +152,8 @@ const cliMessages = {
     SPEC_TIMEOUT: "Specify a value for a hard timeout for each spec execution in the 1-120 mins range. Read https://browserstack.com/docs/automate/cypress/spec-timeout for more details.",
     RECORD: "Pass the --record flag to record your Cypress runs on Cypress.io dashboard. Note: You also need to specify '--record-key' and '--projectId' arguments either in CLI or in browserstack.json.",
     RECORD_KEY: "You can specify the 'key' that is needed to record your runs on Cypress.io dashboard using the '--record-key' argument. Alternatively, you can also pass it on browserstack.json",
-    PROJECT_ID: "You can pass the 'projectId' of your Cypress.io project where you want to record your runs if specifying the '--record' key. You can also specify this in your cypress.json or in your browserstack.json."
+    PROJECT_ID: "You can pass the 'projectId' of your Cypress.io project where you want to record your runs if specifying the '--record' key. You can also specify this in your cypress.json or in your browserstack.json.",
+    NODE_VERSION: "Pass the node version that you want BrowserStack to use to run your Cypress tests on."
   },
   COMMON: {
     DISABLE_USAGE_REPORTING: "Disable usage reporting",

bin/helpers/packageInstaller.js

@@ -5,8 +5,9 @@
   fileHelpers = require('./fileHelpers'),
   logger = require("./logger").winstonLogger,
   Constants = require('./constants'),
-  process = require('process'),
   utils = require('./utils'),
+  { get_version } = require('./usageReporting'),
+  process = require('process'),
   { spawn } = require('child_process'),
   util = require('util');
 
@@ -64,15 +65,30 @@ const packageInstall = (packageDir) => {
         logger.info(`Packages were installed locally successfully.`);
         resolve('Packages were installed successfully.');
       } else {
-        logger.error(`Some error occurred while installing packages. Error code ${code}`);
+        logger.error(`Some error occurred while installing packages. Error code ${code}. Please read npm_install_debug.log for more info.`);
         reject(`Packages were not installed successfully. Error code ${code}`);
       }
     };
     const nodeProcessErrorCallback = (error) => {
       logger.error(`Some error occurred while installing packages: %j`, error);
       reject(`Packages were not installed successfully. Error Description ${util.format('%j', error)}`);
     };
-    nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install', '--loglevel', 'verbose', '>', '../npm_install_debug.log', '2>&1'], {cwd: packageDir, shell: true});
+
+    let nodeProcess;
+    logger.debug(`Fetching npm version and its major version`);
+    const npm_version = get_version('npm')
+    const npm_major_version = utils.getMajorVersion(npm_version);
+    logger.debug(`Fetched npm version: ${npm_version} and its major version: ${npm_major_version}`);
+
+    // add --legacy-peer-deps flag while installing dependencies for npm v7+
+    // For more info please read "Peer Dependencies" section here -> https://github.blog/2021-02-02-npm-7-is-now-generally-available/
+    if (parseInt(npm_major_version) >= 7) {
+      logger.debug(`Running NPM install command: npm install --legacy-peer-deps --loglevel verbose > ../npm_install_debug.log`);
+      nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install', '--legacy-peer-deps', '--loglevel', 'verbose', '>', '../npm_install_debug.log', '2>&1'], {cwd: packageDir, shell: true});
+    } else {
+      logger.debug(`Running NPM install command: 'npm install --loglevel verbose > ../npm_install_debug.log'`);
+      nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install', '--loglevel', 'verbose', '>', '../npm_install_debug.log', '2>&1'], {cwd: packageDir, shell: true});
+    }
     nodeProcess.on('close', nodeProcessCloseCallback);
     nodeProcess.on('error', nodeProcessErrorCallback);
   });