fix: Use internal PropertySymbol.location in BrowserFrameURL to avoid mock interference #1964
+94
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… mock interference When tests mock window.location with a partial mock (e.g., only providing `reload`), the getRelativeURL method would fail because `location.href` was undefined from the mock. This caused the URL resolution to fall back to 'about:blank', which has `origin: null`. The origin mismatch then triggered a SecurityError in History.pushState, which caused the `history` library to fall back to window.location.assign(), which wasn't available in the mock - resulting in confusing errors. By using the internal PropertySymbol.location instead of the public getter, BrowserFrameURL now accesses the real Location object regardless of any mocks applied to window.location.
marchaos
force-pushed
the
fix/browser-frame-url-mock-resilience
branch
2 times, most recently
from
c2d9fc2 to
d24c667
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When tests mock
window.locationwith a partial mock (e.g.,jest.spyOn(window, 'location', 'get').mockReturnValue({ reload: jest.fn() })), theBrowserFrameURL.getRelativeURLmethod fails becauselocation.hrefis undefined from the mock.This causes:
about:blank(which hasorigin: null)History.pushState\ fails:null !== 'http://localhost'`historylibrary tries fallback towindow.location.assign()assign, causing confusing errorsSolution
Use
frame.window[PropertySymbol.location].hrefinstead offrame.window.location.href. This accesses the internal Location object via Symbol property, which isn't affected by mocks on the public getter.Testing
Tested against a large React test suite (~26,000 tests) that was failing with this issue. After the fix, tests pass successfully.