Merge pull request #10885 from kkmuffme/unknown-psalm-annotation-shou…

…ld-not-make-docblock-invalid Unknown @psalm annotation should not make whole docblock invalid
vimeo · Apr 6, 2024 · 7d6c88e · 7d6c88e
2 parents eaeb979 + db7bdd8
commit 7d6c88e
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 2 deletions.
diff --git a/src/Psalm/DocComment.php b/src/Psalm/DocComment.php
@@ -40,13 +40,17 @@ final class DocComment
     /**
      * Parse a docblock comment into its parts.
      */
-    public static function parsePreservingLength(Doc $docblock): ParsedDocblock
+    public static function parsePreservingLength(Doc $docblock, bool $no_psalm_error = false): ParsedDocblock
     {
         $parsed_docblock = DocblockParser::parse(
             $docblock->getText(),
             $docblock->getStartFilePos(),
         );
 
+        if ($no_psalm_error) {
+            return $parsed_docblock;
+        }
+
         foreach ($parsed_docblock->tags as $special_key => $_) {
             if (strpos($special_key, 'psalm-') === 0) {
                 $special_key = substr($special_key, 6);

diff --git a/src/Psalm/Internal/Analyzer/StatementsAnalyzer.php b/src/Psalm/Internal/Analyzer/StatementsAnalyzer.php
@@ -802,6 +802,14 @@ private function parseStatementDocblock(
             $this->parsed_docblock = null;
         }
 
+        if ($this->parsed_docblock === null) {
+            try {
+                $this->parsed_docblock = DocComment::parsePreservingLength($docblock, true);
+            } catch (DocblockParseException $e) {
+                // already reported above
+            }
+        }
+
         $comments = $this->parsed_docblock;
 
         if (isset($comments->tags['psalm-scope-this'])) {

diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockParser.php b/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockParser.php
@@ -53,7 +53,8 @@ public static function parse(
         CodeLocation $code_location,
         string $cased_function_id
     ): FunctionDocblockComment {
-        $parsed_docblock = DocComment::parsePreservingLength($comment);
+        // invalid @psalm annotations are already reported by the StatementsAnalyzer
+        $parsed_docblock = DocComment::parsePreservingLength($comment, true);
 
         $comment_text = $comment->getText();
 

diff --git a/tests/AnnotationTest.php b/tests/AnnotationTest.php
@@ -535,6 +535,45 @@ public function ret(): array { return []; }
                     '$_===' => 'list<array{href: string, lang: string}>',
                 ],
             ],
+            'invalidPsalmForMethodShouldNotBreakDocblock' => [
+                'code' => '<?php
+                    class A {
+                        /**
+                         * @psalm-impure
+                         * @param string $arg
+                         * @return non-falsy-string
+                         */
+                        public function foo($arg) {
+                            return $arg . "bar";
+                        }
+                    }
+
+                    $a = new A();
+                    $_ = $a->foo("hello");
+                ',
+                'assertions' => [
+                    '$_===' => 'non-falsy-string',
+                ],
+                'ignored_issues' => ['InvalidDocblock'],
+            ],
+            'invalidPsalmForFunctionShouldNotBreakDocblock' => [
+                'code' => '<?php
+                    /**
+                     * @psalm-impure
+                     * @param string $arg
+                     * @return non-falsy-string
+                     */
+                    function foo($arg) {
+                        return $arg . "bar";
+                    }
+
+                    $_ = foo("hello");
+                ',
+                'assertions' => [
+                    '$_===' => 'non-falsy-string',
+                ],
+                'ignored_issues' => ['InvalidDocblock'],
+            ],
             'builtInClassInAShape' => [
                 'code' => '<?php
                     /**