chore: develop (including cy.origin) merge into 10.0 #21237

AtofStryker · 2022-04-28T01:56:54Z

DO NOT SQUASH!!!!

Closes #19887

User facing changelog (as seen in #18075)

Removed experimentalSessionSupport Flag
Added experimentalSessionAndOrigin Flag containing:
- All features from the experimentalSessionSupportFlag
- A new Cypress command called origin which allows users to run commands within multiple origins from a single test.
- Cross-domain requests will no longer fail immediately, but instead, time out based on pageLoadTimeout.
- Tests will no longer wait on page loads before moving on to the next test.

Additional details

The goal of this PR is to merge develop containing the cy.origin command and a few other updates, into 10.0. For original PR into develop, please see #18075. To recap important changes in the development environment:

Driver integration tests in CI now have two jobs per browser:
- 1 each with experimentalSessionAndOrigin off (with the tests restructured to use a visit between tests to be compatible with sessions). The cy.origin tests are not run in this job
- 1 each with experimentalSessionAndOrigin on with cy.origin tests run in this job. When this feature becomes GA, the goal is to consolidate back into 1 integration job per browser.

For merging with 10.0, main conflicts/changes from the develop branch into 10.0:

Driver

Test file restructuring (from integration to e2e and following *.cy.js paradigm over *.spec.js) and various snapshot updates. Also updating tests that look for cypress.json to look for new cypress.config.js paradigm.
Renaming createSpecIframe to generic addIframe as we need to now add multiple iframes to create the spec bridges for cy.origin.

Runner / App

In develop, we were able to reference Cypress to remove/create the iframes and inject them into the page. Since it doesn't look to be instantiated yet, the same functionality has been replaced with native DOM methods.
Moving all the logic from the old runner -> app that is AUT/iframe/event driven:
- event-manager (new websocket/communicator methods, screenshot methods (NEEDS TO BE VERIFIED)
- aut-iframe changes for cross origin snapshotting behavior and removal of snapshot responsibilities (NEEDS TO BE VERIFIED)
- iframe-model changes for cross origin snapshotting behavior

Server / Data-Context

Addition of remoteStates concept needs to be consumed by the data-context package when serving the app. runner.serve is no longer used in 10.0 and makeServeConfig is the method where remoteStates likely needs to be reset. When the config is served, remote should otherwise be set to current.
CRI client changes to account for frame tree updates to attach X-Cypress-Is-AUT-Frame header to inform the server to inject the cross origin driver, as well as passing the feature flag into the CDP automation static constructor.
IMPORTANT: Resolving the to runner directory in e2e mode and the runner-ct directory otherwise to make sure the runner routes can serve the cross origin bundle. (THIS NEEDS TO BE VERIFIED IF THIS CHANGE IS CORRECT)

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)~~ N/A
~~Has a PR for user-facing changes been opened in cypress-documentation?~~ N/A: Docs for cy.origin are merged into cypress-documentation and shipped with 9.6.0
Have API changes been updated in the type definitions?
~~Have new configuration options been added to the cypress.schema.json?~~ Applicable item changes from cypress.schema.json were migrated to frontend-shared locales to be referenced on the settings page (see screenshot below)

…nto feature-multidomain

…e between domains (#17942)

…nto feature-multidomain

AtofStryker · 2022-05-06T17:58:56Z

packages/driver/types/remote-state.d.ts

@@ -0,0 +1,14 @@
+declare namespace Cypress {


likely the changes here need to be overwritten to satisfy is comment

AtofStryker · 2022-05-06T18:01:13Z

packages/server/lib/browsers/cdp_automation.ts

@@ -176,13 +178,13 @@ const ffToStandardResourceTypeMap: { [ff: string]: ResourceType } = {
 }

 export class CdpAutomation {


original in 9.x

AtofStryker · 2022-05-06T18:05:49Z

packages/server/lib/browsers/chrome.ts

+let frameTree
+let gettingFrameTree
+
+const onReconnect = (client: CRIWrapper.Client) => {


not exactly a 1:1 here, but this callback handler is defined here and passed into browserCRIClient static constructor which is ultimately referenced in the generic criClient static contructor. original in 9.x

AtofStryker · 2022-05-06T18:06:09Z

packages/server/lib/browsers/cri-client.ts

@@ -147,6 +147,10 @@ export const create = async (target: string, onAsynchronousError: Function, host
      })

      enqueuedCommands = []
+
+      if (onReconnect) {


see original in 9.x

AtofStryker · 2022-05-06T18:07:09Z

packages/server/lib/browsers/chrome.ts

+}
+
+// eslint-disable-next-line @cypress/dev/arrow-body-multiline-braces
+const _updateFrameTree = (client: CRIWrapper.Client, eventName) => async () => {


see original in 9.x

AtofStryker · 2022-05-06T18:09:11Z

packages/server/lib/browsers/chrome.ts

@@ -450,16 +570,21 @@ export = {
    ])

    await this._navigateUsingCRI(pageCriClient, options.url)
+
+    if (options.experimentalSessionAndOrigin) {


Since we have a bit of a different process now for attaching to target and getting the browser CRI client, we need to make sure that the appropriate even listeners are applied every time we attach to a new target, as well as turn on any necessary CDP events.

ryanthemanuel · 2022-05-06T18:30:39Z

packages/server/lib/browsers/chrome.ts

@@ -324,7 +324,7 @@ const onReconnect = (client: CRIWrapper.Client) => {
  // if the client disconnects (e.g. due to a computer sleeping), update
  // the frame tree on reconnect in cases there were changes while
  // the client was disconnected
-  _updateFrameTree(client)()
+  return _updateFrameTree(client)()


Is this asynchronous? Do we need to await it in criClient.create

it is asynchronous, but we do not need to await it. The return statement here is to appease the linter. The waiting gets handled by the _isAUTFrame function itself here.

ryanthemanuel · 2022-05-06T18:34:19Z

packages/driver/cypress/support/utils.js

@@ -107,7 +107,10 @@ const getAllFn = (...aliases) => {
  )
 }

-const shouldWithTimeout = (cb, timeout = 250) => {
+// FIXME: currently increasing the timeout here from 250ms to 1 second


Should we log an issue for this?

We should. @mschile logged #21361 for some of the proxy issues happening in electron from this branch. I'll go ahead and create and issue and update the thread here

issue logged in #21375

…10.0-merge

flotwig

Looks good, nothing jumped out at me as being a mismerge.

lmiller1990 · 2022-05-09T04:29:06Z

I tried to write some tests using cy.origin to see if it's working correctly, but I could not get it working with our dashboard. It worked with the simple and boring http://acme.com.

I also noticed we can't use cy.origin in packages.app - I'm not sure if this is because of some hacks we did for cypress-in-cypress.

I tried writing some tests in packages/launchpad. It worked better there, but I am still having some problems. Here's a link to the test I wrote: link. The screenshot is below.

I tried in develop, and I get the same problem, so I guess it's not a problem introduced by this back merge, so I'll ✅ .

I am curious if I'm doing something wrong - this should work, correct?

lmiller1990

I tried it out and compared between develop and this branch and it seems good.

I had some problems with using cy.origin that seem unrelated, but I posted a comment in case they are: https://cypressio.slack.com/archives/C01TQQCQLJY/p1652071156301199

…ating tests in an attempt to keep strict comparisons in the test

…10.0-merge

AtofStryker · 2022-05-09T16:33:57Z

I tried it out and compared between develop and this branch and it seems good.

I had some problems with using cy.origin that seem unrelated, but I posted a comment in case they are: https://cypressio.slack.com/archives/C01TQQCQLJY/p1652071156301199

@lmiller1990 we talked about this standup. It looks like the dashboard code tries to reference window.parent within the dashboard code to set a react devtools flag for when Cypress is on the window. My guess is this is used to test the dashboard code. This fails because parent is in a cross origin context. I bet if you set chromeWebSecurity to false in cypress.config.ts it will start working. We have some issues created to spike into some of the modifyObstructiveCode #21342, but I think that mostly tries to handlewindow.top instead of window.parent

…-10.0-merge

…mpleted (#21373) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

chrisbreiding and others added 30 commits July 13, 2021 09:14

Merge branch 'feature-multidomain' of github.com:cypress-io/cypress i…

66d947d

…nto feature-multidomain

chore: Wrap native methods in secondary domain (#17303)

700636a

Merge branch 'develop' into feature-multidomain

b36fdff

Merge branch 'feature-multidomain' of github.com:cypress-io/cypress i…

51dea49

…nto feature-multidomain

Merge branch 'develop' into feature-multidomain

4288ce6

chore: Add event listeners in secondary domain (#17391)

53cd6d1

Merge branch 'develop' into feature-multidomain

548db6e

Merge branch 'feature-multidomain' of github.com:cypress-io/cypress i…

31e6d3f

…nto feature-multidomain

Merge branch 'develop' into feature-multidomain

617f321

Merge branch 'develop' into feature-multidomain

a3930c2

Merge branch 'develop' into feature-multidomain

4323215

Merge branch 'develop' into feature-multidomain

f5d326a

fix issues

3ad6c36

convert requires to imports

fef49f4

chore: Run command queue in secondary domain and sync up command stat…

16ad6b4

…e between domains (#17942)

Merge branch 'develop' into feature-multidomain

4e140a2

Merge branch 'feature-multidomain' of github.com:cypress-io/cypress i…

92932c5

…nto feature-multidomain

Merge branch 'develop' into feature-multidomain

cc66129

chore: Fix rerunning multidomain tests (#18090)

416aabe

Merge branch 'develop' into feature-multidomain

2aea225

Merge branch 'feature-multidomain' of github.com:cypress-io/cypress i…

fb5ff06

…nto feature-multidomain

Merge branch 'develop' into feature-multidomain

9503b40

Merge branch 'develop' into feature-multidomain

8f11635

Merge branch 'develop' into feature-multidomain

516100b

Merge branch 'develop' into feature-multidomain

c6d2918

Merge branch 'develop' into feature-multidomain

2c28961

Merge branch 'develop' into feature-multidomain

8ac1ff0

fix errors

0eeb442

fix issues created by merge

10264e6

Merge branch 'develop' into feature-multidomain

b5a135d

AtofStryker commented May 6, 2022

View reviewed changes

ryanthemanuel reviewed May 6, 2022

View reviewed changes

emilyrohrbough approved these changes May 6, 2022

View reviewed changes

ryanthemanuel reviewed May 6, 2022

View reviewed changes

rename 17805_spec.js to 17805.cy.js

b66d35a

AtofStryker requested a review from ryanthemanuel May 6, 2022 18:52

AtofStryker added 2 commits May 6, 2022 15:15

Merge branch '10.0-release' of github.com:cypress-io/cypress into md-…

a374f3c

…10.0-merge

update yarn.lock file

d9aa8ee

flotwig approved these changes May 6, 2022

View reviewed changes

lmiller1990 approved these changes May 9, 2022

View reviewed changes

AtofStryker added 2 commits May 9, 2022 09:53

get reference to btn inside the trigger for cy.ensureElementIsNotAnim…

3715d3e

…ating tests in an attempt to keep strict comparisons in the test

Merge branch '10.0-release' of github.com:cypress-io/cypress into md-…

56ee2a5

…10.0-merge

AtofStryker requested a review from tbiethman May 9, 2022 16:34

AtofStryker and others added 5 commits May 9, 2022 12:44

Merge branch '10.0-release' into md-10.0-merge

2595c44

Merge branch '10.0-release' into md-10.0-merge

0fd58d6

increase shouldWithTimeout to 3 seconds until #21375 is addressed

bd428a5

Merge branch 'md-10.0-merge' of github.com:cypress-io/cypress into md…

295cd02

…-10.0-merge

fix: ensure that proxy logs are updated after the xhr has actually co…

cd8ad4c

…mpleted (#21373) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

tgriesser approved these changes May 9, 2022

View reviewed changes

Merge branch '10.0-release' into md-10.0-merge

1618a99

AtofStryker merged commit 6c81ac3 into 10.0-release May 9, 2022

AtofStryker deleted the md-10.0-merge branch May 9, 2022 21:40

cypress-bot bot mentioned this pull request May 9, 2022

[Multi-domain]: Merge with 10.0 #19887

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: develop (including cy.origin) merge into 10.0 #21237

chore: develop (including cy.origin) merge into 10.0 #21237

AtofStryker commented Apr 28, 2022 •

edited

AtofStryker May 6, 2022

AtofStryker May 6, 2022

AtofStryker May 6, 2022

AtofStryker May 6, 2022 •

edited

AtofStryker May 6, 2022 •

edited

AtofStryker May 6, 2022

ryanthemanuel May 6, 2022

AtofStryker May 6, 2022

ryanthemanuel May 6, 2022

AtofStryker May 6, 2022

AtofStryker May 6, 2022

flotwig left a comment

lmiller1990 commented May 9, 2022 •

edited

lmiller1990 left a comment

AtofStryker commented May 9, 2022

		@@ -176,13 +178,13 @@ const ffToStandardResourceTypeMap: { [ff: string]: ResourceType } = {
		}

		export class CdpAutomation {

chore: develop (including cy.origin) merge into 10.0 #21237

chore: develop (including cy.origin) merge into 10.0 #21237

Conversation

AtofStryker commented Apr 28, 2022 • edited

DO NOT SQUASH!!!!

User facing changelog (as seen in #18075)

Additional details

Driver

Runner / App

Server / Data-Context

How has the user experience changed?

PR Tasks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AtofStryker May 6, 2022 • edited

Choose a reason for hiding this comment

AtofStryker May 6, 2022 • edited

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

flotwig left a comment

Choose a reason for hiding this comment

lmiller1990 commented May 9, 2022 • edited

lmiller1990 left a comment

Choose a reason for hiding this comment

AtofStryker commented May 9, 2022

AtofStryker commented Apr 28, 2022 •

edited

AtofStryker May 6, 2022 •

edited

AtofStryker May 6, 2022 •

edited

lmiller1990 commented May 9, 2022 •

edited