Refactor error, add test

cypress-io · Nov 18, 2021 · c2ba257 · c2ba257
1 parent 45ee157
commit c2ba257
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 6 deletions.
diff --git a/packages/frontend-shared/package.json b/packages/frontend-shared/package.json
@@ -10,7 +10,6 @@
     "windi": "yarn windicss-analysis",
     "cypress:open": "cross-env TZ=America/New_York node ../../scripts/cypress open --component --project ${PWD}",
     "cypress:run:e2e": "echo 'no e2e in frontend-shared'",
-    "cypress:open:ct": "cross-env TZ=America/New_York node ../../scripts/cypress open --component --project ${PWD}",
     "cypress:run:ct": "cross-env TZ=America/New_York node ../../scripts/cypress run --component --project ${PWD}",
     "dev": "vite --open",
     "generate-shiki-theme": "node ./script/generate-shiki-theme.js"

diff --git a/packages/server/lib/plugins/child/run_plugins.js b/packages/server/lib/plugins/child/run_plugins.js
@@ -57,6 +57,12 @@ class RunPlugins {
         return
       }
 
+      if (event === 'dev-server:start' && registeredEventsByName[event]) {
+        this.ipc.send('load:error:plugins', 'SETUP_NODE_EVENTS_DO_NOT_SUPPORT_DEV_SERVER', this.requiredFile)
+
+        return
+      }
+
       if (event === 'task') {
         const existingEventId = registeredEventsByName[event]
 

diff --git a/packages/server/lib/util/run_require_async_child.js b/packages/server/lib/util/run_require_async_child.js
@@ -47,14 +47,14 @@ function run (ipc, requiredFile, projectRoot) {
     return false
   })
 
-  const validateOrDefaultSetupNodeEvents = (setupNodeEvents) => {
+  const isValidSetupNodeEvents = (setupNodeEvents) => {
     if (setupNodeEvents && typeof setupNodeEvents !== 'function') {
       ipc.send('load:error:plugins', 'SETUP_NODE_EVENTS_IS_NOT_FUNCTION', requiredFile, setupNodeEvents)
 
-      return
+      return false
     }
 
-    return setupNodeEvents ?? ((on, config) => {})
+    return true
   }
 
   ipc.on('load', () => {
@@ -71,17 +71,25 @@ function run (ipc, requiredFile, projectRoot) {
 
         areSetupNodeEventsLoaded = true
         if (testingType === 'component') {
-          const setupNodeEvents = validateOrDefaultSetupNodeEvents(result.component?.setupNodeEvents)
+          if (!isValidSetupNodeEvents(result.component?.setupNodeEvents)) {
+            return
+          }
 
           runPlugins.runSetupNodeEvents((on, config) => {
             if (result.component?.devServer) {
               on('dev-server:start', (options) => result.component.devServer(options, result.component?.devServerConfig))
             }
 
+            const setupNodeEvents = result.component?.setupNodeEvents ?? ((on, config) => {})
+
             return setupNodeEvents(on, config)
           })
         } else if (testingType === 'e2e') {
-          const setupNodeEvents = validateOrDefaultSetupNodeEvents(result.e2e?.setupNodeEvents)
+          if (!isValidSetupNodeEvents(result.e2e?.setupNodeEvents)) {
+            return
+          }
+
+          const setupNodeEvents = result.e2e?.setupNodeEvents ?? ((on, config) => {})
 
           runPlugins.runSetupNodeEvents(setupNodeEvents)
         } else {

diff --git a/packages/server/test/unit/plugins/child/run_plugins_spec.js b/packages/server/test/unit/plugins/child/run_plugins_spec.js
@@ -41,6 +41,35 @@ describe('lib/plugins/child/run_plugins', () => {
     mockery.deregisterMock('@cypress/webpack-batteries-included-preprocessor')
   })
 
+  it('sends error message if setupNodeEvents is not a function', function () {
+    const config = { projectRoot: '/project/root' }
+
+    const setupNodeEventsFn = (on, config) => {
+      on('dev-server:start', (options) => {})
+      on('after:screenshot', () => {})
+      on('task', {})
+
+      return config
+    }
+
+    const foo = ((on, config) => {
+      on('dev-server:start', (options) => {})
+
+      return setupNodeEventsFn(on, config)
+    })
+
+    runPlugins.runSetupNodeEvents(foo)
+
+    this.ipc.on.withArgs('load:plugins').yield(config)
+
+    return Promise
+    .delay(10)
+    .then(() => {
+      expect(this.ipc.send).to.be.calledWith('loaded:plugins', config)
+      expect(this.ipc.send).to.be.calledWith('load:error:plugins', 'SETUP_NODE_EVENTS_DO_NOT_SUPPORT_DEV_SERVER', 'cypress.config.js')
+    })
+  })
+
   describe('on \'load\' message', () => {
     it('sends loaded event with registrations', function () {
       const pluginsDeferred = deferred()