allow disable of DOM snapshots for stubs and spies

[kuceb]

I use a lot of spies and stubs, and don't need a DOM snapshot every time a spied function is called, since a DOM snapshot is memory/CPU intensive

We should be able to disable the snapshot similar to how we can disable the log:

cy.stub().log(false)
cy.stub().snapshot(false)

[bahmutov]

Can we do our typical cy.command(..., {snapshot: false})?

…

Sent from my iPhone

On Mar 29, 2019, at 17:42, Ben Kucera ***@***.***> wrote: I use a lot of spies and stubs, and don't need a DOM snapshot every time a spied function is called, since a DOM snapshot is memory/CPU intensive We should be able to disable the snapshot similar to how we can disable the log: cy.stub().log(false) cy.stub().snapshot(false) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

[jennifer-shehane]

cy.stub().log(false)

Does this work?? This is not an intended use of .log() as far as I understand it. .log() is a parent command meant to be directly chained off of cy and should log what is passed in as an arg, I don't think this would affect the cy.stub() logging.

Aside from this, I would advocate for extending the options of most of our commands to allow for snapshot: false, just as they allow for log: false. See blur for example: https://on.cypress.io/blur#Arguments

Although, I think that the true win here should be fixing the snapshots to not be so memory intensive as outlined here: #2366 (comment)

[kuceb]

@jennifer-shehane .log chained off of a cypress stub/spy sets whether the stub will log or not. We do this because you cannot pass an options object to cy.stub() (theres no good way to know whats the options object and whats the stub subject)

maybe simply support a .options([..options]) method on a stub/spy instance to set the options.

here's where we create the .log function on a stub/spy https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cy/commands/agents.coffee#L187

[kuceb]

here's where I went ahead and implemented the .snapshot function: https://github.com/cypress-io/cypress/blob/test-retries/packages/driver/src/cy/commands/agents.coffee#L193

[monkeytroy]

Is there a way to do this at a page/window level? My page loads 50 .proto files and each one creates a log entry and dom snapshot that I don't need to see.

[jennifer-shehane]

You can set the numTestsKeptInMemory to the number of tests you'd like snapshots stored for (0 if you want them off altogether).

cypress.json

{
  "numTestsKeptInMemory": 0
}

[cypress-bot]

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

[cypress-bot]

Released in 5.0.0.

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