feat: experimental skip domain injection #25307

AtofStryker · 2022-12-29T15:29:46Z

Closes Investigate Salesforce API logins being broken #24290
Closes Unable to login into salesforce 23 using session id #23958
Closes After the SalesForce Login it shows the "Whoops, there is no test to run" #2367 (with experimentalModifyObstructiveThirdPartyCode option enabled)
Closes Cypress loads blank page on attempt to open test app url in Chromium-based browsers #24418

User facing changelog

Adds the experimentalSkipDomainInjection option to disable Cypress from setting document.domain on injection.

The experimentalSkipDomainInjection option is either an array of strings/globs to match against url hostnames. If there is a match, document.domain will not be injected. This means that all cross-origin navigations in the provided config, including sub domain navigations, will require a cy.origin() block for Cypress to interact with the page.

Additional details

The goal of this flag is to unblock Cypress users who are running into document.domain issues with the sites they are testing, which includes Salesforce Winter '22. This can also be a diagnostic tool in the future as well for other sites where we expect document.domain to possibly be an issue, and we can simply ask users to toggle on the flag and see if the situation improves

Currently the goal of this experimental flag is to unblock users with document.domain. We want to observe this experiment usage which should educate how it evolves over time. There are no plans to make this feature GA, and at best this may be a supported configuration option in the future that is not experimental (unless setting document.domain is fully removed, in which case we may revisit this).

