VideoPress: add unique ID attributes to videopress elements

[simison]

Proposed changes:

• Adds unique ID attributes to VideoPress attributes, thus allowing us to link directly to the point on the page where the video is, for example, from emails.

Goes together with D161878-code, which adds the hash to URLs at emails:

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:

Block

• Add VideoPress block

• Look at the page's HTML on frontend of the site, and note id="jetpack-videopress-UNIQUE_ID" is in HTML.

• Try adding block an ID from Block's settings panel, and note how that gets added to parent <figure> element just fine.

  

Shortcode

• Go to the WP media library, find the video, and copy the shortcode from its details page.

• Add shortcode block, and use the videopress shortcode.

  

• The HTML output should contain the ID.

[github-actions]

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/videopress-id-in-html branch.

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

  bin/jetpack-downloader test jetpack update/videopress-id-in-html
  

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]

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:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. 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.
3. 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 October 1, 2024 (scheduled code freeze on September 30, 2024).

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

[simison]

I added Apex to see the PR as well, just as an FYI, as they own VideoPress on the Dotcom side.

[simison]

The only downside seems to be that if the same exact video is on the page multiple times, the ID will be identical, potentially linking to the wrong spot + having the same ID multiple times isn't strictly valid HTML:

It feels too much of an edge case to account for, but it could be a good follow-up PR.

[enejb]

potentially linking to the wrong spot + having the same ID multiple times isn't strictly valid HTML:
Yes I was going to bring this up as well.

Definitely an edge case. We can do a follow up on if is is requested.

[anomiex]

Code looks reasonable to me at a quick read-through. I haven't tested it though.

I left one comment inline that's not really related to this PR, feel free to ignore it if you want.

[enejb]

@simison While testing the code.
I found 2 issues. The shortcode case didn't work for me as expected.

The shotcode that generated the following html.

I update the code to match the "old" shortcode id. Mostly because I didn't want to break existing behaviour.

Since the previous shortcode had implemented a increment I also implemented in the new solution.

The changes that I have also mean that we will need to update the .com code as well.

[enejb]

This now works more as expected for me.

[simison]

I found 2 issues. The shortcode case didn't work for me as expected.

Hm, weird. I did test it with the shortcode block though, did you run the shortcode in different way?

We can work out the backend side separately but let's get this in so that we have something in the next release.

[simison]

Looks good in my testing now for shortcode and videopress blocks:

Core-video block extended with VideoPress does not have the ID, but I think we can leave that for a separate PR. We could first check if the publisher defined their own ID in the editor and use that; if not, provide our own fallback in the block attributes.

Here's example markup for video block:

<!-- wp:video {"id":436,"guid":"87dgjNyr","videoPressClassNames":"wp-block-embed is-type-video is-provider-videopress","title":"example-video-food-mp4"} -->
<figure class="wp-block-video wp-block-embed is-type-video is-provider-videopress"><div class="wp-block-embed__wrapper">
https://videopress.com/v/87dgjNyr?resizeToParent=true&amp;cover=true&amp;preloadContent=metadata&amp;useAverageColor=true
</div></figure>
<!-- /wp:video -->