Interactivity API: Prevent each directive errors and allow any iterable #67798
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
|
Flaky tests detected in c04e29b. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12355926558
|
sirreal
changed the title
|
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. |
sirreal
added
[Type] Feature
44 tasks
sirreal
commented
Dec 11, 2024
Comment on lines
+25
to
+37
| eachIterator: { | ||
| [ Symbol.iterator ]() { | ||
| const vals = [ 'implements', 'iterator' ]; | ||
| let i = 0; | ||
| return { | ||
| next() { | ||
| return i < vals.length | ||
| ? { value: vals[ i++ ], done: false } | ||
| : { done: true }; | ||
| }, | ||
| }; | ||
| }, | ||
| }, |
There was a problem hiding this comment.
I'll admit, this is a bit esoteric, but it doesn't work in the iAPI but it seems like it could. I suspect its iterator is lost in the proxies.
|
Size Change: +56 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
Comment on lines
+522
to
+523
| // TODO: Is there a problem with proxies here? | ||
| // [ 'each-with-iterator', [ 'implements', 'iterator' ] ], |
There was a problem hiding this comment.
Is it still the case that there is a problem with proxies? I see that tests are passing in the CI.
There was a problem hiding this comment.
Oh, I realized you meant there's a problem only for the each-with-iterator case which is commented out.
There was a problem hiding this comment.
That's right, it's commented out because it would not pass.
I didn't spend much time debugging the problem so I'm not sure what the issue is. It's some thing that apparently should work but does not, I'm not sure of the cause and don't really plan to spend time debugging it, maybe @DAreRodz know if this would create issues with store proxies.
michalczaplinski
approved these changes
Dec 16, 2024
There was a problem hiding this comment.
This looks good to me! 👍
We can create an issue for each-with-iterator and merge this as it improves on the status quo.
sirreal
force-pushed
the
iapi/prevent-non-array-each-directive-errors
branch
from
ba4391a to
c04e29b
Compare
yogeshbhutkar
pushed a commit
to yogeshbhutkar/gutenberg
that referenced
this pull request
Dec 18, 2024
…bles (WordPress#67798) Fix an issue where the each directive would error when a non-iterable value is received. Support more iterable values in the each directive. --- Co-authored-by: sirreal <jonsurrell@git.wordpress.org> Co-authored-by: michalczaplinski <czapla@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org>
yogeshbhutkar
pushed a commit
to yogeshbhutkar/gutenberg
that referenced
this pull request
Dec 18, 2024
…bles (WordPress#67798) Fix an issue where the each directive would error when a non-iterable value is received. Support more iterable values in the each directive. --- Co-authored-by: sirreal <jonsurrell@git.wordpress.org> Co-authored-by: michalczaplinski <czapla@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org>
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?
If an each directive does has a value without properties or without a callable
.mapmethod, it causes an error.Fixes #67174.
Why?
The API can be more robust in handling data problems like this. It's likely the each should render nothing if instead of
[]the value isnullor some other non-iterable.Take and example like this:
This has many opportunities for runtime errors, starting with the
nullinitial value.How?
Check whether a property is iterable and iterate instead of calling its
.mapmethod.Testing Instructions
The snippets above can be used.
Needs unit tests.
Screenshots or screencast
demo.mov