Scripts: Optimize updating render paths when developing blocks #51162
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
[Package] Scripts
|
Size Change: -16 B (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
gziolo
requested review from
ntwb,
nerrad,
ajitbohra and
ryanwelcher
as code owners
artemiomorales
pushed a commit
to artemiomorales/gutenberg
that referenced
this pull request
Jun 2, 2023
…ress#51162) * Scripts: Optimize updating render paths when developing blocks * Add CHANGELOG entry to `@wordpress/scripts` * Update CHANGELOG.md
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
…ress#51162) * Scripts: Optimize updating render paths when developing blocks * Add CHANGELOG entry to `@wordpress/scripts` * Update CHANGELOG.md
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?
Follow-up for #50939.
Previously discussed in #43917 (comment).
The original issue was reported in
The issue got fixed with #50939, but the approach wasn't optimal in terms of performance.
Why?
As correctly pointed out by @luisherranz in #43917 (comment) when developing the feature:
While the fix works, we can improve the performance.
How?
The proposed fix introduces a custom webpack plugin that uses the existing utility
getRenderPropPathsto update the list of detected PHP files in therenderfield defined inblock.jsonfiles. The idea behind it is to use thethisCompilationwebpack hook that alsoCopyWebpackPluginuses when copying files. This way, we can run the logic only once when changes to files on the disk are detected rather than whenever thefiltercallback gets executed for every PHP file living in the source folder.Testing Instructions
It can be tested with the testing instructions from #49790.
I tested it myself by building the custom block using:
npx wp-create-block example-dynamic --no-wp-scripts --variant=dynamicto create a custom dynamic block.cd example-dynamic.../node_modules/.bin/wp-scripts buildto ensure thatsrc/render.phpfile gets copied to thebuildfolder:renderfield fromsrc/block.json.../node_modules/.bin/wp-scripts startto begin development in the watch mode.render.phpfile in thebuildfolder.renderfield to thesrc/block.jsonfile.render.phpfile in thebuildfolder.