feat: Set CYPRESS=true as env var in child processes where Cypress runs user code in Node (#18981)

Author: davidmunechika

packages/driver/cypress/integration/commands/task_spec.js

@@ -210,7 +210,7 @@ describe('src/cy/commands/task', () => {
           expect(lastLog.get('error')).to.eq(err)
           expect(lastLog.get('state')).to.eq('failed')
 
-          expect(err.message).to.eq(`\`cy.task('bar')\` failed with the following error:\n\nThe task 'bar' was not handled in the plugins file. The following tasks are registered: return:arg, arg:is:undefined, wait, create:long:file\n\nFix this in your plugins file here:\n${Cypress.config('pluginsFile')}`)
+          expect(err.message).to.eq(`\`cy.task('bar')\` failed with the following error:\n\nThe task 'bar' was not handled in the plugins file. The following tasks are registered: return:arg, cypress:env, arg:is:undefined, wait, create:long:file\n\nFix this in your plugins file here:\n${Cypress.config('pluginsFile')}`)
 
           done()
         })

packages/driver/cypress/integration/issues/18805_spec.js

@@ -0,0 +1,5 @@
+describe('CYPRESS env var', () => {
+  it('checks that the CYPRESS env var exists in the plugin file', () => {
+    cy.task('cypress:env').should('eq', 'true')
+  })
+})

packages/driver/cypress/plugins/index.js

@@ -38,6 +38,9 @@ module.exports = (on) => {
     'return:arg' (arg) {
       return arg
     },
+    'cypress:env' () {
+      return process.env['CYPRESS']
+    },
     'arg:is:undefined' (arg) {
       if (arg === undefined) {
         return 'arg was undefined'

packages/server/lib/environment.js

@@ -25,6 +25,8 @@ const pkg = require('@packages/root')
 // or development as default
 const env = process.env['CYPRESS_INTERNAL_ENV'] || (process.env['CYPRESS_INTERNAL_ENV'] = pkg.env != null ? pkg.env : 'development')
 
+process.env['CYPRESS'] = 'true'
+
 const config = {
   // uses cancellation for automation timeouts
   cancellation: true,

packages/server/test/unit/environment_spec.js

@@ -134,4 +134,10 @@ describe('lib/environment', () => {
       return expectedEnv('development')
     })
   })
+
+  context('it sets process.env.CYPRESS', () => {
+    it('sets CYPRESS=true when Cypress runs', () => {
+      expect(process.env['CYPRESS']).to.eq('true')
+    })
+  })
 })