Chore: add experimentalSkipDomainInjection option #4955

AtofStryker · 2023-01-03T18:25:11Z

documents the disabling experimental option of document.domain

… option

vercel · 2023-01-03T18:25:14Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
cypress-documentation	✅ Ready (Inspect)	Visit Preview	Jan 9, 2023 at 4:27PM (UTC)

…into feature/experimentalUseDefaultDocumentDomain

emilyrohrbough · 2023-01-04T14:31:02Z

The base branch will need to be updated to the release version this should merge into once the code changes are close.

emilyrohrbough · 2023-01-04T14:34:16Z

content/guides/references/experiments.md

+| `experimentalStudio`                   | `false` | Generate and save commands directly to your test suite by interacting with your app as an end user would.                                                                                                                                                                                                                                                                                                                                                              |
+| `experimentalRunAllSpecs`              | `false` | Enables the "Run All Specs" UI feature, allowing the execution of multiple specs sequentially.                                                                                                                                                                                                                                                                                                                                                                         |
+| `experimentalOriginDependencies`       | `false` | Enables support for `require`/`import` within `cy.origin`.                                                                                                                                                                                                                                                                                                                                                                                                             |
+| `experimentalUseDefaultDocumentDomain` | `null`  | Disables injecting `document.domain` into `text/html` pages. The `document.domain` configuration has been known to cause issues with certain sites, including Google and Salesforce. Enabling this option no longer allows for default sub domain navigations, and will require the use of `cy.origin()`. This option takes an array of strings/minimatch globs. Our recommended configuration is `['*.salesforce.com', '*.force.com', '*.google.com', 'google.com']`. |


I would have expected more documentation for this experiment. If we know why google doesn't work and give our high-level understanding of salesforce it'll help people understand if they should enable this. I think we probably only want users to turn this on if absolutely necessary right?

Also an example of what changes might be needed where it worked without origin then needed origin might help users.

I think we probably only want users to turn this on if absolutely necessary right?

I would say so, or we leverage as a diagnostic tool.

Do we have a place where we can further document the experiment to add some more verbosity? Right now the column already looks bloated and is a bit hard to read. I'd almost like to trim this down, and have a link to more details about the experiment that users can discover. Otherwise, we'd have to mostly guide through GitHub which I am not a big fan of.

@emilyrohrbough I took a stab at this in 09e859c and removed the reference in the web security page. I figured since this is a pretty small sample size, mentioning in the experiments and cross origin testing guide at the end should suffice

emilyrohrbough · 2023-01-04T14:35:35Z

content/guides/guides/cross-origin-testing.md

@@ -17,6 +17,8 @@ a navigation occurs that does not meet the same superdomain rule, the
 [`cy.origin()`](/api/commands/origin) command must be used to execute Cypress
 commands inside the newly navigated origin.

+::include{file=partials/document-domain-workaround.md}


I think this plug should be at the end of the doc as an FAQ not the beginning since it should be an edge case. I also think additional context of why this might be useful could be helpful.

It does feel awkward. Going to see if I can get something to flow as an FAQ at the end

content/guides/references/experiments.md

content/partials/document-domain-workaround.md

emilyrohrbough · 2023-01-06T14:44:37Z

content/guides/guides/cross-origin-testing.md

