CleaningParser - clean up property hooks

Author: ondrejmirtes

src/Parser/CleaningVisitor.php

@@ -7,6 +7,7 @@
 use PhpParser\NodeVisitorAbstract;
 use PHPStan\Reflection\ParametersAcceptor;
 use function in_array;
+use function is_array;
 
 final class CleaningVisitor extends NodeVisitorAbstract
 {
@@ -21,30 +22,38 @@ public function __construct()
 	public function enterNode(Node $node): ?Node
 	{
 		if ($node instanceof Node\Stmt\Function_) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts, null);
 			return $node;
 		}
 
 		if ($node instanceof Node\Stmt\ClassMethod && $node->stmts !== null) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts, null);
 			return $node;
 		}
 
 		if ($node instanceof Node\Expr\Closure) {
-			$node->stmts = $this->keepVariadicsAndYields($node->stmts);
+			$node->stmts = $this->keepVariadicsAndYields($node->stmts, null);
 			return $node;
 		}
 
+		if ($node instanceof Node\PropertyHook && is_array($node->body)) {
+			$propertyName = $node->getAttribute(PropertyHookNameVisitor::ATTRIBUTE_NAME);
+			if ($propertyName !== null) {
+				$node->body = $this->keepVariadicsAndYields($node->body, $propertyName);
+				return $node;
+			}
+		}
+
 		return null;
 	}
 
 	/**
 	 * @param Node\Stmt[] $stmts
 	 * @return Node\Stmt[]
 	 */
-	private function keepVariadicsAndYields(array $stmts): array
+	private function keepVariadicsAndYields(array $stmts, ?string $hookedPropertyName): array
 	{
-		$results = $this->nodeFinder->find($stmts, static function (Node $node): bool {
+		$results = $this->nodeFinder->find($stmts, static function (Node $node) use ($hookedPropertyName): bool {
 			if ($node instanceof Node\Expr\YieldFrom || $node instanceof Node\Expr\Yield_) {
 				return true;
 			}
@@ -56,6 +65,18 @@ private function keepVariadicsAndYields(array $stmts): array
 				return true;
 			}
 
+			if ($hookedPropertyName !== null) {
+				if (
+					$node instanceof Node\Expr\PropertyFetch
+					&& $node->var instanceof Node\Expr\Variable
+					&& $node->var->name === 'this'
+					&& $node->name instanceof Node\Identifier
+					&& $node->name->toString() === $hookedPropertyName
+				) {
+					return true;
+				}
+			}
+
 			return false;
 		});
 		$newStmts = [];
@@ -65,6 +86,7 @@ private function keepVariadicsAndYields(array $stmts): array
 				|| $result instanceof Node\Expr\YieldFrom
 				|| $result instanceof Node\Expr\Closure
 				|| $result instanceof Node\Expr\ArrowFunction
+				|| $result instanceof Node\Expr\PropertyFetch
 			) {
 				$newStmts[] = new Node\Stmt\Expression($result);
 				continue;

tests/PHPStan/Parser/CleaningParserTest.php

@@ -4,7 +4,7 @@
 
 use PhpParser\Lexer\Emulative;
 use PhpParser\NodeVisitor\NameResolver;
-use PhpParser\Parser\Php7;
+use PhpParser\Parser\Php8;
 use PHPStan\File\FileReader;
 use PHPStan\Node\Printer\Printer;
 use PHPStan\Php\PhpVersion;
@@ -52,6 +52,11 @@ public function dataParse(): iterable
 				__DIR__ . '/data/cleaning-php-version-after-74.php',
 				70400,
 			],
+			[
+				__DIR__ . '/data/cleaning-property-hooks-before.php',
+				__DIR__ . '/data/cleaning-property-hooks-after.php',
+				80400,
+			],
 		];
 	}
 
@@ -66,7 +71,7 @@ public function testParse(
 	{
 		$parser = new CleaningParser(
 			new SimpleParser(
-				new Php7(new Emulative()),
+				new Php8(new Emulative()),
 				new NameResolver(),
 				new VariadicMethodsVisitor(),
 				new VariadicFunctionsVisitor(),

tests/PHPStan/Parser/data/cleaning-property-hooks-after.php

@@ -0,0 +1,21 @@
+<?php
+namespace CleaningPropertyHooks;
+
+class Foo
+{
+    public int $i {
+        get {
+            $this->i;
+        }
+    }
+}
+class FooParam
+{
+    public function __construct(public int $i {
+        get {
+            $this->i;
+        }
+    })
+    {
+    }
+}

tests/PHPStan/Parser/data/cleaning-property-hooks-before.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace CleaningPropertyHooks;
+
+class Foo
+{
+
+	public int $i {
+		get {
+			echo 'irrelevant';
+
+			// other property, clean up
+			echo $this->j;
+
+			// backed property, leave this here
+			return $this->i;
+		}
+	}
+
+}
+
+class FooParam
+{
+
+	public function __construct(
+		public int $i {
+			get {
+				echo 'irrelevant';
+
+				// other property, clean up
+				echo $this->j;
+
+				// backed property, leave this here
+				return $this->i;
+			}
+		}
+	)
+	{
+
+	}
+
+}