resolved comments

Author: roshan04

bin/helpers/capabilityHelper.js

@@ -241,8 +241,11 @@ const validate = (bsConfig, args) => {
       logger.warn(Constants.validationMessages.SPEC_TIMEOUT_NOT_PASSED_ERROR);
     }
 
-    if(!Utils.isUndefined(bsConfig.run_settings["record"])) {
-      if(Utils.isUndefined(bsConfig.run_settings.projectId)) {
+    if(!Utils.isUndefined(bsConfig.run_settings["record"]) && String(bsConfig.run_settings["record"]) != 'false') {
+      if(Utils.isUndefined(bsConfig.run_settings.projectId) && Utils.isUndefined(bsConfig.run_settings["record-key"])) {
+        logger.warn(Constants.validationMessages.PROJECT_ID_MISSING);
+        logger.warn(Constants.validationMessages.RECORD_KEY_MISSING);
+      } else if(Utils.isUndefined(bsConfig.run_settings.projectId)) {
         logger.warn(Constants.validationMessages.PROJECT_ID_MISSING);
       } else if (Utils.isUndefined(bsConfig.run_settings["record-key"])) {
         logger.warn(Constants.validationMessages.RECORD_KEY_MISSING);

bin/helpers/constants.js

@@ -266,6 +266,7 @@ module.exports = Object.freeze({
   ERROR_EXIT_CODE,
   AUTH_REGEX,
   REDACTED_AUTH,
+  REDACTED,
   BUILD_FAILED_EXIT_CODE,
   SPEC_TIMEOUT_LIMIT
 });

bin/helpers/usageReporting.js

@@ -9,7 +9,7 @@ const config = require('./config'),
   fileLogger = require('./logger').fileLogger,
   utils = require('./utils');
 
-const { AUTH_REGEX, REDACTED_AUTH } = require("./constants");
+const { AUTH_REGEX, REDACTED_AUTH, REDACTED } = require("./constants");
 
 function get_version(package_name) {
   try {
@@ -172,15 +172,38 @@ function isUsageReportingEnabled() {
   return process.env.DISABLE_USAGE_REPORTING;
 }
 
+function redactBsConfig(bsConfig) {
+  if(typeof bsConfig === 'object' && !utils.isUndefined(bsConfig.run_settings)) {
+    if(!utils.isUndefined(bsConfig.run_settings["projectId"])) { bsConfig.run_settings["projectId"] = REDACTED }
+    if(!utils.isUndefined(bsConfig.run_settings["record-key"])) { bsConfig.run_settings["record-key"] = REDACTED }
+  }
+}
+
+function redactArgs(args) {
+  if(typeof args === 'object' && !utils.isUndefined(args.cli_args)) {
+    if(!utils.isUndefined(args.cli_args["projectId"])) { args.cli_args["projectId"] = REDACTED }
+    if(!utils.isUndefined(args.cli_args["project-id"])) { args.cli_args["project-id"] = REDACTED }
+    if(!utils.isUndefined(args.cli_args["record-key"])) { args.cli_args["record-key"] = REDACTED }
+    if(!utils.isUndefined(args.cli_args["recordKey"])) { args.cli_args["recordKey"] = REDACTED }
+  }
+}
+
+function redactRecordCaps(bsConfig, args) {
+  redactBsConfig(bsConfig);
+  redactArgs(args);
+}
+
 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;
 
+  redactRecordCaps(bsConfig, args);
+
+  let data = utils.isUndefined(args.data) ? {} : args.data;
   if (bsConfig && bsConfig.run_settings) {
     runSettings = bsConfig.run_settings;
     data.cypress_version = bsConfig.run_settings.cypress_version;

bin/helpers/utils.js

@@ -346,6 +346,8 @@ exports.setRecordKeyFlag = (bsConfig, args) => {
 exports.setProjectId = (bsConfig, args) => {
   if(!this.isUndefined(args["projectId"])) {
     return args["projectId"];
+  } else if(!this.isUndefined(process.env.CYPRESS_PROJECT_ID)) {
+    return process.env.CYPRESS_PROJECT_ID;
   } else if(!this.isUndefined(bsConfig.run_settings["projectId"])) {
     return bsConfig.run_settings["projectId"]; 
   } else {

test/unit/bin/helpers/utils.js

@@ -3041,11 +3041,26 @@ describe('utils', () => {
       let args = {
         projectId: "def"
       }
+      process.env.CYPRESS_PROJECT_ID = "jkl"
       getCypressJSONStub.returns({ projectId: "ghi" })
       expect(utils.setProjectId(bsConfig, args)).to.eq("def")
+      delete process.env.CYPRESS_PROJECT_ID;
     });
 
-    it("prioritizes projectId passed in the bsConfig if args not passed", () => {
+    it("prioritizes env var if args not passed", () => {
+      let bsConfig = {
+        run_settings: {
+          projectId: "abc"
+        }
+      }
+      let args = {};
+      process.env.CYPRESS_PROJECT_ID = "jkl"
+      getCypressJSONStub.returns({ projectId: "ghi" })
+      expect(utils.setProjectId(bsConfig, args)).to.eq("jkl")
+      delete process.env.CYPRESS_PROJECT_ID;
+    });
+
+    it("prioritizes projectId passed in the bsConfig if args and env var not passed", () => {
       let bsConfig = {
         run_settings: {
           projectId: "abc"
@@ -3056,7 +3071,7 @@ describe('utils', () => {
       expect(utils.setProjectId(bsConfig, args)).to.eq("abc")
     });
 
-    it("prioritizes projectId passed in cypress json when no args and bsConfig is passed", () => {
+    it("prioritizes projectId passed in cypress json when no args, env var and bsConfig is passed", () => {
       let bsConfig = {
         run_settings: {}
       }