output simulated query on syntax errors when in debug-mode (#85)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

src/QueryReflection/MysqliQueryReflector.php

@@ -65,22 +65,29 @@ public function __construct(mysqli $mysqli)
 
     public function validateQueryString(string $queryString): ?Error
     {
-        try {
-            $simulatedQuery = QuerySimulation::simulate($queryString);
-            if (null === $simulatedQuery) {
-                return null;
-            }
+        $simulatedQuery = QuerySimulation::simulate($queryString);
+        if (null === $simulatedQuery) {
+            return null;
+        }
 
+        try {
             $this->db->query($simulatedQuery);
 
             return null;
         } catch (mysqli_sql_exception $e) {
             if (\in_array($e->getCode(), [self::MYSQL_SYNTAX_ERROR_CODE, self::MYSQL_UNKNOWN_COLUMN_IN_FIELDLIST, self::MYSQL_UNKNOWN_TABLE], true)) {
-                // make error string consistent across mysql/mariadb
+
                 $message = $e->getMessage();
+
+                // make error string consistent across mysql/mariadb
                 $message = str_replace(' MySQL server', ' MySQL/MariaDB server', $message);
                 $message = str_replace(' MariaDB server', ' MySQL/MariaDB server', $message);
 
+                // to ease debugging, print the error we simulated
+                if ($e->getCode() === self::MYSQL_SYNTAX_ERROR_CODE && QueryReflection::getRuntimeConfiguration()->isDebugEnabled()) {
+                    $message = $message ."\n\nSimulated query: ". $simulatedQuery;
+                }
+
                 return new Error($message, $e->getCode());
             }
 
@@ -93,11 +100,12 @@ public function validateQueryString(string $queryString): ?Error
      */
     public function getResultType(string $queryString, int $fetchType): ?Type
     {
+        $simulatedQuery = QuerySimulation::simulate($queryString);
+        if (null === $simulatedQuery) {
+            return null;
+        }
+
         try {
-            $simulatedQuery = QuerySimulation::simulate($queryString);
-            if (null === $simulatedQuery) {
-                return null;
-            }
             $result = $this->db->query($simulatedQuery);
 
             if (!$result instanceof mysqli_result) {

src/QueryReflection/RuntimeConfiguration.php

@@ -15,6 +15,10 @@ final class RuntimeConfiguration
      * @var self::ERROR_MODE*
      */
     private $errorMode = self::ERROR_MODE_DEFAULT;
+    /**
+     * @var bool
+     */
+    private $debugMode = false;
 
     public static function create(): self
     {
@@ -24,13 +28,24 @@ public static function create(): self
     /**
      * @param self::ERROR_MODE* $mode
      */
-    public function errorMode($mode): self
+    public function errorMode(string $mode): self
     {
         $this->errorMode = $mode;
 
         return $this;
     }
 
+    public function debugMode(bool $mode): self
+    {
+        $this->debugMode = $mode;
+
+        return $this;
+    }
+
+    public function isDebugEnabled():bool {
+        return $this->debugMode;
+    }
+
     public function throwsPdoExceptions(PhpVersion $phpVersion): bool
     {
         if (self::ERROR_MODE_EXCEPTION === $this->errorMode) {