add warning if user uses experimentalRunEvents flag

cypress-io · Mar 1, 2021 · 9706649 · 9706649
1 parent d2cf68c
commit 9706649
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/packages/server/lib/config_options.ts b/packages/server/lib/config_options.ts
@@ -298,13 +298,17 @@ export const breakingOptions = [
     name: 'experimentalGetCookiesSameSite',
     errorKey: 'EXPERIMENTAL_SAMESITE_REMOVED',
     isWarning: true,
-  }, {
-    name: 'experimentalShadowDomSupport',
-    errorKey: 'EXPERIMENTAL_SHADOW_DOM_REMOVED',
-    isWarning: true,
   }, {
     name: 'experimentalNetworkStubbing',
     errorKey: 'EXPERIMENTAL_NETWORK_STUBBING_REMOVED',
     isWarning: true,
+  }, {
+    name: 'experimentalRunEvents',
+    errorKey: 'EXPERIMENTAL_RUN_EVENTS_REMOVED',
+    isWarning: true,
+  }, {
+    name: 'experimentalShadowDomSupport',
+    errorKey: 'EXPERIMENTAL_SHADOW_DOM_REMOVED',
+    isWarning: true,
   },
 ]
diff --git a/packages/server/lib/errors.js b/packages/server/lib/errors.js
@@ -918,6 +918,11 @@ const getMsgByType = function (type, arg1 = {}, arg2, arg3) {
         The \`experimentalNetworkStubbing\` configuration option was removed in Cypress version \`6.0.0\`.
         It is no longer necessary for using \`cy.intercept()\` (formerly \`cy.route2()\`).
 
+        You can safely remove this option from your config.`
+    case 'EXPERIMENTAL_RUN_EVENTS_REMOVED':
+      return stripIndent`\
+        The \`experimentalRunEvents\` configuration option was removed in Cypress version \`6.7.0\`. It is no longer necessary when listening to run events in the plugins file.
+
         You can safely remove this option from your config.`
     case 'INCOMPATIBLE_PLUGIN_RETRIES':
       return stripIndent`\

diff --git a/packages/server/test/unit/config_spec.js b/packages/server/test/unit/config_spec.js
@@ -1210,6 +1210,16 @@ describe('lib/config', () => {
       expect(warning).to.be.calledWith('EXPERIMENTAL_SHADOW_DOM_REMOVED')
     })
 
+    it('warns if experimentalRunEvents is passed', async function () {
+      const warning = sinon.spy(errors, 'warning')
+
+      await this.defaults('experimentalRunEvents', true, {
+        experimentalRunEvents: true,
+      })
+
+      expect(warning).to.be.calledWith('EXPERIMENTAL_RUN_EVENTS_REMOVED')
+    })
+
     // @see https://github.com/cypress-io/cypress/pull/9185
     it('warns if experimentalNetworkStubbing is passed', async function () {
       const warning = sinon.spy(errors, 'warning')