Cypress: Cypress doesn't match the newest route stub when url matches previous route

[nitzansan]

Current behavior:

When having multiple routes with paths that match a request, the newest one assigned does not match and a different stub is used.
E.g - (with the following endpoint: mysite.com/entitiesCollection)

cy.route('mysite.com/entitiesCollection**', response1).as('firstCall');
// something happens here that triggers the call to the relevant url --
cy.wait('@firstCall') // Success!
cy.route('mysite.com/entitiesCollection**page[offset]=20**', response2).as('secondCall');
// something happens here that triggers the call to the relevant url --
cy.wait('@secondCall') // Fails since cypress recognizes the xhr as `firstCall`

Desired behavior:

When matching routes, newer should take precedence over older.

Steps to reproduce: (app code and test code)

See the example above

Versions

cypress 3.1.4, OSX Mojave, Chrome 71

[jennifer-shehane]

The alias does indeed match the first route found that it matches. We would have to think about changing this behavior.

For now, you should likely update your route url to something more specific for each route. Perhaps use REGEXP to match the first one with /mysite.com\/entitiesCollection$/ or something similar depending on what you are matching against, so that it does not match both routes.

[nitzansan]

There are several workarounds that I can do indeed, just that the behavior that would seem more intuitive is that the newest route matching the path would be triggered and not the oldest (aka "first").

This is more intuitive for several reasons:

1. Currently you support overriding a route with identical paths, for example:
   js cy.route('mysite.com/entitiesCollection**', response1).as('firstCall'); cy.route('mysite.com/entitiesCollection**', response2).as('secondCall'); // something happens here that triggers the call to the relevant url -- cy.wait('@secondCall') // Success!
   This kind of behavior implies precedence of newer over older
2. The locality-in-time of adding a route makes more sense to match them from newer to older. For example, if I have 100 routes and I just assigned a new route (regardless of the path), it is far more likely that I'm going to trigger the 101th route than any of the previous ones, and to go and test 100 routes prior is less efficient.
3. Similar to that, when your cypress tests are becoming bigger and more complex, you're using functions and test-units that other people wrote, which might have routes assigned inside them.

If I explicitly write a route in one of my tests that consume a shared logic, I expect my route (which is newer) to take precedence. (This is actually the case I have right now, that I now need to edit shared testing code because of the route match order).

[nitzansan]

Also related to this issue - I was looking for a way to cancel/remove a cy.route assignment and didn't find anything.

Is such a thing possible?

[jennifer-shehane]

@nitzansan Thanks for the thorough explanation for this feature. We'll have to discuss this proposal and the potential impact of these changes as a team.

I was looking for a way to cancel/remove a cy.route assignment and didn't find anything.

This is a good question. You want to remove the alias .as() assignment right? I can't think of a way to do this. 🤔

[nitzansan]

I want to remove the entire cy.route() assignment based on it's alias or exact path.
I think having the ability to do this can help mitigate the problem I've described before.

[nitzansan]

Another find regarding this issue - apparently when passing a regex to cy.route it has precedence over glob patterns and regex pattern routes indeed match in the expected behavior (newer beats older).
e.g:

cy.route('mysite.com/entitiesCollection**', response1).as('firstCall');
// something happens here that triggers the call to the relevant url --
cy.wait('@firstCall') // Success!
cy.route(new RegExp('/mysite.com/entitiesCollection.*page[offset]=20.*'), response2).as('secondCall');
// something happens here that triggers the call to the relevant url with page[offset]=20--
cy.wait('@secondCall') // Success
cy.route(new RegExp('/mysite.com/entitiesCollection.*page\[offset\]=20\&page\[limit\]=100.*'), response3).as('thirdCall');
// something happens here that triggers the call to the url + page[offset]=20&page[limit]=100 query params
cy.wait('@thirdCall') // Success

[jennifer-shehane]

Yes, it does appear that routes that match RegExp would have precedence over routes that match by string. https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cypress/server.coffee#L266

[metas-ts]

Another find regarding this issue - apparently when passing a regex to cy.route it has precedence over glob patterns and regex pattern routes indeed match in the expected behavior (newer beats older).

Thanks a lot for this hint! While actually waiting for #387 I'm going to try changing my route urls to Regex now. Hope that works.

[metas-ts]

Another find regarding this issue - apparently when passing a regex to cy.route it has precedence over glob patterns and regex pattern routes indeed match in the expected behavior (newer beats older).

Unfortunately this didn't work out either..
@jennifer-shehane is there any hint you can give, regarding in which order the routes are matched? E.g. is it worth trying to prefix them such that their creation order is related to their lexical order?

[hakuna0829]

Is there any solution to support multi cy.route for same request url?

[jennifer-shehane]

Going to merge this issue into this duplicate issue with a reproducible example. https://github.com/cypress-io/cypress/issues/4460

[front-end-developer]

Hi All,

I still see this issue in the latest version of Cypress v4.11.0,

its now Aug 2020, has this been solved?

[jennifer-shehane]

@front-end-developer Please see this issue: https://github.com/cypress-io/cypress/issues/4460