add methods to print custom error messages

Author: pranavj1001

bin/helpers/constants.js

@@ -241,6 +241,8 @@ const REDACTED_AUTH =`auth: { "username": ${REDACTED}, "access_key": ${REDACTED}
 
 const SPEC_TIMEOUT_LIMIT = 120 // IN MINS 
 
+const CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY = "custom_errors_to_print";
+
 module.exports = Object.freeze({
   syncCLI,
   userMessages,
@@ -262,5 +264,6 @@ module.exports = Object.freeze({
   AUTH_REGEX,
   REDACTED_AUTH,
   BUILD_FAILED_EXIT_CODE,
-  SPEC_TIMEOUT_LIMIT
+  SPEC_TIMEOUT_LIMIT,
+  CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY
 });

bin/helpers/sync/specsSummary.js

@@ -1,4 +1,5 @@
 const logger = require("../logger").syncCliLogger;
+const winstonlogger = require("../logger").winstonLogger;
 
 /**
  *
@@ -16,7 +17,7 @@ const logger = require("../logger").syncCliLogger;
 //   {specName: 'spec8.alias.js', status: 'Skipped', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'}
 // ]
 //
-let printSpecsRunSummary = (data, machines) => {
+let printSpecsRunSummary = (data, machines, customErrorsToPrint) => {
   return new Promise((resolve, _reject) => {
     let summary = {
       total: 0,
@@ -32,6 +33,24 @@ let printSpecsRunSummary = (data, machines) => {
     logger.info(`Total tests: ${summary.total}, passed: ${summary.passed}, failed: ${summary.failed}, skipped: ${summary.skipped}`);
     logger.info(`Done in ${data.duration/1000} seconds using ${machines} machines\n`);
 
+    if (customErrorsToPrint && customErrorsToPrint.length > 0) {
+      for (const error of customErrorsToPrint) {
+        switch(error.level) {
+          case 'info':
+            winstonlogger.info(error.message);
+            break;
+          case 'warn':
+            winstonlogger.warn(error.message);
+            break;
+          case 'error':
+            winstonlogger.error(error.message);
+            break;
+          default:
+            winstonlogger.warn(error.message);
+        }
+      }
+    }
+
     resolve(data.exitCode);
   })
 };

bin/helpers/sync/syncSpecsLogs.js

@@ -13,8 +13,10 @@ let whileLoop = true, whileTries = config.retries, options, timeout = 3000, n =
 let specSummary = {
   "buildError": null,
   "specs": [],
-  "duration": null
+  "duration": null,
+  "customErrorsToPrint": []
 }
+
 let noWrap = false;
 let terminalWidth = (process.stdout.columns) * 0.9;
 let lineSeparator = Constants.syncCLI.DEFAULT_LINE_SEP;
@@ -166,18 +168,22 @@ let getStackTraceUrl = () => {
 let showSpecsStatus = (data) => {
   let specData = JSON.parse(data);
   specData.forEach(specDetails => {
-    if (specDetails == "created") {
-      return;
-    } else if (specDetails["stacktrace_url"]) {
-      specSummary.exitCode = Constants.BUILD_FAILED_EXIT_CODE;
-      specSummary.buildError = specDetails["stacktrace_url"]
-      winstonLogger.error(chalk.red(specDetails["message"]));
+    if (specDetails.type === Constants.CYPRESS_CUSTOM_ERRORS_TO_PRINT_KEY) {
+      addCustomErrorToPrint(specDetails);
     } else {
-      if(!buildStarted) {
-        buildStarted = true
-        printInitialLog();
+      if (specDetails == "created") {
+        return;
+      } else if (specDetails["stacktrace_url"]) {
+        specSummary.exitCode = Constants.BUILD_FAILED_EXIT_CODE;
+        specSummary.buildError = specDetails["stacktrace_url"]
+        winstonLogger.error(chalk.red(specDetails["message"]));
+      } else {
+        if(!buildStarted) {
+          buildStarted = true
+          printInitialLog();
+        }
+        printSpecData(JSON.parse(specDetails));
       }
-      printSpecData(JSON.parse(specDetails));
     }
   });
 }
@@ -200,6 +206,17 @@ let writeToTable = (combination, specName, status) => {
   stream.write([combination , ":", `${specName} ${status}`]);
 }
 
+let addCustomErrorToPrint = (error_object) => {
+  if (error_object["should_be_unique"]) {
+    for (const error of specSummary.customErrorsToPrint) {
+      if (error.id === error_object.id) {
+        return;
+      }
+    }
+  }
+  specSummary.customErrorsToPrint.push(error_object);
+}
+
 let addSpecToSummary = (specName, status, combination, session_id) => {
   // Format for part 3: {specName: 'spec1.failed.js', status: 'Failed', combination: 'Win 10 / Chrome 78', sessionId: '3d3rdf3r...'},
   specSummary["specs"].push({

bin/helpers/syncRunner.js

@@ -4,11 +4,15 @@ const syncSpecsLogs = require('./sync/syncSpecsLogs'),
   specsSummary = require('./sync/specsSummary');
 
 exports.pollBuildStatus = (bsConfig, buildDetails) => {
+  let customErrorsToPrint;
   return new Promise((resolve, reject) => {
     syncSpecsLogs.printSpecsStatus(bsConfig, buildDetails).then((data) => {
+      if(data.customErrorsToPrint && data.customErrorsToPrint.length > 0) {
+        customErrorsToPrint = data.customErrorsToPrint;
+      }
       return specDetails.failedSpecsDetails(data);
     }).then((data) => {
-      return specsSummary.printSpecsRunSummary(data, buildDetails.machines);
+      return specsSummary.printSpecsRunSummary(data, buildDetails.machines, customErrorsToPrint);
     }).then((successExitCode) => {
       resolve(successExitCode); // exit code 0
     }).catch((nonZeroExitCode) => {