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.

Sign up for GitHub

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

Jump to bottom

Improve the type descriptor for SimpleArrayType #438

Merged
merged 2 commits into from
Apr 6, 2023
Merged

Improve the type descriptor for SimpleArrayType #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3abe8eb
Improve the type descriptor for SimpleArrayType
stof Mar 17, 2023
6d2bdfb
Fix support for type descriptors returning precise arrays
stof Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/Rules/Doctrine/ORM/EntityColumnRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,13 +160,14 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

$propertyTransformedType = TypeTraverser::map($propertyType, static function (Type $type, callable $traverse): Type {
// If the type descriptor does not precise the types inside the array, don't report errors if the field has a more precise type
Copy link
Member

Choose a reason for hiding this comment

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

I disagree with this. If Doctrine can write any array to a property, it's wrong to expect a narrower type.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This comment is about explaining the existing logic that you added in e745610

The change I'm doing here is disabling this logic for some cases (when the type descriptor is precise), not enabling it, to avoid reporting errors that are wrong.

I tried to remove this transformation entirely, but this broke some existing tests (the ones added in that commit)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note however that the only type descriptors that return array as type (and so would trigger this logic) are json_array (deprecated in DBAL 2.10 and removed in DBAL 3.0) and array (deprecated in DBAL 3.4+).

So maybe we could drop this logic and return NeverType as done in the JsonType descriptor

Copy link
Member

Choose a reason for hiding this comment

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

Oh I get it now, it's nice 👍

I'm not rushing to remove functionality, people use phpstan-doctrine with years-old versions of Doctrine.

$propertyTransformedType = $writableToPropertyType->equals(new ArrayType(new MixedType(), new MixedType())) ? TypeTraverser::map($propertyType, static function (Type $type, callable $traverse): Type {
if ($type instanceof ArrayType) {
return new ArrayType(new MixedType(), new MixedType());
}

return $traverse($type);
});
}) : $propertyType;

if (!$propertyTransformedType->isSuperTypeOf($writableToPropertyType)->yes()) {
$errors[] = sprintf(
Expand All @@ -181,16 +182,16 @@ public function processNode(Node $node, Scope $scope): array
if (
!$writableToDatabaseType->isSuperTypeOf(
$this->allowNullablePropertyForRequiredField || (in_array($propertyName, $identifiers, true) && !$nullable)
? TypeCombinator::removeNull($propertyTransformedType)
: $propertyTransformedType
? TypeCombinator::removeNull($propertyType)
: $propertyType
)->yes()
) {
$errors[] = sprintf(
'Property %s::$%s type mapping mismatch: property can contain %s but database expects %s.',
$className,
$propertyName,
$propertyTransformedType->describe(VerbosityLevel::getRecommendedLevelByType($writableToDatabaseType, $propertyTransformedType)),
$writableToDatabaseType->describe(VerbosityLevel::getRecommendedLevelByType($writableToDatabaseType, $propertyTransformedType))
$propertyTransformedType->describe(VerbosityLevel::getRecommendedLevelByType($writableToDatabaseType, $propertyType)),
$writableToDatabaseType->describe(VerbosityLevel::getRecommendedLevelByType($writableToDatabaseType, $propertyType))
);
}
return $errors;
Expand Down
6 changes: 4 additions & 2 deletions src/Type/Doctrine/Descriptors/SimpleArrayType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace PHPStan\Type\Doctrine\Descriptors;

use PHPStan\Type\Accessory\AccessoryArrayListType;
use PHPStan\Type\ArrayType;
use PHPStan\Type\IntegerType;
use PHPStan\Type\MixedType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
Expand All @@ -17,12 +19,12 @@ public function getType(): string

public function getWritableToPropertyType(): Type
{
return new ArrayType(new MixedType(), new MixedType());
return AccessoryArrayListType::intersectWith(new ArrayType(new IntegerType(), new StringType()));
}

public function getWritableToDatabaseType(): Type
{
return new ArrayType(new MixedType(), new MixedType());
return new ArrayType(new MixedType(), new StringType());
}

public function getDatabaseInternalType(): Type
Expand Down
18 changes: 18 additions & 0 deletions tests/Rules/Doctrine/ORM/EntityColumnRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use PHPStan\Type\Doctrine\Descriptors\JsonType;
use PHPStan\Type\Doctrine\Descriptors\Ramsey\UuidTypeDescriptor;
use PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor;
use PHPStan\Type\Doctrine\Descriptors\SimpleArrayType;
use PHPStan\Type\Doctrine\Descriptors\StringType;
use PHPStan\Type\Doctrine\ObjectMetadataResolver;
use Ramsey\Uuid\Doctrine\UuidType;
Expand Down Expand Up @@ -68,6 +69,7 @@ protected function getRule(): Rule
new JsonType(),
new IntegerType(),
new StringType(),
new SimpleArrayType(),
new UuidTypeDescriptor(UuidType::class),
new ReflectionDescriptor(CarbonImmutableType::class, $this->createBroker()),
new ReflectionDescriptor(CarbonType::class, $this->createBroker()),
Expand Down Expand Up @@ -156,6 +158,14 @@ public function testRule(?string $objectManagerLoader): void
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$incompatibleJsonValueObject type mapping mismatch: property can contain PHPStan\Rules\Doctrine\ORM\EmptyObject but database expects array|bool|float|int|JsonSerializable|stdClass|string|null.',
156,
],
[
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$invalidSimpleArray type mapping mismatch: database can contain array<int, string> but property expects array<int>.',
162,
],
[
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$invalidSimpleArray type mapping mismatch: property can contain array<int> but database expects array<string>.',
162,
],
]);
}

