Fixed assigning to arrays with optional keys

ondrejmirtes · ondrejmirtes · commit 55c8a14f9d7f · 2020-05-10T22:07:19.000+02:00
diff --git a/src/Type/Constant/ConstantArrayTypeBuilder.php b/src/Type/Constant/ConstantArrayTypeBuilder.php
@@ -5,6 +5,7 @@
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
+use function array_filter;
 
 class ConstantArrayTypeBuilder
 {
@@ -74,6 +75,9 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $opt
 			foreach ($this->keyTypes as $i => $keyType) {
 				if ($keyType->getValue() === $offsetType->getValue()) {
 					$this->valueTypes[$i] = $valueType;
+					$this->optionalKeys = array_values(array_filter($this->optionalKeys, static function (int $index) use ($i): bool {
+						return $index !== $i;
+					}));
 					return;
 				}
 			}
diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -9894,6 +9894,14 @@ public function dataAssignNestedArray(): array
 		return $this->gatherAssertTypes(__DIR__ . '/data/assign-nested-arrays.php');
 	}
 
+	public function dataBug3276(): array
+	{
+		if (PHP_VERSION_ID < 70400) {
+			$this->markTestSkipped('Test requires PHP 7.4.');
+		}
+		return $this->gatherAssertTypes(__DIR__ . '/data/bug-3276.php');
+	}
+
 	/**
 	 * @dataProvider dataBug2574
 	 * @dataProvider dataBug2577
@@ -9941,6 +9949,7 @@ public function dataAssignNestedArray(): array
 	 * @dataProvider dataBug3266
 	 * @dataProvider dataBug3269
 	 * @dataProvider dataAssignNestedArray
+	 * @dataProvider dataBug3276
 	 * @param ConstantStringType $expectedType
 	 * @param Type $actualType
 	 */
diff --git a/tests/PHPStan/Analyser/data/bug-3276.php b/tests/PHPStan/Analyser/data/bug-3276.php
@@ -0,0 +1,28 @@
+<?php // lint >= 7.4
+
+namespace Bug3276;
+
+use function PHPStan\Analyser\assertType;
+
+class Foo
+{
+
+	/**
+	 * @param array{name?:string} $settings
+	 */
+	public function doFoo(array $settings): void
+	{
+		$settings['name'] ??= 'unknown';
+		assertType('array(\'name\' => string)', $settings);
+	}
+
+	/**
+	 * @param array{name?:string} $settings
+	 */
+	public function doBar(array $settings): void
+	{
+		$settings['name'] = 'unknown';
+		assertType('array(\'name\' => \'unknown\')', $settings);
+	}
+
+}

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use PHPStan\Type\ArrayType;`
`6`	`6`	`use PHPStan\Type\Type;`
`7`	`7`	`use PHPStan\Type\TypeCombinator;`
	`8`	`+use function array_filter;`
`8`	`9`
`9`	`10`	`class ConstantArrayTypeBuilder`
`10`	`11`	`{`
`@@ -74,6 +75,9 @@ public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $opt`
`74`	`75`	`foreach ($this->keyTypes as $i => $keyType) {`
`75`	`76`	`if ($keyType->getValue() === $offsetType->getValue()) {`
`76`	`77`	`$this->valueTypes[$i] = $valueType;`
	`78`	`+ $this->optionalKeys = array_values(array_filter($this->optionalKeys, static function (int $index) use ($i): bool {`
	`79`	`+ return $index !== $i;`
	`80`	`+ }));`
`77`	`81`	`return;`
`78`	`82`	`}`
`79`	`83`	`}`