Symfony route doc block comments get removed by AnnotationToAttributeRector

[emilychestertonhunt]

Bug Report

Subject	Details
Rector version	2.4

When converting Symfony routes from annotations to attributes using withAttributesSets, comments are being removed in addition to the route annotation when they appear after the route.

Minimal PHP Code Causing Issue

I am not sure how to get this to work in the demo but here is what I tried and below is a diff of running the rule with the comment before and after the route.
https://getrector.com/demo/eeb66d58-4507-41bb-bec2-1c814fadc3b1

    ---------- begin diff ----------
@@ Line 17 @@
        /**
-        * This is an example comment
-        *
-        * @Route("/test", name="test_route")
-        */
-       public function test(): Response
+     * This is an example comment
+     */
+    #[Route(path: '/test', name: 'test_route')]
+    public function test(): Response
        {

                return $this->render("test.html.twig", []);
    ----------- end diff -----------

Applied rules:
 * AnnotationToAttributeRector

    ---------- begin diff ----------
@@ Line 16 @@
 {
-       /**
-        * @Route("/test", name="test_route")
-        * This is an example comment
-       */
-       public function test(): Response
+       #[Route(path: '/test', name: 'test_route')]
+    public function test(): Response
        {

                return $this->render("test.html.twig", []);
    ----------- end diff -----------

Applied rules:
 * AnnotationToAttributeRector

Expected Behaviour

Rector should not delete the comment.

[samsonasik]

I can't reproduce, see fixture PR rectorphp/rector-src#8086 .

Try latest dev-main in case already resolved in latest dev-main, if the issue persist, we may need reproducible repo we can clone and try locally. Thank you.

[emilychestertonhunt]

Thank you for your quick reply Abdul.

From what I can see from your testing here, your comment is before the route annotation which works as expected. The issue we were having is where someone has put their comment after the route annotation e.g.

    /**
      * @Route("/test", name="test_route")
      * 
      * This is an example comment
     */

would become

#[Route(path: '/test', name: 'test_route')]

~ Emily

[samsonasik]

For below attribute, that's expected as the php-parser behaviour, comment should belong to attribute.

The comment attribute tweak feature was removed at PR:

• [comments] Remove attribute comments support as comments require standalone line before any doctrine annotation rector-src#7582

Move before annotation, and it will be fine :).

[TomasVotruba]

@samsonasik I'll look into it. Maybe my approach was wrong.

[emilychestertonhunt]

Move before annotation, and it will be fine :).

We’ve now moved the annotation before the route, which fixes it. Ideally, we wouldn’t have had comments after the route in the first place, we just wanted to confirm whether the behaviour was expected. The joys of working on a legacy codebase ay!