fix missing break handling in loop

vimeo · Dec 4, 2022 · 2490230 · 2490230
1 parent 4a77f24
commit 2490230
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/src/Psalm/Internal/Analyzer/ScopeAnalyzer.php b/src/Psalm/Internal/Analyzer/ScopeAnalyzer.php
@@ -23,6 +23,7 @@ class ScopeAnalyzer
     public const ACTION_BREAK = 'BREAK';
     public const ACTION_CONTINUE = 'CONTINUE';
     public const ACTION_LEAVE_SWITCH = 'LEAVE_SWITCH';
+    public const ACTION_LEAVE_LOOP = 'LEAVE_LOOP';
     public const ACTION_NONE = 'NONE';
     public const ACTION_RETURN = 'RETURN';
 
@@ -107,6 +108,10 @@ public static function getControlActions(
                         return [...$control_actions, ...[self::ACTION_LEAVE_SWITCH]];
                     }
 
+                    if ($break_types[count($break_types) - $count] === 'loop') {
+                        return [...$control_actions, ...[self::ACTION_LEAVE_LOOP]];
+                    }
+
                     return array_values($control_actions);
                 }
 
@@ -263,6 +268,7 @@ public static function getControlActions(
                     && $nodes
                     && ($stmt_expr_type = $nodes->getType($stmt->cond))
                     && $stmt_expr_type->isAlwaysTruthy()
+                    && !in_array(self::ACTION_LEAVE_LOOP, $control_actions, true)
                 ) {
                     //infinite while loop that only return don't have an exit path
                     $have_exit_path = (bool)array_diff(
@@ -277,6 +283,7 @@ public static function getControlActions(
 
                 if ($stmt instanceof PhpParser\Node\Stmt\For_
                     && $nodes
+                    && !in_array(self::ACTION_LEAVE_LOOP, $control_actions, true)
                 ) {
                     $is_infinite_loop = true;
                     if ($stmt->cond) {
@@ -300,6 +307,11 @@ public static function getControlActions(
                         }
                     }
                 }
+
+                $control_actions = array_filter(
+                    $control_actions,
+                    static fn(string $action): bool => $action !== self::ACTION_LEAVE_LOOP
+                );
             }
 
             if ($stmt instanceof PhpParser\Node\Stmt\TryCatch) {

diff --git a/tests/Loop/WhileTest.php b/tests/Loop/WhileTest.php
@@ -676,6 +676,21 @@ function breakUpPathIntoParts(): void {
                         }
                     }'
             ],
+            'breakInWhileTrueIsNotInfiniteLoop' => [
+                'code' => '<?php
+                    /** @return Generator<array-key, mixed> */
+                    function f()
+                    {
+                        if (rand(0,1)) {
+                            throw new Exception;
+                        }
+
+                        while (true) {
+                            yield 1;
+                            break;
+                        }
+                    }'
+            ],
         ];
     }