support debugMode() in query plan analysis (#398)

* support debugMode() in query plan analysis

* record

Co-authored-by: Markus Staab <m.staab@complex-it.de>

Author: staabm

src/Analyzer/QueryPlanAnalyzerMysql.php

@@ -42,15 +42,17 @@ public function __construct($connection)
      */
     public function analyze(string $query): QueryPlanResult
     {
+        $simulatedQuery = 'EXPLAIN '.$query;
+
         if ($this->connection instanceof PDO) {
-            $stmt = $this->connection->query('EXPLAIN '.$query);
+            $stmt = $this->connection->query($simulatedQuery);
 
             // @phpstan-ignore-next-line
-            return $this->buildResult($stmt);
+            return $this->buildResult($simulatedQuery, $stmt);
         } else {
-            $result = $this->connection->query('EXPLAIN '.$query);
+            $result = $this->connection->query($simulatedQuery);
             if ($result instanceof \mysqli_result) {
-                return $this->buildResult($result);
+                return $this->buildResult($simulatedQuery, $result);
             }
         }
 
@@ -60,9 +62,9 @@ public function analyze(string $query): QueryPlanResult
     /**
      * @param \IteratorAggregate<array-key, array{select_type: string, key: string|null, type: string|null, rows: positive-int, table: ?string}> $it
      */
-    private function buildResult($it): QueryPlanResult
+    private function buildResult(string $simulatedQuery, $it): QueryPlanResult
     {
-        $result = new QueryPlanResult();
+        $result = new QueryPlanResult($simulatedQuery);
 
         $allowedUnindexedReads = QueryReflection::getRuntimeConfiguration()->getNumberOfAllowedUnindexedReads();
         if (false === $allowedUnindexedReads) {

src/Analyzer/QueryPlanResult.php

@@ -15,6 +15,21 @@ final class QueryPlanResult
      */
     private $result = [];
 
+    /**
+     * @var string
+     */
+    private $simulatedQuery;
+
+    public function __construct(string $simulatedQuery)
+    {
+        $this->simulatedQuery = $simulatedQuery;
+    }
+
+    public function getSimulatedQuery(): string
+    {
+        return $this->simulatedQuery;
+    }
+
     /**
      * @param self::* $result
      *

src/Rules/QueryPlanAnalyzerRule.php

@@ -124,13 +124,19 @@ private function analyze(CallLike $callLike, Scope $scope): array
         $ruleErrors = [];
         $queryReflection = new QueryReflection();
         $proposal = "\n\nConsider optimizing the query.\nIn some cases this is not a problem and this error should be ignored.";
+
         foreach ($queryReflection->analyzeQueryPlan($scope, $queryExpr, $parameterTypes) as $queryPlanResult) {
+            $suffix = $proposal;
+            if (QueryReflection::getRuntimeConfiguration()->isDebugEnabled()) {
+                $suffix = $proposal."\n\nSimulated query: ".$queryPlanResult->getSimulatedQuery();
+            }
+
             $notUsingIndex = $queryPlanResult->getTablesNotUsingIndex();
             if (\count($notUsingIndex) > 0) {
                 foreach ($notUsingIndex as $table) {
                     $ruleErrors[] = RuleErrorBuilder::message(
                         sprintf(
-                            "Query is not using an index on table '%s'.".$proposal,
+                            "Query is not using an index on table '%s'.".$suffix,
                             $table
                         ))
                         ->line($callLike->getLine())
@@ -141,7 +147,7 @@ private function analyze(CallLike $callLike, Scope $scope): array
                 foreach ($queryPlanResult->getTablesDoingTableScan() as $table) {
                     $ruleErrors[] = RuleErrorBuilder::message(
                         sprintf(
-                            "Query is using a full-table-scan on table '%s'.".$proposal,
+                            "Query is using a full-table-scan on table '%s'.".$suffix,
                             $table
                         ))
                         ->line($callLike->getLine())
@@ -152,7 +158,7 @@ private function analyze(CallLike $callLike, Scope $scope): array
                 foreach ($queryPlanResult->getTablesDoingUnindexedReads() as $table) {
                     $ruleErrors[] = RuleErrorBuilder::message(
                         sprintf(
-                        "Query is triggering too many unindexed-reads on table '%s'.".$proposal,
+                        "Query is triggering too many unindexed-reads on table '%s'.".$suffix,
                             $table
                         ))
                         ->line($callLike->getLine())

tests/rules/QueryPlanAnalyzerRuleTest.php

@@ -20,14 +20,20 @@ class QueryPlanAnalyzerRuleTest extends RuleTestCase
      * @var positive-int
      */
     private $numberOfRowsNotRequiringIndex;
+    /**
+     * @var bool
+     */
+    private $debugMode = false;
 
     protected function tearDown(): void
     {
+        QueryReflection::getRuntimeConfiguration()->debugMode(false);
         QueryReflection::getRuntimeConfiguration()->analyzeQueryPlans(false);
     }
 
     protected function getRule(): Rule
     {
+        QueryReflection::getRuntimeConfiguration()->debugMode($this->debugMode);
         QueryReflection::getRuntimeConfiguration()->analyzeQueryPlans($this->numberOfAllowedUnindexedReads, $this->numberOfRowsNotRequiringIndex);
 
         return self::getContainer()->getByType(QueryPlanAnalyzerRule::class);
@@ -84,4 +90,50 @@ public function testNotUsingIndex(): void
             ],
         ]);
     }
+
+    public function testNotUsingIndexInDebugMode(): void
+    {
+        if ('pdo-pgsql' === getenv('DBA_REFLECTOR')) {
+            $this->markTestSkipped('query plan analyzer is not yet implemented for pgsql');
+        }
+
+        if ('recording' !== getenv('DBA_MODE')) {
+            $this->markTestSkipped('query plan analyzer requires a active database connection');
+        }
+
+        $this->debugMode = true;
+        $this->numberOfAllowedUnindexedReads = true;
+        $this->numberOfRowsNotRequiringIndex = 2;
+
+        $proposal = "\n\nConsider optimizing the query.\nIn some cases this is not a problem and this error should be ignored.";
+        $tip = 'see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html';
+
+        $this->analyse([__DIR__.'/data/query-plan-analyzer.php'], [
+            [
+                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM `ada` WHERE email = 'test@example.com'",
+                12,
+                $tip,
+            ],
+            [
+                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT *,adaid FROM `ada` WHERE email = 'test@example.com'",
+                17,
+                $tip,
+            ],
+            [
+                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
+                22,
+                $tip,
+            ],
+            [
+                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
+                23,
+                $tip,
+            ],
+            [
+                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
+                28,
+                $tip,
+            ],
+        ]);
+    }
 }