Link editing: Account for link anchor no longer being present when generating unique link instance key #36357
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
getdave
added
[Type] Bug
getdave
requested review from
cameronvoell,
ellatrix and
guarani
as code owners
getdave
commented
Nov 9, 2021
| @@ -17,6 +17,9 @@ function getKey( _id ) { | |||
| * @return {string} the unique key to use for this link control. | |||
| */ | |||
| function useLinkInstanceKey( instance ) { | |||
| if ( ! instance ) { | |||
There was a problem hiding this comment.
This can be null or a anchorRef. So we need to avoid the null case.
There was a problem hiding this comment.
Could we add a comment above to explicitly state that we're returning a undefined here on purpose?
There was a problem hiding this comment.
Apologies @kevin940726, I just missed your comment here before I hit "merge". I was perhaps over-eager to get this fix in, in time for the 11.9 release!
There was a problem hiding this comment.
No worries 👍 , it's more like a nitpick anyway :).
|
Size Change: 0 B Total Size: 1.08 MB ℹ️ View Unchanged
|
andrewserong
approved these changes
Nov 10, 2021
andrewserong
force-pushed
the
fix/link-ui-instance-key
branch
from
3399a71 to
a9cc4ff
Compare
|
I've just given this a rebase to get the tests passing. |
andrewserong
changed the title
andrewserong
pushed a commit
that referenced
this pull request
Nov 10, 2021
|
Cherry picked into the Gutenberg 11.9 release in: 3c11b5e |
|
Thanks @andrewserong (and @kevin940726!) 👏 |
noisysocks
removed
the
Backport to WP 6.7 Beta/RC
noisysocks
pushed a commit
that referenced
this pull request
Nov 11, 2021
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
In #34742 we used the unique anchor reference of each link in rich text to force remount the Link UI when moving between links (see that PR for why this was done).
Unfortunately, I forgot to account for instances where the anchor has been removed. This caused a
nullvalue to be set as the key of aWeakMapthus triggering a JS error.In such cases we should not attempt to generate a unique link key and instead should bale out of the function. This causes the
keyprop on<LinkControl>to benulland thus not be set.How has this been tested?
Screenshots
Types of changes
Checklist:
*.native.jsfiles for terms that need renaming or removal).