From e3f154279c756c07f27e092dcdde01d2dd9f0199 Mon Sep 17 00:00:00 2001
From: grimlink <sean@hyva.io>
Date: Thu, 1 Oct 2026 11:27:01 +0200
Subject: [PATCH] =?UTF-8?q?Don't=20load=20the=20bfcache=20handler=20script?=
 =?UTF-8?q?=20on=20Hyv=C3=A4=20themes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CHANGELOG.md                                  |   9 +
 README.md                                     |   3 +-
 etc/adminhtml/system.xml                      |   6 +-
 view/frontend/layout/default_hyva.xml         |   9 +-
 .../templates/hyva/bfcache/handler.phtml      | 178 ------------------
 5 files changed, 17 insertions(+), 188 deletions(-)
 delete mode 100644 view/frontend/templates/hyva/bfcache/handler.phtml

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 632d155..82deca9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## [Unreleased]
+
+### Changed
+- The bfcache handler script is no longer loaded on Hyvä themes. Hyvä handles bfcache restores natively (messages, cart drawer, menus and customer section data), so the script only duplicated that work. The bfcache response headers and URL exclusions still apply on Hyvä.
+- The **Update Mini Cart on User Interaction** and **Auto Close Menu** settings now note that they have no effect on Hyvä themes.
+
+### Removed
+- `view/frontend/templates/hyva/bfcache/handler.phtml`.
+
 ## [2.3.0] - 2026-05-11
 
 ### Added
diff --git a/README.md b/README.md
index 8df34e1..faad252 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,8 @@ All values can be configured at Default, Website, and Store View scopes.
   - Yes: Mini cart updates only after user interaction when page is restored from cache (Default)
   - No: Mini cart updates immediately on page restore
   - Recommended "Yes" to maintain optimal Page Speed and Core Web Vitals scores
-* **Auto Close Menu** - Automatically close open menus when page is restored from back/forward cache (for compatible themes). (Default: Yes)
+  - Has no effect on Hyvä themes, Hyvä reloads the mini cart natively on restore
+* **Auto Close Menu** - Automatically close open menus when page is restored from back/forward cache (for compatible themes). (Default: Yes) Has no effect on Hyvä themes, Hyvä closes its menus natively on restore.
 * **Exclude URLs** - Optional configuration to exclude specific URL patterns from back/forward cache. Enter URL parts (substring), one per line. The extension automatically excludes non-cacheable URLs, so this is only needed for custom cached URLs that load private data via JavaScript.
 
 > [!IMPORTANT]  
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
index 83cb140..cf7778b 100644
--- a/etc/adminhtml/system.xml
+++ b/etc/adminhtml/system.xml
@@ -84,7 +84,8 @@
                         <comment><![CDATA[
                         <b>Yes:</b> Mini cart updates only after user interaction when page is restored from cache.<br>
                         <b>No:</b> Mini cart updates immediately on page restore.<br>
-                        <b>Recommended "Yes" to maintain optimal Page Speed and Core Web Vitals scores.</b>
+                        <b>Recommended "Yes" to maintain optimal Page Speed and Core Web Vitals scores.</b><br>
+                        Has no effect on Hyvä themes, Hyvä handles this natively.
                         ]]>
                         </comment>
                     </field>
@@ -92,7 +93,8 @@
                         <label>Auto Close Menu</label>
                         <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                         <comment><![CDATA[
-                        Automatically close open menus when page is restored from back/forward cache (for compatible themes).
+                        Automatically close open menus when page is restored from back/forward cache (for compatible themes).<br>
+                        Has no effect on Hyvä themes, Hyvä handles this natively.
                         ]]>
                         </comment>
                     </field>
diff --git a/view/frontend/layout/default_hyva.xml b/view/frontend/layout/default_hyva.xml
index 9514561..f393f24 100644
--- a/view/frontend/layout/default_hyva.xml
+++ b/view/frontend/layout/default_hyva.xml
@@ -1,12 +1,7 @@
 <?xml version="1.0"?>
 <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
     <body>
-        <referenceBlock name="before.body.end">
-            <block
-                name="theme-optimization.bfcache.main"
-                template="MageOS_ThemeOptimization::hyva/bfcache/handler.phtml"
-                ifconfig="system/bfcache/general/enable"
-            />
-        </referenceBlock>
+        <!-- Hyvä handles bfcache restores natively, the handler would only duplicate that logic -->
+        <referenceBlock name="theme-optimization.bfcache.main" remove="true"/>
     </body>
 </page>
