chore: (multi-domain) support multiple remote states #20752

mschile · 2022-03-23T14:55:56Z

User facing changelog

n/a

Additional details

Added support for multiple remote states. This allows us to better determine when to inject multi-domain and to support carrying forward the cy.visit auth options to subsequent requests. Multiple remote states works as follows:

top origin added to origin stack
remote state added when ready:for:domain event received
- the origin is added to the origin stack
when requesting the remote state, the remote state for the latest origin is returned
when processing auth in the request-middleware, the remote state for the requested origin is retrieved to determine if auth needs to be applied to the request.
when determining if a response should be delayed for multi-domain, the cross-origin check now only passes if the request is not for the current origin or any other previous origins in the stack
when determining if multi-domain should be injected into the response, an additional check is made to ensure the response is for a secondary origin in the origin stack
when the switchToDomain command ends, the origin is removed from the origin stack but the remote state is not removed since the user could make another request to that origin that would need the state applied
origin stack and secondary remote states are reset between tests and when loading the tests to ensure the previous state is cleaned up before starting any new test
if switchToDomain validation fails or if the fallback switchToDomain timeout occurs, the response is released but the remote state and origin are not added

How has the user experience changed?

auth options are now applied to subsequent requests in a secondary origin
multi-domain is only injected for known secondary origins

PR Tasks

Have tests been added/updated?
[na] Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?
[na] Have new configuration options been added to the cypress.schema.json?

* chore: [Multi-domain] Fix Flake when subdomain loads faster than toSpecBridge Command called. * Add Test * simplify test * Loading a cross domain page won't happen until the spec bridge is active (or a timeout will happen) * Update packages/driver/src/multi-domain/domain_fn.ts

…tance (#20653) * fix: make the primary domain communicator a singleton per cypress instance * leverage a factory to make typescript happy with their super() constructor rules * remove singleton instance from communicator and only bind message events once in the primary and per spec bridge. Forward all message events to the respective communicator instance, if available. * remove data.actual reference in primary communicator onMessage as it is no longer needed

* Better timeout error handling * quick fix, should re-visit * cancel dangling timeouts * re-broadcast the window load event. * clean up code and comment more * ignore better * PR updates * oops, didn't mean to enable this * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * moar pr updates * Apply suggestions from code review Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * Fix test * message changes * message update Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

* chore: [multi-domain] fix count-logs-by-test * add tests, fix preAttempts * formatting * remove redundant test

…iple-remote-states

cypress · 2022-03-23T15:17:05Z

Test summary

436 • 0 • 2 • 0 • 0

Run details


Project	cypress
Status	Passed
Commit	`ccc836a`
Started	Mar 28, 2022 9:18 PM
Ended	Mar 28, 2022 9:28 PM
Duration	09:27 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in 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

cypress-bot · 2022-03-23T16:05:13Z

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.

.vscode/launch.json

packages/runner/injection/multi-domain.js

chrisbreiding

A lot cleaner with RemoteStates extracted. Very nice!

…iple-remote-states

packages/server/lib/remote_states.ts

packages/server/lib/server-base.ts

…iple-remote-states

mschile and others added 17 commits March 21, 2022 17:36

supporting multiple remote states

82d3242

fixing a few tests

a1f28c0

fixing test

8d385f4

fixing response-middleware test

c33b44c

fix: [Multi-domain] Fix countLogsByTest (#20719)

3be38ab

* chore: [multi-domain] fix count-logs-by-test * add tests, fix preAttempts * formatting * remove redundant test

making requests unique

f3402ef

adding comment

2758f98

Merge branch 'feature-multidomain' into issue-20620-multi-domain-mult…

a36389b

…iple-remote-states

adding getRemoteStateFor

5f8c5be

fixing cookie auth tests

ccb181a

fixing a few issues

bf2aa70

adding a few tests

5d18585

updating test

e4a8095

test fixes

2d1c526

mschile requested a review from a team as a code owner March 23, 2022 14:55

mschile requested review from rockhold and removed request for a team March 23, 2022 14:55

Merge branch 'feature-multidomain' into issue-20620-multi-domain-mult…

6f91088

…iple-remote-states

mschile requested review from AtofStryker, chrisbreiding and mjhenkes and removed request for rockhold March 23, 2022 14:56

mjhenkes reviewed Mar 23, 2022

View reviewed changes

.vscode/launch.json Show resolved Hide resolved

adding response-middleware test

44a7dbf

mjhenkes reviewed Mar 23, 2022

View reviewed changes

packages/runner/injection/multi-domain.js Show resolved Hide resolved

chrisbreiding approved these changes Mar 25, 2022

View reviewed changes

mschile and others added 5 commits March 25, 2022 16:34

fixing tests

fc4377f

fixing tests

1b70f78

Merge branch 'feature-multidomain' into issue-20620-multi-domain-mult…

c87633e

…iple-remote-states

adding remote_states tests

efb3568

fixing spacing issue

4840f53

mjhenkes reviewed Mar 28, 2022

View reviewed changes

packages/server/lib/remote_states.ts Outdated Show resolved Hide resolved

mjhenkes approved these changes Mar 28, 2022

View reviewed changes

mschile requested a review from AtofStryker March 28, 2022 14:35

chrisbreiding approved these changes Mar 28, 2022

View reviewed changes

AtofStryker reviewed Mar 28, 2022

View reviewed changes

packages/server/lib/remote_states.ts Outdated Show resolved Hide resolved

packages/server/lib/remote_states.ts Outdated Show resolved Hide resolved

packages/server/lib/remote_states.ts Outdated Show resolved Hide resolved

packages/server/lib/server-base.ts Outdated Show resolved Hide resolved

mschile and others added 6 commits March 28, 2022 10:48

added check when removing current origin

11d9897

pr updates

ca371ed

call .get from .set

4f347a8

Merge branch 'feature-multidomain' into issue-20620-multi-domain-mult…

0653190

…iple-remote-states

updtaing remote states to take an event emitter instead of socket

cd8bc41

updates

a05aa0f

mschile requested review from AtofStryker, chrisbreiding and mjhenkes March 28, 2022 20:17

chrisbreiding approved these changes Mar 28, 2022

View reviewed changes

mjhenkes approved these changes Mar 28, 2022

View reviewed changes

fixing test

ccc836a

mschile merged commit fedb65c into feature-multidomain Mar 28, 2022

mschile deleted the issue-20620-multi-domain-multiple-remote-states branch March 28, 2022 21:26

This was referenced Mar 28, 2022

[Multi-domain]: Support multiple remote states #20620

Closed

[Multi-domain]: Multi-domain script is still injected when multi-domain is not used #20428

Closed

[Multi-domain]: Investigate cy.visit performance #20619

Closed

This was referenced Apr 6, 2022

Multi-domain script is injected into cross origin html regardless of switchToDomain context #19632

Closed

chore: audit cross-origin related TODOs/FIXMEs #20975

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: (multi-domain) support multiple remote states #20752

chore: (multi-domain) support multiple remote states #20752

Uh oh!

mschile commented Mar 23, 2022

Uh oh!

cypress bot commented Mar 23, 2022 •

edited

Loading

Uh oh!

cypress-bot bot commented Mar 23, 2022

Uh oh!

Uh oh!

Uh oh!

chrisbreiding left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chore: (multi-domain) support multiple remote states #20752

chore: (multi-domain) support multiple remote states #20752

Uh oh!

Conversation

mschile commented Mar 23, 2022

User facing changelog

Additional details

How has the user experience changed?

PR Tasks

Uh oh!

cypress bot commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test summary

Run details

Uh oh!

cypress-bot bot commented Mar 23, 2022

Uh oh!

Uh oh!

Uh oh!

chrisbreiding left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cypress bot commented Mar 23, 2022 •

edited

Loading