Support dynamically disabling request logs via `cy.intercept()`

[flotwig]

What would you like?

Add the ability to dynamically disable request logs in cy.intercept(), like so:

cy.intercept('/foo', (req) => {
  req.log = false
}

Why is this needed?

#25547 adds the ability to control log via StaticResponseWithOptions. However, this can only be done statically, not dynamically via an interceptor function.

The reasons why it was done this way are detailed in the original ClickUp initiative. TL;DR: dynamically setting log can cause a log to be hidden/shown asynchronously, which requires making some hard UI decisions about how to indicate this at each step.

Other

No response

[jennifer-shehane]

Make sure to update the docs when this issue is closed in the future. cypress-io/cypress-documentation#5106

[SebeFromGermany]

Any updates on this?

[tuliobluz]

It would be nice to have an option to log only when there is an error.

[verheyenkoen]

Other options are:

• to change the signature and move the log option to a "third" options argument (or "fourth" if method or url are passed on separately), like so:

  cy.intercept({method and/or url or RouteMatcher}, {StaticResponse or RouteHandler}, { log: false })

  Currently it is a bit of an odd-one-out option in the StaticResponse object. Not sure if other intercept options would qualify for this object.
• to add the possibility to set the RouteHandler via an option in StaticResponse, like so:

  cy.intercept({method and/or url or RouteMatcer}, { handler: (req) => { ... }, log: false })

Obviously thorough analysis is necessary to check if these signatures are not dubiously conflicting with the existing signature.

[pbassut]

Argh, also needed this to make my logs look a bit prettier.

[MagicDuck]

same here

[nerochiaro]

Other options are:

* to change the signature and move the log option to a "third" options argument (or "fourth" if method or url are passed on separately), like so:
  ```ts
  cy.intercept({method and/or url or RouteMatcher}, {StaticResponse or RouteHandler}, { log: false })
  ```
  Currently it is a bit of an odd-one-out option in the StaticResponse object. Not sure if other intercept options would qualify for this object.

* to add the possibility to set the RouteHandler via an option in StaticResponse, like so:
  ```ts
  cy.intercept({method and/or url or RouteMatcer}, { handler: (req) => { ... }, log: false })
  ```

Obviously thorough analysis is necessary to check if these signatures are not dubiously conflicting with the existing signature.

Wouldn't the last option you suggest also be compatible with the current signature ?
The code basically has to check if the 2nd argument is a plain handler, or if it's an object with a "handler" property, and decide what to do based on that.
This way there's no need to check all the codebase for conflicts, as it would be backwards-compatible.
Am I missing something @verheyenkoen ?

[Tzinov15]

Also in need of something like this, we are using a custom handler function to set aliases for our GraphQL requests and would like to also control the logging behavior at the same time

[MagicDuck]

might be a workaround for some cases. This worked for me:

        cy.intercept('/something/**', (req) => {
            // redirect to local dev server
            const url = new URL(req.url)
            url.hostname = Cypress.env('dev_host')
            url.port = Cypress.env('dev_port')
            url.pathname = url.pathname.replace('/something', '')
            req.url = url.toString()
        })
        // disable logs 
        cy.intercept('/something/**', { log: false })

[VladimirKovalenko]

In case you need to disable logs for multiple URL patterns approach below works for me.
Add this code to the global beforeEach method and it will be applied for each test:

const routesToSkipLogs = [
    'adobedc.net',
    'geolocation.com',
    'google',
    'bam.net',
];

beforeEach((): void => {
    // Set up individual intercepts to disable logging for specific URL patterns
    routesToSkipLogs.forEach((route) => {
        // Escape special regex characters and create a regex pattern
        const escapedRoute = route.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
        const urlPattern = new RegExp(escapedRoute);
        cy.intercept({ resourceType: /xhr|fetch/, url: urlPattern }, { log: false });
    });
});

[ryuuji3]

This would be a very useful feature. I don't want to see a bunch of irrelevant requests for analytics, etc.

I'd rather whitelist than blacklist, but I can't seem to get that to work. I tried using a negative request match to no avail

const apiUrl = Cypress.env('API_URL').replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&'); // Escape special characters for regex
const nonApiUrlPattern = new RegExp(`^(?!${apiUrl}).*`);

cy.intercept({ url: nonApiUrlPattern }, { log: false }).as('nonApiRequest');