Merge remote-tracking branch 'origin/2.10.x' into 2.11.x

composer.json

@@ -42,10 +42,11 @@
         "jetbrains/phpstorm-stubs": "^2019.1",
         "nikic/php-parser": "^4.4",
         "phpstan/phpstan": "^0.12",
-        "phpunit/phpunit": "^8.4.1",
+        "phpunit/phpunit": "^8.5.5",
+        "psalm/plugin-phpunit": "^0.10.0",
         "slevomat/coding-standard": "^6.3.6",
         "symfony/console": "^2.0.5|^3.0|^4.0|^5.0",
-        "vimeo/psalm": "^3.11"
+        "vimeo/psalm": "^3.11.4"
     },
     "suggest": {
         "symfony/console": "For helpful console commands such as SQL execution and import of files."

lib/Doctrine/DBAL/Connection.php

@@ -1265,9 +1265,9 @@ public function query()
      *
      * This method supports PDO binding types as well as DBAL mapping types.
      *
-     * @param string         $query  The SQL query.
-     * @param mixed[]        $params The query parameters.
-     * @param int[]|string[] $types  The parameter types.
+     * @param string                 $query  The SQL query.
+     * @param array<mixed>           $params The query parameters.
+     * @param array<int|string|null> $types  The parameter types.
      *
      * @return int The number of affected rows.
      *

lib/Doctrine/DBAL/Driver/DrizzlePDOMySql/Driver.php

@@ -35,6 +35,8 @@ public function createDatabasePlatformForVersion($version)
 
     /**
      * {@inheritdoc}
+     *
+     * @return DrizzlePlatform
      */
     public function getDatabasePlatform()
     {
@@ -43,6 +45,8 @@ public function getDatabasePlatform()
 
     /**
      * {@inheritdoc}
+     *
+     * @return DrizzleSchemaManager
      */
     public function getSchemaManager(\Doctrine\DBAL\Connection $conn)
     {

lib/Doctrine/DBAL/Driver/Mysqli/MysqliConnection.php

@@ -202,6 +202,8 @@ public function rollBack()
      * {@inheritdoc}
      *
      * @deprecated The error information is available via exceptions.
+     *
+     * @return int
      */
     public function errorCode()
     {
@@ -212,6 +214,8 @@ public function errorCode()
      * {@inheritdoc}
      *
      * @deprecated The error information is available via exceptions.
+     *
+     * @return string
      */
     public function errorInfo()
     {

lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php

@@ -479,6 +479,8 @@ public function errorCode()
      * {@inheritdoc}
      *
      * @deprecated The error information is available via exceptions.
+     *
+     * @return string
      */
     public function errorInfo()
     {

lib/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php

@@ -148,6 +148,8 @@ public function exec($statement)
 
     /**
      * {@inheritdoc}
+     *
+     * @return int|false
      */
     public function lastInsertId($name = null)
     {

lib/Doctrine/DBAL/Driver/PDOConnection.php

@@ -56,19 +56,24 @@ public function getServerVersion()
      * @param string          $prepareString
      * @param array<int, int> $driverOptions
      *
-     * @return Statement
+     * @return \PDOStatement
      */
     public function prepare($prepareString, $driverOptions = [])
     {
         try {
-            return parent::prepare($prepareString, $driverOptions);
+            $statement = parent::prepare($prepareString, $driverOptions);
+            assert($statement instanceof \PDOStatement);
+
+            return $statement;
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
     }
 
     /**
      * {@inheritdoc}
+     *
+     * @return \PDOStatement
      */
     public function query()
     {

lib/Doctrine/DBAL/DriverManager.php

@@ -115,11 +115,15 @@ private function __construct()
      * <b>driverClass</b>:
      * The driver class to use.
      *
-     * @param mixed[]            $params       The parameters.
-     * @param Configuration|null $config       The configuration to use.
-     * @param EventManager|null  $eventManager The event manager to use.
+     * @param  array{wrapperClass?: class-string<T>} $params
+     * @param Configuration|null                    $config       The configuration to use.
+     * @param EventManager|null                     $eventManager The event manager to use.
      *
      * @throws DBALException
+     *
+     * @phpstan-param mixed[] $params
+     * @psalm-return ($params is array{wrapperClass:mixed} ? T : Connection)
+     * @template T of Connection
      */
     public static function getConnection(
         array $params,

lib/Doctrine/DBAL/Logging/SQLLogger.php

@@ -10,9 +10,9 @@ interface SQLLogger
     /**
      * Logs a SQL statement somewhere.
      *
-     * @param string              $sql    The SQL to be executed.
-     * @param mixed[]|null        $params The SQL parameters.
-     * @param int[]|string[]|null $types  The SQL parameter types.
+     * @param string                 $sql    The SQL to be executed.
+     * @param mixed[]|null           $params The SQL parameters.
+     * @param array<int|string|null> $types  The SQL parameter types.
      *
      * @return void
      */

lib/Doctrine/DBAL/Platforms/AbstractPlatform.php

@@ -2816,8 +2816,8 @@ public function getListTableConstraintsSQL($table)
     }
 
     /**
-     * @param string      $table
-     * @param string|null $database
+     * @param string $table
+     * @param string $database
      *
      * @return string
      *

lib/Doctrine/DBAL/Portability/Connection.php

@@ -108,6 +108,8 @@ public function executeQuery($query, array $params = [], $types = [], ?QueryCach
 
     /**
      * {@inheritdoc}
+     *
+     * @return Statement
      */
     public function prepare($statement)
     {

lib/Doctrine/DBAL/SQLParserUtils.php

@@ -118,9 +118,9 @@ private static function collectPlaceholders(string $statement, string $match, st
     /**
      * For a positional query this method can rewrite the sql statement with regard to array parameters.
      *
-     * @param string         $query  The SQL query to execute.
-     * @param mixed[]        $params The parameters to bind to the query.
-     * @param int[]|string[] $types  The types the previous parameters are in.
+     * @param string                 $query  The SQL query to execute.
+     * @param mixed[]                $params The parameters to bind to the query.
+     * @param array<string|int|null> $types  The types the previous parameters are in.
      *
      * @return mixed[]
      *

phpcs.xml.dist

@@ -111,7 +111,7 @@
 
     <!-- The SQLSRV_* functions are defined in the upper case by the sqlsrv extension and violate the standard
          see https://docs.microsoft.com/en-us/sql/connect/php/constants-microsoft-drivers-for-php-for-sql-server -->
-    <rule ref="Squiz.PHP.LowercasePHPFunctions.UseStatementUppercase">
+    <rule ref="Squiz.PHP.LowercasePHPFunctions">
         <exclude-pattern>lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php</exclude-pattern>
     </rule>
 </ruleset>

phpstan.neon.dist

@@ -83,3 +83,15 @@ parameters:
 
         # Needs Generics
         - '~Method Doctrine\\DBAL\\Schema\\SchemaDiff::getNewTablesSortedByDependencies\(\) should return array<Doctrine\\DBAL\\Schema\\Table> but returns array<object>.~'
+
+        # Caused by phpdoc annotations intended for Psalm
+        -
+            message: '~Unable to resolve the template type T in call to method static method Doctrine\\DBAL\\DriverManager::getConnection\(\)~'
+            paths:
+                - %currentWorkingDirectory%/lib/Doctrine/DBAL/Id/TableGenerator.php
+                - %currentWorkingDirectory%/lib/Doctrine/DBAL/Schema/SqliteSchemaManager.php
+
+        -
+            message: '~Method Doctrine\\DBAL\\Driver\\PDOSqlsrv\\Connection\:\:lastInsertId\(\) should return string but returns string\|false\|null\.~'
+            paths:
+                - %currentWorkingDirectory%/lib/Doctrine/DBAL/Driver/PDOSqlsrv/Connection.php

psalm.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <psalm
     totallyTyped="false"
-    errorLevel="7"
+    errorLevel="6"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"

tests/Doctrine/Tests/DBAL/Cache/QueryCacheProfileTest.php

@@ -21,7 +21,7 @@ class QueryCacheProfileTest extends DbalTestCase
     /** @var int[] */
     private $params = [666];
 
-    /** @var string[] */
+    /** @var int[] */
     private $types = [ParameterType::INTEGER];
 
     /** @var string[] */

tests/Doctrine/Tests/DBAL/ConnectionTest.php

@@ -22,7 +22,6 @@
 use Doctrine\DBAL\Logging\EchoSQLLogger;
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
-use Doctrine\DBAL\VersionAwarePlatformDriver;
 use Doctrine\Tests\DbalTestCase;
 use Exception;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -145,9 +144,7 @@ public function testGetEventManager() : void
 
     public function testConnectDispatchEvent() : void
     {
-        $listenerMock = $this->getMockBuilder($this->getMockClass('ConnectDispatchEventListener'))
-            ->addMethods(['postConnect'])
-            ->getMock();
+        $listenerMock = $this->createMock(ConnectDispatchEventListener::class);
         $listenerMock->expects($this->once())->method('postConnect');
 
         $eventManager = new EventManager();
@@ -762,7 +759,7 @@ public function testCallConnectOnce(string $method, array $params) : void
      */
     public function testPlatformDetectionIsTriggerOnlyOnceOnRetrievingPlatform() : void
     {
-        $driverMock = $this->createMock([Driver::class, VersionAwarePlatformDriver::class]);
+        $driverMock = $this->createMock(FutureVersionAwarePlatformDriver::class);
 
         $driverConnectionMock = $this->createMock(ServerInfoAwareConnection::class);
 
@@ -883,7 +880,7 @@ public function testThrowsExceptionWhenInValidPlatformSpecified() : void
      */
     public function testRethrowsOriginalExceptionOnDeterminingPlatformWhenConnectingToNonExistentDatabase() : void
     {
-        $driverMock = $this->createMock([Driver::class, VersionAwarePlatformDriver::class]);
+        $driverMock = $this->createMock(FutureVersionAwarePlatformDriver::class);
 
         $connection        = new Connection(['dbname' => 'foo'], $driverMock);
         $originalException = new Exception('Original exception');
@@ -949,3 +946,8 @@ public function testExecuteCacheQueryStripsPlatformFromConnectionParamsBeforeGen
         $connection->executeCacheQuery($query, [], [], $queryCacheProfile);
     }
 }
+
+interface ConnectDispatchEventListener
+{
+    public function postConnect() : void;
+}

tests/Doctrine/Tests/DBAL/Driver/AbstractDriverTest.php

@@ -28,6 +28,7 @@
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\VersionAwarePlatformDriver;
 use Doctrine\Tests\DbalTestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionProperty;
 use function array_merge;
 use function get_class;
@@ -198,11 +199,12 @@ abstract protected function createPlatform() : AbstractPlatform;
      */
     abstract protected function createSchemaManager(Connection $connection) : AbstractSchemaManager;
 
+    /**
+     * @return Connection&MockObject
+     */
     protected function getConnectionMock() : Connection
     {
-        return $this->getMockBuilder(Connection::class)
-            ->disableOriginalConstructor()
-            ->getMock();
+        return $this->createMock(Connection::class);
     }
 
     /**
@@ -214,7 +216,7 @@ protected function getDatabasePlatformsForVersions() : array
     }
 
     /**
-     * @return mixed[][]
+     * @return iterable<mixed[]>
      */
     public static function exceptionConversionProvider() : iterable
     {

tests/Doctrine/Tests/DBAL/Driver/StatementIteratorTest.php

@@ -43,6 +43,8 @@ public function testIteratorIterationCallsFetchOncePerStep() : void
     }
 
     /**
+     * @param class-string<Statement> $class
+     *
      * @dataProvider statementProvider()
      */
     public function testStatementIterationCallsFetchOncePerStep(string $class) : void
@@ -80,7 +82,7 @@ private function assertIterationCallsFetchOncePerStep(Traversable $iterator, int
     }
 
     /**
-     * @return string[][]
+     * @return iterable<array{0: class-string<Statement>}>
      */
     public static function statementProvider() : iterable
     {

tests/Doctrine/Tests/DBAL/DriverManagerTest.php

@@ -107,6 +107,7 @@ public function testCustomWrapper() : void
 
     /**
      * @requires extension pdo_sqlite
+     * @psalm-suppress InvalidArgument
      */
     public function testInvalidWrapperClass() : void
     {
@@ -242,7 +243,7 @@ public function testDatabaseUrl($url, $expected) : void
     }
 
     /**
-     * @return array<string, array<int, mixed>>
+     * @return array<string, list<mixed>>
      */
     public function databaseUrls() : iterable
     {
@@ -341,7 +342,7 @@ public function databaseUrls() : iterable
                 ],
             ],
             'query params from URL are used as extra params' => [
-                'url' => 'mysql://foo:bar@localhost/dbname?charset=UTF-8',
+                'mysql://foo:bar@localhost/dbname?charset=UTF-8',
                 ['charset' => 'UTF-8'],
             ],
             'simple URL with fallthrough scheme not defined in map' => [

tests/Doctrine/Tests/DBAL/Functional/Driver/SQLSrv/StatementTest.php

@@ -27,7 +27,7 @@ protected function setUp() : void
     public function testFailureToPrepareResultsInException() : void
     {
         // use the driver connection directly to avoid having exception wrapped
-        $stmt = $this->connection->getWrappedConnection()->prepare(null);
+        $stmt = $this->connection->getWrappedConnection()->prepare('');
 
         // it's impossible to prepare the statement without bound variables for SQL Server,
         // so the preparation happens before the first execution when variables are already in place

tests/Doctrine/Tests/DBAL/Functional/ResultCacheTest.php

@@ -21,7 +21,7 @@
  */
 class ResultCacheTest extends DbalFunctionalTestCase
 {
-    /** @var array<int, array<int, int|string>> */
+    /** @var list<array{test_int: int, test_string: string}> */
     private $expectedResult = [['test_int' => 100, 'test_string' => 'foo'], ['test_int' => 200, 'test_string' => 'bar'], ['test_int' => 300, 'test_string' => 'baz']];
 
     /** @var DebugStack */
@@ -195,7 +195,7 @@ public function testFetchAllColumn() : void
     }
 
     /**
-     * @param array<int, array<int, int|string>> $expectedResult
+     * @param array<int, array<int, int|string>>|list<int> $expectedResult
      */
     private function assertCacheNonCacheSelectSameFetchModeAreEqual(array $expectedResult, int $fetchMode) : void
     {

tests/Doctrine/Tests/DBAL/Functional/Schema/PostgreSqlSchemaManagerTest.php

@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Schema;
 use Doctrine\DBAL\Schema\Comparator;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
+use Doctrine\DBAL\Schema\PostgreSqlSchemaManager;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\Types\BlobType;
@@ -20,6 +21,9 @@
 
 class PostgreSqlSchemaManagerTest extends SchemaManagerFunctionalTestCase
 {
+    /** @var PostgreSqlSchemaManager */
+    protected $schemaManager;
+
     protected function tearDown() : void
     {
         parent::tearDown();
@@ -28,7 +32,7 @@ protected function tearDown() : void
             return;
         }
 
-        $this->connection->getConfiguration()->setFilterSchemaAssetsExpression(null);
+        $this->connection->getConfiguration()->setSchemaAssetsFilter(null);
     }
 
     /**