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

Boost: Make sure Critical CSS always works with absolute URLs #39456

Merged
merged 2 commits into from
Sep 24, 2024

Conversation

dilirity
Copy link
Member

@dilirity dilirity commented Sep 19, 2024

Partially addresses #39455.

Proposed changes:

  • Prevent source providers from returning relative URLs. Bad for Critical/Cloud CSS.

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

p1726628647463949-slack-C016BBAFHHS

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

no

Testing instructions:

To see the critical css source-providers endpoint (wp-json/jetpack-boost/v1/list-source-providers), you'll need to have the Boost Developer plugin running.

Test that it shows relative URLs

  • Setup Boost free from trunk;
  • Add this snippet to your site - this will make posts have relative URLs (make sure you have at least one post on your site):
add_filter('post_link', 'make_post_url_relative', 10, 2);
function make_post_url_relative($url, $post_id) {
    if (get_post_type($post_id) === 'post') {
        return wp_make_link_relative($url);
    }
    return $url;
}

CleanShot 2024-09-19 at 13 43 20

Test that it doesn't show relative URLs

  • Switch to this PR's branch;
  • Visit the endpoint URL again;
  • There should be no relative URLs;
  • Try to generate Critical CSS - it should work.

@dilirity dilirity added [Status] Needs Team Review [Plugin] Boost A feature to speed up the site and improve performance. [Boost Feature] Critical CSS Issues involving the Critical CSS feature in Boost [Boost Feature] Cloud CSS labels Sep 19, 2024
@dilirity dilirity requested a review from a team September 19, 2024 10:44
@dilirity dilirity self-assigned this Sep 19, 2024
Copy link
Contributor

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!


Boost plugin:

  • Next scheduled release: none scheduled.

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

Copy link
Contributor

@donnchawp donnchawp 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 expected, even when there's only one URL, it's passed as an array of one.

@dilirity dilirity merged commit 671d537 into trunk Sep 24, 2024
63 checks passed
@dilirity dilirity deleted the fix/boost/relative-urls-breaking-critical-css-gen branch September 24, 2024 08:28
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* Prevent critical css source providers from having relative URLs

* add changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Boost Feature] Cloud CSS [Boost Feature] Critical CSS Issues involving the Critical CSS feature in Boost [Plugin] Boost A feature to speed up the site and improve performance.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants