[framework] messenger: prevent errors when MESSENGER_TRANSPORT_DSN is empty (#3114)

Author: vitek-rostislav

src/CsFixer/Phpdoc/AbstractMissingAnnotationsFixer.php

@@ -8,6 +8,7 @@
 use PhpCsFixer\DocBlock\DocBlock;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
+use PhpCsFixer\Tokenizer\CT;
 use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixer\WhitespacesFixerConfig;
@@ -166,13 +167,39 @@ protected function getDocIndex(Tokens $tokens, int $index): int
     {
         do {
             $index = $tokens->getPrevNonWhitespace($index);
+
+            $index = $this->skipAttributes($tokens, $index);
         } while ($tokens[$index]->isGivenKind(
-            [T_STATIC, T_PUBLIC, T_PROTECTED, T_PRIVATE, T_FINAL, T_ABSTRACT, T_COMMENT],
+            [T_STATIC, T_PUBLIC, T_PROTECTED, T_PRIVATE, T_FINAL, T_ABSTRACT, T_COMMENT, T_ATTRIBUTE, CT::T_ATTRIBUTE_CLOSE],
         ));
 
         return $index;
     }
 
+    /**
+     * @param \PhpCsFixer\Tokenizer\Tokens $tokens
+     * @param int $index
+     * @return int
+     */
+    public function skipAttributes(Tokens $tokens, int $index): int
+    {
+        if ($tokens[$index]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
+            $depth = 1;
+
+            while ($depth > 0 && $index > 0) {
+                $index--;
+
+                if ($tokens[$index]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
+                    $depth++;
+                } elseif ($tokens[$index]->isGivenKind(T_ATTRIBUTE)) {
+                    $depth--;
+                }
+            }
+        }
+
+        return $index;
+    }
+
     /**
      * @param \PhpCsFixer\DocBlock\Line[] $newLines
      * @param string $indent
@@ -191,7 +218,6 @@ protected function createDocContentFromLinesAndIndent(array $newLines, string $i
     /**
      * @param \PhpCsFixer\Tokenizer\Token $docToken
      * @param \PhpCsFixer\DocBlock\Line[] $newLines
-     * @param int|null $offset
      * @return string
      */
     protected function createDocContentFromDocTokenAndNewLines(Token $docToken, array $newLines): string
@@ -218,7 +244,11 @@ protected function getNewDocIndex(Tokens $tokens, int $index): int
     {
         for ($i = $index; $i > 0; --$i) {
             if ($this->isWhitespaceWithNewline($tokens, $i)) {
-                return $i + 1;
+                if (!$tokens[$i - 1]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
+                    return $i + 1;
+                }
+
+                return $this->skipAttributes($tokens, $i - 1);
             }
         }
 

tests/Unit/CsFixer/Phpdoc/MissingParamAnnotationsFixer/MissingParamAnnotationsFixerTest.php

@@ -55,6 +55,8 @@ public function getTestingFiles(): iterable
 
         yield [__DIR__ . '/fixed/fixed6.php', __DIR__ . '/wrong/wrong6.php'];
 
+        yield [__DIR__ . '/fixed/fixed7.php', __DIR__ . '/wrong/wrong7.php'];
+
         yield [__DIR__ . '/correct/correct.php'];
     }
 }

tests/Unit/CsFixer/Phpdoc/MissingParamAnnotationsFixer/correct/correct.php

@@ -2,8 +2,11 @@
 
 namespace Shopsys\ProductFeed\ZboziBundle\Form;
 
+use Override;
+use ReturnTypeWillChange;
 use Shopsys\FormTypesBundle\MultidomainType;
 use Shopsys\FormTypesBundle\YesNoType;
+use Shopsys\FrameworkBundle\Component\EntityLog\Attribute\EntityLogIdentify;
 use Shopsys\FrameworkBundle\Component\Money\Money;
 use Shopsys\FrameworkBundle\Form\Constraints\MoneyRange;
 use Symfony\Component\Form\AbstractType;
@@ -28,10 +31,19 @@ public function __construct(TranslatorInterface $translator)
         $this->translator = $translator;
     }
 
+    /**
+     * @param string $bar
+     */
+    #[EntityLogIdentify(isLocalized: true)]
+    public function foo(string $bar): void
+    {
+    }
+
     /**
      * @param \Symfony\Component\Form\FormBuilderInterface $builder
      * @param array $options
      */
+    #[Override]
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
         $builder

tests/Unit/CsFixer/Phpdoc/MissingParamAnnotationsFixer/fixed/fixed7.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\CodingStandards\Tests;
+
+class SomeParentClassWithAttribute
+{
+    /**
+     * @param string $bar
+     */
+    public function foo(string $bar): void
+    {
+    }
+}
+
+class SomeClass extends SomeParentClassWithAttribute
+{
+    /**
+     * @param string $bar
+     */
+    #[\Override]
+    public function foo(string $bar): void
+    {
+    }
+
+    /**
+     * @param string $foo
+     * @param string $bar
+     */
+    #[\ReturnTypeWillChange]
+    public function bar(string $foo, string $bar): void
+    {
+    }
+}

tests/Unit/CsFixer/Phpdoc/MissingParamAnnotationsFixer/wrong/wrong7.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\CodingStandards\Tests;
+
+class SomeParentClassWithAttribute
+{
+    /**
+     * @param string $bar
+     */
+    public function foo(string $bar): void
+    {
+    }
+}
+
+class SomeClass extends SomeParentClassWithAttribute
+{
+    #[\Override]
+    public function foo(string $bar): void
+    {
+    }
+
+    /**
+     * @param string $bar
+     */
+    #[\ReturnTypeWillChange]
+    public function bar(string $foo, string $bar): void
+    {
+    }
+}

tests/Unit/CsFixer/Phpdoc/MissingReturnAnnotationFixer/MissingReturnAnnotationFixerTest.php

@@ -47,6 +47,8 @@ public function getTestingFiles(): iterable
 
         yield [__DIR__ . '/fixed/fixed2.php', __DIR__ . '/wrong/wrong2.php'];
 
+        yield [__DIR__ . '/fixed/fixed3.php', __DIR__ . '/wrong/wrong3.php'];
+
         yield [__DIR__ . '/correct/correct.php'];
     }
 }

tests/Unit/CsFixer/Phpdoc/MissingReturnAnnotationFixer/correct/correct.php

@@ -18,6 +18,15 @@ public static function isDebug(string $environment): bool
     {
         return $environment === self::DEVELOPMENT;
     }
+
+    /**
+     * @return bool
+     */
+    #[\ReturnTypeWillChange]
+    public function foo(): bool
+    {
+        return true;
+    }
 }
 
 

tests/Unit/CsFixer/Phpdoc/MissingReturnAnnotationFixer/fixed/fixed3.php

@@ -0,0 +1,13 @@
+<?php
+
+class SomeClass
+{
+    /**
+     * @return int
+     */
+    #[\ReturnTypeWillChange]
+    public function function1(): int
+    {
+        return 0;
+    }
+}

tests/Unit/CsFixer/Phpdoc/MissingReturnAnnotationFixer/wrong/wrong3.php

@@ -0,0 +1,10 @@
+<?php
+
+class SomeClass
+{
+    #[\ReturnTypeWillChange]
+    public function function1(): int
+    {
+        return 0;
+    }
+}