Add Inline comment experimental flag #60622

poojabhimani12 · 2024-04-10T06:18:10Z

What?

Introducing the "Block Comment" experiment, with added functionality accessible via this feature flag which when enabled, allows users to add comments to the selected block by clicking on "comment" icon in the toolbar dropdown.

Why?

#59445

How?

Testing Instructions

Enable the Block Comment experiment
Insert any block
Click on the block settings dropdown from the block toolbar
Click the comment icon in the toolbar and add comment.

Screenshots or screencast

Current state:

Earlier iterations:

demo.webm

github-actions · 2024-04-10T06:18:24Z

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: MD-sunilprajapati <[email protected]>
Co-authored-by: poojabhimani12 <[email protected]>
Co-authored-by: rishishah-multidots <[email protected]>
Co-authored-by: ingeniumed <[email protected]>
Co-authored-by: ellatrix <[email protected]>
Co-authored-by: tyxla <[email protected]>
Co-authored-by: ciampo <[email protected]>
Co-authored-by: mtias <[email protected]>
Co-authored-by: jasmussen <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: annezazu <[email protected]>
Co-authored-by: jameskoster <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2024-04-10T06:18:39Z

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @poojabhimani12! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

ingeniumed · 2024-05-29T15:39:00Z

The following is a summary of the discussion that was had with @ellatrix, that's being posted by me for posterity.

In order to be able to test this feature end to end, this PR would need to be updated to add the ability to save comments as well. As a result, the following will need to be be done as the next steps:

Update the PR with the data model proposed here so that it actually persists everything. That way, you can see it working end to end.
Once this PR is merged in, keep an eye on the feature to see what sort of feedback is coming. Make any changes relevant to the feedback.
After sometime, put up a PR to drop the experimental flag so that it can ship in the next WP release - ideally 6.7

Block commenting feature

…line-block-commenting

revert the changes

…ting Fix linting errors

poojabhimani12 · 2024-06-12T10:22:44Z

The following is a summary of the discussion that was had with @ellatrix, that's being posted by me for posterity.

In order to be able to test this feature end to end, this PR would need to be updated to add the ability to save comments as well. As a result, the following will need to be be done as the next steps:

Update the PR with the data model proposed here so that it actually persists everything. That way, you can see it working end to end.

Once this PR is merged in, keep an eye on the feature to see what sort of feedback is coming. Make any changes relevant to the feedback.

After sometime, put up a PR to drop the experimental flag so that it can ship in the next WP release - ideally 6.7

I have updated the PR as proposed above. Please review it and provide any feedback.

ingeniumed

Noticed while testing this using playground and wp-now that the block comments are enabled by default, regardless of the checkbox being selected or not. In addition, the collab sidebar is not visible either.

ingeniumed · 2024-06-13T04:20:36Z

packages/editor/src/components/collab-sidebar/index.js

+		const post = select( editorStore ).getCurrentPost();
+
+		return {
+			threads: post?.meta?.collab ? JSON.parse( post.meta.collab ) : [],


Could this create problem if there's a large enough number of comments on a post? Could it be lazy loaded in some way to work around this problem? Thinking in terms of google docs, you have to scroll both on the page and on the comments dropdown to see all the comments.

We have implemented a feature where the sidebar displays if any comment is open. However, we have now changed the flow so that the sidebar will be visible even if there are no collaborative activities.

We have conducted testing and believe that a large number of comments will not have a significant impact. Once the flow is finalized, we can definitely implement lazy loading.

packages/format-library/package.json

…enting Remove 6.7 rest API and other minor fixes

ellatrix · 2024-10-23T06:46:03Z

packages/editor/src/components/collab-sidebar/comments.js

+		},
+	];
+
+	const moreActions = actions.filter( ( item ) => item.onClick );


actions is constant, so this doesn't filter anything?

ellatrix · 2024-10-23T07:02:35Z

lib/compat/wordpress-6.7/rest-api.php

@@ -115,7 +115,6 @@ function gutenberg_override_default_rest_server() {
 }
 add_filter( 'wp_rest_server_class', 'gutenberg_override_default_rest_server', 1 );

-


Could you remove this line to have a clean change set?

