bug #45554 [Serializer] Fixed framework.serializer.default_context is not working for JsonEncoder (siganushka)

nicolas-grekas · nicolas-grekas · commit caad8ec14cbd · 2022-09-28T17:19:40.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Serializer] Fixed framework.serializer.default_context is not working for JsonEncoder Fixed `framework.serializer.default_context` is not working for `JsonEncoder` like `XmlEncoder` or `DateTimeNormalizer`, the `array $defaultContext` argument bindings from `SerializerPass`, but not working for `JsonEncoder`, I added `array $defaultContext` argument and passed to `JsonEncode` and `JsonDecode`. https://github.com/symfony/serializer/blob/5.4/DependencyInjection/SerializerPass.php#L69-L75 | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no Commits ------- a76016a [Serializer] Fixed framework.serializer.default_context is not working for JsonEncoder
diff --git a/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php b/src/Symfony/Component/Serializer/Encoder/JsonEncoder.php
@@ -23,10 +23,10 @@ class JsonEncoder implements EncoderInterface, DecoderInterface
     protected $encodingImpl;
     protected $decodingImpl;
 
-    public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null)
+    public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null, array $defaultContext = [])
     {
-        $this->encodingImpl = $encodingImpl ?? new JsonEncode();
-        $this->decodingImpl = $decodingImpl ?? new JsonDecode([JsonDecode::ASSOCIATIVE => true]);
+        $this->encodingImpl = $encodingImpl ?? new JsonEncode($defaultContext);
+        $this->decodingImpl = $decodingImpl ?? new JsonDecode(array_merge([JsonDecode::ASSOCIATIVE => true], $defaultContext));
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/JsonEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/JsonEncoderTest.php
@@ -66,6 +66,22 @@ public function testOptions()
         $this->assertEquals($expected, $this->serializer->serialize($arr, 'json'), 'Context should not be persistent');
     }
 
+    public function testWithDefaultContext()
+    {
+        $defaultContext = [
+            'json_encode_options' => \JSON_UNESCAPED_UNICODE,
+            'json_decode_associative' => false,
+        ];
+
+        $encoder = new JsonEncoder(null, null, $defaultContext);
+
+        $data = new \stdClass();
+        $data->msg = '你好';
+
+        $this->assertEquals('{"msg":"你好"}', $json = $encoder->encode($data, 'json'));
+        $this->assertEquals($data, $encoder->decode($json, 'json'));
+    }
+
     public function testEncodeNotUtf8WithoutPartialOnError()
     {
         $this->expectException(UnexpectedValueException::class);

Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,10 @@ class JsonEncoder implements EncoderInterface, DecoderInterface`
`23`	`23`	`protected $encodingImpl;`
`24`	`24`	`protected $decodingImpl;`
`25`	`25`
`26`		`- public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null)`
	`26`	`+ public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null, array $defaultContext = [])`
`27`	`27`	`{`
`28`		`- $this->encodingImpl = $encodingImpl ?? new JsonEncode();`
`29`		`- $this->decodingImpl = $decodingImpl ?? new JsonDecode([JsonDecode::ASSOCIATIVE => true]);`
	`28`	`+ $this->encodingImpl = $encodingImpl ?? new JsonEncode($defaultContext);`
	`29`	`+ $this->decodingImpl = $decodingImpl ?? new JsonDecode(array_merge([JsonDecode::ASSOCIATIVE => true], $defaultContext));`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`