GIF Block: Replace source with Tumblr GIF Search #39896

justinshreve · 2024-10-24T17:19:51Z

Proposed changes:

Updated the GIF block to use Tumblr's GIF search API, replacing the current Giphy-powered block.
Added WP.com proxy endpoints for /v2/gif/search/{query} and /v2/gif/popular to retrieve Tumblr GIFs.
Adds backwards compatibility so if a giphyUrl attribute is still detected, we honor those embeds.
Updated tests.

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

pg1lMq-7O-p2
pg1lMq-80-p2

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

No.

Testing instructions:

Testing an existing GIPHY GIF

Before switching to this branch, create a new post or edit an existing post when running trunk
Add the GIF block and insert it into the post.
Enter a search term in the "Search" field.
Select a GIF from GIPHY.
Save or update the post.
Switch Jetpack to use this branch.
View the post on the frontend site.
Check that the GIPHY GIF still displays correctly.

Creating a new GIF

Run bin/jetpack-downloader test jetpack tumblr-gif-block to apply the endpoints to your sandbox.
Set JETPACK__SANDBOX_DOMAIN to point at your sandbox.
Create a new post or edit an existing post.
Add the GIF block and insert it into the post.
Enter a search term in the "Search" field.
Select a GIF from Tumblr.
Add a caption to the GIF (optional).
Save or update the post.
View the post on the frontend site.
Check that the GIF displays correctly with the caption and attribution.

Demo:

gif_demo.mov

github-actions · 2024-10-24T17:20:51Z

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.

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.

github-actions · 2024-10-24T17:23:13Z

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 tumblr-gif-block branch.
To test on Simple, run the following command on your sandbox:
```
bin/jetpack-downloader test jetpack tumblr-gif-block
```

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

jeherve

I gave it a quick try, and left a few notes below.

jeherve · 2024-10-30T13:49:06Z

projects/plugins/jetpack/extensions/blocks/gif/controls.js

-					<Path d="M4.6 5.9H0v10h1.6v-3.1h3c4.8 0 4.8-6.9 0-6.9zm0 5.4h-3v-4h3c2.6.1 2.6 4 0 4zM51.2 12.3c2-.3 2.7-1.7 2.7-3.1 0-1.7-1.2-3.3-3.5-3.3h-4.6v10h1.6v-3.4h2.1l3 3.4h1.9l-.2-.3-3-3.3zM47.4 11V7.4h3c1.3 0 1.9.9 1.9 1.8s-.6 1.8-1.9 1.8h-3zM30.6 13.6L28 5.9h-1.1l-2.5 7.7-2.6-7.7H20l3.7 10H25l1.4-3.5L27.5 9l1.1 3.4 1.3 3.5h1.4l3.5-10h-1.7z" />
-					<Path d="M14.4 5.7c-3 0-5.1 2.2-5.1 5.2 0 2.6 1.6 5.1 5.1 5.1 3.5 0 5.1-2.5 5.1-5.2-.1-2.6-1.7-5.1-5.1-5.1zm-.1 8.9c-2.5 0-3.5-1.9-3.5-3.7 0-2.2 1.2-3.8 3.5-3.8 2.4 0 3.5 2 3.5 3.8.1 2-1 3.7-3.5 3.7zM57.7 11.6h5.5v-1.5h-5.5V7.4h5.7V5.9h-7.3v10h7.3v-1.6h-5.7zM38 14.3v-2.7h5.5v-1.5H38V7.4h5.7V5.9h-7.3v10h7.3v-1.6zM93 10.3l-2.7-4.4h-1.9V6l3.8 5.8v4.1h1.6v-4.1l4-5.8v-.1h-2zM69.3 5.9h-3.8v10h3.8c3.5 0 5.1-2.5 5-5.1-.1-2.5-1.6-4.9-5-4.9zm0 8.4h-2.2V7.4h2.2c2.3 0 3.4 1.7 3.4 3.4s-1 3.5-3.4 3.5zM86.3 10.7c.9-.4 1.4-1.1 1.4-2 0-2-1.5-2.8-3.4-2.8h-4.6v10h4.6c2 0 3.7-.7 3.7-2.8 0-.8-.5-2-1.7-2.4zm-5-3.4h3c1.2 0 1.8.7 1.8 1.4 0 .8-.6 1.3-1.8 1.3h-3V7.3zm3 7.1h-3v-2.9h3c.9 0 2.1.5 2.1 1.6 0 1-1.2 1.3-2.1 1.3zM113.9 13.3h5.3V16c-1.2.9-2.9 1.1-4 1.1-4.2 0-5.6-3.3-5.6-6 0-4.1 2.2-6.1 5.6-6.1 1.4 0 3.2.4 4.8 1.8l3.4-3.4C120.7.6 118.1 0 115.2 0c-7.8 0-11.4 5.6-11.4 11s3.1 10.9 11.4 10.9c4 0 7.6-1.4 8.9-4.1V8.6h-10.2v4.7zM171.9 8.5h-7.4V.6h-5.9v20.8h5.9v-7.8h7.4v7.8h5.9V.6h-5.9zM195.1.6l-4.5 7.1-4.3-7.1h-6.6v.2l7.9 12.3v8.3h5.9v-8.3L201.8.9V.6zM127.4.6h5.9v20.8h-5.9zM147.6.6h-10.1v20.8h5.9v-5.6h4.2c5.6-.1 8.3-3.4 8.3-7.6.1-4.1-2.7-7.6-8.3-7.6zm0 10.2h-4.2V5.6h4.2c1.6 0 2.5 1.2 2.5 2.6 0 1.4-.9 2.6-2.5 2.6z" />
-				</SVG>
+				<p className="gif-branding-text">


I wonder if we should only display the tagline for new blocks, and not for existing blocks where the gifs are powered by Giphy?

This text is only show in the sidebar of the admin, so I think it's OK because it only shows up when managing GIFs.

Existing Giphy blocks do not get the attribution on the front end.

jeherve · 2024-10-30T13:49:35Z

projects/plugins/jetpack/extensions/blocks/gif/controls.js

-					<Path d="M14.4 5.7c-3 0-5.1 2.2-5.1 5.2 0 2.6 1.6 5.1 5.1 5.1 3.5 0 5.1-2.5 5.1-5.2-.1-2.6-1.7-5.1-5.1-5.1zm-.1 8.9c-2.5 0-3.5-1.9-3.5-3.7 0-2.2 1.2-3.8 3.5-3.8 2.4 0 3.5 2 3.5 3.8.1 2-1 3.7-3.5 3.7zM57.7 11.6h5.5v-1.5h-5.5V7.4h5.7V5.9h-7.3v10h7.3v-1.6h-5.7zM38 14.3v-2.7h5.5v-1.5H38V7.4h5.7V5.9h-7.3v10h7.3v-1.6zM93 10.3l-2.7-4.4h-1.9V6l3.8 5.8v4.1h1.6v-4.1l4-5.8v-.1h-2zM69.3 5.9h-3.8v10h3.8c3.5 0 5.1-2.5 5-5.1-.1-2.5-1.6-4.9-5-4.9zm0 8.4h-2.2V7.4h2.2c2.3 0 3.4 1.7 3.4 3.4s-1 3.5-3.4 3.5zM86.3 10.7c.9-.4 1.4-1.1 1.4-2 0-2-1.5-2.8-3.4-2.8h-4.6v10h4.6c2 0 3.7-.7 3.7-2.8 0-.8-.5-2-1.7-2.4zm-5-3.4h3c1.2 0 1.8.7 1.8 1.4 0 .8-.6 1.3-1.8 1.3h-3V7.3zm3 7.1h-3v-2.9h3c.9 0 2.1.5 2.1 1.6 0 1-1.2 1.3-2.1 1.3zM113.9 13.3h5.3V16c-1.2.9-2.9 1.1-4 1.1-4.2 0-5.6-3.3-5.6-6 0-4.1 2.2-6.1 5.6-6.1 1.4 0 3.2.4 4.8 1.8l3.4-3.4C120.7.6 118.1 0 115.2 0c-7.8 0-11.4 5.6-11.4 11s3.1 10.9 11.4 10.9c4 0 7.6-1.4 8.9-4.1V8.6h-10.2v4.7zM171.9 8.5h-7.4V.6h-5.9v20.8h5.9v-7.8h7.4v7.8h5.9V.6h-5.9zM195.1.6l-4.5 7.1-4.3-7.1h-6.6v.2l7.9 12.3v8.3h5.9v-8.3L201.8.9V.6zM127.4.6h5.9v20.8h-5.9zM147.6.6h-10.1v20.8h5.9v-5.6h4.2c5.6-.1 8.3-3.4 8.3-7.6.1-4.1-2.7-7.6-8.3-7.6zm0 10.2h-4.2V5.6h4.2c1.6 0 2.5 1.2 2.5 2.6 0 1.4-.9 2.6-2.5 2.6z" />
-				</SVG>
+				<p className="gif-branding-text">
+					<a href="https://www.tumblr.com" target="_blank" rel="noopener noreferrer">


