REST API: Enhance author details by including additional data when either user_id or site_id are available. #41159

anton-vlasenko · 2025-01-17T14:44:47Z

Fixes #9984

Proposed changes:

Use the wp_comments table as the source of truth if the $author parameter passed to the WPCOM_JSON_API_Endpoint::get_author method is an instance of WP_Comment;
If the WP_Comment instance has a valid user_id, include the first_name, last_name, nice_name, and login fields in the response;
Add the site_id field to the response when a WP_Comment instance is passed to the WPCOM_JSON_API_Endpoint::get_author method.

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Apply the changes from this branch to your WordPress.com development website.
After applying the changes, open the comments page in wp-admin. The request to the public-api.wordpress.com comments endpoint should return complete data about the commenter, including the login, first_name, last_name, and nice_name fields, if the user_id value in the wp_comments table is defined.

Refer to the screenshots below for comparison:

Before the patch:

After the patch:

github-actions · 2025-01-17T14:45:39Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/author-details-are-missing branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/author-details-are-missing

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2025-01-17T14:45:41Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on February 4, 2025).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

…ble.

anton-vlasenko · 2025-01-29T11:53:33Z

Please note that #41254 which was merged last week, adds two optional fields to the response: wpcom_login and wpcom_id. These fields contain similar data to the login and ID fields. However, they only appear if the author_wpcom_data parameter is present in the request.

jeherve

This tests well for me. I have some notes / questions, but no blockers.

jeherve · 2025-01-31T14:08:08Z

projects/plugins/jetpack/class.json-api-endpoints.php

-			$profile_url = 'https://gravatar.com/' . md5( strtolower( trim( $email ) ) );
-			$nice        = '';
-			$site_id     = -1;
+			$id         = ( isset( $author->user_id ) && $author->user_id ) ? $author->user_id : 0;


Since we're here, maybe we can simplify this a bit? It may be an opportunity to cast the return user ID. I don't know if that's necessary, but it may avoid any issues since we check 0 < $id later.

Suggested change

$id = ( isset( $author->user_id ) && $author->user_id ) ? $author->user_id : 0;

$id = ! empty( $author->user_id ) ? (int) $author->user_id : 0;

Thank you for the review, @jeherve.
I didn't want to touch this old code since refactoring wasn't the main goal of my PR. But I absolutely agree — it can and should be simplified.
Fixed in c63354d

jeherve · 2025-01-31T14:13:04Z

projects/plugins/jetpack/class.json-api-endpoints.php

+					$login      = $user->user_login;
+					$first_name = $user->first_name;
+					$last_name  = $user->last_name;
+					$nice       = $user->user_nicename;


Is there any chance that some of those values return an empty string or are not defined at some point?

Thank you for pointing that out. I naively assumed these class properties were declared on the WP_User class — I should have checked. It turns out they are dynamic.
I've added the necessary checks in 9deae9b.
As for whether they can be empty, I think it's fine since this code doesn't replace any existing data but simply augments what's available in the wp_comments table.

github-actions · 2025-01-31T15:54:31Z

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/plugins/jetpack/class.json-api-endpoints.php	239/1258 (19.00%)	1.59%	-15 💚

Full summary · PHP report · JS report

….com/Automattic/jetpack/pull/41159/files#r1937376311).

anton-vlasenko added 2 commits January 17, 2025 15:40

Revert the changes

34749d5

changelog

6297a75

github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Jan 17, 2025

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 17, 2025

anton-vlasenko added 2 commits January 20, 2025 23:54

Add additional user data to the response if a valid user ID is availa…

b3b2384

…ble.

Add a unit test.

0337efc

github-actions bot added the [Tests] Includes Tests label Jan 21, 2025

Fix the failing unit test.

88d52ef

anton-vlasenko added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Jan 21, 2025

anton-vlasenko added 2 commits January 21, 2025 19:24

Update the changelog.

14b387f

Update the changelog.

78bc6a3

anton-vlasenko changed the title ~~Author details are missing.~~ Enhance author details by including additional data when either user_id or site_id are available. Jan 21, 2025

anton-vlasenko changed the title ~~Enhance author details by including additional data when either user_id or site_id are available.~~ REST API: Enhance author details by including additional data when either user_id or site_id are available. Jan 21, 2025

anton-vlasenko marked this pull request as ready for review January 22, 2025 17:34

anton-vlasenko added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jan 23, 2025

anton-vlasenko mentioned this pull request Jan 24, 2025

REST API: Author Details are bare and missing extra data that can be gained from site users. #9984

Closed

anton-vlasenko requested review from jeherve, Addison-Stavlo, mehmoodak and artemiomorales January 29, 2025 11:46

jeherve added [Type] Bug When a feature is broken and / or not performing as intended [Feature] WPCOM API and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jan 31, 2025

jeherve assigned anton-vlasenko Jan 31, 2025

jeherve added the [Pri] Normal label Jan 31, 2025

jeherve previously approved these changes Jan 31, 2025

View reviewed changes

jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 31, 2025

anton-vlasenko dismissed jeherve’s stale review via c192526 January 31, 2025 15:43

Simplify the expression and cast the value to int (per https://github…

c63354d

….com/Automattic/jetpack/pull/41159/files#r1937376311).

anton-vlasenko force-pushed the fix/author-details-are-missing branch from c192526 to c63354d Compare January 31, 2025 16:05

anton-vlasenko added 2 commits January 31, 2025 17:17

Fix the test user role.

ff478bb

Check whether a property is defined before using it.

9deae9b

jeherve approved these changes Feb 3, 2025

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Feb 3, 2025

anton-vlasenko merged commit aa3a69b into trunk Feb 4, 2025
65 checks passed

anton-vlasenko deleted the fix/author-details-are-missing branch February 4, 2025 12:32

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 4, 2025

github-actions bot added this to the jetpack/14.2.2 milestone Feb 4, 2025

tbradsha modified the milestones: jetpack/14.2.2, jetpack/14.4 Feb 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

REST API: Enhance author details by including additional data when either user_id or site_id are available. #41159

REST API: Enhance author details by including additional data when either user_id or site_id are available. #41159

anton-vlasenko commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

anton-vlasenko commented Jan 29, 2025 •

edited

Loading

jeherve left a comment

jeherve Jan 31, 2025

anton-vlasenko Jan 31, 2025 •

edited

Loading

jeherve Jan 31, 2025

anton-vlasenko Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

	$id = ( isset( $author->user_id ) && $author->user_id ) ? $author->user_id : 0;
	$id = ! empty( $author->user_id ) ? (int) $author->user_id : 0;

REST API: Enhance author details by including additional data when either user_id or site_id are available. #41159

REST API: Enhance author details by including additional data when either user_id or site_id are available. #41159

Conversation

anton-vlasenko commented Jan 17, 2025 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Jan 17, 2025 • edited Loading

github-actions bot commented Jan 17, 2025 • edited Loading

anton-vlasenko commented Jan 29, 2025 • edited Loading

jeherve left a comment

Choose a reason for hiding this comment

jeherve Jan 31, 2025

Choose a reason for hiding this comment

anton-vlasenko Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

jeherve Jan 31, 2025

Choose a reason for hiding this comment

anton-vlasenko Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 31, 2025 • edited Loading

Code Coverage Summary

anton-vlasenko commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

github-actions bot commented Jan 17, 2025 •

edited

Loading

anton-vlasenko commented Jan 29, 2025 •

edited

Loading

anton-vlasenko Jan 31, 2025 •

edited

Loading

anton-vlasenko Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading