Jetpack core api: Refactor and reuse trait for proxying requests to WPCOM #40245

fgiannar · 2024-11-19T11:37:19Z

This PR refactors the existing WPCOM_REST_API_Proxy_Request_Trait so that it can be used by any shared endpoint (between self-hosted and Simple sites) that needs to forward the request to WPCOM when it runs on the Jetpack end.

It also refactors two existing endpoints to use the trait and introduces unit tests for both:

WP_Test_WPCOM_REST_API_V3_Endpoint_Blogging_Prompts
WPCOM_REST_API_V2_Endpoint_Memberships

Proposed changes:

WPCOM_REST_API_Proxy_Request_Trait:

Introduce proxy_request_to_wpcom to allow falling back to using the Site-level Connection if the current user is not connected
Update proxy_request_to_wpcom_as_user for proxying requests to WPCOM on behalf of the current user
Introduce proxy_request_to_wpcom_as_blog for proxying requests to WPCOM using the Site-level Connection

WP_Test_WPCOM_REST_API_V3_Endpoint_Blogging_Prompts:

Refactor endpoint to use the WPCOM_REST_API_Proxy_Request_Trait trait
Add unit tests

WPCOM_REST_API_V2_Endpoint_Memberships:

Refactor endpoint to use the WPCOM_REST_API_Proxy_Request_Trait trait
Add unit tests

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

p1730895681631659-slack-C05PV073SG3

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

No

Testing instructions:

Make sure to run the following command on your sandbox: bin/jetpack-downloader test jetpack update/forward-wpcom-request-trait
We'll need to test the Payments block and the Writing Prompt Block across all environments: self-hosted, WoA and Simple
Add a Donations Form block in a post and play around with all the related fields and block settings.
Confirm behaviour same as trunk

Add a Writing Prompt block in a post and confirm behaviour same as trunk

…e endpoints

github-actions · 2024-11-19T11:38:12Z

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 update/forward-wpcom-request-trait branch.

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

bin/jetpack-downloader test jetpack update/forward-wpcom-request-trait

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 · 2024-11-19T11:38:19Z

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 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 none scheduled (scheduled code freeze on undefined).

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

…ite is not connected

coder-karen

Nice work, and the extent of the tests is fantastic!

I tested functionality on all three platforms and from what I could see the two blocks worked as I'd expect.

I also left some review comments, let me know what you think (none are blockers). I reviewed from the perspective of testing and code reviewing, rather than from the point of view of understanding the best endpoint approach (following the linked Slack thread).

...ugins/jetpack/_inc/lib/core-api/wpcom-endpoints/trait-wpcom-rest-api-proxy-request-trait.php

coder-karen · 2024-11-22T10:58:00Z

...ack/tests/php/core-api/wpcom-endpoints/test-class-wpcom-rest-api-v2-endpoint-memberships.php

