feat(intercept): support regexp matcher with middleware intercepts (#…

…16390)

Co-authored-by: Zach Bloomquist <[email protected]>

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

@@ -181,7 +181,7 @@ describe('network stubbing', { retries: { runMode: 2, openMode: 0 } }, function
         this.testRoute(options, handler, expectedEvent, expectedRoute)
       })
 
-      it('mergeRouteMatcher works when supplied', function () {
+      it('mergeRouteMatcher + string url works', function () {
         const url = '/foo*'
 
         const handler = (req) => {
@@ -221,6 +221,48 @@ describe('network stubbing', { retries: { runMode: 2, openMode: 0 } }, function
         })
         .wait('@get')
       })
+
+      // @see https://github.com/cypress-io/cypress/pull/16390
+      it('mergeRouteMatcher + regex url works', function () {
+        const url = /^\/foo.*/
+
+        const handler = (req) => {
+          // @ts-ignore
+          const routeId = _.findKey(state('routes'), { handler })
+          const route = state('routes')[routeId!]
+
+          // @ts-ignore
+          expectedEvent.routeId = routeId
+          expect(this.emit).to.be.calledWith('backend:request', 'net', 'route:added', expectedEvent)
+
+          expect(route.handler).to.deep.eq(expectedRoute.handler)
+          expect(route.options).to.deep.eq(expectedRoute.options)
+
+          req.reply('a')
+        }
+
+        const expectedRoute = {
+          options: { url, middleware: true },
+          handler,
+        }
+
+        const expectedEvent = {
+          routeMatcher: {
+            url: {
+              type: 'regex',
+              value: String(url),
+            },
+            middleware: true,
+          },
+          hasInterceptor: true,
+        }
+
+        cy.intercept(url, { middleware: true }, handler).as('get')
+        .then(() => {
+          return $.get('/foo')
+        })
+        .wait('@get')
+      })
     })
 
     // https://github.com/cypress-io/cypress/issues/8729
@@ -277,7 +319,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

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

@@ -287,7 +287,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) {

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

@@ -502,7 +502,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.
        *