MAGE-1378 Alter cache vary logic to preserve X-Magento-Vary cookie for Varnish and disable replace category pages by default

Author: cammonro

Plugin/RenderingCacheContextPlugin.php

@@ -3,6 +3,7 @@
 namespace Algolia\AlgoliaSearch\Plugin;
 
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
+use Algolia\AlgoliaSearch\Helper\Configuration\InstantSearchHelper;
 use Magento\Framework\App\Http\Context as HttpContext;
 use Magento\Framework\App\Request\Http;
 use Magento\Framework\Exception\NoSuchEntityException;
@@ -25,7 +26,8 @@ class RenderingCacheContextPlugin
     public const CATEGORY_ROUTE = 'catalog/category/view';
 
     public function __construct(
-        protected ConfigHelper $configHelper,
+        protected ConfigHelper $baseConfig,
+        protected InstantSearchHelper $isConfig,
         protected StoreManagerInterface $storeManager,
         protected Http $request,
         protected UrlFinderInterface $urlFinder
@@ -50,7 +52,7 @@ public function afterGetData(HttpContext $subject, array $data): array {
             return $data;
         }
 
-        $context = $this->configHelper->preventBackendRendering() ?
+        $context = $this->baseConfig->preventBackendRendering() ?
             self::RENDERING_WITHOUT_BACKEND :
             self::RENDERING_WITH_BACKEND;
 
@@ -89,6 +91,7 @@ protected function isCategoryRoute(string $path): bool {
      *
      * @param int $storeId
      * @return bool
+     * @deprecated This method will be removed in a future version
      */
     protected function isCategoryPage(int $storeId): bool
     {
@@ -104,6 +107,6 @@ protected function isCategoryPage(int $storeId): bool
     protected function shouldApplyCacheContext(): bool
     {
         $storeId = $this->storeManager->getStore()->getId();
-        return $this->isCategoryPage($storeId) && $this->configHelper->replaceCategories($storeId);
+        return $this->isConfig->shouldReplaceCategories($storeId);
     }
 }

Setup/Patch/Schema/ConfigPatch.php

@@ -51,7 +51,6 @@ class ConfigPatch implements SchemaPatchInterface
         'algoliasearch_instant/instant/instant_selector' => '.columns',
         'algoliasearch_instant/instant/number_product_results' => '9',
         'algoliasearch_instant/instant/max_values_per_facet' => '10',
-        'algoliasearch_instant/instant/replace_categories' => '1',
         'algoliasearch_instant/instant/show_suggestions_on_no_result_page' => '1',
         'algoliasearch_instant/instant/add_to_cart_enable' => '1',
         'algoliasearch_instant/instant/infinite_scroll_enable' => '0',

composer.json

@@ -5,7 +5,7 @@
   "license": ["MIT"],
   "version": "3.16.0",
   "require": {
-    "php": "~8.1|~8.2|~8.3",
+    "php": "~8.2|~8.3|~8.4",
     "magento/framework": "~103.0",
     "algolia/algoliasearch-client-php": "4.18.3",
     "guzzlehttp/guzzle": "^6.3.3|^7.3.0",

etc/config.xml

@@ -29,6 +29,9 @@
             </redirects>
         </algoliasearch_autocomplete>
         <algoliasearch_instant>
+            <instant>
+                <replace_categories>0</replace_categories>
+            </instant>
             <instant_facets>
                 <facets><![CDATA[{"_1458145454535_587":{"attribute":"price","type":"slider","label":"Price","searchable":"2","create_rule":"2"},"_2541608784525_123":{"attribute":"categories","type":"conjunctive","label":"Categories","searchable":"2","create_rule":"2"},"_3211608784535_456":{"attribute":"color","type":"disjunctive","label":"Colors","searchable":"1","create_rule":"2"}}]]></facets>
                 <max_values_per_facet>10</max_values_per_facet>