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

Add support for @template-contravariant #1492

Closed
wants to merge 4 commits into from
Closed

Add support for @template-contravariant #1492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a368fbe
Add support for @template-contravariant
autaut03 Jul 1, 2022
fd5fa82
Fix missing test stub
autaut03 Jul 1, 2022
3d7710a
Fix Invariant<Out<In<K>>> returns variance checking
autaut03 Jul 2, 2022
200158e
Split method-signature-variance.php test stub into three different te…
autaut03 Jul 10, 2022
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
2 changes: 2 additions & 0 deletions src/PhpDoc/PhpDocNodeResolver.php
View file
Open in desktop
Expand Up @@ -258,6 +258,8 @@ public function resolveTemplateTags(PhpDocNode $phpDocNode, NameScope $nameScope
$variance = TemplateTypeVariance::createInvariant();
} elseif (in_array($tagName, ['@template-covariant', '@psalm-template-covariant', '@phpstan-template-covariant'], true)) {
$variance = TemplateTypeVariance::createCovariant();
} elseif (in_array($tagName, ['@template-contravariant', '@psalm-template-contravariant', '@phpstan-template-contravariant'], true)) {
$variance = TemplateTypeVariance::createContravariant();
} else {
continue;
}
Expand Down
6 changes: 5 additions & 1 deletion src/Type/Generic/TemplateTypeVariance.php
View file
Open in desktop
Expand Up @@ -85,14 +85,18 @@ public function compose(self $other): self

if ($this->covariant()) {
if ($other->contravariant()) {
return self::createCovariant();
return self::createContravariant();
autaut03 marked this conversation as resolved.
Show resolved Hide resolved
}
if ($other->covariant()) {
return self::createCovariant();
}
return self::createInvariant();
}

if ($this->invariant()) {
Copy link
Author

Choose a reason for hiding this comment

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

This change has broken some things. But is this change wrong?

Copy link
Author

Choose a reason for hiding this comment

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

This change is in fact correct, this has also been a bug in PHPStan since 2019. Given the example from the test:

class Base {}
class Extended extends Base {}

/**
 * @template-contravariant K
 */
class B {
	/**
	 * @param Invariant<Out<In<K>>> $l
	 */
	function a($l) {}
}

/**
 * @param B<Extended> $b
 */
function f1($b) {}

/**
 * @param B<Base> $b
 */
function f2($b) {
    f1($b);
}

Without this change, PHPStan would effectively allow changing an invariant type parameter from Out<In<Extended>> to Out<In<Base>>, which is a bug.

@ondrejmirtes Can you verify I'm not wrong so I can fix the tests this has affected?

Copy link
Member

Choose a reason for hiding this comment

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

this has also been a bug in PHPStan since 2019

Can you please show the bug on an existing code on phpstan.org/try? Your example uses @template-contravariant which is a new feature (so it couldn't be a bug in 2019).

Copy link
Author

Choose a reason for hiding this comment

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

Sure thing. Here's a similar example with @template-covariant: https://phpstan.org/r/144953ee-3dfd-4606-a558-b373309ef9c5

It should have given the following error, but it currently passes: Template type K is declared as covariant, but occurs in invariant position in parameter a of method C::a().

Copy link

Choose a reason for hiding this comment

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

Any updates on this @ondrejmirtes? I'd love to finish this PR and get it merged

return self::createInvariant();
}

return $other;
}

Expand Down
177 changes: 177 additions & 0 deletions tests/PHPStan/Rules/Generics/MethodSignatureVarianceRuleTest.php
View file
Open in desktop
Expand Up @@ -44,4 +44,181 @@ public function testRule(): void
]);
}

public function testRuleInvariant(): void
{
$this->analyse([__DIR__ . '/data/method-signature-variance-invariant.php'], []);
}

public function testRuleContravariant(): void
{
$this->analyse([__DIR__ . '/data/method-signature-variance-contravariant.php'], [
[
'Template type K is declared as contravariant, but occurs in covariant position in parameter b of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in parameter d of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter e of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter f of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in parameter i of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter j of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter k of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter l of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter m of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in parameter n of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVarianceContravariant\A::a().',
38,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVarianceContravariant\A::c().',
44,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::e().',
50,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVarianceContravariant\A::f().',
53,
],
[
'Template type K is declared as contravariant, but occurs in covariant position in return type of method MethodSignatureVarianceContravariant\A::g().',
56,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::i().',
62,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::j().',
65,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::k().',
68,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::l().',
71,
],
[
'Template type K is declared as contravariant, but occurs in invariant position in return type of method MethodSignatureVarianceContravariant\A::m().',
74,
],
]);
}

