Keep JsonResponse type (#757)

Author: TomasVotruba

rules-tests/CodeQuality/Rector/ClassMethod/TemplateAnnotationToThisRenderRector/Fixture/Attributes/remove_attribute_but_keep_json_response.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\TemplateAnnotationToThisRenderRector\Fixture\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+final class RemoveAttributeButKeepJsonResponse extends AbstractController
+{
+    #[Template("with_some_template.twig")]
+    public function indexAction(): array|Response
+    {
+        if (mt_rand(0, 1)) {
+            return ['key' => 'value'];
+        }
+
+        return new JsonResponse([], Response::HTTP_BAD_REQUEST);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\TemplateAnnotationToThisRenderRector\Fixture\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+final class RemoveAttributeButKeepJsonResponse extends AbstractController
+{
+    public function indexAction(): \Symfony\Component\HttpFoundation\Response
+    {
+        if (mt_rand(0, 1)) {
+            return $this->render('with_some_template.twig', ['key' => 'value']);
+        }
+        return new JsonResponse([], Response::HTTP_BAD_REQUEST);
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/TemplateAnnotationToThisRenderRector/Fixture/Attributes/remove_attribute_but_keep_json_response_reversed.php.inc

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\TemplateAnnotationToThisRenderRector\Fixture\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+final class RemoveAttributeButKeepJsonResponseReversed extends AbstractController
+{
+    #[Template("with_some_template.twig")]
+    public function indexAction(): array|Response
+    {
+        if (mt_rand(0, 1)) {
+            return new JsonResponse([], Response::HTTP_BAD_REQUEST);
+        }
+
+        return ['key' => 'value'];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\TemplateAnnotationToThisRenderRector\Fixture\Attributes;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+final class RemoveAttributeButKeepJsonResponseReversed extends AbstractController
+{
+    public function indexAction(): \Symfony\Component\HttpFoundation\Response
+    {
+        if (mt_rand(0, 1)) {
+            return new JsonResponse([], Response::HTTP_BAD_REQUEST);
+        }
+        return $this->render('with_some_template.twig', ['key' => 'value']);
+    }
+}
+
+?>

rules/CodeQuality/Rector/ClassMethod/TemplateAnnotationToThisRenderRector.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Symfony\CodeQuality\Rector\ClassMethod;
 
+use PhpParser\Node\Expr\New_;
 use PhpParser\Node;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\Expr;
@@ -38,6 +39,7 @@
 use Rector\Symfony\NodeFinder\EmptyReturnNodeFinder;
 use Rector\Symfony\TypeAnalyzer\ArrayUnionResponseTypeAnalyzer;
 use Rector\Symfony\TypeDeclaration\ReturnTypeDeclarationUpdater;
+use Symfony\Component\HttpFoundation\Response;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -201,7 +203,6 @@ private function refactorClassMethod(
             $classMethod,
             &$hasChanged
         ): ?int {
-
             // keep as similar type
             if ($node instanceof Closure || $node instanceof Function_) {
                 return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
@@ -312,7 +313,14 @@ private function refactorReturnWithValue(
 
         $returnStaticType = $this->getType($lastReturnExpr);
 
-        if (! $return->expr instanceof MethodCall) {
+        // is new response? keep it
+        $isResponseType = false;
+        if ($return->expr instanceof New_) {
+            $new = $return->expr;
+            if ($this->isObjectType($new->class, new ObjectType(Response::class))) {
+                $isResponseType = true;
+            }
+        } elseif (! $return->expr instanceof MethodCall) {
             if (! $hasThisRenderOrReturnsResponse || $returnStaticType instanceof ConstantArrayType) {
                 $return->expr = $thisRenderMethodCall;
             }
@@ -329,13 +337,14 @@ private function refactorReturnWithValue(
         );
 
         // skip as the original class method has to change first
-        if ($isArrayOrResponseType) {
+        if ($isArrayOrResponseType && $isResponseType === false) {
             return false;
         }
 
         // already response
         $this->removeDoctrineAnnotationTagValueNode($classMethod, $doctrineTagValueNodeOrAttribute);
         $this->returnTypeDeclarationUpdater->updateClassMethod($classMethod, SymfonyClass::RESPONSE);
+
         return true;
     }
 

src/NodeFactory/Annotations/AnnotationOrAttributeValueResolver.php

@@ -4,6 +4,7 @@
 
 namespace Rector\Symfony\NodeFactory\Annotations;
 
+use PhpParser\Node\Identifier;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\Scalar\String_;
@@ -64,7 +65,7 @@ public function resolve(
 
     private function isKeyEmptyOrMatch(Arg $attributeArg, string $desiredKey): bool
     {
-        if ($attributeArg->name === null) {
+        if (!$attributeArg->name instanceof Identifier) {
             return true;
         }
 

stubs/Symfony/Bundle/FrameworkExtraBundle/Configuration/Template.php

@@ -5,4 +5,8 @@
 #[\Attribute]
 class Template
 {
+    public function __construct(string $templatePath)
+    {
+
+    }
 }

stubs/Symfony/Component/HttpFoundation/JsonResponse.php

@@ -8,4 +8,7 @@
 
 class JsonResponse extends Response
 {
+    public function __construct(array $items, int $status = 200, array $headers = [], bool $json = false)
+    {
+    }
 }