[TypeDeclaration] Skip ArrayDimFetch for optional items in native array-shapes

[staabm]

No description provided.

[staabm]

shouldn't this tests pass?

[staabm]

failure in

2) Rector\Tests\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector\Php80Test::test with data set #3
Failed on fixture file "pathinfo_return.php.inc"
Failed asserting that string matches format description.
--- Expected
+++ Actual
@@ @@
      *
      * @psalm-assert-if-true =non-empty-string $filename
      */
-    public static function extension($filename): string|array
+    public static function extension($filename): array|string
     {
         return pathinfo($filename, PATHINFO_EXTENSION);
     }

/home/runner/work/rector-src/rector-src/packages/Testing/PHPUnit/AbstractRectorTestCase.php:239
/home/runner/work/rector-src/rector-src/packages/Testing/PHPUnit/AbstractRectorTestCase.php:171
/home/runner/work/rector-src/rector-src/rules-tests/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictTypedCallRector/Php80Test.php:16

is unrelated

[samsonasik]

it seems pathinfo() getNativeType() PHPStan bug, getting native type of $shape itself got union array and string:

PHPStan\Type\UnionType #11106
   types: array (2)
   |  0 => PHPStan\Type\ArrayType #11170 ...
   |  1 => PHPStan\Type\StringType #11098 ...
   normalized: true
   sortedTypes: true
   cachedDescriptions: array (1)
   |  4 => 'array|string'

[samsonasik]

on native return, pathinfo() got array or string https://www.php.net/manual/en/function.pathinfo.php

[samsonasik]

I think the best way to verify if the shape is array or string is by using assertion, eg:

        $shape = pathinfo('');
+       assert(is_array($shape));
        $this->doBar($shape['dirname']); // dirname is only conditionally returned

then, it will be skipped

[samsonasik]

it seems can be fixed with the following check:

            $nativeVariableType = $scope->getNativeType($expr->var);
            if (! $nativeVariableType instanceof MixedType && (! $nativeVariableType instanceof ArrayType || ! $nativeVariableType->getItemType() instanceof MixedType)) {
                $type = $scope->getType($expr);

                if ($expr->dim instanceof String_) {
                    $targetKey = null;
                    $variableType = $scope->getType($expr->var);
                    if ($variableType instanceof ArrayType) {
                        foreach ($variableType->getKeyTypes() as $key => $type) {
                            if ($type instanceof \PHPStan\Type\Constant\ConstantStringType && $type->getValue() === $expr->dim->value) {
                                $targetKey = $key;
                                break;
                            }
                        }

                        if ($targetKey !== null && in_array($targetKey, $variableType->getOptionalKeys(), true)) {
                            $type = $scope->getNativeType($expr);
                        }
                    }
                }
            }

[samsonasik]

#5062