@@ -129,6 +129,8 @@ specific test when it runs. For more information on this, please see our Web
 Security page regarding
 [Different superdomain per test requires cy.origin command](/guides/guides/web-security#Different-superdomain-per-test-requires-cy-origin-command).

+::include{file=partials/document-domain-workaround.md}


Was this mean to be under Other Workarounds?

I put it here because I feel like it is a work around, but it kind of feels thrown in there. Should we maybe dedicate a paragraph or something without the partial which makes more sense?

Yeah I might add some context on why its there and indicate it's type of work-around

What I did was just moved this up in cross origin testing in 3d4fb3e since we describe there why we do document.domain injection and it seems like the appropriate place to plug this. Not sure if this was there before but Revisiting I think it makes sense:

…into feature/experimentalUseDefaultDocumentDomain

….com:cypress-io/cypress-documentation into feature/experimentalUseDefaultDocumentDomain

emilyrohrbough · 2023-01-06T20:04:34Z

content/guides/references/experiments.md

+#### Experimental Skip Domain Injection
+
+Under the hood, Cypress
+[injects document.domain](/guides/guides/web-security#Examples-of-what-Cypress-does-under-the-hood)


I just read the Examples-of-what-Cypress-does-under-the-hood section. It doesn't state WHY we set document.domain. This is primarily to allow sub-domain navigation correct? maybe call that out here?

We have a spot for this in the cross origin testing guide. I think I can move the workaround up there and it will fit fairly well

AtofStryker · 2023-01-06T22:09:57Z

just to put a note ad the bottom that this PR needs to be rebased off v12.4

content/guides/references/experiments.md

* Chore: add experimentalSkipDomainInjection option (#4955) * chore: add documentation for new experimentalUseDefaultDocumentDomain option * chore: give more in depth look at experiment and why it is necessary * chore: address comments from code review * move disabling document.domain disclaimer up to discussion of injection * chore: rework the experiment section * chore: apply suggestions from code review * Adding documentation for experimentalMemoryManagement (#4991) * chore: initial commit of 12.4.0 changelog * chore: add .as() changes to changelog * chore: fix formatting in changelog * chore: address comments from review * chore: cut over changelog to use issue references instead of pull requests for source of issue * fix: cut over document-domain-workaround to mdx component * chore: lint document * chore: fix absolute link reference * chore: add space to changelog * chore: add space to changelog * Update docs/guides/references/_changelogs/12.4.0.md Co-authored-by: Mark Noonan <mark@cypress.io> * Update docs/guides/references/_changelogs/12.4.0.md Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/references/_changelogs/12.4.0.md Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * copy/pasta changelog suggestions into main doc * Update docs/guides/references/_changelogs/12.4.0.md Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/references/_changelogs/12.4.0.md Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: update PR with suggestions * chore: update suggestions from code review * chore: run prettier Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

chore: add documentation for new experimentalUseDefaultDocumentDomain…

09e859c

… option

AtofStryker mentioned this pull request Jan 3, 2023

feat: experimental skip domain injection cypress-io/cypress#25307

Merged

4 tasks

vercel bot deployed to Preview January 3, 2023 18:26 View deployment

Merge branch 'master' of github.com:cypress-io/cypress-documentation …

ff15d8d

…into feature/experimentalUseDefaultDocumentDomain

vercel bot deployed to Preview January 3, 2023 18:53 View deployment

AtofStryker requested review from emilyrohrbough, debrisapron, chrisbreiding, mjhenkes and mschile January 3, 2023 20:15

emilyrohrbough reviewed Jan 4, 2023

View reviewed changes

chore: give more in depth look at experiment and why it is necessary

f0c21be

AtofStryker requested a review from emilyrohrbough January 4, 2023 21:25

vercel bot deployed to Preview January 4, 2023 21:26 View deployment

Merge branch 'master' into feature/experimentalUseDefaultDocumentDomain

52d59af

vercel bot deployed to Preview January 4, 2023 22:29 View deployment

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

content/partials/document-domain-workaround.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

content/partials/document-domain-workaround.md Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

AtofStryker added 3 commits January 6, 2023 14:48

chore: address comments from code review

12dcee7

Merge branch 'master' of github.com:cypress-io/cypress-documentation …

352fd85

…into feature/experimentalUseDefaultDocumentDomain

Merge branch 'feature/experimentalUseDefaultDocumentDomain' of github…

cea2285

….com:cypress-io/cypress-documentation into feature/experimentalUseDefaultDocumentDomain

AtofStryker requested a review from emilyrohrbough January 6, 2023 19:50

vercel bot deployed to Preview January 6, 2023 19:51 View deployment

emilyrohrbough reviewed Jan 6, 2023

View reviewed changes

AtofStryker changed the title ~~Chore: add experimentalUseDefaultDocumentDomain option~~ Chore: add experimentalSkipDomainInjection option Jan 6, 2023

AtofStryker added 2 commits January 6, 2023 16:47

move disabling document.domain disclaimer up to discussion of injection

3d4fb3e

chore: rework the experiment section

dce0200

emilyrohrbough approved these changes Jan 6, 2023

View reviewed changes

vercel bot deployed to Preview January 6, 2023 22:08 View deployment

emilyrohrbough changed the base branch from master to release-12.4.0 January 6, 2023 22:42

mschile reviewed Jan 9, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

mschile reviewed Jan 9, 2023

View reviewed changes

content/guides/references/experiments.md Show resolved Hide resolved

mschile reviewed Jan 9, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

mschile reviewed Jan 9, 2023

View reviewed changes

content/guides/references/experiments.md Outdated Show resolved Hide resolved

chore: apply suggestions from code review

b3ee9a5

vercel bot deployed to Preview January 9, 2023 16:27 View deployment

mschile approved these changes Jan 9, 2023

View reviewed changes

AtofStryker merged commit 3999260 into release-12.4.0 Jan 9, 2023

AtofStryker deleted the feature/experimentalUseDefaultDocumentDomain branch January 9, 2023 20:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: add experimentalSkipDomainInjection option #4955

Chore: add experimentalSkipDomainInjection option #4955

AtofStryker commented Jan 3, 2023

vercel bot commented Jan 3, 2023 •

edited

Loading

emilyrohrbough commented Jan 4, 2023

emilyrohrbough Jan 4, 2023

AtofStryker Jan 4, 2023

AtofStryker Jan 4, 2023

emilyrohrbough Jan 4, 2023

AtofStryker Jan 4, 2023

emilyrohrbough Jan 6, 2023

AtofStryker Jan 6, 2023

emilyrohrbough Jan 6, 2023

AtofStryker Jan 6, 2023

emilyrohrbough Jan 6, 2023

AtofStryker Jan 6, 2023

AtofStryker commented Jan 6, 2023

Chore: add experimentalSkipDomainInjection option #4955

Chore: add experimentalSkipDomainInjection option #4955

Conversation

AtofStryker commented Jan 3, 2023

vercel bot commented Jan 3, 2023 • edited Loading

emilyrohrbough commented Jan 4, 2023

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

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

AtofStryker commented Jan 6, 2023

vercel bot commented Jan 3, 2023 •

edited

Loading