Social: Standardize the connection object in the recently added social endpoints #37390

spsiddarthan · 2024-05-15T06:38:12Z

The newly added Jetpack Social endpoints don't return data in the same format as the initial state. This PR standardizes the response for the connection object. I've also updated the jetpack/v4/publicize/connections endpoint which isn't used anywhere.
We are getting rid of the site option and are going to rely on transient to cache the connections on the Jetpack site.

Proposed changes:

Updated the create and update publicize connections endpoint to call the newly added get_connections_for_user publicize function.
Updated the get publicize connections endpoint to call the existing get_all_connections_for_user publicize function.
Migrated the publicize_connections to a transient to avoid issues with caching of the option.
Added shared key to the connections object.
Added status to the connections object.
To refresh connection test results, add this query param run_test_results=true to your get request.
To clear connection cache, add this query param clear_cache =1 to your get request.

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?

No

Testing instructions:

Don't sandbox and test against prod.
Boot up a JN site on this branch or checkout this branch on your local and ensure define( 'JETPACK_SOCIAL_USE_ADMIN_UI_V1', true ); is enabled or add the blog sticker to enable the feature.
Simulate the post, put and get requests to the following endpoints: POST wp-json/jetpack/v4/social/connections, PUT wp-json/jetpack/v4/social/connections/:id and GET wp-json/jetpack/v4/publicize/connections and observe that the API response.

For the GET request, this will be the response.

{
    "refresh_token": "",
    "type": "access",
    "user_id": "",
    "provider": "nextdoor:wordpressxxxx",
    "issued": "2023-10-25 05:29:34",
    "expires": 1747224005,
    "external_id": "",
    "external_name": "Sid Darthan",
    "external_display": "Sid Darthan",
    "connection_data": {
        "id": "",
        "token_id": "",
        "blog_id": "",
        "user_id": "",
        "meta": {
            "external_user_id": ""
        }
    },
    "profile_picture": "xxxx",
    "service_name": "nextdoor",
    "connection_id": "",
    "can_disconnect": true,
    "profile_link": "https://nextdoor.com/profile/",
    "shared": false,
    "status": "ok"
}

To get connection test results, include these query params wp-json/jetpack/v4/publicize/connections?run_test_results=true
When you create a connection by calling https://temporary-lemming.jurassic.ninja/wp-json/jetpack/v4/social/connections with the body {"keyring_connection_ID" : xxx, "shared" : false }, you will see a similar response. Likewise for globalizing/unglobalizing as well.

github-actions · 2024-05-15T06:39:15Z

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-endpoints 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 update/social-endpoints

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/social-endpoints

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-05-15T06:39:17Z

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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for June 4, 2024 (scheduled code freeze on June 3, 2024).