Inline Commenting: Avoid querying comments on editor load #66670
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
Mamaduka
added
[Type] Performance
Mamaduka
commented
Nov 1, 2024
| defaultAvatar: __experimentalDiscussionSettings?.avatarURL, | ||
| clientId: selectedBlock?.clientId, | ||
| blockCommentId: selectedBlock?.attributes?.blockCommentId, | ||
| showAddCommentBoard: showCommentBoard, |
There was a problem hiding this comment.
Not sure why this prop was passed around in mapSelect. It shouldn't be required.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Mamaduka
commented
Nov 1, 2024
| }; | ||
| }, [] ); | ||
|
|
||
| // Get the dispatch functions to save the comment and update the block attributes. | ||
| const { getSelectedBlockClientId } = useSelect( blockEditorStore ); |
There was a problem hiding this comment.
The clientId is now only used in event callback; we can use the static getter.
Mamaduka
commented
Nov 1, 2024
| @@ -98,7 +76,7 @@ export default function CollabSidebar() { | |||
| const compare = {}; | |||
| const result = []; | |||
|
|
|||
| const filteredComments = threads.filter( | |||
| const filteredComments = ( threads ?? [] ).filter( | |||
There was a problem hiding this comment.
A suggestion from previous refactoring - #66592 (comment).
Mamaduka
commented
Nov 1, 2024
Comment on lines
+278
to
+280
| const AddCommentComponent = blockCommentId | ||
| ? AddCommentToolbarButton | ||
| : AddCommentButton; |
There was a problem hiding this comment.
Personal nit and simplification 😅
Mamaduka
commented
Nov 1, 2024
| <PluginSidebar | ||
| identifier={ collabSidebarName } | ||
| // translators: Comments sidebar title | ||
| title={ __( 'Comments' ) } | ||
| icon={ commentIcon } | ||
| > | ||
| <div className="editor-collab-sidebar-panel"> | ||
| <AddComment | ||
| threads={ resultComments } |
There was a problem hiding this comment.
This value was never used, so I've removed it above.
ellatrix
approved these changes
Nov 1, 2024
|
Size Change: -11 B (0%) Total Size: 1.81 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in fc2487b. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11627378030
|
|
To consider: unresolved comments should still be displayed on load not just when toggling the sidebar view. |
|
@mtias that probably should be part of larger refactoring. But even based on the latest mockups, all comments seem to be contained in the sidebar. |
|
Yeah, I think those mockups are missing the main use case |
|
I'm going to merge this. Optimizations in this PR don't change the way block comments are rendered. |
6 tasks
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
…66670) Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org>
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?
I've updated the collab sidebar to only load comments when it's displayed instead of fetching them when opening the editor. Previously, a query was also made even when the experiment was disabled.
Why?
Unnecessary queries can negatively affect the editor's performance.
How?
Testing Instructions
Testing Instructions for Keyboard
Same.
Screenshot