fix: prevent serialization issues with retries using multi-domain

[AtofStryker]

• Closes N/A

User facing changelog

N/A

Additional details

The goal of this PR is to fix intermittent retry issues with tests that utilize switchToDomain. Previously, we were not preprocessing any values that may/may not be serializable from the primary to the secondary with toSpecBridge functions. This fix processes data before putting it through postMessage, which should guarantee the data is serializable. There are also updates to map nested object properties within objects to literals, as well as Arrays to make sure the structure of an object is still serializable.

A symptom of this is the error Cannot set property message of which has only a getter, which happens when unserializable values are fed through test:before:run:async to the spec bridge, which contains unserializable nested object keys. A data clone error is thrown, which has getter only property message on the base error prototype class, causing this error.

reproduction of error

with PR fixes

To conserve current behavior, we want to only sanitize the data we control. User defined data that is passed into switchToDomain should not be sanitized, and should error as usual.

The only known side effect of this PR is errors passed into Cypress.config are flattened to objects in the secondary, and aren't reified. This seems like an incredibly rare use case, and I am not too worried about this change.

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?
• Have API changes been updated in the type definitions?
• Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

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.

[cypress]

---

Test summary

20471 • 0 • 298 • 4 • 2

---

Run details

Project	cypress
Status	Passed
Commit	cc0a4bd
Started	Mar 16, 2022 5:24 PM
Ended	Mar 16, 2022 5:38 PM
Duration	14:15 💡
OS	Linux Debian - 10.10
Browser	Multiple

View run in Cypress Dashboard ➡️

---

Flakiness

	commands/actions/click_spec.js		1
1	src/cy/commands/actions/click > #rightclick > rightclick remove el on mouseover
	reporter.hooks.spec.js		1
1	hooks > can rerun without timeout error leaking into next run (due to run restart)

---

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

[AtofStryker]

we technically only have to do this for Objects/Arrays, but figured this is easier to maintain to do full recursion in which the property is just returned. This can be optimized a bit more if we find this highly important

[mjhenkes]

With this PR can we enable these tests again?
https://github.com/cypress-io/cypress/blob/feature-multidomain/packages/driver/cypress/integration/e2e/multi-domain/multi_domain_uncaught_errors_spec.ts#L7

https://github.com/cypress-io/cypress/blob/feature-multidomain/packages/driver/cypress/integration/e2e/multi-domain/basic_login_spec.ts#L375

[AtofStryker]

With this PR can we enable these tests again? https://github.com/cypress-io/cypress/blob/feature-multidomain/packages/driver/cypress/integration/e2e/multi-domain/multi_domain_uncaught_errors_spec.ts#L7

https://github.com/cypress-io/cypress/blob/feature-multidomain/packages/driver/cypress/integration/e2e/multi-domain/basic_login_spec.ts#L375

@mjhenkes going to take a look. Thank you merging the feature branch back in BTW