Show warning when binary is run directly (outside npm module)

cli/lib/exec/spawn.js

@@ -73,6 +73,8 @@ module.exports = {
     debug('needs to start own Xvfb?', needsXvfb)
 
     // always push cwd into the args
+    // which additionally acts as a signal to the
+    // binary that it was invoked through the NPM module
     args = [].concat(args, '--cwd', process.cwd())
 
     _.defaults(options, {

package.json

@@ -27,7 +27,6 @@
     "cypress:verify": "node ./cli/bin/cypress verify --dev",
     "predecaffeinate-bulk": "shx cp .eslintrc.decaffeinate.js .eslintrc.js",
     "decaffeinate-bulk": "bulk-decaffeinate",
-    "postdecaffeinate-bulk": "shx rm .eslintrc.js",
     "dev": "node ./scripts/start.js",
     "dev-debug": "node ./scripts/debug.js dev",
     "docker": "./scripts/run-docker-local.sh",

packages/server/lib/cypress.coffee

@@ -16,6 +16,9 @@ path    = require("path")
 Promise = require("bluebird")
 debug   = require("debug")("cypress:server:cypress")
 
+warning = (code) ->
+  require("./errors").warning(code)
+
 exit = (code = 0) ->
   ## TODO: we shouldn't have to do this
   ## but cannot figure out how null is
@@ -32,7 +35,7 @@ exitErr = (err) ->
   ## and exit with 1
   debug('exiting with err', err)
 
-  require("./errors").log(err)
+  require("./errors").logException(err)
   .then -> exit(1)
 
 module.exports = {
@@ -49,6 +52,11 @@ module.exports = {
       ## like in production and we shouldn't spawn a new
       ## process
       if @isCurrentlyRunningElectron()
+        ## if we weren't invoked from the CLI
+        ## then display a warning to the user
+        if not options.invokedFromCli
+          warning("INVOKED_BINARY_OUTSIDE_NPM_MODULE")
+
         ## just run the gui code directly here
         ## and pass our options directly to main
         require("./modes")(mode, options)

packages/server/lib/errors.coffee

@@ -6,6 +6,9 @@ Promise = require("bluebird")
 
 twoOrMoreNewLinesRe = /\n{2,}/
 
+isProduction = ->
+  process.env["CYPRESS_ENV"] is "production"
+
 listItems = (paths) ->
   _
   .chain(paths)
@@ -690,6 +693,16 @@ getMsgByType = (type, arg1 = {}, arg2) ->
 
       We looked but did not find a #{chalk.blue('cypress.json')} file in this folder: #{chalk.blue(arg1)}
       """
+    when "INVOKED_BINARY_OUTSIDE_NPM_MODULE"
+      """
+      It looks like you are running the Cypress binary directly.
+
+      This is not the recommended approach, and Cypress may not work correctly.
+
+      Please install the 'cypress' NPM package and follow the instructions here:
+
+      https://on.cypress.io/installing-cypress
+      """
     when "DUPLICATE_TASK_KEY"
       """
       Warning: Multiple attempts to register the following task(s): #{chalk.blue(arg1)}. Only the last attempt will be registered.
@@ -833,6 +846,8 @@ get = (type, arg1, arg2) ->
 warning = (type, arg1, arg2) ->
   err = get(type, arg1, arg2)
   log(err, "magenta")
+
+  return null
 
 throwErr = (type, arg1, arg2) ->
   throw get(type, arg1, arg2)
@@ -860,27 +875,35 @@ clone = (err, options = {}) ->
   obj
 
 log = (err, color = "red") ->
-  Promise.try ->
-    console.log chalk[color](err.message)
-    if err.details
-      console.log("\n", chalk["yellow"](err.details))
-
-    ## bail if this error came from known
-    ## list of Cypress errors
-    return if isCypressErr(err)
-
-    console.log chalk[color](err.stack)
-
-    if process.env["CYPRESS_ENV"] is "production"
-      ## log this error to raygun since its not
-      ## a known error
-      require("./logger").createException(err).catch(->)
-
+  console.log chalk[color](err.message)
+
+  if err.details
+    console.log("\n", chalk["yellow"](err.details))
+
+  ## bail if this error came from known
+  ## list of Cypress errors
+  return if isCypressErr(err)
+
+  console.log chalk[color](err.stack)
+
+  return err
+
+logException = Promise.method (err) ->
+  ## TODO: remove context here
+  if @log(err) and isProduction()
+    ## log this exception since 
+    ## its not a known error
+    return require("./logger")
+    .createException(err)
+    .catch(->)
+
 module.exports = {
   get,
 
   log,
 
+  logException,
+
   clone,
 
   warning,

packages/server/lib/modes/record.coffee

@@ -247,7 +247,7 @@ billingLink = (orgId) ->
 gracePeriodMessage = (gracePeriodEnds) ->
   gracePeriodEnds or "the grace period ends"
 
-createRun = (options = {}) ->
+createRun = Promise.method (options = {}) ->
   _.defaults(options, {
     group: null,
     parallel: null,