Merge branch '2.11.x' into 3.0.x

derrabus · derrabus · commit 9b3d89db044b · 2022-01-02T20:18:23.000+01:00
* 2.11.x: Run static analysis with language level PHP 8.1 (doctrine#9314) Document LockMode enums (doctrine#9319) Document PHPUnit mocks with intersection types (doctrine#9318) Run PHP CodeSniffer on PHP 8.1 (doctrine#9317) Psalm 4.17.0 (doctrine#9315) Run static analysis on PHP 8.1 (doctrine#9310)
diff --git a/.github/workflows/coding-standard.yml b/.github/workflows/coding-standard.yml
@@ -12,4 +12,4 @@ jobs:
   coding-standards:
     uses: "doctrine/.github/.github/workflows/coding-standards.yml@1.4.1"
     with:
-      php-version: "8.0"
+      php-version: "8.1"
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -18,7 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
-          - "8.0"
+          - "8.1"
         dbal-version:
           - "default"
 
@@ -53,7 +53,7 @@ jobs:
       fail-fast: false
       matrix:
         php-version:
-          - "8.0"
+          - "8.1"
         dbal-version:
           - "default"
 
diff --git a/composer.json b/composer.json
@@ -45,7 +45,7 @@
         "phpunit/phpunit": "^9.5",
         "squizlabs/php_codesniffer": "3.6.2",
         "symfony/cache": "^4.4 || ^5.4 || ^6.0",
-        "vimeo/psalm": "4.16.1"
+        "vimeo/psalm": "4.17.0"
     },
     "conflict": {
         "doctrine/annotations": "<1.13 || >= 2.0"
diff --git a/lib/Doctrine/ORM/EntityManager.php b/lib/Doctrine/ORM/EntityManager.php
@@ -374,6 +374,7 @@ public function flush($entity = null)
      * @param int|null $lockVersion The version of the entity to find when using
      * optimistic locking.
      * @psalm-param class-string<T> $className
+     * @psalm-param LockMode::*|null $lockMode
      *
      * @return object|null The entity instance or NULL if the entity can not be found.
      * @psalm-return ?T
@@ -946,6 +947,8 @@ public function hasFilters()
     }
 
     /**
+     * @psalm-param LockMode::* $lockMode
+     *
      * @throws OptimisticLockException
      * @throws TransactionRequiredException
      */
diff --git a/lib/Doctrine/ORM/EntityManagerInterface.php b/lib/Doctrine/ORM/EntityManagerInterface.php
@@ -7,6 +7,7 @@
 use DateTimeInterface;
 use Doctrine\Common\EventManager;
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\LockMode;
 use Doctrine\ORM\Exception\ORMException;
 use Doctrine\ORM\Internal\Hydration\AbstractHydrator;
 use Doctrine\ORM\Proxy\ProxyFactory;
@@ -204,6 +205,7 @@ public function close();
      * @param object                     $entity
      * @param int                        $lockMode
      * @param int|DateTimeInterface|null $lockVersion
+     * @psalm-param LockMode::* $lockMode
      *
      * @return void
      *
diff --git a/lib/Doctrine/ORM/EntityRepository.php b/lib/Doctrine/ORM/EntityRepository.php
@@ -8,6 +8,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\Collections\Selectable;
+use Doctrine\DBAL\LockMode;
 use Doctrine\Deprecations\Deprecation;
 use Doctrine\Inflector\Inflector;
 use Doctrine\Inflector\InflectorFactory;
@@ -164,6 +165,7 @@ public function clear()
      *                              or NULL if no specific lock mode should be used
      *                              during the search.
      * @param int|null $lockVersion The lock version.
+     * @psalm-param LockMode::*|null $lockMode
      *
      * @return object|null The entity instance or NULL if the entity can not be found.
      * @psalm-return ?T
diff --git a/lib/Doctrine/ORM/LazyCriteriaCollection.php b/lib/Doctrine/ORM/LazyCriteriaCollection.php
@@ -9,6 +9,7 @@
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\Collections\Selectable;
 use Doctrine\ORM\Persisters\Entity\EntityPersister;