What do you think about using ExternalLink here, to clearly indicate that the link opens a new window?

jeherve · 2024-10-30T15:25:19Z

...s/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-tumblr-gifs.php

+		$this->wpcom_is_site_specific_endpoint = false;
+		$this->wpcom_is_wpcom_only_endpoint    = false;


I believe this will need to be set to true if we want the block to be usable outside of WordPress.com simple.

I think you could look at existing endpoints in projects/plugins/jetpack/_inc/lib/core-api/wpcom-endpoints/ for some existing work on this. The Blogging prompts endpoint for example, would be a good example:
projects/plugins/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v3-endpoint-blogging-prompts.php

It is an endpoint that is used in a similar way to the tumblr search. It can also be used by contributors and above. Admins shouldn't be the only ones to be able to insert GIF blocks in a post, as long as the site is connected to WordPress.com you should be able to make a request.

Thanks, I fixed up a few things here following the writing block as an example!

jeherve · 2024-10-30T15:28:12Z

...s/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-tumblr-gifs.php

+	 * @return void
+	 */
+	public function register_routes() {
+		register_rest_route(


Are the extra routes meant to be used in a future version of the block? I'm asking to know if it's worth adding them now, or if it may be worth waiting until we really need them?

In the future I think we would like to use the Popular GIFs endpoint, but I agree we can remove it for now.

justinshreve · 2024-10-31T19:53:22Z

Thank you for the review @jeherve! I've pushed a few changes to address the feedback, especially around the auth/proxying part. I also updated the testing instructions since the WP.com portion of this (the key) is now deployed.

jeherve

Thanks for working on those changes!

Things are working well on WordPress.com Simple, but not on WoA or self-hosted yet since there no endpoint to respond to https://public-api.wordpress.com/wpcom/v2/sites/%blog_id%/tumblr-gifs/search/%keyword% yet, as far as I can tell. Is there a Phab diff with that endpoint, that I could use to test this on Atomic and self-hosted?

jeherve · 2024-11-04T19:03:59Z

projects/plugins/jetpack/extensions/blocks/gif/block.json

 		}
 	},
 	"example": {
 		"attributes": {
 			"align": "center",
-			"giphyUrl": "https://giphy.com/embed/fxKWgoOG9hzPPkE1oc",
+			"gifUrl": "https://64.media.tumblr.com/3131b9d2a05485e7ae7838a8b1314ab2/2d72fb0f707ea67a-5f/s500x750/d45e10288e4ff6a775c879978f52c87d3318ff8d.gif",


Any chance you could find an image with a different aspect ratio? It doesn't look great right now:

justinshreve · 2024-11-05T21:43:56Z

Things are working well on WordPress.com Simple, but not on WoA or self-hosted yet since there no endpoint to respond to https://public-api.wordpress.com/wpcom/v2/sites/%blog_id%/tumblr-gifs/search/%keyword% yet, as far as I can tell. Is there a Phab diff with that endpoint, that I could use to test this on Atomic and self-hosted?

Not at the moment, as that would require adding the endpoints in Moon/Sun myself. The way I've been testing this is by running bin/jetpack-downloader test jetpack tumblr-gif-block on my sandbox, and then pointing the Jetpack install to it with JETPACK__SANDBOX_DOMAIN.

I did already deploy code that will load the endpoints from Jetpack; it just needs the files to exist. I can build a Phab diff, but I think it might just be easier to use the jetpack-downloader script.

--

Also, we might be changing the way the GIF is embedded, so I'll follow up on that shortly!

…rnalLink for sidebar attribution

justinshreve self-assigned this Oct 24, 2024

github-actions bot added [Block] GIF [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests Docs labels Oct 24, 2024

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 24, 2024

justinshreve force-pushed the tumblr-gif-block branch from 69d2de0 to b71add9 Compare October 24, 2024 17:22

justinshreve added the [Status] In Progress label Oct 24, 2024

justinshreve removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 24, 2024

justinshreve changed the title ~~[WIP] GIF Block: Replace source with Tumblr GIF Search~~ GIF Block: Replace source with Tumblr GIF Search Oct 24, 2024

justinshreve added [Status] Needs Team Review and removed [Status] In Progress labels Oct 24, 2024

justinshreve requested a review from a team October 29, 2024 13:11

jeherve reviewed Oct 30, 2024

View reviewed changes

justinshreve force-pushed the tumblr-gif-block branch from 91da91d to ad9f06c Compare October 31, 2024 16:55

jeherve reviewed Nov 4, 2024

View reviewed changes

justinshreve added 10 commits November 18, 2024 11:13

Convert the GIF Block to use Tumblr as a source instead

4378a03

Support old giphyUrl attribute so we don't break older embeds

20bf50d

Make sure GIFs look the same on the front end and the editor

0bb8994

Update tests, add test case for legacy block

3c4a3ad

changelog

c17d9c8

Add back validate test

b9744f0

Add Testing Instructions

fae4885

Fix phan issues

7c1c5b9

update apiFetch, add global to apiFetch

0c89879

Fix API permissions on WP.com, show an error if the request fails

ccf1ab5

justinshreve added 3 commits November 18, 2024 11:13

If the user is logged in, it's a WP.com request

6ee5aea

Remove unusued endpoints, fix up auth and proxing to WP.com. Use Exte…

1a540cf

…rnalLink for sidebar attribution

Fix docblock type

3f3c106

justinshreve force-pushed the tumblr-gif-block branch from aa1e647 to 3f3c106 Compare November 18, 2024 16:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GIF Block: Replace source with Tumblr GIF Search #39896

GIF Block: Replace source with Tumblr GIF Search #39896

justinshreve commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

jeherve left a comment

jeherve Oct 30, 2024

justinshreve Oct 31, 2024

jeherve Oct 30, 2024

justinshreve Oct 31, 2024

jeherve Oct 30, 2024

justinshreve Oct 31, 2024

jeherve Oct 30, 2024

justinshreve Oct 31, 2024

justinshreve commented Oct 31, 2024

jeherve left a comment

jeherve Nov 4, 2024

justinshreve commented Nov 5, 2024 •

edited

Loading

		$this->wpcom_is_site_specific_endpoint = false;
		$this->wpcom_is_wpcom_only_endpoint = false;

GIF Block: Replace source with Tumblr GIF Search #39896

Are you sure you want to change the base?

GIF Block: Replace source with Tumblr GIF Search #39896

Conversation

justinshreve commented Oct 24, 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:

Demo:

github-actions bot commented Oct 24, 2024 • edited Loading

github-actions bot commented Oct 24, 2024 • edited Loading

jeherve left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinshreve commented Oct 31, 2024

jeherve left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinshreve commented Nov 5, 2024 • edited Loading

justinshreve commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

justinshreve commented Nov 5, 2024 •

edited

Loading