feat: add option to ignore chrome preferences #29447

jennifer-shehane · 2024-04-30T19:01:13Z

Closes Add an option to ignore preferences files load on browser relaunch #29330

Additional details

Adds an IGNORE_CHROME_PREFERENCES option to ignore Chrome preferences paths.

Steps to test

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? Add note about how to set IGNORE_CHROME_PREFERENCES env var cypress-documentation#5822
Have API changes been updated in the type definitions?

cypress · 2024-04-30T19:33:53Z

2 flaky tests on run #55647 ↗︎

0	4670	951	0	2

Details:

Merge branch 'develop' into ignore-chrom-prefs
Project: cypress	Commit: `74202f0612`
Status: Passed	Duration: 16:12 💡
Started: Jun 4, 2024 2:22 PM	Ended: Jun 4, 2024 2:38 PM

cypress/e2e/commands/net_stubbing.cy.ts • 2 flaky tests • 5x-driver-webkit

View Output

Test Artifacts

... > with `resourceType` > can match a proxied image request by resourceType

    </td>
  </tr>
  <tr>
    <td colspan="2">
      <a href="https://cloud.cypress.io/projects/ypt4pf/runs/55647/overview/61f105e7-b855-4438-b395-de221e5928ef?reviewViewBy=FLAKY&utm_source=github&utm_medium=flaky&utm_campaign=view%20test">
        ... > stops waiting when an xhr request is canceled
      </a>
    </td>
    <td>
      
    </td>
  </tr></table>

Review all test suite changes for PR #29447 ↗︎

mschile · 2024-05-13T17:55:34Z

packages/server/lib/browsers/chrome.ts

@@ -501,13 +513,16 @@ export = {
      launchOptions.preferences = _mergeChromePreferences(preferences, launchOptions.preferences as ChromePreferences)
    }

+    const p = _disableRestorePagesPrompt(userDir)


Any reason this was pulled out of the promise array below?

mschile · 2024-05-13T17:56:15Z

packages/server/lib/browsers/chrome.ts

@@ -501,13 +513,16 @@ export = {
      launchOptions.preferences = _mergeChromePreferences(preferences, launchOptions.preferences as ChromePreferences)
    }

+    const p = _disableRestorePagesPrompt(userDir)


If we keep this here, we'll want a more appropriately named variable.

This was for debugging while running - I'll remove

addressed in c209969

mschile · 2024-05-13T18:05:47Z

packages/server/lib/browsers/chrome.ts

