Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use dynamic throw type extension on EntityManagerInterface::flush #486

Merged
merged 3 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions extension.neon
Original file line number Diff line number Diff line change
Expand Up @@ -398,3 +398,8 @@ services:
class: PHPStan\PhpDoc\Doctrine\QueryTypeNodeResolverExtension
tags:
- phpstan.phpDoc.typeNodeResolverExtension

-
class: PHPStan\Type\Doctrine\EntityManagerInterfaceThrowTypeExtension
tags:
- phpstan.dynamicMethodThrowTypeExtension
6 changes: 5 additions & 1 deletion phpstan-baseline.neon
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ parameters:
count: 1
path: tests/Rules/Exceptions/CatchWithUnthrownExceptionRuleTest.php

-
message: "#^Accessing PHPStan\\\\Rules\\\\Exceptions\\\\TooWideMethodThrowTypeRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
count: 1
path: tests/Rules/Exceptions/TooWideMethodThrowTypeRuleTest.php

-
message: "#^Accessing PHPStan\\\\Rules\\\\DeadCode\\\\UnusedPrivatePropertyRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
count: 1
Expand All @@ -59,4 +64,3 @@ parameters:
message: "#^Accessing PHPStan\\\\Rules\\\\Properties\\\\MissingReadOnlyPropertyAssignRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
count: 1
path: tests/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php

49 changes: 49 additions & 0 deletions src/Type/Doctrine/EntityManagerInterfaceThrowTypeExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php declare(strict_types = 1);

namespace PHPStan\Type\Doctrine;

use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Exception\ORMException;
use Doctrine\Persistence\ObjectManager;
use PhpParser\Node\Expr\MethodCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Type\DynamicMethodThrowTypeExtension;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use function array_map;

class EntityManagerInterfaceThrowTypeExtension implements DynamicMethodThrowTypeExtension
{

public const SUPPORTED_METHOD = [
'flush' => [
ORMException::class,
UniqueConstraintViolationException::class,
],
];

public function isMethodSupported(MethodReflection $methodReflection): bool
{
return $methodReflection->getDeclaringClass()->getName() === ObjectManager::class
&& isset(self::SUPPORTED_METHOD[$methodReflection->getName()]);
}

public function getThrowTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
{
$type = $scope->getType($methodCall->var);

if ((new ObjectType(EntityManagerInterface::class))->isSuperTypeOf($type)->yes()) {
return TypeCombinator::union(
...array_map(static function ($class): Type {
return new ObjectType($class);
}, self::SUPPORTED_METHOD[$methodReflection->getName()])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a test. You can create a new test case for the corresponding rule, and fetch the rule with self::getContainer()->getByType(....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems covered by
https://github.com/phpstan/phpstan-doctrine/blob/1.3.x/tests/Rules/Exceptions/data/unthrown-exception.php#L21-L25
to me.

I tried to comment the whole if in the getThrowTypeFromMethodCall, and tests were failing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If your src/ does not change anything about test results then it's not needed.

Please show why your change is needed by writing a failing test first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added another test which fail without this change.

);
}

return $methodReflection->getThrowType();
}

}
8 changes: 0 additions & 8 deletions stubs/EntityManagerInterface.stub
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,6 @@ interface EntityManagerInterface extends ObjectManager
*/
public function copy($entity, $deep = false);

/**
* @return void
*
* @throws ORMException
* @throws \Doctrine\DBAL\Exception\UniqueConstraintViolationException
*/
public function flush();

/**
* @template T of object
* @phpstan-param class-string<T> $className
Expand Down
31 changes: 31 additions & 0 deletions tests/Rules/Exceptions/TooWideMethodThrowTypeRuleTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php declare(strict_types = 1);

namespace PHPStan\Rules\Exceptions;

use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;

/**
* @extends RuleTestCase<TooWideMethodThrowTypeRule>
*/
class TooWideMethodThrowTypeRuleTest extends RuleTestCase
{

protected function getRule(): Rule
{
return self::getContainer()->getByType(TooWideMethodThrowTypeRule::class);
}

public function testRule(): void
{
$this->analyse([__DIR__ . '/data/entity-manager-interface.php'], []);
}

public static function getAdditionalConfigFiles(): array
{
return [
__DIR__ . '/../../../extension.neon',
];
}

}
21 changes: 21 additions & 0 deletions tests/Rules/Exceptions/data/entity-manager-interface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace EntityManagerInterfaceThrowTypeExtensionTest;

use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Exception\ORMException;

class Example
{

/**
* @throws ORMException
* @throws UniqueConstraintViolationException
*/
public function doFoo(EntityManagerInterface $entityManager): void
{
$entityManager->flush();
}

}