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 responsiveness during CCSS generation retry #40675

Merged
merged 10 commits into from
Dec 20, 2024

Conversation

haqadn
Copy link
Contributor

@haqadn haqadn commented Dec 18, 2024

Fixes #38169
Closes #40407

Proposed changes:

  • Optimistically update the UI to avoid any flicker when critical CSS generation is attempted after an error.

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

None

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

No

Testing instructions:

  • Use the Boost Dev plugin and set "Force Critical CSS generation Error" to timeout.
  • Attempt C.CSS generation.
  • It should fail, and you should see an error.
  • Retry the generation.
  • It should show the generating progress bar immediately without the UI glitch seen on Boost: Error UI takes a while to update after refreshing #38169
  • Make sure cloud CSS and local C.CSS are both working correctly in different situations after this change.

@haqadn haqadn requested a review from a team December 18, 2024 21:07
@haqadn haqadn self-assigned this Dec 18, 2024
@github-actions github-actions bot added the [Plugin] Boost A feature to speed up the site and improve performance. label Dec 18, 2024
Copy link
Contributor

github-actions bot commented Dec 18, 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 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: none scheduled.

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 Dec 18, 2024
@haqadn haqadn added this to the boost/next milestone Dec 18, 2024
@haqadn haqadn added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it 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 Dec 18, 2024
Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

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

Free critical css seems to work fine:

xXgEoRC2B1ZctQpX8yaQ04Crur7SAhCItwLztQGR.mp4

Although, I noticed the Contact Support button flashing for a brief moment when you click refresh.

I recorded a video of the above recording and slowed it down manually. I think it's just one frame when re-rendering the component:

LVwsou3nDVTZdckac27aLV0gKGlolK4yrL6Z4NLO.mp4

Just wanted to add this, technically the user will miss it, but it seems something's a miss. I don't think it should be happening.

For easier testing the free version, you can use this - just one page in the payload:

add_filter( 'jetpack_boost_critical_css_providers', function ( $sources ) {
	return array(
		array (
			'key' => 'core_posts_page',
			'label' => 'Posts page',
			'urls' => array (
				'http://jetpack-boost.test/blog/',
			),
			'success_ratio' => 1,
		),
	);
} );

For premium, there's still an issue. It's hard to demonstrate, but you can try it for yourself by throttling the network before clicking refresh.

Here's what it looks like:

eTEWMdr0AJmZTjqms9JlZ9L5r5ejdYITE0IFpey4.mp4

Clicking refresh immediately shows the Contact Support button instead of the progress description.

@haqadn
Copy link
Contributor Author

haqadn commented Dec 19, 2024

  • I had inadvertently broken the retried state while working on this. A fix for that was f899ee1.
  • Addressed the cloud CSS issue be17aa6.
  • The single frame issue: bd531b1. Because we are in the business of improving web vitals after all.

@haqadn haqadn requested a review from dilirity December 19, 2024 19:21
Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

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

Wow - awesome work on this!

I couldn't find issues with the UI.

:shipit:

@haqadn haqadn merged commit 753c548 into trunk Dec 20, 2024
62 checks passed
@haqadn haqadn deleted the fix/critical-css-status branch December 20, 2024 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Boost A feature to speed up the site and improve performance. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Boost: Error UI takes a while to update after refreshing
2 participants