Remove use of Doctrine stub and and generic Doctrine result types (#705)

staabm · Nov 7, 2024 · 61a6233 · 61a6233
1 parent 415c4a6
commit 61a6233
Show file tree

Hide file tree

Showing 20 changed files with 115 additions and 70 deletions.
diff --git a/config/DoctrineDbal.stub b/config/DoctrineDbal.stub
diff --git a/config/dba.neon b/config/dba.neon
@@ -1,12 +1,3 @@
 includes:
-    - stubFiles.neon
     - extensions.neon
     - rules.neon
-
-parameters:
-    featureToggles:
-        skipCheckGenericClasses:
-            - Doctrine\DBAL\Result
-            - Doctrine\DBAL\Statement
-
-        duplicateStubs: false  # workaround for: https://github.com/staabm/phpstan-dba/issues/466
diff --git a/config/stubFiles.neon b/config/stubFiles.neon
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - config/stubFiles.neon
     - config/extensions.neon
     - config/rules.neon
     - phpstan-baseline.neon

diff --git a/src/DoctrineReflection/DoctrineReflection.php b/src/DoctrineReflection/DoctrineReflection.php
@@ -144,7 +144,7 @@ public function createGenericStatement(iterable $queryStrings, int $reflectionFe
                 return null;
             }
 
-            $genericObjects[] = new DoctrineStatementObjectType($resultType);
+            $genericObjects[] = DoctrineStatementObjectType::newWithRowType($resultType);
         }
 
         if (\count($genericObjects) > 1) {
@@ -173,7 +173,7 @@ public function createGenericResult(iterable $queryStrings, int $reflectionFetch
                 return null;
             }
 
-            $genericObjects[] = new DoctrineResultObjectType($resultType);
+            $genericObjects[] = DoctrineResultObjectType::newWithRowType($resultType);
         }
 
         if (\count($genericObjects) > 1) {

diff --git a/src/DoctrineReflection/DoctrineResultObjectType.php b/src/DoctrineReflection/DoctrineResultObjectType.php
@@ -5,20 +5,62 @@
 namespace staabm\PHPStanDba\DoctrineReflection;
 
 use Doctrine\DBAL\Result;
-use PHPStan\Type\Generic\GenericObjectType;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 
-final class DoctrineResultObjectType extends GenericObjectType
+final class DoctrineResultObjectType extends ObjectType
 {
-    public function __construct(Type $rowType)
+    private ?Type $rowType;
+
+    public static function newWithRowType(Type $rowType): self
     {
-        parent::__construct(Result::class, [$rowType]);
+        $new = new self(Result::class);
+        $new->rowType = $rowType;
+        return $new;
     }
 
     public function getRowType(): Type
     {
-        $genericTypes = $this->getTypes();
+        if ($this->rowType === null) {
+            throw new ShouldNotHappenException();
+        }
+
+        return $this->rowType;
+    }
+
+    public function getIterableValueType(): Type
+    {
+        return $this->getRowType();
+    }
+
+    // differentiate objects based on the local properties,
+    // to make sure TypeCombinator::union() will not normalize separate objects away.
+    // this means we need to implement equals() and isSuperTypeOf().
+    public function equals(Type $type): bool
+    {
+        if ($type instanceof self
+        ) {
+            return $type->rowType !== null
+                && $this->rowType !== null
+                && $type->rowType === $this->rowType
+                && $type->rowType->equals($this->rowType);
+        }
+
+        return parent::equals($type);
+    }
+
+    public function isSuperTypeOf(Type $type): TrinaryLogic
+    {
+        if ($type instanceof self) {
+            return TrinaryLogic::createFromBoolean(
+                $type->rowType !== null
+                && $this->rowType !== null
+                && $type->rowType->equals($this->rowType)
+            );
+        }
 
-        return $genericTypes[0];
+        return parent::isSuperTypeOf($type);
     }
 }
diff --git a/src/DoctrineReflection/DoctrineStatementObjectType.php b/src/DoctrineReflection/DoctrineStatementObjectType.php
@@ -5,13 +5,62 @@
 namespace staabm\PHPStanDba\DoctrineReflection;
 
 use Doctrine\DBAL\Statement;
-use PHPStan\Type\Generic\GenericObjectType;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 
-final class DoctrineStatementObjectType extends GenericObjectType
+final class DoctrineStatementObjectType extends ObjectType
 {
-    public function __construct(Type $rowType)
+    private ?Type $rowType;
+
+    public static function newWithRowType(Type $rowType): self
+    {
+        $new = new self(Statement::class);
+        $new->rowType = $rowType;
+        return $new;
+    }
+
+    public function getRowType(): Type
+    {
+        if ($this->rowType === null) {
+            throw new ShouldNotHappenException();
+        }
+
+        return $this->rowType;
+    }
+
+    public function getIterableValueType(): Type
     {
-        parent::__construct(Statement::class, [$rowType]);
+        return $this->getRowType();
+    }
+
+    // differentiate objects based on the local properties,
+    // to make sure TypeCombinator::union() will not normalize separate objects away.
+    // this means we need to implement equals() and isSuperTypeOf().
+    public function equals(Type $type): bool
+    {
+        if ($type instanceof self
+        ) {
+            return $type->rowType !== null
+                && $this->rowType !== null
+                && $type->rowType === $this->rowType
+                && $type->rowType->equals($this->rowType);
+        }
+
+        return parent::equals($type);
+    }
+
+    public function isSuperTypeOf(Type $type): TrinaryLogic
+    {
+        if ($type instanceof self) {
+            return TrinaryLogic::createFromBoolean(
+                $type->rowType !== null
+                && $this->rowType !== null
+                && $type->rowType->equals($this->rowType)
+            );
+        }
+
+        return parent::isSuperTypeOf($type);
     }
 }
diff --git a/tests/default/DbaInferenceTest.php b/tests/default/DbaInferenceTest.php
@@ -18,6 +18,7 @@ public function dataFileAsserts(): iterable
                 throw new \Exception('doctrine/dbal 3.x is required to run tests for php 7.3+. Please install it via composer.');
             }
 
