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.

Sign up for GitHub

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

Jump to bottom

Update use cache control immutable for static file #39484

Open
wants to merge 3 commits into
base: 2.4-develop
Choose a base branch
from
Open

Update use cache control immutable for static file #39484

wants to merge 3 commits into from
+4 −5

Conversation

rogerdz
Copy link
Contributor

@rogerdz rogerdz commented Dec 16, 2024 •
edited by m2-assistant bot
Loading

Description (*)

Update Cache-Control header to static file (assets, media)
As explained in the Mozilla documentation:
``When a user reloads the browser, the browser will send conditional requests for validating to the origin server. But it's not necessary to revalidate those kinds of static resources even when a user reloads the browser, because they're never modified. immutable tells a cache that the response is immutable while it's fresh and avoids those kinds of unnecessary conditional requests to the server.`
Inspire by:
serversideup/docker-php#487
https://www.keycdn.com/blog/cache-control-immutable

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. Check cache control header static file (js, css, image,...)
    image
    image
    image

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Update use cache control immutable for static site #39486: Update use cache control immutable for static site

@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Dec 16, 2024

Hi @rogerdz. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@rogerdz
Copy link
Contributor Author

rogerdz commented Dec 16, 2024

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Dec 17, 2024
Open
5 tasks
@engcom-Hotel engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Dec 17, 2024
@rogerdz rogerdz changed the title Update use cache control immutable for static site Update use cache control immutable for static file Dec 17, 2024
@hostep
Copy link
Contributor

hostep commented Dec 18, 2024 •
edited
Loading

In my opinion, we should only do this for static assets in /static/ because those assets are versioned and each time we deploy the version changes. So to the browser this looks like a new file after each deploy.
However, it should - in my opinion - NOT be done for static assets in /media/ as there is no guarantee that those are in fact immutable. Merchants can just remove and re-upload a different file with the same filename.
So I would revert the changes done around line 170 in the nginx sample config file.

Also, we should not only update the nginx config file, but also the .htaccess file in pub/static/ used by the Apache httpd webserver.

And we should also be aware that this feature is not fully supported yet by the various major browsers at this moment: https://caniuse.com/mdn-http_headers_cache-control_immutable

@rogerdz
Copy link
Contributor Author

rogerdz commented Dec 23, 2024

@magento run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: pending review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Update use cache control immutable for static site
3 participants
@rogerdz @engcom-Hotel @hostep