+use ReturnTypeWillChange;
 
 /**
  * A lazy collection that allows a fast count when using criteria object
@@ -38,6 +39,7 @@ public function __construct(EntityPersister $entityPersister, Criteria $criteria
      *
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         if ($this->isInitialized()) {
diff --git a/lib/Doctrine/ORM/PersistentCollection.php b/lib/Doctrine/ORM/PersistentCollection.php
@@ -10,6 +10,7 @@
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\Collections\Selectable;
 use Doctrine\ORM\Mapping\ClassMetadata;
+use ReturnTypeWillChange;
 use RuntimeException;
 
 use function array_combine;
@@ -504,6 +505,7 @@ public function offsetSet($offset, $value): void
      *
      * @return object|null
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         return $this->remove($offset);
diff --git a/lib/Doctrine/ORM/Persisters/Entity/BasicEntityPersister.php b/lib/Doctrine/ORM/Persisters/Entity/BasicEntityPersister.php
@@ -1537,6 +1537,7 @@ public function lock(array $criteria, $lockMode)
      * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.
      *
      * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.
+     * @psalm-param LockMode::*|null $lockMode
      *
      * @return string
      */
diff --git a/lib/Doctrine/ORM/Persisters/Entity/EntityPersister.php b/lib/Doctrine/ORM/Persisters/Entity/EntityPersister.php
@@ -5,6 +5,7 @@
 namespace Doctrine\ORM\Persisters\Entity;
 
 use Doctrine\Common\Collections\Criteria;
+use Doctrine\DBAL\LockMode;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\MappingException;
 use Doctrine\ORM\PersistentCollection;
@@ -54,6 +55,7 @@ public function getInsertSQL();
      * @param int|null         $limit
      * @param int|null         $offset
      * @param mixed[]|null     $orderBy
+     * @psalm-param LockMode::*|null $lockMode
      *
      * @return string
      */
@@ -185,6 +187,7 @@ public function getOwningTable($fieldName);
      * @psalm-param array<string, mixed>       $criteria
      * @psalm-param array<string, mixed>|null  $assoc
      * @psalm-param array<string, mixed>       $hints
+     * @psalm-param LockMode::*|null           $lockMode
      * @psalm-param array<string, string>|null $orderBy
      *
      * @return object|null The loaded and managed entity instance or NULL if the entity can not be found.
@@ -239,6 +242,7 @@ public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifie
      * @psalm-param array<string, mixed> $id The identifier of the entity as an
      *                                       associative array from column or
      *                                       field names to values.
+     * @psalm-param LockMode::*|null $lockMode
      *
      * @return void
      */
@@ -300,6 +304,7 @@ public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentC
      *
      * @param int $lockMode One of the Doctrine\DBAL\LockMode::* constants.
      * @psalm-param array<string, mixed> $criteria
+     * @psalm-param LockMode::* $lockMode
      *
      * @return void
      */
diff --git a/lib/Doctrine/ORM/Query.php b/lib/Doctrine/ORM/Query.php
@@ -732,6 +732,7 @@ public function setHydrationMode($hydrationMode): self
      * @see \Doctrine\DBAL\LockMode
      *
      * @param int $lockMode
+     * @psalm-param LockMode::* $lockMode
      *
      * @throws TransactionRequiredException
      */
