Template Part: Prevent infinite recursion #28456
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
gziolo
added
[Feature] Templates API
|
Size Change: +155 B (0%) Total Size: 1.4 MB
ℹ️ View Unchanged
|
|
See #27012 where, for the server side rendering I implemented logic to detect recursion in nested blocks by adding and removing the block to a stack.
See #27612 for my original issue and test case data. The template part has a |
gziolo
added
[Feature] Full Site Editing
[Block] Template Part
See reference below. Template parts are also a function of the theme, so that needs to be part of the identifier. |
|
Thanks for getting this PR started. It would be good to solve #28405 (comment), as you've pointed out, before generalising this server-side solution. Edit: fix opened at #28461. |
|
@bobbingwide, thank you for the helpful comment. It aligns with what @carlomanf commented in #28405 (comment) in relation to Reusable block:
We might as well merge the editor part for now and tackle the server-side separately based on the implementation you shared. |
gziolo
commented
Jan 25, 2021
gziolo
force-pushed
the
try/template-part-infinite-recursion
branch
from
d1f22bd
to
4d3e092
Compare
6 tasks
mcsf
requested changes
Jan 25, 2021
|
@gziolo, can I help with this PR in any way? |
|
Feel free to take it over. I won't have time to work on it this week. |
6 tasks
Will do! |
gziolo
force-pushed
the
try/template-part-infinite-recursion
branch
from
4d3e092
to
e4a2a46
Compare
gziolo
force-pushed
the
try/template-part-infinite-recursion
branch
from
e4a2a46
to
26349a9
Compare
gziolo
commented
Mar 2, 2021
mcsf
reviewed
Mar 3, 2021
gziolo
force-pushed
the
try/template-part-infinite-recursion
branch
from
f4d36bd
to
976d181
Compare
|
This is how it looks with template parts nested in themselves when browsing in the template parts view on the Edit Site page: nested-template-parts.movIt behaves a bit strange for the template part that is nested inside another template part, but it all makes sense. I would say it's an anti-pattern in the first place to nest the same template part inside itself so it doesn't explode but the result is random that should raise the flag for the theme author 😄 |
|
@aristath and @ntsekouras – this PR is ready for review and testing. It means we have Reusable Block and Template Parts covered. What else is missing? |
Post Content is missing. |
ntsekouras
reviewed
Mar 4, 2021
ntsekouras
reviewed
Mar 4, 2021
There was a problem hiding this comment.
Thanks for working on this @gziolo! I left a couple of comments but in my testing everything works as expected.
Great work on the addition to check ids with block 💯
packages/block-editor/src/components/use-no-recursive-renders/test/use-no-recursive-renders.js
Show resolved
Hide resolved
|
@mcsf and @ntsekouras - anything left to rework here? |
mcsf
approved these changes
Mar 5, 2021
|
Interesting, 5 unit tests fail on CI. I will investigate that and fix it before merging this PR.. |
It looks like there were some changes introduced in #29333. The hook uses now |
7 tasks
gziolo
force-pushed
the
try/template-part-infinite-recursion
branch
from
c0d5796
to
d68cfb8
Compare
7 tasks
4 tasks
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.
Description
Fixes #27612.
Based on #28405 from @mcsf.
Tries to apply the same technique used for Reusable block to prevent infinite recursion when the same block is inserted into itself at any level of nesting.
Technical details
useNoRecursiveRendersrequired some improvements as there was the probability that the same unique id would be used for different block types. In theory, we could mitigate that by using the block name in the id but it would be up to the block author to ensure it. Instead, it uses the solution proposed by @mcsf to use the block edit context insideuseNoRecursiveRendersto resolve ambiguity on the framework level.How has this been tested?
WP_DEBUGandWP_DEBUG_DISPLAYconfig flags are enabled.a. Template Part A inside Template Part B that contains Template Part A.
b. Template Part A inside Template Part B that contains Template Part B.
Screenshots
Types of changes
Bug fix (non-breaking change which fixes an issue).
Checklist: