WIP Psalm 5.11.0

doctrine · May 8, 2023 · 98b12e9 · 98b12e9
1 parent 81579c2
commit 98b12e9
Show file tree

Hide file tree

Showing 26 changed files with 156 additions and 82 deletions.
diff --git a/composer.json b/composer.json
@@ -50,7 +50,7 @@
         "squizlabs/php_codesniffer": "3.7.2",
         "symfony/cache": "^5.4|^6.0",
         "symfony/console": "^4.4|^5.4|^6.0",
-        "vimeo/psalm": "4.30.0"
+        "vimeo/psalm": "^5.11.0"
     },
     "suggest": {
         "symfony/console": "For helpful console commands such as SQL execution and import of files."

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -5,6 +5,8 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="false"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />
@@ -608,6 +610,16 @@
                 <!-- We're testing with invalid input here. -->
                 <file name="tests/Functional/LegacyAPITest.php"/>
                 <file name="tests/Platforms/AbstractPlatformTestCase.php"/>
+
+                <!-- See https://bugs.php.net/bug.php?id=77591 -->
+                <referencedFunction name="db2_autocommit"/>
+
+                <!-- See https://github.com/doctrine/dbal/pull/3498 -->
+                <file name="tests/Functional/DataAccessTest.php"/>
+                <file name="tests/Platforms/AbstractPlatformTestCase.php"/>
+                <file name="tests/Platforms/DB2PlatformTest.php"/>
+                <file name="tests/Platforms/OraclePlatformTest.php"/>
+                <file name="tests/Platforms/SqlitePlatformTest.php"/>
             </errorLevel>
         </InvalidArgument>
         <InvalidDocblock>
@@ -628,6 +640,12 @@
                 <file name="src/Driver/PDO/Exception.php"/>
             </errorLevel>
         </InvalidPropertyAssignmentValue>
+        <LessSpecificReturnStatement>
+            <errorLevel type="suppress">
+                <!-- Psalm does not understand the polymorphism of the PDO::fetch() and fetchAll() methods -->
+                <file name="src/Driver/PDO/Result.php"/>
+            </errorLevel>
+        </LessSpecificReturnStatement>
         <MissingConstructor>
             <errorLevel type="suppress">
                 <!--
@@ -637,6 +655,12 @@
                 <file name="src/Schema/SchemaConfig.php"/>
             </errorLevel>
         </MissingConstructor>
+        <MoreSpecificReturnType>
+            <errorLevel type="suppress">
+                <!-- Psalm does not understand the polymorphism of the PDO::fetch() and fetchAll() methods -->
+                <file name="src/Driver/PDO/Result.php"/>
+            </errorLevel>
+        </MoreSpecificReturnType>
         <NullableReturnStatement>
             <errorLevel type="suppress">
                 <!--
@@ -812,6 +836,7 @@
                     This issue should be fixed in 4.0
                 -->
                 <file name="src/Connection.php"/>
+                <file name="src/Driver/Mysqli/Result.php"/>
                 <file name="src/Statement.php"/>
                 <file name="src/Query/QueryBuilder.php"/>
             </errorLevel>
@@ -824,6 +849,7 @@
                     This issue should be fixed in 4.0
                 -->
                 <file name="src/Connection.php"/>
+                <file name="src/Driver/Mysqli/Result.php"/>
                 <file name="src/Statement.php"/>
                 <file name="src/Query/QueryBuilder.php"/>
             </errorLevel>
@@ -839,10 +865,26 @@
 
                 <!-- See https://github.com/doctrine/dbal/pull/3574 -->
                 <file name="tests/Query/Expression/ExpressionBuilderTest.php"/>
-
-                <!-- See https://bugs.php.net/bug.php?id=77591 -->
-                <referencedFunction name="db2_autocommit"/>
             </errorLevel>
         </InvalidScalarArgument>
+        <MethodSignatureMustProvideReturnType>
+            <errorLevel type="suppress">
+                <!-- https://github.com/vimeo/psalm/issues/8557 -->
+                <file name="src/Query/Expression/CompositeExpression.php"/>
+                <file name="src/Query/QueryBuilder.php"/>
+            </errorLevel>
+        </MethodSignatureMustProvideReturnType>
+        <NoValue>
+            <errorLevel type="suppress">
+                <!-- We're checking for invalid input. -->
+                <file name="src/Platforms/AbstractPlatform.php"/>
+                <file name="src/Platforms/SQLServerPlatform.php"/>
+            </errorLevel>
+        </NoValue>
+        <UnsupportedReferenceUsage>
+            <errorLevel type="suppress">
+                <file name="src/Driver/SQLSrv/Statement.php"/>
+            </errorLevel>
+        </UnsupportedReferenceUsage>
     </issueHandlers>
 </psalm>
diff --git a/src/Driver/IBMDB2/Exception/CannotCopyStreamToStream.php b/src/Driver/IBMDB2/Exception/CannotCopyStreamToStream.php
@@ -13,7 +13,7 @@
  */
 final class CannotCopyStreamToStream extends AbstractException
 {
-    /** @psalm-param array{message: string}|null $error */
+    /** @psalm-param array{message: string, ...mixed}|null $error */
     public static function new(?array $error): self
     {
         $message = 'Could not copy source stream to temporary file';

diff --git a/src/Driver/IBMDB2/Exception/CannotCreateTemporaryFile.php b/src/Driver/IBMDB2/Exception/CannotCreateTemporaryFile.php
@@ -13,7 +13,7 @@
  */
 final class CannotCreateTemporaryFile extends AbstractException
 {
-    /** @psalm-param array{message: string}|null $error */
+    /** @psalm-param array{message: string, ...mixed}|null $error */
     public static function new(?array $error): self
     {
         $message = 'Could not create temporary file';

diff --git a/src/Driver/IBMDB2/Exception/PrepareFailed.php b/src/Driver/IBMDB2/Exception/PrepareFailed.php
@@ -13,7 +13,7 @@
  */
 final class PrepareFailed extends AbstractException
 {
-    /** @psalm-param array{message: string}|null $error */
+    /** @psalm-param array{message: string, ...mixed}|null $error */
     public static function new(?array $error): self
     {
         if ($error === null) {

diff --git a/src/Driver/Mysqli/Exception/ConnectionError.php b/src/Driver/Mysqli/Exception/ConnectionError.php
@@ -26,6 +26,6 @@ public static function upcast(mysqli_sql_exception $exception): self
         $p = new ReflectionProperty(mysqli_sql_exception::class, 'sqlstate');
         $p->setAccessible(true);
 
-        return new self($exception->getMessage(), $p->getValue($exception), (int) $exception->getCode(), $exception);
+        return new self($exception->getMessage(), $p->getValue($exception), $exception->getCode(), $exception);
     }
 }
diff --git a/src/Driver/Mysqli/Exception/ConnectionFailed.php b/src/Driver/Mysqli/Exception/ConnectionFailed.php
@@ -31,6 +31,6 @@ public static function upcast(mysqli_sql_exception $exception): self
         $p = new ReflectionProperty(mysqli_sql_exception::class, 'sqlstate');
         $p->setAccessible(true);
 
-        return new self($exception->getMessage(), $p->getValue($exception), (int) $exception->getCode(), $exception);
+        return new self($exception->getMessage(), $p->getValue($exception), $exception->getCode(), $exception);
     }
 }
diff --git a/src/Driver/Mysqli/Exception/InvalidCharset.php b/src/Driver/Mysqli/Exception/InvalidCharset.php
@@ -35,7 +35,7 @@ public static function upcast(mysqli_sql_exception $exception, string $charset):
         return new self(
             sprintf('Failed to set charset "%s": %s', $charset, $exception->getMessage()),
             $p->getValue($exception),
-            (int) $exception->getCode(),
+            $exception->getCode(),
             $exception,
         );
     }

diff --git a/src/Driver/Mysqli/Exception/StatementError.php b/src/Driver/Mysqli/Exception/StatementError.php
@@ -26,6 +26,6 @@ public static function upcast(mysqli_sql_exception $exception): self
         $p = new ReflectionProperty(mysqli_sql_exception::class, 'sqlstate');
         $p->setAccessible(true);
 
-        return new self($exception->getMessage(), $p->getValue($exception), (int) $exception->getCode(), $exception);
+        return new self($exception->getMessage(), $p->getValue($exception), $exception->getCode(), $exception);
     }
 }
diff --git a/src/DriverManager.php b/src/DriverManager.php
@@ -64,10 +64,15 @@
  *     serverVersion?: string,
  *     sharding?: array<string,mixed>,
  *     slaves?: array<OverrideParams>,
+ *     ssl_ca?: string,
+ *     ssl_capath?: string,
+ *     ssl_cert?: string,
+ *     ssl_cipher?: string,
+ *     ssl_key?: string,
+ *     unix_socket?: string,
  *     url?: string,
  *     user?: string,
  *     wrapperClass?: class-string<Connection>,
- *     unix_socket?: string,
  * }
  */
 final class DriverManager

