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

WPSC: Check that there is cached content to display in browser #40342

Merged
merged 3 commits into from
Dec 2, 2024

Conversation

donnchawp
Copy link
Contributor

If a website is using an NFS/Samba share to host their cached content, there may be a race condition when serving cache pages. This can happen when one server is serving a page, it checks for the existence of the cache file, and before the file can be read, another server deletes the file.

The check is repeated multiple times because different processing is done each time, sometimes with and without gzipping the data.

Fixes https://wordpress.org/support/topic/edge-case-can-lead-to-blank-page-being-served/

Proposed changes:

  • Make sure that $cachefiledata isn't false before serving a cached page.

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:

  • This would be very difficult to test as it would require two servers, one serving a page, and the other modifying it.
  • However, file_get_contents returns false if there's an error, and it can't read the file, so this should be easy to visually check.

@github-actions github-actions bot added [Plugin] Super Cache A fast caching plugin for WordPress. [Status] In Progress labels Nov 26, 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!


Super Cache plugin:

  • Next scheduled release: none scheduled.

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

@donnchawp donnchawp changed the title Check that there is cached content to display in browser WPSC: Check that there is cached content to display in browser Nov 26, 2024
@donnchawp donnchawp self-assigned this Nov 26, 2024
@donnchawp donnchawp marked this pull request as ready for review November 26, 2024 14:00
@donnchawp donnchawp requested a review from a team November 26, 2024 14:01
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.

Nice, I like the logging!

:shipit:

@donnchawp donnchawp merged commit adabdc7 into trunk Dec 2, 2024
57 checks passed
@donnchawp donnchawp deleted the update/super-cache/cache-file-race-condition branch December 2, 2024 14:10
@github-actions github-actions bot added this to the super-cache/1.12.5 milestone Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Super Cache A fast caching plugin for WordPress.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants