feat: deprecate cy.route(), remove experimentalNetworkStubbing flag (#…

…9185)

Co-authored-by: Jennifer Shehane <[email protected]>

cli/schema/cypress.schema.json

@@ -234,11 +234,6 @@
       "default": false,
       "description": "Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm."
     },
-    "experimentalNetworkStubbing": {
-      "type": "boolean",
-      "default": false,
-      "description": "Enables `cy.http()`, which can be used to dynamically intercept/stub/await any HTTP request or response (XHRs, fetch, beacons, etc.)"
-    },
     "experimentalFetchPolyfill": {
       "type": "boolean",
       "default": false,

cli/types/cypress.d.ts

@@ -2576,11 +2576,6 @@ declare namespace Cypress {
      * @default false
      */
     experimentalSourceRewriting: boolean
-    /**
-     * Enables `cy.http()`, which can be used to dynamically intercept/stub/await any HTTP request or response (XHRs, fetch, beacons, etc.)
-     * @default false
-     */
-    experimentalNetworkStubbing: boolean
     /**
      * Number of times to retry a failed test.
      * If a number is set, tests will retry in both runMode and openMode.

packages/desktop-gui/cypress.json

@@ -10,7 +10,6 @@
   "nodeVersion": "system",
   "testFiles": "**/*_spec.{js,jsx}",
   "experimentalComponentTesting": true,
-  "experimentalNetworkStubbing": true,
   "componentFolder": "src",
   "reporter": "../../node_modules/cypress-multi-reporters/index.js",
   "reporterOptions": {

packages/driver/cypress.json

@@ -7,6 +7,5 @@
   "reporter": "cypress-multi-reporters",
   "reporterOptions": {
     "configFile": "../../mocha-reporter-config.json"
-  },
-  "experimentalNetworkStubbing": true
+  }
 }

packages/driver/cypress/integration/commands/net_stubbing_spec.ts

@@ -309,20 +309,6 @@ describe('network stubbing', { retries: 2 }, function () {
         })
       })
 
