[JsonStreamer] Skip properties with null value

mtarld · mtarld · commit 798233399baf · 2025-06-07T10:16:34.000+02:00
diff --git a/src/Symfony/Component/JsonStreamer/CHANGELOG.md b/src/Symfony/Component/JsonStreamer/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Remove `nikic/php-parser` dependency
+ * Skip properties with `null` value
 
 7.3
 ---
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/DummyWithDollarNamedProperties.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/DummyWithDollarNamedProperties.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\JsonStreamer\Tests\Fixtures\Model;
+
+use Symfony\Component\JsonStreamer\Attribute\StreamedName;
+
+class DummyWithDollarNamedProperties
+{
+    #[StreamedName('$foo')]
+    public bool $foo = true;
+
+    #[StreamedName('{$foo->bar}')]
+    public bool $bar = true;
+}
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/null.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/null.php
@@ -2,7 +2,7 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield 'null';
+        yield "null";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_backed_enum.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_backed_enum.php
@@ -5,7 +5,7 @@
         if ($data instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Enum\DummyBackedEnum) {
             yield \json_encode($data->value, \JSON_THROW_ON_ERROR, 512);
         } elseif (null === $data) {
-            yield 'null';
+            yield "null";
         } else {
             throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data)));
         }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object.php
@@ -3,13 +3,15 @@
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
         if ($data instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNameAttributes) {
-            yield '{"@id":';
+            $prefix1 = '';
+            yield "{{$prefix1}\"@id\":";
             yield \json_encode($data->id, \JSON_THROW_ON_ERROR, 511);
-            yield ',"name":';
+            $prefix1 = ',';
+            yield "{$prefix1}\"name\":";
             yield \json_encode($data->name, \JSON_THROW_ON_ERROR, 511);
-            yield '}';
+            yield "}";
         } elseif (null === $data) {
-            yield 'null';
+            yield "null";
         } else {
             throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data)));
         }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object_dict.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object_dict.php
@@ -3,21 +3,22 @@
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
         if (\is_array($data)) {
-            yield '{';
-            $prefix = '';
+            yield "{";
+            $prefix1 = '';
             foreach ($data as $key => $value) {
                 $key = \substr(\json_encode($key), 1, -1);
-                yield "{$prefix}\"{$key}\":";
-                yield '{"@id":';
+                $prefix2 = '';
+                yield "{$prefix1}\"{$key}\":{{$prefix2}\"@id\":";
                 yield \json_encode($value->id, \JSON_THROW_ON_ERROR, 510);
-                yield ',"name":';
+                $prefix2 = ',';
+                yield "{$prefix2}\"name\":";
                 yield \json_encode($value->name, \JSON_THROW_ON_ERROR, 510);
-                yield '}';
-                $prefix = ',';
+                yield "}";
+                $prefix1 = ',';
             }
-            yield '}';
+            yield "}";
         } elseif (null === $data) {
-            yield 'null';
+            yield "null";
         } else {
             throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data)));
         }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object_list.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/nullable_object_list.php
@@ -3,20 +3,21 @@
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
         if (\is_array($data)) {
-            yield '[';
-            $prefix = '';
+            yield "[";
+            $prefix1 = '';
             foreach ($data as $value) {
-                yield $prefix;
-                yield '{"@id":';
+                $prefix2 = '';
+                yield "{$prefix1}{{$prefix2}\"@id\":";
                 yield \json_encode($value->id, \JSON_THROW_ON_ERROR, 510);
-                yield ',"name":';
+                $prefix2 = ',';
+                yield "{$prefix2}\"name\":";
                 yield \json_encode($value->name, \JSON_THROW_ON_ERROR, 510);
-                yield '}';
-                $prefix = ',';
+                yield "}";
+                $prefix1 = ',';
             }
-            yield ']';
+            yield "]";
         } elseif (null === $data) {
-            yield 'null';
+            yield "null";
         } else {
             throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data)));
         }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object.php
@@ -2,11 +2,13 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{"@id":';
+        $prefix1 = '';
+        yield "{{$prefix1}\"@id\":";
         yield \json_encode($data->id, \JSON_THROW_ON_ERROR, 511);
-        yield ',"name":';
+        $prefix1 = ',';
+        yield "{$prefix1}\"name\":";
         yield \json_encode($data->name, \JSON_THROW_ON_ERROR, 511);
-        yield '}';
+        yield "}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_dict.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_dict.php
@@ -2,19 +2,20 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{';
-        $prefix = '';
+        yield "{";
+        $prefix1 = '';
         foreach ($data as $key => $value) {
             $key = \substr(\json_encode($key), 1, -1);
-            yield "{$prefix}\"{$key}\":";
-            yield '{"@id":';
+            $prefix2 = '';
+            yield "{$prefix1}\"{$key}\":{{$prefix2}\"@id\":";
             yield \json_encode($value->id, \JSON_THROW_ON_ERROR, 510);
-            yield ',"name":';
+            $prefix2 = ',';
+            yield "{$prefix2}\"name\":";
             yield \json_encode($value->name, \JSON_THROW_ON_ERROR, 510);
-            yield '}';
-            $prefix = ',';
+            yield "}";
+            $prefix1 = ',';
         }
-        yield '}';
+        yield "}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_in_object.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_in_object.php
@@ -2,17 +2,25 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{"name":';
+        $prefix1 = '';
+        yield "{{$prefix1}\"name\":";
         yield \json_encode($data->name, \JSON_THROW_ON_ERROR, 511);
-        yield ',"otherDummyOne":{"@id":';
+        $prefix1 = ',';
+        yield "{$prefix1}\"otherDummyOne\":";
+        $prefix2 = '';
+        yield "{{$prefix2}\"@id\":";
         yield \json_encode($data->otherDummyOne->id, \JSON_THROW_ON_ERROR, 510);
-        yield ',"name":';
+        $prefix2 = ',';
+        yield "{$prefix2}\"name\":";
         yield \json_encode($data->otherDummyOne->name, \JSON_THROW_ON_ERROR, 510);
-        yield '},"otherDummyTwo":{"id":';
+        yield "}{$prefix1}\"otherDummyTwo\":";
+        $prefix2 = '';
+        yield "{{$prefix2}\"id\":";
         yield \json_encode($data->otherDummyTwo->id, \JSON_THROW_ON_ERROR, 510);
-        yield ',"name":';
+        $prefix2 = ',';
+        yield "{$prefix2}\"name\":";
         yield \json_encode($data->otherDummyTwo->name, \JSON_THROW_ON_ERROR, 510);
-        yield '}}';
+        yield "}}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_iterable.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_iterable.php
@@ -2,19 +2,20 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{';
-        $prefix = '';
+        yield "{";
+        $prefix1 = '';
         foreach ($data as $key => $value) {
             $key = is_int($key) ? $key : \substr(\json_encode($key), 1, -1);
-            yield "{$prefix}\"{$key}\":";
-            yield '{"id":';
+            $prefix2 = '';
+            yield "{$prefix1}\"{$key}\":{{$prefix2}\"id\":";
             yield \json_encode($value->id, \JSON_THROW_ON_ERROR, 510);
-            yield ',"name":';
+            $prefix2 = ',';
+            yield "{$prefix2}\"name\":";
             yield \json_encode($value->name, \JSON_THROW_ON_ERROR, 510);
-            yield '}';
-            $prefix = ',';
+            yield "}";
+            $prefix1 = ',';
         }
-        yield '}';
+        yield "}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_list.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_list.php
@@ -2,18 +2,19 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '[';
-        $prefix = '';
+        yield "[";
+        $prefix1 = '';
         foreach ($data as $value) {
-            yield $prefix;
-            yield '{"@id":';
+            $prefix2 = '';
+            yield "{$prefix1}{{$prefix2}\"@id\":";
             yield \json_encode($value->id, \JSON_THROW_ON_ERROR, 510);
-            yield ',"name":';
+            $prefix2 = ',';
+            yield "{$prefix2}\"name\":";
             yield \json_encode($value->name, \JSON_THROW_ON_ERROR, 510);
-            yield '}';
-            $prefix = ',';
+            yield "}";
+            $prefix1 = ',';
         }
-        yield ']';
+        yield "]";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_dollar_named_properties.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_dollar_named_properties.php
@@ -0,0 +1,15 @@
+<?php
+
+return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
+    try {
+        $prefix1 = '';
+        yield "{{$prefix1}\"\$foo\":";
+        yield $data->foo ? 'true' : 'false';
+        $prefix1 = ',';
+        yield "{$prefix1}\"{\$foo->bar}\":";
+        yield $data->bar ? 'true' : 'false';
+        yield "}";
+    } catch (\JsonException $e) {
+        throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
+    }
+};
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_union.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_union.php
@@ -2,17 +2,19 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{"value":';
-        if ($data->value instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Enum\DummyBackedEnum) {
-            yield \json_encode($data->value->value, \JSON_THROW_ON_ERROR, 511);
-        } elseif (null === $data->value) {
-            yield 'null';
-        } elseif (\is_string($data->value)) {
-            yield \json_encode($data->value, \JSON_THROW_ON_ERROR, 511);
-        } else {
-            throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data->value)));
+        $prefix1 = '';
+        yield "{";
+        if (null !== $data->value) {
+            yield "{$prefix1}\"value\":";
+            if ($data->value instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Enum\DummyBackedEnum) {
+                yield \json_encode($data->value->value, \JSON_THROW_ON_ERROR, 511);
+            } elseif (\is_string($data->value)) {
+                yield \json_encode($data->value, \JSON_THROW_ON_ERROR, 511);
+            } else {
+                throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data->value)));
+            }
         }
-        yield '}';
+        yield "}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_value_transformer.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_value_transformer.php
@@ -2,15 +2,17 @@
 
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
-        yield '{"id":';
+        $prefix1 = '';
+        yield "{{$prefix1}\"id\":";
         yield \json_encode($valueTransformers->get('Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\DoubleIntAndCastToStringValueTransformer')->transform($data->id, $options), \JSON_THROW_ON_ERROR, 511);
-        yield ',"active":';
+        $prefix1 = ',';
+        yield "{$prefix1}\"active\":";
         yield \json_encode($valueTransformers->get('Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\BooleanToStringValueTransformer')->transform($data->active, $options), \JSON_THROW_ON_ERROR, 511);
-        yield ',"name":';
+        yield "{$prefix1}\"name\":";
         yield \json_encode(strtolower($data->name), \JSON_THROW_ON_ERROR, 511);
-        yield ',"range":';
+        yield "{$prefix1}\"range\":";
         yield \json_encode(Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithValueTransformerAttributes::concatRange($data->range, $options), \JSON_THROW_ON_ERROR, 511);
-        yield '}';
+        yield "}";
     } catch (\JsonException $e) {
         throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);
     }
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/self_referencing_object.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/self_referencing_object.php
@@ -5,15 +5,13 @@
         if ($depth >= 512) {
             throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException('Maximum stack depth exceeded');
         }
-        yield '{"@self":';
-        if ($data->self instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummy) {
+        $prefix1 = '';
+        yield "{";
+        if (null !== $data->self) {
+            yield "{$prefix1}\"@self\":";
             yield from $generators['Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummy']($data->self, $depth + 1);
-        } elseif (null === $data->self) {
-            yield 'null';
-        } else {
-            throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data->self)));
         }
-        yield '}';
+        yield "}";
     };
     try {
         yield from $generators['Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummy']($data, 0);
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/union.php b/src/Symfony/Component/JsonStreamer/Tests/Fixtures/stream_writer/union.php
@@ -3,20 +3,22 @@
 return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {
     try {
         if (\is_array($data)) {
-            yield '[';
-            $prefix = '';
+            yield "[";
+            $prefix1 = '';
             foreach ($data as $value) {
-                yield $prefix;
+                yield "{$prefix1}";
                 yield \json_encode($value->value, \JSON_THROW_ON_ERROR, 511);
-                $prefix = ',';
+                $prefix1 = ',';
             }
-            yield ']';
+            yield "]";
         } elseif ($data instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNameAttributes) {
-            yield '{"@id":';
+            $prefix1 = '';
+            yield "{{$prefix1}\"@id\":";
             yield \json_encode($data->id, \JSON_THROW_ON_ERROR, 511);
-            yield ',"name":';
+            $prefix1 = ',';
+            yield "{$prefix1}\"name\":";
             yield \json_encode($data->name, \JSON_THROW_ON_ERROR, 511);
-            yield '}';
+            yield "}";
         } elseif (\is_int($data)) {
             yield \json_encode($data, \JSON_THROW_ON_ERROR, 512);
         } else {
diff --git a/src/Symfony/Component/JsonStreamer/Tests/JsonStreamWriterTest.php b/src/Symfony/Component/JsonStreamer/Tests/JsonStreamWriterTest.php
diff --git a/src/Symfony/Component/JsonStreamer/Tests/Write/StreamWriterGeneratorTest.php b/src/Symfony/Component/JsonStreamer/Tests/Write/StreamWriterGeneratorTest.php
diff --git a/src/Symfony/Component/JsonStreamer/Write/PhpGenerator.php b/src/Symfony/Component/JsonStreamer/Write/PhpGenerator.php

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`return static function (mixed $data, \Psr\Container\ContainerInterface $valueTransformers, array $options): \Traversable {`
`4`	`4`	`try {`
`5`		`- yield 'null';`
	`5`	`+ yield "null";`
`6`	`6`	`} catch (\JsonException $e) {`
`7`	`7`	`throw new \Symfony\Component\JsonStreamer\Exception\NotEncodableValueException($e->getMessage(), 0, $e);`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`if ($data instanceof \Symfony\Component\JsonStreamer\Tests\Fixtures\Enum\DummyBackedEnum) {`
`6`	`6`	`yield \json_encode($data->value, \JSON_THROW_ON_ERROR, 512);`
`7`	`7`	`} elseif (null === $data) {`
`8`		`- yield 'null';`
	`8`	`+ yield "null";`
`9`	`9`	`} else {`
`10`	`10`	`throw new \Symfony\Component\JsonStreamer\Exception\UnexpectedValueException(\sprintf('Unexpected "%s" value.', \get_debug_type($data)));`
`11`	`11`	`}`