+	public function test_list_products_no_auth() {
+		wp_set_current_user( 0 );
+
+		$request  = new WP_REST_Request( Requests::GET, '/wpcom/v2/memberships/products' );


Could it be worth defining some of the endpoint URLs as class constants to prevent possible issues if anything changes? such as const PRODUCTS_ENDPOINT = '/wpcom/v2/memberships/products';

TBH I'd prefer the test to fail on purpose if someone redefines the endpoint path :)

coder-karen · 2024-11-22T10:59:06Z

...ack/tests/php/core-api/wpcom-endpoints/test-class-wpcom-rest-api-v2-endpoint-memberships.php

+	public function test_list_products_with_insufficient_permissions() {
+		wp_set_current_user( static::$author_id );
+
+		$request  = new WP_REST_Request( Requests::GET, '/wpcom/v2/memberships/products' );


As most of the tests make requests, I wonder if it might be worth extracting the request logic into a helper function? A similar example is here:

jetpack/projects/plugins/jetpack/tests/php/_inc/lib/test_class.rest-api-endpoints.php

Line 106 in 18cc457

protected function create_and_get_request( $route = '', $json_params = array(), $method = 'GET', $params = array() ) {

I'm personally ok with repeating the new WP_REST_Request part and setting headers and body independently in each test as per out needs.
I find methods like this a bit restricting in eg adding additional headers or interacting with the WP_REST_Request object as needed, and they tend to grow over time in terms of params and custom logic.

That said, if we'd like to use a helper method like this perhaps we could do that in the future as part of refactoring the tests to use a common trait?

Yes, perhaps if there is a need to come back and generally refactor or add more tests, it might make sense then too.

jeherve

This is nice, thanks for working on this! And the added tests will help too.

I only have a minor question, not a blocker for me.

...ugins/jetpack/_inc/lib/core-api/wpcom-endpoints/trait-wpcom-rest-api-proxy-request-trait.php

…it-wpcom-rest-api-proxy-request-trait.php Co-authored-by: Karen Attfield <[email protected]>

coder-karen

LGTM! 👍

fgiannar added 3 commits November 18, 2024 16:18

WPCOM_REST_API_Proxy_Request_Trait: Refactor trait and use in multipl…

1322096

…e endpoints

Add unit tests

12db512

changelog

9351e61

fgiannar added the [Status] In Progress label Nov 19, 2024

fgiannar self-assigned this Nov 19, 2024

github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Nov 19, 2024

fgiannar added 6 commits November 19, 2024 13:41

Update docs

9c1691c

Fix unit tests

4af3ff1

Phan fixes

4c321c7

Unit test hotfix

fda67c1

WPCOM_REST_API_Proxy_Request_Trait: Default error response when the s…

fa288d0

…ite is not connected

Jetpack plugin: Update phan baselines

79ad7a0

fgiannar added this to the Jetpack 14.1 milestone Nov 19, 2024

fgiannar added 4 commits November 19, 2024 16:29

Ensure WPCOM_REST_API_Proxy_Request_Trait trait is available on WPCOM

e63ff56

Make linter happy

ccee9eb

Merge branch 'trunk' into update/forward-wpcom-request-trait

a3811fe

Hotfix and unit test

bcfa830

fgiannar added [Status] Needs Team Review and removed [Status] In Progress labels Nov 20, 2024

fgiannar requested review from a team and jeherve November 20, 2024 11:19

Merge branch 'trunk' into update/forward-wpcom-request-trait

98724be

coder-karen reviewed Nov 22, 2024

View reviewed changes

jeherve reviewed Nov 22, 2024

View reviewed changes

...ugins/jetpack/_inc/lib/core-api/wpcom-endpoints/trait-wpcom-rest-api-proxy-request-trait.php Show resolved Hide resolved

fgiannar and others added 2 commits November 25, 2024 10:01

Instantiate Manager once

1691d1e

Update projects/plugins/jetpack/_inc/lib/core-api/wpcom-endpoints/tra…

b52d801

…it-wpcom-rest-api-proxy-request-trait.php Co-authored-by: Karen Attfield <[email protected]>

coder-karen approved these changes Nov 25, 2024

View reviewed changes

fgiannar merged commit bcf6634 into trunk Nov 25, 2024
58 checks passed

fgiannar deleted the update/forward-wpcom-request-trait branch November 25, 2024 11:58

github-actions bot removed the [Status] Needs Team Review label Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jetpack core api: Refactor and reuse trait for proxying requests to WPCOM #40245

Jetpack core api: Refactor and reuse trait for proxying requests to WPCOM #40245

fgiannar commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024

coder-karen left a comment •

edited

Loading

coder-karen Nov 22, 2024

fgiannar Nov 25, 2024

coder-karen Nov 22, 2024

fgiannar Nov 25, 2024

coder-karen Nov 25, 2024

jeherve left a comment

coder-karen left a comment

Jetpack core api: Refactor and reuse trait for proxying requests to WPCOM #40245

Jetpack core api: Refactor and reuse trait for proxying requests to WPCOM #40245

Conversation

fgiannar commented Nov 19, 2024 • 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 Nov 19, 2024 • edited Loading

github-actions bot commented Nov 19, 2024

coder-karen left a comment • edited Loading

Choose a reason for hiding this comment

coder-karen Nov 22, 2024

Choose a reason for hiding this comment

fgiannar Nov 25, 2024

Choose a reason for hiding this comment

coder-karen Nov 22, 2024

Choose a reason for hiding this comment

fgiannar Nov 25, 2024

Choose a reason for hiding this comment

coder-karen Nov 25, 2024

Choose a reason for hiding this comment

jeherve left a comment

Choose a reason for hiding this comment

coder-karen left a comment

Choose a reason for hiding this comment

fgiannar commented Nov 19, 2024 •

edited

Loading

github-actions bot commented Nov 19, 2024 •

edited

Loading

coder-karen left a comment •

edited

Loading