Throw a descriptive exception when typeString cannot be parsed

spaze · spaze · commit d954504e4647 · 2026-04-24T18:18:49.000+02:00
A wildcard or other invalid value in `typeString` caused PHPStan to crash at DI container initialization with a raw `ParserException` and no indication of which config entry was responsible. The new `InvalidTypeStringInConfigException` names the offending `typeString` value, includes the parser's own reason, and appends a wildcard-specific hint when the value contains `*`. Both it and the existing `UnsupportedParamTypeInConfigException` extend the new abstract `InvalidConfigException`, which all factories catch and wrap in `ShouldNotHappenException`.
diff --git a/src/Allowed/AllowedConfigFactory.php b/src/Allowed/AllowedConfigFactory.php
@@ -4,11 +4,14 @@
 namespace Spaze\PHPStan\Rules\Disallowed\Allowed;
 
 use PHPStan\PhpDoc\TypeStringResolver;
+use PHPStan\PhpDocParser\Parser\ParserException;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\NullType;
 use PHPStan\Type\VerbosityLevel;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidTypeStringInConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\Params\ParamValue;
@@ -42,7 +45,7 @@ public function __construct(
 	 * @param array $allowed
 	 * @phpstan-param AllowDirectivesConfig $allowed
 	 * @return AllowedConfig
-	 * @throws UnsupportedParamTypeInConfigException
+	 * @throws InvalidConfigException
 	 */
 	public function getConfig(array $allowed): AllowedConfig
 	{
@@ -147,7 +150,7 @@ public function getConfig(array $allowed): AllowedConfig
 	 * @param int|string $key
 	 * @param int|bool|string|null|array{position:int, value?:int|bool|string, typeString?:string, name?:string} $value
 	 * @return T
-	 * @throws UnsupportedParamTypeInConfigException
+	 * @throws InvalidConfigException
 	 */
 	private function paramFactory(string $class, $key, $value): ParamValue
 	{
@@ -180,7 +183,12 @@ private function paramFactory(string $class, $key, $value): ParamValue
 		}
 
 		if ($typeString) {
-			$type = $this->typeStringResolver->resolve($typeString);
+			try {
+				$type = $this->typeStringResolver->resolve($typeString);
+			} catch (ParserException $e) {
+				$hint = str_contains($typeString, '*') ? ' Wildcards are not supported in typeString.' : '';
+				throw new InvalidTypeStringInConfigException($typeString, $e->getMessage() . $hint, $e);
+			}
 		} elseif (is_int($paramValue)) {
 			$type = new ConstantIntegerType($paramValue);
 		} elseif (is_bool($paramValue)) {
diff --git a/src/DisallowedCallFactory.php b/src/DisallowedCallFactory.php
@@ -5,7 +5,7 @@
 
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;
-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
@@ -61,7 +61,7 @@ public function createFromConfig(array $config): array
 					);
 					$disallowedCalls[$disallowedCall->getKey()] = $disallowedCall;
 				}
-			} catch (UnsupportedParamTypeInConfigException $e) {
+			} catch (InvalidConfigException $e) {
 				throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($calls), $e->getMessage()));
 			}
 		}
diff --git a/src/DisallowedConstantFactory.php b/src/DisallowedConstantFactory.php
@@ -5,7 +5,7 @@
 
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;
-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
@@ -54,7 +54,7 @@ public function createFromConfig(array $config): array
 					);
 					$disallowedConstants[$disallowedConstant->getConstant()] = $disallowedConstant;
 				}
-			} catch (UnsupportedParamTypeInConfigException $e) {
+			} catch (InvalidConfigException $e) {
 				throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($constants), $e->getMessage()));
 			}
 		}
diff --git a/src/DisallowedKeywordFactory.php b/src/DisallowedKeywordFactory.php
@@ -5,7 +5,7 @@
 
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;
-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
 
 class DisallowedKeywordFactory
@@ -84,7 +84,7 @@ public function getDisallowedKeywords(array $config): array
 					);
 					$disallowedKeywords[$disallowedKeyword->getKeyword()] = $disallowedKeyword;
 				}
-			} catch (UnsupportedParamTypeInConfigException $e) {
+			} catch (InvalidConfigException $e) {
 				throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($keywords), $e->getMessage()));
 			}
 		}
diff --git a/src/DisallowedNamespaceFactory.php b/src/DisallowedNamespaceFactory.php
@@ -5,7 +5,7 @@
 
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;
-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 
@@ -64,7 +64,7 @@ public function createFromConfig(array $config): array
 					);
 					$disallowedNamespaces[$disallowedNamespace->getNamespace()] = $disallowedNamespace;
 				}
-			} catch (UnsupportedParamTypeInConfigException $e) {
+			} catch (InvalidConfigException $e) {
 				throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($namespaces), $e->getMessage()));
 			}
 		}
diff --git a/src/DisallowedSuperglobalFactory.php b/src/DisallowedSuperglobalFactory.php
@@ -5,7 +5,7 @@
 
 use PHPStan\ShouldNotHappenException;
 use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;
-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;
+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;
 use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;
 
 class DisallowedSuperglobalFactory
@@ -67,7 +67,7 @@ public function getDisallowedVariables(array $config): array
 					);
 					$disallowedSuperglobals[$disallowedSuperglobal->getVariable()] = $disallowedSuperglobal;
 				}
