Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shortcode: Fix the YouTube URL for the private video #39454

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

arthur791004
Copy link
Contributor

@arthur791004 arthur791004 commented Sep 19, 2024

Fixes p1725499365595119-slack-CRWCHQGUB

Proposed changes:

  • There is a regression caused by Shortcode: Get rid of custom shortcodes for YouTube and Vimeo in favor of Core #39096 as we didn't notice that the custom embed handler would be called by the /oembed/1.0/sites/:site_id/proxy endpoint. Before that change, we could always get the result from the oembed proxy endpoint for every YouTube URL even if it was either private or invalid. As a result, the scheduled YouTube video (as a private video) could be embedded correctly.
  • To make the scheduled YouTube video work as before, we reverted part of that PR and made a slight change to keep the title of the YouTube video available on the iframe. But it also means that every YouTube URL can be embedded correctly even if it's the wrong one.
  • The changes might look weird as the custom embed hanlder ($wp_embed->get_embed_handler_html) works differently between the oembed proxy endpoint and how it renders on the frontend.
    • For the oembed proxy endpoint, the order is
      • Get the data from the cache
      • Get the data from the oembed endpoint according to the provider of the URL. For YouTube, it's https://www.youtube.com/oembed?format=json&url=
      • If we cannot get the result, fallback to the custom oembed handler, that is, wpcom_youtube_embed_crazy_url
      • See here for more details.
    • For how it renders on the frontend, the order is
      • Get the HTML from the custom oembed handler first
      • If not, get the HTML from the cache
      • If not, get the HTML from the oembed endpoint according to the provider of the URL
      • See here for more details
  • As mentioned above, the HTML from the custom handler is different. If we keep the previous way, the title of the YouTube video would be missing because the custom embed handler of YouTube couldn't get the title of the video. Hence, this PR registers the custom embed handler of YouTube for the oembed proxy endpoint and then hooks the HTML from the custom handler to the pre_oembed_result filter to deprioritize its order on the frontend
  • Maybe we have to raise the PR to Core to make the order the same in the follow-up PR 🤔

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:

@arthur791004 arthur791004 self-assigned this Sep 19, 2024
Copy link
Contributor

github-actions bot commented Sep 19, 2024

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 fix/youtube-schedule-video branch.

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

    bin/jetpack-downloader test jetpack fix/youtube-schedule-video
    

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 github-actions bot added [Feature] Shortcodes / Embeds [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Sep 19, 2024
Copy link
Contributor

github-actions bot commented Sep 19, 2024

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.

@github-actions 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 Sep 19, 2024
@arthur791004 arthur791004 requested review from jeherve and a team September 19, 2024 10:22
@arthur791004 arthur791004 added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Sep 19, 2024
Copy link
Contributor

@taipeicoder taipeicoder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works as intended.
SCR-20240920-psvd

@arthur791004 arthur791004 merged commit 1985f99 into trunk Sep 20, 2024
60 checks passed
@arthur791004 arthur791004 deleted the fix/youtube-schedule-video branch September 20, 2024 17:06
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 20, 2024
@github-actions github-actions bot added this to the jetpack/13.9 milestone Sep 20, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Shortcode: Fix the YouTube URL for the private video

* changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Shortcodes / Embeds [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants