feat(intercept): support regexp matcher with middleware intercepts

[Andarist]

User facing changelog

cy.intercept accepts a RegExp matcher for url now when route matcher options are passed to it as the second argument.

Additional details

When upgrading to Cypress 7 I had to figure out how to add a delay to one of our requests. In Cypress 6 we were just adding such intercept before other intercepts but now they are matched in the reverse order.

So we had a code like this:

cy.intercept(/localization/, () => delay(500))
cy.customVisitWithSetOfCommonInterceptsInIt('')

but since this request was done immediately on startup of our application we couldn't just reorder those commands - because cy.visit only resolves after the load event.

So I've figured out that { middleware: true } can actually save me here and to my surprise this both didn't work and didn't typecheck correctly:

-cy.intercept(/localization/, () => delay(500))
+cy.intercept(/localization/, { middleware: true }, () => delay(500))

The work around this is quite simple:

-cy.intercept(/localization/, { middleware: true }, () => delay(500))
+cy.intercept('**localization**', { middleware: true }, () => delay(500))

But I think that the DX could be improved here by just allowing a regexp matcher, unless there is a strong reason why this is not supported.

How has the user experience changed?

It has been improved since now cy.intercept will accept more combination of arguments.

PR Tasks

• Have tests been added/updated?
• [na] Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?

[cypress-bot]

Thanks for taking the time to open a PR!

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.
• Become familiar with the Code Review Checklist for guidelines on coding standards and what needs to be done before a PR can be merged.

[flotwig]

But I think that the DX could be improved here by just allowing a regexp matcher, unless there is a strong reason why this is not supported.

This was definitely an oversight, not a deliberate decision. Thanks for opening a PR @Andarist! LGTM

[flotwig]

I think a docs update is not necessary here, url is already documented as String | RegExp: https://docs.cypress.io/api/commands/intercept#Arguments

[cypress-bot]

Released in 7.3.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v7.3.0, please open a new issue.