WIP Psalm 5.10.0-dev

doctrine · Apr 3, 2023 · 4263e6f · 4263e6f
1 parent e252152
commit 4263e6f
Show file tree

Hide file tree

Showing 24 changed files with 135 additions and 77 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.10.0@dev"
     },
     "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" />
@@ -607,6 +609,9 @@
                 <!-- 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"/>
             </errorLevel>
         </InvalidArgument>
         <InvalidDocblock>
@@ -627,6 +632,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">
                 <!--
@@ -636,6 +647,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">
                 <!--
@@ -811,6 +828,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>
@@ -823,6 +841,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>
@@ -838,10 +857,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/Platforms/AbstractMySQLPlatform.php b/src/Platforms/AbstractMySQLPlatform.php
@@ -1417,7 +1417,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/Schema/SchemaDiff.php b/src/Schema/SchemaDiff.php
@@ -29,7 +29,7 @@ class SchemaDiff
      *
      * @internal Use {@link getCreatedSchemas()} instead.
      *
-     * @var string[]
+     * @var array<string, string>
      */
     public $newNamespaces = [];
 
@@ -38,7 +38,7 @@ class SchemaDiff
      *
      * @internal Use {@link getDroppedSchemas()} instead.
      *
-     * @var string[]
+     * @var array<string, string>
      */
     public $removedNamespaces = [];
 
@@ -47,7 +47,7 @@ class SchemaDiff
      *
      * @internal Use {@link getCreatedTables()} instead.
      *
-     * @var Table[]
+     * @var array<string, Table>
      */
     public $newTables = [];
 
@@ -56,7 +56,7 @@ class SchemaDiff
      *
      * @internal Use {@link getAlteredTables()} instead.
      *
-     * @var TableDiff[]
+     * @var array<string, TableDiff>
      */
     public $changedTables = [];
 
@@ -65,28 +65,28 @@ class SchemaDiff
      *
      * @internal Use {@link getDroppedTables()} instead.
      *
-     * @var Table[]
+     * @var array<string, Table>
      */
     public $removedTables = [];
 
     /**
      * @internal Use {@link getCreatedSequences()} instead.
      *
-     * @var Sequence[]
+     * @var list<Sequence>
      */
     public $newSequences = [];
 
     /**
      * @internal Use {@link getAlteredSequences()} instead.
      *
-     * @var Sequence[]
+     * @var list<Sequence>
      */
     public $changedSequences = [];
 
     /**
      * @internal Use {@link getDroppedSequences()} instead.
      *
-     * @var Sequence[]
+     * @var list<Sequence>
      */
     public $removedSequences = [];
 
@@ -102,14 +102,14 @@ class SchemaDiff
      *
      * @internal The diff can be only instantiated by a {@see Comparator}.
      *
-     * @param Table[]         $newTables
-     * @param TableDiff[]     $changedTables
-     * @param Table[]         $removedTables
-     * @param array<string>   $createdSchemas
-     * @param array<string>   $droppedSchemas
-     * @param array<Sequence> $createdSequences
-     * @param array<Sequence> $alteredSequences
-     * @param array<Sequence> $droppedSequences
+     * @param array<string, Table>     $newTables
+     * @param array<string, TableDiff> $changedTables
+     * @param array<string, Table>     $removedTables
+     * @param array<string, string>    $createdSchemas
+     * @param array<string, string>    $droppedSchemas
+     * @param list<Sequence>           $createdSequences
+     * @param list<Sequence>           $alteredSequences
+     * @param list<Sequence>           $droppedSequences
      */
     public function __construct(
         $newTables = [],
@@ -137,49 +137,49 @@ public function __construct(
         $this->removedSequences  = $droppedSequences;
     }
 
-    /** @return array<string> */
+    /** @return array<string, string> */
     public function getCreatedSchemas(): array
     {
         return $this->newNamespaces;
     }
 
-    /** @return array<string> */
+    /** @return array<string, string> */
     public function getDroppedSchemas(): array
     {
         return $this->removedNamespaces;
     }
 
-    /** @return array<Table> */
+    /** @return array<string, Table> */
     public function getCreatedTables(): array
     {
         return $this->newTables;
     }
 
-    /** @return array<TableDiff> */
+    /** @return array<string, TableDiff> */
     public function getAlteredTables(): array
     {
         return $this->changedTables;
     }
 
-    /** @return array<Table> */
+    /** @return array<string, Table> */
     public function getDroppedTables(): array
     {
         return $this->removedTables;
     }
 
-    /** @return array<Sequence> */
+    /** @return list<Sequence> */
     public function getCreatedSequences(): array
     {
         return $this->newSequences;
     }
 
-    /** @return array<Sequence> */
+    /** @return list<Sequence> */
     public function getAlteredSequences(): array
     {
         return $this->changedSequences;
     }
 
-    /** @return array<Sequence> */
+    /** @return list<Sequence> */
     public function getDroppedSequences(): array
     {
         return $this->removedSequences;

diff --git a/src/Schema/TableDiff.php b/src/Schema/TableDiff.php
@@ -105,7 +105,7 @@ class TableDiff
      *
      * @internal Use {@see getAddedForeignKeys()} instead.
      *
-     * @var ForeignKeyConstraint[]
+     * @var list<ForeignKeyConstraint>
      */
     public $addedForeignKeys = [];
 
@@ -114,7 +114,7 @@ class TableDiff
      *
      * @internal Use {@see getModifiedForeignKeys()} instead.
      *
-     * @var ForeignKeyConstraint[]
+     * @var list<ForeignKeyConstraint>
      */
     public $changedForeignKeys = [];
 
@@ -123,7 +123,7 @@ class TableDiff
      *
      * @internal Use {@see getDroppedForeignKeys()} instead.
      *
-     * @var (ForeignKeyConstraint|string)[]
+     * @var list<ForeignKeyConstraint|string>
      */
     public $removedForeignKeys = [];
 
@@ -333,12 +333,10 @@ public function getDroppedForeignKeys(): array
      */
     public function unsetDroppedForeignKey($foreignKey): void
     {
-        $this->removedForeignKeys = array_filter(
+        $this->removedForeignKeys = array_values(array_filter(
             $this->removedForeignKeys,
-            static function ($removedForeignKey) use ($foreignKey): bool {
-                return $removedForeignKey !== $foreignKey;
-            },
-        );
+            static fn ($removedForeignKey): bool => $removedForeignKey !== $foreignKey,
+        ));
     }
 
     /**