feat(driver): add filtering API for request logs

[flotwig]

• Closes Is there an equivalent of cy.server({ignore: (xhr) => bool}) to disable logging, after moving to cy.intercept? #9358

Flaky test issues:

• Closes Flaky test: fetch log shows resource type, url, method, and status code and has expected snapshots and consoleProps #23443
• Closes Flaky test: intercept log has consoleProps with intercept info #23420

User facing changelog

Exposed a new function, Cypress.RequestLogs.filter, which enables users to selectively enable or disable Command Log output for HTTP requests.

Additional details

• Initiative link with design history: https://app.clickup.com/t/18033298/PM-2815
• Performance can be significantly improved by disabling these logs in an application with lots of requests. Full benchmarks: https://docs.google.com/spreadsheets/d/1boQGWEyRjCzgILd5uxH-Y3xuIwfNd5mWfvXSD_lgbXA/edit#gid=0
• Should Cy still log all cy.intercept()s until we have a cy.intercept({ log: false })? - no - add a prop for this
• Should/how can this API allow users to extend existing rules?
• Also improves debug logs for net-stubbing

Steps to test

Follow the examples below and see what gets logged when HTTP requests are made.

How has the user experience changed?

New API is available for selectively logging HTTP requests:

// disable all XHR and fetch logs
Cypress.RequestLogs.showAllXhrFetch = false

// only log the current origin's requests if they are XHRs
Cypress.RequestLogs.showAllXhrFetch = false
Cypress.RequestLogs.filter = (req) => req.resourceType === 'xhr' && req.url.startsWith(window.location.origin)

// only log the current origin's requests
Cypress.RequestLogs.showAllXhrFetch = false
Cypress.RequestLogs.filter = (req) => req.url.startsWith(window.location.origin)

// only log cy.intercept() requests, not XHRs
Cypress.RequestLogs.showAllXhrFetch = false

// disable all request logs
Cypress.RequestLogs.showAllXhrFetch = false
Cypress.RequestLogs.showAllIntercepts = false

// throws since we're not setting a function
Cypress.RequestLogs.filter = 'foo'

PR Tasks

• Have tests been added/updated?
• Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
• Has a PR for user-facing changes been opened in cypress-documentation? docs(api): add Cypress.NetworkLogs API cypress-documentation#4884
• 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]

This is now covered by 'can ignore an intercept log' which was added above.

[cypress]

---

Test summary

21664 • 1 • 1696 • 0 • 2

---

Run details

Project	cypress
Status	Failed
Commit	a79b943
Started	Nov 30, 2022 6:56 PM
Ended	Nov 30, 2022 7:14 PM
Duration	17:43 💡
OS	Linux Debian -
Browser	Multiple

View run in Cypress Dashboard ➡️

---

Failures

	cypress/e2e/commands/waiting.cy.js		1
1	... > errors > throws when bar cannot resolve

---

Flakiness

	specs_list_latest_runs.cy.ts		1
1	App/Cloud Integration - Latest runs and Average duration > when no runs are recorded > shows placeholders for all visible specs
	cypress-origin-communicator.cy.ts		1
1	Cypress In Cypress Origin Communicator > cy.origin passivity with app interactions > passes upon test reload mid test execution

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[flotwig]

A lot of this file is the same as it was in proxy-logging.cy.ts, but GitHub's diff viewer doesn't seem to detect the rename.

[mjhenkes]

this is a much better name!

[flotwig]

We will most likely not add this API for the time being. Instead, we will solve #9358 by implementing two features:

1. Ability to match cy.intercept() by resourceType: feat: add resourceType support to cy.intercept() on req/routeMatcher #25075
2. Ability to disable logs per-intercept

Then, users can disable the default logging like so:

cy.intercept({ resourceType: /xhr|fetch/ }, { log: false })