Skip to content

[JsonStreamer] fix invalid json output for list of self #62622

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

Merged
nicolas-grekas merged 1 commit into from
Dec 5, 2025
Merged

[JsonStreamer] fix invalid json output for list of self #62622

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
11 changes: 11 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/DummyWithNestedDictDummies.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Fixtures\Model;

namespace Symfony\Component\JsonStreamer\Tests\Fixtures\Model;

class DummyWithNestedDictDummies
{
/** @var array<string, DummyWithNestedDictDummies> */
public array $dummies = [];
}
11 changes: 11 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/DummyWithNestedListDummies.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Fixtures\Model;

namespace Symfony\Component\JsonStreamer\Tests\Fixtures\Model;

class DummyWithNestedListDummies
{
/** @var DummyWithNestedListDummies[] */
public array $dummies = [];
}
11 changes: 11 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/SelfReferencingDummyDict.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Symfony\Component\JsonStreamer\Tests\Fixtures\Model;

class SelfReferencingDummyDict
{
/**
* @var array<string, self>
*/
public array $items = [];
}
11 changes: 11 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/Fixtures/Model/SelfReferencingDummyList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Symfony\Component\JsonStreamer\Tests\Fixtures\Model;

class SelfReferencingDummyList
{
/**
* @var self[]
*/
public array $items = [];
}
28 changes: 28 additions & 0 deletions ...fony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_nested_dict_self.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions ...fony/Component/JsonStreamer/Tests/Fixtures/stream_writer/object_with_nested_list_self.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions ...fony/Component/JsonStreamer/Tests/Fixtures/stream_writer/self_referencing_object_dict.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions ...fony/Component/JsonStreamer/Tests/Fixtures/stream_writer/self_referencing_object_list.php
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 54 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/JsonStreamWriterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,16 @@
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithGenerics;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNameAttributes;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedArray;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedDictDummies;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedListDummies;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNullableProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithPhpDoc;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithSyntheticProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithUnionProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithValueTransformerAttributes;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummy;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummyDict;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummyList;
use Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\BooleanToStringValueTransformer;
use Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\DoubleIntAndCastToStringValueTransformer;
use Symfony\Component\JsonStreamer\ValueTransformer\DateTimeToStringValueTransformer;
Expand Down Expand Up @@ -283,6 +287,56 @@ public function testWriteObjectWithSyntheticProperty()
$this->assertSame('{"synthetic":true}', (string) $writer->write(new DummyWithSyntheticProperties(), Type::object(DummyWithSyntheticProperties::class)));
}

public function testWriteNestedSelfList()
{
$dummy = new SelfReferencingDummyList();
$dummy->items = [new SelfReferencingDummyList(), new SelfReferencingDummyList(), new SelfReferencingDummyList()];

$this->assertWritten(
'{"items":[{"items":[]},{"items":[]},{"items":[]}]}',
$dummy,
Type::object(SelfReferencingDummyList::class)
);

$dummy = new DummyWithNestedListDummies();
$dummy->dummies = [new DummyWithNestedListDummies(), new DummyWithNestedListDummies(), new DummyWithNestedListDummies()];

$this->assertWritten(
'{"dummies":[{"dummies":[]},{"dummies":[]},{"dummies":[]}]}',
$dummy,
Type::object(DummyWithNestedListDummies::class)
);
}

public function testWriteNestedSelfDict()
{
$dummy = new SelfReferencingDummyDict();
$dummy->items = [
'first' => new SelfReferencingDummyDict(),
'second' => new SelfReferencingDummyDict(),
'third' => new SelfReferencingDummyDict(),
];

$this->assertWritten(
'{"items":{"first":{"items":{}},"second":{"items":{}},"third":{"items":{}}}}',
$dummy,
Type::object(SelfReferencingDummyDict::class)
);

$dummy = new DummyWithNestedDictDummies();
$dummy->dummies = [
'first' => new DummyWithNestedDictDummies(),
'second' => new DummyWithNestedDictDummies(),
'third' => new DummyWithNestedDictDummies(),
];

$this->assertWritten(
'{"dummies":{"first":{"dummies":{}},"second":{"dummies":{}},"third":{"dummies":{}}}}',
$dummy,
Type::object(DummyWithNestedDictDummies::class)
);
}

#[DataProvider('throwWhenMaxDepthIsReachedDataProvider')]
public function testThrowWhenMaxDepthIsReached(Type $type, mixed $data)
{
Expand Down
8 changes: 8 additions & 0 deletions src/Symfony/Component/JsonStreamer/Tests/Write/StreamWriterGeneratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithDollarNamedProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNameAttributes;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedArray;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedDictDummies;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithNestedListDummies;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithOtherDummies;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithSyntheticProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithUnionProperties;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\DummyWithValueTransformerAttributes;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummy;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummyDict;
use Symfony\Component\JsonStreamer\Tests\Fixtures\Model\SelfReferencingDummyList;
use Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\BooleanToStringValueTransformer;
use Symfony\Component\JsonStreamer\Tests\Fixtures\ValueTransformer\DoubleIntAndCastToStringValueTransformer;
use Symfony\Component\JsonStreamer\Tests\ServiceContainer;
Expand Down Expand Up @@ -99,6 +103,8 @@ public static function generatedStreamWriterDataProvider(): iterable
yield ['nullable_object_list', Type::nullable(Type::list(Type::object(DummyWithNameAttributes::class)))];
yield ['nested_list', Type::list(Type::object(DummyWithArray::class))];
yield ['double_nested_list', Type::list(Type::object(DummyWithNestedArray::class))];
yield ['object_with_nested_list_self', Type::object(DummyWithNestedListDummies::class)];
yield ['object_with_nested_dict_self', Type::object(DummyWithNestedDictDummies::class)];

yield ['dict', Type::dict()];
yield ['object_dict', Type::dict(Type::object(DummyWithNameAttributes::class))];
Expand All @@ -112,6 +118,8 @@ public static function generatedStreamWriterDataProvider(): iterable
yield ['object_in_object', Type::object(DummyWithOtherDummies::class)];
yield ['object_with_value_transformer', Type::object(DummyWithValueTransformerAttributes::class)];
yield ['self_referencing_object', Type::object(SelfReferencingDummy::class)];
yield ['self_referencing_object_list', Type::object(SelfReferencingDummyList::class)];
yield ['self_referencing_object_dict', Type::object(SelfReferencingDummyDict::class)];
yield ['object_with_dollar_named_properties', Type::object(DummyWithDollarNamedProperties::class)];
yield ['object_with_synthetic_properties', Type::object(DummyWithSyntheticProperties::class), new SyntheticPropertyMetadataLoader()];

Expand Down
3 changes: 2 additions & 1 deletion src/Symfony/Component/JsonStreamer/Write/PhpGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,8 @@ private function generateYields(DataModelNodeInterface $dataModelNode, array $op
if (isset($context['generated_generators'][$dataModelNode->getIdentifier()]) || $dataModelNode->isMock()) {
$depthArgument = ($context['generating_generator'] ?? false) ? '$depth + 1' : (string) $context['depth'];

return $this->line('yield from $generators[\''.$dataModelNode->getIdentifier().'\']('.$accessor.', '.$depthArgument.');', $context);
return $this->flushYieldBuffer($context)
.$this->line('yield from $generators[\''.$dataModelNode->getIdentifier().'\']('.$accessor.', '.$depthArgument.');', $context);
}

++$context['depth'];
Expand Down
Loading