Add widget id to blocks in the widgets screen #28379
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
kevin940726
added
[Type] Bug
|
Size Change: -81 B (0%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
noisysocks
reviewed
Jan 22, 2021
youknowriad
reviewed
Jan 22, 2021
| @@ -134,13 +100,15 @@ export function createBlocksFromInnerBlocksTemplate( | |||
| export function cloneBlock( block, mergeAttributes = {}, newInnerBlocks ) { | |||
| const clientId = uuid(); | |||
|
|
|||
| const sanitizedAttributes = sanitizeBlockAttributes( block.name, { | |||
There was a problem hiding this comment.
The addition of sanitize could potentially have a small performance impact (not sure if noticeable), the other thing is that it was not an expectation of cloneBock and I hope it doesn't produce unexpected side effects
There was a problem hiding this comment.
Does running npm run test-performance with and without this PR demonstrate any performance regression?
| ...block, | ||
| attributes: { | ||
| ...( block.attributes || {} ), | ||
| __internalWidgetId: widgetId, |
There was a problem hiding this comment.
It's a bit weird that we add an attribute that is not registered. I'm fine with it but I hope it's something that can break if for some reason, in the future, we apply the same "sanitizeAttributes" behavior in flows where it's not applied right now.
Let's make sure we've tests to cover this.
There was a problem hiding this comment.
I'm fine with it but I hope it's something that can break if for some reason, in the future, we apply the same "sanitizeAttributes" behavior in flows where it's not applied right now.
I'm not sure what you meant by that? What kind of tests you have in mind?
There was a problem hiding this comment.
Not particular tests in my mind, this is meant to fix widgets updating if I'm not wrong, let's just make sure it's covered because it can easily break.
kevin940726
requested review from
adamziel,
ajitbohra,
draganescu,
ellatrix,
nerrad,
ntwb and
tellthemachines
as code owners
kevin940726
force-pushed
the
try/add-widget-id-to-blocks
branch
from
e1ea247 to
46003d8
Compare
noisysocks
reviewed
Jan 27, 2021
|
|
||
| return state || {}; | ||
| } | ||
|
|
| ...block.attributes, | ||
| ...mergeAttributes, | ||
| }, | ||
| attributes: sanitizedAttributes, |
There was a problem hiding this comment.
Could you please add a new unit test for cloneBlock() which tests that attributes are sanitised? (And, maybe while you're at it, double check that createBlock() has one.)
|
Let's document this change of |
noisysocks
added
the
Needs Dev Note
noisysocks
approved these changes
Jan 27, 2021
6 tasks
7 tasks
6 tasks
15 tasks
youknowriad
removed
the
Needs Dev Note
7 tasks
8 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
Mentioned in this Slack thread. Basically, this PR tries to fix a saving issue in the widgets screen after merging #27885 (comment). The recap was well documented in a Slack thread comment.
The solution is to inject
__internalWidgetIdto all blocks in the widgets screen but not in their block types attributes, and modify thecloneBlockfunction to only clone attributes specified inside the block types (following the same logic increateBlock).This PR also partially reverts #28078, specifically the
__unstableCloneValuehack.How has this been tested?
Types of changes
Breaking change
Checklist: