ACP2E-4094: Add index check for queries when loggging mode is enabled.

Author: aplapana

lib/internal/Magento/Framework/DB/Logger/QueryIndexAnalyzer.php

@@ -8,6 +8,7 @@
 namespace Magento\Framework\DB\Logger;
 
 use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\Serialize\Serializer\Json;
 
 class QueryIndexAnalyzer implements QueryAnalyzerInterface
 {
@@ -18,12 +19,18 @@ class QueryIndexAnalyzer implements QueryAnalyzerInterface
      */
     private int $smallTableThreshold;
 
+    private array $analyzerCache = [];
+
     /**
      * @param ResourceConnection $resource
+     * @param Json $serializer
      * @param int|null $smallTableThreshold
      */
-    public function __construct(private readonly ResourceConnection $resource, ?int $smallTableThreshold = null)
-    {
+    public function __construct(
+        private readonly ResourceConnection $resource,
+        private readonly Json $serializer,
+        ?int $smallTableThreshold = null
+    ) {
         if ($smallTableThreshold !== null) {
             $this->smallTableThreshold = $smallTableThreshold;
         } else {
@@ -45,8 +52,14 @@ public function process(string $sql, array $bindings): array
             throw new \InvalidArgumentException("Can't process query type");
         }
 
-        $connection = $this->resource->getConnection();
-        $explainOutput = $connection->query('EXPLAIN ' . $sql, $bindings)->fetchAll();
+        $cacheKey = $this->generateCacheKey($sql, $bindings);
+        if(isset($this->analyzerCache[$cacheKey])) {
+            $explainOutput = $this->analyzerCache[$cacheKey];
+        } else {
+            $connection = $this->resource->getConnection();
+            $explainOutput = $connection->query('EXPLAIN ' . $sql, $bindings)->fetchAll();
+            $this->analyzerCache[$cacheKey] = $explainOutput;
+        }
 
         if (empty($explainOutput)) {
             throw new \InvalidArgumentException("No 'explain' output available");
@@ -60,6 +73,18 @@ public function process(string $sql, array $bindings): array
         return array_values(array_unique($issues));
     }
 
+    /**
+     * Generate a cache key based on the SQL query and its bindings.
+     *
+     * @param string $sql
+     * @param array $bindings
+     * @return string
+     */
+    private function generateCacheKey(string $sql, array $bindings): string
+    {
+        return base64_encode(hash('sha256', $sql . '|' . $this->serializer->serialize($bindings), true));
+    }
+
     /**
      * Detects if a given SQL string is a SELECT query.
      *

lib/internal/Magento/Framework/DB/Test/Unit/Logger/QueryIndexAnalyzerTest.php

@@ -14,6 +14,7 @@
 use Magento\Framework\DB\Logger\QueryIndexAnalyzer;
 use Magento\Framework\DB\LoggerInterface;
 use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Serialize\Serializer\Json;
 use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -30,13 +31,19 @@ class QueryIndexAnalyzerTest extends TestCase
      */
     private QueryIndexAnalyzer $queryAnalyzer;
 
+    /**
+     * @var Json|MockObject
+     */
+    private Json $serializer;
+
     /**
      * @inheritDoc
      */
     protected function setUp(): void
     {
         $this->resource = $this->createMock(ResourceConnection::class);
-        $this->queryAnalyzer = new QueryIndexAnalyzer($this->resource);
+        $this->serializer = $this->createMock(Json::class);
+        $this->queryAnalyzer = new QueryIndexAnalyzer($this->resource, $this->serializer);
 
         parent::setUp();
     }