Treat #[Pure(true)] in PhpStorm stubs as hasSideEffects => true

Author: zonuexe

Diff for: bin/functionMetadata_original.php

@@ -70,16 +70,13 @@
 	'chown' => ['hasSideEffects' => true],
 	'copy' => ['hasSideEffects' => true],
 	'count' => ['hasSideEffects' => false],
-	'connection_aborted' => ['hasSideEffects' => true],
-	'connection_status' => ['hasSideEffects' => true],
 	'error_log' => ['hasSideEffects' => true],
 	'fclose' => ['hasSideEffects' => true],
 	'fflush' => ['hasSideEffects' => true],
 	'fgetc' => ['hasSideEffects' => true],
 	'fgetcsv' => ['hasSideEffects' => true],
 	'fgets' => ['hasSideEffects' => true],
 	'fgetss' => ['hasSideEffects' => true],
-	'file_get_contents' => ['hasSideEffects' => true],
 	'file_put_contents' => ['hasSideEffects' => true],
 	'flock' => ['hasSideEffects' => true],
 	'fopen' => ['hasSideEffects' => true],

Diff for: bin/generate-function-metadata.php

@@ -25,16 +25,27 @@
 		/** @var string[] */
 		public array $functions = [];
 
+		/** @var list<string> */
+		public array $impureFunctions = [];
+
 		/** @var string[] */
 		public array $methods = [];
 
 		public function enterNode(Node $node)
 		{
 			if ($node instanceof Node\Stmt\Function_) {
+				assert(isset($node->namespacedName));
+				$functionName = $node->namespacedName->toLowerString();
 				foreach ($node->attrGroups as $attrGroup) {
 					foreach ($attrGroup->attrs as $attr) {
 						if ($attr->name->toString() === Pure::class) {
-							$this->functions[] = $node->namespacedName->toLowerString();
+							// PhpStorm stub's #[Pure(true)] mean sthe function has side effects but its return value is important.
+							// In PHPStan's criteria, these functions are simply considered as ['hasSideEffect' => true].
+							if (isset($attr->args[0]->value->name->name) && $attr->args[0]->value->name->name === 'true') {
+								$this->impureFunctions[] = $functionName;
+							} else {
+								$this->functions[] = $functionName;
+							}
 							break 2;
 						}
 					}
@@ -74,26 +85,24 @@ public function enterNode(Node $node)
 		);
 	}
 
+	/** @var array<string, array{hasSideEffects: bool}> $metadata */
 	$metadata = require __DIR__ . '/functionMetadata_original.php';
 	foreach ($visitor->functions as $functionName) {
 		if (array_key_exists($functionName, $metadata)) {
 			if ($metadata[$functionName]['hasSideEffects']) {
-				if (in_array($functionName, [
-					'mt_rand',
-					'rand',
-					'random_bytes',
-					'random_int',
-					'connection_aborted',
-					'connection_status',
-					'file_get_contents',
-				], true)) {
-					continue;
-				}
 				throw new ShouldNotHappenException($functionName);
 			}
 		}
 		$metadata[$functionName] = ['hasSideEffects' => false];
 	}
+	foreach ($visitor->impureFunctions as $functionName) {
+		if (array_key_exists($functionName, $metadata)) {
+			if ($metadata[$functionName]['hasSideEffects']) {
+				throw new ShouldNotHappenException($functionName);
+			}
+		}
+		$metadata[$functionName] = ['hasSideEffects' => true];
+	}
 
 	foreach ($visitor->methods as $methodName) {
 		if (array_key_exists($methodName, $metadata)) {