fix: api:upgrade-resource output formatting (#5624)

Author: n-valverde

src/Core/Bridge/Symfony/Bundle/Command/UpgradeApiResourceCommand.php

@@ -26,8 +26,9 @@
 use ApiPlatform\Exception\ResourceClassNotFoundException;
 use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
 use Doctrine\Common\Annotations\AnnotationReader;
-use PhpParser\Lexer\Emulative;
+use PhpParser\Lexer;
 use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor\CloningVisitor;
 use PhpParser\Parser\Php7;
 use PhpParser\PrettyPrinter\Standard;
 use SebastianBergmann\Diff\Differ;
@@ -106,7 +107,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 continue;
             }
 
-            $lexer = new Emulative([
+            $lexer = new Lexer([
                 'usedAttributes' => [
                     'comments',
                     'startLine',
@@ -141,7 +142,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $oldStmts = $parser->parse($oldCode);
             $oldTokens = $lexer->getTokens();
 
-            $newStmts = $traverser->traverse($oldStmts);
+            $cloningTraverser = new NodeTraverser();
+            $cloningTraverser->addVisitor(new CloningVisitor()); // Required to preserve formatting
+
+            $newStmts = $traverser->traverse($cloningTraverser->traverse($oldStmts));
             $newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);
 
             if (!$input->getOption('force') && $input->getOption('dry-run')) {
@@ -216,7 +220,7 @@ private function getSubresources(): array
     private function printDiff(string $oldCode, string $newCode, OutputInterface $output): void
     {
         $consoleFormatter = new ColorConsoleDiffFormatter();
-        $differ = class_exists(UnifiedDiffOutputBuilder::class) ? new Differ(new UnifiedDiffOutputBuilder()) :  new Differ();
+        $differ = class_exists(UnifiedDiffOutputBuilder::class) ? new Differ(new UnifiedDiffOutputBuilder()) : new Differ();
         $diff = $differ->diff($oldCode, $newCode);
         $output->write($consoleFormatter->format($diff));
     }

src/Core/Upgrade/RemoveAnnotationTrait.php

@@ -13,22 +13,15 @@
 
 namespace ApiPlatform\Core\Upgrade;
 
-use phpDocumentor\Reflection\DocBlock\Serializer;
-use phpDocumentor\Reflection\DocBlockFactory;
 use PhpParser\Comment\Doc;
 
 trait RemoveAnnotationTrait
 {
     private function removeAnnotationByTag(Doc $comment, string $tagName): Doc
     {
-        $factory = DocBlockFactory::createInstance();
-        $docBlock = $factory->create($comment->getText());
-        foreach ($docBlock->getTagsByName($tagName) as $tag) {
-            $docBlock->removeTag($tag);
-        }
+        // https://regex101.com/r/GBIPnj/1
+        $text = preg_filter("/^[[:blank:]]*[\/*]+[[:blank:]]*@{$tagName}[[:blank:]]*(\(.*?\))?[\s*\/]*?$/ms", '', $comment->getText());
 
-        $serializer = new Serializer(0, '', true, null, null, \PHP_EOL);
-
-        return new Doc($serializer->getDocComment($docBlock));
+        return null === $text ? $comment : new Doc($text);
     }
 }

tests/Core/Bridge/Symfony/Bundle/Command/UpgradeApiResourceCommandTest.php

@@ -69,6 +69,13 @@ public function testDebugResource(string $entityClass, array $subresourceOperati
         foreach ($expectedStrings as $expectedString) {
             $this->assertStringContainsString($expectedString, $display);
         }
+
+        $this->assertStringNotContainsString('-declare(strict_types=1);', $display);
+        $this->assertStringNotContainsString('+declare (strict_types=1);', $display);
+        $this->assertStringNotContainsString('-@ORM\Column(type="integer")', $display);
+        $this->assertStringNotContainsString('+@ORM\Column (type="integer")', $display);
+        $this->assertStringNotContainsString('-private function nothingToDo(): void', $display);
+        $this->assertStringNotContainsString('+private function nothingToDo() : void', $display);
     }
 
     public function debugResourceProvider(): array

tests/Fixtures/TestBundle/Entity/DummyToUpgradeWithOnlyAnnotation.php

@@ -66,4 +66,8 @@ class DummyToUpgradeWithOnlyAnnotation
      * @ApiFilter(ExistsFilter::class)
      */
     private $dummyToUpgradeProduct;
+
+    private function nothingToDo(): void // @phpstan-ignore-line
+    {
+    }
 }

tests/Fixtures/TestBundle/Entity/DummyToUpgradeWithOnlyAttribute.php

@@ -49,4 +49,8 @@ class DummyToUpgradeWithOnlyAttribute
     #[ApiSubresource]
     #[ApiProperty(iri: 'DummyToUpgradeWithOnlyAttribute.dummyToUpgradeProduct')]
     private $dummyToUpgradeProduct;
+
+    private function nothingToDo(): void // @phpstan-ignore-line
+    {
+    }
 }