Skip to content

Commit d97ddee

Browse files
ondrejmirtesondrejmirtes
committed
Type description verbosity - be more verbose when invariant template type is involved
1 parent 5efd078 commit d97ddee

12 files changed

+153
-14
lines changed

‎src/Rules/Arrays/AppendedArrayItemTypeRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public function processNode(\PhpParser\Node $node, Scope $scope): array
7676

7777
$itemType = $assignedToType->getItemType();
7878
if (!$this->ruleLevelHelper->accepts($itemType, $assignedValueType, $scope->isDeclareStrictTypes())) {
79-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($itemType);
79+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($itemType, $assignedValueType);
8080
return [
8181
RuleErrorBuilder::message(sprintf(
8282
'Array (%s) does not accept %s.',

‎src/Rules/FunctionCallParametersCheck.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ static function (Type $type): bool {
254254
&& !$parameter->passedByReference()->createsNewVariable()
255255
&& !$this->ruleLevelHelper->accepts($parameterType, $argumentValueType, $scope->isDeclareStrictTypes())
256256
) {
257-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType);
257+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType, $argumentValueType);
258258
$parameterDescription = sprintf('%s$%s', $parameter->isVariadic() ? '...' : '', $parameter->getName());
259259
$errors[] = RuleErrorBuilder::message(sprintf(
260260
$messages[6],

‎src/Rules/FunctionReturnTypeCheck.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function checkReturnType(
6868
}
6969

7070
$isVoidSuperType = (new VoidType())->isSuperTypeOf($returnType);
71-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType);
71+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType, null);
7272
if ($returnValue === null) {
7373
if (!$isVoidSuperType->no()) {
7474
return [];
@@ -83,6 +83,7 @@ public function checkReturnType(
8383
}
8484

8585
$returnValueType = $scope->getType($returnValue);
86+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType, $returnValueType);
8687

8788
if ($isVoidSuperType->yes()) {
8889
return [

‎src/Rules/Functions/IncompatibleDefaultParameterTypeRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public function processNode(Node $node, Scope $scope): array
5151
continue;
5252
}
5353

54-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType);
54+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType, $defaultValueType);
5555

5656
$errors[] = RuleErrorBuilder::message(sprintf(
5757
'Default value of the parameter #%d $%s (%s) of function %s() is incompatible with type %s.',

‎src/Rules/Generators/YieldFromTypeRule.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ public function processNode(Node $node, Scope $scope): array
8080

8181
$messages = [];
8282
if (!$this->ruleLevelHelper->accepts($returnType->getIterableKeyType(), $exprType->getIterableKeyType(), $scope->isDeclareStrictTypes())) {
83-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableKeyType());
83+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableKeyType(), $exprType->getIterableKeyType());
8484
$messages[] = RuleErrorBuilder::message(sprintf(
8585
'Generator expects key type %s, %s given.',
8686
$returnType->getIterableKeyType()->describe($verbosityLevel),
8787
$exprType->getIterableKeyType()->describe($verbosityLevel)
8888
))->line($node->expr->getLine())->build();
8989
}
9090
if (!$this->ruleLevelHelper->accepts($returnType->getIterableValueType(), $exprType->getIterableValueType(), $scope->isDeclareStrictTypes())) {
91-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableValueType());
91+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableValueType(), $exprType->getIterableValueType());
9292
$messages[] = RuleErrorBuilder::message(sprintf(
9393
'Generator expects value type %s, %s given.',
9494
$returnType->getIterableValueType()->describe($verbosityLevel),

‎src/Rules/Generators/YieldTypeRule.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ public function processNode(Node $node, Scope $scope): array
6464

6565
$messages = [];
6666
if (!$this->ruleLevelHelper->accepts($returnType->getIterableKeyType(), $keyType, $scope->isDeclareStrictTypes())) {
67-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableKeyType());
67+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableKeyType(), $keyType);
6868
$messages[] = RuleErrorBuilder::message(sprintf(
6969
'Generator expects key type %s, %s given.',
7070
$returnType->getIterableKeyType()->describe($verbosityLevel),
7171
$keyType->describe($verbosityLevel)
7272
))->build();
7373
}
7474
if (!$this->ruleLevelHelper->accepts($returnType->getIterableValueType(), $valueType, $scope->isDeclareStrictTypes())) {
75-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableValueType());
75+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($returnType->getIterableValueType(), $valueType);
7676
$messages[] = RuleErrorBuilder::message(sprintf(
7777
'Generator expects value type %s, %s given.',
7878
$returnType->getIterableValueType()->describe($verbosityLevel),

‎src/Rules/Methods/IncompatibleDefaultParameterTypeRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function processNode(Node $node, Scope $scope): array
5252
continue;
5353
}
5454

55-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType);
55+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($parameterType, $defaultValueType);
5656

5757
$errors[] = RuleErrorBuilder::message(sprintf(
5858
'Default value of the parameter #%d $%s (%s) of method %s::%s() is incompatible with type %s.',

‎src/Rules/Properties/DefaultValueTypesAssignedToPropertiesRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function processNode(Node $node, Scope $scope): array
5252
return [];
5353
}
5454

55-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($propertyType);
55+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($propertyType, $defaultValueType);
5656

5757
return [
5858
RuleErrorBuilder::message(sprintf(

‎src/Rules/Properties/TypesAssignedToPropertiesRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ private function processSingleProperty(
8989
}
9090
if (!$this->ruleLevelHelper->accepts($propertyType, $assignedValueType, $scope->isDeclareStrictTypes())) {
9191
$propertyDescription = $this->propertyDescriptor->describePropertyByName($propertyReflection, $propertyReflection->getName());
92-
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($propertyType);
92+
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($propertyType, $assignedValueType);
9393

9494
return [
9595
RuleErrorBuilder::message(sprintf(

‎src/Type/VerbosityLevel.php

+48-3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
use PHPStan\Type\Accessory\AccessoryNumericStringType;
66
use PHPStan\Type\Accessory\NonEmptyArrayType;
7+
use PHPStan\Type\Generic\GenericObjectType;
8+
use PHPStan\Type\Generic\TemplateType;
79

810
class VerbosityLevel
911
{
@@ -49,10 +51,9 @@ public static function cache(): self
4951
return self::create(self::CACHE);
5052
}
5153

52-
public static function getRecommendedLevelByType(Type $type): self
54+
public static function getRecommendedLevelByType(Type $acceptingType, ?Type $acceptedType = null): self
5355
{
54-
$moreVerbose = false;
55-
TypeTraverser::map($type, static function (Type $type, callable $traverse) use (&$moreVerbose): Type {
56+
$moreVerboseCallback = static function (Type $type, callable $traverse) use (&$moreVerbose): Type {
5657
if ($type->isCallable()->yes()) {
5758
$moreVerbose = true;
5859
return $type;
@@ -69,9 +70,53 @@ public static function getRecommendedLevelByType(Type $type): self
6970
$moreVerbose = true;
7071
return $type;
7172
}
73+
return $traverse($type);
74+
};
75+
76+
/** @var bool $moreVerbose */
77+
$moreVerbose = false;
78+
TypeTraverser::map($acceptingType, $moreVerboseCallback);
79+
80+
if ($moreVerbose) {
81+
return self::value();
82+
}
83+
84+
if ($acceptedType === null) {
85+
return self::typeOnly();
86+
}
87+
88+
$containsInvariantTemplateType = false;
89+
TypeTraverser::map($acceptingType, static function (Type $type, callable $traverse) use (&$containsInvariantTemplateType): Type {
90+
if ($type instanceof GenericObjectType) {
91+
$reflection = $type->getClassReflection();
92+
if ($reflection !== null) {
93+
$templateTypeMap = $reflection->getTemplateTypeMap();
94+
foreach ($templateTypeMap->getTypes() as $templateType) {
95+
if (!$templateType instanceof TemplateType) {
96+
continue;
97+
}
98+
99+
if (!$templateType->getVariance()->invariant()) {
100+
continue;
101+
}
102+
103+
$containsInvariantTemplateType = true;
104+
return $type;
105+
}
106+
}
107+
}
108+
72109
return $traverse($type);
73110
});
74111

112+
if (!$containsInvariantTemplateType) {
113+
return self::typeOnly();
114+
}
115+
116+
/** @var bool $moreVerbose */
117+
$moreVerbose = false;
118+
TypeTraverser::map($acceptedType, $moreVerboseCallback);
119+
75120
return $moreVerbose ? self::value() : self::typeOnly();
76121
}
77122

‎tests/PHPStan/Rules/Methods/ReturnTypeRuleTest.php

+18
Original file line numberDiff line numberDiff line change
@@ -426,4 +426,22 @@ public function testInferArrayKey(): void
426426
$this->analyse([__DIR__ . '/data/infer-array-key.php'], []);
427427
}
428428

429+
public function testBug4590(): void
430+
{
431+
$this->analyse([__DIR__ . '/data/bug-4590.php'], [
432+
[
433+
'Method Bug4590\Controller::test1() should return Bug4590\OkResponse<array<string, string>> but returns Bug4590\OkResponse<array(\'ok\' => string)>.',
434+
39,
435+
],
436+
[
437+
'Method Bug4590\Controller::test2() should return Bug4590\OkResponse<array<int, string>> but returns Bug4590\OkResponse<array(string)>.',
438+
47,
439+
],
440+
[
441+
'Method Bug4590\Controller::test3() should return Bug4590\OkResponse<array<string>> but returns Bug4590\OkResponse<array(string)>.',
442+
55,
443+
],
444+
]);
445+
}
446+
429447
}

‎tests/PHPStan/Rules/Methods/data/bug-4590.php

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?php
2+
3+
namespace Bug4590;
4+
5+
/**
6+
* @template T
7+
*/
8+
class OkResponse
9+
{
10+
/**
11+
* @phpstan-var T
12+
*/
13+
private $body;
14+
15+
/**
16+
* @phpstan-param T $body
17+
*/
18+
public function __construct($body)
19+
{
20+
$this->body = $body;
21+
}
22+
23+
/**
24+
* @phpstan-return T
25+
*/
26+
public function getBody()
27+
{
28+
return $this->body;
29+
}
30+
}
31+
32+
class Controller
33+
{
34+
/**
35+
* @return OkResponse<array<string, string>>
36+
*/
37+
public function test1(): OkResponse
38+
{
39+
return new OkResponse(["ok" => "hello"]);
40+
}
41+
42+
/**
43+
* @return OkResponse<array<int, string>>
44+
*/
45+
public function test2(): OkResponse
46+
{
47+
return new OkResponse([0 => "hello"]);
48+
}
49+
50+
/**
51+
* @return OkResponse<string[]>
52+
*/
53+
public function test3(): OkResponse
54+
{
55+
return new OkResponse(["hello"]);
56+
}
57+
58+
/**
59+
* @return OkResponse<string>
60+
*/
61+
public function test4(): OkResponse
62+
{
63+
return new OkResponse("hello");
64+
}
65+
66+
/**
67+
* @param array<int, string> $a
68+
* @return OkResponse<array<int, string>>
69+
*/
70+
public function test5(array $a): OkResponse
71+
{
72+
return new OkResponse($a);
73+
}
74+
75+
}

0 commit comments

Comments
 (0)