Connection: Add REST support for jsonAPI endpoints

[sergeymitr]

Proposed changes:

• Add REST support for jsonAPI endpoints

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

pf5801-18d-p2

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

No.

Testing instructions:

See 169495-ghe-Automattic/wpcom

[github-actions]

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 add/json-api-direct-access 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 add/json-api-direct-access
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/json-api-direct-access
  

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]

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 February 4, 2025).

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

[sergeymitr]

Hi @fgiannar
I copied a little bit of code from the serve() method: 22e01d7
There's some more, but I'd rather approach that as we get to the endpoint it's actually needed for.
Please take a look when you get a minute.

[fgiannar]

I copied a little bit of code from the serve() method: 22e01d7
There's some more, but I'd rather approach that as we get to the endpoint it's actually needed for.
Please take a look when you get a minute.

I believe we also need to copy the output logic from serve, otherwise we don't properly return WP_Error responses.
You can easily test this by modifying the endpoint's capabilities to dummy and confirm that we get a 200 response instead of the permissions error

[fgiannar]

I believe we need to json encode the response independently of the http_envelope param. Otherwise, we get a PHP Warning locally: PHP Warning: Array to string conversion in class.json-api-endpoints.php on line 2740 and a Fatal on WPCOM: Fatal error: Uncaught Error: Object of class stdClass could not be converted to string

[sergeymitr]

Good catch, thanks!
Fixed now: c9f0973

[fgiannar]

Looks like we are encoding the $response twice if http_envelope is true. Is that ok? Should we perhaps do something like:

if ( $request->get_param( 'http_envelope' ) ) {
	$response = WPCOM_JSON_API::wrap_http_envelope( $status_code, $response, 'application/json' );
}
$response = wp_json_encode( $response );

[sergeymitr]

Good catch, there really is no need for that.
Removed in dd50616
Adjusted the WPCOM counterpart as well.