Support for doctrine/dbal v4 (#754)

bnowak · Bartłomiej Nowak · web-flow · commit d93014580232 · 2025-05-16T14:47:17.000+02:00
Co-authored-by: Bartłomiej Nowak &lt;bartlomiej.nowak@workbuzz.com&gt;
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -27,57 +27,81 @@ jobs:
           #  dependencies: "lowest"
 
           - php-version: "7.4"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "pdo-mysql"
             mode: "recording"
             dependencies: "highest"
           - php-version: "8.0"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "pdo-mysql"
             mode: "recording"
             dependencies: "highest"
           - php-version: "8.0"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "mysqli"
             mode: "recording"
             dependencies: "highest"
 
           - php-version: "8.1"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "mysqli"
             mode: "recording"
             dependencies: "highest"
           - php-version: '8.1'
+            dbal-version: "^3"
             db-image: 'mariadb:latest'
             platform: 'mariadb'
             reflector: "mysqli"
             mode: "recording"
             dependencies: "highest"
 
           - php-version: "8.2"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "mysqli"
             mode: "recording"
             dependencies: "highest"
           - php-version: '8.2'
+            dbal-version: "^3"
             db-image: 'mariadb:latest'
             platform: 'mariadb'
             reflector: "mysqli"
             mode: "recording"
             dependencies: "highest"
 
+          - php-version: "8.3"
+            dbal-version: "^4"
+            db-image: 'mysql:8.0'
+            reflector: "mysqli"
+            mode: "recording"
+            dependencies: "highest"
+
+          - php-version: "8.4"
+            dbal-version: "^4"
+            db-image: 'mysql:8.0'
+            reflector: "mysqli"
+            mode: "recording"
+            dependencies: "highest"
+
           - php-version: "8.1"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "pdo-mysql"
             mode: "replay-and-recording"
             dependencies: "highest"
 
           - php-version: "8.1"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "pdo-mysql"
             mode: "empty-recording"
             dependencies: "highest"
           - php-version: "8.1"
+            dbal-version: "^3"
             db-image: 'mysql:8.0'
             reflector: "pdo-mysql"
             mode: "empty-replay-and-recording"
@@ -120,7 +144,7 @@ jobs:
       run: composer require sqlftw/sqlftw --ignore-platform-req=php+
 
     - name: Install doctrine/dbal (optional dependency)
-      run: composer require doctrine/dbal:^3 --ignore-platform-req=php+
+      run: "composer require doctrine/dbal:${{ matrix.dbal-version }} --ignore-platform-req=php+"
 
     - name: Setup Problem Matchers for PHPUnit
       run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
 		"php": "^7.4 || ^8.0",
 		"composer-runtime-api": "^2.0",
 		"composer/semver": "^3.2",
-		"doctrine/dbal": "3.*",
+		"doctrine/dbal": "3.*|4.*",
 		"phpstan/phpstan": "^2.0"
 	},
 	"require-dev": {
diff --git a/config/rules.neon b/config/rules.neon
@@ -46,6 +46,8 @@ services:
                 - 'PDO::prepare#0'
                 - 'mysqli::query#0'
                 - 'mysqli::execute_query#0'
+                - 'Doctrine\DBAL\Connection::executeQuery#0'
+                - 'Doctrine\DBAL\Connection::executeStatement#0'
                 - 'Doctrine\DBAL\Connection::query#0' # deprecated in doctrine
                 - 'Doctrine\DBAL\Connection::exec#0' # deprecated in doctrine
 
diff --git a/src/Extensions/DoctrineConnectionExecuteQueryDynamicReturnTypeExtension.php b/src/Extensions/DoctrineConnectionExecuteQueryDynamicReturnTypeExtension.php
@@ -44,7 +44,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         }
 
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/src/Extensions/DoctrineConnectionFetchDynamicReturnTypeExtension.php b/src/Extensions/DoctrineConnectionFetchDynamicReturnTypeExtension.php
@@ -57,7 +57,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         }
 
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/src/Extensions/DoctrineConnectionPrepareDynamicReturnTypeExtension.php b/src/Extensions/DoctrineConnectionPrepareDynamicReturnTypeExtension.php
@@ -44,7 +44,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         }
 
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/src/Extensions/DoctrineConnectionQueryDynamicReturnTypeExtension.php b/src/Extensions/DoctrineConnectionQueryDynamicReturnTypeExtension.php
@@ -44,7 +44,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         }
 
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/src/Extensions/DoctrineResultDynamicReturnTypeExtension.php b/src/Extensions/DoctrineResultDynamicReturnTypeExtension.php
@@ -48,7 +48,7 @@ public function isMethodSupported(MethodReflection $methodReflection): bool
     public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
     {
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/src/Extensions/DoctrineStatementExecuteDynamicReturnTypeExtension.php b/src/Extensions/DoctrineStatementExecuteDynamicReturnTypeExtension.php
@@ -40,7 +40,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
         }
 
         // make sure we don't report wrong types in doctrine 2.x
-        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*|4.*')) {
             return null;
         }
 
diff --git a/tests/default/DbaInferenceTest.php b/tests/default/DbaInferenceTest.php
@@ -18,6 +18,9 @@ public function dataFileAsserts(): iterable
         }
 
         yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal-union-result.php');
+        if (InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+            yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal3.php');
+        }
         yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/inference-placeholder.php');
 
diff --git a/tests/default/data/doctrine-dbal-union-result.php b/tests/default/data/doctrine-dbal-union-result.php
@@ -26,14 +26,4 @@ public function doFoo(Connection $conn)
             assertType('array{adaid: int<-32768, 32767>}|array{email: string}|false', $fetch);
         }
     }
-
-    public function doBar(Connection $conn)
-    {
-        $queries = ['SELECT adaid FROM ada', 'SELECT email FROM ada'];
-
-        foreach ($queries as $query) {
-            $result = $conn->query($query);
-            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
@@ -10,9 +10,9 @@
 
 class Foo
 {
-    public function foo(Connection $conn)
+    public function resultFetching(Connection $conn)
     {
-        $result = $conn->query('SELECT email, adaid FROM ada');
+        $result = $conn->executeQuery('SELECT email, adaid FROM ada');
 
         $columnCount = $result->columnCount();
         assertType('2', $columnCount);
diff --git a/tests/default/data/doctrine-dbal3.php b/tests/default/data/doctrine-dbal3.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace DoctrineDbal3Test;
+
+use Doctrine\DBAL\Connection;
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+    public function resultFetching(Connection $conn)
+    {
+        $result = $conn->query('SELECT email, adaid FROM ada');
+
+        $columnCount = $result->columnCount();
+        assertType('2', $columnCount);
+
+        $fetch = $result->fetchOne();
+        assertType('string|false', $fetch);
+
+        $fetch = $result->fetchNumeric();
+        assertType('array{string, int<-32768, 32767>}|false', $fetch);
+
+        $fetch = $result->fetchFirstColumn();
+        assertType('list<string>', $fetch);
+
+        $fetch = $result->fetchAssociative();
+        assertType('array{email: string, adaid: int<-32768, 32767>}|false', $fetch);
+
+        $fetch = $result->fetchAllNumeric();
+        assertType('list<array{string, int<-32768, 32767>}>', $fetch);
+
+        $fetch = $result->fetchAllAssociative();
+        assertType('list<array{email: string, adaid: int<-32768, 32767>}>', $fetch);
+
+        $fetch = $result->fetchAllKeyValue();
+        assertType('array<string, int<-32768, 32767>>', $fetch);
+
+        $fetch = $result->iterateNumeric();
+        assertType('Traversable<int, array{string, int<-32768, 32767>}>', $fetch);
+
+        $fetch = $result->iterateAssociative();
+        assertType('Traversable<int, array{email: string, adaid: int<-32768, 32767>}>', $fetch);
+
+        $fetch = $result->iterateColumn();
+        assertType('Traversable<int, string>', $fetch);
+
+        $fetch = $result->iterateKeyValue();
+        assertType('Traversable<string, int<-32768, 32767>>', $fetch);
+    }
+
+    public function unionQueriesResult(Connection $conn)
+    {
+        $queries = ['SELECT adaid FROM ada', 'SELECT email FROM ada'];
+
+        foreach ($queries as $query) {
+            $result = $conn->query($query);
+            assertType('array{adaid: int<-32768, 32767>}|array{email: string}|false', $result->fetchAssociative());
+        }
+    }
+}
diff --git a/tests/rules/SyntaxErrorInQueryMethodRuleTest.php b/tests/rules/SyntaxErrorInQueryMethodRuleTest.php
@@ -4,6 +4,8 @@
 
 namespace staabm\PHPStanDba\Tests;
 
+use Composer\InstalledVersions;
+use Composer\Semver\VersionParser;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use staabm\PHPStanDba\QueryReflection\MysqliQueryReflector;
@@ -302,6 +304,46 @@ public function testSyntaxErrorInQueryRule(): void
         $this->analyse([__DIR__ . '/data/syntax-error-in-query-method.php'], $expected);
     }
 
+    public function testSyntaxErrorInQueryRuleForDoctrineDbal3(): void
+    {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {
+            self::markTestSkipped('Doctrine DBAL 3.x test only.');
+        }
+
+        if (MysqliQueryReflector::NAME === getenv('DBA_REFLECTOR')) {
+            $expected = [
+                [
+                    "Query error: You have an error in your SQL syntax; check the manual that corresponds to your MySQL/MariaDB server version for the right syntax to use near 'freigabe1u1 FROM ada LIMIT 0' at line 1 (1064).",
+                    12,
+                ],
+            ];
+        } elseif (PdoMysqlQueryReflector::NAME === getenv('DBA_REFLECTOR')) {
+            if ('mariadb' === $_ENV['DBA_PLATFORM']) {
+                self::markTestSkipped("We don't test all variants of expectations for all drivers");
+            }
+
+            $expected = [
+                [
+                    "Query error: SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual that corresponds to your MySQL/MariaDB server version for the right syntax to use near 'freigabe1u1 FROM ada LIMIT 0' at line 1 (42000).",
+                    12,
+                ],
+            ];
+        } elseif (PdoPgSqlQueryReflector::NAME === getenv('DBA_REFLECTOR')) {
+            $expected = [
+                [
+                    'Query error: SQLSTATE[42601]: Syntax error: 7 ERROR:  syntax error at or near "freigabe1u1"
+LINE 1: SELECT email adaid WHERE gesperrt freigabe1u1 FROM ada LIMIT...
+                                          ^ (42601).',
+                    12,
+                ],
+            ];
+        } else {
+            throw new \RuntimeException('Unsupported DBA_REFLECTOR ' . getenv('DBA_REFLECTOR'));
+        }
+
+        $this->analyse([__DIR__ . '/data/syntax-error-in-query-method-dbal3.php'], $expected);
+    }
+
     public function testMysqliExecuteQuery(): void
     {
         if (\PHP_VERSION_ID < 80200) {
diff --git a/tests/rules/data/syntax-error-in-query-method-dbal3.php b/tests/rules/data/syntax-error-in-query-method-dbal3.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace SyntaxErrorInQueryMethodDbal3RuleTest;
+
+use PDO;
+
+class Foo
+{
+    public function syntaxErrorDoctrineDbal(\Doctrine\DBAL\Connection $conn)
+    {
+        $sql = 'SELECT email adaid WHERE gesperrt freigabe1u1 FROM ada';
+        $conn->query($sql);
+    }
+
+    public function noErrorOnQueriesContainingPlaceholders(\Doctrine\DBAL\Connection $conn)
+    {
+        // errors in this scenario are reported by SyntaxErrorInPreparedStatementMethodRule only
+        $conn->query('SELECT email, adaid, gesperrt, freigabe1u1 FROM ada WHERE adaid=?');
+    }
+}
diff --git a/tests/rules/data/syntax-error-in-query-method.php b/tests/rules/data/syntax-error-in-query-method.php
@@ -79,13 +79,13 @@ public function syntaxErrorPdoPrepare(PDO $pdo)
     public function syntaxErrorDoctrineDbal(\Doctrine\DBAL\Connection $conn)
     {
         $sql = 'SELECT email adaid WHERE gesperrt freigabe1u1 FROM ada';
-        $conn->query($sql);
+        $conn->executeQuery($sql);
     }
 
     public function noErrorOnQueriesContainingPlaceholders(\Doctrine\DBAL\Connection $conn)
     {
         // errors in this scenario are reported by SyntaxErrorInPreparedStatementMethodRule only
-        $conn->query('SELECT email, adaid, gesperrt, freigabe1u1 FROM ada WHERE adaid=?');
+        $conn->executeQuery('SELECT email, adaid, gesperrt, freigabe1u1 FROM ada WHERE adaid=?');
     }
 
     public function conditionalSyntaxError(PDO $pdo)

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// make sure we don't report wrong types in doctrine 2.x`
`47`		`- if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {`
	`47`	`+ if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.\|4.')) {`
`48`	`48`	`return null;`
`49`	`49`	`}`
`50`	`50`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`// make sure we don't report wrong types in doctrine 2.x`
`60`		`- if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {`
	`60`	`+ if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.\|4.')) {`
`61`	`61`	`return null;`
`62`	`62`	`}`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function isMethodSupported(MethodReflection $methodReflection): bool`
`48`	`48`	`public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type`
`49`	`49`	`{`
`50`	`50`	`// make sure we don't report wrong types in doctrine 2.x`
`51`		`- if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {`
	`51`	`+ if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.\|4.')) {`
`52`	`52`	`return null;`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`// make sure we don't report wrong types in doctrine 2.x`
`43`		`- if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {`
	`43`	`+ if (! InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.\|4.')) {`
`44`	`44`	`return null;`
`45`	`45`	`}`
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@ public function dataFileAsserts(): iterable`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal-union-result.php');`
	`21`	`+ if (InstalledVersions::satisfies(new VersionParser(), 'doctrine/dbal', '3.*')) {`
	`22`	`+ yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal3.php');`
	`23`	`+ }`
`21`	`24`	`yield from $this->gatherAssertTypes(__DIR__ . '/data/doctrine-dbal.php');`
`22`	`25`	`yield from $this->gatherAssertTypes(__DIR__ . '/data/inference-placeholder.php');`
`23`	`26`