Fix issues with Collection<foo, bar>

Author: ondrejmirtes

src/Rules/Doctrine/ORM/EntityRelationRule.php

@@ -85,6 +85,7 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$columnType = null;
+		$toMany = false;
 		if ((bool) ($associationMapping['type'] & 3)) { // ClassMetadataInfo::TO_ONE
 			$columnType = new ObjectType($associationMapping['targetEntity']);
 			if ($identifier !== null && $identifier === $propertyName) {
@@ -96,6 +97,7 @@ public function processNode(Node $node, Scope $scope): array
 				$columnType = TypeCombinator::addNull($columnType);
 			}
 		} elseif ((bool) ($associationMapping['type'] & 12)) { // ClassMetadataInfo::TO_MANY
+			$toMany = true;
 			$columnType = TypeCombinator::intersect(
 				new ObjectType('Doctrine\Common\Collections\Collection'),
 				new IterableType(new MixedType(), new ObjectType($associationMapping['targetEntity']))
@@ -108,13 +110,26 @@ public function processNode(Node $node, Scope $scope): array
 			if (get_class($propertyWritableType) === MixedType::class || $propertyWritableType instanceof ErrorType || $propertyWritableType instanceof NeverType) {
 				return [];
 			}
-			if (!$propertyWritableType->isSuperTypeOf($columnType)->yes()) {
+
+			$collectionObjectType = new ObjectType('Doctrine\Common\Collections\Collection');
+			$propertyWritableTypeToCheckAgainst = $propertyWritableType;
+			if (
+				$toMany
+				&& $collectionObjectType->isSuperTypeOf($propertyWritableType)->yes()
+				&& $propertyWritableType->isIterable()->yes()
+			) {
+				$propertyWritableTypeToCheckAgainst = TypeCombinator::intersect(
+					$collectionObjectType,
+					new IterableType(new MixedType(true), $propertyWritableType->getIterableValueType())
+				);
+			}
+			if (!$propertyWritableTypeToCheckAgainst->isSuperTypeOf($columnType)->yes()) {
 				$errors[] = sprintf(
 					'Property %s::$%s type mapping mismatch: database can contain %s but property expects %s.',
 					$className,
 					$propertyName,
 					$columnType->describe(VerbosityLevel::typeOnly()),
-					$property->getWritableType()->describe(VerbosityLevel::typeOnly())
+					$propertyWritableType->describe(VerbosityLevel::typeOnly())
 				);
 			}
 			if (!$columnType->isSuperTypeOf($property->getReadableType())->yes()) {

tests/Rules/Doctrine/ORM/EntityRelationRuleTest.php

@@ -31,11 +31,31 @@ public function testRule(string $file, array $expectedErrors): void
 	}
 
 	/**
-	 * @return \Iterator<string, mixed[]>
+	 * @return \Iterator<mixed[]>
 	 */
 	public function ruleProvider(): Iterator
 	{
-		yield 'nice entity' => [__DIR__ . '/data/EntityWithRelations.php', []];
+		yield [
+			__DIR__ . '/data/EntityWithRelations.php',
+			[
+				[
+					'Property PHPStan\Rules\Doctrine\ORM\EntityWithRelations::$genericCollection type mapping mismatch: property can contain Doctrine\Common\Collections\Collection<PHPStan\Rules\Doctrine\ORM\AnotherEntity> but database expects Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\AnotherEntity>.',
+					59,
+				],
+				[
+					'Property PHPStan\Rules\Doctrine\ORM\EntityWithRelations::$genericCollection4 type mapping mismatch: property can contain Doctrine\Common\Collections\Collection but database expects Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\AnotherEntity>.',
+					77,
+				],
+				[
+					'Property PHPStan\Rules\Doctrine\ORM\EntityWithRelations::$genericCollection5 type mapping mismatch: database can contain Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\AnotherEntity> but property expects Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\MyEntity>.',
+					83,
+				],
+				[
+					'Property PHPStan\Rules\Doctrine\ORM\EntityWithRelations::$genericCollection5 type mapping mismatch: property can contain Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\MyEntity> but database expects Doctrine\Common\Collections\Collection&iterable<PHPStan\Rules\Doctrine\ORM\AnotherEntity>.',
+					83,
+				],
+			],
+		];
 
 		yield 'one to one' => [__DIR__ . '/data/EntityWithBrokenOneToOneRelations.php',
 			[

tests/Rules/Doctrine/ORM/data/EntityWithRelations.php

@@ -71,9 +71,15 @@ class EntityWithRelations
 	private $genericCollection3;
 
 	/**
-	 * @ORM\OneToMany(targetEntity="PHPStan\Rules\Doctrine\ORM\AnotherEntity")
-	 * @var \Doctrine\Common\Collections\Collection<int, AnotherEntity>
+	 * @ORM\OneToMany(targetEntity="PHPStan\Rules\Doctrine\ORM\AnotherEntity", mappedBy="manyToOne")
+	 * @var \Doctrine\Common\Collections\Collection
+	 */
+	private $genericCollection4;
+
+	/**
+	 * @ORM\OneToMany(targetEntity="PHPStan\Rules\Doctrine\ORM\AnotherEntity", mappedBy="manyToOne")
+	 * @var \Doctrine\Common\Collections\Collection&iterable<MyEntity>
 	 */
-	private $brokenCollectionAnnotation;
+	private $genericCollection5;
 
 }