Use dynamic throw type extension on EntityManagerInterface::flush

Author: VincentLanglet

extension.neon

@@ -398,3 +398,8 @@ services:
 		class: PHPStan\PhpDoc\Doctrine\QueryTypeNodeResolverExtension
 		tags:
 			- phpstan.phpDoc.typeNodeResolverExtension
+
+	-
+		class: PHPStan\Type\Doctrine\EntityManagerInterfaceThrowTypeExtension
+		tags:
+			- phpstan.dynamicMethodThrowTypeExtension

phpstan-baseline.neon

@@ -40,6 +40,11 @@ parameters:
 			count: 1
 			path: tests/Rules/Exceptions/CatchWithUnthrownExceptionRuleTest.php
 
+		-
+			message: "#^Accessing PHPStan\\\\Rules\\\\Exceptions\\\\TooWideMethodThrowTypeRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
+			count: 1
+			path: tests/Rules/Exceptions/TooWideMethodThrowTypeRuleTest.php
+
 		-
 			message: "#^Accessing PHPStan\\\\Rules\\\\DeadCode\\\\UnusedPrivatePropertyRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
 			count: 1
@@ -59,4 +64,3 @@ parameters:
 			message: "#^Accessing PHPStan\\\\Rules\\\\Properties\\\\MissingReadOnlyPropertyAssignRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
 			count: 1
 			path: tests/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php
-

src/Type/Doctrine/EntityManagerInterfaceThrowTypeExtension.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine;
+
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Exception\ORMException;
+use Doctrine\Persistence\ObjectManager;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodThrowTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use function array_map;
+
+class EntityManagerInterfaceThrowTypeExtension implements DynamicMethodThrowTypeExtension
+{
+
+	public const SUPPORTED_METHOD = [
+		'flush' => [
+			ORMException::class,
+			UniqueConstraintViolationException::class,
+		],
+	];
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getDeclaringClass()->getName() === ObjectManager::class
+			&& isset(self::SUPPORTED_METHOD[$methodReflection->getName()]);
+	}
+
+	public function getThrowTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
+	{
+		$type = $scope->getType($methodCall->var);
+
+		if ((new ObjectType(EntityManagerInterface::class))->isSuperTypeOf($type)->yes()) {
+			return TypeCombinator::union(
+				...array_map(static function ($class): Type {
+					return new ObjectType($class);
+				}, self::SUPPORTED_METHOD[$methodReflection->getName()])
+			);
+		}
+
+		return $methodReflection->getThrowType();
+	}
+
+}

stubs/EntityManagerInterface.stub

@@ -60,14 +60,6 @@ interface EntityManagerInterface extends ObjectManager
 	 */
 	public function copy($entity, $deep = false);
 
-	/**
-	 * @return void
-	 *
-	 * @throws ORMException
-	 * @throws \Doctrine\DBAL\Exception\UniqueConstraintViolationException
-	 */
-	public function flush();
-
 	/**
 	 * @template T of object
 	 * @phpstan-param class-string<T> $className

tests/Rules/Exceptions/TooWideMethodThrowTypeRuleTest.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Exceptions;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<TooWideMethodThrowTypeRule>
+ */
+class TooWideMethodThrowTypeRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return self::getContainer()->getByType(TooWideMethodThrowTypeRule::class);
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/entity-manager-interface.php'], []);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../extension.neon',
+		];
+	}
+
+}

tests/Rules/Exceptions/data/entity-manager-interface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace EntityManagerInterfaceThrowTypeExtensionTest;
+
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Exception\ORMException;
+
+class Example
+{
+
+	/**
+	 * @throws ORMException
+	 * @throws UniqueConstraintViolationException
+	 */
+	public function doFoo(EntityManagerInterface $entityManager): void
+	{
+		$entityManager->flush();
+	}
+
+}