Transform void return to null after call

phpstan · Dec 11, 2023 · 1b4b134 · 1b4b134
1 parent fb76c9f
commit 1b4b134
Show file tree

Hide file tree

Showing 12 changed files with 100 additions and 15 deletions.
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -150,6 +150,8 @@ class MutatingScope implements Scope
 
 	private const BOOLEAN_EXPRESSION_MAX_PROCESS_DEPTH = 4;
 
+	private const KEEP_VOID_ATTRIBUTE_NAME = 'keepVoid';
+
 	/** @var Type[] */
 	private array $resolvedTypes = [];
 
@@ -676,6 +678,10 @@ private function getNodeKey(Expr $node): string
 			$key .= '/*' . $node->getAttribute('startFilePos') . '*/';
 		}
 
+		if ($node->getAttribute(self::KEEP_VOID_ATTRIBUTE_NAME) === true) {
+			$key .= '/*' . self::KEEP_VOID_ATTRIBUTE_NAME . '*/';
+		}
+
 		return $key;
 	}
 
@@ -1236,7 +1242,7 @@ private function resolveType(string $exprString, Expr $node): Type
 						new VoidType(),
 					]);
 				} else {
-					$returnType = $arrowScope->getType($node->expr);
+					$returnType = $arrowScope->getKeepVoidType($node->expr);
 					if ($node->returnType !== null) {
 						$returnType = TypehintHelper::decideType($this->getFunctionType($node->returnType, false, false), $returnType);
 					}
@@ -1492,6 +1498,9 @@ private function resolveType(string $exprString, Expr $node): Type
 			$matchScope = $this;
 			foreach ($node->arms as $arm) {
 				if ($arm->conds === null) {
+					if ($node->hasAttribute(self::KEEP_VOID_ATTRIBUTE_NAME)) {
+						$arm->body->setAttribute(self::KEEP_VOID_ATTRIBUTE_NAME, $node->getAttribute(self::KEEP_VOID_ATTRIBUTE_NAME));
+					}
 					$types[] = $matchScope->getType($arm->body);
 					continue;
 				}
@@ -1521,6 +1530,9 @@ private function resolveType(string $exprString, Expr $node): Type
 
 				if (!$filteringExprType->isFalse()->yes()) {
 					$truthyScope = $matchScope->filterByTruthyValue($filteringExpr);
+					if ($node->hasAttribute(self::KEEP_VOID_ATTRIBUTE_NAME)) {
+						$arm->body->setAttribute(self::KEEP_VOID_ATTRIBUTE_NAME, $node->getAttribute(self::KEEP_VOID_ATTRIBUTE_NAME));
+					}
 					$types[] = $truthyScope->getType($arm->body);
 				}
 
@@ -1946,7 +1958,7 @@ private function resolveType(string $exprString, Expr $node): Type
 				}
 			}
 
-			return $parametersAcceptor->getReturnType();
+			return $this->transformVoidToNull($parametersAcceptor->getReturnType(), $node);
 		}
 
 		return new MixedType();
@@ -1986,6 +1998,25 @@ private function getNullsafeShortCircuitingType(Expr $expr, Type $type): Type
 		return $type;
 	}
 
+	private function transformVoidToNull(Type $type, Node $node): Type
+	{
+		if ($node->getAttribute(self::KEEP_VOID_ATTRIBUTE_NAME) === true) {
+			return $type;
+		}
+
+		return TypeTraverser::map($type, static function (Type $type, callable $traverse): Type {
+			if ($type instanceof UnionType || $type instanceof IntersectionType) {
+				return $traverse($type);
+			}
+
+			if ($type->isVoid()->yes()) {
+				return new NullType();
+			}
+
+			return $type;
+		});
+	}
+
 	/**
 	 * @param callable(Type): ?bool $typeCallback
 	 */
@@ -2173,6 +2204,14 @@ public function getNativeType(Expr $expr): Type
 		return $this->promoteNativeTypes()->getType($expr);
 	}
 
+	public function getKeepVoidType(Expr $node): Type
+	{
+		$clonedNode = clone $node;
+		$clonedNode->setAttribute(self::KEEP_VOID_ATTRIBUTE_NAME, true);
+
+		return $this->getType($clonedNode);
+	}
+
 	/**
 	 * @api
 	 * @deprecated Use getNativeType()
@@ -5103,7 +5142,7 @@ private function methodCallReturnType(Type $typeWithMethod, string $methodName,
 			$normalizedMethodCall = ArgumentsNormalizer::reorderStaticCallArguments($parametersAcceptor, $methodCall);
 		}
 		if ($normalizedMethodCall === null) {
-			return $parametersAcceptor->getReturnType();
+			return $this->transformVoidToNull($parametersAcceptor->getReturnType(), $methodCall);
 		}
 
 		$resolvedTypes = [];
@@ -5142,10 +5181,10 @@ private function methodCallReturnType(Type $typeWithMethod, string $methodName,
 		}
 
 		if (count($resolvedTypes) > 0) {
-			return TypeCombinator::union(...$resolvedTypes);
+			return $this->transformVoidToNull(TypeCombinator::union(...$resolvedTypes), $methodCall);
 		}
 
-		return $parametersAcceptor->getReturnType();
+		return $this->transformVoidToNull($parametersAcceptor->getReturnType(), $methodCall);
 	}
 
 	/** @api */