+            yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal-union-result.php');
             yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal.php');
             yield from $this->gatherAssertTypes(__DIR__ . '/data/inference-placeholder.php');
 
@@ -90,7 +91,6 @@ public function testFileAsserts(
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__ . '/../../config/stubFiles.neon',
             __DIR__ . '/../../config/extensions.neon',
         ];
     }

diff --git a/tests/default/config/phpstan.neon.dist b/tests/default/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters:

diff --git a/tests/default/data/doctrine-dbal-union-result.php b/tests/default/data/doctrine-dbal-union-result.php
@@ -13,13 +13,11 @@ public function doFoo(Connection $conn)
 
         foreach ($queries as $query) {
             $stmt = $conn->prepare($query);
-            assertType('Doctrine\DBAL\Statement<array{adaid: int<-32768, 32767>, 0: int<-32768, 32767>}>|Doctrine\DBAL\Statement<array{email: string, 0: string}>', $stmt);
-
             $result = $stmt->executeQuery([]);
-            assertType('Doctrine\DBAL\Result<array{adaid: int<-32768, 32767>, 0: int<-32768, 32767>}>|Doctrine\DBAL\Result<array{email: string, 0: string}>', $result);
+            assertType('array{adaid: int<-32768, 32767>}|array{email: string}|false', $result->fetchAssociative());
 
             $result = $stmt->execute([]);
-            assertType('Doctrine\DBAL\Result<array{adaid: int<-32768, 32767>, 0: int<-32768, 32767>}>|Doctrine\DBAL\Result<array{email: string, 0: string}>', $result);
+            assertType('array{adaid: int<-32768, 32767>}|array{email: string}|false', $result->fetchAssociative());
 
             $fetch = $result->fetchOne();
             assertType('int<-32768, 32767>|string|false', $fetch);
@@ -35,7 +33,7 @@ public function doBar(Connection $conn)
 
         foreach ($queries as $query) {
             $result = $conn->query($query);
-            assertType('Doctrine\DBAL\Result<array{adaid: int<-32768, 32767>, 0: int<-32768, 32767>}>|Doctrine\DBAL\Result<array{email: string, 0: string}>', $result);
+            assertType('array{adaid: int<-32768, 32767>}|array{email: string}|false', $result->fetchAssociative());
         }
     }
 }
