ObservableMap: optimize unsubscribe and add unit tests #60892
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
jsnajdr
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ellatrix
approved these changes
Apr 19, 2024
ellatrix
reviewed
Apr 19, 2024
| list = new Set(); | ||
| listeners.set( name, list ); | ||
| } | ||
| const list = getListeners( name ); |
There was a problem hiding this comment.
Is getListeners intended to be reused at some point?
There was a problem hiding this comment.
I extracted getListeners so that TypeScript stops bothering me 🙂 This code doesn't pass type check:
let list = ...
if ( ! list ) {
list = ...
}
return () => list.delete();TypeScript (5.1.x) thinks that list can be undefined inside the body of the returned function. Because after the first line it really can be undefined. TypeScript 5.4 no longer has this bug. But it forced me to extract the list-assigning code to a function.
There was a problem hiding this comment.
After merging TS upgrade to 5.4.5 in #60793, I was able to inline the getListeners function. TypeScript now knows list is never undefined.
|
Size Change: -12 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Apr 19, 2024
Comment on lines
47
to
52
| // check that unsubscription really works. | ||
| unsubA(); | ||
| unsubB(); | ||
| map.set( 'a', 3 ); | ||
| expect( notifsFromA ).toBe( 3 ); | ||
| expect( notifsFromB ).toBe( 1 ); |
There was a problem hiding this comment.
Minor: Should those subscription assertions be in separate tests? This particular one tests that after unsubscribing individual values are no longer observed, which is exactly the opposite of what the test claims to do 🤔
| const map = observableMap(); | ||
| map.set( 'a', 1 ); | ||
|
|
||
| let renders = 0; |
There was a problem hiding this comment.
Perhaps a cleaner way to store the count inside a ref in the component?
We could then render that value and assert it the same way we assert "value is N"
There was a problem hiding this comment.
Yes, but this works equally well, it's not complicated or confusing in anyway, and we're already doing this in other tests, like for useSelect.
There was a problem hiding this comment.
It kind of feels off to me to pass and modify an external variable in a component, but it's not critical in a test. Leaving it to your judgment.
There was a problem hiding this comment.
I wrapped the functions where we count how many times they are called in a jest.fn, and started checking the call counts with .toHaveBeenCalledTimes. That should be a more professional way to do it 🙂
jsnajdr
force-pushed
the
followups/observable-map
branch
from
b0d3994 to
5ae7a80
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.
Followup to #60879 that implements some review suggestions: