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

manzoorwanijk · 2024-12-10T13:52:14Z

Extracted out of #40536

Proposed changes:

Add wpcom/v3/publicize/connections endpoint that can be used in every scenario the publicize module is used
- WPCOM sites
- Jetpack sites - both Jetpack and Social plugins

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 this PR to your sandbox and point public API to the sandbox
Goto Developer console
Hit WP REST API - wpcom/v3/sites/<site_id>/publicize/connections
Confirm that the site connections are displayed correctly as per the schema in this PR
Break a connection by removing Jetpack from the service, e.g. here for Facebook.
Add ?test_connections=1 to the endpoint above
Verify that the tests are run for connections
Verify that status is set to 'broken' for the broken connection
Point your Jetpack site to the sandbox
Goto any page which uses wp.apiFetch e.g. Block Editor
In console, run this

await wp.apiFetch({
    path: '/wpcom/v3/publicize/connections'
});

Confirm that the site connections are displayed correctly as per the schema in this PR

github-actions · 2024-12-10T13:53:04Z

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/social-unitied-connections-endpoint branch.

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

bin/jetpack-downloader test jetpack add/social-unitied-connections-endpoint

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-10T13:53:25Z

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!

manzoorwanijk · 2024-12-10T13:55:51Z

projects/packages/publicize/src/class-connection-fields.php

