Skip to content
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.

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

[TypeDeclaration] Handle infinite loop on array_reverse with index on AddMethodCallBasedStrictParamTypeRector on php8+ feature #3678

Merged
merged 7 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?php

declare(strict_types=1);

namespace Rector\PHPStanStaticTypeMapper\TypeMapper;

use PhpParser\Node;
use PhpParser\Node\Identifier;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\Type\IntegerRangeType;
use PHPStan\Type\Type;
use Rector\Core\Php\PhpVersionProvider;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\PHPStanStaticTypeMapper\Contract\TypeMapperInterface;

/**
* @implements TypeMapperInterface<IntegerRangeType>
*/
final class IntegerRangeTypeMapper implements TypeMapperInterface
{
public function __construct(
private readonly PhpVersionProvider $phpVersionProvider
) {
}

/**
* @return class-string<Type>
*/
public function getNodeClass(): string
{
return IntegerRangeType::class;
}

/**
* @param IntegerRangeType $type
*/
public function mapToPHPStanPhpDocTypeNode(Type $type, string $typeKind): TypeNode
{
return new IdentifierTypeNode('int');
}

/**
* @param IntegerRangeType $type
*/
public function mapToPhpParserNode(Type $type, string $typeKind): ?Node
{
if (! $this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::SCALAR_TYPES)) {
return null;
}

if ($type->getMin() === null) {
return null;
}

if ($type->getMax() === null) {
return null;
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

min, max value null seems valid value https://phpstan.org/r/765b0694-8832-4b65-98b7-4944d2914bc3

getMin() === null printed as min

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all type applied with string type seems also valid https://phpstan.org/r/474c8c8b-1d17-4ba2-b6bf-c243b7390e19 for this type:

^ PHPStan\Type\UnionType^ {#23962
  -sortedTypes: false
  -cachedDescriptions: []
  -types: array:3 [
    0 => PHPStan\Type\IntegerRangeType^ {#22268
      -min: null
      -max: -1
    }
    1 => PHPStan\Type\IntegerRangeType^ {#22323
      -min: 1
      -max: null
    }
    2 => PHPStan\Type\StringType^ {#19486}
  ]
  -normalized: false
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue seems somehow used index as integer on this type:

              // here index must be integer...
              $this->someOtherMethod($index, $uri);
        }
    }

    private function someOtherMethod(int $index, string $uri)
    {
        return sprintf('%d-%s', $index, $uri);
    }

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got it, it seems due to combination of UnionType + MixedType, then it should be skipped, see 42bcdaa#diff-42a5a059b66868f3ede960ea9a50a3591de610668457d76063ac2f6dc653dcc3


return new Identifier('int');
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector\Fixture;

final class SkipNoReturnArrayReverse
{
public function run()
{
$parts = array_reverse(explode('/', '/some/test/url'));
foreach ($parts as $index => $uri) {
if ($index === 0) {
continue;
}

$this->someOtherMethod($index, $uri);
}
}

private function someOtherMethod(int $index, string $uri)
{
return sprintf('%d-%s', $index, $uri);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector\FixtureUnion;

final class SkipNoReturnArrayReverse
{
public function run()
{
$parts = array_reverse(explode('/', '/some/test/url'));
foreach ($parts as $index => $uri) {
if ($index === 0) {
continue;
}

$this->someOtherMethod($index, $uri);
}
}

private function someOtherMethod(int $index, string $uri)
{
return sprintf('%d-%s', $index, $uri);
}
}