Allow specifying identifier to RuleError

Ultimately every error in PHPStan should have its own unique identifier so that its possible to group by error type and ignore errors based on identifier. phpstan/phpstan#1686 (comment) phpstan/phpstan#3065
spaze · Dec 12, 2021 · cbf3ff6 · cbf3ff6
1 parent 5ad6d00
commit cbf3ff6
Show file tree

Hide file tree

Showing 18 changed files with 84 additions and 25 deletions.
diff --git a/src/Calls/EchoCalls.php b/src/Calls/EchoCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Stmt\Echo_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -52,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Echo_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/EmptyCalls.php b/src/Calls/EmptyCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\Empty_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -52,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Empty_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/EvalCalls.php b/src/Calls/EvalCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\Eval_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -52,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Eval_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/ExitDieCalls.php b/src/Calls/ExitDieCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\Exit_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -52,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Exit_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/FunctionCalls.php b/src/Calls/FunctionCalls.php
@@ -8,6 +8,7 @@
 use PhpParser\Node\Name;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -53,7 +54,7 @@ public function getNodeType(): string
 	/**
 	 * @param FuncCall $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/MethodCalls.php b/src/Calls/MethodCalls.php
@@ -8,6 +8,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -55,7 +56,7 @@ public function getNodeType(): string
 	/**
 	 * @param MethodCall $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 * @throws ClassNotFoundException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/Calls/NewCalls.php b/src/Calls/NewCalls.php
@@ -9,6 +9,7 @@
 use PhpParser\Node\Name;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\ConstantScalarType;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
@@ -55,7 +56,7 @@ public function getNodeType(): string
 	/**
 	 * @param New_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/PrintCalls.php b/src/Calls/PrintCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\Print_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -52,7 +53,7 @@ public function getNodeType(): string
 	/**
 	 * @param Print_ $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/ShellExecCalls.php b/src/Calls/ShellExecCalls.php
@@ -7,6 +7,7 @@
 use PhpParser\Node\Expr\ShellExec;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -56,7 +57,7 @@ public function getNodeType(): string
 	/**
 	 * @param ShellExec $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{

diff --git a/src/Calls/StaticCalls.php b/src/Calls/StaticCalls.php
@@ -8,6 +8,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCall;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
@@ -55,7 +56,7 @@ public function getNodeType(): string
 	/**
 	 * @param StaticCall $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 * @throws ClassNotFoundException
 	 */
 	public function processNode(Node $node, Scope $scope): array

diff --git a/src/DisallowedCall.php b/src/DisallowedCall.php
@@ -32,6 +32,9 @@ class DisallowedCall
 	/** @var array<int, DisallowedCallParam> */
 	private $allowExceptParams;
 
+	/** @var string|null */
+	private $identifier;
+
 
 	/**
 	 * DisallowedCall constructor.
@@ -44,8 +47,9 @@ class DisallowedCall
 	 * @param array<int, DisallowedCallParam> $allowParamsAnywhere
 	 * @param array<int, DisallowedCallParam> $allowExceptParamsInAllowed
 	 * @param array<int, DisallowedCallParam> $allowExceptParams
+	 * @param string|null $identifier
 	 */
-	public function __construct(string $call, ?string $message, array $allowIn, array $allowInCalls, array $allowParamsInAllowed, array $allowParamsAnywhere, array $allowExceptParamsInAllowed, array $allowExceptParams)
+	public function __construct(string $call, ?string $message, array $allowIn, array $allowInCalls, array $allowParamsInAllowed, array $allowParamsAnywhere, array $allowExceptParamsInAllowed, array $allowExceptParams, ?string $identifier)
 	{
 		$this->call = $call;
 		$this->message = $message;
@@ -55,6 +59,7 @@ public function __construct(string $call, ?string $message, array $allowIn, arra
 		$this->allowParamsAnywhere = $allowParamsAnywhere;
 		$this->allowExceptParamsInAllowed = $allowExceptParamsInAllowed;
 		$this->allowExceptParams = $allowExceptParams;
+		$this->identifier = $identifier;
 	}
 
 
@@ -124,6 +129,15 @@ public function getAllowExceptParams(): array
 	}
 
 
+	/**
+	 * @return string|null
+	 */
+	public function getIdentifier(): ?string
+	{
+		return $this->identifier;
+	}
+
+
 	public function getKey(): string
 	{
 		// The key consists of "initial" config values that would be overwritten with more specific details in a custom config.

diff --git a/src/DisallowedConstant.php b/src/DisallowedConstant.php
@@ -15,19 +15,24 @@ class DisallowedConstant
 	/** @var string[] */
 	private $allowIn;
 
+	/** @var string|null */
+	private $identifier;
+
 
 	/**
 	 * DisallowedCall constructor.
 	 *
 	 * @param string $constant
 	 * @param string|null $message
 	 * @param string[] $allowIn
+	 * @param string|null $identifier
 	 */
-	public function __construct(string $constant, ?string $message, array $allowIn)
+	public function __construct(string $constant, ?string $message, array $allowIn, ?string $identifier)
 	{
 		$this->constant = ltrim($constant, '\\');
 		$this->message = $message;
 		$this->allowIn = $allowIn;
+		$this->identifier = $identifier;
 	}
 
 
@@ -51,4 +56,13 @@ public function getAllowIn(): array
 		return $this->allowIn;
 	}
 
