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

fgiannar commented 6 days ago

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:

[x] Have you written new tests for your changes, if applicable?
[x] Have you checked the E2E test CI results, and verified that your changes do not break them?
[x] 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

github-actions[bot] commented 6 days ago

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[bot] commented 6 days ago

Thank you for your PR!

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

:white_check_mark: Include a description of your PR changes.
:white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
:white_check_mark: Add testing instructions.
:white_check_mark: Specify whether this PR includes any changes to data or privacy.
:white_check_mark: 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 :robot:

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.

Automattic / jetpack