diff --git a/src/Analyser/Scope.php b/src/Analyser/Scope.php
@@ -77,6 +77,8 @@ public function getType(Expr $node): Type;
 
 	public function getNativeType(Expr $expr): Type;
 
+	public function getKeepVoidType(Expr $node): Type;
+
 	/**
 	 * @deprecated Use getNativeType()
 	 */

diff --git a/src/Rules/Comparison/UsageOfVoidMatchExpressionRule.php b/src/Rules/Comparison/UsageOfVoidMatchExpressionRule.php
@@ -21,7 +21,7 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if (!$scope->isInFirstLevelStatement()) {
-			$matchResultType = $scope->getType($node);
+			$matchResultType = $scope->getKeepVoidType($node);
 			if ($matchResultType->isVoid()->yes()) {
 				return [RuleErrorBuilder::message('Result of match expression (void) is used.')->build()];
 			}

diff --git a/src/Rules/FunctionCallParametersCheck.php b/src/Rules/FunctionCallParametersCheck.php
@@ -210,7 +210,7 @@ public function check(
 		if (
 			!$funcCall instanceof Node\Expr\New_
 			&& !$scope->isInFirstLevelStatement()
-			&& $scope->getType($funcCall)->isVoid()->yes()
+			&& $scope->getKeepVoidType($funcCall)->isVoid()->yes()
 		) {
 			$errors[] = RuleErrorBuilder::message($messages[7])->line($funcCall->getLine())->build();
 		}

diff --git a/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php b/tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
@@ -6072,15 +6072,15 @@ public function dataVoid(): array
 	{
 		return [
 			[
-				'void',
+				'null',
 				'$this->doFoo()',
 			],
 			[
-				'void',
+				'null',
 				'$this->doBar()',
 			],
 			[
-				'void',
+				'null',
 				'$this->doConflictingVoid()',
 			],
 		];

diff --git a/tests/PHPStan/Analyser/data/conditional-types.php b/tests/PHPStan/Analyser/data/conditional-types.php
@@ -151,9 +151,9 @@ abstract public function maybeNever(int $option): void;
 
 	public function testMaybeNever(): void
 	{
-		assertType('void', $this->maybeNever(0));
+		assertType('null', $this->maybeNever(0));
 		assertType('never', $this->maybeNever(1));
-		assertType('void', $this->maybeNever(2));
+		assertType('null', $this->maybeNever(2));
 	}
 
 	/**

diff --git a/tests/PHPStan/Analyser/data/emptyiterator.php b/tests/PHPStan/Analyser/data/emptyiterator.php
@@ -11,7 +11,7 @@ public function doFoo(\EmptyIterator $it): void
 		assertType('EmptyIterator', $it);
 		assertType('never', $it->key());
 		assertType('never', $it->current());
-		assertType('void', $it->next());
+		assertType('null', $it->next());
 		assertType('false', $it->valid());
 	}
 

diff --git a/tests/PHPStan/Analyser/data/self-out.php b/tests/PHPStan/Analyser/data/self-out.php
@@ -69,12 +69,12 @@ function () {
 	$i = new a(123);
 	// OK - $i is a<123>
 	assertType('SelfOut\\a<int>', $i);
-	assertType('void', $i->test());
+	assertType('null', $i->test());
 
 	$i->addData(321);
 	// OK - $i is a<123|321>
 	assertType('SelfOut\\a<int>', $i);
-	assertType('void', $i->test());
+	assertType('null', $i->test());
 
 	$i->setData("test");
 	// IfThisIsMismatch - Class is not a<int> as required

diff --git a/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php b/tests/PHPStan/Rules/Functions/CallToFunctionParametersRuleTest.php
@@ -1584,6 +1584,11 @@ public function testBug10171(): void
 		]);
 	}
 
+	public function testBug6720(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-6720.php'], []);
+	}
+
 	public function testBug8659(): void
 	{
 		$this->analyse([__DIR__ . '/data/bug-8659.php'], []);

diff --git a/tests/PHPStan/Rules/Functions/data/bug-6720.php b/tests/PHPStan/Rules/Functions/data/bug-6720.php
@@ -0,0 +1,11 @@
+<?php declare(strict_types = 1);
+
+namespace Bug6720;
+
+/** @return string|void */
+function a() {}
+
+function b(?string $a): void {}
+
+$a = a();
+b($a);
diff --git a/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php b/tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php
@@ -974,4 +974,13 @@ public function testWrongListTip(): void
 		]);
 	}
 
+	public function testArrowFunctionReturningVoidClosure(): void
+	{
+		if (PHP_VERSION_ID < 70400) {
+			$this->markTestSkipped('Test requires PHP 7.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/arrow-function-returning-void-closure.php'], []);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/arrow-function-returning-void-closure.php b/tests/PHPStan/Rules/Methods/data/arrow-function-returning-void-closure.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace ArrowFunctionReturningVoidClosure;
+
+class ArrowFunctionReturningVoidClosure
+{
+	/**
+	 * @return \Closure(): void
+	 */
+	public function getClosure(): \Closure
+	{
+		return fn () => $this->returnVoid();
+	}
+
+	public function returnVoid(): void
+	{
+
+	}
+}