Avoid false positive with 'use function ...' lines

magento · Mar 25, 2024 · 5fb6d01 · 5fb6d01
1 parent 7521587
commit 5fb6d01
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 5 deletions.
diff --git a/Magento2/Sniffs/Exceptions/TryProcessSystemResourcesSniff.php b/Magento2/Sniffs/Exceptions/TryProcessSystemResourcesSniff.php
@@ -1,13 +1,15 @@
 <?php
+
 /**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento2\Sniffs\Exceptions;
 
-use function array_slice;
-use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 
 /**
  * Detects missing try-catch block when processing system resources.
@@ -43,7 +45,10 @@ class TryProcessSystemResourcesSniff implements Sniff
      */
     public function register()
     {
-        return [T_STRING];
+        return [
+            \T_USE,
+            \T_STRING,
+        ];
     }
 
     /**
@@ -53,10 +58,31 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
+        if ($tokens[$stackPtr]['code'] === \T_USE) {
+            $previousToken = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 1, null, true);
+            $nextToken = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
+            $semicolon = $phpcsFile->findNext(T_SEMICOLON, $stackPtr + 1);
+            if (
+                $previousToken !== false
+                && \in_array($tokens[$previousToken]['code'], [\T_OPEN_TAG, \T_SEMICOLON], true)
+                && $nextToken !== false
+                && $tokens[$nextToken]['code'] === \T_STRING
+                && $tokens[$nextToken]['content'] === 'function'
+                && $semicolon !== false
+            ) {
+                // We have found a 'use function ...' statement; skip over this.
+                return $semicolon;
+            }
+
+            // This is not a 'use function ...' statement.
+            return;
+        }
+
         foreach ($this->functions as $function) {
             if (strpos($tokens[$stackPtr]['content'], $function) !== 0) {
                 continue;
             }
+
             $tryPosition = $phpcsFile->findPrevious(T_TRY, $stackPtr - 1);
 
             if ($tryPosition !== false) {

diff --git a/Magento2/Tests/Exceptions/TryProcessSystemResourcesUnitTest.inc b/Magento2/Tests/Exceptions/TryProcessSystemResourcesUnitTest.inc
@@ -4,6 +4,8 @@ namespace Foo\Bar;
 
 use Exception;
 
+use function stream_get_contents;
+
 class StreamHandler
 {
     public function handleException()
@@ -26,4 +28,8 @@ function executeStream()
     socket_bind($sock);
     // Rule find: Try block detected when processing system resources
     socket_close($sock);
+
+    $func = function () use (&$strChar) {
+        $strChar = stream_get_contents(STDIN, 1);
+    }
 }
diff --git a/Magento2/Tests/Exceptions/TryProcessSystemResourcesUnitTest.php b/Magento2/Tests/Exceptions/TryProcessSystemResourcesUnitTest.php
@@ -26,10 +26,11 @@ protected function getErrorList()
     protected function getWarningList()
     {
         return [
-            22 => 1,
             24 => 1,
             26 => 1,
-            28 => 1
+            28 => 1,
+            30 => 1,
+            33 => 1,
         ];
     }
 }