Add pureUnlessCallableIsImpureParameters to functionMetadata

Author: zonuexe

bin/generate-function-metadata.php

@@ -77,7 +77,7 @@ public function enterNode(Node $node)
 	$metadata = require __DIR__ . '/functionMetadata_original.php';
 	foreach ($visitor->functions as $functionName) {
 		if (array_key_exists($functionName, $metadata)) {
-			if ($metadata[$functionName]['hasSideEffects']) {
+			if (isset($metadata[$functionName]['hasSideEffects']) && $metadata[$functionName]['hasSideEffects']) {
 				if (in_array($functionName, [
 					'mt_rand',
 					'rand',
@@ -91,6 +91,14 @@ public function enterNode(Node $node)
 				}
 				throw new ShouldNotHappenException($functionName);
 			}
+
+			if (isset($metadata[$functionName]['pureUnlessCallableIsImpureParameters'])) {
+				$metadata[$functionName] = [
+					'pureUnlessCallableIsImpureParameters' => $metadata[$functionName]['pureUnlessCallableIsImpureParameters'],
+				];
+
+				continue;
+			}
 		}
 		$metadata[$functionName] = ['hasSideEffects' => false];
 	}
@@ -128,12 +136,29 @@ public function enterNode(Node $node)
 ];
 php;
 	$content = '';
+	$escape = fn (mixed $value): string => var_export($value, true);
+	$encodeHasSideEffects = fn (array $meta) => [$escape('hasSideEffects'), $escape($meta['hasSideEffects'])];
+	$encodePureUnlessCallableIsImpureParameters = fn (array $meta) => [
+		$escape('pureUnlessCallableIsImpureParameters'),
+		sprintf(
+			'[%s]',
+			implode(' ,', array_map(
+				fn ($key, $param) => sprintf('%s => %s', $escape($key), $escape($param)),
+				array_keys($meta['pureUnlessCallableIsImpureParameters']),
+				$meta['pureUnlessCallableIsImpureParameters']),
+			),
+		),
+	];
+
 	foreach ($metadata as $name => $meta) {
 		$content .= sprintf(
 			"\t%s => [%s => %s],\n",
 			var_export($name, true),
-			var_export('hasSideEffects', true),
-			var_export($meta['hasSideEffects'], true),
+			...match(true) {
+				isset($meta['hasSideEffects']) => $encodeHasSideEffects($meta),
+				isset($meta['pureUnlessCallableIsImpureParameters']) => $encodePureUnlessCallableIsImpureParameters($meta),
+				default => throw new ShouldNotHappenException($escape($meta)),
+			},
 		);
 	}
 

src/Reflection/SignatureMap/NativeFunctionReflectionProvider.php

@@ -88,13 +88,24 @@ public function findFunctionReflection(string $functionName): ?NativeFunctionRef
 			$acceptsNamedArguments = $phpDoc->acceptsNamedArguments();
 		}
 
+		$pureUnlessCallableIsImpureParameters = [];
+		if ($this->signatureMapProvider->hasFunctionMetadata($lowerCasedFunctionName)) {
+			$functionMetadata = $this->signatureMapProvider->getFunctionMetadata($lowerCasedFunctionName);
+			if (isset($functionMetadata['pureUnlessCallableIsImpureParameters'])) {
+				$pureUnlessCallableIsImpureParameters = $functionMetadata['pureUnlessCallableIsImpureParameters'];
+			}
+		} else {
+			$functionMetadata = null;
+		}
+
 		$variantsByType = ['positional' => []];
 		foreach ($functionSignaturesResult as $signatureType => $functionSignatures) {
 			foreach ($functionSignatures ?? [] as $functionSignature) {
 				$variantsByType[$signatureType][] = new FunctionVariantWithPhpDocs(
 					TemplateTypeMap::createEmpty(),
 					null,
-					array_map(static function (ParameterSignature $parameterSignature) use ($phpDoc): NativeParameterWithPhpDocsReflection {
+					array_map(static function (ParameterSignature $parameterSignature) use ($phpDoc, $pureUnlessCallableIsImpureParameters): NativeParameterWithPhpDocsReflection {
+						$name = $parameterSignature->getName();
 						$type = $parameterSignature->getType();
 
 						$phpDocType = null;
@@ -113,7 +124,7 @@ public function findFunctionReflection(string $functionName): ?NativeFunctionRef
 						}
 
 						return new NativeParameterWithPhpDocsReflection(
-							$parameterSignature->getName(),
+							$name,
 							$parameterSignature->isOptional(),
 							TypehintHelper::decideType($type, $phpDocType),
 							$phpDocType ?? new MixedType(),
@@ -124,6 +135,7 @@ public function findFunctionReflection(string $functionName): ?NativeFunctionRef
 							$phpDoc !== null ? NativeFunctionReflectionProvider::getParamOutTypeFromPhpDoc($parameterSignature->getName(), $phpDoc) : null,
 							$immediatelyInvokedCallable,
 							$closureThisType,
+							isset($pureUnlessCallableIsImpureParameters[$name]) && $pureUnlessCallableIsImpureParameters[$name],
 						);
 					}, $functionSignature->getParameters()),
 					$functionSignature->isVariadic(),
@@ -134,8 +146,8 @@ public function findFunctionReflection(string $functionName): ?NativeFunctionRef
 			}
 		}
 
-		if ($this->signatureMapProvider->hasFunctionMetadata($lowerCasedFunctionName)) {
-			$hasSideEffects = TrinaryLogic::createFromBoolean($this->signatureMapProvider->getFunctionMetadata($lowerCasedFunctionName)['hasSideEffects']);
+		if (isset($functionMetadata['hasSideEffects'])) {
+			$hasSideEffects = TrinaryLogic::createFromBoolean($functionMetadata['hasSideEffects']);
 		} else {
 			$hasSideEffects = TrinaryLogic::createMaybe();
 		}

src/Reflection/SignatureMap/SignatureMapProvider.php

@@ -24,12 +24,12 @@ public function hasMethodMetadata(string $className, string $methodName): bool;
 	public function hasFunctionMetadata(string $name): bool;
 
 	/**
-	 * @return array{hasSideEffects: bool}
+	 * @return array{hasSideEffects?: bool, pureUnlessCallableIsImpureParameters?: array<string, bool>}
 	 */
 	public function getMethodMetadata(string $className, string $methodName): array;
 
 	/**
-	 * @return array{hasSideEffects: bool}
+	 * @return array{hasSideEffects?: bool, pureUnlessCallableIsImpureParameters?: array<string, bool>}
 	 */
 	public function getFunctionMetadata(string $functionName): array;
 

tests/PHPStan/Reflection/SignatureMap/FunctionMetadataTest.php

@@ -17,7 +17,8 @@ public function testSchema(): void
 		$processor = new Processor();
 		$processor->process(Expect::arrayOf(
 			Expect::structure([
-				'hasSideEffects' => Expect::bool()->required(),
+				'hasSideEffects' => Expect::bool(),
+				'pureUnlessCallableIsImpureParameters' => Expect::arrayOf(Expect::string(), Expect::bool()),
 			])->required(),
 		)->required(), $data);
 	}