[JsonStreamer] Merge PropertyMetadata value transformers

mtarld · nicolas-grekas · commit 3cd9483448be · 2025-10-24T15:47:31.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ CHANGELOG
  * Add `_current_object` to the context passed to value transformers during write operations
  * Add `include_null_properties` option to encode the properties with `null` value
  * Add synthetic properties support
+ * Deprecate `PropertyMetadata::$streamToNativeValueTransformers`, use `PropertyMetadata::$valueTransformers` instead
+ * Deprecate `PropertyMetadata::getNativeToStreamValueTransformer()` and `PropertyMetadata::getStreamToNativeValueTransformers()`, use `PropertyMetadata::getValueTransformers()` instead
+ * Deprecate `PropertyMetadata::withNativeToStreamValueTransformers()` and `PropertyMetadata::withStreamToNativeValueTransformers()`, use `PropertyMetadata::withValueTransformers()` instead
+ * Deprecate `PropertyMetadata::withAdditionalNativeToStreamValueTransformer()` and `PropertyMetadata::withAdditionalStreamToNativeValueTransformer`, use `PropertyMetadata::withAdditionalValueTransformer()` instead
 
 7.3
 ---
diff --git a/Mapping/PropertyMetadata.php b/Mapping/PropertyMetadata.php
@@ -20,16 +20,23 @@
  */
 final class PropertyMetadata
 {
+    private ?array $streamToNativeValueTransformers;
+
     /**
-     * @param list<string|\Closure> $nativeToStreamValueTransformers
-     * @param list<string|\Closure> $streamToNativeValueTransformers
+     * @param list<string|\Closure>      $valueTransformers
+     * @param list<string|\Closure>|null $streamToNativeValueTransformers
      */
     public function __construct(
         private ?string $name,
         private Type $type,
-        private array $nativeToStreamValueTransformers = [],
-        private array $streamToNativeValueTransformers = [],
+        private array $valueTransformers = [],
+        ?array $streamToNativeValueTransformers = null,
     ) {
+        if (null !== $streamToNativeValueTransformers) {
+            trigger_deprecation('symfony/json-streamer', '7.4', 'The "streamToNativeValueTransformers" parameter of the "%s()" method is deprecated. Use "valueTransformers" instead.', __METHOD__);
+        }
+
+        $this->streamToNativeValueTransformers = $streamToNativeValueTransformers;
     }
 
     /**
@@ -51,7 +58,7 @@ public function getName(): ?string
 
     public function withName(?string $name): self
     {
-        return new self($name, $this->type, $this->nativeToStreamValueTransformers, $this->streamToNativeValueTransformers);
+        return new self($name, $this->type, $this->valueTransformers, $this->streamToNativeValueTransformers);
     }
 
     public function getType(): Type
@@ -61,28 +68,67 @@ public function getType(): Type
 
     public function withType(Type $type): self
     {
-        return new self($this->name, $type, $this->nativeToStreamValueTransformers, $this->streamToNativeValueTransformers);
+        return new self($this->name, $type, $this->valueTransformers, $this->streamToNativeValueTransformers);
+    }
+
+    /**
+     * @return list<string|\Closure>
+     */
+    public function getValueTransformers(): array
+    {
+        return $this->valueTransformers;
+    }
+
+    /**
+     * @param list<string|\Closure> $valueTransformers
+     */
+    public function withValueTransformers(array $valueTransformers): self
+    {
+        return new self($this->name, $this->type, $valueTransformers);
+    }
+
+    public function withAdditionalValueTransformer(string|\Closure $valueTransformer): self
+    {
+        $valueTransformers = $this->valueTransformers;
+
+        $valueTransformers[] = $valueTransformer;
+        $valueTransformers = array_values(array_unique($valueTransformers));
+
+        return $this->withValueTransformers($valueTransformers);
     }
 
     /**
+     * @deprecated since Symfony 7.4, use "getValueTransformers" instead
+     *
      * @return list<string|\Closure>
      */
     public function getNativeToStreamValueTransformer(): array
     {
-        return $this->nativeToStreamValueTransformers;
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::getValueTransformers()" instead.', __METHOD__, self::class);
+
+        return $this->valueTransformers;
     }
 
     /**
+     * @deprecated since Symfony 7.4, use "withValueTransformers" instead
+     *
      * @param list<string|\Closure> $nativeToStreamValueTransformers
      */
     public function withNativeToStreamValueTransformers(array $nativeToStreamValueTransformers): self
     {
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::withValueTransformers()" instead.', __METHOD__, self::class);
+
         return new self($this->name, $this->type, $nativeToStreamValueTransformers, $this->streamToNativeValueTransformers);
     }
 
+    /**
+     * @deprecated since Symfony 7.4, use "withAdditionalValueTransformer" instead
+     */
     public function withAdditionalNativeToStreamValueTransformer(string|\Closure $nativeToStreamValueTransformer): self
     {
-        $nativeToStreamValueTransformers = $this->nativeToStreamValueTransformers;
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::withAdditionalValueTransformer()" instead.', __METHOD__, self::class);
+
+        $nativeToStreamValueTransformers = $this->valueTransformers;
 
         $nativeToStreamValueTransformers[] = $nativeToStreamValueTransformer;
         $nativeToStreamValueTransformers = array_values(array_unique($nativeToStreamValueTransformers));
@@ -91,24 +137,37 @@ public function withAdditionalNativeToStreamValueTransformer(string|\Closure $na
     }
 
     /**
+     * @deprecated since Symfony 7.4, use "getValueTransformers" instead
+     *
      * @return list<string|\Closure>
      */
     public function getStreamToNativeValueTransformers(): array
     {
-        return $this->streamToNativeValueTransformers;
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::getValueTransformers()" instead.', __METHOD__, self::class);
+
+        return $this->streamToNativeValueTransformers ?? [];
     }
 
     /**
+     * @deprecated since Symfony 7.4, use "withValueTransformers" instead
+     *
      * @param list<string|\Closure> $streamToNativeValueTransformers
      */
     public function withStreamToNativeValueTransformers(array $streamToNativeValueTransformers): self
     {
-        return new self($this->name, $this->type, $this->nativeToStreamValueTransformers, $streamToNativeValueTransformers);
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::withValueTransformers()" instead.', __METHOD__, self::class);
+
+        return new self($this->name, $this->type, $this->valueTransformers, $streamToNativeValueTransformers);
     }
 
+    /**
+     * @deprecated since Symfony 7.4, use "withAdditionalValueTransformer" instead
+     */
     public function withAdditionalStreamToNativeValueTransformer(string|\Closure $streamToNativeValueTransformer): self
     {
-        $streamToNativeValueTransformers = $this->streamToNativeValueTransformers;
+        trigger_deprecation('symfony/json-streamer', '7.4', 'The "%s()" method is deprecated, use "%s::withAdditionalValueTransformer()" instead.', __METHOD__, self::class);
+
+        $streamToNativeValueTransformers = $this->streamToNativeValueTransformers ?? [];
 
         $streamToNativeValueTransformers[] = $streamToNativeValueTransformer;
         $streamToNativeValueTransformers = array_values(array_unique($streamToNativeValueTransformers));
diff --git a/Mapping/Read/AttributePropertyMetadataLoader.php b/Mapping/Read/AttributePropertyMetadataLoader.php
@@ -66,7 +66,7 @@ public function load(string $className, array $options = [], array $context = []
 
                 $result[$streamedName] = $initialMetadata
                     ->withType($valueTransformerService::getStreamValueType())
-                    ->withAdditionalStreamToNativeValueTransformer($valueTransformer);
+                    ->withAdditionalValueTransformer($valueTransformer);
 
                 continue;
             }
@@ -83,7 +83,7 @@ public function load(string $className, array $options = [], array $context = []
 
             $result[$streamedName] = $initialMetadata
                 ->withType($this->typeResolver->resolve($parameterReflection))
-                ->withAdditionalStreamToNativeValueTransformer($valueTransformer);
+                ->withAdditionalValueTransformer($valueTransformer);
         }
 
         return $result;
diff --git a/Mapping/Read/DateTimeTypePropertyMetadataLoader.php b/Mapping/Read/DateTimeTypePropertyMetadataLoader.php
@@ -44,7 +44,7 @@ public function load(string $className, array $options = [], array $context = []
 
                 $metadata = $metadata
                     ->withType(StringToDateTimeValueTransformer::getStreamValueType())
-                    ->withAdditionalStreamToNativeValueTransformer('json_streamer.value_transformer.string_to_date_time');
+                    ->withAdditionalValueTransformer('json_streamer.value_transformer.string_to_date_time');
             }
         }
 
diff --git a/Mapping/Write/AttributePropertyMetadataLoader.php b/Mapping/Write/AttributePropertyMetadataLoader.php
@@ -66,7 +66,7 @@ public function load(string $className, array $options = [], array $context = []
 
                 $result[$streamedName] = $initialMetadata
                     ->withType($valueTransformerService::getStreamValueType())
-                    ->withAdditionalNativeToStreamValueTransformer($valueTransformer);
+                    ->withAdditionalValueTransformer($valueTransformer);
 
                 continue;
             }
@@ -79,7 +79,7 @@ public function load(string $className, array $options = [], array $context = []
 
             $result[$streamedName] = $initialMetadata
                 ->withType($this->typeResolver->resolve($valueTransformerReflection))
-                ->withAdditionalNativeToStreamValueTransformer($valueTransformer);
+                ->withAdditionalValueTransformer($valueTransformer);
         }
 
         return $result;
diff --git a/Mapping/Write/DateTimeTypePropertyMetadataLoader.php b/Mapping/Write/DateTimeTypePropertyMetadataLoader.php
@@ -39,7 +39,7 @@ public function load(string $className, array $options = [], array $context = []
             if ($type instanceof ObjectType && is_a($type->getClassName(), \DateTimeInterface::class, true)) {
                 $metadata = $metadata
                     ->withType(DateTimeToStringValueTransformer::getStreamValueType())
-                    ->withAdditionalNativeToStreamValueTransformer('json_streamer.value_transformer.date_time_to_string');
+                    ->withAdditionalValueTransformer('json_streamer.value_transformer.date_time_to_string');
             }
         }
 
diff --git a/Read/StreamReaderGenerator.php b/Read/StreamReaderGenerator.php
@@ -135,7 +135,7 @@ private function createDataModel(Type $type, array $options = [], array $context
                     'name' => $propertyMetadata->getName(),
                     'value' => $this->createDataModel($propertyMetadata->getType(), $options, $context),
                     'accessor' => function (string $accessor) use ($propertyMetadata): string {
-                        foreach ($propertyMetadata->getStreamToNativeValueTransformers() as $valueTransformer) {
+                        foreach ($propertyMetadata->getValueTransformers() as $valueTransformer) {
                             if (\is_string($valueTransformer)) {
                                 $accessor = "\$valueTransformers->get('$valueTransformer')->transform($accessor, \$options)";
 
diff --git a/Tests/Mapping/Read/AttributePropertyMetadataLoaderTest.php b/Tests/Mapping/Read/AttributePropertyMetadataLoaderTest.php
@@ -42,10 +42,10 @@ public function testRetrieveValueTransformer()
         ]), TypeResolver::create());
 
         $this->assertEquals([
-            'id' => new PropertyMetadata('id', Type::string(), [], [DivideStringAndCastToIntValueTransformer::class]),
-            'active' => new PropertyMetadata('active', Type::string(), [], [StringToBooleanValueTransformer::class]),
-            'name' => new PropertyMetadata('name', Type::string(), [], [\Closure::fromCallable('strtoupper')]),
-            'range' => new PropertyMetadata('range', Type::string(), [], [\Closure::fromCallable(DummyWithValueTransformerAttributes::explodeRange(...))]),
+            'id' => new PropertyMetadata('id', Type::string(), [DivideStringAndCastToIntValueTransformer::class]),
+            'active' => new PropertyMetadata('active', Type::string(), [StringToBooleanValueTransformer::class]),
+            'name' => new PropertyMetadata('name', Type::string(), [\Closure::fromCallable('strtoupper')]),
+            'range' => new PropertyMetadata('range', Type::string(), [\Closure::fromCallable(DummyWithValueTransformerAttributes::explodeRange(...))]),
         ], $loader->load(DummyWithValueTransformerAttributes::class));
     }
 
diff --git a/Tests/Mapping/Read/DateTimeTypePropertyMetadataLoaderTest.php b/Tests/Mapping/Read/DateTimeTypePropertyMetadataLoaderTest.php
@@ -29,8 +29,8 @@ public function testAddStringToDateTimeValueTransformer()
         ]));
 
         $this->assertEquals([
-            'interface' => new PropertyMetadata('interface', Type::string(), [], ['json_streamer.value_transformer.string_to_date_time']),
-            'immutable' => new PropertyMetadata('immutable', Type::string(), [], ['json_streamer.value_transformer.string_to_date_time']),
+            'interface' => new PropertyMetadata('interface', Type::string(), ['json_streamer.value_transformer.string_to_date_time']),
+            'immutable' => new PropertyMetadata('immutable', Type::string(), ['json_streamer.value_transformer.string_to_date_time']),
             'other' => new PropertyMetadata('other', Type::object(self::class)),
         ], $loader->load(self::class));
     }
