Fix "array_rand() - offset might not exists"

Author: staabm

src/Analyser/TypeSpecifier.php

@@ -687,6 +687,32 @@ public function specifyTypesInCondition(
 			if ($context->null()) {
 				$specifiedTypes = $this->specifyTypesInCondition($scope->exitFirstLevelStatements(), $expr->expr, $context)->setRootExpr($expr);
 
+				// infer $arr[$key] after $arr[array_rand($arr)]
+				if (
+					$expr->expr instanceof FuncCall
+					&& $expr->expr->name instanceof Name
+					&& in_array($expr->expr->name->toLowerString(), ['array_rand'], true)
+					&& count($expr->expr->getArgs()) >= 1
+				) {
+					$arrayArg = $expr->expr->getArgs()[0]->value;
+					$numArg = $expr->expr->getArgs()[1]->value;
+					$one = new ConstantIntegerType(1);
+					$arrayType = $scope->getType($arrayArg);
+
+					if (
+						$arrayType->isArray()->yes()
+						&& $arrayType->isIterableAtLeastOnce()->yes()
+						&& ($numArg === null || $one->isSuperTypeOf($scope->getType($numArg))->yes())
+					) {
+						$dimFetch = new ArrayDimFetch($arrayArg, $expr->var);
+						$iterableValueType = $arrayType->getFirstIterableValueType();
+
+						return $specifiedTypes->unionWith(
+							$this->create($dimFetch, $iterableValueType, TypeSpecifierContext::createTrue(), $scope),
+						);
+					}
+				}
+
 				// infer $arr[$key] after $key = array_key_first/last($arr)
 				if (
 					$expr->expr instanceof FuncCall

src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php

@@ -14,6 +14,7 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\TrinaryLogic;
+use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
@@ -129,6 +130,30 @@ public function processNode(Node $node, Scope $scope): array
 			}
 		}
 
+		if (
+			$node->dim instanceof Node\Expr\FuncCall
+			&& $node->dim->name instanceof Node\Name
+			&& $node->dim->name->toLowerString() === 'array_rand'
+			&& count($node->dim->getArgs()) >= 1
+		) {
+			$arrayArg = $node->dim->getArgs()[0]->value;
+			$numArg = $node->dim->getArgs()[1]->value;
+
+			$one = new ConstantIntegerType(1);
+			$arrayType = $scope->getType($arrayArg);
+			if (
+				$arrayArg instanceof Node\Expr\Variable
+				&& $node->var instanceof Node\Expr\Variable
+				&& is_string($arrayArg->name)
+				&& $arrayArg->name === $node->var->name
+				&& $arrayType->isArray()->yes()
+				&& $arrayType->isIterableAtLeastOnce()->yes()
+				&& ($numArg === null || $one->isSuperTypeOf($scope->getType($numArg))->yes())
+			) {
+				return [];
+			}
+		}
+
 		if (
 			$node->dim instanceof Node\Expr\BinaryOp\Minus
 			&& $node->dim->left instanceof Node\Expr\FuncCall

tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php

@@ -942,6 +942,23 @@ public function testBug12593(): void
 		$this->analyse([__DIR__ . '/data/bug-12593.php'], []);
 	}
 
+	public function testBug12981(): void
+	{
+		$this->reportPossiblyNonexistentGeneralArrayOffset = true;
+
+		$this->analyse([__DIR__ . '/data/bug-12981.php'], [
+			[
+				'Offset array<int, int|string> might not exist on non-empty-array<bool|float|int|string>.',
+				31
+			],
+			[
+				'Offset array<int, int|string> might not exist on non-empty-array<bool|float|int|string>.',
+				33
+			],
+		]);
+	}
+
+
 	public function testBugObject(): void
 	{
 		$this->analyse([__DIR__ . '/data/bug-object.php'], [

tests/PHPStan/Rules/Arrays/data/bug-12981.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace Bug12981;
+
+use function PHPStan\dumpType;
+use function PHPStan\Testing\assertType;
+
+class HelloWorld
+{
+	/** @param non-empty-array<scalar> $arr */
+	public function sayHello(array $arr): void
+	{
+		echo $arr[array_rand($arr)];
+		$randIndex = array_rand($arr);
+		echo $arr[$randIndex];
+	}
+
+	/** @param non-empty-array<scalar> $arr */
+	public function sayHello1(array $arr): void
+	{
+		$num = 1;
+		echo $arr[array_rand($arr, $num)];
+		$randIndex = array_rand($arr, $num);
+		echo $arr[$randIndex];
+	}
+
+	/** @param non-empty-array<scalar> $arr */
+	public function sayHello2(array $arr): void
+	{
+		$num = 5;
+		echo $arr[array_rand($arr, $num)];
+		$randIndex = array_rand($arr, $num);
+		echo $arr[$randIndex];
+	}
+}