adding stacktrace on cli and prettifying

Author: roshan04

bin/commands/runs.js

@@ -19,6 +19,7 @@ const archiver = require("../helpers/archiver"),
   downloadBuildStacktrace = require('../helpers/downloadBuildStacktrace').downloadBuildStacktrace,
   updateNotifier = require('update-notifier'),
   pkg = require('../../package.json');
+const { getStackTraceUrl } = require('../helpers/sync/syncSpecsLogs');
 
 module.exports = function run(args, rawArgs) {
   let bsConfigPath = utils.getConfigPath(args.cf);
@@ -172,7 +173,6 @@ module.exports = function run(args, rawArgs) {
                 if (args.sync) {
                   syncRunner.pollBuildStatus(bsConfig, data, rawArgs).then(async (exitCode) => {
 
-                    console.log(`roshan1: the exit code is ${exitCode} :: ${config.buildFailedExitCode}`)
                     // stop the Local instance
                     await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs);
 
@@ -190,6 +190,11 @@ module.exports = function run(args, rawArgs) {
                         utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null, buildReportData, rawArgs);
                         utils.handleSyncExit(exitCode, data.dashboard_url);
                       });
+                    } else {
+                      let stacktraceUrl = getStackTraceUrl();
+                      await downloadBuildStacktrace(stacktraceUrl);
+                      logger.info(Constants.userMessages.BUILD_FAILED_ERROR)
+                      process.exitCode = Constants.ERROR_EXIT_CODE;
                     }
                   });
                 } else if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {

bin/helpers/constants.js

@@ -61,6 +61,7 @@ const userMessages = {
   DOWNLOAD_BUILD_ARTIFACTS_SUCCESS: "Your build artifact(s) have been successfully downloaded in '<user-path>/build_artifacts/<build-id>' directory",
   LATEST_SYNTAX_TO_ACTUAL_VERSION_MESSAGE: "Your build will run using Cypress <actualVersion> as you had specified <latestSyntaxVersion>.<frameworkUpgradeMessage> Read more about supported versions here: http://browserstack.com/docs/automate/cypress/supported-versions",
   PROCESS_KILL_MESSAGE: "Stopping the CLI and the execution of the build on BrowserStack",
+  BUILD_FAILED_ERROR: "The above stacktrace has been thrown by Cypress when we tried to run your build. If your test suite requires npm dependencies then please specify them on browserstack.json. Read more at https://www.browserstack.com/docs/automate/cypress/npm-packages. Also, we recommend you to try running the build locally using ‘cypress run’ and if it works fine then please reach out to support at https://www.browserstack.com/contact#technical-support"
 };
 
 const validationMessages = {

bin/helpers/downloadBuildStacktrace.js

@@ -1,38 +1,23 @@
 'use strict'
-
-const request = require('request');
-const { inspect } = require('util');
+const fs = require('fs'),
+  request = require('request'),
+  { inspect } = require('util'),
+  Constants = require("./constants"),
+  chalk = require('chalk');
 
 const downloadBuildStacktrace = async (url) => {
-	let tmpFilePath = path.join("a", "fileName");
-  const writer = fs.createWriteStream(tmpFilePath);
+  let writer = fs.createWriteStream('a.txt');
 	return new Promise(async (resolve, reject) => {
-    request.get(url).on('response', function(response) {
-
-      if(response.statusCode != 200) {
-        reject();
-      } else {
-        //ensure that the user can call `then()` only when the file has
-        //been downloaded entirely.
-				console.log(`roshan1: the response is ${inspect(response)}`);
-        response.pipe(writer);
-        let error = null;
-        writer.on('error', err => {
-          error = err;
-          writer.close();
-          reject(err);
-        });
-        writer.on('close', async () => {
-          if (!error) {
-            await unzipFile("a", "fileName");
-            fs.unlinkSync(tmpFilePath);
-            resolve(true);
-          }
-          //no need to call the reject here, as it will have been called in the
-          //'error' stream;
-        });
-      }
-    });
+    request.get(url).on('data', (data) => {
+      console.log(chalk.bold(data.toString()));
+    }).on('error', (err) => {
+      reject();
+    }).on('end', () => {
+      let terminalWidth = (process.stdout.columns) * 0.9;
+      let lineSeparator = "\n" + "-".repeat(terminalWidth);
+      console.log(lineSeparator)
+      resolve();
+    })
   });
 };
 

bin/helpers/sync/syncSpecsLogs.js

@@ -9,11 +9,10 @@ const request = require("request"),
   tableStream = require('table').createStream,
   chalk = require('chalk');
 
-const downloadBuildStacktrace = require('../downloadBuildStacktrace').downloadBuildStacktrace
-
 const { inspect } = require('util');
 let whileLoop = true, whileTries = config.retries, options, timeout = 3000, n = 2, tableConfig, stream, endTime, startTime = Date.now(), buildStarted = false;
 let specSummary = {
+  "buildError": null,
   "specs": [],
   "duration": null
 }
@@ -108,10 +107,8 @@ let printSpecsStatus = (bsConfig, buildDetails, rawArgs) => {
         whileProcess(callback)
       },
       function(err, result) { // when loop ends
-        console.log(`roshan1: the error is ${inspect(err)}`)
         if (err) {
           if(err.status == 204) {
-            
             reject(specSummary.exitCode);
           } else {
           utils.sendUsageReport(bsConfig, {}, `buildId: ${buildDetails.build_id}`, 'error', 'sync_cli_error', err, rawArgs);
@@ -163,15 +160,19 @@ let whileProcess = (whilstCallback) => {
   });
 }
 
+let getStackTraceUrl = () => {
+  return specSummary.buildError
+}
+
 let showSpecsStatus = (data) => {
   let specData = JSON.parse(data);
   specData.forEach(specDetails => {
-    console.log(`specDetails ${inspect(specDetails)}`);
     if (specDetails == "created") {
       return;
     } else if (specDetails["stacktrace_url"]) {
       specSummary.exitCode = config.buildFailedExitCode;
-      downloadBuildStacktrace(specDetails["stacktrace_url"]);
+      specSummary.buildError = specDetails["stacktrace_url"]
+      console.log(chalk.bold.red(specDetails["message"]));
     } else {
       if(!buildStarted) {
         buildStarted = true
@@ -226,3 +227,4 @@ let getStatus = (status) => {
 }
 
 exports.printSpecsStatus = printSpecsStatus;
+exports.getStackTraceUrl = getStackTraceUrl;