[PHPStan ^2.1.1] Handle next unreachable statement via UnreachableSta…

…tementNode->getNextUnreachableStatements() (#6642) * [PHPStan 2.1.x-dev] Handle next unreachable statement via UnreachableStatementNode->getNextUnreachableStatements() * [PHPStan 2.1.x-dev] Handle next unreachable statement via UnreachableStatementNode->getNextUnreachableStatements() * temporary use composer update on packages_tests * temporary use composer update on packages_tests * temporary use composer update on packages_tests * rollback * fix test * fix * add more fixture * more fixture * fix * [ci-review] Rector Rectify * remove unused flag IS_UNREACHABLE attribute * add unreachable statement test on UnnecessaryTernaryExpressionRector * add unreachable statement test on UnnecessaryTernaryExpressionRector * fixture name conflict fix --------- Co-authored-by: GitHub Action <[email protected]>
rectorphp · Jan 5, 2025 · 2e82ab4 · 2e82ab4
1 parent 92b4999
commit 2e82ab4
Show file tree

Hide file tree

Showing 9 changed files with 207 additions and 88 deletions.
diff --git a/.phpstorm.meta.php b/.phpstorm.meta.php
@@ -49,7 +49,6 @@
     \Rector\NodeTypeResolver\Node\AttributeKey::SCOPE,
     \Rector\NodeTypeResolver\Node\AttributeKey::REPRINT_RAW_VALUE,
     \Rector\NodeTypeResolver\Node\AttributeKey::ORIGINAL_NODE,
-    \Rector\NodeTypeResolver\Node\AttributeKey::IS_UNREACHABLE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PHP_DOC_INFO,
     \Rector\NodeTypeResolver\Node\AttributeKey::KIND,
     \Rector\NodeTypeResolver\Node\AttributeKey::IS_REGULAR_PATTERN,
@@ -64,7 +63,6 @@
     \Rector\NodeTypeResolver\Node\AttributeKey::SCOPE,
     \Rector\NodeTypeResolver\Node\AttributeKey::REPRINT_RAW_VALUE,
     \Rector\NodeTypeResolver\Node\AttributeKey::ORIGINAL_NODE,
-    \Rector\NodeTypeResolver\Node\AttributeKey::IS_UNREACHABLE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PHP_DOC_INFO,
     \Rector\NodeTypeResolver\Node\AttributeKey::KIND,
     \Rector\NodeTypeResolver\Node\AttributeKey::IS_REGULAR_PATTERN,

diff --git a/...ity/Rector/Ternary/UnnecessaryTernaryExpressionRector/Fixture/fixture_unreachable.php.inc b/...ity/Rector/Ternary/UnnecessaryTernaryExpressionRector/Fixture/fixture_unreachable.php.inc
@@ -0,0 +1,59 @@
+<?php
+
+if (true) {
+    return;
+}
+
+echo 'test';
+
+class FixtureUnreachableA
+{
+    public function run($order, $oldOrder)
+    {
+        return $order || $oldOrder ? true : false;
+    }
+}
+
+$order || $oldOrder ? true : false;
+
+class FixtureUnreachableB
+{
+    public function run($order, $oldOrder)
+    {
+        return $order || $oldOrder ? true : false;
+    }
+}
+
+$order || $oldOrder ? true : false;
+
+?>
+-----
+<?php
+
+if (true) {
+    return;
+}
+
+echo 'test';
+
+class FixtureUnreachableA
+{
+    public function run($order, $oldOrder)
+    {
+        return $order || $oldOrder;
+    }
+}
+
+$order || $oldOrder;
+
+class FixtureUnreachableB
+{
+    public function run($order, $oldOrder)
+    {
+        return $order || $oldOrder;
+    }
+}
+
+$order || $oldOrder;
+
+?>
diff --git a/src/NodeTypeResolver/Node/AttributeKey.php b/src/NodeTypeResolver/Node/AttributeKey.php
@@ -71,11 +71,6 @@ final class AttributeKey
      */
     public const KIND = 'kind';
 
-    /**
-     * @var string
-     */
-    public const IS_UNREACHABLE = 'isUnreachable';
-
     /**
      * @var string
      */

diff --git a/src/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php b/src/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php
@@ -105,7 +105,6 @@
 use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\NodeTypeResolver\PHPStan\Scope\Contract\NodeVisitor\ScopeResolverNodeVisitorInterface;
 use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
-use Rector\PHPStan\NodeVisitor\UnreachableStatementNodeVisitor;
 use Rector\Util\Reflection\PrivatesAccessor;
 use Webmozart\Assert\Assert;
 
@@ -161,11 +160,9 @@ public function processNodes(
 
         $scope = $formerMutatingScope ?? $this->scopeFactory->createFromFile($filePath);
 
-        $hasUnreachableStatementNode = false;
         $nodeCallback = function (Node $node, MutatingScope $mutatingScope) use (
             &$nodeCallback,
             $filePath,
-            &$hasUnreachableStatementNode
         ): void {
             // the class reflection is resolved AFTER entering to class node
             // so we need to get it from the first after this one
@@ -187,8 +184,7 @@ public function processNodes(
             // early check here as UnreachableStatementNode is special VirtualNode
             // so node to be checked inside
             if ($node instanceof UnreachableStatementNode) {
-                $this->processUnreachableStatementNode($node, $filePath, $mutatingScope);
-                $hasUnreachableStatementNode = true;
+                $this->processUnreachableStatementNode($node, $mutatingScope, $nodeCallback);
                 return;
             }
 
@@ -410,12 +406,7 @@ public function processNodes(
             RectorNodeScopeResolver::processNodes($stmts, $scope);
         }
 
-        if (! $hasUnreachableStatementNode) {
-            return $stmts;
-        }
-
-        $nodeTraverser = new NodeTraverser(new UnreachableStatementNodeVisitor($this, $filePath, $scope));
-        return $nodeTraverser->traverse($stmts);
+        return $stmts;
     }
 
     private function processYield(Yield_ $yield, MutatingScope $mutatingScope): void
@@ -582,16 +573,21 @@ private function processTryCatch(TryCatch $tryCatch, MutatingScope $mutatingScop
         }
     }
 
+    /**
+     * @param callable(Node $node, MutatingScope $scope): void $nodeCallback
+     */
     private function processUnreachableStatementNode(
         UnreachableStatementNode $unreachableStatementNode,
-        string $filePath,
-        MutatingScope $mutatingScope
+        MutatingScope $mutatingScope,
+        callable $nodeCallback
     ): void {
         $originalStmt = $unreachableStatementNode->getOriginalStatement();
-        $originalStmt->setAttribute(AttributeKey::IS_UNREACHABLE, true);
-        $originalStmt->setAttribute(AttributeKey::SCOPE, $mutatingScope);
 
-        $this->processNodes([$originalStmt], $filePath, $mutatingScope);
+        $this->nodeScopeResolverProcessNodes(
+            array_merge([$originalStmt], $unreachableStatementNode->getNextStatements()),
+            $mutatingScope,
+            $nodeCallback
+        );
     }
 
     /**

diff --git a/src/PHPStan/NodeVisitor/UnreachableStatementNodeVisitor.php b/src/PHPStan/NodeVisitor/UnreachableStatementNodeVisitor.php
diff --git a/tests/Issues/ScopeNotAvailable/FixtureJsonThrowCaseSensitiveConstFetch/fixture.php.inc b/tests/Issues/ScopeNotAvailable/FixtureJsonThrowCaseSensitiveConstFetch/fixture.php.inc
@@ -8,16 +8,19 @@ class Fixture
     {
         $user = $_REQUEST['param'];
 
+        // add JSON_THROW_ON_ERROR on NON-exact value
         $user = json_decode($user);
 
         $condition = true;
         if ($condition) {
             $output = [];
+            // skip add JSON_THROW_ON_ERROR on exact value
             echo(json_encode($output));
             exit;
         }
 
         $output = [];
+        // skip add JSON_THROW_ON_ERROR on exact value
         echo(json_encode($output));
     }
 }
@@ -34,17 +37,20 @@ class Fixture
     {
         $user = $_REQUEST['param'];
 
+        // add JSON_THROW_ON_ERROR on NON-exact value
         $user = json_decode($user, null, 512, JSON_THROW_ON_ERROR);
 
         $condition = true;
         if ($condition) {
             $output = [];
+            // skip add JSON_THROW_ON_ERROR on exact value
             echo(json_encode($output));
             exit;
         }
 
         $output = [];
-        echo(json_encode($output, JSON_THROW_ON_ERROR));
+        // skip add JSON_THROW_ON_ERROR on exact value
+        echo(json_encode($output));
     }
 }
 

diff --git a/...e/FixtureJsonThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts.php.inc b/...e/FixtureJsonThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts.php.inc
@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+class NonExactValueAfterUnreachableStmts
+{
+    /**
+     * @param 'foo' $foo
+     */
+    public static function run($foo)
+    {
+        if ($foo === 'foo') {
+            return;
+        }
+
+        echo 'some statement 1';
+        echo 'some statement 2';
+        echo(json_encode($foo));
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+class NonExactValueAfterUnreachableStmts
+{
+    /**
+     * @param 'foo' $foo
+     */
+    public static function run($foo)
+    {
+        if ($foo === 'foo') {
+            return;
+        }
+
+        echo 'some statement 1';
+        echo 'some statement 2';
+        echo(json_encode($foo, JSON_THROW_ON_ERROR));
+    }
+}
+
+?>
diff --git a/.../FixtureJsonThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts2.php.inc b/.../FixtureJsonThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts2.php.inc
@@ -0,0 +1,51 @@
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+class NonExactValueAfterUnreachableStmts
+{
+    /**
+     * @param 'foo' $foo
+     */
+    public static function run($foo)
+    {
+        if ($foo === 'foo') {
+            return;
+        }
+
+        echo 'some statement 1';
+        echo 'some statement 2';
+
+        function foo($foo) {
+            echo(json_encode($foo));
+        }
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+class NonExactValueAfterUnreachableStmts
+{
+    /**
+     * @param 'foo' $foo
+     */
+    public static function run($foo)
+    {
+        if ($foo === 'foo') {
+            return;
+        }
+
+        echo 'some statement 1';
+        echo 'some statement 2';
+
+        function foo($foo) {
+            echo(json_encode($foo, JSON_THROW_ON_ERROR));
+        }
+    }
+}
+
+?>
diff --git a/...ThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts_on_top_level.php.inc b/...ThrowCaseSensitiveConstFetch/non_exact_value_after_unreachable_stmts_on_top_level.php.inc
@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+if (true) {
+    return;
+}
+
+echo 'some statement 1';
+echo 'some statement 2';
+
+function foo($foo) {
+    echo(json_encode($foo));
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Issues\ScopeNotAvailable\FixtureJsonThrowCaseSensitiveConstFetch;
+
+if (true) {
+    return;
+}
+
+echo 'some statement 1';
+echo 'some statement 2';
+
+function foo($foo) {
+    echo(json_encode($foo, JSON_THROW_ON_ERROR));
+}
+
+?>