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: Add e2e tests to Page Cache #36501

Merged
merged 20 commits into from
Apr 5, 2024
Merged

Boost: Add e2e tests to Page Cache #36501

merged 20 commits into from
Apr 5, 2024

Conversation

dilirity
Copy link
Member

@dilirity dilirity commented Mar 21, 2024

Part of #33877

Proposed changes:

  • Add e2e tests for the Page Cache module:
    • Meta isn't visible while the module is deactivated;
    • Cache header isn't present while the module is deactivated;
    • There's an error when plain permalinks are used and there's an attempt to activate the module;
    • Meta is visible while the module is activated;
    • Cache header is present while the module is activated.
  • Update e2e tests to allow changing permalinks on the site;
  • Update Boost CLI to support activating/deactivating Page Cache;
  • Update docker e2e test matrix to include tests (you can check the GH actions section to see the tests).

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

n/a

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

no

Testing instructions:

  • Run tests to see if everything is working as expected.

@dilirity dilirity added [Status] In Progress E2E Tests [Plugin] Boost A feature to speed up the site and improve performance. labels Mar 21, 2024
@dilirity dilirity self-assigned this Mar 21, 2024
Copy link
Contributor

github-actions bot commented Mar 21, 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Boost plugin:

  • Next scheduled release: May 7, 2024.
  • Scheduled code freeze: April 29, 2024.

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

@dilirity dilirity changed the title Boost: Add e2e tests for modules Boost: Add e2e tests to Page Cache Mar 25, 2024
@github-actions github-actions bot added the Actions GitHub actions used to automate some of the work around releases and repository management label Mar 28, 2024
@dilirity dilirity marked this pull request as ready for review March 29, 2024 10:38
@dilirity dilirity requested a review from a team March 29, 2024 10:39
@dilirity
Copy link
Member Author

dilirity commented Apr 2, 2024

Ready for review.

This PR needs an update for making relevant parts of the site writable, as wp-config.php and wp-content aren't writable, so tests fail because cache can't be enabled.

I've reached out for help here p1711711037050859-slack-CBG1CP4EN

Copy link
Contributor

@haqadn haqadn left a comment

Choose a reason for hiding this comment

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

Looks good so far, can we have a test where instead of just checking for the cache header, we look for cache-hit? This will cover more areas of the caching.

@dilirity
Copy link
Member Author

dilirity commented Apr 3, 2024

@haqadn thanks for the suggestion. I've updated the tests to check the value of the header as well.

@dilirity dilirity requested a review from haqadn April 3, 2024 14:26
@dilirity dilirity enabled auto-merge (squash) April 4, 2024 13:02
Copy link
Contributor

@haqadn haqadn left a comment

Choose a reason for hiding this comment

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

👍🏼

@dilirity dilirity merged commit 26f9122 into trunk Apr 5, 2024
60 of 61 checks passed
@dilirity dilirity deleted the add/boost/e2e-page-cache branch April 5, 2024 09:12
TimBroddin pushed a commit that referenced this pull request Apr 10, 2024
* Add test for Page Cache meta visibility when module is inactive

* Add test for Page Cache header when module is inactive

* Add test for Page cache meta visibility when module is active

* Add permalink tests for page cache

* add changelog

* Add cache header test

* Update boost CLI to support page cache

* Fix test

* Update GH actions to include page cache tests

* Fix page cache tests

* Update file permissions in docker to be writable

* Add pnpm script to make files used by page cache writable

* Revert permission changes

* Fix prepare script

* Update script

* Update page cache test to check header value as well
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Actions GitHub actions used to automate some of the work around releases and repository management Docker E2E Tests [Plugin] Boost A feature to speed up the site and improve performance. [Tests] Includes Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants