Introduce new `wpl_iframe_src` filter to enable filtering arguments to Likes iframes.

georgestephanis commented 1 day ago

This will enable experimenting with re-introducing slim likeboxes to display likes without gravatars and other future changes. Could also enable testing grounds of new changes before full UI for setting management is built out, or potentially to point more easily to a testing sandbox.

Companion to proposed changes WPCOM-side via phab diff D165404

I used the existing pattern of wpl_ for the filter prefix but I'm 100% fine if it's changed to jetpack_likes_ for a filter prefix or anything else.

Proposed changes:

Introduces a new filter in two places.

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?
[x] 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

I've been discussing this with @jsnajdr in Slack about the wpcom-side changes. Jetpack-side changes for now are limited to just adding two filters so it is possible to append a slim=1 argument.

Slim mode was added for the Carousel module eleven years ago, and removed again eight years ago via #3585 but the code supporting it has lived on wpcom-side, albeit in a broken state for the past few years. The proposed change wpcom-side rectifies that and lets slim mode work again as a version without gravatars. This PR to Jetpack just makes it possible to filter and append the iframe to add &slim=1 to the fragment so JS picks it up and toggles the mode.

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

Testing instructions:

There isn't much to test Jetpack side as this is just adding two instances of a filter.

github-actions[bot] commented 1 day ago

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/likes-add-iframe-filter branch.

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

bin/jetpack-downloader test jetpack update/likes-add-iframe-filter

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[bot] commented 1 day ago

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

:white_check_mark: Include a description of your PR changes.
:white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
:white_check_mark: Add testing instructions.
:white_check_mark: Specify whether this PR includes any changes to data or privacy.
:white_check_mark: 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 :robot:

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 none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

georgestephanis commented 1 day ago

Setting up the Jetpack CLI tool isn't functional for me currently.

I've tried to follow the directions as best I could, but it seems pnpm is installing a version newer than Jetpack supports currently to generate the changelog message?

~/code/jetpack $ pnpm -v
9.14.2
~/code/jetpack $ pnpm install
 ERR_PNPM_UNSUPPORTED_ENGINE  Unsupported environment (bad pnpm and/or Node.js version)

Your pnpm version is incompatible with "/Users/georgestephanis/code/jetpack".

Expected version: ^9.3.0 <9.12.0
Got: 9.14.2

This is happening because the package's manifest has an engines.pnpm field specified.
To fix this issue, install the required pnpm version globally.

To install the latest version of pnpm, run "pnpm i -g pnpm".
To check your pnpm version, run "pnpm -v".

georgestephanis commented 1 day ago

I've tried to follow the directions as best I could, but it seems pnpm is installing a version newer than Jetpack supports currently to generate the changelog message?

I sorted this locally with the following change --

diff --git a/package.json b/package.json
index 347afccb62..bf8194e99f 100644
--- a/package.json
+++ b/package.json
@@ -35,7 +35,7 @@
    },
    "engines": {
        "node": "^22.9.0",
-       "pnpm": "^9.3.0 <9.12.0"
+       "pnpm": "^9.3.0 <9.15.0"
    },
    "packageManager": "pnpm@9.3.0"
 }

Unsure if pnpm needs to have a max version required in package.json?

simison commented 1 day ago

npm i -g pnpm@9.12.0 helped me in a similar situation.

simison commented 1 day ago

What are some other changes that you're looking into with Likes?

It would be important to have a path with these types of settings configurable in the Likes Block.

georgestephanis commented 1 day ago

What are some other changes that you're looking into with Likes?

Just what's outlined in the phab diff. Getting the "slim" mode up and running again, and retooling it to operate as the current full likes block behaves, but without gravatars.

Longer term, I'd like to have to have that potentially available as a setting for the likes button exposed to admins -- whether or not to display gravatars of users who have liked it -- but I'm personally fine with that resolving down the road following any discussion / bikeshedding on whether to include it is finalized.

Automattic / jetpack