Replace x.top, x.parent accessors with correct reference (at runtime)

[flotwig]

PR: #5273

Current behavior:

window.top and window.parent references are naively corrected like so:

cypress/packages/server/lib/util/security.js

Lines 7 to 38 in 4ec77e3

	const topOrParentEqualityBeforeRe = /((?:window|self)(?:\.|\[['"](?:top|self)['"]\])?\s*[!=]==?\s*(?:(?:window|self)(?:\.|\[['"]))?)(top|parent)(?![\w])/g
	const topOrParentEqualityAfterRe = /(top|parent)((?:["']\])?\s*[!=]==?\s*(?:window|self))/g
	const topOrParentLocationOrFramesRe = /([^\da-zA-Z\(\)])?(top|parent)([.])(location|frames)/g
	const jiraTopWindowGetterRe = /(!function\s*\((\w{1})\)\s*{\s*return\s*\w{1}\s*(?:={2,})\s*\w{1}\.parent)(\s*}\(\w{1}\))/g
	const strip = (html) => {
	return html
	.replace(topOrParentEqualityBeforeRe, '$1self')
	.replace(topOrParentEqualityAfterRe, 'self$2')
	.replace(topOrParentLocationOrFramesRe, '$1self$3$4')
	.replace(jiraTopWindowGetterRe, '$1 || $2.parent.__Cypress__$3')
	}
	const stripStream = () => {
	return pumpify(
	utf8Stream(),
	replaceStream(
	[
	topOrParentEqualityBeforeRe,
	topOrParentEqualityAfterRe,
	topOrParentLocationOrFramesRe,
	jiraTopWindowGetterRe,
	],
	[
	'$1self',
	'self$2',
	'$1self$3$4',
	'$1 || $2.parent.__Cypress__$3',
	]
	)
	)
	}

Desired behavior:

• Replace /(.*)\.(top|parent)/ with (window.top.Cypress.resolveWindowReference($1, "$2")) using AST parser or regexes
• window.top.Cypress.resolveWindowReference(maybeWindow, prop) is a function that checks if maybeWindow is a Window and, if so, corrects the property access to be 1 level deeper than it would've been (to skip window.top).
• If maybeWindow is not a Window, and if maybeWindow[prop] is a Function, it will bind maybeWindow[prop] to maybeWindow and return it.
• Else, it will return maybeWindow[prop].

[cypress-bot]

The code for this is done in cypress-io/cypress#5273, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 4.6.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v4.6.0, please open a new issue.

[flotwig]

This fix is available starting in 4.6.0 as an experiment which you can access by setting this config option in your cypress.json or elsewhere:

{
	"experimentalSourceRewriting": true
}

The fix is experimental, so there may be some situations where the this is not fixed.

If you're still this issue while setting the experimentalSourceRewriting to true in 4.6.0 - open a new issue with a reproducible example + screenshots, etc - filling out our issue template.

[fderraz]

Hello,

My Cypress test fails because the home page is not loaded:
(uncaught exception)TypeError: top.getTabFrom is not a function
(uncaught exception)TypeError: top.getParamWindow is not a function

The following error originated from your application code, not from Cypress. > top.getTabFrom is not a function

I addedto the cypress.json file, the following params: “experimentalSourceRewriting”: true
Except that it doesn't fix my problem

Version Cypress: "13.15.0"

Any suggestions you may have to solve this problem, will be appreciated :)

Please find enclosed my code: Test.cy.js
The following code snippet corrects the loading problem, except that it's not a relevant solution because the win.top is used everywhere in the application under Test ==> it's not possible to include it after each click.

cy.window().then((win) => {
win.top.getTabFrom = win.top[0].getTabFrom;
win.top.getParamWindow = win.top[0].getParamWindow;
});