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.

Sign up for GitHub

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

Jump to bottom

API: create REST endpoint for 'features/available' #39442

Merged
merged 7 commits into from
Sep 23, 2024
Merged

API: create REST endpoint for 'features/available' #39442

merged 7 commits into from
Sep 23, 2024

Conversation

sergeymitr
Copy link
Contributor

@sergeymitr sergeymitr commented Sep 18, 2024 •
edited by darssen
Loading

Proposed changes:

  • Create REST endpoint for 'features/available'.

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#comment-552

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

No.

Testing instructions:

  • Check tests in the CI
  • Run tests with jetpack docker phpunit -- --filter=WP_Test_Jetpack_REST_API_endpoints and make sure all of them pass.
  • Run tests with jetpack docker phpunit -- --filter=WP_Test_Jetpack_REST_API_Authentication and make sure all of them pass.
  • Use 35b21-pb to test these endpoints with both a blog and user token. Only blog_token should work

@sergeymitr sergeymitr added this to the jetpack/13.9 milestone Sep 18, 2024
@sergeymitr sergeymitr self-assigned this Sep 18, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 18, 2024 •
edited
Loading

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/restful-features-available 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/restful-features-available

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/restful-features-available

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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Sep 18, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 18, 2024 •
edited
Loading

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:

  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 October 1, 2024 (scheduled code freeze on September 30, 2024).

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

Backup plugin:

  • Next scheduled release: none scheduled.

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

Boost plugin:

  • Next scheduled release: none scheduled.

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

Search plugin:

  • Next scheduled release: none scheduled.

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

Social plugin:

  • Next scheduled release: none scheduled.

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

Starter Plugin plugin:

  • Next scheduled release: none scheduled.

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

Protect plugin:

  • Next scheduled release: none scheduled.

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

Videopress plugin:

  • Next scheduled release: none scheduled.

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

Migration plugin:

  • Next scheduled release: none scheduled.

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

Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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

Inspect plugin:

  • Next scheduled release: none scheduled.

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

Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

Automattic For agencies client plugin:

  • Next scheduled release: none scheduled.

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

@darssen darssen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Sep 19, 2024
@github-actions github-actions bot added [Package] Connection [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh labels Sep 19, 2024
@darssen darssen self-assigned this Sep 20, 2024
@darssen darssen added [Status] In Progress and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Sep 20, 2024
darssen
darssen reviewed Sep 20, 2024
View reviewed changes
projects/packages/connection/legacy/class-jetpack-xmlrpc-server.php
@@ -823,24 +823,6 @@ public function disconnect_blog() {
return false;
}

/**
Copy link
Contributor

Choose a reason for hiding this comment

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

I removed this long deprecated method which was calling the now deprecated method Jetpack_XMLRPC_Methods::features_available.

@darssen darssen requested a review from a team September 20, 2024 09:10
@darssen darssen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Sep 20, 2024
darssen
darssen reviewed Sep 20, 2024
View reviewed changes
projects/plugins/automattic-for-agencies-client/changelog/add-restful-features-available Outdated
@@ -0,0 +1,4 @@
Significance: major
Copy link
Contributor

Choose a reason for hiding this comment

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

Not really sure about the major here and all the plugins. It makes sense to have a major in the connection package, but I don't think it makes sense for the plugins

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that's fine to have it that way.
Since Connection changelog is "major", and all those plugins rely on it, it's logical to extend the "major" version increase to all of them.

Copy link
Contributor

Choose a reason for hiding this comment

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

What it really comes down to is "will this change potentially break things for people (properly) using the plugin?"

In this case, I'd say "probably not". I doubt the plugin exposes the functionality of this package method in its own UI or APIs. Anything using the package itself should itself be depending on the package rather than relying on any of our other plugins to provide it.

(I think we can ignore #17221 for the purposes of deciding if a plugin change is major).

Copy link
Contributor

Choose a reason for hiding this comment

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

Many thanks for replying @anomiex. I will update the PR accordingly and change the significance of the changelogs in the plugins to minor then

sergeymitr
sergeymitr commented Sep 21, 2024
View reviewed changes
Copy link
Contributor Author

@sergeymitr sergeymitr left a comment

Choose a reason for hiding this comment

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

GitHub doesn't let me approve the PR, but I tested it and went through the code and everything looks good.

Please merge whenever you feel ready.
Thank you for helping with this.

projects/plugins/automattic-for-agencies-client/changelog/add-restful-features-available Outdated
@@ -0,0 +1,4 @@
Significance: major
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that's fine to have it that way.
Since Connection changelog is "major", and all those plugins rely on it, it's logical to extend the "major" version increase to all of them.

@darssen darssen merged commit e173ec2 into trunk Sep 23, 2024
72 of 73 checks passed
@darssen darssen deleted the add/restful-features-available branch September 23, 2024 12:55
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 23, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
@sergeymitr @darssen @gogdzl
API: create REST endpoint for 'features/available' (#39442)
80e329b 
* API: create REST endpoint for 'features/available'.

* Added test for succesful authentication for the features available rest endpoint

* Removing deprecated legacy features_available

* changelog

---------

Co-authored-by: Juanma Rodriguez Escriche <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@darssen darssen darssen left review comments

@anomiex anomiex anomiex left review comments

Assignees

@sergeymitr sergeymitr

@darssen darssen

Labels
[Package] Connection [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh [Tests] Includes Tests
Projects
None yet
Milestone
jetpack/13.9
Development

Successfully merging this pull request may close these issues.
3 participants
@sergeymitr @anomiex @darssen