Upgrade the PHP static analysis to Psalm 6 (#504)

Author: stof

php/bin/gherkin

@@ -13,14 +13,22 @@ $options = ['predictable-ids', 'no-source', 'no-ast', 'no-pickles'];
 
 $selectedOptions = getopt('', $options, $restIndex);
 
+assert($selectedOptions !== false, "getopt returns false only when it cannot find the argv array.");
+
 $paths = array_slice($argv, $restIndex);
 
 // lazily-read list of Sources
 $sources = (
     /** @param list<string> $paths */
     function (array $paths) {
         foreach ($paths as $path) {
-            yield new Source(uri: $path, data: file_get_contents($path));
+            $data = file_get_contents($path);
+
+            if ($data === false) {
+                throw new RuntimeException(sprintf('Unable to read file "%s".', $path));
+            }
+
+            yield new Source(uri: $path, data: $data);
         }
     }
 )($paths);
@@ -34,5 +42,6 @@ $parser = new GherkinParser(
 $envelopes = $parser->parse($sources);
 
 $output = fopen('php://stdout', 'w');
+assert($output !== false);
 $writer = NdJsonStreamWriter::fromFileHandle($output);
 $writer->writeEnvelopes($envelopes);

php/bin/gherkin-generate-tokens

@@ -17,9 +17,15 @@ $parser = new Parser(new TokenFormatterBuilder());
 array_shift($argv);
 
 foreach($argv as $fileName) {
+    $input = file_get_contents($fileName);
+
+    if ($input === false) {
+        throw new \RuntimeException(\sprintf('Could not read file "%s".', $fileName));
+    }
+
     $result = $parser->parse(
             $fileName,
-            new StringTokenScanner(file_get_contents($fileName)),
+            new StringTokenScanner($input),
             new TokenMatcher(),
     );
     echo $result;

php/composer.json

@@ -19,8 +19,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^10.5 || ^11.0",
-        "vimeo/psalm": "5.26.1",
+        "vimeo/psalm": "6.13.1",
         "friendsofphp/php-cs-fixer": "^3.51",
-        "psalm/plugin-phpunit": "^0.19.0"
+        "psalm/plugin-phpunit": "^0.19.5"
     }
 }

php/psalm.xml

@@ -4,6 +4,7 @@
     resolveFromConfigFile="true"
     findUnusedBaselineEntry="true"
     findUnusedCode="true"
+    ensureOverrideAttribute="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
@@ -25,18 +26,6 @@
                 <file name="src-generated/Parser.php"/>
             </errorLevel>
         </TypeDoesNotContainType>
-        <InvalidReturnType>
-            <errorLevel type="suppress">
-                <!-- See https://github.com/vimeo/psalm/issues/8572 -->
-                <file name="src/AstNode.php"/>
-            </errorLevel>
-        </InvalidReturnType>
-        <InvalidReturnStatement>
-            <errorLevel type="suppress">
-                <!-- See https://github.com/vimeo/psalm/issues/8572 -->
-                <file name="src/AstNode.php"/>
-            </errorLevel>
-        </InvalidReturnStatement>
     </issueHandlers>
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>

php/src/GherkinDialectProvider.php

@@ -27,9 +27,12 @@ public function __construct(
         try {
             /**
              * Here we force the type checker to assume the decoded JSON has the correct
-             * structure, rather than validating it. This is safe because it's not dynamic
+             * structure, rather than validating it. This is safe because it's not dynamic.
+             * We also assume that reading the file won't fail as this is a file shipped in
+             * the package.
              *
              * @var non-empty-array<non-empty-string, Dialect> $data
+             * @psalm-suppress PossiblyFalseArgument
              */
             $data = json_decode(file_get_contents(self::JSON_PATH), true, flags: JSON_THROW_ON_ERROR);
             $this->DIALECTS = $data;

php/src/GherkinDocumentBuilder.php

@@ -26,6 +26,7 @@
 use Cucumber\Messages\TableRow;
 use Cucumber\Messages\Tag;
 use LogicException;
+use RuntimeException;
 
 /**
  * @implements Builder<GherkinDocument>
@@ -316,6 +317,10 @@ private function transformDescriptionNode(AstNode $node): string
             $this->joinMatchedTextWithLinebreaks($lineTokens),
         );
 
+        if ($lineText === null) {
+            throw new RuntimeException('Failed to trim the description: ' . preg_last_error_msg());
+        }
+
         return $lineText;
     }
 

php/src/StringGherkinLine.php

@@ -4,6 +4,8 @@
 
 namespace Cucumber\Gherkin;
 
+use RuntimeException;
+
 final class StringGherkinLine implements GherkinLine
 {
     // TODO: set this to 0 when/if we change to 0-indexed columns
@@ -93,7 +95,7 @@ function ($match) {
                 // done this way so that \\n => \n once and isn't then recursively replaced again (or similar)
                 $unescaped = preg_replace_callback(
                     '/(\\\\.)/u',
-                    function ($groups) {
+                    function (array $groups) {
                         return match ($groups[0]) {
                             '\\n' => "\n",
                             '\\\\' => '\\',
@@ -104,6 +106,10 @@ function ($groups) {
                     $trimmedCell,
                 );
 
+                if ($unescaped === null) {
+                    throw new \RuntimeException('Failed to decode escape sequences in doc string: ' . preg_last_error_msg());
+                }
+
                 return new GherkinLineSpan($cellStart + $cellIndent + self::OFFSET, $unescaped);
             },
             $splitCells,
@@ -115,6 +121,10 @@ public function getTags(): array
     {
         $uncommentedLine = preg_replace('/\s' . preg_quote(GherkinLanguageConstants::COMMENT_PREFIX) . '.*$/u', '', $this->trimmedLineText);
 
+        if ($uncommentedLine === null) {
+            throw new RuntimeException('Failed to strip comments: ' . preg_last_error_msg());
+        }
+
         /**
          * @var list<array{0:string, 1:int}> $elements guaranteed by PREG_SPLIT_OFFSET_CAPTURE
          */

php/src/StringUtils.php

@@ -4,6 +4,8 @@
 
 namespace Cucumber\Gherkin;
 
+use RuntimeException;
+
 /**
  * Keeps common string operations in one place using correct unicode functions
  * (and normalises naming with other implementations)
@@ -33,22 +35,46 @@ public static function substring(string $string, int $start, int $length = null)
 
     public static function rtrim(string $string): string
     {
-        return preg_replace('/' . self::WHITESPACE_PATTERN . '$/u', '', $string);
+        $trimmed = preg_replace('/' . self::WHITESPACE_PATTERN . '$/u', '', $string);
+
+        if ($trimmed === null) {
+            throw new RuntimeException('Failed to trim the string: ' . preg_last_error_msg());
+        }
+
+        return $trimmed;
     }
 
     public static function rtrimKeepNewLines(string $string): string
     {
-        return preg_replace('/' . self::WHITESPACE_PATTERN_NO_NEWLINE . '$/u', '', $string);
+        $trimmed = preg_replace('/' . self::WHITESPACE_PATTERN_NO_NEWLINE . '$/u', '', $string);
+
+        if ($trimmed === null) {
+            throw new RuntimeException('Failed to trim the string: ' . preg_last_error_msg());
+        }
+
+        return $trimmed;
     }
 
     public static function ltrim(string $string): string
     {
-        return preg_replace('/^'. self::WHITESPACE_PATTERN . '/u', '', $string);
+        $trimmed = preg_replace('/^'. self::WHITESPACE_PATTERN . '/u', '', $string);
+
+        if ($trimmed === null) {
+            throw new RuntimeException('Failed to trim the string: ' . preg_last_error_msg());
+        }
+
+        return $trimmed;
     }
 
     public static function ltrimKeepNewLines(string $string): string
     {
-        return preg_replace('/^'. self::WHITESPACE_PATTERN_NO_NEWLINE . '/u', '', $string);
+        $trimmed = preg_replace('/^'. self::WHITESPACE_PATTERN_NO_NEWLINE . '/u', '', $string);
+
+        if ($trimmed === null) {
+            throw new RuntimeException('Failed to trim the string: ' . preg_last_error_msg());
+        }
+
+        return $trimmed;
     }
 
     public static function trim(string $string): string
@@ -61,7 +87,13 @@ public static function replace(string $string, array $replacements): string
     {
         $patterns = array_map(fn ($p) => '/' . preg_quote($p) . '/u', array_keys($replacements));
 
-        return preg_replace($patterns, array_values($replacements), $string);
+        $replaced = preg_replace($patterns, array_values($replacements), $string);
+
+        if ($replaced === null) {
+            throw new RuntimeException('Failed to replace patterns in string: ' . preg_last_error_msg());
+        }
+
+        return $replaced;
     }
 
     /** @return array<non-empty-string> */