diff --git a/src/Platforms/AbstractMySQLPlatform.php b/src/Platforms/AbstractMySQLPlatform.php
@@ -1418,7 +1418,7 @@ public function createSchemaManager(Connection $connection): MySQLSchemaManager
     }
 
     /**
-     * @param list<T> $assets
+     * @param array<T> $assets
      *
      * @return array<string,T>
      *

diff --git a/src/Platforms/AbstractPlatform.php b/src/Platforms/AbstractPlatform.php
@@ -2172,7 +2172,7 @@ private function buildCreateTableSQL(Table $table, bool $createIndexes, bool $cr
     }
 
     /**
-     * @param list<Table> $tables
+     * @param array<Table> $tables
      *
      * @return list<string>
      *
@@ -2199,7 +2199,7 @@ public function getCreateTablesSQL(array $tables): array
     }
 
     /**
-     * @param list<Table> $tables
+     * @param array<Table> $tables
      *
      * @return list<string>
      */
@@ -2840,7 +2840,7 @@ protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff)
         return $sql;
     }
 
-    /** @return string[] */
+    /** @return list<string> */
     protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff)
     {
         $sql     = [];
@@ -2888,7 +2888,7 @@ protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff)
      * @param Index  $index        The definition of the index to rename to.
      * @param string $tableName    The table to rename the given index on.
      *
-     * @return string[] The sequence of SQL statements for renaming the given index.
+     * @return list<string> The sequence of SQL statements for renaming the given index.
      */
     protected function getRenameIndexSQL($oldIndexName, Index $index, $tableName)
     {

diff --git a/src/Result.php b/src/Result.php
@@ -117,9 +117,11 @@ public function fetchAllKeyValue(): array
     {
         $this->ensureHasKeyValue();
 
-        $data = [];
+        /** @var list<array{mixed, mixed}> $allRows */
+        $allRows = $this->fetchAllNumeric();
 
-        foreach ($this->fetchAllNumeric() as [$key, $value]) {
+        $data = [];
+        foreach ($allRows as [$key, $value]) {
             $data[$key] = $value;
         }
 
@@ -192,7 +194,10 @@ public function iterateKeyValue(): Traversable
     {
         $this->ensureHasKeyValue();
 
-        foreach ($this->iterateNumeric() as [$key, $value]) {
+        /** @var Traversable<mixed, array{array-key, mixed}> $iterator */
+        $iterator = $this->iterateNumeric();
+
+        foreach ($iterator as [$key, $value]) {
             yield $key => $value;
         }
     }