diff --git a/tests/default/data/doctrine-dbal.php b/tests/default/data/doctrine-dbal.php
@@ -13,7 +13,6 @@ class Foo
     public function foo(Connection $conn)
     {
         $result = $conn->query('SELECT email, adaid FROM ada');
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $result);
 
         $columnCount = $result->columnCount();
         assertType('2', $columnCount);
@@ -54,28 +53,25 @@ public function foo(Connection $conn)
 
     public function executeQuery(Connection $conn, array $types, QueryCacheProfile $qcp)
     {
-        $stmt = $conn->executeQuery('SELECT email, adaid FROM ada WHERE adaid = ?', [1]);
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $stmt);
+        $result = $conn->executeQuery('SELECT email, adaid FROM ada WHERE adaid = ?', [1]);
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $result->fetchAssociative());
 
-        $stmt = $conn->executeCacheQuery('SELECT email, adaid FROM ada WHERE adaid = ?', [1], $types, $qcp);
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $stmt);
+        $result = $conn->executeCacheQuery('SELECT email, adaid FROM ada WHERE adaid = ?', [1], $types, $qcp);
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $result->fetchAssociative());
 
-        $stmt = $conn->executeQuery('SELECT email, adaid FROM ada');
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $stmt);
+        $result = $conn->executeQuery('SELECT email, adaid FROM ada');
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $result->fetchAssociative());
     }
 
     public function executeStatement(Connection $conn, int $adaid)
     {
-        $stmt = $conn->prepare('SELECT email, adaid FROM ada');
-        assertType('Doctrine\DBAL\Statement<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $stmt);
-
         $stmt = $conn->prepare('SELECT email, adaid FROM ada WHERE adaid = ?');
         $result = $stmt->execute([$adaid]);
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $result);
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $result->fetchAssociative());
 
         $stmt = $conn->prepare('SELECT email, adaid FROM ada WHERE adaid = ?');
         $result = $stmt->executeQuery([$adaid]);
-        assertType('Doctrine\DBAL\Result<array{email: string, 0: string, adaid: int<-32768, 32767>, 1: int<-32768, 32767>}>', $result);
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $result->fetchAssociative());
     }
 
     public function fetchAssociative(Connection $conn)

diff --git a/tests/defaultFetchAssoc/DefaultFetchModeTest.php b/tests/defaultFetchAssoc/DefaultFetchModeTest.php
@@ -29,7 +29,6 @@ public function testFileAsserts(
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__ . '/../../config/stubFiles.neon',
             __DIR__ . '/../../config/extensions.neon',
         ];
     }

diff --git a/tests/defaultFetchAssoc/config/phpstan.neon.dist b/tests/defaultFetchAssoc/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters:

diff --git a/tests/defaultFetchNumeric/DefaultFetchModeTest.php b/tests/defaultFetchNumeric/DefaultFetchModeTest.php
@@ -29,7 +29,6 @@ public function testFileAsserts(
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__ . '/../../config/stubFiles.neon',
             __DIR__ . '/../../config/extensions.neon',
         ];
     }

diff --git a/tests/defaultFetchNumeric/config/phpstan.neon.dist b/tests/defaultFetchNumeric/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters:

diff --git a/tests/rules/config/phpstan.neon.dist b/tests/rules/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters:

diff --git a/tests/sqlAst/SqlAstInferenceTest.php b/tests/sqlAst/SqlAstInferenceTest.php
@@ -32,7 +32,6 @@ public function testFileAsserts(
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__ . '/../../config/stubFiles.neon',
             __DIR__ . '/../../config/extensions.neon',
         ];
     }

diff --git a/tests/sqlAst/config/phpstan.neon.dist b/tests/sqlAst/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters:

diff --git a/tests/stringify/InferenceStringifyTest.php b/tests/stringify/InferenceStringifyTest.php
@@ -33,7 +33,6 @@ public function testFileAsserts(
     public static function getAdditionalConfigFiles(): array
     {
         return [
-            __DIR__ . '/../../config/stubFiles.neon',
             __DIR__ . '/../../config/extensions.neon',
         ];
     }

diff --git a/tests/stringify/config/phpstan.neon.dist b/tests/stringify/config/phpstan.neon.dist
@@ -1,5 +1,4 @@
 includes:
-    - ../../../config/stubFiles.neon
     - ../../../config/extensions.neon
 
 parameters: