Add instrumentation if cypress config read fails

Author: prajwaldhawarikar-bs

bin/helpers/readCypressConfigUtil.js

@@ -5,6 +5,7 @@ const cp = require('child_process');
 
 const config = require('./config');
 const constants = require("./constants");
+const utils = require("./utils");
 const logger = require('./logger').winstonLogger;
 
 exports.detectLanguage = (cypress_config_filename) => {
@@ -78,9 +79,18 @@ exports.readCypressConfigFile = (bsConfig) => {
             return this.loadJsFile(compiled_cypress_config_filepath, bstack_node_modules_path)
         }
     } catch (error) {
-        logger.error(`Error while reading cypress config: ${error.message}`)
-
-        // TODO: Add instrumention if error occurred
+        const errorMessage = `Error while reading cypress config: ${error.message}`
+        const errorCode = 'cypress_config_file_read_failed'
+        logger.error(errorMessage)
+        utils.sendUsageReport(
+            bsConfig,
+            null,
+            errorMessage,
+            constants.messageTypes.WARNING,
+            errorCode,
+            null,
+            null
+        )
     } finally {
         const working_dir = path.dirname(cypress_config_filepath);
         cp.execSync(`rm -rf ${config.compiledConfigJsDirName}`, { cwd: working_dir })

test/unit/bin/helpers/readCypressConfigUtil.js

@@ -8,7 +8,7 @@ const logger = require("../../../../bin/helpers/logger").winstonLogger;
 
 const cp = require("child_process");
 const fs = require("fs");
-const rewire = require("rewire");
+const utils = require("../../../../bin/helpers/utils");
 const  readCypressConfigUtil = require("../../../../bin/helpers/readCypressConfigUtil");
 
 logger.transports["console.info"].silent = true;
@@ -134,5 +134,27 @@ describe("readCypressConfigUtil", () => {
 
             expect(result).to.eql({ e2e: {} });
         });
+
+        it('should handle error if any error occurred', () => {
+            const bsConfig = {
+                run_settings: {
+                    cypressConfigFilePath: 'path/to/cypress.config.js',
+                    cypress_config_filename: 'cypress.config.js'
+                }
+            };
+            sandbox.stub(readCypressConfigUtil, 'loadJsFile').throws(new Error("Some error"));
+            const sendUsageReportStub = sandbox.stub(utils, 'sendUsageReport');
+            sandbox.stub(cp, 'execSync');
+
+            const result =  readCypressConfigUtil.readCypressConfigFile(bsConfig);
+
+            expect(result).to.eql(undefined);
+            sinon.assert.calledWithExactly(sendUsageReportStub, {
+                run_settings: {
+                    cypressConfigFilePath: 'path/to/cypress.config.js',
+                    cypress_config_filename: 'cypress.config.js'
+                }
+            }, null, 'Error while reading cypress config: Some error', 'warning','cypress_config_file_read_failed', null, null)
+        });
     });
 });