Feedback has been addressed.

…enting Fixes local state changes

…enting Fix static lint issue

ellatrix · 2024-10-23T09:12:55Z

packages/editor/src/components/collab-sidebar/index.js

+				status: 'any',
+				per_page: 100,
+			} );
+			return Array.isArray( data ) ? data : [];


We shouldn't create a new array inside useSelect, it will create excessive re-renders. useSelect will think there's change. Can you create an EMTPY_ARRY constant outside this component. Same for the early return above.

Alternatively, let it return null and move the array checks outside of useSelect.

packages/editor/src/components/collab-sidebar/index.js

…enting made changes with useSelect

…enting Address empty array feedback Co-authored-by: rishishah-multidots <[email protected]>

…enting define empty array outside the component

…enting made changes to compatible with FSE

…enting restore thread code

…enting fix lint error

ellatrix

Ok, there's a number of things that should be addressed in a follow-up, but let's start with this.

mtias · 2024-10-24T09:45:29Z

Kudos all for driving this one!

andrewserong · 2024-10-29T22:41:39Z

Fantastic work here, this is so exciting to see! 🎉 I've just done a tiny update to the PR description and added another screenshot as I missed at first that the Comments button had been moved to the block settings menu. Hope you don't mind!

Co-authored-by: MD-sunilprajapati <[email protected]> Co-authored-by: poojabhimani12 <[email protected]> Co-authored-by: rishishah-multidots <[email protected]> Co-authored-by: ingeniumed <[email protected]> Co-authored-by: ellatrix <[email protected]> Co-authored-by: tyxla <[email protected]> Co-authored-by: ciampo <[email protected]> Co-authored-by: mtias <[email protected]> Co-authored-by: jasmussen <[email protected]> Co-authored-by: youknowriad <[email protected]> Co-authored-by: annezazu <[email protected]> Co-authored-by: jameskoster <[email protected]>

poojabhimani12 requested review from spacedmonkey and ellatrix as code owners April 10, 2024 06:18

github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Apr 10, 2024

poojabhimani12 marked this pull request as draft April 10, 2024 06:20

poojabhimani12 marked this pull request as ready for review May 16, 2024 04:49

poojabhimani12 requested review from fluiddot and dcalhoun as code owners May 16, 2024 04:49

cbravobernal added the [Type] Experimental Experimental feature or API. label May 16, 2024

poojabhimani12 requested a review from ajitbohra as a code owner June 5, 2024 06:42

poojabhimani12 marked this pull request as draft June 7, 2024 05:34

MD-sunilprajapati and others added 9 commits June 10, 2024 11:48

Update comment functionality and reformating code

10c9ed0

remove style import

271895a

Merge pull request #8 from MD-sunilprajapati/try/inline-block-commenting

f2b7114

Block commenting feature

revert the changes

5e0890c

resolved conflicts

031e8d5

Merge branch 'poojabhimani12:try/inline-block-commenting' into try/in…

6b0c3b3

…line-block-commenting

Adjust spacing between icons

d2d6215

Merge pull request #9 from MD-sunilprajapati/try/inline-block-commenting

cbee86f

revert the changes

resolved conflicts

b36c2ab

poojabhimani12 marked this pull request as ready for review June 10, 2024 11:46

MD-sunilprajapati and others added 2 commits June 11, 2024 16:04

Fix linting errors

b7b1ba4

Merge pull request #10 from MD-sunilprajapati/try/inline-block-commen…

6c0862d

…ting Fix linting errors

ingeniumed reviewed Jun 13, 2024

View reviewed changes

MD-sunilprajapati added 3 commits June 13, 2024 11:10

Add experimental condition

77ee009

Show sidebar on zero comments

a8ea60e

Add package lock

ec302ff

Merge pull request #85 from rishishah-multidots/try/inline-block-comm…

ca54345

…enting Remove 6.7 rest API and other minor fixes

ellatrix reviewed Oct 23, 2024

View reviewed changes

rishishah-multidots and others added 4 commits October 23, 2024 13:55

made changes as per the feedback

2e212c1

Merge pull request #86 from rishishah-multidots/try/inline-block-comm…

4b8986b

…enting Fixes local state changes

made changes as per the feedback

b42cd97

Merge pull request #87 from rishishah-multidots/try/inline-block-comm…

30ddf61

…enting Fix static lint issue

ellatrix reviewed Oct 23, 2024

View reviewed changes

packages/editor/src/components/collab-sidebar/index.js Outdated Show resolved Hide resolved

rishishah-multidots and others added 13 commits October 23, 2024 15:50

made changes as per the feedback

e446297

made changes as per the feedback

1955469

Merge pull request #88 from rishishah-multidots/try/inline-block-comm…

22893f8

…enting made changes with useSelect

made changes as per the feedback

b89ce85

Merge pull request #89 from rishishah-multidots/try/inline-block-comm…

3f9d745

…enting Address empty array feedback Co-authored-by: rishishah-multidots <[email protected]>

define empty array outside the component

90b038b

Merge pull request #90 from rishishah-multidots/try/inline-block-comm…

b7c0c46

…enting define empty array outside the component

made changes to compatible with FSE

48c3351

Merge pull request #91 from rishishah-multidots/try/inline-block-comm…

7c00570

…enting made changes to compatible with FSE

made changes to compatible with FSE

047e07f

Merge pull request #92 from rishishah-multidots/try/inline-block-comm…

a342e27

…enting restore thread code

fix lint error

ae50d7a

Merge pull request #93 from rishishah-multidots/try/inline-block-comm…

2ca51c3

…enting fix lint error

ellatrix approved these changes Oct 23, 2024

View reviewed changes

ellatrix mentioned this pull request Oct 23, 2024

Inline Commenting: Next iteration #66377

Open

ellatrix merged commit a775b7c into WordPress:trunk Oct 23, 2024
63 checks passed

github-actions bot added this to the Gutenberg 19.6 milestone Oct 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Inline comment experimental flag #60622

Add Inline comment experimental flag #60622

poojabhimani12 commented Apr 10, 2024 •

edited by andrewserong

Loading

github-actions bot commented Apr 10, 2024 •

edited

Loading

github-actions bot commented Apr 10, 2024

ingeniumed commented May 29, 2024

poojabhimani12 commented Jun 12, 2024

ingeniumed left a comment

ingeniumed Jun 13, 2024

poojabhimani12 Jun 13, 2024

poojabhimani12 Jun 13, 2024

ellatrix Oct 23, 2024

ellatrix Oct 23, 2024

ellatrix Oct 23, 2024

ellatrix Oct 23, 2024

ellatrix left a comment

mtias commented Oct 24, 2024

andrewserong commented Oct 29, 2024

		@@ -115,7 +115,6 @@ function gutenberg_override_default_rest_server() {
		}
		add_filter( 'wp_rest_server_class', 'gutenberg_override_default_rest_server', 1 );

Add Inline comment experimental flag #60622

Add Inline comment experimental flag #60622

Conversation

poojabhimani12 commented Apr 10, 2024 • edited by andrewserong Loading

What?

Why?

How?

Testing Instructions

Screenshots or screencast

github-actions bot commented Apr 10, 2024 • edited Loading

github-actions bot commented Apr 10, 2024

ingeniumed commented May 29, 2024

poojabhimani12 commented Jun 12, 2024

ingeniumed left a comment

Choose a reason for hiding this comment

ingeniumed Jun 13, 2024

Choose a reason for hiding this comment

poojabhimani12 Jun 13, 2024

Choose a reason for hiding this comment

poojabhimani12 Jun 13, 2024

Choose a reason for hiding this comment

ellatrix Oct 23, 2024

Choose a reason for hiding this comment

ellatrix Oct 23, 2024

Choose a reason for hiding this comment

ellatrix Oct 23, 2024

Choose a reason for hiding this comment

ellatrix Oct 23, 2024

Choose a reason for hiding this comment

ellatrix left a comment

Choose a reason for hiding this comment

mtias commented Oct 24, 2024

andrewserong commented Oct 29, 2024

poojabhimani12 commented Apr 10, 2024 •

edited by andrewserong

Loading

github-actions bot commented Apr 10, 2024 •

edited

Loading