+/**
+ * Publicize Connection Fields class.
+ */
+class Connection_Fields {


The methods in this class are copied from Publicize_Base class which we can later on clean up to these methods as fallback after deprecating them.

pablinos

I think we might be doing too much in one go here. We should definitely be doing some refactoring of the Publicize_Base class, but I'm not sure if we want to tackle that at the same time.

It would be good to do the smallest change that fixes our problem.

pablinos · 2024-12-10T20:48:56Z

projects/packages/publicize/src/rest-endpoints/class-connections-controller.php

+			'title'      => 'jetpack-publicize-connection',
+			'type'       => 'object',
+			'properties' => array(
+				'connection_id'   => array(


Looking at this, the endpoint exists because we need to rename a couple of fields and add some more. Would it be possible to extend the current connection test results endpoint, and create a version 2.1 from there?

We're copying quite a bit of code and creating a third set of endpoints, which we should probably avoid if we can.

Would it be possible to extend the current connection test results endpoint, and create a version 2.1 from there?

I initially tried to update that endpoint to enhance it but it resulted in complications for its use on all the sites - Simple and Jetpack. It also cannot be used in Standalone plugins as is.

We're copying quite a bit of code and creating a third set of endpoints, which we should probably avoid if we can.

Yes, existing endpoints are spread all over and the logic is not consolidated, which actually resulted in the schema mess we are trying to solve. I did think about keeping the changes to minimal but it felt like creating more such mess.

The approach here tries to consolidate the endpoint which can be used everywhere - WPCOM and Jetpack sites, both in Jetpack and Social plugin.

manzoorwanijk · 2024-12-11T04:24:03Z

I think we might be doing too much in one go here.

I agree but I am confident about these changes that they will be better in the long run.

We should definitely be doing some refactoring of the Publicize_Base class, but I'm not sure if we want to tackle that at the same time.

We are not touching Publicize_Base to leave that refactor for a later time. I just copied the useful bits from there which are needed for the endpoint. We can afterwards deprecate those methods in that class.

It would be good to do the smallest change that fixes our problem.

I am afraid that may lead to further complicated logic of the Publicize classes on Jetpack and WPCOM, making it harder for someone else to follow the business logic.

manzoorwanijk · 2024-12-11T13:11:08Z

projects/packages/publicize/src/class-publicize-base.php

-		if ( 'threads' === $service_name && isset( $connection['external_name'] ) ) {
-			return 'https://www.threads.net/@' . $connection['external_name'];
+		if ( 'threads' === $service_name && isset( $cmeta['external_name'] ) ) {
+			return 'https://www.threads.net/@' . $cmeta['external_name'];


This change is to ensure it works on WPCOM sites where connection is not an array.

manzoorwanijk · 2024-12-11T13:30:06Z

projects/packages/publicize/src/class-publicize-base.php

@@ -527,7 +527,7 @@ public function get_profile_link( $service_name, $connection ) {
 			}

 			$profile_url_query      = wp_parse_url( $cmeta['connection_data']['meta']['profile_url'], PHP_URL_QUERY );
-			$profile_url_query_args = null;
+			$profile_url_query_args = array();


Phan complained about this.

manzoorwanijk · 2024-12-11T13:33:06Z

projects/packages/publicize/src/class-publicize-base.php

@@ -608,7 +608,7 @@ public function get_username( $service_name, $connection ) {
 	 * @param object|array $connection The Connection object (WordPress.com) or array (Jetpack).
 	 * @return string
 	 */
-	private function get_profile_picture( $connection ) {
+	public function get_profile_picture( $connection ) {


This makes it available externally for facade.

manzoorwanijk · 2024-12-12T12:27:34Z

Closing in favour of #40589 as we no longer need the connections endpoint. We can remove the wpcom/v2/publicize/connections endpoint in the future and use the publicize class directly.

manzoorwanijk added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Dec 10, 2024

manzoorwanijk requested a review from a team December 10, 2024 13:52

manzoorwanijk self-assigned this Dec 10, 2024

github-actions bot added [Feature] Publicize Now Jetpack Social, auto-sharing [Package] Publicize [Status] In Progress labels Dec 10, 2024

manzoorwanijk commented Dec 10, 2024

View reviewed changes

manzoorwanijk marked this pull request as ready for review December 10, 2024 14:03

pablinos reviewed Dec 10, 2024

View reviewed changes

manzoorwanijk added [Status] Needs Team Review and removed [Status] In Progress labels Dec 11, 2024

manzoorwanijk force-pushed the add/social-unitied-connections-endpoint branch from cf2eaf6 to 8a796c6 Compare December 11, 2024 12:28

manzoorwanijk commented Dec 11, 2024

View reviewed changes

manzoorwanijk added 11 commits December 12, 2024 09:55

Add Connections_Controller

f8c3049

Initialize Connections_Controller

e6090ac

Create class-connection-fields.php

f4827a1

Changelog

5b256d7

Phan

5b955e7

Update baseline.php

c994a30

Improve filtering of fields

a42252c

Phan needs a fan

a8835c2

Don't force to pass $is_wpcom

460db14

Extract the share logic to base class

e76f8db

Use base class for connection fields for now.

b0190a0

manzoorwanijk force-pushed the add/social-unitied-connections-endpoint branch from 53a4d87 to b0190a0 Compare December 12, 2024 04:25

manzoorwanijk closed this Dec 12, 2024

github-actions bot removed the [Status] Needs Team Review label Dec 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

manzoorwanijk commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024

manzoorwanijk Dec 10, 2024

pablinos left a comment

pablinos Dec 10, 2024

manzoorwanijk Dec 11, 2024

manzoorwanijk commented Dec 11, 2024

manzoorwanijk Dec 11, 2024

manzoorwanijk Dec 11, 2024

manzoorwanijk Dec 11, 2024

manzoorwanijk commented Dec 12, 2024

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

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

Conversation

manzoorwanijk commented Dec 10, 2024 • edited Loading

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 10, 2024 • edited Loading

github-actions bot commented Dec 10, 2024

manzoorwanijk Dec 10, 2024

Choose a reason for hiding this comment

pablinos left a comment

Choose a reason for hiding this comment

pablinos Dec 10, 2024

Choose a reason for hiding this comment

manzoorwanijk Dec 11, 2024

Choose a reason for hiding this comment

manzoorwanijk commented Dec 11, 2024

manzoorwanijk Dec 11, 2024

Choose a reason for hiding this comment

manzoorwanijk Dec 11, 2024

Choose a reason for hiding this comment

manzoorwanijk Dec 11, 2024

Choose a reason for hiding this comment

manzoorwanijk commented Dec 12, 2024

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

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

manzoorwanijk commented Dec 10, 2024 •

edited

Loading

github-actions bot commented Dec 10, 2024 •

edited

Loading