Adds support for fixing missing throws doc block #7994
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
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
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,123 @@ | ||
| <?php | ||
|
|
||
| namespace Psalm\Tests\FileManipulation; | ||
|
|
||
| class ThrowsBlockAdditionTest extends FileManipulationTestCase | ||
| { | ||
| /** | ||
| * @return array<string,array{string,string,string,string[],bool}> | ||
| */ | ||
| public function providerValidCodeParse(): array | ||
| { | ||
| return [ | ||
| 'addThrowsAnnotationToFunction' => [ | ||
| '<?php | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '7.4', | ||
| ['MissingThrowsDocblock'], | ||
| true, | ||
| ], | ||
| 'addMultipleThrowsAnnotationToFunction' => [ | ||
| '<?php | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| if("" === \trim($s)) { | ||
| throw new \DomainException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException|DomainException | ||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| if("" === \trim($s)) { | ||
| throw new \DomainException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '7.4', | ||
| ['MissingThrowsDocblock'], | ||
| true, | ||
| ], | ||
| 'preservesExistingThrowsAnnotationToFunction' => [ | ||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException|DomainException | ||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \Exception(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException|DomainException | ||
| * @throws Exception | ||
|
There was a problem hiding this comment. i preserve the existing throws annotation and add a new one based on inference There was a problem hiding this comment. So the fix will always add a new throws annotation which can have |
||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \Exception(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '7.4', | ||
| ['MissingThrowsDocblock'], | ||
| true, | ||
| ], | ||
| 'doesNotAddDuplicateThrows' => [ | ||
|
There was a problem hiding this comment. This validates that the fix only adds exceptions which are not listed in the current throws doc block |
||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| if("" === \trim($s)) { | ||
| throw new \DomainException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '<?php | ||
| /** | ||
| * @throws InvalidArgumentException | ||
| * @throws DomainException | ||
| */ | ||
| function foo(string $s): string { | ||
| if("" === $s) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| if("" === \trim($s)) { | ||
| throw new \DomainException(); | ||
| } | ||
| return $s; | ||
| }', | ||
| '7.4', | ||
| ['MissingThrowsDocblock'], | ||
| true, | ||
| ], | ||
| ]; | ||
| } | ||
| } | ||
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.
should i keep this assert or remove it, it makes sense for throws keyword to only contain classes which exist
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.
ideally this check would not be needed, but that means modifying the return type for the function
getUncaughtThrowswhich would be a bigger changeThere 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.
Please drop it. It's risky because classes could be stubbed or inserted through a Plugin so you can't guarantee they'll exists for Psalm to autoload