bug #36340 [Serializer] Fix configuration of the cache key (dunglas)

fabpot · fabpot · commit 66b9fef4ac52 · 2020-08-17T08:10:54.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [Serializer] Fix configuration of the cache key | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #35574 doctrine/orm#8030 (partially) | License | MIT | Doc PR | n/a Currently, a bug prevents to configure the context keys to exclude from the cache key computation. The value is always replaced in the constructor. This PR fixes the problem. Commits ------- 3b034cb [Serializer] Fix configuration of the cache key
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -115,7 +115,7 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory
             throw new InvalidArgumentException(sprintf('The "%s" given in the default context is not callable.', self::MAX_DEPTH_HANDLER));
         }
 
-        $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] = [self::CIRCULAR_REFERENCE_LIMIT_COUNTERS];
+        $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] = array_merge($this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] ?? [], [self::CIRCULAR_REFERENCE_LIMIT_COUNTERS]);
 
         $this->propertyTypeExtractor = $propertyTypeExtractor;
 
@@ -360,7 +360,7 @@ public function denormalize($data, $type, $format = null, array $context = [])
             try {
                 $this->setAttributeValue($object, $attribute, $value, $format, $context);
             } catch (InvalidArgumentException $e) {
-                throw new NotNormalizableValueException(sprintf('Failed to denormalize attribute "%s" value for class "%s": ', $attribute, $type).$e->getMessage(), $e->getCode(), $e);
+                throw new NotNormalizableValueException(sprintf('Failed to denormalize attribute "%s" value for class "%s": '.$e->getMessage(), $attribute, $type), $e->getCode(), $e);
             }
         }
 
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -741,6 +741,17 @@ public function testNormalizeNotSerializableContext()
         }]));
     }
 
+    public function testDefaultExcludeFromCacheKey()
+    {
+        $normalizer = new class(null, null, null, null, null, null, [ObjectNormalizer::EXCLUDE_FROM_CACHE_KEY => ['foo']]) extends ObjectNormalizer {
+            protected function isCircularReference($object, &$context)
+            {
+                ObjectNormalizerTest::assertContains('foo', $this->defaultContext[ObjectNormalizer::EXCLUDE_FROM_CACHE_KEY]);
+            }
+        };
+        $normalizer->normalize(new ObjectDummy());
+    }
+
     public function testThrowUnexpectedValueException()
     {
         $this->expectException('Symfony\Component\Serializer\Exception\UnexpectedValueException');

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory`
`115`	`115`	`throw new InvalidArgumentException(sprintf('The "%s" given in the default context is not callable.', self::MAX_DEPTH_HANDLER));`
`116`	`116`	`}`
`117`	`117`
`118`		`- $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] = [self::CIRCULAR_REFERENCE_LIMIT_COUNTERS];`
	`118`	`+ $this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] = array_merge($this->defaultContext[self::EXCLUDE_FROM_CACHE_KEY] ?? [], [self::CIRCULAR_REFERENCE_LIMIT_COUNTERS]);`
`119`	`119`
`120`	`120`	`$this->propertyTypeExtractor = $propertyTypeExtractor;`
`121`	`121`
`@@ -360,7 +360,7 @@ public function denormalize($data, $type, $format = null, array $context = [])`
`360`	`360`	`try {`
`361`	`361`	`$this->setAttributeValue($object, $attribute, $value, $format, $context);`
`362`	`362`	`} catch (InvalidArgumentException $e) {`
`363`		`- throw new NotNormalizableValueException(sprintf('Failed to denormalize attribute "%s" value for class "%s": ', $attribute, $type).$e->getMessage(), $e->getCode(), $e);`
	`363`	`+ throw new NotNormalizableValueException(sprintf('Failed to denormalize attribute "%s" value for class "%s": '.$e->getMessage(), $attribute, $type), $e->getCode(), $e);`
`364`	`364`	`}`
`365`	`365`	`}`
`366`	`366`