Wip: [CatalogOptimizer] Function scores filter prebuilding and caching

src/module-elasticsuite-catalog-optimizer/Model/Optimizer/ApplierList.php

@@ -15,6 +15,7 @@
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Smile\ElasticsuiteCatalogOptimizer\Model\Optimizer\Functions\ProviderInterface;
+use Smile\ElasticsuiteCatalogOptimizer\Model\Optimizer\Functions\Filter\PreBuilder as FunctionFilterPreBuilder;
 use Smile\ElasticsuiteCore\Api\Search\Request\ContainerConfigurationInterface;
 use Smile\ElasticsuiteCore\Search\Request\Query\QueryFactory;
 use Smile\ElasticsuiteCore\Search\Request\QueryInterface;
@@ -38,6 +39,11 @@ class ApplierList
      */
     private $functionsProvider;
 
+    /**
+     * @var FunctionFilterPreBuilder
+     */
+    private $preBuilder;
+
     /**
      * @var ScopeConfigInterface
      */
@@ -53,17 +59,20 @@ class ApplierList
      *
      * @param QueryFactory               $queryFactory      Query factory.
      * @param ProviderInterface          $functionsProvider Functions provider.
+     * @param FunctionFilterPreBuilder   $preBuilder        Function filter pre-builder.
      * @param ScopeConfigInterface       $scopeConfig       Scope configuration.
      * @param OptimizerFilterInterface[] $filters           Optimizer filters.
      */
     public function __construct(
         QueryFactory $queryFactory,
         ProviderInterface $functionsProvider,
+        FunctionFilterPreBuilder $preBuilder,
         ScopeConfigInterface $scopeConfig,
         array $filters = []
     ) {
         $this->queryFactory       = $queryFactory;
         $this->functionsProvider  = $functionsProvider;
+        $this->preBuilder         = $preBuilder;
         $this->scopeConfig        = $scopeConfig;
         $this->filters            = $filters;
     }
@@ -85,6 +94,8 @@ public function applyOptimizers(ContainerConfigurationInterface $containerConfig
             $functions = array_intersect_key($functions, array_flip($optimizerIds));
         }
 
+        $functions = $this->preBuilder->prebuild($containerConfiguration, $functions);
+
         return $this->applyFunctions($query, $functions);
     }
 

src/module-elasticsuite-catalog-optimizer/Model/Optimizer/Functions/Filter/PreBuilder.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade this module to newer versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Richard BAYET <[email protected]>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCatalogOptimizer\Model\Optimizer\Functions\Filter;
+
+use Magento\Framework\App\CacheInterface;
+use Smile\ElasticsuiteCatalogOptimizer\Model\Optimizer;
+use Smile\ElasticsuiteCore\Api\Search\Request\ContainerConfigurationInterface;
+use Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Request\Query\Builder;
+use Smile\ElasticsuiteCore\Search\Request\QueryInterface;
+
+/**
+ * PreBuilder of function score queries.
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCatalogOptimizer
+ */
+class PreBuilder
+{
+    /** @var int default lifetime for computed optimizers functions. */
+    const DEFAULT_CACHE_LIFETIME = 7200;
+
+    /** @var Builder */
+    private $builder;
+
+    /** @var CacheInterface */
+    private $cache;
+
+    /** @var integer|mixed */
+    private $cacheLifeTime;
+
+    /** @var array */
+    private $prebuiltFilters;
+
+    /**
+     * Constructor.
+     *
+     * @param Builder        $builder       Adapter request builder.
+     * @param CacheInterface $cache         Cache manager.
+     * @param int            $cacheLifetime Cache Lifetime of prebuilt optimizers function filters.
+     */
+    public function __construct(
+        Builder $builder,
+        CacheInterface $cache,
+        $cacheLifetime = self::DEFAULT_CACHE_LIFETIME
+    ) {
+        $this->builder = $builder;
+        $this->cache = $cache;
+        $this->cacheLifeTime = $cacheLifetime;
+    }
+
+    /**
+     * Prebuild function queries of optimizers and apply cache.
+     *
+     * @param ContainerConfigurationInterface $containerConfiguration Container configuration.
+     * @param array                           $functions              Functions whose queries to prebuild.
+     *
+     * @return array
+     */
+    public function prebuild(ContainerConfigurationInterface $containerConfiguration, $functions)
+    {
+        // Test if enabled.
+        foreach ($functions as $optimizerId => &$function) {
+            if (isset($function['filter'])) {
+                if ($function['filter'] instanceof QueryInterface) {
+                    $function['filter'] = $this->prebuildFilter(
+                        $containerConfiguration,
+                        $optimizerId,
+                        $function['filter']
+                    );
+                }
+            }
+        }
+
+        return $functions;
+    }
+
+    /**
+     * Prebuild an optimizer function filter query into a portion of Elasticsearch request.
+     *
+     * @param ContainerConfigurationInterface $containerConfiguration Container configuration.
+     * @param int                             $optimizerId            Optimizer id.
+     * @param QueryInterface                  $filter                 Filter query.
+     *
+     * @return array
+     */
+    private function prebuildFilter(ContainerConfigurationInterface $containerConfiguration, $optimizerId, QueryInterface $filter)
+    {
+        $cacheKey = sprintf(
+            "%s_%s_%s",
+            'optimizer_boost_function_prebuild',
+            $containerConfiguration->getStoreId(),
+            $optimizerId
+        );
+
+        if (!isset($this->prebuiltFilters[$cacheKey])) {
+            if ($prebuiltFilter = $this->cache->load($cacheKey)) {
+                $prebuiltFilter = unserialize($prebuiltFilter);
+            } else {
+                $prebuiltFilter = $this->builder->buildQuery($filter);
+                $this->cache->save(serialize($prebuiltFilter), $cacheKey, [Optimizer::CACHE_TAG], $this->cacheLifeTime);
+            }
+
+            $this->prebuiltFilters[$cacheKey] = $prebuiltFilter;
+        }
+
+        return $this->prebuiltFilters[$cacheKey];
+    }
+}

src/module-elasticsuite-core/Search/Adapter/Elasticsuite/Request/Query/Builder/FunctionScore.php

@@ -47,7 +47,10 @@ public function buildQuery(QueryInterface $query)
 
         foreach ($searchQueryParams['functions'] as &$function) {
             if (isset($function['filter'])) {
-                $function['filter'] = $this->parentBuilder->buildQuery($function['filter']);
+                // Filter query might have been prebuilt for performance reasons, if not built it now.
+                if ($function['filter'] instanceof QueryInterface) {
+                    $function['filter'] = $this->parentBuilder->buildQuery($function['filter']);
+                }
             }
         }