feat(intercept): add `{ log: false }` to `StaticResponse` #25547

flotwig · 2023-01-23T19:04:16Z

Closes Hide XHR requests from the command log #7362

Additional details

Adds the ability for users to control whether or not a request is logged by passing { log: false } in the StaticResponse field. For example:
```
 cy.intercept({ resourceType: 'xhr' }, { log: false }) // don't log XHRs
```
By default, all intercepted requests, all XHRs, and all fetches are logged. cy.intercept can selectively disable these.
Original approach: feat(driver): add filtering API for request logs #22458 (comment)
Design process: https://app.clickup.com/t/18033298/PM-2815
Separate issue for adding dynamic req.log support: Support dynamically disabling request logs via cy.intercept() #26069

Steps to test

Pass { log: false } as the 2nd argument to cy.intercept to hide logs.

How has the user experience changed?

PR Tasks

Have tests been added/updated?
Has a PR for user-facing changes been opened in cypress-documentation? docs: add { log: false } to StaticResponse cypress-documentation#5106
Have API changes been updated in the type definitions?

run ci

cypress · 2023-02-13T19:36:25Z

30 flaky tests on run #44715 ↗︎

0	26888	1281	0	30

Details:

Merge branch 'develop' into intercept-log-control
Project: cypress	Commit: `a32c1df52f`
Status: Passed	Duration: 19:18 💡
Started: Mar 13, 2023 7:19 PM	Ended: Mar 13, 2023 7:39 PM

create-from-component.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
... > runs generated spec		`Output` `Screenshots` `Video`

specs_list_latest_runs.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
App/Cloud Integration - Latest runs and Average duration > when no runs are recorded > shows placeholders for all visible specs		`Output` `Screenshots` `Video`

cypress-in-cypress-component.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress In Cypress CT > default config > redirects to the specs list with error if a spec is not found		`Output` `Screenshots` `Video`

commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		`Output`

cypress-origin-communicator.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress In Cypress Origin Communicator > cy.origin passivity with app interactions > passes upon test reload mid test execution		`Output` `Screenshots` `Video`

The first 5 flaky specs are shown, see all 18 specs in Cypress Cloud.

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

run ci

BlueWinds · 2023-02-13T21:48:15Z

packages/driver/cypress/e2e/cypress/proxy-logging.cy.ts

+            logs.push(log)
+          })
+
+          cy.intercept('**/cypress.png?*', { log: true }).as('log-me')


Could shorten this test slightly by combining the two image fetches into one .then(), and wait on both requests with the same .wait().

https://docs.cypress.io/api/commands/wait#Usage

I only recently learned you can cy.wait(['@alias1', '@alias2']) on an array of aliases, so spreading that learning around a bit. :)

Good tip, I didn't know that... somehow 🤦 I think I'll keep this as-is though, because it's simpler in my mind to first cleanly assert that dont-log-me hasn't logged and then separately assert that log-me is logged.

BlueWinds · 2023-02-13T21:55:04Z

packages/net-stubbing/lib/server/intercepted-request.ts

