Config option - injecting document.domain #5974

cacieprins · 2024-10-29T13:53:51Z

(draft pr for work relating to cypress-io/cypress#29590)

…ection removal and reversion

jennifer-shehane · 2024-11-04T18:54:50Z

docs/api/commands/origin.mdx

+the two origins are in the same superdomain. This behavior can be disabled with
+the `injectDocumentDomain` configuration option, to allow a transition period.


Suggested change

the two origins are in the same superdomain. This behavior can be disabled with

the `injectDocumentDomain` configuration option, to allow a transition period.

the two origins are in the same superdomain. This behavior can be disabled by setting the `injectDocumentDomain` configuration option to `true`, to allow a smooth transition of tests to the new behavior.

addressed in 644aa61

docs/app/guides/cross-origin-testing.mdx

jennifer-shehane · 2024-11-04T18:57:44Z

docs/app/guides/cross-origin-testing.mdx

 2. [`.submit()`](/api/commands/submit) a `<form>` that causes your web server to
-   redirect you a different superdomain where additional Cypress commands are
+   redirect you a different origin where additional Cypress commands are


Suggested change

redirect you a different origin where additional Cypress commands are

redirect you to a different origin where additional Cypress commands are

addressed in 644aa61

jennifer-shehane · 2024-11-04T18:58:38Z

docs/app/guides/cross-origin-testing.mdx


 :::

 :::tip

 <Icon name="check-circle" color="green" /> You **can** [visit](/api/commands/visit)
-two or more domains of different origin in **different** tests without needing [`cy.origin()`](/api/commands/origin).
+two or origins in **different** tests without needing [`cy.origin()`](/api/commands/origin).


Suggested change

two or origins in **different** tests without needing [`cy.origin()`](/api/commands/origin).

two or more origins in **different** tests without needing [`cy.origin()`](/api/commands/origin).

addressed in 644aa61

jennifer-shehane · 2024-11-04T19:00:12Z

docs/app/references/configuration.mdx

+This option is <Badge type="caution">deprecated</Badge>, and will be removed in the next
+major version of Cypress.
+
+Set this configuration option is `true` to instruct Cypress to


Suggested change

Set this configuration option is `true` to instruct Cypress to

Set this configuration option to `true` to instruct Cypress to

addressed in 644aa61

jennifer-shehane · 2024-11-04T19:01:33Z

docs/app/references/configuration.mdx

+to behave in unexpected ways. This is especially true if a site your tests visit
+sets the [`Origin-Agent-Cluster`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster)


Suggested change

to behave in unexpected ways. This is especially true if a site your tests visit

sets the [`Origin-Agent-Cluster`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster)

to behave in unexpected ways. This is especially true if the site under test

sets the [`Origin-Agent-Cluster`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster)

addressed in 644aa61

jennifer-shehane · 2024-11-04T19:03:26Z

docs/app/references/migration-guide.mdx

@@ -68,6 +68,44 @@ For users with the existing `experimentalJustInTimeCompile` flag set, you can re

 :::

+### Changes to `cy.origin()`
+
+To support sites that use [origin-keyed agent clusters](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster), Cypress no longer injects `document.domain` into `text/html` content by default.


I'd like to mention the document.domain deprecation somewhere here: https://developer.chrome.com/blog/document-domain-setter-deprecation - just want to give context that these are outward changes enforcing this direction.

Addressed in 644aa61

cypress · 2024-11-04T19:20:06Z

cypress-documentation Run #193

Run Properties: Passed #193 • c7ff618f07: Update docs/app/references/configuration.mdx

Project	`cypress-documentation`
Branch Review	`config/inject-document-domain`
Run status	`Passed #193`
Run duration	`03m 21s`
Commit	`c7ff618f07: Update docs/app/references/configuration.mdx`
Committer	`Cacie Prins`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`0`
Pending	`0`
Skipped	`0`
Passing	`279`
View all changes introduced in this branch ↗︎

UI Coverage `10.89%`
Untested elements	`2227`
Tested elements	`3`

Accessibility `95.68%`
Failed rules	`2 critical` `5 serious` `4 moderate` `0 minor`
Failed elements	`530`

jennifer-shehane · 2024-12-03T17:00:09Z

docs/app/references/experiments.mdx

+| Option                    | Default | Description                                                                                               |
+| ------------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
+| `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.            |


@cacieprins Did you mean to remove experimentalOriginDependencies here?

Accidental - resolved in 644aa61

docs/partials/_document-domain-workaround.mdx

docs/app/references/configuration.mdx

AtofStryker · 2024-12-20T18:50:08Z

docs/api/commands/origin.mdx

@@ -64,7 +76,7 @@ const hits = getHits()
 cy.visit('https://example.cypress.io/history/founder')
 // To interact with cross-origin content, move this inside cy.origin() callback
 cy.get('h1').contains('About our Founder')
-// Domain must be a precise match including subdomain, i.e. example.cypress.io
+// Origin must be a precise match including scheme, subdomain and port, i.e. https://example.cypress.io
 cy.origin('cypress.io', () => {


should we update this example then to be an origin, like http://docs.cypress.io?

AtofStryker · 2024-12-20T18:51:07Z

docs/app/guides/cross-origin-testing.mdx

@@ -113,17 +108,6 @@ used.
 Read on to learn about
 [working around these common problems](#Common-Workarounds).

-#### What is a superdomain?
-
-But what is same superdomain? It's actually very similar to that of same


yay to superdomain no more!

AtofStryker · 2024-12-20T18:52:09Z

docs/app/guides/cross-origin-testing.mdx


-The URLs below, however, will have different superdomains/origins compared to
-`https://www.cypress.io`.
+An `origin` is comprised of a URL's `scheme`, `hostname`, _and_ `port`. Given the URLs


this is so much easier to interpret now as a normal web user IMO

docs/app/references/configuration.mdx

AtofStryker · 2024-12-20T18:56:00Z

docs/app/references/configuration.mdx

+#### Known Incompatibilities
+
+Setting this configuration value to `true` can cause the application you are testing
+to behave in unexpected ways. This is especially true if a site your tests visit


there are implications if your site sets it, but there are also implications where the browser defaults the origin-agent-cluster into buckets, which can cause problems. I think this is also worth mentioning

Co-authored-by: Bill Glesias <bglesias@gmail.com>

cacieprins added 3 commits October 28, 2024 10:08

Documents changes to cy.origin, configuration for document.domain inj…

4d7e8e6

…ection removal and reversion

lint and broken link fixes

bc4a1e7

lint

9a8aa77

jennifer-shehane assigned cacieprins Oct 30, 2024

jennifer-shehane requested changes Nov 4, 2024

View reviewed changes

Merge branch 'release/14.0.0' into config/inject-document-domain

52964ac

jennifer-shehane reviewed Dec 3, 2024

View reviewed changes

graphite-app bot reviewed Dec 11, 2024

View reviewed changes

docs/partials/_document-domain-workaround.mdx Outdated Show resolved Hide resolved

docs/app/references/configuration.mdx Outdated Show resolved Hide resolved

cacieprins added 2 commits December 19, 2024 10:31

address code review comments: typos, clarification

644aa61

Merge branch 'release/14.0.0' into config/inject-document-domain

b4a879d

jennifer-shehane mentioned this pull request Dec 20, 2024

breaking: no longer inject document.domain by default cypress-io/cypress#30770

Open

2 tasks

lint

f980559

cacieprins marked this pull request as ready for review December 20, 2024 18:30

AtofStryker reviewed Dec 20, 2024

View reviewed changes

Update docs/app/references/configuration.mdx

c7ff618

Co-authored-by: Bill Glesias <bglesias@gmail.com>

cacieprins requested a review from jennifer-shehane December 20, 2024 20:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Config option - injecting document.domain #5974

Config option - injecting document.domain #5974

cacieprins commented Oct 29, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

jennifer-shehane Nov 4, 2024

cacieprins Dec 19, 2024

cypress bot commented Nov 4, 2024 •

edited

Loading

jennifer-shehane Dec 3, 2024

cacieprins Dec 19, 2024

AtofStryker Dec 20, 2024

AtofStryker Dec 20, 2024

AtofStryker Dec 20, 2024

AtofStryker Dec 20, 2024

		the two origins are in the same superdomain. This behavior can be disabled with
		the `injectDocumentDomain` configuration option, to allow a transition period.

	redirect you a different origin where additional Cypress commands are
	redirect you to a different origin where additional Cypress commands are

	two or origins in different tests without needing [`cy.origin()`](/api/commands/origin).
	two or more origins in different tests without needing [`cy.origin()`](/api/commands/origin).

	Set this configuration option is `true` to instruct Cypress to
	Set this configuration option to `true` to instruct Cypress to

		to behave in unexpected ways. This is especially true if a site your tests visit
		sets the [`Origin-Agent-Cluster`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin-Agent-Cluster)

Config option - injecting document.domain #5974

Are you sure you want to change the base?

Config option - injecting document.domain #5974

Conversation

cacieprins commented Oct 29, 2024

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

Choose a reason for hiding this comment

cypress bot commented Nov 4, 2024 • edited Loading

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

cypress bot commented Nov 4, 2024 •

edited

Loading