Fixed keyed array types being properly unpacked when are parts of union (#1094)

* fixed unpacked types being not handled in unions

* Fix styling

---------

Co-authored-by: romalytvynenko <romalytvynenko@users.noreply.github.com>

Author: romalytvynenko

src/Infer/Services/KeyedArrayUnpackingTypeVisitor.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Dedoc\Scramble\Infer\Services;
+
+use Dedoc\Scramble\Support\Type\AbstractTypeVisitor;
+use Dedoc\Scramble\Support\Type\KeyedArrayType;
+use Dedoc\Scramble\Support\Type\Type;
+use Dedoc\Scramble\Support\Type\TypeHelper;
+
+class KeyedArrayUnpackingTypeVisitor extends AbstractTypeVisitor
+{
+    public function leave(Type $type): ?Type
+    {
+        if (! $type instanceof KeyedArrayType) {
+            return null;
+        }
+
+        return TypeHelper::unpackIfArray($type);
+    }
+}

src/Infer/Services/ReferenceTypeResolver.php

@@ -32,10 +32,8 @@
 use Dedoc\Scramble\Support\Type\TemplatePlaceholderType;
 use Dedoc\Scramble\Support\Type\TemplateType;
 use Dedoc\Scramble\Support\Type\Type;
-use Dedoc\Scramble\Support\Type\TypeHelper;
 use Dedoc\Scramble\Support\Type\TypeTraverser;
 use Dedoc\Scramble\Support\Type\TypeWalker;
-use Dedoc\Scramble\Support\Type\Union;
 use Dedoc\Scramble\Support\Type\UnknownType;
 use Dedoc\Scramble\Support\Type\VoidType;
 
@@ -61,12 +59,7 @@ public function resolve(Scope $scope, Type $type): Type
         );
 
         // Type finalization: removing duplicates from union, unpacking array items (inside `replace`), calling resolving extensions.
-        $finalizedResolvedType = (new TypeWalker)->replace(
-            $resolvedType,
-            fn (Type $t) => $t instanceof Union ? TypeHelper::mergeTypes(...$t->types) : null,
-        );
-
-        return $this->resolveLateTypes($finalizedResolvedType->setOriginal($originalType), $originalType)->widen();
+        return $this->finalizeType($resolvedType->setOriginal($originalType), $originalType)->widen();
     }
 
     private function doResolve(Type $t, Type $type, Scope $scope): Type
@@ -121,11 +114,13 @@ private function resolveLateTypeEarly(LateResolvingType $type): Type
         return $type->resolve();
     }
 
-    private function resolveLateTypes(Type $type, Type $originalType): Type
+    private function finalizeType(Type $type, Type $originalType): Type
     {
         $attributes = $type->attributes();
 
         $traverser = new TypeTraverser([
+            new UnionNormalizingTypeVisitor,
+            new KeyedArrayUnpackingTypeVisitor,
             new LateTypeResolvingTypeVisitor,
         ]);
 

src/Infer/Services/UnionNormalizingTypeVisitor.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Dedoc\Scramble\Infer\Services;
+
+use Dedoc\Scramble\Support\Type\AbstractTypeVisitor;
+use Dedoc\Scramble\Support\Type\Type;
+use Dedoc\Scramble\Support\Type\TypeHelper;
+use Dedoc\Scramble\Support\Type\Union;
+
+class UnionNormalizingTypeVisitor extends AbstractTypeVisitor
+{
+    public function leave(Type $type): ?Type
+    {
+        if (! $type instanceof Union) {
+            return null;
+        }
+
+        return TypeHelper::mergeTypes(...$type->types);
+    }
+}

src/Support/Type/TypeTraverser.php

@@ -49,20 +49,38 @@ public function traverse(Type $type): Type
     private function enterType(Type $type): Type|int|null
     {
         $result = null;
+        $resultType = $type;
         foreach ($this->visitors as $visitor) {
-            $result = $visitor->enter($result instanceof Type ? $result : $type);
+            $enterResult = $visitor->enter($resultType);
+
+            if ($enterResult === TypeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN) {
+                return $enterResult;
+            }
+
+            if ($enterResult instanceof Type) {
+                $resultType = $enterResult;
+            }
+
+            $result = $enterResult;
         }
 
-        return $result;
+        return $resultType === $type ? $result : $resultType;
     }
 
     private function leaveType(Type $type): Type|int|null
     {
         $result = null;
+        $resultType = $type;
         foreach ($this->visitors as $visitor) {
-            $result = $visitor->leave($result instanceof Type ? $result : $type);
+            $leaveResult = $visitor->leave($resultType);
+
+            if ($leaveResult instanceof Type) {
+                $resultType = $leaveResult;
+            }
+
+            $result = $leaveResult;
         }
 
-        return $result;
+        return $resultType === $type ? $result : $resultType;
     }
 }

tests/Infer/Services/ReferenceTypeResolverTest.php

@@ -231,3 +231,38 @@ public function toString(): string
         ]),
     )->toString())->toBe('string(wow)');
 });
+
+it('resolves spread in union type', function () {
+    $def = analyzeFile(<<<'EOD'
+<?php
+class JsonResourceExtensionTest_SpreadInMatch
+{
+    public function toArray(Request $request)
+    {
+        return match (mt_rand(0, 1)) {
+            0 => [
+                ...$this->typeA(),
+                'type' => 'a',
+            ],
+            1 => [
+                ...$this->typeB(),
+                'type' => 'b',
+            ],
+        };
+    }
+
+    private function typeA(): array
+    {
+        return ['id' => 1, 'name' => 'Type A'];
+    }
+
+    private function typeB(): array
+    {
+        return ['id' => 2, 'name' => 'Type B'];
+    }
+}
+EOD)->getClassDefinition('JsonResourceExtensionTest_SpreadInMatch');
+
+    expect($def->getMethod('toArray')->getReturnType()->toString())
+        ->toBe('array{id: int(1), name: string(Type A), type: string(a)}|array{id: int(2), name: string(Type B), type: string(b)}');
+});