Add/rest api for block commenting #65181

poojabhimani12 · 2024-09-10T06:25:16Z

What?

Add Rest API for Block Level Comment

Why?

This PR updates the REST API to support our custom comment type, 'block_comment.' Previously, only the default 'comment' type was supported. We've developed the comment API endpoint in Gutenberg to enable block-based commenting, providing greater flexibility for managing comments within the block editor.

…add/rest-api-for-block-commenting

…commenting Add Rest api filters for block commenting

github-actions · 2024-09-10T06:25:30Z

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: tyxla <[email protected]>
Co-authored-by: ellatrix <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: TimothyBJacobs <[email protected]>
Co-authored-by: spacedmonkey <[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-09-10T06:25:46Z

👋 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.

youknowriad · 2024-09-10T07:33:00Z

Thanks for splitting the PRs, that's really helpful.

I'm adding @TimothyBJacobs here for his expertise on the REST API. I know @tyxla had some comments on the other thread as well about the REST API.

It would be cool to add some php unit tests to clarify what these changes are about, and maybe consider adding some context to the PR description.

tyxla

Thanks for splitting this one out to a separate PR 🙌

From my perspective, this mostly looks good and is close enough!

Passing the latest feedback over to this PR, and adding some more let me know what you think.

tyxla · 2024-09-10T12:33:41Z

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

+
+		return $response;
+	}
+	add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7', 10, 1 );


As also mentioned in #60622:

This will only work when retrieving comments via the REST API. If we want to retrieve them on the backend, it won't work.

I'm trying to understand why get_comment will set the avatar URL to null (as mentioned here). A few possibilities come to mind:

is it because the show_avatars option is not enabled?

is it because the author_avatar_urls field is not enabled when performing the REST API request?

Can you speak more about where this assignment to null happens?

In any case, to achieve what you're doing it should be enough to just use the rest_avatar_sizes filter and the rest_get_avatar_urls() function would build the avatar URLs properly. If we're just doing it for the REST API response, we're doing it in an inconsistent way which is likely to introduce unexpected bugs and missing data in unexpected places.

The issue has been resolved. We found that the REST API was returning a null avatar URL because it only supported the default 'comment' type while we were using a custom type.

To fix this, we applied the get_avatar_comment_types filter to include our custom comment type, 'block_comment'. This allowed us to remove the rest_prepare_comment filter, and the issue is now resolved.

Great, thanks 🙌

tyxla · 2024-09-10T12:35:34Z

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

+
+		return $prepared_comment;
+	}
+	add_filter( 'rest_pre_insert_comment', 'update_comment_type_in_rest_api_6_7', 10, 2 );


Thanks for reconsidering the previous approach of updating the comment during a REST request 🙌

Using rest_pre_insert_comment works OK if you always want to do it only through the REST API.

I acknowledge it doesn't make sense to use rest_preprocess_comment because the comment_type and comment_approved fields will be overridden automatically after that.

However, if you want this to work through any interface or flow that updates the comments, you might want to use the wp_update_comment_data filter instead.

When a comment is submitted, whether it's a custom comment type or the default, comments from registered users will automatically be marked as "approved." For comments that need moderation, set their status to "on hold" initially. After review, you can update the status from "on hold" to "approved" as needed.

Thanks for clarifying that part @poojabhimani12.

I don't understand why we're doing it only when inserting a comment via the REST API. Wouldn't it be a better idea to do it consistently when a comment is inserted/updated?

The Comment REST API currently only allows inserting default comment types. If you try to use a custom comment type, it returns an incorrect comment type error.

To resolve this, a filter must be applied to include custom comment types in the REST API. However, no filter is needed when using the comment insert function, as it already supports the insertion of custom comment types.

This makes sense; thanks a lot for elaborating 🙌

tyxla · 2024-09-10T12:37:30Z

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

