Psalm level 5

It adds a baseline to reach level 5
doctrine · Feb 16, 2022 · 946ff86 · 946ff86
1 parent 87f0c64
commit 946ff86
Show file tree

Hide file tree

Showing 28 changed files with 206 additions and 73 deletions.
diff --git a/composer.json b/composer.json
@@ -48,7 +48,7 @@
         "phpunit/phpunit": "^8.5 || ^9",
         "squizlabs/php_codesniffer": "^3.5",
         "symfony/cache": "^4.4 || ^5.0 || ^6.0",
-        "vimeo/psalm": "^4.8.1"
+        "vimeo/psalm": "^4.20.0"
     },
     "suggest": {
         "ext-bcmath": "Decimal128 type support"

diff --git a/lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php b/lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php
@@ -29,7 +29,7 @@ final class PrimingIterator implements Iterator
     /** @var ReferencePrimer */
     private $referencePrimer;
 
-    /** @var array<string, callable|null> */
+    /** @var array<string, callable|true|null> */
     private $primers;
 
     /**
@@ -42,9 +42,9 @@ final class PrimingIterator implements Iterator
     private $referencesPrimed = false;
 
     /**
-     * @param \Iterator<mixed, TValue>     $iterator
-     * @param ClassMetadata<TDocument>     $class
-     * @param array<string, callable|null> $primers
+     * @param \Iterator<mixed, TValue>          $iterator
+     * @param ClassMetadata<TDocument>          $class
+     * @param array<string, callable|true|null> $primers
      * @psalm-param Hints $unitOfWorkHints
      */
     public function __construct(\Iterator $iterator, ClassMetadata $class, ReferencePrimer $referencePrimer, array $primers, array $unitOfWorkHints = [])

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeReader.php b/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeReader.php
@@ -20,16 +20,17 @@
  */
 final class AttributeReader implements Reader
 {
-    /**
-     * @param ReflectionClass<object> $class
-     */
     public function getClassAnnotations(ReflectionClass $class): array
     {
         return $this->convertToAttributeInstances($class->getAttributes());
     }
 
     /**
-     * @param ReflectionClass<object> $class
+     * @param class-string<T> $annotationName
+     *
+     * @return T|null
+     *
+     * @template T
      */
     public function getClassAnnotation(ReflectionClass $class, $annotationName)
     {
@@ -47,6 +48,13 @@ public function getMethodAnnotations(ReflectionMethod $method): array
         return $this->convertToAttributeInstances($method->getAttributes());
     }
 
+    /**
+     * @param class-string<T> $annotationName
+     *
+     * @return T|null
+     *
+     * @template T
+     */
     public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
     {
         foreach ($this->getMethodAnnotations($method) as $annotation) {
@@ -63,6 +71,13 @@ public function getPropertyAnnotations(ReflectionProperty $property): array
         return $this->convertToAttributeInstances($property->getAttributes());
     }
 
+    /**
+     * @param class-string<T> $annotationName
+     *
+     * @return T|null
+     *
+     * @template T
+     */
     public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
     {
         foreach ($this->getPropertyAnnotations($property) as $annotation) {

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php b/lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php
@@ -571,7 +571,7 @@ private function addIndex(ClassMetadata $class, SimpleXMLElement $xmlIndex): voi
     }
 
     /**
-     * @return array<string, array<string, mixed>|scalar>
+     * @return array<string, array<string, mixed>|scalar|null>
      */
     private function getPartialFilterExpression(SimpleXMLElement $fields): array
     {

diff --git a/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php b/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php
@@ -428,6 +428,7 @@ public function isEmpty()
 
     /**
      * @return Traversable
+     * @psalm-return Traversable<TKey, T>
      */
     #[ReturnTypeWillChange]
     public function getIterator()
@@ -540,6 +541,7 @@ public function offsetExists($offset)
      * @param mixed $offset
      *
      * @return mixed
+     * @psalm-return T|null
      */
     #[ReturnTypeWillChange]
     public function offsetGet($offset)
@@ -660,6 +662,11 @@ private function doAdd($value, $arrayAccess)
      * @param mixed $offset
      *
      * @return bool|T|null
+     * @psalm-return (
+     *      $arrayAccess is false
+     *      ? T|null
+     *      : T|null|true
+     * )
      */
     private function doRemove($offset, bool $arrayAccess)
     {

diff --git a/lib/Doctrine/ODM/MongoDB/Proxy/Factory/StaticProxyFactory.php b/lib/Doctrine/ODM/MongoDB/Proxy/Factory/StaticProxyFactory.php
@@ -70,8 +70,9 @@ public function generateProxyClasses(array $classes): int
                 ->proxyFactory
                 ->createProxy(
                     $metadata->getName(),
-                    static function () {
+                    static function (): bool {
                         // empty closure, serves its purpose, for now
+                        return true;
                     },
                     [
                         'skippedProperties' => $this->skippedFieldsFqns($metadata),
@@ -83,10 +84,18 @@ static function () {
     }
 
     /**
-     * @param ClassMetadata<T>     $metadata
-     * @param DocumentPersister<T> $documentPersister
+     * @param ClassMetadata<TDocument>     $metadata
+     * @param DocumentPersister<TDocument> $documentPersister
      *
-     * @template T of object
+     * @psalm-return Closure(
+     *   TDocument&GhostObjectInterface<TDocument>,
+     *   string,
+     *   array<string, mixed>,
+     *   ?Closure=,
+     *   array<string, mixed>
+     * ) : bool
+     *
+     * @template TDocument of object
      */
     private function createInitializer(
         ClassMetadata $metadata,

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -153,11 +153,6 @@ parameters:
             count: 1
             path: tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM88Test.php
 
-        -
-            message: "#^Call to an undefined method Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\<object\\>\\:\\:mapField\\(\\)\\.$#"
-            count: 1
-            path: tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataLoadEventTest.php
-
         -
             message: "#^Parameter \\#1 \\$primer of method Doctrine\\\\ODM\\\\MongoDB\\\\Query\\\\Builder\\:\\:prime\\(\\) expects bool\\|\\(callable\\(\\)\\: mixed\\), 1 given\\.$#"
             count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="4.20.0@f82a70e7edfc6cf2705e9374c8a0b6a974a779ed">
+  <file src="lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GeoNear.php">
+    <InvalidReturnStatement occurrences="1">
+      <code>$this-&gt;num($limit)</code>
+    </InvalidReturnStatement>
+    <InvalidReturnType occurrences="1">
+      <code>self</code>
+    </InvalidReturnType>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php">
+    <InvalidArrayOffset occurrences="1">
+      <code>[$this-&gt;identifier =&gt; $this-&gt;getIdentifierValue($object)]</code>
+    </InvalidArrayOffset>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php">
+    <InvalidArgument occurrences="1">
+      <code>$mapping</code>
+    </InvalidArgument>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/PersistentCollection/AbstractPersistentCollectionFactory.php">
+    <InvalidArgument occurrences="1">
+      <code>new PersistentCollection($coll, $dm, $dm-&gt;getUnitOfWork())</code>
+    </InvalidArgument>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php">
+    <InvalidArgument occurrences="5">
+      <code>$func</code>
+      <code>$p</code>
+      <code>$p</code>
+      <code>$p</code>
+      <code>$p</code>
+    </InvalidArgument>
+    <InvalidNullableReturnType occurrences="1">
+      <code>getMapping</code>
+    </InvalidNullableReturnType>
+    <InvalidReturnType occurrences="1">
+      <code>getTypeClass</code>
+    </InvalidReturnType>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Proxy/Resolver/ProxyManagerClassNameResolver.php">
+    <MoreSpecificImplementedParamType occurrences="1">
+      <code>$className</code>
+    </MoreSpecificImplementedParamType>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/Repository/DefaultGridFSRepository.php">
+    <InvalidReturnStatement occurrences="1">
+      <code>$options + ['metadata' =&gt; (object) $metadata]</code>
+    </InvalidReturnStatement>
+  </file>
+  <file src="lib/Doctrine/ODM/MongoDB/UnitOfWork.php">
+    <InvalidPropertyAssignmentValue occurrences="2">
+      <code>$this-&gt;identityMap</code>
+      <code>$this-&gt;originalDocumentData</code>
+    </InvalidPropertyAssignmentValue>
+    <NullableReturnStatement occurrences="1">
+      <code>$mapping['targetDocument']</code>
+    </NullableReturnStatement>
+  </file>
+  <file src="tests/Doctrine/ODM/MongoDB/Tests/DocumentRepositoryTest.php">
+    <InvalidArgument occurrences="1">
+      <code>new ArrayCollection([$project])</code>
+    </InvalidArgument>
+  </file>
+  <file src="tests/Doctrine/ODM/MongoDB/Tests/Functional/CollectionPersisterTest.php">
+    <InvalidArgument occurrences="3">
+      <code>[$user-&gt;categories[0]-&gt;children, $user-&gt;categories[1]-&gt;children]</code>
+      <code>[$user-&gt;categories[0]-&gt;children[0]-&gt;children, $user-&gt;categories[0]-&gt;children[1]-&gt;children]</code>
+      <code>[$user-&gt;categories[0]-&gt;children[0]-&gt;children, $user-&gt;categories[0]-&gt;children[1]-&gt;children]</code>
+    </InvalidArgument>
+  </file>
+  <file src="tests/Doctrine/ODM/MongoDB/Tests/Functional/CustomCollectionsTest.php">
+    <InvalidArgument occurrences="4">
+      <code>$i</code>
+      <code>$i</code>
+      <code>$j</code>
+      <code>$j</code>
+    </InvalidArgument>
+  </file>
+  <file src="tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM81Test.php">
+    <InvalidNullableReturnType occurrences="1">
+      <code>DocumentManager</code>
+    </InvalidNullableReturnType>
+    <NullableReturnStatement occurrences="1">
+      <code>$this-&gt;dm</code>
+    </NullableReturnStatement>
+  </file>
+</files>
diff --git a/psalm.xml b/psalm.xml
@@ -1,11 +1,12 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="7"
+    errorLevel="5"
     findUnusedPsalmSuppress="true"
     resolveFromConfigFile="true"
     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"
+    errorBaseline="psalm-baseline.xml"
 >
     <projectFiles>
         <directory name="lib/Doctrine/ODM/MongoDB" />

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/CommitImprovementTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/CommitImprovementTest.php
@@ -101,17 +101,21 @@ public function testChangingCollectionInPostEventsHasNoIllEffects(): void
         $this->dm->persist($user);
         $this->dm->flush();
 
-        $this->assertCount(1, $user->getPhonenumbers()); // so we got a number on postPersist
-        $this->assertInstanceOf(PersistentCollectionInterface::class, $user->getPhonenumbers()); // so we got a number on postPersist
-        $this->assertTrue($user->getPhonenumbers()->isDirty()); // but they should be dirty
+        $phoneNumbers = $user->getPhonenumbers();
+        $this->assertCount(1, $phoneNumbers); // so we got a number on postPersist
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $phoneNumbers); // so we got a number on postPersist
+        $this->assertTrue($phoneNumbers->isDirty()); // but they should be dirty
 
         $collection = $this->dm->getDocumentCollection(get_class($user));
         $inDb       = $collection->findOne();
         $this->assertArrayNotHasKey('phonenumbers', $inDb, 'Collection modified in postPersist should not be in database without recomputing change set');
 
         $this->dm->flush();
-        $this->assertCount(2, $user->getPhonenumbers()); // so we got a number on postUpdate
-        $this->assertTrue($user->getPhonenumbers()->isDirty()); // but they should be dirty
+
+        $phoneNumbers = $user->getPhonenumbers();
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $phoneNumbers);
+        $this->assertCount(2, $phoneNumbers); // so we got a number on postUpdate
+        $this->assertTrue($phoneNumbers->isDirty()); // but they should be dirty
 
         $inDb = $collection->findOne();
         $this->assertCount(1, $inDb['phonenumbers'], 'Collection changes from postUpdate should not be in database');

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/FilterTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/FilterTest.php
@@ -10,12 +10,13 @@
 use Documents\Group;
 use Documents\Profile;
 use Documents\User;
+use MongoDB\BSON\ObjectId;
 
 use function sort;
 
 class FilterTest extends BaseTest
 {
-    /** @var array<string, string> */
+    /** @var array<string, ObjectId|string|null> */
     private $ids;
 
     /** @var FilterCollection */

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/LifecycleTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/LifecycleTest.php
@@ -79,7 +79,7 @@ class ParentObject
     /**
      * @ODM\EmbedOne(targetDocument=ChildEmbeddedObject::class)
      *
-     * @var ChildEmbeddedObject|null
+     * @var ChildEmbeddedObject
      */
     private $childEmbedded;
 

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/ReadPreferenceTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/ReadPreferenceTest.php
@@ -37,8 +37,9 @@ public function testHintIsNotSetByDefault(): void
         $user = $query->getSingleResult();
         $this->assertInstanceOf(User::class, $user);
 
-        $this->assertInstanceOf(PersistentCollectionInterface::class, $user->getGroups());
-        $this->assertArrayNotHasKey(Query::HINT_READ_PREFERENCE, $user->getGroups()->getHints());
+        $groups = $user->getGroups();
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $groups);
+        $this->assertArrayNotHasKey(Query::HINT_READ_PREFERENCE, $groups->getHints());
     }
 
     /**
@@ -58,8 +59,9 @@ public function testHintIsSetOnQuery(int $readPreference, array $tags = []): voi
         $user = $query->getSingleResult();
         $this->assertInstanceOf(User::class, $user);
 
-        $this->assertInstanceOf(PersistentCollectionInterface::class, $user->getGroups());
-        $this->assertReadPreferenceHint($readPreference, $user->getGroups()->getHints()[Query::HINT_READ_PREFERENCE], $tags);
+        $groups = $user->getGroups();
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $groups);
+        $this->assertReadPreferenceHint($readPreference, $groups->getHints()[Query::HINT_READ_PREFERENCE], $tags);
     }
 
     public function provideReadPreferenceHints(): array

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/ReferencesTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/ReferencesTest.php
@@ -257,10 +257,11 @@ public function testFlushInitializesEmptyPersistentCollection(): void
         $this->dm->persist($user);
         $this->dm->flush();
 
-        $this->assertInstanceOf(PersistentCollectionInterface::class, $user->getGroups());
-        $this->assertTrue($user->getGroups()->isInitialized(), 'A flushed collection should be initialized');
-        $this->assertCount(2, $user->getGroups());
-        $this->assertCount(2, $user->getGroups()->toArray());
+        $groups = $user->getGroups();
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $groups);
+        $this->assertTrue($groups->isInitialized(), 'A flushed collection should be initialized');
+        $this->assertCount(2, $groups);
+        $this->assertCount(2, $groups->toArray());
     }
 
     public function testFlushInitializesNotEmptyPersistentCollection(): void
@@ -280,10 +281,11 @@ public function testFlushInitializesNotEmptyPersistentCollection(): void
         $this->dm->persist($user);
         $this->dm->flush();
 
-        $this->assertInstanceOf(PersistentCollectionInterface::class, $user->getGroups());
-        $this->assertTrue($user->getGroups()->isInitialized(), 'A flushed collection should be initialized');
-        $this->assertCount(3, $user->getGroups());
-        $this->assertCount(3, $user->getGroups()->toArray());
+        $groups = $user->getGroups();
+        $this->assertInstanceOf(PersistentCollectionInterface::class, $groups);
+        $this->assertTrue($groups->isInitialized(), 'A flushed collection should be initialized');
+        $this->assertCount(3, $groups);
+        $this->assertCount(3, $groups->toArray());
     }
 
     public function testManyReferenceWithAddToSetStrategy(): void

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH1152Test.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH1152Test.php
@@ -58,11 +58,11 @@ class GH1152Parent
 /**
  * @ODM\EmbeddedDocument
  *
- * @psalm-import-type FieldMapping from ClassMetadata
+ * @psalm-import-type AssociationFieldMapping from ClassMetadata
  */
 class GH1152Child
 {
-    /** @psalm-var array{0: FieldMapping, 1: object|null, 2: string}|null */
+    /** @psalm-var array{0: AssociationFieldMapping, 1: object|null, 2: string}|null */
     public $parentAssociation;
 }
 

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH1229Test.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH1229Test.php
@@ -203,7 +203,7 @@ class GH1229Child
     /**
      * @ODM\Field(type="int")
      *
-     * @var int|null
+     * @var int
      */
     public $order = 0;
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         /**
-         * @return array<string, array<string, mixed>|scalar>
+         * @return array<string, array<string, mixed>|scalar|null>
          */
         private function getPartialFilterExpression(SimpleXMLElement $fields): array
         {
@@ Expand Down @@