bug #62407 [FrameworkBundle] work around limitation in JsonResponse when the data is null (xabbuh)

nicolas-grekas · nicolas-grekas · commit ec4e5a7b59ab · 2025-11-16T10:59:51.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [FrameworkBundle] work around limitation in `JsonResponse` when the data is `null` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #62404 | License | MIT I did abstain from fixing this in `JsonResponse` since https://github.com/symfony/symfony/blob/6769c4c670736adad5d77fe02c25f313e10971b6/src/Symfony/Component/HttpFoundation/JsonResponse.php#L47 has been there for years since 2d07a17 Commits ------- c0287d5 work around limitation in JsonResponse when the data is null
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
@@ -157,6 +157,10 @@ protected function json(mixed $data, int $status = 200, array $headers = [], arr
             return new JsonResponse($json, $status, $headers, true);
         }
 
+        if (null === $data) {
+            return new JsonResponse('null', $status, $headers, true);
+        }
+
         return new JsonResponse($data, $status, $headers);
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php
@@ -224,6 +224,37 @@ public function testJsonWithSerializerContextOverride()
         $this->assertEquals('{}', $response->getContent());
     }
 
+    public function testJsonNull()
+    {
+        $controller = $this->createController();
+        $controller->setContainer(new Container());
+
+        $response = $controller->json(null);
+        $this->assertInstanceOf(JsonResponse::class, $response);
+        $this->assertSame('null', $response->getContent());
+    }
+
+    public function testJsonNullWithSerializer()
+    {
+        $container = new Container();
+
+        $serializer = $this->createMock(SerializerInterface::class);
+        $serializer
+            ->expects($this->once())
+            ->method('serialize')
+            ->with(null, 'json', ['json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS])
+            ->willReturn('null');
+
+        $container->set('serializer', $serializer);
+
+        $controller = $this->createController();
+        $controller->setContainer($container);
+
+        $response = $controller->json(null);
+        $this->assertInstanceOf(JsonResponse::class, $response);
+        $this->assertSame('null', $response->getContent());
+    }
+
     public function testFile()
     {
         $container = new Container();

Original file line number	Diff line number	Diff line change
`@@ -157,6 +157,10 @@ protected function json(mixed $data, int $status = 200, array $headers = [], arr`
`157`	`157`	`return new JsonResponse($json, $status, $headers, true);`
`158`	`158`	`}`
`159`	`159`
	`160`	`+ if (null === $data) {`
	`161`	`+ return new JsonResponse('null', $status, $headers, true);`
	`162`	`+ }`
	`163`	`+`
`160`	`164`	`return new JsonResponse($data, $status, $headers);`
`161`	`165`	`}`
`162`	`166`