intercept()'s minimatch glob-matching against routeMatcher url property no longer works

[knotthere]

Current behavior

In Cypress 4.12.1, matching a route (cy.route()) with a url property that contains a string with minimatch syntax (*) works.

In Cypress 6.0.0, using cy.intercept() with a routeMatcher.url that also contains minimatch syntax fails to match.

The help at https://docs.cypress.io/api/commands/intercept.html#routeMatcher-RouteMatcher says:

All properties are optional. All properties that are set must match for the route to handle a request. If a string is passed to any property, it will be glob-matched against the request using minimatch.The available routeMatcher properties are listed below:

Desired behavior

Glob-matching should succeed with string properties passed to cy.intercept() in a routeMatcher.

Test code to reproduce

Versions

[knotthere]

I saw this, but I'm not sure if dropping minimatch support was intentional:
#9340 (comment)

[flotwig]

@knotthere url is matched as a substring or via minimatch. Can you share your test code that is not working please?

[knotthere]

@flotwig - Thank you for the followup and confirmation minimatch should still be supported. I will circle back on my code and provide a repeatable example (if this was not simply user-error on my part.)

[bahmutov]

Ok, I added example in https://github.com/bahmutov/cy-intercept-example - it can be tricky if the URL has query parameters.

// to match "https://jsonplaceholder.cypress.io/users?_limit=3"
cy.intercept('**/users?*').as('users')
cy.get('#load-users').click()
cy.wait('@users')

Had to do a few tries in the DevTools console like this until found true

Cypress.minimatch('https://jsonplaceholder.cypress.io/users?_limit=3', '**/users', {debug: true})

[Pirlouit]

Seems to be a duplicate of #9305

[CSchulz]

I am struggling with the same issue, the minimatch pattern does not work for intercept:

  Cypress.minimatch('http://localhost:4200/product/api/5/vehicles?producer=0005&type=450', '**/product/api/*/vehicles?*', {debug: true})
> true

  cy.intercept({
    method: 'GET',
    url: '**/product/api/*/vehicles?*',
  }).as('search');
> timeout while waiting

[knotthere]

@Pirlouit - Yes, I began converting my url's from minimatch format to RegEx to work around this, but it sounds like minimatch glob-matching should still work with intercept(), but it does not always.

[Pirlouit]

Hey @knotthere,
Yes, it definetely should. This is a bug from v6.0. I do not doubt it will be fixed in the next release.
My work around is for the mean time.

[jarretmoses]

I think this is related/a dupe to #9340

[jennifer-shehane]

Reproducible Example

// ✅ passes
it('cy.route() passes', () => {
  cy.server()
  cy.route('/users/search*').as('getUrl')
  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users/search?=Sarah')
    xhr.send()
  })
  cy.wait('@getUrl')
})

// ❗️ fails
it('cy.intercept() fails', () => {
  cy.intercept('/users/search*').as('getUrl')
  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users/search?=Sarah')
    xhr.send()
  })
  cy.wait('@getUrl')
})

// ✅ passes
it('cy.intercept() with pathname passes', () => {
  cy.intercept({
    method: 'GET',
    pathname: '/users/search*'
  }).as('getUrl')
  cy.visit('https://example.com')
  cy.window().then((win) => {
    const xhr = new win.XMLHttpRequest()
    xhr.open('GET', '/users/search?=Sarah')
    xhr.send()
  })
  cy.wait('@getUrl')
})

[flotwig]

The main issue here seems to be that cy.intercepts behavior differs from cy.route.

cy.route matches full URLs via minimatch, but if that fails, it will test against the pathname as well, as a convenience.

// ✅ matches http://example.com/foo/1
cy.route('http://example.com/foo/*')
// ✅ matches http://example.com/foo/1
cy.route('/foo/*')

As of 6.1.0, cy.intercept only matches full URLs via minimatch - you must explicitly match against the pathname property if you want to match on pathname.

// ❌ does not match http://example.com/foo/1
cy.intercept('/foo/*')
// ✅ matches http://example.com/foo/1
cy.intercept({ pathname: '/foo/*' })
// ✅ matches http://example.com/foo/1
cy.intercept('http://example.com/foo/*')
// ✅ matches http://example.com/foo/1
cy.intercept('**/foo/*')

Potentially, cy.intercept could be updated to match the old behavior:

// could be updated to match against pathname or full URL, like cy.route
cy.intercept('/foo/*')
// would still only match against full URL
cy.intercept({ url: 'http://example.com/foo/*' })
// would still only match against pathname
cy.intercept({ pathname: '/foo/*' })

[jennifer-shehane]

We have most of the examples in our docs passing the pathname as the main argument for matching in cy.intercept() which is another reason I think no one expected this to be the new behavior.

A lot less examples showing the 'correct' way in 6.1.0.

[jennifer-shehane]

We are planning to update cy.intercept() to match the old behavior like cy.route() matching as Zach showed above.

[cypress-bot]

The code for this is done in cypress-io/cypress#14241, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[knotthere]

Thank you for addressing this. I await a new release so I can complete my port to Cypress 6.x.

[cypress-bot]

Released in 6.2.0.

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