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
Improve handling of unsupported references (fixes #8018). #8022
Merged
orklah
merged 2 commits into
vimeo:master
from
AndrolGenhald:bugfix/8018-improve-failure-case-for-references
May 27, 2022
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
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
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,34 @@ | ||
# UnsupportedReferenceUsage | ||
|
||
Emitted when Psalm encounters a reference that it is not currently able to track (for instance a reference to an array | ||
offset of an array offset: `$foo = &$bar[$baz[0]]`). When an unsupported reference is encountered, Psalm will issue this | ||
warning and treat the variable as though it wasn't actually a reference. | ||
|
||
## How to fix | ||
|
||
This can sometimes be fixed by using a temporary variable: | ||
|
||
```php | ||
<?php | ||
|
||
/** @var non-empty-list<int> */ | ||
$bar = [1, 2, 3]; | ||
/** @var non-empty-list<int> */ | ||
$baz = [1, 2, 3]; | ||
|
||
$foo = &$bar[$baz[0]]; | ||
``` | ||
|
||
can be turned into | ||
|
||
```php | ||
<?php | ||
|
||
/** @var non-empty-list<int> */ | ||
$bar = [1, 2, 3]; | ||
/** @var non-empty-list<int> */ | ||
$baz = [1, 2, 3]; | ||
|
||
$offset = $baz[0]; | ||
$foo = &$bar[$offset]; | ||
``` |
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,9 @@ | ||
<?php | ||
|
||
namespace Psalm\Issue; | ||
|
||
final class UnsupportedReferenceUsage extends CodeIssue | ||
{ | ||
public const ERROR_LEVEL = 2; | ||
public const SHORTCODE = 312; | ||
} |
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
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.
It turns out the bug this pull request fixes actually affected this method, causing everything after
$context->vars_in_scope[$lhs_var_id] = &$context->vars_in_scope[$rhs_var_id];
to be ignored.After it was fixed, that same line was reported as an unused variable, so I finally gave up and just decided that putting a reference in an object or an array is a bad idea anyway, and it's not worth it to track usage in that case (this is basically increasing the scope of the change in #7684 from only ignoring unused references on
$this
to ignoring unused references on any object or array).