Social | Standardize connections API schema #40589

manzoorwanijk · 2024-12-12T12:23:49Z

Supercedes #40536

Proposed changes:

Declare get_all_connections_for_user abstract method in Publicize_Base class
Update get_all_connections_for_user method in jetpack to return the data as per the new schema
Use get_all_connections_for_user method for script data on WPCOM
Add status field to wpcom/v2/connection-test-results endpoint
Fix PHP fatal on WPCOM when getting profile link for Threads connection
Changed the transient name for connections to ensure to clear old transients to avoid data mismatch

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:

Apply D168243-code to your sandbox and point public API and your site to it.
Goto connections management on a Jetpack site and verify that everything works same as before like adding, removing and updating connections.
On a Simple site, goto editor
Open Jetpack sidebar
Verify that Connections management now opens the modal, instead of pointing to Calypso
In the modal, confirm that the connections show up fine.
Note that adding/removing connections is not yet implemented for simple sites

github-actions · 2024-12-12T12:24:44Z

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/unify-schema-for-connections-management branch.

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

bin/jetpack-downloader test jetpack update/unify-schema-for-connections-management

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 · 2024-12-12T12:24:53Z

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:

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

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.

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

pablinos

I've been expanding on this, and added the implementation of get_all_connections_for_user to the Publicize_Base class.

I realise we want to get away from dumping everything in there, but I wonder if this is the first knot to unpick, and then we can start moving things into separate classes or traits.

What do you think of #40604 ?

projects/plugins/wpcomsh/wpcom-features/class-wpcom-features.php

pablinos · 2024-12-12T23:53:08Z

...s/plugins/jetpack/tests/php/core-api/wpcom-fields/test-post-fields-publicize-connections.php

@@ -153,7 +153,7 @@ public static function setup_connections_wpcom() {

 	public static function setup_connections_jetpack() {
 		set_transient(
-			'jetpack_social_connections',
+			'jetpack_social_connection_list',


Is this just to be more descriptive?

Mentioned in the PR description

Changed the transient name for connections to ensure to clear old transients to avoid data mismatch

This reverts commit 1cccf43.

manzoorwanijk added 9 commits December 12, 2024 17:46

Declare get_all_connections_for_user abstract class

a21bf50

Add and update the required methods in base class

783ada0

Update get_all_connections_for_user method in jetpack

666866d

Use get_all_connections_for_user method for script data on WPCOM

2f982e9

Add status field to connection test results

0cd6366

Fix PHP fatal on WPCOM for profile link

ced1f63

Ensure to clear old transients to avoid data mismatch

b449a43

Sync WPCOM_Features

1cccf43

Add changelogs

e978653

manzoorwanijk added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Team Review labels Dec 12, 2024

manzoorwanijk requested a review from a team December 12, 2024 12:23

manzoorwanijk self-assigned this Dec 12, 2024

manzoorwanijk mentioned this pull request Dec 12, 2024

Social | Standardize connections API schema #40536

Closed

3 tasks

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/ [Plugin] Wpcomsh labels Dec 12, 2024

manzoorwanijk mentioned this pull request Dec 12, 2024

Social | Add wpcom/v3/publicize/connections endpoint #40540

Closed

3 tasks

manzoorwanijk added the DO NOT MERGE don't merge it! label Dec 12, 2024

Attempt to fix tests

22b9c81

manzoorwanijk force-pushed the update/unify-schema-for-connections-management branch from a771347 to 22b9c81 Compare December 12, 2024 13:37

github-actions bot added the [Tests] Includes Tests label Dec 12, 2024

external_display may be empty in tests

e9a6ae6

pablinos mentioned this pull request Dec 12, 2024

Publicize: Use get_all_connections_for_user in wpcom/v2 endpoints #40604

Draft

3 tasks

pablinos reviewed Dec 12, 2024

View reviewed changes

external_name may be empty in tests

d6471f5

manzoorwanijk added 2 commits December 13, 2024 09:28

Revert "Sync WPCOM_Features"

1b6db8e

This reverts commit 1cccf43.

Fix tests

a1e6be4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Social | Standardize connections API schema #40589

Social | Standardize connections API schema #40589

manzoorwanijk commented Dec 12, 2024

github-actions bot commented Dec 12, 2024 •

edited

Loading

github-actions bot commented Dec 12, 2024

pablinos left a comment

pablinos Dec 12, 2024

manzoorwanijk Dec 13, 2024

Social | Standardize connections API schema #40589

Are you sure you want to change the base?

Social | Standardize connections API schema #40589

Conversation

manzoorwanijk commented Dec 12, 2024

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Dec 12, 2024 • edited Loading

github-actions bot commented Dec 12, 2024

pablinos left a comment

Choose a reason for hiding this comment

pablinos Dec 12, 2024

Choose a reason for hiding this comment

manzoorwanijk Dec 13, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 12, 2024 •

edited

Loading