Merge pull request #60 from sascha-egerer/feature/allow-phpdoctypes-in-mappings

Allow more complex phpdoc types in mappings and add more tests

Author: sascha-egerer

README.md

@@ -50,8 +50,9 @@ what type of class is returned by Request::getAttribute()
 ```
 parameters:
     typo3:
-        requestApiGetAttributeMapping:
+        requestGetAttributeMapping:
             myAttribute: FlowdGmbh\MyProject\Http\MyAttribute
+            myNullableAttribute: FlowdGmbh\MyProject\Http\MyAttribute|null
 ```
 
 ```

extension.neon

@@ -39,6 +39,12 @@ services:
             contextApiGetAspectMapping: %typo3.contextApiGetAspectMapping%
         tags:
             - phpstan.rules.rule
+    -
+        class: SaschaEgerer\PhpstanTypo3\Rule\RequestAttributeValidationRule
+        arguments:
+            requestGetAttributeMapping: %typo3.requestGetAttributeMapping%
+        tags:
+            - phpstan.rules.rule
     -
         class: SaschaEgerer\PhpstanTypo3\Type\RepositoryQueryDynamicReturnTypeExtension
         tags:
@@ -50,7 +56,7 @@ services:
     -
         class: SaschaEgerer\PhpstanTypo3\Type\RequestDynamicReturnTypeExtension
         arguments:
-            requestApiGetAttributeMapping: %typo3.requestApiGetAttributeMapping%
+            requestGetAttributeMapping: %typo3.requestGetAttributeMapping%
         tags:
             - phpstan.broker.dynamicMethodReturnTypeExtension
 parameters:
@@ -65,14 +71,16 @@ parameters:
             workspace: TYPO3\CMS\Core\Context\WorkspaceAspect
             language: TYPO3\CMS\Core\Context\LanguageAspect
             typoscript: TYPO3\CMS\Core\Context\TypoScriptAspect
-        requestApiGetAttributeMapping:
+        requestGetAttributeMapping:
             backend.user: TYPO3\CMS\Backend\FrontendBackendUserAuthentication
             frontend.user: TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication
             language: TYPO3\CMS\Core\Site\Entity\SiteLanguage
             module: TYPO3\CMS\Backend\Module\ModuleInterface
             moduleData: TYPO3\CMS\Backend\Module\ModuleData
             normalizedParams: TYPO3\CMS\Core\Http\NormalizedParams
             site: TYPO3\CMS\Core\Site\Entity\Site
+            applicationType: TYPO3\CMS\Core\Core\SystemEnvironmentBuilder::REQUESTTYPE_*
+            routing: TYPO3\CMS\Core\Routing\SiteRouteResult|TYPO3\CMS\Core\Routing\PageArguments
     stubFiles:
         - stubs/DomainObjectInterface.stub
         - stubs/GeneralUtility.stub
@@ -126,5 +134,5 @@ parameters:
 parametersSchema:
     typo3: structure([
         contextApiGetAspectMapping: arrayOf(string())
-        requestApiGetAttributeMapping: arrayOf(string())
+        requestGetAttributeMapping: arrayOf(string())
     ])

phpstan.neon

@@ -1,6 +1,8 @@
 includes:
     - vendor/phpstan/phpstan-strict-rules/rules.neon
     - extension.neon
+    - tests/Unit/Type/data/context-get-aspect-return-types.neon
+    - tests/Unit/Type/data/request-get-attribute-return-types.neon
 
 parameters:
     level: 8

src/Rule/RequestAttributeValidationRule.php

@@ -0,0 +1,69 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Rule;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\RuleErrorBuilder;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Expr\MethodCall>
+ */
+class RequestAttributeValidationRule implements \PHPStan\Rules\Rule
+{
+
+	/** @var array<string, string> */
+	private $requestGetAttributeMapping;
+
+	/**
+	 * @param array<string, string> $requestGetAttributeMapping
+	 */
+	public function __construct(array $requestGetAttributeMapping)
+	{
+		$this->requestGetAttributeMapping = $requestGetAttributeMapping;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Expr\MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->name instanceof Node\Identifier) {
+			return [];
+		}
+
+		$methodReflection = $scope->getMethodReflection($scope->getType($node->var), $node->name->toString());
+		if ($methodReflection === null || $methodReflection->getName() !== 'getAttribute') {
+			return [];
+		}
+
+		$declaringClass = $methodReflection->getDeclaringClass();
+
+		if (!$declaringClass->implementsInterface(ServerRequestInterface::class) && $declaringClass->getName() !== ServerRequestInterface::class) {
+			return [];
+		}
+
+		$argument = $node->getArgs()[0] ?? null;
+
+		if (!($argument instanceof Node\Arg) || !($argument->value instanceof Node\Scalar\String_)) {
+			return [];
+		}
+
+		if (isset($this->requestGetAttributeMapping[$argument->value->value])) {
+			return [];
+		}
+
+		$ruleError = RuleErrorBuilder::message(sprintf(
+			'There is no request attribute "%s" configured so we can\'t figure out the exact type to return when calling %s::%s',
+			$argument->value->value,
+			$declaringClass->getDisplayName(),
+			$methodReflection->getName()
+		))->tip('You should add custom request attribute to the typo3.requestGetAttributeMapping setting.')->build();
+
+		return [$ruleError];
+	}
+
+}

src/Type/ContextDynamicReturnTypeExtension.php

@@ -4,10 +4,10 @@
 
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
+use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
-use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 
 class ContextDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
@@ -16,12 +16,16 @@ class ContextDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtens
 	/** @var array<string, string> */
 	private $contextApiGetAspectMapping;
 
+	/** @var TypeStringResolver */
+	private $typeStringResolver;
+
 	/**
 	 * @param array<string, string> $contextApiGetAspectMapping
 	 */
-	public function __construct(array $contextApiGetAspectMapping)
+	public function __construct(array $contextApiGetAspectMapping, TypeStringResolver $typeStringResolver)
 	{
 		$this->contextApiGetAspectMapping = $contextApiGetAspectMapping;
+		$this->typeStringResolver = $typeStringResolver;
 	}
 
 	public function getClass(): string
@@ -49,7 +53,7 @@ public function getTypeFromMethodCall(
 		}
 
 		if (isset($this->contextApiGetAspectMapping[$argument->value->value])) {
-			return new ObjectType($this->contextApiGetAspectMapping[$argument->value->value]);
+			return $this->typeStringResolver->resolve($this->contextApiGetAspectMapping[$argument->value->value]);
 		}
 
 		return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();

src/Type/RequestDynamicReturnTypeExtension.php

@@ -4,24 +4,29 @@
 
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
+use PHPStan\PhpDoc\TypeStringResolver;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
-use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
 
 class RequestDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
 
 	/** @var array<string, string> */
-	private $requestApiGetAttributeMapping;
+	private $requestGetAttributeMapping;
+
+	/** @var TypeStringResolver */
+	private $typeStringResolver;
 
 	/**
-	 * @param array<string, string> $requestApiGetAttributeMapping
+	 * @param array<string, string> $requestGetAttributeMapping
 	 */
-	public function __construct(array $requestApiGetAttributeMapping)
+	public function __construct(array $requestGetAttributeMapping, TypeStringResolver $typeStringResolver)
 	{
-		$this->requestApiGetAttributeMapping = $requestApiGetAttributeMapping;
+		$this->requestGetAttributeMapping = $requestGetAttributeMapping;
+		$this->typeStringResolver = $typeStringResolver;
 	}
 
 	public function getClass(): string
@@ -41,8 +46,8 @@ public function getTypeFromMethodCall(
 			return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
 		}
 
-		if (isset($this->requestApiGetAttributeMapping[$argument->value->value])) {
-			return new ObjectType($this->requestApiGetAttributeMapping[$argument->value->value]);
+		if (isset($this->requestGetAttributeMapping[$argument->value->value])) {
+			return TypeCombinator::addNull($this->typeStringResolver->resolve($this->requestGetAttributeMapping[$argument->value->value]));
 		}
 
 		return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();

tests/Unit/Type/ContextDynamicReturnTypeExtensionTest.php

@@ -33,7 +33,10 @@ public function testFileAsserts(
 
 	public static function getAdditionalConfigFiles(): array
 	{
-		return [__DIR__ . '/../../../extension.neon'];
+		return [
+			__DIR__ . '/../../../extension.neon',
+			__DIR__ . '/data/context-get-aspect-return-types.neon',
+		];
 	}
 
 }

tests/Unit/Type/RequestGetAttributeDynamicReturnTypeExtensionTest.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Tests\Unit\Type;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class RequestGetAttributeDynamicReturnTypeExtensionTest extends TypeInferenceTestCase
+{
+
+	/**
+	 * @return iterable<mixed>
+	 */
+	public function dataFileAsserts(): iterable
+	{
+		// path to a file with actual asserts of expected types:
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/request-get-attribute-return-types.php');
+	}
+
+	/**
+	 * @dataProvider dataFileAsserts
+	 * @param string $assertType
+	 * @param string $file
+	 * @param mixed ...$args
+	 */
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../extension.neon',
+			__DIR__ . '/data/request-get-attribute-return-types.neon',
+		];
+	}
+
+}

tests/Unit/Type/data/context-get-aspect-return-types.neon

@@ -0,0 +1,4 @@
+parameters:
+    typo3:
+        contextApiGetAspectMapping:
+            myCustomAspect: Foo\Bar|TYPO3\CMS\Core\Context\DateTimeAspect

tests/Unit/Type/data/context-get-aspect-return-types.php

@@ -27,6 +27,7 @@ public function getAspectTests(Context $context): void
 		assertType(UserAspect::class, $context->getAspect('frontend.user'));
 		assertType(WorkspaceAspect::class, $context->getAspect('workspace'));
 		assertType(LanguageAspect::class, $context->getAspect('language'));
+		assertType('Foo\Bar|TYPO3\CMS\Core\Context\DateTimeAspect', $context->getAspect('myCustomAspect'));
 	}
 
 }