diff --git a/lib/Doctrine/ORM/UnitOfWork.php b/lib/Doctrine/ORM/UnitOfWork.php
@@ -2458,6 +2458,7 @@ static function ($assoc) {
      *
      * @param object                     $entity
      * @param int|DateTimeInterface|null $lockVersion
+     * @psalm-param LockMode::* $lockMode
      *
      * @throws ORMInvalidArgumentException
      * @throws TransactionRequiredException
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -255,16 +255,6 @@ parameters:
 			count: 2
 			path: lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php
 
-		-
-			message: "#^Call to an undefined method ReflectionProperty\\:\\:getType\\(\\)\\.$#"
-			count: 3
-			path: lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
-
-		-
-			message: "#^Call to an undefined method ReflectionProperty\\:\\:hasType\\(\\)\\.$#"
-			count: 1
-			path: lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
-
 		-
 			message: "#^Method Doctrine\\\\ORM\\\\Mapping\\\\NamingStrategy\\:\\:joinColumnName\\(\\) invoked with 2 parameters, 1 required\\.$#"
 			count: 2
@@ -821,18 +811,17 @@ parameters:
 			path: lib/Doctrine/ORM/Query/Parser.php
 
 		-
-			message:
-				"""
-					#^PHPDoc tag @return has invalid value \\(AST\\\\BetweenExpression\\|
-					        AST\\\\CollectionMemberExpression\\|
-					        AST\\\\ComparisonExpression\\|
-					        AST\\\\EmptyCollectionComparisonExpression\\|
-					        AST\\\\ExistsExpression\\|
-					        AST\\\\InExpression\\|
-					        AST\\\\InstanceOfExpression\\|
-					        AST\\\\LikeExpression\\|
-					        AST\\\\NullComparisonExpression\\)\\: Unexpected token "\\\\n     \\* ", expected type at offset 344$#
-				"""
+			message: """
+				#^PHPDoc tag @return has invalid value \\(AST\\\\BetweenExpression\\|
+				        AST\\\\CollectionMemberExpression\\|
+				        AST\\\\ComparisonExpression\\|
+				        AST\\\\EmptyCollectionComparisonExpression\\|
+				        AST\\\\ExistsExpression\\|
+				        AST\\\\InExpression\\|
+				        AST\\\\InstanceOfExpression\\|
+				        AST\\\\LikeExpression\\|
+				        AST\\\\NullComparisonExpression\\)\\: Unexpected token "\\\\n     \\* ", expected type at offset 344$#
+			"""
 			count: 1
 			path: lib/Doctrine/ORM/Query/Parser.php
 
diff --git a/phpstan-params.neon b/phpstan-params.neon
@@ -8,4 +8,4 @@ parameters:
     earlyTerminatingMethodCalls:
         Doctrine\ORM\Query\Parser:
             - syntaxError
-    phpVersion: 70100
+    phpVersion: 80100
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.16.1@aa7e400908833b10c0333861f86cd48c510b60eb">
+<files psalm-version="4.17.0@6f4707aa41c9174353a6434bba3fc8840f981d9c">
   <file src="lib/Doctrine/ORM/AbstractQuery.php">
     <DeprecatedMethod occurrences="3">
       <code>getResultCacheDriver</code>
diff --git a/psalm.xml b/psalm.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <psalm
     errorLevel="2"
+    phpVersion="8.1"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
@@ -79,25 +80,12 @@
                 <file name="lib/Doctrine/ORM/QueryBuilder.php"/>
             </errorLevel>
         </RedundantCastGivenDocblockType>
-        <!-- Workaround for https://github.com/vimeo/psalm/issues/7026 -->
-        <ReservedWord>
-            <errorLevel type="suppress">
-                <directory name="lib"/>
-                <directory name="tests"/>
-            </errorLevel>
-        </ReservedWord>
         <TypeDoesNotContainType>
             <errorLevel type="suppress">
                 <file name="lib/Doctrine/ORM/Internal/SQLResultCasing.php"/>
                 <file name="lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php"/>
             </errorLevel>
         </TypeDoesNotContainType>
-        <UndefinedAttributeClass>
-            <errorLevel type="suppress">
-                <!-- The class was added in PHP 8.1 -->
-                <referencedClass name="ReturnTypeWillChange"/>
-            </errorLevel>
-        </UndefinedAttributeClass>
         <UndefinedClass>
             <errorLevel type="suppress">
                 <referencedClass name="Doctrine\Common\Cache\ApcCache"/>
diff --git a/tests/Doctrine/Tests/ORM/Cache/CacheLoggerChainTest.php b/tests/Doctrine/Tests/ORM/Cache/CacheLoggerChainTest.php
@@ -21,7 +21,7 @@ class CacheLoggerChainTest extends DoctrineTestCase
     /** @var CacheLoggerChain */
     private $logger;
 
-    /** @var MockObject|CacheLogger */
+    /** @var CacheLogger&MockObject */
     private $mock;
 
     protected function setUp(): void
diff --git a/tests/Doctrine/Tests/ORM/Cache/DefaultCacheFactoryTest.php b/tests/Doctrine/Tests/ORM/Cache/DefaultCacheFactoryTest.php
@@ -31,6 +31,7 @@
 use Doctrine\Tests\OrmTestCase;
 use InvalidArgumentException;
 use LogicException;
+use PHPUnit\Framework\MockObject\MockObject;
 
 use function assert;
 
@@ -39,7 +40,7 @@
  */
 class DefaultCacheFactoryTest extends OrmTestCase
 {
-    /** @var CacheFactory */
+    /** @var CacheFactory&MockObject */
     private $factory;
 
     /** @var EntityManager */
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/AbstractCollectionPersisterTest.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/AbstractCollectionPersisterTest.php
@@ -14,13 +14,14 @@
 use Doctrine\ORM\Persisters\Collection\CollectionPersister;
 use Doctrine\Tests\Models\Cache\State;
 use Doctrine\Tests\OrmTestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * @group DDC-2183
  */
 abstract class AbstractCollectionPersisterTest extends OrmTestCase
 {
-    /** @var Region */
+    /** @var Region&MockObject */
     protected $region;
 
     /** @var CollectionPersister */
@@ -70,6 +71,9 @@ protected function setUp(): void
                                            ->getMock();
     }
 
+    /**
+     * @return Region&MockObject
+     */
     protected function createRegion(): Region
     {
         return $this->getMockBuilder(Region::class)
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/AbstractEntityPersisterTest.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/AbstractEntityPersisterTest.php
@@ -17,16 +17,17 @@
 use Doctrine\ORM\Query\ResultSetMappingBuilder;
 use Doctrine\Tests\Models\Cache\Country;
 use Doctrine\Tests\OrmTestCase;
+use PHPUnit\Framework\MockObject\MockObject;
 
 /**
  * @group DDC-2183
  */
 abstract class AbstractEntityPersisterTest extends OrmTestCase
 {
-    /** @var Region */
+    /** @var Region&MockObject */
     protected $region;
 
-    /** @var EntityPersister */
+    /** @var EntityPersister&MockObject */
     protected $entityPersister;
 
     /** @var EntityManager */
@@ -45,6 +46,9 @@ protected function setUp(): void
         $this->entityPersister = $this->createMock(EntityPersister::class);
     }
 
+    /**
+     * @return Region&MockObject
+     */
     protected function createRegion(): Region
     {
         return $this->createMock(Region::class);
diff --git a/tests/Doctrine/Tests/ORM/Decorator/EntityManagerDecoratorTest.php b/tests/Doctrine/Tests/ORM/Decorator/EntityManagerDecoratorTest.php
@@ -32,7 +32,7 @@ class EntityManagerDecoratorTest extends TestCase
         'lock',
     ];
 
-    /** @var EntityManagerInterface|MockObject */
+    /** @var EntityManagerInterface&MockObject */
     private $wrapped;
 
     protected function setUp(): void
diff --git a/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php b/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php
diff --git a/tests/Doctrine/Tests/ORM/Hydration/AbstractHydratorTest.php b/tests/Doctrine/Tests/ORM/Hydration/AbstractHydratorTest.php
diff --git a/tests/Doctrine/Tests/ORM/Internal/HydrationCompleteHandlerTest.php b/tests/Doctrine/Tests/ORM/Internal/HydrationCompleteHandlerTest.php
diff --git a/tests/Doctrine/Tests/ORM/LazyCriteriaCollectionTest.php b/tests/Doctrine/Tests/ORM/LazyCriteriaCollectionTest.php
diff --git a/tests/Doctrine/Tests/ORM/Repository/DefaultRepositoryFactoryTest.php b/tests/Doctrine/Tests/ORM/Repository/DefaultRepositoryFactoryTest.php
diff --git a/tests/Doctrine/Tests/ORM/Tools/Pagination/PaginatorTest.php b/tests/Doctrine/Tests/ORM/Tools/Pagination/PaginatorTest.php
diff --git a/tests/Doctrine/Tests/ORM/UnitOfWorkTest.php b/tests/Doctrine/Tests/ORM/UnitOfWorkTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use Doctrine\Common\Collections\Criteria;`
`10`	`10`	`use Doctrine\Common\Collections\Selectable;`
`11`	`11`	`use Doctrine\ORM\Persisters\Entity\EntityPersister;`
	`12`	`+use ReturnTypeWillChange;`
`12`	`13`
`13`	`14`	`/**`
`14`	`15`	`* A lazy collection that allows a fast count when using criteria object`
`@@ -38,6 +39,7 @@ public function __construct(EntityPersister $entityPersister, Criteria $criteria`
`38`	`39`	`*`
`39`	`40`	`* @return int`
`40`	`41`	`*/`
	`42`	`+ #[ReturnTypeWillChange]`
`41`	`43`	`public function count()`
`42`	`44`	`{`
`43`	`45`	`if ($this->isInitialized()) {`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`use Doctrine\Common\Collections\Criteria;`
`11`	`11`	`use Doctrine\Common\Collections\Selectable;`
`12`	`12`	`use Doctrine\ORM\Mapping\ClassMetadata;`
	`13`	`+use ReturnTypeWillChange;`
`13`	`14`	`use RuntimeException;`
`14`	`15`
`15`	`16`	`use function array_combine;`
`@@ -504,6 +505,7 @@ public function offsetSet($offset, $value): void`
`504`	`505`	`*`
`505`	`506`	`* @return object\|null`
`506`	`507`	`*/`
	`508`	`+ #[ReturnTypeWillChange]`
`507`	`509`	`public function offsetUnset($offset)`
`508`	`510`	`{`
`509`	`511`	`return $this->remove($offset);`
Original file line number	Diff line number	Diff line change
`@@ -1537,6 +1537,7 @@ public function lock(array $criteria, $lockMode)`
`1537`	`1537`	`* Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister.`
`1538`	`1538`	`*`
`1539`	`1539`	`* @param int\|null $lockMode One of the Doctrine\DBAL\LockMode::* constants.`
	`1540`	`+ * @psalm-param LockMode::*\|null $lockMode`
`1540`	`1541`	`*`
`1541`	`1542`	`* @return string`
`1542`	`1543`	`*/`