Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move WPCOM_REST_API_Proxy_Request trait to the connection package #41023

Merged
merged 5 commits into from
Jan 15, 2025

Conversation

manzoorwanijk
Copy link
Member

@manzoorwanijk manzoorwanijk commented Jan 14, 2025

Fixes #40947

Proposed changes:

  • Move WPCOM_REST_API_Proxy_Request trait to the connection package
  • Add an option to override $request_options to allow passing additional options like timeout

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:

  • Test the affected endpoints for self-hosted, AT and Simple sites. You can use the dev console.
  • Hit these endpoints and verify that there are no PHP errors
  • /wpcom/v2/email-preview
await wp.apiFetch({
    path: '/wpcom/v2/email-preview?post_id=32'
});
image
  • /wpcom/v2/newsletter-categories
await wp.apiFetch({
    path: '/wpcom/v2/newsletter-categories'
});
image
  • /wpcom/v2/newsletter-categories/count
await wp.apiFetch({
    path: '/wpcom/v2/newsletter-categories/count'
});
image
  • /wpcom/v2/send-email-preview?id=32
await wp.apiFetch({
    path: '/wpcom/v2/send-email-preview?id=32',
    method: 'POST',
});
image
  • Verify that you receive the email
  • /wpcom/v3/blogging-prompts
await wp.apiFetch({
    path: '/wpcom/v3/blogging-prompts'
});
image
  • /wpcom/v2/memberships/status
await wp.apiFetch({
    path: '/wpcom/v2/memberships/status',
});
image
  • /wpcom/v2/memberships/products
await wp.apiFetch({
    path: '/wpcom/v2/memberships/products',
});
image
  • Test those endpoints for a self-hosted site with an old version of the JP plugin and, e.g., Backups on this branch
  • Do a sanity check for everything else

I also tested it on my Simple site

image

Copy link
Contributor

github-actions bot commented Jan 14, 2025

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/move-wpcom-rest-api-proxy-request-trait branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/move-wpcom-rest-api-proxy-request-trait
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/move-wpcom-rest-api-proxy-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 github-actions bot added [Package] Connection [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Jan 14, 2025
Copy link
Contributor

github-actions bot commented Jan 14, 2025

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. 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.
  3. 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 undefined).

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

@github-actions 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 14, 2025
@manzoorwanijk manzoorwanijk force-pushed the update/move-wpcom-rest-api-proxy-request-trait branch from a14d7fe to 93ae9f7 Compare January 14, 2025 09:45
@manzoorwanijk manzoorwanijk changed the title Move WPCOM_REST_API_Proxy_Request trait to connections package Move WPCOM_REST_API_Proxy_Request trait to the connection package Jan 14, 2025
@manzoorwanijk manzoorwanijk added [Type] Task 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 14, 2025
@manzoorwanijk manzoorwanijk self-assigned this Jan 14, 2025
@manzoorwanijk manzoorwanijk requested review from fgiannar and a team January 14, 2025 09:48
@manzoorwanijk manzoorwanijk marked this pull request as ready for review January 14, 2025 11:38
@manzoorwanijk manzoorwanijk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jan 14, 2025
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work here, Manzoor!

Tested all endpoints with:

  1. A self-hosted site on current branch
  2. A simple site
  3. A self-hosted site with latest Jetpack and Backups on this branch via Jetpack Beta

and everything works as expected 👍

Add an option to override $request_options( to allow passing additional options like timeout )

Since you added this, could you pls update the rest trait public methods accordingly?
Note that I didn't test this functionality since no endpoints are using the added argument yet.

@fgiannar fgiannar 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 15, 2025
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚢

@fgiannar fgiannar 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 Jan 15, 2025
@manzoorwanijk manzoorwanijk merged commit 270e71d into trunk Jan 15, 2025
77 checks passed
@manzoorwanijk manzoorwanijk deleted the update/move-wpcom-rest-api-proxy-request-trait branch January 15, 2025 08:57
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Connection [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Type] Task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WPCOM_REST_API_Proxy_Request_Trait: Move to connection from the JP plugin
2 participants