Skip to content

[JsonStreamer] Add number object support #59915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[JsonStreamer] Add number object support #59915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 36 additions & 20 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/json_streamer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,14 @@
use Symfony\Component\JsonStreamer\Mapping\GenericTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Read\AttributePropertyMetadataLoader as ReadAttributePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Read\DateTimeTypePropertyMetadataLoader as ReadDateTimeTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Read\ValueObjectTypePropertyMetadataLoader as ReadValueObjectTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Write\AttributePropertyMetadataLoader as WriteAttributePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Write\DateTimeTypePropertyMetadataLoader as WriteDateTimeTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Write\ValueObjectTypePropertyMetadataLoader as WriteValueObjectTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\ValueTransformer\BcMathNumberToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\DateTimeToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\GmpNumberToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToBcMathNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToGmpNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\StringToDateTimeValueTransformer;

return static function (ContainerConfigurator $container) {
Expand All @@ -48,55 +52,67 @@
->args([
service('type_info.resolver'),
])
->set('.json_streamer.write.property_metadata_loader.generic', GenericTypePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader')
->set('.json_streamer.write.property_metadata_loader.attribute', WriteAttributePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader', null, 512)
->args([
service('.inner'),
service('type_info.type_context_factory'),
tagged_locator('json_streamer.value_transformer'),
service('type_info.resolver'),
])
->set('.json_streamer.write.property_metadata_loader.date_time', WriteDateTimeTypePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader')
->set('.json_streamer.write.property_metadata_loader.generic', GenericTypePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader', null, 256)
->args([
service('.inner'),
service('type_info.type_context_factory'),
])
->set('.json_streamer.write.property_metadata_loader.attribute', WriteAttributePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader')
->set('.json_streamer.write.property_metadata_loader.value_object', WriteValueObjectTypePropertyMetadataLoader::class)
->decorate('json_streamer.write.property_metadata_loader', null, 128)
->args([
service('.inner'),
tagged_locator('json_streamer.value_transformer'),
service('type_info.resolver'),
])

->set('json_streamer.read.property_metadata_loader', PropertyMetadataLoader::class)
->args([
service('type_info.resolver'),
])
->set('.json_streamer.read.property_metadata_loader.generic', GenericTypePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader')
->set('.json_streamer.read.property_metadata_loader.attribute', ReadAttributePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader', null, 512)
->args([
service('.inner'),
service('type_info.type_context_factory'),
tagged_locator('json_streamer.value_transformer'),
service('type_info.resolver'),
])
->set('.json_streamer.read.property_metadata_loader.date_time', ReadDateTimeTypePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader')
->set('.json_streamer.read.property_metadata_loader.generic', GenericTypePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader', null, 256)
->args([
service('.inner'),
service('type_info.type_context_factory'),
])
->set('.json_streamer.read.property_metadata_loader.attribute', ReadAttributePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader')
->set('.json_streamer.read.property_metadata_loader.value_object', ReadValueObjectTypePropertyMetadataLoader::class)
->decorate('json_streamer.read.property_metadata_loader', null, 128)
->args([
service('.inner'),
tagged_locator('json_streamer.value_transformer'),
service('type_info.resolver'),
])

// value transformers
->set('json_streamer.value_transformer.date_time_to_string', DateTimeToStringValueTransformer::class)
->tag('json_streamer.value_transformer')

->set('json_streamer.value_transformer.bc_math_number_to_string', BcMathNumberToStringValueTransformer::class)
->tag('json_streamer.value_transformer')

->set('json_streamer.value_transformer.gmp_number_to_string', GmpNumberToStringValueTransformer::class)
->tag('json_streamer.value_transformer')

->set('json_streamer.value_transformer.string_to_date_time', StringToDateTimeValueTransformer::class)
->tag('json_streamer.value_transformer')

->set('json_streamer.value_transformer.int_string_to_bc_math_number', IntStringToBcMathNumberValueTransformer::class)
->tag('json_streamer.value_transformer')

->set('json_streamer.value_transformer.int_string_to_gmp_number', IntStringToGmpNumberValueTransformer::class)
->tag('json_streamer.value_transformer')

// cache
->set('.json_streamer.cache_warmer.streamer', StreamerCacheWarmer::class)
->args([
Expand Down
16 changes: 14 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Functional/JsonStreamerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,16 @@ protected function setUp(): void

public function testWrite()
{
$dummy = new Dummy();
$dummy->dateTime = new \DateTimeImmutable('2025-11-20', new \DateTimeZone('UTC'));

/** @var StreamWriterInterface $writer */
$writer = static::getContainer()->get('json_streamer.stream_writer.alias');

$this->assertSame('{"@name":"DUMMY","range":"10..20"}', (string) $writer->write(new Dummy(), Type::object(Dummy::class)));
$this->assertSame(
'{"@name":"DUMMY","range":"10..20","dateTime":"2025-11-20T00:00:00+00:00"}',
(string) $writer->write($dummy, Type::object(Dummy::class)),
);
}

public function testRead()
Expand All @@ -43,8 +49,14 @@ public function testRead()
$expected = new Dummy();
$expected->name = 'dummy';
$expected->range = [0, 1];
$expected->dateTime = new \DateTimeImmutable('2025-11-20');

$actual = $reader->read('{"@name": "DUMMY", "range": "0..1","dateTime":"2025-11-20"}', Type::object(Dummy::class));

$this->assertEquals($expected, $reader->read('{"@name": "DUMMY", "range": "0..1"}', Type::object(Dummy::class)));
$this->assertInstanceOf(Dummy::class, $actual);
$this->assertSame('dummy', $actual->name);
$this->assertSame([0, 1], $actual->range);
$this->assertSame('2025-11-20', $actual->dateTime->format('Y-m-d'));
}

public function testWarmupStreamableClasses()
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonStreamer/Dto/Dummy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@ class Dummy
streamToNative: StringToRangeValueTransformer::class,
)]
public array $range = [10, 20];

public \DateTimeInterface|bool $dateTime = false;
}
12 changes: 8 additions & 4 deletions src/Symfony/Component/JsonStreamer/JsonStreamReader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoaderInterface;
use Symfony\Component\JsonStreamer\Mapping\Read\AttributePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Read\DateTimeTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Read\ValueObjectTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Read\Instantiator;
use Symfony\Component\JsonStreamer\Read\LazyInstantiator;
use Symfony\Component\JsonStreamer\Read\StreamReaderGenerator;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToBcMathNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToGmpNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\StringToDateTimeValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\ValueTransformerInterface;
use Symfony\Component\TypeInfo\Type;
Expand Down Expand Up @@ -69,6 +71,8 @@ public static function create(array $valueTransformers = [], ?string $streamRead
$lazyGhostsDir ??= sys_get_temp_dir().'/json_streamer/lazy_ghost';
$valueTransformers += [
'json_streamer.value_transformer.string_to_date_time' => new StringToDateTimeValueTransformer(),
'json_streamer.value_transformer.int_string_to_bc_math_number' => new IntStringToBcMathNumberValueTransformer(),
'json_streamer.value_transformer.int_string_to_gmp_number' => new IntStringToGmpNumberValueTransformer(),
];

$valueTransformersContainer = new class($valueTransformers) implements ContainerInterface {
Expand All @@ -90,15 +94,15 @@ public function get(string $id): ValueTransformerInterface

$typeContextFactory = new TypeContextFactory(class_exists(PhpDocParser::class) ? new StringTypeResolver() : null);

$propertyMetadataLoader = new GenericTypePropertyMetadataLoader(
new DateTimeTypePropertyMetadataLoader(
$propertyMetadataLoader = new ValueObjectTypePropertyMetadataLoader(
new GenericTypePropertyMetadataLoader(
new AttributePropertyMetadataLoader(
new PropertyMetadataLoader(TypeResolver::create()),
$valueTransformersContainer,
TypeResolver::create(),
),
$typeContextFactory,
),
$typeContextFactory,
);

return new self($valueTransformersContainer, $propertyMetadataLoader, $streamReadersDir, $lazyGhostsDir);
Expand Down
12 changes: 8 additions & 4 deletions src/Symfony/Component/JsonStreamer/JsonStreamWriter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoaderInterface;
use Symfony\Component\JsonStreamer\Mapping\Write\AttributePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Write\DateTimeTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\Mapping\Write\ValueObjectTypePropertyMetadataLoader;
use Symfony\Component\JsonStreamer\ValueTransformer\BcMathNumberToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\DateTimeToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\GmpNumberToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\ValueTransformerInterface;
use Symfony\Component\JsonStreamer\Write\StreamWriterGenerator;
use Symfony\Component\TypeInfo\Type;
Expand Down Expand Up @@ -88,6 +90,8 @@ public static function create(array $valueTransformers = [], ?string $streamWrit
$streamWritersDir ??= sys_get_temp_dir().'/json_streamer/write';
$valueTransformers += [
'json_streamer.value_transformer.date_time_to_string' => new DateTimeToStringValueTransformer(),
'json_streamer.value_transformer.bc_math_number_to_string' => new BcMathNumberToStringValueTransformer(),
'json_streamer.value_transformer.gmp_number_to_string' => new GmpNumberToStringValueTransformer(),
];

$valueTransformersContainer = new class($valueTransformers) implements ContainerInterface {
Expand All @@ -109,15 +113,15 @@ public function get(string $id): ValueTransformerInterface

$typeContextFactory = new TypeContextFactory(class_exists(PhpDocParser::class) ? new StringTypeResolver() : null);

$propertyMetadataLoader = new GenericTypePropertyMetadataLoader(
new DateTimeTypePropertyMetadataLoader(
$propertyMetadataLoader = new ValueObjectTypePropertyMetadataLoader(
new GenericTypePropertyMetadataLoader(
Copy link
Member

@stof stof Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why changing the order of decorators ?

new AttributePropertyMetadataLoader(
new PropertyMetadataLoader(TypeResolver::create()),
$valueTransformersContainer,
TypeResolver::create(),
),
$typeContextFactory,
),
$typeContextFactory,
);

return new self($valueTransformersContainer, $propertyMetadataLoader, $streamWritersDir);
Expand Down
4 changes: 0 additions & 4 deletions src/Symfony/Component/JsonStreamer/Mapping/PropertyMetadata.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,7 @@ public function withNativeToStreamValueTransformers(array $nativeToStreamValueTr
public function withAdditionalNativeToStreamValueTransformer(string|\Closure $nativeToStreamValueTransformer): self
{
$nativeToStreamValueTransformers = $this->nativeToStreamValueTransformers;

$nativeToStreamValueTransformers[] = $nativeToStreamValueTransformer;
$nativeToStreamValueTransformers = array_values(array_unique($nativeToStreamValueTransformers));
Copy link
Contributor Author

@mtarld mtarld Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stop trying to make value transformers unique, as it does not add any value, and didn't work anyway because \Closure aren't castable to string.


return $this->withNativeToStreamValueTransformers($nativeToStreamValueTransformers);
}
Expand All @@ -99,9 +97,7 @@ public function withStreamToNativeValueTransformers(array $streamToNativeValueTr
public function withAdditionalStreamToNativeValueTransformer(string|\Closure $streamToNativeValueTransformer): self
{
$streamToNativeValueTransformers = $this->streamToNativeValueTransformers;

$streamToNativeValueTransformers[] = $streamToNativeValueTransformer;
$streamToNativeValueTransformers = array_values(array_unique($streamToNativeValueTransformers));

return $this->withStreamToNativeValueTransformers($streamToNativeValueTransformers);
}
Expand Down
53 changes: 0 additions & 53 deletions src/Symfony/Component/JsonStreamer/Mapping/Read/DateTimeTypePropertyMetadataLoader.php
View file
Open in desktop

This file was deleted.

77 changes: 77 additions & 0 deletions src/Symfony/Component/JsonStreamer/Mapping/Read/ValueObjectTypePropertyMetadataLoader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\JsonStreamer\Mapping\Read;

use BcMath\Number;
use Symfony\Component\JsonStreamer\Exception\InvalidArgumentException;
use Symfony\Component\JsonStreamer\Mapping\PropertyMetadataLoaderInterface;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToBcMathNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\IntStringToGmpNumberValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\StringToDateTimeValueTransformer;
use Symfony\Component\TypeInfo\Type;
use Symfony\Component\TypeInfo\Type\UnionType;

/**
* Transforms scalar to value object.
*
* @author Mathias Arlaud <mathias.arlaud@gmail.com>
*
* @internal
*/
final class ValueObjectTypePropertyMetadataLoader implements PropertyMetadataLoaderInterface
Copy link
Member

@chalasr chalasr Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be split as well for the same reasons (#59915 (comment))?

{
public function __construct(
private PropertyMetadataLoaderInterface $decorated,
) {
}

public function load(string $className, array $options = [], array $context = []): array
{
$result = $this->decorated->load($className, $options, $context);

foreach ($result as &$metadata) {
$type = $metadata->getType();
$newTypeParts = [];

foreach ($type instanceof UnionType ? $type->getTypes() : [$type] as $t) {
$newTypePart = $t;

if ($t->isIdentifiedBy(\DateTimeInterface::class)) {
if ($t->isIdentifiedBy(\DateTime::class)) {
throw new InvalidArgumentException('The "DateTime" class is not supported. Use "DateTimeImmutable" instead.');
}

$metadata = $metadata->withAdditionalStreamToNativeValueTransformer('json_streamer.value_transformer.string_to_date_time');
$newTypePart = StringToDateTimeValueTransformer::getStreamValueType();
} elseif ($t->isIdentifiedBy(Number::class)) {
$metadata = $metadata->withAdditionalStreamToNativeValueTransformer('json_streamer.value_transformer.int_string_to_bc_math_number');
$newTypePart = IntStringToBcMathNumberValueTransformer::getStreamValueType();
} elseif ($t->isIdentifiedBy(\GMP::class)) {
$metadata = $metadata->withAdditionalStreamToNativeValueTransformer('json_streamer.value_transformer.int_string_to_gmp_number');
$newTypePart = IntStringToGmpNumberValueTransformer::getStreamValueType();
}

$newTypeParts = [
...$newTypeParts,
...($newTypePart instanceof UnionType ? $newTypePart->getTypes() : [$newTypePart]),
];
}

$newTypeParts = array_values(array_unique($newTypeParts));
$newType = \count($newTypeParts) > 1 ? Type::union(...$newTypeParts) : $newTypeParts[0];

$metadata = $metadata->withType($newType);
}

return $result;
}
}
Loading
Loading