implementation for interfaces

Author: Bartłomiej Nowak

extension.neon

@@ -10,9 +10,10 @@ parameters:
 		consoleApplicationLoader: null
 		messenger:
 			handleTraitWrappers:
-				# move that params to tests only
+				# todo move that params to tests only
 				- MessengerHandleTrait\QueryBus::dispatch
-				- MessengerHandleTrait\QueryBus2::dispatch
+				- MessengerHandleTrait\QueryBus::dispatch2
+				- MessengerHandleTrait\QueryBusInterface::dispatch
 	stubFiles:
 		- stubs/Psr/Cache/CacheException.stub
 		- stubs/Psr/Cache/CacheItemInterface.stub

src/Type/Symfony/MessengerHandleTraitWrapperReturnTypeExtension.php

@@ -6,6 +6,7 @@
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Symfony\MessageMap;
 use PHPStan\Symfony\MessageMapFactory;
 use PHPStan\Type\ExpressionTypeResolverExtension;
@@ -18,7 +19,7 @@
  * Configurable extension for resolving return types of methods that internally use HandleTrait.
  *
  * Configured via PHPStan parameters under symfony.messenger.handleTraitWrappers with
- * "Class::method" patterns, e.g.:
+ * "class::method" patterns, e.g.:
  * - App\Bus\QueryBus::dispatch
  * - App\Bus\QueryBus::query
  * - App\Bus\CommandBus::execute
@@ -34,11 +35,14 @@ final class MessengerHandleTraitWrapperReturnTypeExtension implements Expression
 	/** @var array<string> */
 	private array $wrappers;
 
+	private ReflectionProvider $reflectionProvider;
+
 	/** @param array{handleTraitWrappers: array<string>}|null $messenger */
-	public function __construct(MessageMapFactory $messageMapFactory, ?array $messenger)
+	public function __construct(MessageMapFactory $messageMapFactory, ?array $messenger, ReflectionProvider $reflectionProvider)
 	{
 		$this->messageMapFactory = $messageMapFactory;
 		$this->wrappers = $messenger['handleTraitWrappers'] ?? [];
+		$this->reflectionProvider = $reflectionProvider;
 	}
 
 	public function getType(Expr $expr, Scope $scope): ?Type
@@ -91,8 +95,23 @@ private function isSupported(Expr $expr, Scope $scope): bool
 		$className = $classNames[0];
 		$classMethodCombination = $className . '::' . $methodName;
 
-		// Check if this class::method combination is configured
-		return in_array($classMethodCombination, $this->wrappers, true);
+		// Check if this exact class::method combination is configured
+		if (in_array($classMethodCombination, $this->wrappers, true)) {
+			return true;
+		}
+
+		// Check if any interface implemented by this class::method is configured
+		if ($this->reflectionProvider->hasClass($className)) {
+			$classReflection = $this->reflectionProvider->getClass($className);
+			foreach ($classReflection->getInterfaces() as $interface) {
+				$interfaceMethodCombination = $interface->getName() . '::' . $methodName;
+				if (in_array($interfaceMethodCombination, $this->wrappers, true)) {
+					return true;
+				}
+			}
+		}
+
+		return false;
 	}
 
 	private function getMessageMap(): MessageMap

tests/Type/Symfony/data/messenger_handle_trait.php

@@ -62,9 +62,18 @@ public function dispatch(object $query): mixed
     {
         return $this->handle($query);
     }
+
+	public function dispatch2(object $query): mixed
+	{
+		return $this->handle($query);
+	}
+}
+
+interface QueryBusInterface {
+	public function dispatch(object $query): mixed;
 }
 
-class QueryBus2 {
+class QueryBusWithInterface implements QueryBusInterface {
 	use HandleTrait;
 
 	public function dispatch(object $query): mixed
@@ -87,11 +96,14 @@ public function action()
 
         assertType(TaggedResult::class, $queryBus->dispatch(new TaggedQuery()));
 
+		assertType(RegularQueryResult::class, $queryBus->dispatch2(new RegularQuery()));
+
+		$queryBusWithInterface = new QueryBusWithInterface();
+
+		assertType(RegularQueryResult::class, $queryBusWithInterface->dispatch(new RegularQuery()));
+
         // HandleTrait will throw exception in fact due to multiple handle methods/handlers per single query
         assertType('mixed', $queryBus->dispatch(new MultiHandlesForInTheSameHandlerQuery()));
         assertType('mixed', $queryBus->dispatch(new MultiHandlersForTheSameMessageQuery()));
-
-		$queryBus2 = new QueryBus2();
-		assertType(TaggedResult::class, $queryBus2->dispatch(new TaggedQuery()));
     }
 }