Improved CLI experience

Author: karanshah-browserstack

bin/commands/runs.js

@@ -12,7 +12,9 @@ const archiver = require("../helpers/archiver"),
   checkUploaded = require("../helpers/checkUploaded"),
   reportGenerator = require('../helpers/reporterHTML').reportGenerator,
   {initTimeComponents, instrumentEventTime, markBlockStart, markBlockEnd, getTimeComponents} = require('../helpers/timeComponents'),
-  downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts;
+  downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
+  updateNotifier = require('update-notifier'),
+  pkg = require('../../package.json');
 
 module.exports = function run(args) {
   let bsConfigPath = utils.getConfigPath(args.cf);
@@ -235,5 +237,10 @@ module.exports = function run(args) {
     logger.error(err);
     utils.setUsageReportingFlag(null, args.disableUsageReporting);
     utils.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, utils.getErrorCodeFromErr(err));
+  }).finally(function(){
+    updateNotifier({
+      pkg,
+      updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
+    }).notify();
   });
 }

bin/helpers/constants.js

@@ -7,6 +7,7 @@ const syncCLI = {
   },
   INITIAL_DELAY_MULTIPLIER: 10,
   DEFAULT_LINE_SEP: "\n--------------------------------------------------------------------------------",
+  STARTUP_MESSAGE: "BrowserStack machines are now setting up Cypress with the specified npm dependencies for running your tests. It might take some time before your tests start runnning and showing up below..."
 };
 
 const userMessages = {
@@ -143,7 +144,7 @@ const messageTypes = {
   NULL: null
 }
 
-const allowedFileTypes = ['js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf', 'jpg', 'jpeg', 'png', 'zip', 'npmrc', 'xml', 'doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'jsx', 'coffee', 'cjsx', 'csv', 'tsv', 'yml', 'yaml', 'env'];
+const allowedFileTypes = ['js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf', 'jpg', 'jpeg', 'png', 'zip', 'npmrc', 'xml', 'doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'jsx', 'coffee', 'cjsx', 'csv', 'tsv', 'yml', 'yaml', 'env', 'mov', 'mp4'];
 
 const filesToIgnoreWhileUploading = [
   '**/node_modules/**',

bin/helpers/sync/syncSpecsLogs.js

@@ -3,6 +3,7 @@ const request = require("request"),
   config = require("../config"),
   utils = require("../utils"),
   logger = require("../logger").syncCliLogger,
+  winstonLogger = require("../logger").winstonLogger,
   async = require('async'),
   Constants = require("../constants"),
   tableStream = require('table').createStream,
@@ -164,6 +165,7 @@ let showSpecsStatus = (data) => {
 }
 
 let printInitialLog = () => {
+  winstonLogger.info(Constants.syncCLI.STARTUP_MESSAGE);
   logger.info(`\n${Constants.syncCLI.LOGS.INIT_LOG}`)
   logger.info(lineSeparator);
   n = Constants.syncCLI.INITIAL_DELAY_MULTIPLIER

package.json

@@ -27,7 +27,8 @@
     "winston": "^2.3.1",
     "yargs": "^14.2.3",
     "axios": "^0.21.1",
-    "unzipper": "^0.10.11"
+    "unzipper": "^0.10.11",
+    "update-notifier": "^5.1.0"
   },
   "repository": {
     "type": "git",