Fix readonly property assign with ArrayAccess offset

Author: herndlm

src/Rules/Properties/ReadOnlyByPhpDocPropertyAssignRule.php

@@ -2,15 +2,19 @@
 
 namespace PHPStan\Rules\Properties;
 
+use ArrayAccess;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\Expr\SetOffsetValueTypeExpr;
+use PHPStan\Node\Expr\UnsetOffsetExpr;
 use PHPStan\Node\PropertyAssignNode;
 use PHPStan\Reflection\ConstructorsHelper;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\TypeUtils;
 use function in_array;
 use function sprintf;
@@ -106,6 +110,14 @@ public function processNode(Node $node, Scope $scope): array
 				continue;
 			}
 
+			$assignedExpr = $node->getAssignedExpr();
+			if (
+				($assignedExpr instanceof SetOffsetValueTypeExpr || $assignedExpr instanceof UnsetOffsetExpr)
+				&& (new ObjectType(ArrayAccess::class))->isSuperTypeOf($scope->getType($assignedExpr->getVar()))->yes()
+			) {
+				continue;
+			}
+
 			$errors[] = RuleErrorBuilder::message(sprintf('@readonly property %s::$%s is assigned outside of the constructor.', $declaringClass->getDisplayName(), $propertyReflection->getName()))
 				->identifier('property.readOnlyByPhpDocAssignNotInConstructor')
 				->build();

src/Rules/Properties/ReadOnlyPropertyAssignRule.php

@@ -2,14 +2,18 @@
 
 namespace PHPStan\Rules\Properties;
 
+use ArrayAccess;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Node\Expr\SetOffsetValueTypeExpr;
+use PHPStan\Node\Expr\UnsetOffsetExpr;
 use PHPStan\Node\PropertyAssignNode;
 use PHPStan\Reflection\ConstructorsHelper;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\ObjectType;
 use PHPStan\Type\TypeUtils;
 use function in_array;
 use function sprintf;
@@ -89,6 +93,14 @@ public function processNode(Node $node, Scope $scope): array
 				continue;
 			}
 
+			$assignedExpr = $node->getAssignedExpr();
+			if (
+				($assignedExpr instanceof SetOffsetValueTypeExpr || $assignedExpr instanceof UnsetOffsetExpr)
+				&& (new ObjectType(ArrayAccess::class))->isSuperTypeOf($scope->getType($assignedExpr->getVar()))->yes()
+			) {
+				continue;
+			}
+
 			$errors[] = RuleErrorBuilder::message(sprintf('Readonly property %s::$%s is assigned outside of the constructor.', $declaringClass->getDisplayName(), $propertyReflection->getName()))
 				->identifier('property.readOnlyAssignNotInConstructor')
 				->build();

tests/PHPStan/Rules/Properties/ReadOnlyByPhpDocPropertyAssignRuleTest.php

@@ -125,6 +125,10 @@ public function testRule(): void
 				'@readonly property ReadonlyPropertyAssignPhpDoc\C::$c is assigned outside of the constructor.',
 				293,
 			],
+			[
+				'@readonly property ReadonlyPropertyAssignPhpDoc\ArrayAccessPropertyFetch::$storage is assigned outside of the constructor.',
+				311,
+			],
 		]);
 	}
 

tests/PHPStan/Rules/Properties/ReadOnlyPropertyAssignRuleTest.php

@@ -123,6 +123,11 @@ public function testRule(): void
 			];
 		}
 
+		$errors[] = [
+			'Readonly property ReadonlyPropertyAssign\ArrayAccessPropertyFetch::$storage is assigned outside of the constructor.',
+			212,
+		];
+
 		$this->analyse([__DIR__ . '/data/readonly-assign.php'], $errors);
 	}
 
@@ -168,4 +173,22 @@ public function testBug6773(): void
 		]);
 	}
 
+	public function testBug8929(): void
+	{
+		if (PHP_VERSION_ID < 80100) {
+			$this->markTestSkipped('Test requires PHP 8.1.');
+		}
+
+		$this->analyse([__DIR__ . '/data/bug-8929.php'], []);
+	}
+
+	public function testBug12537(): void
+	{
+		if (PHP_VERSION_ID < 80100) {
+			$this->markTestSkipped('Test requires PHP 8.1.');
+		}
+
+		$this->analyse([__DIR__ . '/data/bug-12537.php'], []);
+	}
+
 }

tests/PHPStan/Rules/Properties/data/bug-12537.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1); // lint >= 8.1
+
+namespace Bug12537;
+
+use WeakMap;
+
+class Metadata {
+	/**
+	 * @var WeakMap<stdClass, int>
+	 */
+	private readonly WeakMap $storage;
+
+	public function __construct() {
+		$this->storage = new WeakMap();
+	}
+
+	public function set(stdClass $class, int $value): void {
+		$this->storage[$class] = $value;
+	}
+
+	public function get(stdClass $class): mixed {
+		return $this->storage[$class] ?? null;
+	}
+}
+
+$class = new stdClass();
+$meta  = new Metadata();
+
+$meta->set($class, 123);
+
+var_dump($meta->get($class));

tests/PHPStan/Rules/Properties/data/bug-8929.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1); // lint >= 8.1
+
+namespace Bug8929;
+
+class Test
+{
+	/** @var \WeakMap<object, mixed> */
+	protected readonly \WeakMap $cache;
+
+	public function __construct()
+	{
+		$this->cache = new \WeakMap();
+	}
+
+	public function add(object $key, mixed $value): void
+	{
+		$this->cache[$key] = $value;
+	}
+}

tests/PHPStan/Rules/Properties/data/readonly-assign-phpdoc.php

@@ -294,3 +294,21 @@ public function mod()
 	}
 
 }
+
+class ArrayAccessPropertyFetch
+{
+
+	/** @readonly */
+	private \ArrayObject $storage;
+
+	public function __construct() {
+		$this->storage = new \ArrayObject();
+	}
+
+	public function set(\stdClass $class, int $value): void {
+		$this->storage[$class] = $value;
+		unset($this->storage[$class]);
+		$this->storage = new \WeakMap(); // invalid
+	}
+
+}

tests/PHPStan/Rules/Properties/data/readonly-assign.php

@@ -196,3 +196,20 @@ protected function setUp(): void
 	}
 
 }
+
+class ArrayAccessPropertyFetch
+{
+
+	private readonly \ArrayObject $storage;
+
+	public function __construct() {
+		$this->storage = new \ArrayObject();
+	}
+
+	public function set(\stdClass $class, int $value): void {
+		$this->storage[$class] = $value;
+		unset($this->storage[$class]);
+		$this->storage = new \WeakMap(); // invalid
+	}
+
+}