iterator_to_array must always return array-key (#5400)

vimeo · Mar 16, 2021 · ff5a6cb · ff5a6cb
1 parent 1a3ff56
commit ff5a6cb
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/src/Psalm/Internal/Provider/ReturnTypeProvider/IteratorToArrayReturnTypeProvider.php b/src/Psalm/Internal/Provider/ReturnTypeProvider/IteratorToArrayReturnTypeProvider.php
@@ -2,8 +2,9 @@
 namespace Psalm\Internal\Provider\ReturnTypeProvider;
 
 use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
+use Psalm\Type\Atomic\TTemplateParam;
+use function array_shift;
 use function assert;
-use PhpParser;
 use Psalm\Internal\Analyzer\Statements\Block\ForeachAnalyzer;
 use Psalm\Internal\Type\Comparator\AtomicTypeComparator;
 use Psalm\Internal\Codebase\InternalCallMapHandler;
@@ -86,6 +87,15 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
                     $key_type = Type::getArrayKey();
                 }
 
+                if ($key_type->isSingle() && $key_type->hasTemplate()) {
+                    $template_types = $key_type->getTemplateTypes();
+                    $template_type = array_shift($template_types);
+                    if ($template_type->as->hasMixed()) {
+                        $template_type->as = Type::getArrayKey();
+                        $key_type = new Type\Union([$template_type]);
+                    }
+                }
+
                 return new Type\Union([
                     new Type\Atomic\TArray([
                         $key_type,

diff --git a/tests/Php71Test.php b/tests/Php71Test.php
@@ -235,6 +235,19 @@ function foo(iterable $i): array {
                       return $i;
                     }',
             ],
+            'iterator_to_arrayMixedKey' => [
+                '<?php
+                    /**
+                     * @template TKey
+                     * @template TValue
+                     * @param Traversable<TKey, TValue> $traversable
+                     * @return array<TValue>
+                     */
+                    function toArray(Traversable $traversable): array
+                    {
+                        return iterator_to_array($traversable);
+                    }',
+            ],
             'noReservedWordInDocblock' => [
                 '<?php
                     /**