feat: add option to ignore chrome preferences #29447
Conversation
8 flaky tests on run #55512 ↗︎
Details:
|
|||||||||||||||||||||||||||||||||||||||||||||
| Test | Artifacts | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ... > past Max-Age, before Expires -> not logged in |
| |||||||||||||||||||||||||
| Test | Artifacts | |
|---|---|---|
| network stubbing > waiting and aliasing > yields the expected interception when two requests are raced |
Test Replay
|
|
e2e/origin/commands/waiting.cy.ts • 1 flaky test • 5x-driver-chrome
| Test | Artifacts | |
|---|---|---|
| ... > throws when foo cannot resolve |
Test Replay
|
|
commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-electron
| Test | Artifacts | |
|---|---|---|
| network stubbing > waiting and aliasing > yields the expected interception when two requests are raced |
Test Replay
|
|
commands/waiting.cy.js • 1 flaky test • 5x-driver-electron
| Test | Artifacts | |
|---|---|---|
| ... > errors > throws when waiting for 2nd response to route |
Test Replay
|
|
The first 5 flaky specs are shown, see all 6 specs in Cypress Cloud.
Review all test suite changes for PR #29447 ↗︎
| @@ -501,13 +513,16 @@ export = { | |||
| launchOptions.preferences = _mergeChromePreferences(preferences, launchOptions.preferences as ChromePreferences) | |||
| } | |||
|
|
|||
| const p = _disableRestorePagesPrompt(userDir) | |||
There was a problem hiding this comment.
Any reason this was pulled out of the promise array below?
| @@ -501,13 +513,16 @@ export = { | |||
| launchOptions.preferences = _mergeChromePreferences(preferences, launchOptions.preferences as ChromePreferences) | |||
| } | |||
|
|
|||
| const p = _disableRestorePagesPrompt(userDir) | |||
There was a problem hiding this comment.
If we keep this here, we'll want a more appropriately named variable.
There was a problem hiding this comment.
This was for debugging while running - I'll remove
| * this effectively prevents Cypress from writing to the Chrome preferences files. | ||
| * See: _writeChromePreferences | ||
| */ | ||
| if (process.env.IGNORE_CHROME_PREFERENCES) { |
There was a problem hiding this comment.
I wonder if this should be more specific, SKIP_RETRIEVING_CHROME_PREFERENCES or SKIP_READING_CHROME_PREFERENCE_PATHS
| if (process.env.IGNORE_CHROME_PREFERENCES) { | ||
| debug('ignoring chrome preferences...') | ||
|
|
||
| return Bluebird.resolve(_.mapValues(CHROME_PREFERENCE_PATHS, () => ({}))) |
There was a problem hiding this comment.
What if only one of the CHROME_PREFERENCE_PATHS is encrypted, would we want to read from the other paths?
There was a problem hiding this comment.
I don't think so - this makes more sense as an all-or-nothing thing. I'm curious if we should prevent writing preferences as well with this env var, but that may cause more confusion (or should be a separate env var). As is, if you set this env, and then provide preferences via config, it will still attempt to write preferences.
|
|
||
| return Bluebird.resolve(_.mapValues(CHROME_PREFERENCE_PATHS, () => ({}))) | ||
| } | ||
|
|
||
| debug('reading chrome preferences... %o', { userDir, CHROME_PREFERENCE_PATHS }) | ||
|
|
||
| return Bluebird.props(_.mapValues(CHROME_PREFERENCE_PATHS, (prefPath) => { |
There was a problem hiding this comment.
We are already catching the ENOENT error below and returning an empty object. Is there an error thrown when reading an encrypted path? If so, can we just add it to below and remove the need of the new environment variable?
There was a problem hiding this comment.
It might be the write logic combined with the lockfile removal, on relaunch, that throws the error, not the read?
Co-authored-by: Matt Schile <mschile@cypress.io>
|
@cacieprins to make some updates here based on our convo - to ignore writing and reading chrome prefs |
Additional details
Adds an
IGNORE_CHROME_PREFERENCESoption to ignore Chrome preferences paths.Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation? Add note about how to set IGNORE_CHROME_PREFERENCES env var cypress-documentation#5822type definitions?