feat(net-stubbing): experimental full network mocking support

.gitignore

@@ -32,20 +32,6 @@ packages/server/support
 packages/server/test/support/fixtures/server/imgs
 packages/server/test/support/fixtures/server/libs
 
-# CLI tool
-cli/types/blob-util
-cli/types/bluebird
-cli/types/chai
-cli/types/chai-jquery
-cli/types/jquery
-cli/types/lodash
-cli/types/mocha
-cli/types/minimatch
-cli/types/sinon
-cli/types/sinon-chai
-# ignore CLI output build folder
-cli/build
-
 # Building app binary
 scripts/support
 package-lock.json

circle.yml

@@ -549,7 +549,7 @@ jobs:
       # run unit tests from each individual package
       - run: yarn test
       - verify-mocha-results:
-          expectedResultCount: 8
+          expectedResultCount: 9
       - store_test_results:
           path: /tmp/cypress
       # CLI tests generate HTML files with sample CLI command output

cli/.gitignore

@@ -0,0 +1,14 @@
+types/blob-util
+types/bluebird
+types/chai
+types/chai-jquery
+types/jquery
+types/lodash
+types/mocha
+types/minimatch
+types/sinon
+types/sinon-chai
+# copied from net-stubbing package on build
+types/net-stubbing.ts
+# ignore CLI output build folder
+build

cli/package.json

@@ -98,7 +98,8 @@
     "bin",
     "lib",
     "index.js",
-    "types/**/*.d.ts"
+    "types/**/*.d.ts",
+    "types/net-stubbing.ts"
   ],
   "bin": {
     "cypress": "bin/cypress"

cli/schema/cypress.schema.json

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

cli/scripts/post-install.js

@@ -68,3 +68,7 @@ makeReferenceTypesCommentRelative('sinon', '../sinon/index.d.ts', sinonChaiFilen
 
 // and an import sinon line to be changed to relative path
 shell.sed('-i', 'from \'sinon\';', 'from \'../sinon\';', sinonChaiFilename)
+
+// copy experimental network stubbing type definitions
+// so users can import: `import 'cypress/types/net-stubbing'`
+shell.cp(resolvePkg('@packages/net-stubbing/lib/external-types.ts'), 'types/net-stubbing.ts')

cli/types/cypress.d.ts

@@ -26,6 +26,7 @@ declare namespace Cypress {
      * @see https://on.cypress.io/firefox-gc-issue
      */
     (task: 'firefox:force:gc'): Promise<void>
+    (task: 'net', eventName: string, frame: any): Promise<void>
   }
 
   type BrowserName = 'electron' | 'chrome' | 'chromium' | 'firefox' | 'edge' | string
@@ -2578,9 +2579,15 @@ declare namespace Cypress {
      * @default false
      */
     experimentalSourceRewriting: boolean
+    /**
+     * Enables `cy.route2`, which can be used to dynamically intercept/stub/await any HTTP request or response (XHRs, fetch, beacons, etc.)
+     * @default false
+     */
+    experimentalNetworkMocking: boolean
     /**
      * Enables shadow DOM support. Adds the `cy.shadow()` command and
      * the `includeShadowDom` option to some DOM commands.
+     * @default false
      */
     experimentalShadowDomSupport: boolean
     /**

cli/types/index.d.ts

@@ -27,6 +27,7 @@
 // hmm, how to load it better?
 /// <reference path="./cypress-npm-api.d.ts" />
 
+/// <reference path="./net-stubbing.ts" />
 /// <reference path="./cypress.d.ts" />
 /// <reference path="./cypress-global-vars.d.ts" />
 /// <reference path="./cypress-type-helpers.d.ts" />

package.json

@@ -47,7 +47,7 @@
     "stop-only": "npx stop-only --skip .cy,.publish,.projects,node_modules,dist,dist-test,fixtures,lib,bower_components,src --exclude e2e.ts,cypress-tests.ts",
     "stop-only-all": "yarn stop-only --folder packages",
     "pretest": "yarn ensure-deps",
-    "test": "yarn lerna exec yarn test --scope cypress --scope \"'@packages/{electron,extension,https-proxy,launcher,network,proxy,rewriter,reporter,runner,socket}'\"",
+    "test": "yarn lerna exec yarn test --scope cypress --scope \"'@packages/{electron,extension,https-proxy,launcher,net-stubbing,network,proxy,rewriter,reporter,runner,socket}'\"",
     "test-debug": "lerna exec yarn test-debug --ignore \"'@packages/{desktop-gui,driver,root,static,web-config}'\"",
     "pretest-e2e": "yarn ensure-deps",
     "test-e2e": "lerna exec yarn test-e2e --ignore \"'@packages/{desktop-gui,driver,root,static,web-config}'\"",

packages/driver/cypress.json

@@ -8,5 +8,6 @@
   "reporterOptions": {
     "configFile": "../../mocha-reporter-config.json"
   },
+  "experimentalNetworkMocking": true,
   "experimentalShadowDomSupport": true
 }