Parser / Site Editor: Ensure autop is not run when freeform block is set to core/html #52716
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
andrewserong
added
[Type] Bug
andrewserong
requested review from
mcsf,
youknowriad,
noisysocks,
dmsnell,
ramonjd,
tellthemachines and
ntsekouras
|
Size Change: +16 B (0%) Total Size: 1.43 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in fe4641728cc4dbd5f93d30e31d442e9fb8f30676. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5583963619
|
mcsf
reviewed
Jul 18, 2023
There was a problem hiding this comment.
Thanks for working on this!
The approach looks good to me. However, after a quick grep, I think we are forgetting this other instance where the inverse — removep — is called during serialisation:
gutenberg/packages/blocks/src/api/serializer.js
Lines 391 to 396 in 276d336
I believe that condition should be amended in the same way:
// For compatibility, treat a post consisting of a
// single freeform block as legacy content and apply
// pre-block-editor removep'd content formatting.
if (
blocks.length === 1 &&
blocks[ 0 ].name === getFreeformContentHandlerName()
+ blocks[ 0 ].name !== 'core/html'
) {
content = removep( content );
}
| @@ -101,6 +101,7 @@ export function normalizeRawBlock( rawBlock, options ) { | |||
| // meaning there are no negative consequences to repeated autop calls. | |||
| if ( | |||
| rawBlockName === fallbackBlockName && | |||
| rawBlockName !== 'core/html' && | |||
There was a problem hiding this comment.
This makes sense. I dare say this could even be rawBlockName === 'core/freeform' — to me, autop and freeform go together as descendants of WP's original simplified approach to post_content, where any block of text would be interpreted as a P tag. In other words, I can't think of a scenario with any block type other than freeform that would want autop.
|
Thanks for the review and feedback @mcsf! Doing a check for I've updated this PR now. I also needed to update a fair few tests that referred to |
|
Thanks for working on this @andrewserong If it's all good with @mcsf, then it LGTM!
|
andrewserong
force-pushed
the
fix/autop-insertion-in-site-editor-templates
branch
from
328902e
to
4c01a3b
Compare
ntsekouras
approved these changes
Jul 19, 2023
|
Thanks folks! 🙇 |
andrewserong
added
the
Backport to WP Beta/RC
tellthemachines
pushed a commit
that referenced
this pull request
Jul 24, 2023
…set to core/html (#52716) * Parse / Site Editor: Ensure autop is not run when freeform block is set to core/html * Switch to equals freeform instead of not equals core/html * Rename core/test-freeform to core/freeform in tests
|
I just cherry-picked this PR to the update/packages-RC2 branch to get it included in the next release: 790b744 |
tellthemachines
removed
the
Backport to WP Beta/RC
Merged
tellthemachines
added a commit
that referenced
this pull request
Jul 24, 2023
* Filter out patterns that are not allowed in the inserter (#52675) * Remove autofocus and improve placeholder text consistency. (#52634) * Do not navigate to the styles pages unless you're in a random listing page (#52728) * Patterns: Don't override the rootClientID in create menu - only set if undefined (#52713) * Footnotes: store in revisions (#52686) * Fix: Block toolbar obscuring document tools when Top Toolbar is enabled (#52722) * Update toolbar width * Site editor needs specific width * fixes top toolbar width for post editor when not in fullscreen * remove the body rule --------- Co-authored-by: Andrei Draganescu <andrei.draganescu@automattic.com> * Site Editor: Fix site link accessibility issues (#52744) * Add id to pattern inserted notice to stop multiple notices stacking (#52746) * Global Styles: Don't use named arguments for 'sprintf' (#52782) * Footnotes: Use static closures when not using '' (#52781) * removes check for active preview device type to enable the fixed toolbar preference (#52770) * Parser / Site Editor: Ensure autop is not run when freeform block is set to core/html (#52716) * Parse / Site Editor: Ensure autop is not run when freeform block is set to core/html * Switch to equals freeform instead of not equals core/html * Rename core/test-freeform to core/freeform in tests * Adding @SInCE annotation for relevant 6.3 changes. (#52820) * Navigation: Load the raw property on the navigation fallback (#52758) * Navigation: Load the raw property on the navigation fallback * Update lib/compat/wordpress-6.3/navigation-fallback.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update lib/compat/wordpress-6.3/navigation-fallback.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Add a test for these properties * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * Update phpunit/class-gutenberg-rest-navigation-fallback-controller-test.php Co-authored-by: Dave Smith <getdavemail@gmail.com> * add more comments * add necessary method * Fix php coding standards error --------- Co-authored-by: Dave Smith <getdavemail@gmail.com> Co-authored-by: Jerry Jones <jones.jeremydavid@gmail.com> * Allow styles to be changed dynamically through editor settings (#52767) * ResizableFrame: Fix styling in Firefox (#52700) * ResizableFrame: Fix styling in Firefox * Remove unused class * Patterns: Fix empty general template parts category (#52747) --------- Co-authored-by: Glen Davies <glen.davies@automattic.com> --------- Co-authored-by: Carolina Nymark <myazalea@hotmail.com> Co-authored-by: Andrea Fercia <a.fercia@gmail.com> Co-authored-by: Riad Benguella <benguella@gmail.com> Co-authored-by: Glen Davies <glendaviesnz@users.noreply.github.com> Co-authored-by: Ella <4710635+ellatrix@users.noreply.github.com> Co-authored-by: James Koster <james@jameskoster.co.uk> Co-authored-by: Andrei Draganescu <andrei.draganescu@automattic.com> Co-authored-by: George Mamadashvili <georgemamadashvili@gmail.com> Co-authored-by: Andrei Draganescu <me@andreidraganescu.info> Co-authored-by: Andrew Serong <14988353+andrewserong@users.noreply.github.com> Co-authored-by: Ramon <ramonjd@users.noreply.github.com> Co-authored-by: Ben Dwyer <ben@scruffian.com> Co-authored-by: Dave Smith <getdavemail@gmail.com> Co-authored-by: Jerry Jones <jones.jeremydavid@gmail.com> Co-authored-by: Lena Morita <lena@jaguchi.com> Co-authored-by: Kai Hao <kevin830726@gmail.com> Co-authored-by: Glen Davies <glen.davies@automattic.com>
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?
Possible fix for #49166
If the freeform block for the editor is set to
core/html, skip runningautopon raw parsed blocks. To achieve this, this PR now runsautoponly when the freeform block is set tocore/freeform(the Classic block).This should hopefully resolve an issue where custom HTML added to a template would receive unexpected
<p>and<br>tags.Why?
Back in #48129, the site editor was updated to set
setFreeformFallbackBlockNametocore/htmlso that freeform content would be treated as an HTML block. However, innormalizeRawBlockraw content matching the fallback block name gets run throughautopto automatically addpandbrtags. From context, I believe this is to ensure that Classic blocks in post content correctly receive paragraph and break tags and such. In the site editor / when editing templates, I believe this is not required or expected, especially now that freeform content is treated as HTML blocks.How?
In the parser's
normalizeRawBlockfunction, only applyautopwhen the freeform block is set tocore/freeform, so that editors that usecore/htmldo not unexpectedly include automatically insertedpandbrtags.Update tests that relate to the freeform block behaviour so that they use the string
core/freeformfor the block name for consistency (and to catch the expected default behaviour).Testing Instructions
<p>tags in your Custom HTML. With this PR applied, after saving and reloading the template, there should not be extra<p>tags added to the Custom HTML.Example markup to use:
Screenshots or screencast