handled the case of invalid json and invalid paths

Author: Roshan Nikam

bin/commands/runs.js

@@ -16,7 +16,7 @@ const archiver = require("../helpers/archiver"),
   downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
   updateNotifier = require('update-notifier'),
   pkg = require('../../package.json');
-
+  
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
   //Delete build_results.txt from log folder if already present.
@@ -284,7 +284,8 @@ module.exports = function run(args) {
   }).catch(function (err) {
     logger.error(err);
     utils.setUsageReportingFlag(null, args.disableUsageReporting);
-    utils.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err));
+    let bsJsonData = utils.readBsConfigJSON(bsConfigPath);
+    utils.sendUsageReport(bsJsonData, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err));
     process.exitCode = Constants.ERROR_EXIT_CODE;
   }).finally(function(){
     updateNotifier({

bin/helpers/constants.js

@@ -209,10 +209,14 @@ const usageReportingConstants = {
 
 const LATEST_VERSION_SYNTAX_REGEX = /\d*.latest(.\d*)?/gm
 
+const AUTH_REGEX = /"auth" *: *{[\s\S]*?}/g
+
 const ERROR_EXIT_CODE = 1;
 
 const REDACTED = "[REDACTED]";
 
+const REDACTED_AUTH =`auth: { "username": ${REDACTED}, "access_key": ${REDACTED} }`;
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -231,5 +235,6 @@ module.exports = Object.freeze({
   usageReportingConstants,
   LATEST_VERSION_SYNTAX_REGEX,
   ERROR_EXIT_CODE,
-  REDACTED
+  AUTH_REGEX,
+  REDACTED_AUTH
 });

bin/helpers/usageReporting.js

@@ -9,7 +9,7 @@ const config = require('./config'),
   fileLogger = require('./logger').fileLogger,
   utils = require('./utils');
 
-const { REDACTED } = require("./constants");
+const { AUTH_REGEX, REDACTED_AUTH } = require("./constants");
 
 function get_version(package_name) {
   try {
@@ -176,16 +176,19 @@ function send(args) {
   if (isUsageReportingEnabled() === "true") return;
 
   let bsConfig = JSON.parse(JSON.stringify(args.bstack_config));
+  let runSettings = "";
+  let sanitizedbsConfig = "";
   let cli_details = cli_version_and_path(bsConfig);
   let data = utils.isUndefined(args.data) ? {} : args.data;
 
   if (bsConfig && bsConfig.run_settings) {
-    data.cypress_version = bsConfig.run_settings.cypress_version
+    runSettings = bsConfig.run_settings;
+    data.cypress_version = bsConfig.run_settings.cypress_version;
   }
 
-  bsConfig['auth']['username'] = REDACTED
-  bsConfig['auth']['access_key'] = REDACTED
-  
+  sanitizedbsConfig = `${(typeof bsConfig === 'string') ? bsConfig : 
+  JSON.stringify(bsConfig)}`.replace(AUTH_REGEX, REDACTED_AUTH);
+
   delete args.bstack_config;
 
   const payload = {
@@ -194,8 +197,8 @@ function send(args) {
       build_id: data.build_id,
       user_id: data.user_id,
       parallels: data.parallels,
-      bstack_json: bsConfig,
-      run_settings: bsConfig.run_settings,
+      bstack_json: sanitizedbsConfig,
+      run_settings: runSettings,
       os: _os(),
       os_version: os_version(),
       bstack_json_found_in_pwd: bstack_json_found_in_pwd(),

bin/helpers/utils.js

@@ -912,6 +912,10 @@ exports.setOtherConfigs = (bsConfig, args) => {
   }
 }
 
+exports.readBsConfigJSON = (bsConfigPath) => {
+  return fs.readFileSync(bsConfigPath, 'utf-8');
+}
+
 exports.getCypressJSON = (bsConfig) => {
   let cypressJSON = undefined;
   if (bsConfig.run_settings.cypress_config_file && bsConfig.run_settings.cypress_config_filename !== 'false') {