Expand Down Expand Up @@ -211,6 +221,14 @@ public function testRuleWithAllowedNullableProperty(?string $objectManagerLoader
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$incompatibleJsonValueObject type mapping mismatch: property can contain PHPStan\Rules\Doctrine\ORM\EmptyObject but database expects array|bool|float|int|JsonSerializable|stdClass|string|null.',
156,
],
[
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$invalidSimpleArray type mapping mismatch: database can contain array<int, string> but property expects array<int>.',
162,
],
[
'Property PHPStan\Rules\Doctrine\ORM\MyBrokenEntity::$invalidSimpleArray type mapping mismatch: property can contain array<int> but database expects array<string>.',
162,
],
]);
}

Expand Down
12 changes: 12 additions & 0 deletions tests/Rules/Doctrine/ORM/data/MyBrokenEntity.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,16 @@ class MyBrokenEntity extends MyBrokenSuperclass
* @var EmptyObject
*/
private $incompatibleJsonValueObject;

/**
* @ORM\Column(type="simple_array")
* @var int[]
*/
private $invalidSimpleArray;

/**
* @ORM\Column(type="simple_array")
* @var list<string>
*/
private $validSimpleArray;
}
1 change: 1 addition & 0 deletions tests/Type/Doctrine/Query/QueryResultTypeWalkerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ public static function setUpBeforeClass(): void
$many->stringNullColumn = $stringNullColumnMany;
$many->datetimeColumn = new DateTime('2001-01-01 00:00:00');
$many->datetimeImmutableColumn = new DateTimeImmutable('2001-01-01 00:00:00');
$many->simpleArrayColumn = ['foo'];
$many->one = $one;
$one->manies->add($many);
$em->persist($many);
Expand Down
6 changes: 6 additions & 0 deletions tests/Type/Doctrine/data/QueryResult/Entities/Many.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ class Many
* @var CompoundPkAssoc|null
*/
public $compoundPkAssoc;

/**
* @ORM\Column(type="simple_array")
* @var list<string>
*/
public $simpleArrayColumn;
}

/**
Expand Down
7 changes: 7 additions & 0 deletions tests/Type/Doctrine/data/QueryResult/createQuery.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ public function testQueryTypeParametersAreInfered(EntityManagerInterface $em): v
assertType('Doctrine\ORM\Query<null, array{intColumn: int, stringNullColumn: string|null}>', $query);
}

public function testQueryTypeSimpleArray(EntityManagerInterface $em): void
{
$query = $em->createQuery('SELECT m.simpleArrayColumn FROM QueryResult\Entities\Many m');

assertType('Doctrine\ORM\Query<null, array{simpleArrayColumn: list<string>}>', $query);
}

public function testQueryResultTypeIsMixedWhenDQLIsNotKnown(EntityManagerInterface $em, string $dql): void
{
$query = $em->createQuery($dql);
Expand Down