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: Improve critical css generation process #41946

Draft
wants to merge 11 commits into
base: trunk
Choose a base branch
from

Conversation

dilirity
Copy link
Member

@dilirity dilirity commented Feb 21, 2025

This PR fixes the C.CSS generation process breaking when an invalid URL was passed to the critical CSS gen library.

Recommendations will also now be more unique instead of bunched together under one entry on the advanced recommendations page. Previously, if a provider failed and had URLs with a 301, 404 and 500 error, items would be listed under the 500 error (or the most frequent one). Now they all have separate recommendations and can be dismissed individually. In other words, the error_status for providers has been replaced with dismissed_errors and now holds all error types that were dismissed via the UI.

Fixes #41391

Proposed changes:

  • Fix invalid URLs passed to critical CSS gen library, resulting in the whole process being broken;
  • Add InvalidURLError recommendation and steps on how to address it;
  • Add watch command to CSS gen package;
  • Fix not reporting non-200 HTTP errors to the user. This means, 404 pages will no longer be used to generate critical css for a group;
  • Update advanced recommendations listing, to list recommendations based on provider-error type, instead of just provider.

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:

TBD

@dilirity dilirity added [Type] Bug When a feature is broken and / or not performing as intended [Status] In Progress RNA [Plugin] Boost A feature to speed up the site and improve performance. [Boost Feature] Critical CSS Issues involving the Critical CSS feature in Boost [JS Package] Critical Css Gen labels Feb 21, 2025
@dilirity dilirity self-assigned this Feb 21, 2025
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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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: March 3, 2025.

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

Copy link

jp-launch-control bot commented Feb 21, 2025

Code Coverage Summary

Coverage changed in 7 files. Only the first 5 are listed here.

File Coverage Δ% Δ Uncovered
projects/plugins/boost/app/assets/src/js/features/critical-css/lib/critical-css-errors.ts 0/50 (0.00%) 0.00% 13 💔
projects/plugins/boost/app/lib/critical-css/Critical_CSS_State.php 0/99 (0.00%) 0.00% 8 💔
projects/plugins/boost/app/assets/src/js/features/critical-css/more-list/more-list.tsx 0/13 (0.00%) 0.00% 5 💔
projects/plugins/boost/app/assets/src/js/pages/critical-css-advanced/critical-css-advanced.tsx 0/42 (0.00%) 0.00% 4 💔
projects/plugins/boost/app/assets/src/js/features/critical-css/error-description/error-description.tsx 0/14 (0.00%) 0.00% 2 ❤️‍🩹

1 file is newly checked for coverage.

File Coverage
projects/plugins/boost/app/assets/src/js/features/critical-css/lib/stores/recommendation-types.ts 0/0 (—%) 🤷

Full summary · PHP report · JS report

Coverage check overridden by I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. .

@dilirity dilirity added the I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. label Feb 21, 2025
@dilirity dilirity force-pushed the fix/critical-css-gen/invalid-url-breaking-whole-process branch from 1caa3a8 to fa49239 Compare February 21, 2025 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Boost Feature] Critical CSS Issues involving the Critical CSS feature in Boost I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. [JS Package] Critical Css Gen [Plugin] Boost A feature to speed up the site and improve performance. RNA [Status] In Progress [Tests] Includes Tests [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Critical CSS Gen] Prevent bad URLs from breaking Critical CSS Generator
1 participant