+if ( ! function_exists( 'update_comment_type_in_rest_api_6_7' ) && gutenberg_is_experiment_enabled( 'gutenberg-block-comment' ) ) {
+	function update_comment_type_in_rest_api_6_7( $prepared_comment, $request ) {
+		if ( ! empty( $request['comment_type'] ) && 'block_comment' === $request['comment_type'] ) {
+			$prepared_comment['comment_type']     = $request['comment_type'];


You might want to extend the admin_comment_types_dropdown filter to allow users to filter in the admin interface by the new comment_type that you're introducing. Unless you want to intentionally hide those comments from the interface.

Why not always allow there properties to be set and avoid hardcoding the comment type?

tyxla · 2024-09-10T12:39:24Z

lib/experiments-page.php

+		'gutenberg-experiments',
+		'gutenberg_experiments_section',
+		array(
+			'label' => __( 'Enable multi-user commenting on blocks in post editor', 'gutenberg' ),


You might want to consider this prior feedback:

#60622 (comment)

Perhaps it can be reflected in the experiment title?

We’ve made this update based on the feedback provided here: #60622 (comment).

I don't think we should be adding this setting here, and hardcode the comment type. We should generalise it to work either with all comment types, or add an (experimental) option/setting to the comment type registration and use that setting (instead of hardcoding anything).

tyxla · 2024-09-10T12:46:38Z

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

+
+		return $response;
+	}
+	add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7', 10, 1 );


Priority 10 and 1 accepted arguments are the defaults for add_filter(), so they can be omitted.

Suggested change

add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7', 10, 1 );

add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7' );

…k-commenting update get avatar url rest-api filter

tyxla · 2024-09-10T13:27:44Z

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

+        return $comment_type;
+
+    }
+    add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type', 10, 1 );


Aside from the spacing issues which I'm assuming you're addressing separately, the trailing arguments aren't necessary because they're the defaults:

Suggested change

add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type', 10, 1 );

add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type' );

tyxla · 2024-09-10T13:30:21Z

It would be cool to add some php unit tests to clarify what these changes are about, and maybe consider adding some context to the PR description.

I also think some basic unit tests would be useful to have here. The logic is straightforward, so I don't assume the tests to be complicated.

…k-commenting Extend the admin_comment_types_dropdown filter

…k-commenting added unit test cases for filter functions

…k-commenting remove spacing from unit testing file

…k-commenting resolve phpcs error from unit test file

…k-commenting resolve phpcs error in unit test file

TimothyBJacobs · 2024-09-11T18:06:24Z

Using the existing comments controller like this is I think sufficient for an experiment. But we most likely are going to want to treat this more like post types, where different comment types are at different routes.

spacedmonkey · 2024-09-11T20:09:10Z

Using the existing comments controller like this is I think sufficient for an experiment. But we most likely are going to want to treat this more like post types, where different comment types are at different routes.

I am not sure if we need a new endpoint here. Adding support for this comment type for the existing endpoint makes sense to me.

ellatrix · 2024-09-23T21:10:19Z

lib/experimental/editor-settings.php

@@ -28,6 +28,9 @@ function gutenberg_enable_experiments() {
 	if ( gutenberg_is_experiment_enabled( 'gutenberg-full-page-client-side-navigation' ) ) {
 		wp_add_inline_script( 'wp-block-library', 'window.__experimentalFullPageClientSideNavigation = true', 'before' );
 	}
+	if ( $gutenberg_experiments && array_key_exists( 'gutenberg-block-comment', $gutenberg_experiments ) ) {
+		wp_add_inline_script( 'wp-block-editor', 'window.__experimentalEnableBlockComment = true', 'before' );


Why do we need this flag in this PR?

ellatrix · 2024-09-23T21:20:10Z

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

+			'block_comment' => __( 'Block Comments' ),
+		);
+	}
+	add_filter( 'admin_comment_types_dropdown', 'update_comment_type_filter_dropdown' );


Why do we need to add this comment type to the comment management list? Comments are managed in the editor?

We have incorporated the comment type into the backend comment page filter based on the feedback received: #65181 (comment).

How is this related to the REST API?

…hah-multidots/gutenberg into add/rest-api-for-block-commenting

…k-commenting remove experimental flag from this PR

…k-commenting remove filters from rest API PR

…k-commenting-conflict-resolve Add/rest api for block commenting conflict resolve

MD-sunilprajapati and others added 5 commits September 9, 2024 19:02

Add rest api filter for block comments

2bf37e7

Merge branch 'poojabhimani12:add/rest-api-for-block-commenting' into …

635b3ba

…add/rest-api-for-block-commenting

Add experimental setting option to enable block comments

e0dc011

Merge pull request #48 from MD-sunilprajapati/add/rest-api-for-block-…

ff09cfc

…commenting Add Rest api filters for block commenting

Merge branch 'WordPress:trunk' into add/rest-api-for-block-commenting

764734b

poojabhimani12 requested a review from spacedmonkey as a code owner September 10, 2024 06:25

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

tyxla reviewed Sep 10, 2024

View reviewed changes

rishishah-multidots and others added 2 commits September 10, 2024 18:39

update get avatar url rest-api filter

eb853d5

Merge pull request #53 from rishishah-multidots/add/rest-api-for-bloc…

ff26fdf

…k-commenting update get avatar url rest-api filter

tyxla reviewed Sep 10, 2024

View reviewed changes

rishishah-multidots and others added 13 commits September 10, 2024 19:07

update comment type dropdown filter to support block_comment type

b68bcfc

update comment type dropdown filter to support block_comment type

a0056b8

update function document

4bc0128

Merge pull request #54 from rishishah-multidots/add/rest-api-for-bloc…

a4d3033

…k-commenting Extend the admin_comment_types_dropdown filter

added unit test cases for filter functions

400e32b

Merge pull request #55 from rishishah-multidots/add/rest-api-for-bloc…

bcc7803

…k-commenting added unit test cases for filter functions

remove spacing from unit testing file

744a225

Merge pull request #56 from rishishah-multidots/add/rest-api-for-bloc…

6e2128a

…k-commenting remove spacing from unit testing file

remove spacing from unit testing file

ba71390

Merge pull request #57 from rishishah-multidots/add/rest-api-for-bloc…

0f62c79

…k-commenting resolve phpcs error from unit test file

resolve phpcs error in unit test file

7f6ab7e

resolve phpcs error in unit test file

ed7fce1

Merge pull request #58 from rishishah-multidots/add/rest-api-for-bloc…

4aa22aa

…k-commenting resolve phpcs error in unit test file

ellatrix added the [Type] Enhancement A suggestion for improvement. label Sep 23, 2024

ellatrix reviewed Sep 23, 2024

View reviewed changes

ellatrix mentioned this pull request Sep 23, 2024

Add Inline comment experimental flag #60622

Open

rishishah-multidots and others added 7 commits September 24, 2024 16:40

remove experimental flag from this PR

21b6653

Merge branch 'add/rest-api-for-block-commenting' of github.com:rishis…

9d20007

…hah-multidots/gutenberg into add/rest-api-for-block-commenting

Merge pull request #62 from rishishah-multidots/add/rest-api-for-bloc…

8ba3370

…k-commenting remove experimental flag from this PR

remove filters from rest API PR

35e73ff

Merge pull request #63 from rishishah-multidots/add/rest-api-for-bloc…

945ccb7

…k-commenting remove filters from rest API PR

resolve conflict

8876b70

Merge pull request #66 from rishishah-multidots/add/rest-api-for-bloc…

bba1771

…k-commenting-conflict-resolve Add/rest api for block commenting conflict resolve

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add/rest api for block commenting #65181

Add/rest api for block commenting #65181

poojabhimani12 commented Sep 10, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024

youknowriad commented Sep 10, 2024

tyxla left a comment

tyxla Sep 10, 2024

poojabhimani12 Sep 10, 2024

tyxla Sep 10, 2024

tyxla Sep 10, 2024

poojabhimani12 Sep 10, 2024

tyxla Sep 10, 2024

poojabhimani12 Sep 11, 2024

tyxla Sep 11, 2024

tyxla Sep 10, 2024

ellatrix Sep 23, 2024

tyxla Sep 10, 2024

poojabhimani12 Sep 10, 2024

ellatrix Sep 23, 2024

tyxla Sep 10, 2024

tyxla Sep 10, 2024

tyxla commented Sep 10, 2024

TimothyBJacobs commented Sep 11, 2024

spacedmonkey commented Sep 11, 2024

ellatrix Sep 23, 2024

ellatrix Sep 23, 2024

poojabhimani12 Sep 24, 2024

ellatrix Sep 24, 2024

	add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7', 10, 1 );
	add_filter( 'rest_prepare_comment', 'add_user_avatar_urls_in_rest_response_6_7' );

	add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type', 10, 1 );
	add_filter( 'get_avatar_comment_types', 'update_get_avatar_comment_type' );

Add/rest api for block commenting #65181

Are you sure you want to change the base?

Add/rest api for block commenting #65181

Conversation

poojabhimani12 commented Sep 10, 2024 • edited Loading

What?

Why?

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

github-actions bot commented Sep 10, 2024

youknowriad commented Sep 10, 2024

tyxla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tyxla commented Sep 10, 2024

TimothyBJacobs commented Sep 11, 2024

spacedmonkey commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

poojabhimani12 commented Sep 10, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024 •

edited

Loading