Merge master

Author: hariharanbrowserstack

bin/commands/runs.js

@@ -18,7 +18,6 @@ const archiver = require("../helpers/archiver"),
   {initTimeComponents, instrumentEventTime, markBlockStart, markBlockEnd, getTimeComponents} = require('../helpers/timeComponents'),
   downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
   downloadBuildStacktrace = require('../helpers/downloadBuildStacktrace').downloadBuildStacktrace,
-  updateNotifier = require('update-notifier'),
   pkg = require('../../package.json'),
   packageDiff = require('../helpers/package-diff');
 const { getStackTraceUrl } = require('../helpers/sync/syncSpecsLogs');
@@ -249,6 +248,9 @@ module.exports = function run(args, rawArgs) {
                 utils.setProcessHooks(data.build_id, bsConfig, bs_local, args, buildReportData);
                 let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
                 let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${data.dashboard_url}`;
+                if (turboScaleSession) {
+                  dashboardLink = `${Constants.userMessages.VISIT_ATS_DASHBOARD} ${data.dashboard_url}`;
+                }
                 buildReportData = { 'build_id': data.build_id, 'parallels': userSpecifiedParallels, ...buildReportData }
                 utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
                 if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
@@ -311,6 +313,8 @@ module.exports = function run(args, rawArgs) {
                         logger.info(Constants.userMessages.BUILD_FAILED_ERROR)
                         process.exitCode = Constants.BUILD_FAILED_EXIT_CODE;
                       });
+                    } else {
+                      utils.handleSyncExit(exitCode, data.dashboard_url);
                     }
                   });
                 } else if (utils.nonEmptyArray(bsConfig.run_settings.downloads && !turboScaleSession)) {
@@ -452,23 +456,27 @@ module.exports = function run(args, rawArgs) {
     utils.sendUsageReport(bsJsonData, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err), null, rawArgs);
     process.exitCode = Constants.ERROR_EXIT_CODE;
   }).finally(function(){
-    const notifier = updateNotifier({
-      pkg,
-      updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
-    });
+    import('update-notifier').then(({ default: updateNotifier } ) => {
+      const notifier = updateNotifier({
+        pkg,
+        updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
+      });
 
-    // Checks for update on first run.
-    // Set lastUpdateCheck to 0 to spawn the check update process as notifier sets this to Date.now() for preventing
-    // the check untill one interval period. It runs once.
-    if (!notifier.disabled && Date.now() - notifier.config.get('lastUpdateCheck') < 50) {
-      notifier.config.set('lastUpdateCheck', 0);
-      notifier.check();
-    }
+      // Checks for update on first run.
+      // Set lastUpdateCheck to 0 to spawn the check update process as notifier sets this to Date.now() for preventing
+      // the check untill one interval period. It runs once.
+      if (!notifier.disabled && Date.now() - notifier.config.get('lastUpdateCheck') < 50) {
+        notifier.config.set('lastUpdateCheck', 0);
+        notifier.check();
+      }
 
-    // Set the config update as notifier clears this after reading.
-    if (notifier.update && notifier.update.current !== notifier.update.latest) {
-      notifier.config.set('update', notifier.update);
-      notifier.notify({isGlobal: true});
-    }
+      // Set the config update as notifier clears this after reading.
+      if (notifier.update && notifier.update.current !== notifier.update.latest) {
+        notifier.config.set('update', notifier.update);
+        notifier.notify({isGlobal: true});
+      }
+    }).catch((error) => {
+      logger.debug('Got error loading update-notifier: ', error);
+    });
   });
 }

bin/helpers/archiver.js

@@ -72,9 +72,30 @@ const archiveSpecs = (runSettings, filePath, excludeFiles, md5data) => {
       });
     }
 
+    // Split mac and win configs
+    let macPackageJSON = {};
+    let winPackageJSON = {};
+    Object.assign(macPackageJSON, packageJSON);
+    Object.assign(winPackageJSON, packageJSON);
+
+    if (typeof runSettings.npm_dependencies === 'object') {
+      let macNpmDependencies = Object.assign({}, runSettings.npm_dependencies, runSettings.mac_npm_dependencies || {});
+      let winNpmDependencies = Object.assign({}, runSettings.npm_dependencies, runSettings.win_npm_dependencies || {});
+
+      Object.assign(macPackageJSON, {
+        devDependencies: macNpmDependencies,
+      });
+
+      Object.assign(winPackageJSON, {
+        devDependencies: winNpmDependencies,
+      });
+    }
+
     if (Object.keys(packageJSON).length > 0) {
-      let packageJSONString = JSON.stringify(packageJSON, null, 4);
-      archive.append(packageJSONString, {name: `${cypressAppendFilesZipLocation}browserstack-package.json`});
+      const macPackageJSONString = JSON.stringify(macPackageJSON, null, 4);
+      const winPackageJSONString = JSON.stringify(winPackageJSON, null, 4);
+      archive.append(macPackageJSONString, {name: `${cypressAppendFilesZipLocation}browserstack-mac-package.json`});
+      archive.append(winPackageJSONString, {name: `${cypressAppendFilesZipLocation}browserstack-win-package.json`});
     }
 
     //Create copy of package.json

bin/helpers/buildArtifacts.js

@@ -12,6 +12,7 @@ const { default: axios } = require('axios');
 const HttpsProxyAgent = require('https-proxy-agent');
 const FormData = require('form-data');
 const decompress = require('decompress');
+const unzipper = require("unzipper");
 
 let BUILD_ARTIFACTS_TOTAL_COUNT = 0;
 let BUILD_ARTIFACTS_FAIL_COUNT = 0;
@@ -36,6 +37,9 @@ const parseAndDownloadArtifacts = async (buildId, data, bsConfig, args, rawArgs,
             utils.sendUsageReport(bsConfig, args, warningMessage, Constants.messageTypes.ERROR, 'build_artifacts_not_found', buildReportData, rawArgs);
           } else {
             BUILD_ARTIFACTS_FAIL_COUNT += 1;
+            const errorMsg = `Error downloading build artifacts for ${sessionId} with error: ${error}`;
+            logger.debug(errorMsg);
+            utils.sendUsageReport(bsConfig, args, errorMsg, Constants.messageTypes.ERROR, 'build_artifacts_parse_error', buildReportData, rawArgs);
           }
           // delete malformed zip if present
           let tmpFilePath = path.join(filePath, fileName);
@@ -103,14 +107,16 @@ const downloadAndUnzip = async (filePath, fileName, url) => {
   let tmpFilePath = path.join(filePath, fileName);
   const writer = fs.createWriteStream(tmpFilePath);
 
+  logger.debug(`Downloading build artifact for: ${filePath}`)
   return new Promise(async (resolve, reject) => {
     try {
       const response = await axios.get(url, {responseType: 'stream'});
       if(response.status != 200) {
         if (response.statusCode === 404) {
           reject(Constants.userMessages.DOWNLOAD_BUILD_ARTIFACTS_NOT_FOUND);
         }
-        reject()
+        const errorMsg = `Non 200 status code, got status code: ${response.statusCode}`;
+        reject(errorMsg);
       } else {
         //ensure that the user can call `then()` only when the file has
         //been downloaded entirely.
@@ -122,13 +128,15 @@ const downloadAndUnzip = async (filePath, fileName, url) => {
           reject(err);
         });
         writer.on('close', async () => {
-          if (!error) {
-            await unzipFile(filePath, fileName);
-            fs.unlinkSync(tmpFilePath);
-            resolve(true);
+          try {
+            if (!error) {
+              await unzipFile(filePath, fileName);
+              fs.unlinkSync(tmpFilePath);
+            }
+          } catch (error) {
+            reject(error);
           }
-          //no need to call the reject here, as it will have been called in the
-          //'error' stream;
+          resolve(true);
         });
       }
     } catch (error) {
@@ -139,13 +147,25 @@ const downloadAndUnzip = async (filePath, fileName, url) => {
 
 const unzipFile = async (filePath, fileName) => {
   return new Promise( async (resolve, reject) => {
-    await decompress(path.join(filePath, fileName), filePath)
-    .then((files) => {
+    try {
+      await decompress(path.join(filePath, fileName), filePath);
       resolve();
-    })
-    .catch((error) => {
-      reject(error);
-    });
+    } catch (error) {
+      logger.debug(`Error unzipping with decompress, trying with unzipper. Stacktrace: ${error}.`);
+      try {
+        fs.createReadStream(path.join(filePath, fileName))
+          .pipe(unzipper.Extract({ path: filePath }))
+          .on("close", () => {
+            resolve();
+          })
+          .on("error", (err) => {
+            reject(err);
+          });
+      } catch (unzipperError) {
+        logger.debug(`Unzipper package error: ${unzipperError}`);
+        reject(Constants.userMessages.BUILD_ARTIFACTS_UNZIP_FAILURE);
+      }
+    }
   });
 }
 

bin/helpers/checkUploaded.js

@@ -1,5 +1,6 @@
 'use strict';
 const { default: axios } = require('axios');
+const { combineMacWinNpmDependencies } = require('./helper');
 
 const crypto = require('crypto'),
   Constants = require('./constants'),
@@ -59,7 +60,7 @@ const checkPackageMd5 = (runSettings) => {
 
   if (typeof runSettings.npm_dependencies === 'object') {
     Object.assign(packageJSON, {
-      devDependencies: utils.sortJsonKeys(runSettings.npm_dependencies),
+      devDependencies: utils.sortJsonKeys(combineMacWinNpmDependencies(runSettings)),
     });
   }
 

bin/helpers/constants.js

@@ -57,6 +57,7 @@ const userMessages = {
   FAILED_MD5_CHECK:
     "Something went wrong - you can retry running browserstack-cypress with ‘--force-upload’ parameter, or contact BrowserStack Support.",
   VISIT_DASHBOARD: "Visit the Automate dashboard for real-time test reporting:",
+  VISIT_ATS_DASHBOARD: "Visit the Automate TurboScale dashboard for real-time test reporting:",
   CONFLICTING_INIT_ARGUMENTS:
     "Conflicting arguments given. You can use --path only with a file name, and not with a file path.",
   NO_PARALLELS:
@@ -123,7 +124,8 @@ const userMessages = {
   CYPRESS_PORT_WARNING:
     "The requested port number <x> is ignored. The default BrowserStack port will be used for this execution",
   CYPRESS_INTERACTIVE_SESSION_CONFLICT_VALUES:
-    "Conflicting values (True & False) were found for the interactive_debugging capability. Please resolve this issue to proceed further."
+    "Conflicting values (True & False) were found for the interactive_debugging capability. Please resolve this issue to proceed further.",
+  BUILD_ARTIFACTS_UNZIP_FAILURE: "Failed to unzip build artifacts.",
 };
 
 const validationMessages = {
@@ -342,7 +344,11 @@ const filesToIgnoreWhileUploading = [
   "package.json",
   "**/package.json",
   "browserstack-package.json",
+  "browserstack-mac-package.json",
+  "browserstack-win-package.json",
   "**/browserstack-package.json",
+  "**/browserstack-mac-package.json",
+  "**/browserstack-win-package.json",
   "tests.zip",
   "**/tests.zip",
   "cypress.json",

bin/helpers/helper.js

@@ -440,3 +440,7 @@ exports.truncateString = (field, truncateSizeInBytes) => {
 
   return field;
 };
+
+exports.combineMacWinNpmDependencies = (runSettings) => {
+  return Object.assign({}, runSettings.npm_dependencies, runSettings.win_npm_dependencies || {}, runSettings.mac_npm_dependencies || {})
+};

bin/helpers/packageInstaller.js

@@ -9,8 +9,11 @@
   { get_version } = require('./usageReporting'),
   process = require('process'),
   { spawn } = require('child_process'),
+  cliUtils = require("./utils"),
   util = require('util');
 
+const { combineMacWinNpmDependencies } = require("./helper");
+
 let nodeProcess;
 
 const setupPackageFolder = (runSettings, directoryPath) => {
@@ -28,9 +31,10 @@ const setupPackageFolder = (runSettings, directoryPath) => {
           Object.assign(packageJSON, runSettings.package_config_options);
         }
 
+        // Combine win and mac specific dependencies if present
         if (typeof runSettings.npm_dependencies === 'object') {
           Object.assign(packageJSON, {
-            devDependencies: runSettings.npm_dependencies,
+            devDependencies: combineMacWinNpmDependencies(runSettings),
           });
         }
 
@@ -58,7 +62,7 @@ const setupPackageFolder = (runSettings, directoryPath) => {
   })
 };
 
-const packageInstall = (packageDir) => {
+const packageInstall = (packageDir, bsConfig) => {
   return new Promise(function (resolve, reject) {
     const nodeProcessCloseCallback = (code) => {
       if(code == 0) {
@@ -74,6 +78,16 @@ const packageInstall = (packageDir) => {
       reject(`Packages were not installed successfully. Error Description ${util.format('%j', error)}`);
     };
 
+    // Moving .npmrc to tmpBstackPackages
+    try {
+      logger.debug(`Copying .npmrc file to temporary package directory`);
+      const npmrcRootPath = path.join(cliUtils.isNotUndefined(bsConfig.run_settings.home_directory) ? path.resolve(bsConfig.run_settings.home_directory) : './', '.npmrc');
+      const npmrcTmpPath = path.join(path.resolve(packageDir), '.npmrc');
+      fs.copyFileSync(npmrcRootPath, npmrcTmpPath);
+    } catch (error) {
+      logger.debug(`Failed copying .npmrc to ${packageDir}: ${error}`)
+    }
+
     let nodeProcess;
     logger.debug(`Fetching npm version and its major version`);
     const npm_version = get_version('npm')
@@ -147,7 +161,7 @@ const packageSetupAndInstaller = (bsConfig, packageDir, instrumentBlocks) => {
       instrumentBlocks.markBlockEnd("packageInstaller.folderSetup");
       instrumentBlocks.markBlockStart("packageInstaller.packageInstall");
       logger.debug("Started installing dependencies specified in browserstack.json");
-      return packageInstall(packageDir);
+      return packageInstall(packageDir, bsConfig);
     }).then((_result) => {
       logger.debug("Completed installing dependencies");
       instrumentBlocks.markBlockEnd("packageInstaller.packageInstall");

bin/helpers/utils.js

@@ -220,6 +220,16 @@ exports.setDefaults = (bsConfig, args) => {
     bsConfig.run_settings.npm_dependencies = {}
   }
 
+  // setting win_npm_dependencies to {} if not present
+  if (bsConfig.run_settings && this.isUndefined(bsConfig.run_settings.win_npm_dependencies)) {
+    bsConfig.run_settings.win_npm_dependencies = {}
+  }
+
+  // setting mac_npm_dependencies to {} if not present
+  if (bsConfig.run_settings && this.isUndefined(bsConfig.run_settings.mac_npm_dependencies)) {
+    bsConfig.run_settings.mac_npm_dependencies = {}
+  }
+
   // setting connection_settings to {} if not present
   if (this.isUndefined(bsConfig.connection_settings)) {
     bsConfig.connection_settings = {};

bin/testObservability/helper/cleanupQueueSync.js

@@ -0,0 +1,13 @@
+/**
+ * Sending all the remaining queues for synchronous manner
+ */
+
+const RequestQueueHandler = require('./requestQueueHandler');
+
+const shutdown = async () => {
+  const requestHandler = new RequestQueueHandler();
+  requestHandler.queue = require(process.argv[2].trim());
+  await requestHandler.shutdown();
+}
+
+shutdown();

bin/testObservability/helper/constants.js

@@ -0,0 +1,36 @@
+const path = require('path');
+
+exports.consoleHolder = Object.assign({},console);
+exports.BATCH_SIZE = 1000;
+exports.BATCH_INTERVAL = 2000;
+exports.API_URL = 'https://collector-observability.browserstack.com';
+
+exports.IPC_EVENTS = {
+  LOG: 'testObservability:cypressLog',
+  CONFIG: 'testObservability:cypressConfig',
+  SCREENSHOT: 'testObservability:cypressScreenshot',
+  COMMAND: 'testObservability:cypressCommand',
+  CUCUMBER: 'testObservability:cypressCucumberStep',
+  PLATFORM_DETAILS: 'testObservability:cypressPlatformDetails'
+};
+
+exports.OBSERVABILITY_ENV_VARS = [
+  "BROWSERSTACK_TEST_OBSERVABILITY",
+  "BROWSERSTACK_AUTOMATION",
+  "BS_TESTOPS_BUILD_COMPLETED",
+  "BS_TESTOPS_JWT",
+  "BS_TESTOPS_BUILD_HASHED_ID",
+  "BS_TESTOPS_ALLOW_SCREENSHOTS",
+  "OBSERVABILITY_LAUNCH_SDK_VERSION",
+  "BROWSERSTACK_OBSERVABILITY_DEBUG",
+  "OBS_CRASH_REPORTING_USERNAME",
+  "OBS_CRASH_REPORTING_ACCESS_KEY",
+  "OBS_CRASH_REPORTING_BS_CONFIG_PATH",
+  "OBS_CRASH_REPORTING_CYPRESS_CONFIG_PATH"
+];
+
+exports.TEST_OBSERVABILITY_REPORTER = 'browserstack-cypress-cli/bin/testObservability/reporter';
+
+exports.TEST_OBSERVABILITY_REPORTER_LOCAL = path.join(__dirname, '..', 'reporter');
+
+exports.PENDING_QUEUES_FILE = `pending_queues_${process.pid}.json`;