diff --git a/view/frontend/templates/hyva/bfcache/handler.phtml b/view/frontend/templates/hyva/bfcache/handler.phtml
deleted file mode 100644
index fc1c444..0000000
--- a/view/frontend/templates/hyva/bfcache/handler.phtml
+++ /dev/null
@@ -1,178 +0,0 @@
-<?php declare(strict_types=1);
-
-use Hyva\Theme\Model\ViewModelRegistry;
-use Hyva\Theme\ViewModel\HyvaCsp;
-use Magento\Framework\Escaper;
-use Magento\Framework\View\Element\Template;
-use MageOS\ThemeOptimization\ViewModel\BfCache;
-
-/** @var Template $block */
-/** @var Escaper $escaper */
-/** @var ViewModelRegistry $viewModels */
-/** @var HyvaCsp $hyvaCsp */
-/** @var BfCache $bfcacheConfig */
-$bfcacheConfig = $viewModels->require(BfCache::class);
-$isCustomerLoggedIn = $bfcacheConfig->isCustomerLoggedIn() ? 'true' : 'false';
-$enableUserInteractionRefresh = $bfcacheConfig->isReloadMiniCartOnInteraction() ? 'true' : 'false';
-$autoCloseMenuMobile = $bfcacheConfig->autoCloseMenuMobile() ? 'true' : 'false';
-?>
-
-<script>
-(() => {
-    class BFCacheHandler {
-        constructor() {
-            this.options = {
-                isCustomerLoggedIn: <?= $isCustomerLoggedIn ?>,
-                enableUserInteractionRefreshMiniCart: <?= $enableUserInteractionRefresh ?>,
-                autoCloseMenuMobile: <?= $autoCloseMenuMobile ?>
-            };
-
-            this.userInteractionEvents = ['touchstart', 'mouseover', 'wheel', 'scroll', 'keydown'];
-            this._reloadTriggered = false;
-            this.dom = {};
-
-            // Centralized selectors for reuse
-            this.selectors = {
-                cartDrawer: "[x-data^='initCartDrawer']",
-                mobileMenu: "[x-data^='initMenuMobile']",
-                desktopMenu: "[x-data^='initMenuDesktop']"
-            };
-        }
-
-        <?php
-        /**
-         * Safe DOM getter with caching (re-queries only if element removed)
-         */ ?>
-        getElement(key) {
-            const cached = this.dom[key];
-            if (cached && document.contains(cached)) return cached;
-            const el = document.querySelector(this.selectors[key]);
-            if (el) this.dom[key] = el;
-            return el;
-        }
-
-        init() {
-            this.refreshMiniCart();
-            this.reloadCustomerLoginPage();
-            this.actionAutoCloseMenu(this.options.autoCloseMenuMobile);
-        }
-
-        <?php
-        /**
-         * Refresh minicart on user interaction or immediately
-         */ ?>
-        refreshMiniCart() {
-            if (this.options.enableUserInteractionRefreshMiniCart) {
-                this.refreshMiniCartOnUserInteraction();
-            } else {
-                this.actionRefreshMiniCart();
-            }
-        }
-
-        refreshMiniCartOnUserInteraction() {
-            const refreshMiniCart = () => {
-                this.userInteractionEvents.forEach(eventType =>
-                    window.removeEventListener(eventType, refreshMiniCart)
-                );
-                this.actionRefreshMiniCart();
-            };
-            const opts = { once: true, passive: true };
-            this.userInteractionEvents.forEach(eventType =>
-                window.addEventListener(eventType, refreshMiniCart, opts)
-            );
-        }
-
-        <?php
-        /**
-         * Compare frontend & backend login state and reload if mismatched
-         */ ?>
-        reloadCustomerLoginPage() {
-            const backendLoggedInState = this.options.isCustomerLoggedIn;
-
-            let customerData = null;
-            try {
-                const cacheStorage = localStorage.getItem('mage-cache-storage');
-                if (cacheStorage) {
-                    customerData = JSON.parse(cacheStorage).customer || null;
-                }
-            } catch {
-                // Ignore parse errors silently
-            }
-
-            const frontendLoggedInState = Boolean(customerData?.firstname);
-
-            if (frontendLoggedInState !== backendLoggedInState && !this._reloadTriggered) {
-                this._reloadTriggered = true;
-                window.location.reload();
-            }
-        }
-
-        <?php
-        /**
-         * Dispatch Magento event to refresh customer sections (minicart, etc.)
-         */ ?>
-        actionRefreshMiniCart() {
-            window.dispatchEvent(new CustomEvent('reload-customer-section-data'));
-        }
-
-        <?php
-        /**
-         * Close cart drawer & optionally close mobile/desktop menus
-         */ ?>
-        actionAutoCloseMenu(autoCloseMenuMobile) {
-            window.dispatchEvent(new Event('clear-messages'));
-
-            const cartDrawer = this.getElement('cartDrawer');
-            if (cartDrawer && typeof Alpine !== 'undefined') {
-                requestAnimationFrame(() => {
-                    const cartDrawerData = Alpine.$data(cartDrawer);
-                    if (cartDrawerData?.open !== undefined) {
-                        cartDrawerData.open = false;
-                        document.body.style.overflow = '';
-                    }
-                });
-            }
-
-            if (autoCloseMenuMobile) {
-                this.handleMenuClosure();
-            }
-        }
-
-        <?php
-        /**
-         * Handle closing of mobile & desktop menus via Alpine.js
-         */ ?>
-        handleMenuClosure() {
-            if (typeof Alpine === 'undefined' || !Alpine.$data) return;
-
-            const mobileMenu = this.getElement('mobileMenu');
-            if (mobileMenu) {
-                const mobileMenuData = Alpine.$data(mobileMenu);
-                if (mobileMenuData?.open !== undefined) {
-                    mobileMenuData.open = false;
-                }
-            }
-
-            const desktopMenu = this.getElement('desktopMenu');
-            if (desktopMenu) {
-                const desktopMenuData = Alpine.$data(desktopMenu);
-                if (desktopMenuData?.hoverPanelActiveId !== undefined) {
-                    desktopMenuData.hoverPanelActiveId = 0;
-                }
-            }
-        }
-    }
-
-    <?php
-    /**
-     * Page restoration handler — persistent global instance
-     */ ?>
-    window.addEventListener('pageshow', (event) => {
-        if (event.persisted) {
-            (window._bfcacheHandler ??= new BFCacheHandler()).init();
-        }
-    }, { passive: true });
-})();
-</script>
-<?php $hyvaCsp->registerInlineScript() ?>
-<?php /** The $hyvaCsp->registerInlineScript() has to be called directly after the closing script tag! There must be no other HTML in between. */ ?>