feat(intercept): support regexp matcher with middleware intercepts

cypress-io · May 7, 2021 · 57c6623 · 57c6623
1 parent c340bef
commit 57c6623
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 3 deletions.
diff --git a/packages/driver/cypress/integration/commands/net_stubbing_spec.ts b/packages/driver/cypress/integration/commands/net_stubbing_spec.ts
@@ -277,7 +277,7 @@ describe('network stubbing', { retries: { runMode: 2, openMode: 0 } }, function
     })
 
     context('overrides', function () {
-      it('chains middleware as expected', function () {
+      it('chains middleware with string matcher as expected', function () {
         const e: string[] = []
 
         cy
@@ -314,6 +314,43 @@ describe('network stubbing', { retries: { runMode: 2, openMode: 0 } }, function
         ])
       })
 
+      it('chains middleware with regexp matcher as expected', function () {
+        const e: string[] = []
+
+        cy
+        .intercept(/dump-headers/, { middleware: true }, (req) => {
+          e.push('mware req handler')
+          req.on('before:response', (res) => {
+            e.push('mware before:response')
+          })
+
+          req.on('response', (res) => {
+            e.push('mware response')
+          })
+
+          req.on('after:response', (res) => {
+            e.push('mware after:response')
+          })
+        })
+        .intercept('/dump-headers*', (req) => {
+          e.push('normal req handler')
+          req.reply(() => {
+            e.push('normal res handler')
+          })
+        })
+        .then(() => {
+          return $.get('/dump-headers')
+        })
+        .wrap(e).should('have.all.members', [
+          'mware req handler',
+          'normal req handler',
+          'mware before:response',
+          'normal res handler',
+          'mware response',
+          'mware after:response',
+        ])
+      })
+
       it('chains request handlers from bottom-up', function (done) {
         cy.intercept('/dump-headers*', (req) => {
           req.reply((res) => {

diff --git a/packages/driver/src/cy/net-stubbing/add-command.ts b/packages/driver/src/cy/net-stubbing/add-command.ts
@@ -283,7 +283,7 @@ export function addCommand (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy,
 
   function intercept (matcher: RouteMatcher, handler?: RouteHandler | StringMatcher | RouteMatcherOptions, arg2?: RouteHandler) {
     function getMatcherOptions (): RouteMatcherOptions {
-      if (_.isString(matcher) && hasOnlyRouteMatcherKeys(handler)) {
+      if (isStringMatcher(matcher) && hasOnlyRouteMatcherKeys(handler)) {
         // url, mergeRouteMatcher, handler
         // @ts-ignore
         if (handler.url) {

diff --git a/packages/net-stubbing/lib/external-types.ts b/packages/net-stubbing/lib/external-types.ts
@@ -498,7 +498,7 @@ declare global {
        *
        * @param mergeRouteMatcher Additional route matcher options to merge with `url`. Typically used for middleware.
        */
-      intercept(url: string, mergeRouteMatcher: Omit<RouteMatcherOptions, 'url'>, response: RouteHandler): Chainable<null>
+      intercept(url: StringMatcher, mergeRouteMatcher: Omit<RouteMatcherOptions, 'url'>, response: RouteHandler): Chainable<null>
       /**
        * Wait for a specific request to complete.
        *