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

Social: Update social/settings route registration #41596

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open

Social: Update social/settings route registration #41596

wants to merge 5 commits into from

Conversation

gmjuhasz
Copy link
Contributor

@gmjuhasz gmjuhasz commented Feb 6, 2025 •
edited
Loading

Fixes https://github.com/Automattic/jetpack-reach/issues/790
Fixes https://github.com/Automattic/jetpack-reach/issues/794

Proposed changes:

  • Only register social/settings endpoint if the current Jetpack version does not have it
  • Use the available endpoint based on the same check.

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

No

Testing instructions:

  • You need to test different versions for this change.
  • Check trunk social with Jetpack at least 13.4 - The module toggle should use the JP settings endpoint
  • Check trunk social with older Jetpack - the social/settings route should get registered and used on the module toggle
  • Toggle path for Jetpack new versions: wp-json/jetpack/v4/settings?_locale=user
  • Toggle path for Jetpack older versions: wp-json/jetpack/v4/social/settings?_locale=user

@gmjuhasz gmjuhasz requested a review from a team February 6, 2025 12:32
@gmjuhasz gmjuhasz self-assigned this Feb 6, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
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 update/social-settings-route-registration branch.

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

    bin/jetpack-downloader test jetpack update/social-settings-route-registration

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 [Feature] Publicize Now Jetpack Social, auto-sharing [Package] Publicize [Plugin] Social Issues about the Jetpack Social plugin labels Feb 6, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
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 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!

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.

@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 Feb 6, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025 •
edited
Loading

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/social/src/class-rest-settings-controller.php 0/97 (0.00%) 0.00% 2 💔

Full summary · PHP report · JS report

pablinos
pablinos reviewed Feb 7, 2025
View reviewed changes
Copy link
Contributor

@pablinos pablinos left a comment

Choose a reason for hiding this comment

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

This is good. Just a couple of minor comments

projects/packages/publicize/src/class-publicize-utils.php Outdated Show resolved Hide resolved
projects/plugins/social/src/class-rest-settings-controller.php Outdated Show resolved Hide resolved
projects/packages/publicize/src/class-publicize-utils.php Outdated
Comment on lines 113 to 118
/**
* Check if the new module endpoint is available in the used Jetpack version.
*
* @return bool
*/
public static function has_new_module_endpoint() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think we should link to the code/PR for this? I'm not sure it's obvious what this is checking, and I can imagine we would forget!

Also, it's an addition to the existing settings endpoint, so we might want to change the name, although I'm not sure what to!

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 renamed it to should_use_jetpack_module_endpoint

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool. Do you think we should link to the code? https://github.com/Automattic/jetpack/pull/41461/files#diff-f8e5ef1115599de750b64143dd1901554254eddd95ab4371b6b6b3b2a5914224R638-R642 I think it might be worth documenting that we need the module status in the response, and that's why we're doing the version check.

pablinos
pablinos reviewed Feb 7, 2025
View reviewed changes
Copy link
Contributor

@pablinos pablinos left a comment

Choose a reason for hiding this comment

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

The Phan check is still compaining I think.

projects/packages/publicize/src/class-publicize-utils.php Outdated Show resolved Hide resolved
projects/packages/publicize/src/class-publicize-utils.php Outdated
Comment on lines 113 to 118
/**
* Check if the new module endpoint is available in the used Jetpack version.
*
* @return bool
*/
public static function has_new_module_endpoint() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Cool. Do you think we should link to the code? https://github.com/Automattic/jetpack/pull/41461/files#diff-f8e5ef1115599de750b64143dd1901554254eddd95ab4371b6b6b3b2a5914224R638-R642 I think it might be worth documenting that we need the module status in the response, and that's why we're doing the version check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pablinos pablinos pablinos left review comments

Assignees

@gmjuhasz gmjuhasz

Labels
[Feature] Publicize Now Jetpack Social, auto-sharing [Package] Publicize [Plugin] Social Issues about the Jetpack Social plugin [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gmjuhasz @pablinos