bug #61561 [JsonStreamer] Fix decoding iterable lists (mtarld)

nicolas-grekas · nicolas-grekas · commit 6e42b3659d25 · 2025-09-01T11:19:33.000+02:00
This PR was merged into the 7.3 branch. Discussion ---------- [JsonStreamer] Fix decoding iterable lists | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #61559 | License | MIT Because a `list<T>` is a subtype of `array<T>`, an `iterable<T>` cannot be a list. This means that, as said [here](#59308 (comment)): > There is no way to be sure that keys of an iterable are successive (even if they are integers). > And if keys are not successive, the resulting JSON structure is an object and not an array. > According, to the [JSON specification](https://datatracker.ietf.org/doc/html/rfc8259#section-4), object' keys must be strings, and not integers. This imply that it is right now impossible to "yield" items from `[{"itemId": 1, "modificationDate": "2025-10-10"}]` - it can only be yielded from `{"0": {"itemId": 1, "modificationDate": "2025-10-10"}}`. I think that in the real world, a lot of people want to be able to yield items from `[...]`, even though it does not stick with the JSON specification. This PR is doing the trade-off of considering `iterable<int, Anything>` as an "iterable list" (like `list<Anything>` but not cast to array). Commits ------- 2b9b801 [JsonStreamer] Fix decoding iterable lists
diff --git a/src/Symfony/Component/JsonStreamer/Read/PhpAstBuilder.php b/src/Symfony/Component/JsonStreamer/Read/PhpAstBuilder.php
@@ -379,10 +379,12 @@ private function buildCollectionNodeStatements(CollectionNode $node, bool $decod
             ? $this->builder->funcCall($this->builder->var('iterable'), [$this->builder->var('stream'), $this->builder->var('data')])
             : $this->builder->funcCall($this->builder->var('iterable'), [$this->builder->var('data')]);
 
+        $collectionKeyType = $node->getType()->getCollectionKeyType();
+
         $prepareDataStmts = $decodeFromStream ? [
             new Expression(new Assign($this->builder->var('data'), $this->builder->staticCall(
                 new FullyQualified(Splitter::class),
-                $node->getType()->isList() ? 'splitList' : 'splitDict',
+                ($collectionKeyType instanceof BuiltinType && TypeIdentifier::INT === $collectionKeyType->getTypeIdentifier()) ? 'splitList' : 'splitDict',
                 [$this->builder->var('stream'), $this->builder->var('offset'), $this->builder->var('length')],
             ))),
         ] : [];
diff --git a/src/Symfony/Component/JsonStreamer/Tests/JsonStreamReaderTest.php b/src/Symfony/Component/JsonStreamer/Tests/JsonStreamReaderTest.php
@@ -87,7 +87,7 @@ public function testReadCollection()
         $this->assertRead($reader, function (mixed $read) {
             $this->assertIsIterable($read);
             $this->assertSame([true, false], iterator_to_array($read));
-        }, '{"0": true, "1": false}', Type::iterable(Type::bool(), Type::int()));
+        }, '[true, false]', Type::iterable(Type::bool(), Type::int()));
     }
 
     public function testReadObject()

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public function testReadCollection()`
`87`	`87`	`$this->assertRead($reader, function (mixed $read) {`
`88`	`88`	`$this->assertIsIterable($read);`
`89`	`89`	`$this->assertSame([true, false], iterator_to_array($read));`
`90`		`- }, '{"0": true, "1": false}', Type::iterable(Type::bool(), Type::int()));`
	`90`	`+ }, '[true, false]', Type::iterable(Type::bool(), Type::int()));`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`public function testReadObject()`