-        if (eventName === 'before:request') {
-          if (immediateStaticResponse) {
+        if (eventName === 'before:request' && immediateStaticResponse) {
+          // Since StaticResponse is conflated with InterceptOptions, only send an immediate response if there are keys other than `log`.


This comment solidified some of what I've felt reading the code here - static response and log are conflated in the code.

It makes sense that they overlap when .intercept() is called - it's the cost of how we've overloaded the arguments.

But I wonder if things would be cleaner if "log" were pulled out at that one point - so you'd have a static response / no static response, and then log / don't log to be passed around separately, rather than passing one object encompassing both, pulled apart into the components as-needed across multiple areas.

Thoughts?

Agreed, it's pretty messy this way. I'll update the to break out the options from the StaticResponse. How do you feel about the public API combining log with StaticResponse?

Hm. This method signature is heavily overloaded - is it possible to fold it into routeMatcher rather than staticResponse? That might make more sense at a glance, but I haven't worked through the implications; I'll believe you if you say that's complicated / we can't do it. 🤣

Minor note for when you work on docs - we have some broken links on the .intercept() page. https://docs.cypress.io/api/commands/intercept#Syntax- all the links in the Syntax section don't connect properly.

One nice thing about having it in the 2nd argument is that it maintains this sort of signature:

cy.intercept(which requests you're targeting, what you want to do to those requests)

But the 2nd argument is greatly overloaded as you say, so putting it in the first could be nice. However, when we go to add req.log and allow dynamically toggling logs in the future, the user could set it in two places:

cy.intercept({ log: false }, (req) => req.log = false)

...which starts to feel a little weird to me.

I worked on ^^ a bit and didn't feel that it was really making the code much clearer. I think this would be worth re-evaluating if we had more InterceptOptions, but with just log it's a marginal improvement for now.

mjhenkes · 2023-02-15T16:17:19Z

I had trouble parsing out what exactly was the final decision for this feature from the click up and I think i may have missed a couple of meetings. Could you elaborate further on the pr as to what the change is?

flotwig · 2023-02-15T21:34:32Z

@mjhenkes good call-out, updated. See Solution #1 on the ClickUp for how we got here: https://app.clickup.com/t/18033298/PM-2815?block=block-f14d450c-1486-4eb8-9504-2729b044b373

mjhenkes · 2023-03-01T18:02:20Z

packages/net-stubbing/lib/server/middleware/request.ts

+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const debug = null


We could removed this right?

This is here so that developers get an error if they attempt to invoke debug in this file - since this file contains only proxy middleware, any debug calls should be to this.debug so they get the advantage of the extra contextual information (method, URL, stage) about the HTTP request:

cypress/packages/proxy/lib/http/index.ts

Lines 298 to 302 in 2a67033

debug: (formatter, ...args) => {

if (!debugVerbose.enabled) return

debugVerbose(`${colorFn!(`%s %s`)} %s ${formatter}`, req.method, debugUrl, chalk.grey(ctx.stage), ...args)

},

The same pattern is followed in proxy:

cypress/packages/proxy/lib/http/request-middleware.ts

Lines 9 to 12 in 2a67033

// do not use a debug namespace in this file - use the per-request `this.debug` instead

// available as cypress-verbose:proxy:http

// eslint-disable-next-line @typescript-eslint/no-unused-vars

const debug = null

I guess you could get by with a lint rule for this, too, but I think I did this pattern in proxy before I knew about blocking variable names with eslint.

mjhenkes

Looks good. We'll need a corresponding cypress docs update too since we're adding a new option to intercept right?

flotwig · 2023-03-09T17:29:47Z

Looks good. We'll need a corresponding cypress docs update too since we're adding a new option to intercept right?

@mjhenkes Just put up the docs PR: cypress-io/cypress-documentation#5106

cli/CHANGELOG.md

flotwig added 2 commits January 23, 2023 14:00

begin setting log with the backend

6221c62

revert backend changes

0a2409a

flotwig changed the title ~~feat(intercept): add { log: false } to StaticResponse and req~~ feat(intercept): add { log: false } to StaticResponse Feb 2, 2023

flotwig added 4 commits February 13, 2023 12:18

Merge remote-tracking branch 'origin/develop' into intercept-log-control

6b04001

update interface now that we are only doing static log

89f7993

change existing logging logic to run in proxy layer instead

e834ce6

add tests, fix small bugs

a72fc7d

run ci

flotwig added 6 commits February 13, 2023 14:37

fix tests

ac738c2

add changelog

14966e4

run ci

6d8c193

Merge branch 'develop' into intercept-log-control

ff24b09

run ci

be294a6

fix cl

47c787f

run ci

flotwig force-pushed the intercept-log-control branch from 72733c8 to 47c787f Compare February 13, 2023 20:12

flotwig requested review from BlueWinds and mjhenkes February 13, 2023 21:28

flotwig marked this pull request as ready for review February 13, 2023 21:29

BlueWinds reviewed Feb 13, 2023

View reviewed changes

flotwig self-assigned this Feb 14, 2023

mjhenkes reviewed Mar 1, 2023

View reviewed changes

mjhenkes approved these changes Mar 1, 2023

View reviewed changes

Merge branch 'develop' into intercept-log-control

2a67033

flotwig requested a review from BlueWinds March 7, 2023 22:44

Merge branch 'develop' into intercept-log-control

dba68d7

This was referenced Mar 9, 2023

Support dynamically disabling request logs via cy.intercept() #26069

Open

docs: add { log: false } to StaticResponse cypress-io/cypress-documentation#5106

Merged

BlueWinds reviewed Mar 9, 2023

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

BlueWinds approved these changes Mar 9, 2023

View reviewed changes

flotwig and others added 2 commits March 10, 2023 21:02

Update cli/CHANGELOG.md

4254969

Merge branch 'develop' into intercept-log-control

a32c1df

mjhenkes assigned mjhenkes and unassigned flotwig Mar 13, 2023

mjhenkes merged commit 039ebad into develop Mar 14, 2023

mjhenkes deleted the intercept-log-control branch March 14, 2023 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(intercept): add `{ log: false }` to `StaticResponse` #25547

feat(intercept): add `{ log: false }` to `StaticResponse` #25547

flotwig commented Jan 23, 2023 •

edited

cypress bot commented Feb 13, 2023 •

edited

BlueWinds Feb 13, 2023

flotwig Mar 7, 2023

BlueWinds Feb 13, 2023 •

edited

flotwig Feb 13, 2023

BlueWinds Feb 13, 2023

BlueWinds Feb 13, 2023

flotwig Feb 14, 2023

flotwig Mar 7, 2023

mjhenkes commented Feb 15, 2023

flotwig commented Feb 15, 2023

mjhenkes Mar 1, 2023

flotwig Mar 7, 2023

mjhenkes left a comment

flotwig commented Mar 9, 2023

		// eslint-disable-next-line @typescript-eslint/no-unused-vars
		const debug = null

	debug: (formatter, ...args) => {
	if (!debugVerbose.enabled) return

	debugVerbose(`${colorFn!(`%s %s`)} %s ${formatter}`, req.method, debugUrl, chalk.grey(ctx.stage), ...args)
	},

	// do not use a debug namespace in this file - use the per-request `this.debug` instead
	// available as cypress-verbose:proxy:http
	// eslint-disable-next-line @typescript-eslint/no-unused-vars
	const debug = null

feat(intercept): add { log: false } to StaticResponse #25547

feat(intercept): add { log: false } to StaticResponse #25547

Conversation

flotwig commented Jan 23, 2023 • edited

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Feb 13, 2023 • edited

30 flaky tests on run #44715 ↗︎

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BlueWinds Feb 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjhenkes commented Feb 15, 2023

flotwig commented Feb 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjhenkes left a comment

Choose a reason for hiding this comment

flotwig commented Mar 9, 2023

feat(intercept): add `{ log: false }` to `StaticResponse` #25547

feat(intercept): add `{ log: false }` to `StaticResponse` #25547

flotwig commented Jan 23, 2023 •

edited

cypress bot commented Feb 13, 2023 •

edited

BlueWinds Feb 13, 2023 •

edited