diff --git a/Write/StreamWriterGenerator.php b/Write/StreamWriterGenerator.php
@@ -135,7 +135,7 @@ private function createDataModel(Type $type, string $accessor, array $options =
             foreach ($propertiesMetadata as $streamedName => $propertyMetadata) {
                 $propertyAccessor = $propertyMetadata->getName() ? $accessor.'->'.$propertyMetadata->getName() : 'null';
 
-                foreach ($propertyMetadata->getNativeToStreamValueTransformer() as $valueTransformer) {
+                foreach ($propertyMetadata->getValueTransformers() as $valueTransformer) {
                     if (\is_string($valueTransformer)) {
                         $valueTransformerServiceAccessor = "\$valueTransformers->get('$valueTransformer')";
                         $propertyAccessor = "{$valueTransformerServiceAccessor}->transform($propertyAccessor, ['_current_object' => $accessor] + \$options)";
diff --git a/composer.json b/composer.json
@@ -19,6 +19,7 @@
         "php": ">=8.2",
         "psr/container": "^1.1|^2.0",
         "psr/log": "^1|^2|^3",
+        "symfony/deprecation-contracts": "^2.5|^3",
         "symfony/filesystem": "^7.2|^8.0",
         "symfony/type-info": "^7.3.3|^8.0",
         "symfony/var-exporter": "^7.2|^8.0"

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function load(string $className, array $options = [], array $context = []`
`66`	`66`
`67`	`67`	`$result[$streamedName] = $initialMetadata`
`68`	`68`	`->withType($valueTransformerService::getStreamValueType())`
`69`		`- ->withAdditionalStreamToNativeValueTransformer($valueTransformer);`
	`69`	`+ ->withAdditionalValueTransformer($valueTransformer);`
`70`	`70`
`71`	`71`	`continue;`
`72`	`72`	`}`
`@@ -83,7 +83,7 @@ public function load(string $className, array $options = [], array $context = []`
`83`	`83`
`84`	`84`	`$result[$streamedName] = $initialMetadata`
`85`	`85`	`->withType($this->typeResolver->resolve($parameterReflection))`
`86`		`- ->withAdditionalStreamToNativeValueTransformer($valueTransformer);`
	`86`	`+ ->withAdditionalValueTransformer($valueTransformer);`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`return $result;`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function load(string $className, array $options = [], array $context = []`
`44`	`44`
`45`	`45`	`$metadata = $metadata`
`46`	`46`	`->withType(StringToDateTimeValueTransformer::getStreamValueType())`
`47`		`- ->withAdditionalStreamToNativeValueTransformer('json_streamer.value_transformer.string_to_date_time');`
	`47`	`+ ->withAdditionalValueTransformer('json_streamer.value_transformer.string_to_date_time');`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function load(string $className, array $options = [], array $context = []`
`39`	`39`	`if ($type instanceof ObjectType && is_a($type->getClassName(), \DateTimeInterface::class, true)) {`
`40`	`40`	`$metadata = $metadata`
`41`	`41`	`->withType(DateTimeToStringValueTransformer::getStreamValueType())`
`42`		`- ->withAdditionalNativeToStreamValueTransformer('json_streamer.value_transformer.date_time_to_string');`
	`42`	`+ ->withAdditionalValueTransformer('json_streamer.value_transformer.date_time_to_string');`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`