Skip to content

Commit 8724f2b

Browse files
raalderinkondrejmirtes
raalderink
authored and
ondrejmirtes
committed
Set properties autowired with @required as initialized
1 parent abc7682 commit 8724f2b

8 files changed

+258
-2
lines changed

‎composer.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"require": {
1616
"php": "^7.2 || ^8.0",
1717
"ext-simplexml": "*",
18-
"phpstan/phpstan": "^1.9.18"
18+
"phpstan/phpstan": "^1.10.36"
1919
},
2020
"conflict": {
2121
"symfony/framework-bundle": "<3.0"
@@ -35,7 +35,8 @@
3535
"symfony/http-foundation": "^5.4 || ^6.1",
3636
"symfony/messenger": "^5.4",
3737
"symfony/polyfill-php80": "^1.24",
38-
"symfony/serializer": "^5.4"
38+
"symfony/serializer": "^5.4",
39+
"symfony/service-contracts": "^2.2.0"
3940
},
4041
"config": {
4142
"sort-packages": true

‎extension.neon

+7
Original file line numberDiff line numberDiff line change
@@ -329,3 +329,10 @@ services:
329329
-
330330
factory: PHPStan\Type\Symfony\InputBagTypeSpecifyingExtension
331331
tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
332+
333+
# Additional constructors and initialization checks for @required autowiring
334+
-
335+
class: PHPStan\Symfony\RequiredAutowiringExtension
336+
tags:
337+
- phpstan.properties.readWriteExtension
338+
- phpstan.additionalConstructorsExtension

‎phpstan-baseline.neon

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
parameters:
22
ignoreErrors:
3+
-
4+
message: "#^Although PHPStan\\\\Reflection\\\\Php\\\\PhpPropertyReflection is covered by backward compatibility promise, this instanceof assumption might break because it's not guaranteed to always stay the same\\.$#"
5+
count: 1
6+
path: src/Symfony/RequiredAutowiringExtension.php
7+
38
-
49
message: "#^Call to function method_exists\\(\\) with Symfony\\\\Component\\\\Console\\\\Input\\\\InputOption and 'isNegatable' will always evaluate to true\\.$#"
510
count: 1
@@ -10,6 +15,11 @@ parameters:
1015
count: 1
1116
path: tests/Rules/NonexistentInputBagClassTest.php
1217

18+
-
19+
message: "#^Accessing PHPStan\\\\Rules\\\\Properties\\\\UninitializedPropertyRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
20+
count: 1
21+
path: tests/Symfony/RequiredAutowiringExtensionTest.php
22+
1323
-
1424
message: "#^Accessing PHPStan\\\\Rules\\\\Comparison\\\\ImpossibleCheckTypeMethodCallRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
1525
count: 1

‎src/Symfony/RequiredAutowiringExtension.php

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Symfony;
4+
5+
use PHPStan\Reflection\AdditionalConstructorsExtension;
6+
use PHPStan\Reflection\ClassReflection;
7+
use PHPStan\Reflection\Php\PhpPropertyReflection;
8+
use PHPStan\Reflection\PropertyReflection;
9+
use PHPStan\Rules\Properties\ReadWritePropertiesExtension;
10+
use PHPStan\Type\FileTypeMapper;
11+
use function count;
12+
13+
class RequiredAutowiringExtension implements ReadWritePropertiesExtension, AdditionalConstructorsExtension
14+
{
15+
16+
/** @var FileTypeMapper */
17+
private $fileTypeMapper;
18+
19+
public function __construct(FileTypeMapper $fileTypeMapper)
20+
{
21+
$this->fileTypeMapper = $fileTypeMapper;
22+
}
23+
24+
public function isAlwaysRead(PropertyReflection $property, string $propertyName): bool
25+
{
26+
return false;
27+
}
28+
29+
public function isAlwaysWritten(PropertyReflection $property, string $propertyName): bool
30+
{
31+
return false;
32+
}
33+
34+
public function isInitialized(PropertyReflection $property, string $propertyName): bool
35+
{
36+
// If the property is public, check for @required on the property itself
37+
if (!$property->isPublic()) {
38+
return false;
39+
}
40+
41+
if ($property->getDocComment() !== null && $this->isRequiredFromDocComment($property->getDocComment())) {
42+
return true;
43+
}
44+
45+
// Check for the attribute version
46+
if ($property instanceof PhpPropertyReflection && count($property->getNativeReflection()->getAttributes('Symfony\Contracts\Service\Attribute\Required')) > 0) {
47+
return true;
48+
}
49+
50+
return false;
51+
}
52+
53+
public function getAdditionalConstructors(ClassReflection $classReflection): array
54+
{
55+
$additionalConstructors = [];
56+
$nativeReflection = $classReflection->getNativeReflection();
57+
58+
foreach ($nativeReflection->getMethods() as $method) {
59+
if (!$method->isPublic()) {
60+
continue;
61+
}
62+
63+
if ($method->getDocComment() !== false && $this->isRequiredFromDocComment($method->getDocComment())) {
64+
$additionalConstructors[] = $method->getName();
65+
}
66+
67+
if (count($method->getAttributes('Symfony\Contracts\Service\Attribute\Required')) === 0) {
68+
continue;
69+
}
70+
71+
$additionalConstructors[] = $method->getName();
72+
}
73+
74+
return $additionalConstructors;
75+
}
76+
77+
private function isRequiredFromDocComment(string $docComment): bool
78+
{
79+
$phpDoc = $this->fileTypeMapper->getResolvedPhpDoc(null, null, null, null, $docComment);
80+
81+
foreach ($phpDoc->getPhpDocNodes() as $node) {
82+
// @required tag is available, meaning this property is always initialized
83+
if (count($node->getTagsByName('@required')) > 0) {
84+
return true;
85+
}
86+
}
87+
88+
return false;
89+
}
90+
91+
}

‎tests/Symfony/RequiredAutowiringExtensionTest.php

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Symfony;
4+
5+
use PHPStan\Reflection\AdditionalConstructorsExtension;
6+
use PHPStan\Rules\Properties\UninitializedPropertyRule;
7+
use PHPStan\Rules\Rule;
8+
use PHPStan\Testing\RuleTestCase;
9+
use Symfony\Contracts\Service\Attribute\Required;
10+
use function class_exists;
11+
12+
/**
13+
* @extends RuleTestCase<UninitializedPropertyRule>
14+
*/
15+
final class RequiredAutowiringExtensionTest extends RuleTestCase
16+
{
17+
18+
protected function getRule(): Rule
19+
{
20+
$container = self::getContainer();
21+
$container->getServicesByTag(AdditionalConstructorsExtension::EXTENSION_TAG);
22+
23+
return $container->getByType(UninitializedPropertyRule::class);
24+
}
25+
26+
public function testRequiredAnnotations(): void
27+
{
28+
$this->analyse([__DIR__ . '/data/required-annotations.php'], [
29+
[
30+
'Class RequiredAnnotationTest\TestAnnotations has an uninitialized property $three. Give it default value or assign it in the constructor.',
31+
12,
32+
],
33+
[
34+
'Class RequiredAnnotationTest\TestAnnotations has an uninitialized property $four. Give it default value or assign it in the constructor.',
35+
14,
36+
],
37+
]);
38+
}
39+
40+
public function testRequiredAttributes(): void
41+
{
42+
if (!class_exists(Required::class)) {
43+
self::markTestSkipped('Required symfony/[email protected] or higher is not installed');
44+
}
45+
46+
$this->analyse([__DIR__ . '/data/required-attributes.php'], [
47+
[
48+
'Class RequiredAttributesTest\TestAttributes has an uninitialized property $three. Give it default value or assign it in the constructor.',
49+
14,
50+
],
51+
[
52+
'Class RequiredAttributesTest\TestAttributes has an uninitialized property $four. Give it default value or assign it in the constructor.',
53+
16,
54+
],
55+
]);
56+
}
57+
58+
public static function getAdditionalConfigFiles(): array
59+
{
60+
return [
61+
__DIR__ . '/required-autowiring-config.neon',
62+
];
63+
}
64+
65+
}

‎tests/Symfony/data/required-annotations.php

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php // lint >= 7.4
2+
3+
namespace RequiredAnnotationTest;
4+
5+
class TestAnnotations
6+
{
7+
/** @required */
8+
public string $one;
9+
10+
private string $two;
11+
12+
public string $three;
13+
14+
private string $four;
15+
16+
/**
17+
* @required
18+
*/
19+
public function setTwo(int $two): void
20+
{
21+
$this->two = $two;
22+
}
23+
24+
public function getTwo(): int
25+
{
26+
return $this->two;
27+
}
28+
29+
public function setFour(int $four): void
30+
{
31+
$this->four = $four;
32+
}
33+
34+
public function getFour(): int
35+
{
36+
return $this->four;
37+
}
38+
}

‎tests/Symfony/data/required-attributes.php

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php // lint >= 8.0
2+
3+
namespace RequiredAttributesTest;
4+
5+
use Symfony\Contracts\Service\Attribute\Required;
6+
7+
class TestAttributes
8+
{
9+
#[Required]
10+
public string $one;
11+
12+
private string $two;
13+
14+
public string $three;
15+
16+
private string $four;
17+
18+
#[Required]
19+
public function setTwo(int $two): void
20+
{
21+
$this->two = $two;
22+
}
23+
24+
public function getTwo(): int
25+
{
26+
return $this->two;
27+
}
28+
29+
public function setFour(int $four): void
30+
{
31+
$this->four = $four;
32+
}
33+
34+
public function getFour(): int
35+
{
36+
return $this->four;
37+
}
38+
}

‎tests/Symfony/required-autowiring-config.neon

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
services:
2+
-
3+
class: PHPStan\Symfony\RequiredAutowiringExtension
4+
tags:
5+
- phpstan.properties.readWriteExtension
6+
- phpstan.additionalConstructorsExtension

0 commit comments

Comments
 (0)