Improve WebChannel mocking #3647
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #3647 +/- ##
==========================================
- Coverage 88.90% 88.87% -0.03%
==========================================
Files 258 258
Lines 21498 21542 +44
Branches 5494 5504 +10
==========================================
+ Hits 19112 19146 +34
- Misses 2212 2222 +10
Partials 174 174
Continue to review full report at Codecov.
|
julienw
approved these changes
Nov 16, 2021
| @@ -124,5 +127,7 @@ describe('app/DragAndDrop', () => { | |||
|
|
|||
| fireEvent.dragLeave(dragAndDrop); | |||
| expect(overlay.classList).not.toContain('dragging'); | |||
|
|
|||
| restoreOriginals(); | |||
There was a problem hiding this comment.
We don't need to add all these restoreOriginals calls, because jest.spyOn spys are automatically removed after each test. See
Lines 25 to 28 in bead77f
(historical note: in the past we used to do this with some jest configuration, but this wasn't working properly, see jestjs/jest#9896 especially. That's why we're doing it manually in the setup file. I don't know if that improved.)
There was a problem hiding this comment.
Oh, perfect! That should make the patch a lot simpler.
This means that these functions will be usable from UrlManager.test.js. I'll make use of that in a future PR.
The WebChannel mocking now calls the original functions for addEventListener, removeEventListener, and dispatchEvent. This means that it won't interfere with other uses of these APIs. One example of such a use is the popstate event: UrlManager.test.js has a test which makes sure that the URL state is restored when going backwards in history. Using a mocked WebChannel in that test broke it because the popstate event was no longer being dispatched.
mstange
force-pushed
the
less-invasive-mock-webchannel
branch
from
d0af54c
to
8d06672
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR has two commits which improve the mock WebChannel which we use in tests: The code is moved to a different file, it no longer breaks other uses of window.dispatchEvent, and it adds a way to clean up after the test.