InvalidKeyInArray: report float deprecation since PHP 8.1

Author: janedbal

src/Rules/Arrays/InvalidKeyInArrayDimFetchRule.php

@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
@@ -22,6 +23,7 @@ class InvalidKeyInArrayDimFetchRule implements Rule
 	public function __construct(
 		private RuleLevelHelper $ruleLevelHelper,
 		private bool $reportMaybes,
+		private PhpVersion $phpVersion,
 	)
 	{
 	}
@@ -54,15 +56,24 @@ public function processNode(Node $node, Scope $scope): array
 		}
 
 		$isSuperType = AllowedArrayKeysTypes::getType()->isSuperTypeOf($dimensionType);
-		if ($isSuperType->yes() || ($isSuperType->maybe() && !$this->reportMaybes)) {
-			return [];
+		$isOk = $isSuperType->yes() || ($isSuperType->maybe() && !$this->reportMaybes);
+		if (!$isOk) {
+			return [
+				RuleErrorBuilder::message(
+					sprintf('%s array key type %s.', $isSuperType->no() ? 'Invalid' : 'Possibly invalid', $dimensionType->describe(VerbosityLevel::typeOnly())),
+				)->identifier('offsetAccess.invalidOffset')->build(),
+			];
+		}
+
+		if ($this->phpVersion->getVersionId() >= 80_100 && !$dimensionType->isFloat()->no()) {
+			return [
+				RuleErrorBuilder::message(
+					'Using float as array key emits deprecation notice.',
+				)->identifier('array.invalidKey')->build(),
+			];
 		}
 
-		return [
-			RuleErrorBuilder::message(
-				sprintf('%s array key type %s.', $isSuperType->no() ? 'Invalid' : 'Possibly invalid', $dimensionType->describe(VerbosityLevel::typeOnly())),
-			)->identifier('offsetAccess.invalidOffset')->build(),
-		];
+		return [];
 	}
 
 }

src/Rules/Arrays/InvalidKeyInArrayItemRule.php

@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\MixedType;
@@ -16,7 +17,10 @@
 class InvalidKeyInArrayItemRule implements Rule
 {
 
-	public function __construct(private bool $reportMaybes)
+	public function __construct(
+		private bool $reportMaybes,
+		private PhpVersion $phpVersion,
+	)
 	{
 	}
 
@@ -47,6 +51,14 @@ public function processNode(Node $node, Scope $scope): array
 			];
 		}
 
+		if ($this->phpVersion->getVersionId() >= 80_100 && !$dimensionType->isFloat()->no()) {
+			return [
+				RuleErrorBuilder::message(
+					'Using float as array key emits deprecation notice.',
+				)->identifier('array.invalidKey')->build(),
+			];
+		}
+
 		return [];
 	}
 

tests/PHPStan/Rules/Arrays/InvalidKeyInArrayDimFetchRuleTest.php

@@ -2,9 +2,12 @@
 
 namespace PHPStan\Rules\Arrays;
 
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Testing\RuleTestCase;
+use function array_filter;
+use function array_values;
 use const PHP_VERSION_ID;
 
 /**
@@ -16,12 +19,12 @@ class InvalidKeyInArrayDimFetchRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false);
-		return new InvalidKeyInArrayDimFetchRule($ruleLevelHelper, true);
+		return new InvalidKeyInArrayDimFetchRule($ruleLevelHelper, true, new PhpVersion(PHP_VERSION_ID));
 	}
 
 	public function testInvalidKey(): void
 	{
-		$this->analyse([__DIR__ . '/data/invalid-key-array-dim-fetch.php'], [
+		$this->analyse([__DIR__ . '/data/invalid-key-array-dim-fetch.php'], array_values(array_filter([
 			[
 				'Invalid array key type DateTimeImmutable.',
 				7,
@@ -30,6 +33,12 @@ public function testInvalidKey(): void
 				'Invalid array key type array.',
 				8,
 			],
+			PHP_VERSION_ID >= 80_100
+				? [
+					'Using float as array key emits deprecation notice.',
+					10,
+				]
+				: null,
 			[
 				'Possibly invalid array key type stdClass|string.',
 				24,
@@ -58,7 +67,7 @@ public function testInvalidKey(): void
 				'Invalid array key type DateTimeImmutable.',
 				48,
 			],
-		]);
+		])));
 	}
 
 	public function testBug6315(): void

tests/PHPStan/Rules/Arrays/InvalidKeyInArrayItemRuleTest.php

@@ -2,8 +2,10 @@
 
 namespace PHPStan\Rules\Arrays;
 
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function array_filter;
 use const PHP_VERSION_ID;
 
 /**
@@ -14,12 +16,12 @@ class InvalidKeyInArrayItemRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new InvalidKeyInArrayItemRule(true);
+		return new InvalidKeyInArrayItemRule(true, new PhpVersion(PHP_VERSION_ID));
 	}
 
 	public function testInvalidKey(): void
 	{
-		$this->analyse([__DIR__ . '/data/invalid-key-array-item.php'], [
+		$this->analyse([__DIR__ . '/data/invalid-key-array-item.php'], array_filter([
 			[
 				'Invalid array key type DateTimeImmutable.',
 				13,
@@ -32,7 +34,13 @@ public function testInvalidKey(): void
 				'Possibly invalid array key type stdClass|string.',
 				15,
 			],
-		]);
+			PHP_VERSION_ID >= 80_100
+				? [
+					'Using float as array key emits deprecation notice.',
+					16,
+				]
+				: null,
+		]));
 	}
 
 	public function testInvalidKeyInList(): void

tests/PHPStan/Rules/Arrays/data/invalid-key-array-item.php

@@ -13,4 +13,5 @@
 	new \DateTimeImmutable() => 'aaa',
 	[] => 'bbb',
 	$stringOrObject => 'aaa',
+	1.0 => 'aaa',
 ];