Pass projectRoot and configFile to plugins file through config (#6317)

* decaffeinate: Rename index.coffee from .coffee to .js

* decaffeinate: Convert index.coffee to JS

* decaffeinate: Run post-processing cleanups on index.coffee

* refactor decaffeinated plugins/index.js

* decaffeinate: Rename 3_plugins_spec.coffee from .coffee to .js

* decaffeinate: Convert 3_plugins_spec.coffee to JS

* decaffeinate: Run post-processing cleanups on 3_plugins_spec.coffee

* fix wrongly removed return

* refactor e2e plugins spec, update snapshot

* pass env argument to plugins file

* decaffeinate: Rename index_spec.coffee from .coffee to .js

* decaffeinate: Convert index_spec.coffee to JS

* decaffeinate: Run post-processing cleanups on index_spec.coffee

* update plugins tests

* update scaffold snapshot

* add back server test script and document running individual tests

* add projectRoot and configFile directly to config

* normalize browsers in snapshot

* add types for configFile and projectRoot

* fix linting issues

* return return

* Merge

* remove file

* remove unnecessary returns

Author: chrisbreiding

cli/types/index.d.ts

@@ -52,7 +52,7 @@ declare namespace Cypress {
   type RequestBody = string | object
   type ViewportOrientation = "portrait" | "landscape"
   type PrevSubject = "optional" | "element" | "document" | "window"
-  type PluginConfig = (on: PluginEvents, config: ConfigOptions) => void | Partial<ConfigOptions> | Promise<Partial<ConfigOptions>>
+  type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | Partial<ConfigOptions> | Promise<Partial<ConfigOptions>>
 
   interface CommandOptions {
     prevSubject: boolean | PrevSubject | PrevSubject[]
@@ -2282,6 +2282,17 @@ declare namespace Cypress {
     firefoxGcInterval: Nullable<number | { runMode: Nullable<number>, openMode: Nullable<number> }>
   }
 
+  interface PluginConfigOptions extends ConfigOptions {
+    /**
+    * Absolute path to the config file (default: <projectRoot>/cypress.json) or false
+    */
+    configFile: string | false
+    /**
+    * Absolute path to the root of the project
+    */
+    projectRoot: string
+  }
+
   interface DebugOptions {
     verbose: boolean
   }

cli/types/tests/plugins-config.ts

@@ -5,8 +5,10 @@ const pluginConfig: Cypress.PluginConfig = (on, config) => {}
 
 // allows synchronous returns
 const pluginConfig2: Cypress.PluginConfig = (on, config) => {
-  config // $ExpectType ConfigOptions
+  config // $ExpectType PluginConfigOptions
   config.baseUrl // $ExpectType: string
+  config.configFile // $ExpectType: string | false
+  config.projectRoot // $ExpectType: string
 
   on('before:browser:launch', (browser, options) => {
     browser.displayName // $ExpectType string

packages/server/__snapshots__/3_plugins_spec.coffee.js

@@ -1,4 +1,4 @@
-exports['e2e plugins passes 1'] = `
+exports['e2e plugins passes with working preprocessor 1'] = `
 
 ====================================================================================================
 
@@ -58,7 +58,7 @@ exports['e2e plugins passes 1'] = `
 
 `
 
-exports['e2e plugins fails 1'] = `
+exports['e2e plugins fails with async error 1'] = `
 
 ====================================================================================================
 
@@ -175,13 +175,6 @@ exports['e2e plugins can modify config from plugins 1'] = `
     ✔  All specs passed!                        XX:XX        2        2        -        -        -  
 
 
-`
-
-exports['e2e plugins catches invalid viewportWidth returned from plugins 1'] = `
-An invalid configuration value returned from the plugins file: \`cypress/plugins/index.coffee\`
-
-Expected \`viewportWidth\` to be a number. Instead the value was: \`"foo"\`
-
 `
 
 exports['e2e plugins catches invalid browsers list returned from plugins 1'] = `
@@ -402,3 +395,10 @@ exports['e2e plugins calls after:screenshot for cy.screenshot() and failure scre
 
 
 `
+
+exports['e2e plugins catches invalid viewportWidth returned from plugins 1'] = `
+An invalid configuration value returned from the plugins file: \`cypress/plugins/index.coffee\`
+
+Expected \`viewportWidth\` to be a number. Instead the value was: \`"foo"\`
+
+`

packages/server/__snapshots__/3_plugins_spec.js

@@ -68,9 +68,16 @@ const init = (config, options) => {
       handler(ipc)
     }
 
+    _.extend(config, {
+      projectRoot: options.projectRoot,
+      configFile: options.configFile,
+    })
+
     ipc.send('load', config)
 
     ipc.on('loaded', (newCfg, registrations) => {
+      _.omit(config, 'projectRoot', 'configFile')
+
       _.each(registrations, (registration) => {
         debug('register plugins process event', registration.event, 'with id', registration.eventId)
 
@@ -105,9 +112,7 @@ const init = (config, options) => {
 
     const handleError = (err) => {
       debug('plugins process error:', err.stack)
-      if (!pluginsProcess) {
-        return // prevent repeating this in case of multiple errors
-      }
+      if (!pluginsProcess) return // prevent repeating this in case of multiple errors
 
       killPluginsProcess()
       err = errors.get('PLUGINS_ERROR', err.annotated || err.stack || err.message)
@@ -116,11 +121,9 @@ const init = (config, options) => {
       return options.onError(err)
     }
 
-    const handleWarning = function (warningErr) {
+    const handleWarning = (warningErr) => {
       debug('plugins process warning:', warningErr.stack)
-      if (!pluginsProcess) {
-        return // prevent repeating this in case of multiple warnings
-      }
+      if (!pluginsProcess) return // prevent repeating this in case of multiple warnings
 
       return options.onWarning(warningErr)
     }

packages/server/lib/plugins/index.js

@@ -159,6 +159,8 @@ class Project extends EE {
     cfg = config.whitelist(cfg)
 
     return plugins.init(cfg, {
+      projectRoot: this.projectRoot,
+      configFile: settings.pathToConfigFile(this.projectRoot, options),
       onError (err) {
         debug('got plugins error', err.stack)
 

packages/server/lib/project.js

@@ -3,6 +3,7 @@ const path = require('path')
 const e2e = require('../support/helpers/e2e')
 const Fixtures = require('../support/helpers/fixtures')
 
+const e2eProject = Fixtures.projectPath('e2e')
 const pluginExtension = Fixtures.projectPath('plugin-extension')
 const pluginConfig = Fixtures.projectPath('plugin-config')
 const pluginFilterBrowsers = Fixtures.projectPath('plugin-filter-browsers')
@@ -14,10 +15,10 @@ const pluginReturnsBadConfig = Fixtures.projectPath('plugin-returns-bad-config')
 const pluginReturnsEmptyBrowsersList = Fixtures.projectPath('plugin-returns-empty-browsers-list')
 const pluginReturnsInvalidBrowser = Fixtures.projectPath('plugin-returns-invalid-browser')
 
-describe('e2e plugins', () => {
+describe('e2e plugins', function () {
   e2e.setup()
 
-  it('passes', function () {
+  it('passes with working preprocessor', function () {
     return e2e.exec(this, {
       spec: 'app_spec.coffee',
       project: workingPreprocessor,
@@ -26,7 +27,7 @@ describe('e2e plugins', () => {
     })
   })
 
-  it('fails', function () {
+  it('fails with async error', function () {
     return e2e.exec(this, {
       spec: 'app_spec.coffee',
       project: pluginsAsyncError,
@@ -121,4 +122,44 @@ describe('e2e plugins', () => {
       expectedExitCode: 1,
     })
   })
+
+  describe('projectRoot and configFile', function () {
+    it('passes projectRoot and default configFile to plugins function', function () {
+      return e2e.exec(this, {
+        spec: 'plugins_config_extras_spec.js',
+        config: {
+          env: {
+            projectRoot: e2eProject,
+            configFile: path.join(e2eProject, 'cypress.json'),
+          },
+        },
+      })
+    })
+
+    it('passes custom configFile to plugins function', function () {
+      return e2e.exec(this, {
+        spec: 'plugins_config_extras_spec.js',
+        configFile: 'cypress-alt.json',
+        config: {
+          env: {
+            projectRoot: e2eProject,
+            configFile: path.join(e2eProject, 'cypress-alt.json'),
+          },
+        },
+      })
+    })
+
+    it('passes false configFile to plugins function', function () {
+      return e2e.exec(this, {
+        spec: 'plugins_config_extras_spec.js',
+        configFile: 'false',
+        config: {
+          env: {
+            projectRoot: e2eProject,
+            configFile: false,
+          },
+        },
+      })
+    })
+  })
 })

packages/server/test/e2e/3_plugins_spec.js

@@ -0,0 +1 @@
+{}

packages/server/test/support/fixtures/projects/e2e/cypress-alt.json

@@ -0,0 +1,13 @@
+describe('plugins config extras', () => {
+  it('has correct projectRoot', () => {
+    cy.task('get:config:value', 'projectRoot')
+    .should('not.be.undefined')
+    .and('equal', Cypress.env('projectRoot'))
+  })
+
+  it('has correct configFile', () => {
+    cy.task('get:config:value', 'configFile')
+    .should('not.be.undefined')
+    .and('equal', Cypress.env('configFile'))
+  })
+})

packages/server/test/support/fixtures/projects/e2e/cypress/integration/plugins_config_extras_spec.js

@@ -151,5 +151,9 @@ module.exports = (on, config) => {
     'get:browser:args' () {
       return browserArgs
     },
+
+    'get:config:value' (key) {
+      return config[key]
+    },
   })
 }