-			} catch (UnsupportedParamTypeInConfigException $e) {
+			} catch (InvalidConfigException $e) {
 				throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($superglobals), $e->getMessage()));
 			}
 		}
diff --git a/src/Exceptions/InvalidConfigException.php b/src/Exceptions/InvalidConfigException.php
@@ -0,0 +1,11 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed\Exceptions;
+
+use Exception;
+
+abstract class InvalidConfigException extends Exception
+{
+
+}
diff --git a/src/Exceptions/InvalidTypeStringInConfigException.php b/src/Exceptions/InvalidTypeStringInConfigException.php
@@ -0,0 +1,16 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed\Exceptions;
+
+use Throwable;
+
+class InvalidTypeStringInConfigException extends InvalidConfigException
+{
+
+	public function __construct(string $typeString, string $reason, ?Throwable $previous = null)
+	{
+		parent::__construct(sprintf("Invalid typeString '%s': %s", $typeString, $reason), 0, $previous);
+	}
+
+}
diff --git a/src/Exceptions/UnsupportedParamTypeInConfigException.php b/src/Exceptions/UnsupportedParamTypeInConfigException.php
@@ -3,10 +3,9 @@
 
 namespace Spaze\PHPStan\Rules\Disallowed\Exceptions;
 
-use Exception;
 use Throwable;
 
-class UnsupportedParamTypeInConfigException extends Exception
+class UnsupportedParamTypeInConfigException extends InvalidConfigException
 {
 
 	public function __construct(?int $position, ?string $name, string $type, int $code = 0, ?Throwable $previous = null)
diff --git a/tests/Calls/FunctionCallsInvalidTypeStringConfigTest.php b/tests/Calls/FunctionCallsInvalidTypeStringConfigTest.php
@@ -0,0 +1,76 @@
+<?php
+declare(strict_types = 1);
+
+namespace Spaze\PHPStan\Rules\Disallowed\Calls;
+
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Testing\PHPStanTestCase;
+use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
+use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallableParameterRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedFunctionRuleErrors;
+
+class FunctionCallsInvalidTypeStringConfigTest extends PHPStanTestCase
+{
+
+	/**
+	 * @throws ShouldNotHappenException
+	 */
+	public function testInvalidTypeStringWithWildcard(): void
+	{
+		$this->expectException(ShouldNotHappenException::class);
+		$this->expectExceptionMessage('Wildcards are not supported in typeString.');
+		$container = self::getContainer();
+		new FunctionCalls(
+			$container->getByType(DisallowedFunctionRuleErrors::class),
+			$container->getByType(DisallowedCallableParameterRuleErrors::class),
+			$container->getByType(DisallowedCallFactory::class),
+			[
+				[
+					'function' => 'foo()',
+					'disallowParamsInAllowed' => [
+						1 => [
+							'position' => 1,
+							'typeString' => 'Foo\*',
+						],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @throws ShouldNotHappenException
+	 */
+	public function testInvalidTypeStringWithoutWildcard(): void
+	{
+		$this->expectException(ShouldNotHappenException::class);
+		$this->expectExceptionMessage("Invalid typeString 'array<int':");
+		$container = self::getContainer();
+		new FunctionCalls(
+			$container->getByType(DisallowedFunctionRuleErrors::class),
+			$container->getByType(DisallowedCallableParameterRuleErrors::class),
+			$container->getByType(DisallowedCallFactory::class),
+			[
+				[
+					'function' => 'foo()',
+					'disallowParamsInAllowed' => [
+						1 => [
+							'position' => 1,
+							'typeString' => 'array<int',
+						],
+					],
+				],
+			]
+		);
+	}
+
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../extension.neon',
+		];
+	}
+
+}

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`use PHPStan\ShouldNotHappenException;`
`7`	`7`	`use Spaze\PHPStan\Rules\Disallowed\Allowed\AllowedConfigFactory;`
`8`		`-use Spaze\PHPStan\Rules\Disallowed\Exceptions\UnsupportedParamTypeInConfigException;`
	`8`	`+use Spaze\PHPStan\Rules\Disallowed\Exceptions\InvalidConfigException;`
`9`	`9`	`use Spaze\PHPStan\Rules\Disallowed\Formatter\Formatter;`
`10`	`10`	`use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;`
`11`	`11`
`@@ -61,7 +61,7 @@ public function createFromConfig(array $config): array`
`61`	`61`	`);`
`62`	`62`	`$disallowedCalls[$disallowedCall->getKey()] = $disallowedCall;`
`63`	`63`	`}`
`64`		`- } catch (UnsupportedParamTypeInConfigException $e) {`
	`64`	`+ } catch (InvalidConfigException $e) {`
`65`	`65`	`throw new ShouldNotHappenException(sprintf('%s: %s', $this->formatter->formatIdentifier($calls), $e->getMessage()));`
`66`	`66`	`}`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,9 @@`
`3`	`3`
`4`	`4`	`namespace Spaze\PHPStan\Rules\Disallowed\Exceptions;`
`5`	`5`
`6`		`-use Exception;`
`7`	`6`	`use Throwable;`
`8`	`7`
`9`		`-class UnsupportedParamTypeInConfigException extends Exception`
	`8`	`+class UnsupportedParamTypeInConfigException extends InvalidConfigException`
`10`	`9`	`{`
`11`	`10`
`12`	`11`	`public function __construct(?int $position, ?string $name, string $type, int $code = 0, ?Throwable $previous = null)`