public function testRuleCovariant(): void
{
$this->analyse([__DIR__ . '/data/method-signature-variance-covariant.php'], [
[
'Template type K is declared as covariant, but occurs in contravariant position in parameter a of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in parameter c of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter e of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter f of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in parameter g of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in parameter h of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter j of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter k of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter l of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter m of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in invariant position in parameter n of method MethodSignatureVarianceCovariant\A::a().',
38,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVarianceCovariant\A::b().',
41,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVarianceCovariant\A::d().',
47,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::e().',
50,
],
[
'Template type K is declared as covariant, but occurs in contravariant position in return type of method MethodSignatureVarianceCovariant\A::h().',
59,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::i().',
62,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::j().',
65,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::k().',
68,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::l().',
71,
],
[
'Template type K is declared as covariant, but occurs in invariant position in return type of method MethodSignatureVarianceCovariant\A::m().',
74,
],
]);
}

}
75 changes: 75 additions & 0 deletions tests/PHPStan/Rules/Generics/data/method-signature-variance-contravariant.php
View file
Open in desktop
@@ -0,0 +1,75 @@
<?php

namespace MethodSignatureVarianceContravariant;

/** @template-contravariant T */
interface In {
}

/** @template-covariant T */
interface Out {
}

/** @template T */
interface Invariant {
}

/**
* @template-contravariant K
*/
class A {
/**
* @param K $a
* @param In<K> $b
* @param In<In<K>> $c
* @param In<Out<K>> $d
* @param In<Out<Invariant<K>>> $e
* @param In<Invariant<In<K>>> $f
* @param Out<K> $g
* @param Out<Out<K>> $h
* @param Out<In<K>> $i
* @param Out<In<Invariant<K>>> $j
* @param Out<Invariant<Out<K>>> $k
* @param Invariant<K> $l
* @param Invariant<Invariant<K>> $m
* @param Invariant<Out<In<K>>> $n
* @return K
*/
function a($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) {}

/** @return In<K> */
function b() {}

/** @return In<In<K>> */
function c() {}

/** @return In<Out<K>> */
function d() {}

/** @return In<Out<Invariant<K>>> */
function e() {}

/** @return Out<K> */
function f() {}

/** @return Out<Out<K>> */
function g() {}

/** @return Out<In<K>> */
function h() {}

/** @return Out<In<Invariant<K>>> */
function i() {}

/** @return Invariant<K> */
function j() {}

/** @return Invariant<Invariant<K>> */
function k() {}

/** @return Invariant<In<Out<K>>> */
function l() {}

/** @return Invariant<Out<In<K>>> */
function m() {}
}
75 changes: 75 additions & 0 deletions tests/PHPStan/Rules/Generics/data/method-signature-variance-covariant.php
View file
Open in desktop
@@ -0,0 +1,75 @@
<?php

namespace MethodSignatureVarianceCovariant;

/** @template-contravariant T */
interface In {
}

/** @template-covariant T */
interface Out {
}

/** @template T */
interface Invariant {
}

/**
* @template-covariant K
*/
class A {
/**
* @param K $a
* @param In<K> $b
* @param In<In<K>> $c
* @param In<Out<K>> $d
* @param In<Out<Invariant<K>>> $e
* @param In<Invariant<In<K>>> $f
* @param Out<K> $g
* @param Out<Out<K>> $h
* @param Out<In<K>> $i
* @param Out<In<Invariant<K>>> $j
* @param Out<Invariant<Out<K>>> $k
* @param Invariant<K> $l
* @param Invariant<Invariant<K>> $m
* @param Invariant<Out<In<K>>> $n
* @return K
*/
function a($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) {}

/** @return In<K> */
function b() {}

/** @return In<In<K>> */
function c() {}

/** @return In<Out<K>> */
function d() {}

/** @return In<Out<Invariant<K>>> */
function e() {}

/** @return Out<K> */
function f() {}

/** @return Out<Out<K>> */
function g() {}

/** @return Out<In<K>> */
function h() {}

/** @return Out<In<Invariant<K>>> */
function i() {}

/** @return Invariant<K> */
function j() {}

/** @return Invariant<Invariant<K>> */
function k() {}

/** @return Invariant<In<Out<K>>> */
function l() {}

/** @return Invariant<Out<In<K>>> */
function m() {}
}