ThrowsVoidPropertyHookWithExplicitThrowPointRule - level 3

Author: ondrejmirtes

conf/config.level3.neon

@@ -69,6 +69,14 @@ services:
 		tags:
 			- phpstan.rules.rule
 
+	-
+		class: PHPStan\Rules\Exceptions\ThrowsVoidPropertyHookWithExplicitThrowPointRule
+		arguments:
+			exceptionTypeResolver: @exceptionTypeResolver
+			missingCheckedExceptionInThrows: %exceptions.check.missingCheckedExceptionInThrows%
+		tags:
+			- phpstan.rules.rule
+
 	-
 		class: PHPStan\Rules\Generators\YieldFromTypeRule
 		arguments:

src/Rules/Exceptions/ThrowsVoidPropertyHookWithExplicitThrowPointRule.php

@@ -0,0 +1,79 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Exceptions;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\PropertyHookReturnStatementsNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\TypeUtils;
+use PHPStan\Type\VerbosityLevel;
+use function sprintf;
+use function ucfirst;
+
+/**
+ * @implements Rule<PropertyHookReturnStatementsNode>
+ */
+final class ThrowsVoidPropertyHookWithExplicitThrowPointRule implements Rule
+{
+
+	public function __construct(
+		private ExceptionTypeResolver $exceptionTypeResolver,
+		private bool $missingCheckedExceptionInThrows,
+	)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return PropertyHookReturnStatementsNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$statementResult = $node->getStatementResult();
+		$hookReflection = $node->getHookReflection();
+
+		if ($hookReflection->getThrowType() === null || !$hookReflection->getThrowType()->isVoid()->yes()) {
+			return [];
+		}
+
+		if ($hookReflection->getPropertyHookName() === null) {
+			throw new ShouldNotHappenException();
+		}
+
+		$errors = [];
+		foreach ($statementResult->getThrowPoints() as $throwPoint) {
+			if (!$throwPoint->isExplicit()) {
+				continue;
+			}
+
+			foreach (TypeUtils::flattenTypes($throwPoint->getType()) as $throwPointType) {
+				$isCheckedException = TrinaryLogic::createFromBoolean($this->missingCheckedExceptionInThrows)->lazyAnd(
+					$throwPointType->getObjectClassNames(),
+					fn (string $objectClassName) => TrinaryLogic::createFromBoolean($this->exceptionTypeResolver->isCheckedException($objectClassName, $throwPoint->getScope())),
+				);
+				if ($isCheckedException->yes()) {
+					continue;
+				}
+
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					'%s hook for property %s::$%s throws exception %s but the PHPDoc contains @throws void.',
+					ucfirst($hookReflection->getPropertyHookName()),
+					$hookReflection->getDeclaringClass()->getDisplayName(),
+					$hookReflection->getHookedPropertyName(),
+					$throwPointType->describe(VerbosityLevel::typeOnly()),
+				))
+					->line($throwPoint->getNode()->getStartLine())
+					->identifier('throws.void')
+					->build();
+			}
+		}
+
+		return $errors;
+	}
+
+}

tests/PHPStan/Rules/Exceptions/ThrowsVoidPropertyHookWithExplicitThrowPointRuleTest.php

@@ -0,0 +1,104 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Exceptions;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use ThrowsVoidPropertyHook\MyException;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<ThrowsVoidPropertyHookWithExplicitThrowPointRule>
+ */
+class ThrowsVoidPropertyHookWithExplicitThrowPointRuleTest extends RuleTestCase
+{
+
+	private bool $missingCheckedExceptionInThrows;
+
+	/** @var string[] */
+	private array $checkedExceptionClasses;
+
+	protected function getRule(): Rule
+	{
+		return new ThrowsVoidPropertyHookWithExplicitThrowPointRule(new DefaultExceptionTypeResolver(
+			$this->createReflectionProvider(),
+			[],
+			[],
+			[],
+			$this->checkedExceptionClasses,
+		), $this->missingCheckedExceptionInThrows);
+	}
+
+	public function dataRule(): array
+	{
+		return [
+			[
+				true,
+				[],
+				[],
+			],
+			[
+				false,
+				['DifferentException'],
+				[
+					[
+						'Get hook for property ThrowsVoidPropertyHook\Foo::$i throws exception ThrowsVoidPropertyHook\MyException but the PHPDoc contains @throws void.',
+						18,
+					],
+				],
+			],
+			[
+				true,
+				[MyException::class],
+				[],
+			],
+			[
+				true,
+				['DifferentException'],
+				[
+					[
+						'Get hook for property ThrowsVoidPropertyHook\Foo::$i throws exception ThrowsVoidPropertyHook\MyException but the PHPDoc contains @throws void.',
+						18,
+					],
+				],
+			],
+			[
+				false,
+				[],
+				[
+					[
+						'Get hook for property ThrowsVoidPropertyHook\Foo::$i throws exception ThrowsVoidPropertyHook\MyException but the PHPDoc contains @throws void.',
+						18,
+					],
+				],
+			],
+			[
+				false,
+				[MyException::class],
+				[
+					[
+						'Get hook for property ThrowsVoidPropertyHook\Foo::$i throws exception ThrowsVoidPropertyHook\MyException but the PHPDoc contains @throws void.',
+						18,
+					],
+				],
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataRule
+	 * @param string[] $checkedExceptionClasses
+	 * @param list<array{0: string, 1: int, 2?: string}> $errors
+	 */
+	public function testRule(bool $missingCheckedExceptionInThrows, array $checkedExceptionClasses, array $errors): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('Test requires PHP 8.4.');
+		}
+
+		$this->missingCheckedExceptionInThrows = $missingCheckedExceptionInThrows;
+		$this->checkedExceptionClasses = $checkedExceptionClasses;
+		$this->analyse([__DIR__ . '/data/throws-void-property-hook.php'], $errors);
+	}
+
+}

tests/PHPStan/Rules/Exceptions/data/throws-void-property-hook.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace ThrowsVoidPropertyHook;
+
+class MyException extends \Exception
+{
+
+}
+
+class Foo
+{
+
+	public int $i {
+		/**
+		 * @throws void
+		 */
+		get {
+			throw new MyException();
+		}
+	}
+
+}