cypress-documentation likely will need to add info snippets in the following areas, including information on the experimental flag (added in cypress-io/cypress-documentation#4955):

Steps to test

Since this change requires a experimental config option that the server needs to be aware of, system tests were added to fully test the expected behavior in regards to navigation

How has the user experience changed?

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?Chore: add experimentalSkipDomainInjection option cypress-documentation#4955
Have API changes been updated in the type definitions?

…t.domain overwritting

…n iframe and spec bridge iframes. Also adapt CORS policy to use same-origin if experimental flag is set

…avior

cypress-bot · 2022-12-29T15:29:48Z

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.

…umentDomain

flotwig · 2022-12-29T16:16:39Z

cli/types/cypress.d.ts

+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/domain
+     * @default false
+     */
+    experimentalUseDefaultDocumentDomain: boolean


What changes would it take to make this the default behavior for all users (taking it out of experimental)?

I think it depends where we land, whether its an "all or nothing" approach like what's implemented right now or something that is configurable per domain. As for now, the only thing we would need to do to take this out of experimental is making the policyForDomain always same-origin and reverse the conditional which is pretty straight forward. And the change would be breaking.

However I think right now it likely may not work with same origin iframes within the AUT, since we need partial document.domain injection for same-origin localhost iframes. There might need to be some caveats around this, which would probably be a good idea to document.

cypress · 2022-12-29T16:30:42Z

Test summary

26418 • 0 • 1179 • 0 • 45

Run details


Project	cypress
Status	Passed
Commit	`100a8cb`
Started	Jan 6, 2023 9:05 PM
Ended	Jan 6, 2023 9:24 PM
Duration	19:13 💡
OS	Linux Debian -
Browser	Multiple

View run in Cypress Dashboard ➡️

Flakiness

	create-from-component.cy.ts	2
1	... > runs generated spec
2	... > runs generated spec
	commands/net_stubbing.cy.ts	3
1	network stubbing > intercepting request > can delay and throttle a StaticResponse
2	network stubbing > intercepting request > can delay and throttle a StaticResponse
3	network stubbing > intercepting request > can delay and throttle a StaticResponse
This comment includes only the first 5 flaky tests. See all 45 flaky tests in the Cypress Dashboard.

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

feat: cut over experimental flag to take list of known problematic domains via string/glob pattern run ci chore: update system test and fix broken config

…no longer use google to test against injection as we do not inject document.domain on google domains

…erimentalDefaultDocumentDomain

…receive document.domain injection. Kept test same by changing URL

…faults to users to configure

AtofStryker · 2023-01-04T16:53:43Z

I would have expected a new error message or two for cross-origin errors for when this is set to remind users they excluded this domain and cy.origin() is required for this specific super domains.

Currently we are just reusing the same-origin / same-super-domain messaging in error_messages, which for the domain configured would error for an origin mismatch and not domain. But right now I think Google is the only exception to this rule, so I wonder if we can add a plug for the experiment and if the flag is turned on say something like " Since experiment is on and you have this domain configured, you'd need a cy.origin() block when performing cross origin navigations". Do you think something like that would be helpful? Right now I feel the error is a bit contextless

…pDomainInjection

…ypress-io/cypress into feat/experimentalDefaultDocumentDomain

…erimentalDefaultDocumentDomain

…add unit tests

AtofStryker · 2023-01-04T17:55:45Z

@emilyrohrbough the cross origin error looks something like this for subdomains with the option configured correctly:

AtofStryker · 2023-01-04T18:10:08Z

packages/errors/src/errors.ts

+    const code = errPartial`
+    {
+      e2e: {
+        experimentalSkipDomainInjection: ['*.salesforce.com', '*.force.com', '*.google.com', 'google.com']


should I go with something less specific here?

I've opened the #24418 issue, and I think this should be changed for the following domains also: *.my.site.com
taken from https://help.salesforce.com/s/articleView?id=sf.domain_name_enhanced.htm&type=5

@alexanderg1982 this should resolve #24418. This line here is more so to recommend users on how to configure the option if the config isn't inside the e2e object. I think it's too specific since we just want to recommend where to move the option. When we release this, you should be able to do:

experimentalSkipDomainInjection: ['power-inspiration-1088-dev-ed.scratch.my.site.com']

@AtofStryker Maybe it would be good to call out this is a recommendation?

I'm wondering if we just want to reference the enhanced domain names in the docs?

@alexanderg1982 I added the enhanced domain reference in the docs to help guide the correct domains. Thank you for sharing this!

packages/network/lib/cors.ts

emilyrohrbough · 2023-01-06T14:36:08Z

" Since experiment is on and you have this domain configured, you'd need a cy.origin() block when performing cross origin navigations". Do you think something like that would be helpful? Right now I feel the error is a bit contextless

I do think this would be helpful, especially because there are workflows working for users when on Firefox so it'd could be helpful to provide more direction.

…erimentalDefaultDocumentDomain

AtofStryker · 2023-01-06T20:42:40Z

Added some context in the cross origin error @emilyrohrbough in e27acf7 . It isn't smart enough right now to compare the url, but we could add that in the future or if we really think it would be helpful right now

* develop: (45 commits) fix: re-enable CYPRESS_INTERNAL_VITE_DEV development (#25364) fix: add skip domain injection description (#25463) fix: revert CSP header and script-src addition (#25445) chore: Update v8 snapshot cache (#25401) feat: Do not strip CSP headers from HTTPResponse (#24760) fix: keep spaces in formatted output in test runner (#24687) fix: Restrict dependency versions to known supported ranges (#25380) chore: Update v8 snapshot cache (#25370) feat: experimental skip domain injection (#25307) chore: support vite v4 for component testing (#25365) feat: Use JSX/TSX in generated spec filenames (#25318) docs(angular): Properties that are spied upon have to be defined within `componentProperties` instead of on root level. (#25359) chore: remove lint-changed from scripts/docs (#25308) chore: bump to 12.3.0 [skip ci] (#25355) fix: make NODE_ENV "production" for prod builds of launchpad (#25320) fix: .contains() should only return one element at all times (#25250) feat: add currentRetry to Cypress API (#25297) chore: release @cypress/webpack-dev-server-v3.2.2 chore: release create-cypress-tests-v2.0.1 fix: change wording for spec creation (#25271) ...

cypress-bot · 2023-01-24T20:59:30Z

Released in 12.4.0.

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

AtofStryker added 11 commits December 27, 2022 15:12

feat: set up experimentalUseDefaultDocumentDomain to disallow documen…

e7b288f

…t.domain overwritting

use default domain around experimentalUseDefaultDocumentDomain in mai…

3e16fff

…n iframe and spec bridge iframes. Also adapt CORS policy to use same-origin if experimental flag is set

run ci

3dda26b

fix: add insertion of experimental flag where is was needed/missing

805de57

chore: add system test to exercise experimental flag for expected beh…

0b35f47

…avior

fix: fix issues with template updates to conform to squirrelly v7

9ddbd99

fix: update config tests to include new experimental flag

3fe48f9

run ci

d422738

fix: trailing whitespace [run ci]

0a5750f

chore: update snapshot

41896c8

run ci

48c6b04

AtofStryker added 3 commits December 29, 2022 10:48

Merge branch 'develop' into feat/experimentalDefaultDocumentDomain

7eb2d0e

fix: update proxy unit tests to account for experimentalUseDefaultDoc…

03dd439

…umentDomain

run ci

38dd080

flotwig reviewed Dec 29, 2022

View reviewed changes

fix: Allow component tests with special characters in filepath (#25299)

fc18ac6

feat: cut over experimental flag to take list of known problematic domains via string/glob pattern run ci chore: update system test and fix broken config

AtofStryker force-pushed the feat/experimentalDefaultDocumentDomain branch from 3d391c3 to fc18ac6 Compare December 29, 2022 19:39

AtofStryker added 8 commits December 29, 2022 15:36

fix: fix server unit and integration tests. integration tests should …

6538e13

…no longer use google to test against injection as we do not inject document.domain on google domains

run ci

d07248c

Merge branch 'develop' of github.com:cypress-io/cypress into feat/exp…

ecffe4c

…erimentalDefaultDocumentDomain

run ci

3ec938f

fix: server integration tests where google documents are expected to …

55b947c

…receive document.domain injection. Kept test same by changing URL

run ci

b261683

fix: update server test with mssing unupdated assertions

483e2cd

run ci

d63e526

AtofStryker mentioned this pull request Dec 30, 2022

include strict same origin config inside useDefaultDocumentDomain flag #25317

Closed

AtofStryker added 2 commits December 30, 2022 14:29

fix: turn off experimental flag by default while recommending sane de…

04c3ba1

…faults to users to configure

run ci

2e9b369

AtofStryker added 5 commits January 4, 2023 12:01

chore: address comments in code review

dccf967

chore: rename experimentalUseDefaultDocumentDomain to experimentalSki…

86bea96

…pDomainInjection

Merge branch 'feat/experimentalDefaultDocumentDomain' of github.com:c…

b59ba86

…ypress-io/cypress into feat/experimentalDefaultDocumentDomain

Merge branch 'develop' of github.com:cypress-io/cypress into feat/exp…

0e5497a

…erimentalDefaultDocumentDomain

fix regression in shouldInjectionDocumentDomain utility function and …

861de35

…add unit tests

run ci

8a16ce6

AtofStryker requested a review from emilyrohrbough January 4, 2023 18:06

AtofStryker commented Jan 4, 2023

View reviewed changes

chore: rename documentSuperDomainIfExists to superDomain [run ci]

9b6938f

mjhenkes approved these changes Jan 5, 2023

View reviewed changes

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

packages/network/lib/cors.ts Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

packages/network/lib/cors.ts Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

packages/network/lib/cors.ts Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

packages/network/lib/cors.ts Outdated Show resolved Hide resolved

emilyrohrbough approved these changes Jan 6, 2023

View reviewed changes

emilyrohrbough changed the title ~~feat: experimental default document domain~~ feat: experimental skip domain injection Jan 6, 2023

AtofStryker added 4 commits January 6, 2023 15:08

Merge branch 'develop' of github.com:cypress-io/cypress into feat/exp…

e3c4f92

…erimentalDefaultDocumentDomain

chore: address comments from code review

e27acf7

Merge branch 'develop' of github.com:cypress-io/cypress into feat/exp…

75934e7

…erimentalDefaultDocumentDomain

chore: just pass opts through to policyForDomain

8c6813d

run ci

100a8cb

AtofStryker merged commit d470f59 into develop Jan 9, 2023

AtofStryker deleted the feat/experimentalDefaultDocumentDomain branch January 9, 2023 15:00

cypress-bot bot locked as resolved and limited conversation to collaborators Jan 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: experimental skip domain injection #25307

feat: experimental skip domain injection #25307

AtofStryker commented Dec 29, 2022 •

edited

Loading

cypress-bot bot commented Dec 29, 2022

flotwig Dec 29, 2022

AtofStryker Dec 29, 2022

cypress bot commented Dec 29, 2022 •

edited

Loading

AtofStryker commented Jan 4, 2023

AtofStryker commented Jan 4, 2023

AtofStryker Jan 4, 2023

alexanderg1982 Jan 5, 2023

AtofStryker Jan 5, 2023 •

edited

Loading

emilyrohrbough Jan 6, 2023

AtofStryker Jan 6, 2023

AtofStryker Jan 9, 2023

emilyrohrbough commented Jan 6, 2023

AtofStryker commented Jan 6, 2023

cypress-bot bot commented Jan 24, 2023

feat: experimental skip domain injection #25307

feat: experimental skip domain injection #25307

Conversation

AtofStryker commented Dec 29, 2022 • edited Loading

User facing changelog

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress-bot bot commented Dec 29, 2022

flotwig Dec 29, 2022

Choose a reason for hiding this comment

AtofStryker Dec 29, 2022

Choose a reason for hiding this comment

cypress bot commented Dec 29, 2022 • edited Loading

Test summary

Run details

Flakiness

AtofStryker commented Jan 4, 2023

AtofStryker commented Jan 4, 2023

AtofStryker Jan 4, 2023

Choose a reason for hiding this comment

alexanderg1982 Jan 5, 2023

Choose a reason for hiding this comment

AtofStryker Jan 5, 2023 • edited Loading

Choose a reason for hiding this comment

emilyrohrbough Jan 6, 2023

Choose a reason for hiding this comment

AtofStryker Jan 6, 2023

Choose a reason for hiding this comment

AtofStryker Jan 9, 2023

Choose a reason for hiding this comment

emilyrohrbough commented Jan 6, 2023

AtofStryker commented Jan 6, 2023

cypress-bot bot commented Jan 24, 2023

AtofStryker commented Dec 29, 2022 •

edited

Loading

cypress bot commented Dec 29, 2022 •

edited

Loading

AtofStryker Jan 5, 2023 •

edited

Loading