-      it('if experimentalNetworkStubbing is falsy', function (done) {
-        sinon.stub(Cypress, 'config').callThrough()
-        // @ts-ignore
-        .withArgs('experimentalNetworkStubbing').returns(false)
-
-        cy.on('fail', (err) => {
-          expect(err.message).to.contain('`cy.http()` requires experimental network mocking to be enabled.')
-          sinon.restore()
-          done()
-        })
-
-        cy.http('', '')
-      })
-
       it('url must be a string or regexp', function (done) {
         cy.on('fail', function (err) {
           expect(err.message).to.include('`url` must be a string or a regular expression')

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

@@ -1081,6 +1081,15 @@ describe('src/cy/commands/xhr', () => {
   })
 
   context('#server', () => {
+    it('logs deprecation warning', () => {
+      cy.stub(Cypress.utils, 'warning')
+
+      cy.server()
+      .then(function () {
+        expect(Cypress.utils.warning).to.be.calledWithMatch(/^`cy\.server\(\)` has been deprecated and will be moved to a plugin in a future release\. Consider migrating to using `cy\.http\(\)` instead\./)
+      })
+    })
+
     it('sets serverIsStubbed', () => {
       cy.server().then(() => {
         expect(cy.state('serverIsStubbed')).to.be.true
@@ -1261,6 +1270,15 @@ describe('src/cy/commands/xhr', () => {
       })
     })
 
+    it('logs deprecation warning', () => {
+      cy.stub(Cypress.utils, 'warning')
+
+      cy.route('*')
+      .then(function () {
+        expect(Cypress.utils.warning).to.be.calledWithMatch(/^`cy\.route\(\)` has been deprecated and will be moved to a plugin in a future release\. Consider migrating to using `cy\.http\(\)` instead\./)
+      })
+    })
+
     it('accepts url, response', () => {
       cy.route('/foo', {}).then(function () {
         this.expectOptionsToBe({
@@ -1642,7 +1660,7 @@ describe('src/cy/commands/xhr', () => {
 
       cy.route('GET', 'http://example.com/%E0%A4%A')
       .then(() => {
-        expect(Cypress.utils.warning).to.not.be.called
+        expect(Cypress.utils.warning).to.not.be.calledWithMatch(/percent\-encoded characters/)
       })
     })
 
@@ -1654,19 +1672,6 @@ describe('src/cy/commands/xhr', () => {
       })
     })
 
-    describe('deprecations', () => {
-      beforeEach(function () {
-        this.warn = cy.spy(window.top.console, 'warn')
-      })
-
-      it('does not log on {force404: true}', () => {
-        cy.server({ force404: true })
-        .then(function () {
-          expect(this.warn).not.to.be.called
-        })
-      })
-    })
-
     describe('request response alias', () => {
       it('matches xhrs with lowercase methods', () => {
         cy

packages/driver/src/cy/commands/navigation.js

@@ -17,7 +17,7 @@ let hasVisitedAboutBlank = null
 let currentlyVisitingAboutBlank = null
 let knownCommandCausedInstability = null
 
-const REQUEST_URL_OPTS = 'auth failOnStatusCode retryOnNetworkFailure retryOnStatusCodeFailure method body headers selfProxy'
+const REQUEST_URL_OPTS = 'auth failOnStatusCode retryOnNetworkFailure retryOnStatusCodeFailure method body headers'
 .split(' ')
 
 const VISIT_OPTS = 'url log onBeforeLoad onLoad timeout requestTimeout'
@@ -877,11 +877,6 @@ module.exports = (Commands, Cypress, cy, state, config) => {
           url = url.replace(`${existingAuth}@`, '')
         }
 
-        // hack to make cy.visits interceptable by network stubbing
-        if (Cypress.config('experimentalNetworkStubbing')) {
-          options.selfProxy = true
-        }
-
         return requestUrl(url, options)
         .then((resp = {}) => {
           let { url, originalUrl, cookies, redirects, filePath } = resp

packages/driver/src/cy/commands/waiting.js

@@ -25,8 +25,8 @@ const throwErr = (arg) => {
 
 module.exports = (Commands, Cypress, cy, state) => {
   const isDynamicAliasingPossible = () => {
-    // dynamic aliasing is possible if cy.http is enabled and a route with dynamic interception has been defined
-    return Cypress.config('experimentalNetworkStubbing') && _.find(state('routes'), (route) => {
+    // dynamic aliasing is possible if a route with dynamic interception has been defined
+    return _.find(state('routes'), (route) => {
       return _.isFunction(route.handler)
     })
   }
@@ -75,12 +75,11 @@ module.exports = (Commands, Cypress, cy, state) => {
 
       options.type = type
 
-      if (Cypress.config('experimentalNetworkStubbing')) {
-        const req = waitForRoute(alias, state, type)
+      // check cy.http routes
+      const req = waitForRoute(alias, state, type)
 
-        if (req) {
-          return req
-        }
+      if (req) {
+        return req
       }
 
       // append .type to the alias

packages/driver/src/cy/commands/xhr.js

@@ -329,6 +329,8 @@ module.exports = (Commands, Cypress, cy, state, config) => {
 
   return Commands.addAll({
     server (options) {
+      $errUtils.warnByPath('server.deprecated')
+
       let userOptions = options
 
       if (arguments.length === 0) {
@@ -351,6 +353,8 @@ module.exports = (Commands, Cypress, cy, state, config) => {
     },
 
     route (...args) {
+      $errUtils.warnByPath('route.deprecated')
+
       // TODO:
       // if we return a function which returns a promise
       // then we should be handling potential timeout issues

packages/driver/src/cy/net-stubbing/add-command.ts

@@ -271,10 +271,6 @@ export function addCommand (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy,
   }
 
   function http (matcher: RouteMatcher, handler?: RouteHandler | StringMatcher, arg2?: RouteHandler) {
-    if (!Cypress.config('experimentalNetworkStubbing')) {
-      return $errUtils.throwErrByPath('net_stubbing.http.needs_experimental')
-    }
-
     function getMatcherOptions (): RouteMatcherOptions {
       if (_.isString(matcher) && $utils.isValidHttpMethod(matcher) && isStringMatcher(handler)) {
         // method, url, handler

packages/driver/src/cypress/error_messages.js

@@ -917,12 +917,6 @@ module.exports = {
         You passed: ${format(staticResponse)}`, 8)
     },
     http: {
-      needs_experimental: stripIndent`\
-        ${cmd('http')} requires experimental network mocking to be enabled.
-
-        Set the \`experimentalNetworkStubbing\` config value to \`true\` to access this command.
-
-        Read more: https://on.cypress.io/experiments`,
       invalid_handler: ({ handler }) => {
         return stripIndent`\
           ${cmd('http')}'s \`handler\` argument must be a String, StaticResponse, or HttpController function.
@@ -1200,6 +1194,10 @@ module.exports = {
   },
 
   route: {
+    deprecated: {
+      message: `${cmd('route')} has been deprecated and will be moved to a plugin in a future release. Consider migrating to using ${cmd('http')} instead.`,
+      docsUrl: 'https://on.cypress.io/http',
+    },
     failed_prerequisites: {
       message: `${cmd('route')} cannot be invoked before starting the ${cmd('server')}`,
       docsUrl: 'https://on.cypress.io/server',
@@ -1391,6 +1389,10 @@ module.exports = {
   },
 
   server: {
+    deprecated: {
+      message: `${cmd('server')} has been deprecated and will be moved to a plugin in a future release. Consider migrating to using ${cmd('http')} instead.`,
+      docsUrl: 'https://on.cypress.io/http',
+    },
     invalid_argument: {
       message: `${cmd('server')} accepts only an object literal as its argument.`,
       docsUrl: 'https://on.cypress.io/server',

packages/net-stubbing/lib/external-types.ts

@@ -334,9 +334,6 @@ declare global {
       /**
        * Use `cy.http()` to stub and intercept HTTP requests and responses.
        *
-       * Note: this command is only available if you have set the `experimentalNetworkStubbing`
-       * configuration option to `true`.
-       *
        * @see https://on.cypress.io/http
        * @example
        *    cy.http('https://localhost:7777/users', [{id: 1, name: 'Pat'}])
@@ -355,9 +352,6 @@ declare global {
       /**
        * Use `cy.http()` to stub and intercept HTTP requests and responses.
        *
-       * Note: this command is only available if you have set the `experimentalNetworkStubbing`
-       * configuration option to `true`.
-       *
        * @see https://on.cypress.io/http
        * @example
        *    cy.http('GET', 'http://foo.com/fruits', ['apple', 'banana', 'cherry'])

packages/net-stubbing/lib/server/index.ts

@@ -8,6 +8,8 @@ export { InterceptResponse } from './intercept-response'
 
 export { NetStubbingState } from './types'
 
+export { getRouteForRequest } from './route-matching'
+
 import { state } from './state'
 
 export const netStubbingState = state