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

Publicize: Use get_all_connections_for_user in wpcom/v2 endpoints #40604

Draft
wants to merge 1 commit into
base: update/unify-schema-for-connections-management
Choose a base branch
from
Draft

Publicize: Use get_all_connections_for_user in wpcom/v2 endpoints #40604

wants to merge 1 commit into from
+90 −120

Conversation

pablinos
Copy link
Contributor

Expanding on #40589 this attempts to refactor the wpcom/v2 endpoints and bring the get_all_connections_for_user method to publicize-base.

It means we start relying on the XMLRPC calls entirely, which could be a performance problem with testing the connections.

There's probably some more refactoring we could do to proxy the endpoints and use those within Publicize, by overriding some of the methods, like get_publicize_conns_test_results

Fixes #

Proposed changes:

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:

  • Go to '..'

@pablinos
Publicize: Use get_all_connections_for_user in wpcom/v2 endpoints
2f322d7 
Expanding on #40589 this attempts to refactor the wpcom/v2 endpoints and
bring the get_all_connections_for_user method to publicize-base.

It means we start relying on the XMLRPC calls entirely, which could be a
performance problem with testing the connections.

There's probably some more refactoring we could do to proxy the
endpoints and use those within Publicize, by overriding some of the
methods, like get_publicize_conns_test_results
@github-actions github-actions bot added [Feature] Publicize Now Jetpack Social, auto-sharing [Package] Publicize [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Dec 12, 2024
@github-actions GitHub Actions
Copy link
Contributor

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.

🔴 Action required: Please add missing changelog entries for the following projects: projects/packages/publicize, projects/plugins/jetpack

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md

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 January 7, 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
Copy link
Contributor

github-actions bot commented Dec 12, 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 try/publicize-connections-test-results-refactor branch.

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

    bin/jetpack-downloader test jetpack try/publicize-connections-test-results-refactor

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

@pablinos pablinos mentioned this pull request Dec 12, 2024
Open
3 tasks
manzoorwanijk
manzoorwanijk reviewed Dec 13, 2024
View reviewed changes
projects/packages/publicize/src/class-publicize-script-data.php
@@ -263,7 +263,7 @@ public static function get_api_paths() {
}

return array(
'refreshConnections' => '/jetpack/v4/publicize/connections?test_connections=1',
'refreshConnections' => '/wpcom/v2/publicize/connection-test-results',
Copy link
Member

Choose a reason for hiding this comment

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

This won't work in Social plugin.

Copy link
Member

Choose a reason for hiding this comment

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

IMHO #40607 implementation of moving the endpoint is better and will work in all scenarios.

It also has a well defined schema for the fields and also the properties marked as deprecated in the schema.

Copy link
Member

Choose a reason for hiding this comment

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

Following that, we can deprecate the test connections endpoint because the above implementation incorporates that via a flag test_connections and we don't need to have a separate endpoint for that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This won't work in Social plugin.

No, I know it went yet, as we also need to move the endpoint, but I've refactored the endpoints in this PR to use get_all_connections_for_user so everything is using the same code to prodcue the connections data

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

@manzoorwanijk manzoorwanijk manzoorwanijk left review comments

Assignees
No one assigned
Labels
[Feature] Publicize Now Jetpack Social, auto-sharing [Package] Publicize [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress
Projects
None yet
Milestone
No milestone
Development

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