Add EnvelopeReturnTypeExtension for symfony/messenger

Author: enumag

Diff for: composer.json

@@ -33,7 +33,8 @@
     "phpstan/phpstan-phpunit": "^0.11",
     "symfony/framework-bundle": "^3.0 || ^4.0",
     "squizlabs/php_codesniffer": "^3.3.2",
-    "symfony/serializer": "^3|^4"
+    "symfony/serializer": "^3|^4",
+    "symfony/messenger": "^4.2"
   },
   "conflict": {
     "symfony/framework-bundle": "<3.0"

Diff for: src/Type/Symfony/EnvelopeReturnTypeExtension.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+final class EnvelopeReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return 'Symfony\Component\Messenger\Envelope';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'all';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type
+	{
+		if (count($methodCall->args) === 0) {
+			return new ArrayType(new MixedType(), new ArrayType(new MixedType(), new ObjectType(StampInterface::class)));
+		}
+
+		$argType = $scope->getType($methodCall->args[0]->value);
+		if (!$argType instanceof ConstantStringType) {
+			return new ArrayType(new MixedType(), new ObjectType(StampInterface::class));
+		}
+
+		return new ArrayType(new MixedType(), new ObjectType($argType->getValue()));
+	}
+
+}

Diff for: tests/Type/Symfony/EnvelopeReturnTypeExtensionTest.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use Iterator;
+use Symfony\Component\Messenger\Stamp\ReceivedStamp;
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+final class EnvelopeReturnTypeExtensionTest extends ExtensionTestCase
+{
+
+	/**
+	 * @dataProvider getProvider
+	 */
+	public function testAll(string $expression, string $type): void
+	{
+		$this->processFile(
+			__DIR__ . '/envelope_all.php',
+			$expression,
+			$type,
+			new EnvelopeReturnTypeExtension()
+		);
+	}
+
+	public function getProvider(): Iterator
+	{
+		yield ['$test1', 'array<' . ReceivedStamp::class . '>'];
+		yield ['$test2', 'array<' . StampInterface::class . '>'];
+		yield ['$test3', 'array<array<' . StampInterface::class . '>>'];
+	}
+
+}

Diff for: tests/Type/Symfony/envelope_all.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types = 1);
+
+$envelope = new \Symfony\Component\Messenger\Envelope(new stdClass());
+
+$test1 = $envelope->all(\Symfony\Component\Messenger\Stamp\ReceivedStamp::class);
+$test2 = $envelope->all(random_bytes(1));
+$test3 = $envelope->all();
+
+die;