-
Notifications
You must be signed in to change notification settings - Fork 97
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
ondrejmirtes
merged 3 commits into
phpstan:1.3.x
from
VincentLanglet:fix/entityManagerFlush
Nov 13, 2023
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
src/Type/Doctrine/EntityManagerInterfaceThrowTypeExtension.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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()]) | ||
); | ||
} | ||
|
||
return $methodReflection->getThrowType(); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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', | ||
]; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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(); | ||
} | ||
|
||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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(....
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.