Array with int|string in prevent mode should accept any string

Author: ondrejmirtes

src/PhpDoc/TypeNodeResolver.php

@@ -988,17 +988,19 @@ static function (string $variance): TemplateTypeVariance {
 	private function transformUnsafeArrayKey(Type $keyType): Type
 	{
 		if ($this->reportUnsafeArrayStringKeyCasting === ReportUnsafeArrayStringKeyCastingToggle::PREVENT) {
-			$keyType = TypeTraverser::map($keyType, static function (Type $type, callable $traverse) {
-				if ($type instanceof UnionType || $type instanceof IntersectionType) {
-					return $traverse($type);
-				}
+			if (!$keyType->isSuperTypeOf(new IntegerType())->yes()) {
+				$keyType = TypeTraverser::map($keyType, static function (Type $type, callable $traverse) {
+					if ($type instanceof UnionType || $type instanceof IntersectionType) {
+						return $traverse($type);
+					}
 
-				if ($type instanceof StringType) {
-					return TypeCombinator::intersect($type, new AccessoryDecimalIntegerStringType(inverse: true));
-				}
+					if ($type instanceof StringType) {
+						return TypeCombinator::intersect($type, new AccessoryDecimalIntegerStringType(inverse: true));
+					}
 
-				return $type;
-			});
+					return $type;
+				});
+			}
 		}
 
 		return TypeCombinator::intersect($keyType->toArrayKey(), new UnionType([

src/Type/UnionType.php

@@ -7,6 +7,7 @@
 use DateTimeInterface;
 use Error;
 use Exception;
+use PHPStan\DependencyInjection\ReportUnsafeArrayStringKeyCastingToggle;
 use PHPStan\Php\PhpVersion;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
@@ -1186,7 +1187,18 @@ public function toArray(): Type
 
 	public function toArrayKey(): Type
 	{
-		return $this->unionTypes(static fn (Type $type): Type => $type->toArrayKey());
+		$level = ReportUnsafeArrayStringKeyCastingToggle::getLevel();
+		if ($level !== ReportUnsafeArrayStringKeyCastingToggle::PREVENT || $this->isInteger()->no()) {
+			return $this->unionTypes(static fn (Type $type): Type => $type->toArrayKey());
+		}
+
+		return $this->unionTypes(static function (Type $type): Type {
+			if ($type instanceof StringType) { // @phpstan-ignore phpstanApi.instanceofType
+				return $type;
+			}
+
+			return $type->toArrayKey();
+		});
 	}
 
 	public function toCoercedArgumentType(bool $strictTypes): Type

tests/PHPStan/Analyser/ReportUnsafeArrayStringKeyCastingPreventTypeAcceptanceTest.php

@@ -3,19 +3,25 @@
 namespace PHPStan\Analyser;
 
 use PHPStan\Rules\Methods\CallMethodsRule;
+use PHPStan\Rules\Methods\ReturnTypeRule;
 use PHPStan\Rules\Rule;
+use PHPStan\Testing\CompositeRule;
 use PHPStan\Testing\RuleTestCase;
 use function array_merge;
 
 /**
- * @extends RuleTestCase<CallMethodsRule>
+ * @extends RuleTestCase<CompositeRule>
  */
 class ReportUnsafeArrayStringKeyCastingPreventTypeAcceptanceTest extends RuleTestCase
 {
 
 	public function getRule(): Rule
 	{
-		return self::getContainer()->getByType(CallMethodsRule::class);
+		// @phpstan-ignore argument.type
+		return new CompositeRule([
+			self::getContainer()->getByType(CallMethodsRule::class),
+			self::getContainer()->getByType(ReturnTypeRule::class),
+		]);
 	}
 
 	public function testRule(): void

tests/PHPStan/Analyser/data/report-unsafe-array-string-key-casting-accepts.php

@@ -86,3 +86,22 @@ public function doTest(string $s): void
 	}
 
 }
+
+class ReleaseNoteParser
+{
+
+	/**
+	 * @param non-empty-string $s
+	 * @return array<int|string, array{section: string, release: string}>
+	 */
+	public function buildCommitMap(string $s): array
+	{
+		/** @var array<string, array{section: string, release: string}> $map */
+		$map = [];
+
+		$map[$s] = ['section' => 'a', 'release' => 'b'];
+
+		return $map;
+	}
+
+}

tests/PHPStan/Analyser/data/report-unsafe-array-string-key-casting-prevent.php

@@ -25,7 +25,7 @@ public function doBar(array $a): void
 	{
 		assertType('array<ReportUnsafeArrayStringKeyCastingPrevent\Foo>', $a);
 		foreach ($a as $k => $v) {
-			assertType('(int|non-decimal-int-string)', $k);
+			assertType('(int|string)', $k);
 		}
 	}
 
@@ -34,9 +34,9 @@ public function doBar(array $a): void
 	 */
 	public function doBaz(array $a): void
 	{
-		assertType('array<int|non-decimal-int-string, ReportUnsafeArrayStringKeyCastingPrevent\Foo>', $a);
+		assertType('array<int|string, ReportUnsafeArrayStringKeyCastingPrevent\Foo>', $a);
 		foreach ($a as $k => $v) {
-			assertType('int|non-decimal-int-string', $k);
+			assertType('int|string', $k);
 		}
 	}
 
@@ -111,7 +111,7 @@ public function doBar(array $a): void
 	{
 		assertType('array{a: int, ...<ReportUnsafeArrayStringKeyCastingPrevent\Unsealed>}', $a);
 		foreach ($a as $k => $v) {
-			assertType('(int|non-decimal-int-string)', $k);
+			assertType('(int|string)', $k);
 		}
 	}
 
@@ -120,9 +120,9 @@ public function doBar(array $a): void
 	 */
 	public function doBaz(array $a): void
 	{
-		assertType('array{a: int, ...<int|non-decimal-int-string, ReportUnsafeArrayStringKeyCastingPrevent\Unsealed>}', $a);
+		assertType('array{a: int, ...<int|string, ReportUnsafeArrayStringKeyCastingPrevent\Unsealed>}', $a);
 		foreach ($a as $k => $v) {
-			assertType('int|non-decimal-int-string', $k);
+			assertType('int|string', $k);
 		}
 	}