+
+	/**
+	 * @return string|null
+	 */
+	public function getIdentifier(): string
+	{
+		return $this->identifier;
+	}
+
 }
diff --git a/src/DisallowedHelper.php b/src/DisallowedHelper.php
@@ -11,6 +11,8 @@
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ConstantScalarType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
@@ -111,19 +113,19 @@ private function getArgType(CallLike $node, Scope $scope, int $param): ?Type
 	 * @param string|null $displayName
 	 * @param DisallowedCall[] $disallowedCalls
 	 * @param string|null $message
-	 * @return string[]
+	 * @return RuleError[]
 	 */
 	public function getDisallowedMessage(?CallLike $node, Scope $scope, string $name, ?string $displayName, array $disallowedCalls, ?string $message = null): array
 	{
 		foreach ($disallowedCalls as $disallowedCall) {
 			if ($this->callMatches($disallowedCall, $name) && !$this->isAllowed($scope, $node, $disallowedCall)) {
 				return [
-					sprintf(
+					RuleErrorBuilder::message(sprintf(
 						$message ?? 'Calling %s is forbidden, %s%s',
 						($displayName && $displayName !== $name) ? "{$name}() (as {$displayName}())" : "{$name}()",
 						$disallowedCall->getMessage(),
 						$disallowedCall->getCall() !== $name ? " [{$name}() matches {$disallowedCall->getCall()}()]" : ''
-					),
+					))->identifier($disallowedCall->getIdentifier())
 				];
 			}
 		}
@@ -222,12 +224,12 @@ public function getDisallowedConstantMessage(string $constant, Scope $scope, ?st
 		foreach ($disallowedConstants as $disallowedConstant) {
 			if ($disallowedConstant->getConstant() === $constant && !$this->isAllowedPath($scope, $disallowedConstant)) {
 				return [
-					sprintf(
+					RuleErrorBuilder::message(sprintf(
 						'Using %s%s is forbidden, %s',
 						$disallowedConstant->getConstant(),
 						$displayName && $displayName !== $disallowedConstant->getConstant() ? ' (as ' . $displayName . ')' : '',
 						$disallowedConstant->getMessage()
-					),
+					))->identifier($disallowedConstant->getIdentifier()),
 				];
 			}
 		}

diff --git a/src/DisallowedNamespace.php b/src/DisallowedNamespace.php
@@ -15,17 +15,22 @@ class DisallowedNamespace
 	/** @var string[] */
 	private $allowIn;
 
+	/** @var string|null */
+	private $identifier;
+
 
 	/**
 	 * @param string $namespace
 	 * @param string|null $message
 	 * @param string[] $allowIn
+	 * @param string|null $identifier
 	 */
-	public function __construct(string $namespace, ?string $message, array $allowIn)
+	public function __construct(string $namespace, ?string $message, array $allowIn, ?string $identifier)
 	{
 		$this->namespace = ltrim($namespace, '\\');
 		$this->message = $message;
 		$this->allowIn = $allowIn;
+		$this->identifier = $identifier;
 	}
 
 
@@ -49,4 +54,13 @@ public function getAllowIn(): array
 		return $this->allowIn;
 	}
 
+
+	/**
+	 * @return string|null
+	 */
+	public function getIdentifier(): string
+	{
+		return $this->identifier;
+	}
+
 }
diff --git a/src/DisallowedNamespaceHelper.php b/src/DisallowedNamespaceHelper.php
@@ -4,6 +4,7 @@
 namespace Spaze\PHPStan\Rules\Disallowed;
 
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\RuleErrorBuilder;
 
 class DisallowedNamespaceHelper
 {
@@ -53,12 +54,12 @@ public function getDisallowedMessage(string $namespace, Scope $scope, array $dis
 			}
 
 			return [
-				sprintf(
+				RuleErrorBuilder::message(sprintf(
 					'Namespace %s is forbidden, %s%s',
 					$namespace,
 					$disallowedNamespace->getMessage(),
 					$disallowedNamespace->getNamespace() !== $namespace ? " [{$namespace} matches {$disallowedNamespace->getNamespace()}]" : ''
-				),
+				))->identifier($disallowedNamespace->getIdentifier()),
 			];
 		}
 

diff --git a/src/Usages/ClassConstantUsages.php b/src/Usages/ClassConstantUsages.php
@@ -8,6 +8,8 @@
 use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\TypeWithClassName;
@@ -54,7 +56,7 @@ public function getNodeType(): string
 	/**
 	 * @param ClassConstFetch $node
 	 * @param Scope $scope
-	 * @return string[]
+	 * @return RuleError[]
 	 * @throws ShouldNotHappenException
 	 */
 	public function processNode(Node $node, Scope $scope): array
@@ -78,11 +80,11 @@ public function processNode(Node $node, Scope $scope): array
 		} else {
 			if ($usedOnType->hasConstant($constant)->no()) {
 				return [
-					sprintf(
+					RuleErrorBuilder::message(sprintf(
 						'Cannot access constant %s on %s',
 						$constant,
 						$usedOnType->describe(VerbosityLevel::getRecommendedLevelByType($usedOnType))
-					),
+					)),
 				];
 			} else {
 				$className = $usedOnType->getConstant($constant)->getDeclaringClass()->getDisplayName();