Data: Add error handle to the 'registry.batch' method #62322
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
Mamaduka
added
[Type] Bug
Mamaduka
commented
Jun 5, 2024
jsnajdr
reviewed
Jun 5, 2024
|
Size Change: +39 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
|
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. |
That would be great. I tried to add unit tests, but it's been a while since I've worked on store tests and properly emulated the reducer's error. If you have any pointers, I would be happy to take it from there. |
tyxla
reviewed
Jun 5, 2024
| callback(); | ||
| emitter.resume(); | ||
| Object.values( stores ).forEach( ( store ) => store.emitter.resume() ); | ||
| try { |
There was a problem hiding this comment.
Should we also wrap with try/catch/finally the callback() that we run if we're already batching above (L319)?
There was a problem hiding this comment.
L319 returns early and doesn't touch emitters. Bubbling the errors should be okay there.
Could be something straightforward, like simulating an error by an unallowed operation inside the reducer. For example, This should simulate a |
|
On second thought, I'm not sure the |
You put it better in words. I think I had the same problem when trying initially. |
Mamaduka
added
the
Backport to WP 6.6 Beta/RC
Mamaduka
commented
Jun 5, 2024
Comment on lines
+767
to
+778
| expect( () => { | ||
| registry.batch( () => { | ||
| throw error; | ||
| } ); | ||
| } ).toThrow( error ); | ||
| expect( listener ).not.toHaveBeenCalled(); | ||
|
|
||
| registry.batch( () => { | ||
| store.dispatch( { type: 'dummy' } ); | ||
| store.dispatch( { type: 'dummy' } ); | ||
| } ); | ||
| expect( listener ).toHaveBeenCalledTimes( 1 ); |
There was a problem hiding this comment.
@tyxla, what do you think about this?
There was a problem hiding this comment.
Looks good to me - thanks for adding a test!
Mamaduka
added
the
props-bot
github-actions
bot
removed
the
props-bot
ellatrix
pushed a commit
that referenced
this pull request
Jun 11, 2024
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: Mr2P <mr2p@git.wordpress.org>
ellatrix
pushed a commit
that referenced
this pull request
Jun 11, 2024
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: Mr2P <mr2p@git.wordpress.org>
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: Mr2P <mr2p@git.wordpress.org>
ellatrix
removed
the
Backport to WP 6.6 Beta/RC
|
This was cherry-picked to the wp/6.6 branch. |
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.
What?
Resolves: #62311.
PR adds an error handler to the
registry.batchmethod and avoids pausing all store emitters during the error.Testing Instructions
wp.data.select( 'core' ).getEntityRecords( 'root', 'site' );.Testing Instructions for Keyboard
Same.