README

This repository provides a collection of patches to enable and optimize Back/Forward Cache (BFCache) support in Magento 2. These patches are based on the work from Magento 2 PR #40750.

Why?

By default, Magento 2 prevents browsers from caching storefront pages in the Back/Forward Cache by sending Cache-Control: no-store headers. This means that every time a user clicks the "Back" or "Forward" button, the browser must re-fetch the page from the server and re-execute all JavaScript, leading to slower navigation and a less responsive experience.

BFCache allows the browser to save a complete snapshot of the page (including the JavaScript state) in memory. When a user navigates back, the page is restored instantly.

These patches improve Magento 2 by:

Removing restrictive headers: Allowing the browser to utilize BFCache for storefront pages.
Handling state restoration: Adding pageshow event listeners to refresh dynamic content (like the minicart, customer data, and authentication tokens) when a page is restored from cache.
Improving Performance: Significantly boosting Core Web Vitals, specifically Largest Contentful Paint (LCP) and Interaction to Next Paint (INP) during history navigation.

How to Install

These patches work with any Composer-based patch tool, including cweagans/composer-patches and vaimo/composer-patches. Choose the option that fits your setup.

Option 1: Git Clone (Recommended)

Clone this repository into a patches directory in your Magento root, move the patches.json to the root, and apply the patches:

git clone https://github.com/GrimLink/magento-bfcache-patches patches
mv patches/patches.json .
composer patches-relock
composer patches-repatch

Option 2: Curl or Wget

Download and extract the patches, move the configuration file, and apply the changes:

Using Curl:

mkdir -p patches
curl -L https://github.com/GrimLink/magento-bfcache-patches/archive/refs/heads/main.tar.gz | tar -xz -C patches --strip-components=1
mv patches/patches.json .
composer patches-relock
composer patches-repatch

Using Wget:

mkdir -p patches
wget -O - https://github.com/GrimLink/magento-bfcache-patches/archive/refs/heads/main.tar.gz | tar -xz -C patches --strip-components=1
mv patches/patches.json .
composer patches-relock
composer patches-repatch

Merging with Existing patches.json

If you already have a patches.json file in your project root, do not overwrite it. Instead, copy the entries from this repository's patches.json into your existing file and run the following commands to update your lock file and apply the new patches:

composer patches-relock
composer patches-repatch

Option 3: Composer Require (vaimo/composer-patches)

If you are using vaimo/composer-patches with package patch sources enabled, you can install this package directly via Composer and vaimo will pick up and apply the patches automatically.

composer require grimlink/magento-bfcache-patches

Warning

This method requires vaimo/composer-patches with package-level patch sources enabled. See the vaimo/composer-patches documentation for the required configuration. If you are using cweagans/composer-patches, use Option 1 instead.

Option 4: Using the "Mage" Repository

If you are using the GrimLink/mage distribution or its tools, there is a built-in option to add this patch set automatically.

License

These patches are licensed under the same terms as Magento 2 (OSL-3.0 / Apache-2.0).

grimlink / magento-bfcache-patches

Maintainers

Package info

Statistics

Security