[DeadCode] Skip foreach over side-effecting expression in RemoveDeadIfForeachForRector#8106
Merged
Merged
Conversation
…fForeachForRector
Member
Author
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
RemoveDeadIfForeachForRectorremoved aforeachwith an empty body even when the iterated expression has side effects, e.g. consuming a generator:Here
$this->events()is a generator that sets$this->resultas it is consumed. The empty body is not dead code — iterating is the work. The rule deleted the wholeif/foreach, silently breaking behavior.Spotted in the wild: https://github.com/neuron-core/neuron-ai/blob/3.x/rector.php#L23-L27 had to
withSkip()this rule onWorkflowHandler.php.Fix
processForForeach()only checked whether loop variables were used in the next statement; it ignored side effects in the iterated expression itself. Bail out when$for->exprcontains aCallLike/Assign(reusing the existinghasNodeSideEffect()helper already used byprocessIf()).Added
skip_foreach_over_call_side_effect.php.incfixture covering the case.