implement DbaApi (#480)

Co-authored-by: Jakub Vojacek <jakub@motv.eu>

Author: jakubvojacek

src/Extensions/DibiConnectionFetchDynamicReturnTypeExtension.php

@@ -16,6 +16,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 use staabm\PHPStanDba\DibiReflection\DibiReflection;
+use staabm\PHPStanDba\QueryReflection\DbaApi;
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 use staabm\PHPStanDba\UnresolvableQueryException;
@@ -60,7 +61,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
 
     private function inferType(MethodReflection $methodReflection, Expr $queryExpr, Scope $scope): ?Type
     {
-        $queryReflection = new QueryReflection();
+        $queryReflection = new QueryReflection(new DbaApi(DbaApi::API_DIBI));
         $queryStrings = $queryReflection->resolveQueryStrings($queryExpr, $scope);
 
         return $this->createFetchType($queryStrings, $methodReflection);
@@ -71,7 +72,7 @@ private function inferType(MethodReflection $methodReflection, Expr $queryExpr,
      */
     private function createFetchType(iterable $queryStrings, MethodReflection $methodReflection): ?Type
     {
-        $queryReflection = new QueryReflection();
+        $queryReflection = new QueryReflection(new DbaApi(DbaApi::API_DIBI));
         $dibiReflection = new DibiReflection();
 
         $fetchTypes = [];

src/QueryReflection/BasePdoQueryReflector.php

@@ -72,12 +72,10 @@ abstract class BasePdoQueryReflector implements QueryReflector, RecordingReflect
      */
     protected $pdo;
 
-    public function __construct(PDO $pdo, TypeMapper $typeMapper)
+    public function __construct(PDO $pdo)
     {
         $this->pdo = $pdo;
         $this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
-
-        $this->typeMapper = $typeMapper;
     }
 
     public function validateQueryString(string $queryString): ?Error

src/QueryReflection/ChainedReflector.php

@@ -61,4 +61,11 @@ public function getResultType(string $queryString, int $fetchType): ?Type
 
         return null;
     }
+
+    public function setupDbaApi(?DbaApi $dbaApi): void
+    {
+        foreach ($this->reflectors as $reflector) {
+            $reflector->setupDbaApi($dbaApi);
+        }
+    }
 }

src/QueryReflection/DbaApi.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace staabm\PHPStanDba\QueryReflection;
+
+final class DbaApi
+{
+    public const API_DIBI = 'dibi';
+
+    /** @var self::API_* */
+    private $api;
+
+    /** @param self::API_* $api */
+    public function __construct($api)
+    {
+        $this->api = $api;
+    }
+
+    public function returnsDateTimeImmutable(): bool
+    {
+        return self::API_DIBI === $this->api;
+    }
+}

src/QueryReflection/LazyQueryReflector.php

@@ -18,6 +18,11 @@ final class LazyQueryReflector implements QueryReflector
      */
     private $reflector;
 
+    /**
+     * @var DbaApi|null
+     */
+    private $dbaApi;
+
     /**
      * @param callable():QueryReflector $reflectorFactory
      */
@@ -28,19 +33,30 @@ public function __construct(callable $reflectorFactory)
 
     public function validateQueryString(string $queryString): ?Error
     {
-        if (null === $this->reflector) {
-            $this->reflector = ($this->reflectorFactory)();
-        }
+        $this->reflector = $this->createReflector();
 
         return $this->reflector->validateQueryString($queryString);
     }
 
     public function getResultType(string $queryString, int $fetchType): ?Type
+    {
+        $this->reflector = $this->createReflector();
+
+        return $this->reflector->getResultType($queryString, $fetchType);
+    }
+
+    public function setupDbaApi(?DbaApi $dbaApi): void
+    {
+        $this->dbaApi = $dbaApi;
+    }
+
+    private function createReflector(): QueryReflector
     {
         if (null === $this->reflector) {
             $this->reflector = ($this->reflectorFactory)();
+            $this->reflector->setupDbaApi($this->dbaApi);
         }
 
-        return $this->reflector->getResultType($queryString, $fetchType);
+        return $this->reflector;
     }
 }

src/QueryReflection/MysqliQueryReflector.php

@@ -55,8 +55,6 @@ public function __construct(mysqli $mysqli)
         $this->db->set_charset('utf8');
         // enable exception throwing on php <8.1
         mysqli_report(\MYSQLI_REPORT_ERROR | \MYSQLI_REPORT_STRICT);
-
-        $this->typeMapper = new MysqliTypeMapper();
     }
 
     public function validateQueryString(string $queryString): ?Error
@@ -122,6 +120,11 @@ public function getResultType(string $queryString, int $fetchType): ?Type
         return $arrayBuilder->getArray();
     }
 
+    public function setupDbaApi(?DbaApi $dbaApi): void
+    {
+        $this->typeMapper = new MysqliTypeMapper($dbaApi);
+    }
+
     /**
      * @return mysqli_sql_exception|list<object>|null
      */

src/QueryReflection/PdoMysqlQueryReflector.php

@@ -25,7 +25,7 @@ public function __construct(PDO $pdo)
     {
         $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 
-        parent::__construct($pdo, new MysqlTypeMapper());
+        parent::__construct($pdo);
     }
 
     /** @return PDOException|list<ColumnMeta>|null */
@@ -90,6 +90,11 @@ protected function simulateQuery(string $queryString)
         return $this->cache[$queryString];
     }
 
+    public function setupDbaApi(?DbaApi $dbaApi): void
+    {
+        $this->typeMapper = new MysqlTypeMapper($dbaApi);
+    }
+
     /**
      * @return Iterator<string, TypeMapper::FLAG_*>
      */

src/QueryReflection/PdoPgSqlQueryReflector.php

@@ -21,9 +21,7 @@ final class PdoPgSqlQueryReflector extends BasePdoQueryReflector
 
     public function __construct(PDO $pdo)
     {
-        $typeMapper = new PgsqlTypeMapper();
-
-        parent::__construct($pdo, $typeMapper);
+        parent::__construct($pdo);
     }
 
     /** @return PDOException|list<PDOColumnMeta>|null */
@@ -91,6 +89,11 @@ protected function simulateQuery(string $queryString)
         return $this->cache[$queryString];
     }
 
+    public function setupDbaApi(?DbaApi $dbaApi): void
+    {
+        $this->typeMapper = new PgsqlTypeMapper($dbaApi);
+    }
+
     /**
      * @return Iterator<string, PgsqlTypeMapper::FLAG_*>
      */

src/QueryReflection/QueryReflection.php

@@ -43,6 +43,11 @@ final class QueryReflection
      */
     private static $runtimeConfiguration;
 
+    public function __construct(?DbaApi $dbaApi = null)
+    {
+        self::reflector()->setupDbaApi($dbaApi);
+    }
+
     public static function setupReflector(QueryReflector $reflector, RuntimeConfiguration $runtimeConfiguration): void
     {
         self::$reflector = $reflector;

src/QueryReflection/QueryReflector.php

@@ -22,4 +22,6 @@ public function validateQueryString(string $queryString): ?Error;
      * @param self::FETCH_TYPE* $fetchType
      */
     public function getResultType(string $queryString, int $fetchType): ?Type;
+
+    public function setupDbaApi(?DbaApi $dbaApi): void;
 }