+   * this effectively prevents Cypress from writing to the Chrome preferences files.
+   * See: _writeChromePreferences
+   */
+  if (process.env.IGNORE_CHROME_PREFERENCES) {


I wonder if this should be more specific, SKIP_RETRIEVING_CHROME_PREFERENCES or SKIP_READING_CHROME_PREFERENCE_PATHS

packages/server/lib/browsers/chrome.ts

mschile · 2024-05-13T18:33:37Z

packages/server/lib/browsers/chrome.ts

+  if (process.env.IGNORE_CHROME_PREFERENCES) {
+    debug('ignoring chrome preferences...')
+
+    return Bluebird.resolve(_.mapValues(CHROME_PREFERENCE_PATHS, () => ({})))


What if only one of the CHROME_PREFERENCE_PATHS is encrypted, would we want to read from the other paths?

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.

mschile · 2024-05-13T18:36:42Z

packages/server/lib/browsers/chrome.ts

+
+    return Bluebird.resolve(_.mapValues(CHROME_PREFERENCE_PATHS, () => ({})))
+  }
+
  debug('reading chrome preferences... %o', { userDir, CHROME_PREFERENCE_PATHS })

  return Bluebird.props(_.mapValues(CHROME_PREFERENCE_PATHS, (prefPath) => {


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?

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>

cli/CHANGELOG.md

jennifer-shehane · 2024-05-21T17:10:06Z

@cacieprins to make some updates here based on our convo - to ignore writing and reading chrome prefs

cacieprins · 2024-05-22T18:36:54Z

Latest changes applied:

definitively skip writing as well as reading - before, it would only skip as secondary behavior to the flag, and only if chrome preferences were not set in cy config

na

packages/server/lib/browsers/chrome.ts

Co-authored-by: Matt Schile <mschile@cypress.io>

cypress-bot · 2024-06-04T20:12:36Z

Released in 13.11.0.

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

jennifer-shehane added 2 commits April 30, 2024 15:00

feat: add option to ignore chrome preferences

c97d2b2

build binary on this branch

e439881

jennifer-shehane mentioned this pull request Apr 30, 2024

feat: add the option to ignore chrome prefs #29332

Closed

3 tasks

jennifer-shehane requested a review from cacieprins May 3, 2024 15:51

cacieprins and others added 2 commits May 3, 2024 14:36

adds explanation comment and test

f432813

Merge branch 'develop' into ignore-chrom-prefs

435e3d6

jennifer-shehane mentioned this pull request May 6, 2024

Add note about how to set IGNORE_CHROME_PREFERENCES env var cypress-io/cypress-documentation#5822

Merged

jennifer-shehane self-assigned this May 7, 2024

mschile self-requested a review May 7, 2024 16:14

jennifer-shehane added 2 commits May 13, 2024 13:54

Merge branch 'develop' into ignore-chrom-prefs

4a48da1

update changelog from dev

0fa5258

mschile reviewed May 13, 2024

View reviewed changes

packages/server/lib/browsers/chrome.ts Outdated Show resolved Hide resolved

mschile reviewed May 13, 2024

View reviewed changes

cacieprins and others added 2 commits May 15, 2024 12:02

Update packages/server/lib/browsers/chrome.ts

04f295e

Co-authored-by: Matt Schile <mschile@cypress.io>

put disableRestorePagesPrompt back in promise list in browser open

c209969

jennifer-shehane commented May 20, 2024

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

Update cli/CHANGELOG.md

dee8827

cacieprins previously approved these changes May 20, 2024

View reviewed changes

jennifer-shehane requested a review from mschile May 20, 2024 14:37

Merge branch 'develop' into ignore-chrom-prefs

517f77d

cacieprins and others added 3 commits May 22, 2024 14:33

Merge branch 'develop' into ignore-chrom-prefs

463f648

ensure we skip writing to chrome prefs when env is set

2fa0423

changelog update

28e86d8

mschile reviewed May 22, 2024

View reviewed changes

packages/server/lib/browsers/chrome.ts Show resolved Hide resolved

mschile approved these changes May 22, 2024

View reviewed changes

Update packages/server/lib/browsers/chrome.ts

3cc3904

Co-authored-by: Matt Schile <mschile@cypress.io>

jennifer-shehane requested a review from AtofStryker May 24, 2024 18:10

AtofStryker approved these changes Jun 3, 2024

View reviewed changes

jennifer-shehane and others added 5 commits June 3, 2024 07:43

Merge branch 'develop' into ignore-chrom-prefs

f3d93dd

Merge branch 'develop' into ignore-chrom-prefs

5ea5bd7

more fully ignore chrome preferences when env var is set

7f698c7

Merge branch 'develop' into ignore-chrom-prefs

a50ebf6

Merge branch 'develop' into ignore-chrom-prefs

74202f0

jennifer-shehane merged commit e790891 into develop Jun 4, 2024
115 of 117 checks passed

jennifer-shehane deleted the ignore-chrom-prefs branch June 4, 2024 14:17

cypress-bot bot locked as resolved and limited conversation to collaborators Jun 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add option to ignore chrome preferences #29447

feat: add option to ignore chrome preferences #29447

jennifer-shehane commented Apr 30, 2024 •

edited

cypress bot commented Apr 30, 2024 •

edited

Review all test suite changes for PR #29447 ↗︎

mschile May 13, 2024

mschile May 13, 2024

cacieprins May 15, 2024

cacieprins May 15, 2024

mschile May 13, 2024 •

edited

mschile May 13, 2024

cacieprins May 15, 2024

mschile May 13, 2024

cacieprins May 15, 2024 •

edited

jennifer-shehane commented May 21, 2024

cacieprins commented May 22, 2024

cypress-bot bot commented Jun 4, 2024

feat: add option to ignore chrome preferences #29447

feat: add option to ignore chrome preferences #29447

Conversation

jennifer-shehane commented Apr 30, 2024 • edited

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Apr 30, 2024 • edited

2 flaky tests on run #55647 ↗︎

Review all test suite changes for PR #29447 ↗︎

mschile May 13, 2024

Choose a reason for hiding this comment

mschile May 13, 2024

Choose a reason for hiding this comment

cacieprins May 15, 2024

Choose a reason for hiding this comment

cacieprins May 15, 2024

Choose a reason for hiding this comment

mschile May 13, 2024 • edited

Choose a reason for hiding this comment

mschile May 13, 2024

Choose a reason for hiding this comment

cacieprins May 15, 2024

Choose a reason for hiding this comment

mschile May 13, 2024

Choose a reason for hiding this comment

cacieprins May 15, 2024 • edited

Choose a reason for hiding this comment

jennifer-shehane commented May 21, 2024

cacieprins commented May 22, 2024

cypress-bot bot commented Jun 4, 2024

jennifer-shehane commented Apr 30, 2024 •

edited

cypress bot commented Apr 30, 2024 •

edited

mschile May 13, 2024 •

edited

cacieprins May 15, 2024 •

edited