Skip to content

Commit f962e83

Browse files
raalderinkraalderink
committed
Set properties autowired with @required as initialized
1 parent db75c81 commit f962e83

10 files changed

+294
-23
lines changed

‎composer.json

+1-1
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.14"
1919
},
2020
"conflict": {
2121
"symfony/framework-bundle": "<3.0"

‎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

+15
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,16 @@ parameters:
1015
count: 1
1116
path: tests/Rules/NonexistentInputBagClassTest.php
1217

18+
-
19+
message: "#^Creating new PHPStan\\\\Reflection\\\\ConstructorsHelper 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+
23+
-
24+
message: "#^Creating new PHPStan\\\\Rules\\\\Properties\\\\UninitializedPropertyRule is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
25+
count: 1
26+
path: tests/Symfony/RequiredAutowiringExtensionTest.php
27+
1328
-
1429
message: "#^Accessing PHPStan\\\\Rules\\\\Comparison\\\\ImpossibleCheckTypeMethodCallRule\\:\\:class is not covered by backward compatibility promise\\. The class might change in a minor PHPStan version\\.$#"
1530
count: 1

‎src/Symfony/RequiredAutowiringExtension.php

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

‎tests/Symfony/RequiredAutowiringExtensionTest.php

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

‎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

‎tests/Type/Symfony/ExtensionTest.php

+20-20
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,49 @@ class ExtensionTest extends TypeInferenceTestCase
1414
/** @return mixed[] */
1515
public function dataFileAsserts(): iterable
1616
{
17-
yield from $this->gatherAssertTypes(__DIR__ . '/data/envelope_all.php');
18-
yield from $this->gatherAssertTypes(__DIR__ . '/data/header_bag_get.php');
19-
yield from $this->gatherAssertTypes(__DIR__ . '/data/response_header_bag_get_cookies.php');
17+
yield from self::gatherAssertTypes(__DIR__ . '/data/envelope_all.php');
18+
yield from self::gatherAssertTypes(__DIR__ . '/data/header_bag_get.php');
19+
yield from self::gatherAssertTypes(__DIR__ . '/data/response_header_bag_get_cookies.php');
2020

2121
if (class_exists('Symfony\Component\HttpFoundation\InputBag')) {
22-
yield from $this->gatherAssertTypes(__DIR__ . '/data/input_bag.php');
22+
yield from self::gatherAssertTypes(__DIR__ . '/data/input_bag.php');
2323
}
2424

25-
yield from $this->gatherAssertTypes(__DIR__ . '/data/tree_builder.php');
25+
yield from self::gatherAssertTypes(__DIR__ . '/data/tree_builder.php');
2626

27-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleBaseCommand.php');
28-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleOptionCommand.php');
29-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleOptionLazyCommand.php');
30-
yield from $this->gatherAssertTypes(__DIR__ . '/data/kernel_interface.php');
31-
yield from $this->gatherAssertTypes(__DIR__ . '/data/request_get_content.php');
27+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleBaseCommand.php');
28+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleOptionCommand.php');
29+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleOptionLazyCommand.php');
30+
yield from self::gatherAssertTypes(__DIR__ . '/data/kernel_interface.php');
31+
yield from self::gatherAssertTypes(__DIR__ . '/data/request_get_content.php');
3232

3333
$ref = new ReflectionMethod(Request::class, 'getSession');
3434
$doc = (string) $ref->getDocComment();
3535
if (strpos($doc, '@return SessionInterface|null') !== false) {
36-
yield from $this->gatherAssertTypes(__DIR__ . '/data/request_get_session_null.php');
36+
yield from self::gatherAssertTypes(__DIR__ . '/data/request_get_session_null.php');
3737
} else {
38-
yield from $this->gatherAssertTypes(__DIR__ . '/data/request_get_session.php');
38+
yield from self::gatherAssertTypes(__DIR__ . '/data/request_get_session.php');
3939
}
4040

4141
if (class_exists('Symfony\Bundle\FrameworkBundle\Controller\Controller')) {
42-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleController.php');
42+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleController.php');
4343
}
4444

4545
if (class_exists('Symfony\Bundle\FrameworkBundle\Controller\AbstractController')) {
46-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleAbstractController.php');
46+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleAbstractController.php');
4747
}
4848

49-
yield from $this->gatherAssertTypes(__DIR__ . '/data/serializer.php');
49+
yield from self::gatherAssertTypes(__DIR__ . '/data/serializer.php');
5050

5151
if (class_exists('Symfony\Component\HttpFoundation\InputBag')) {
52-
yield from $this->gatherAssertTypes(__DIR__ . '/data/input_bag_from_request.php');
52+
yield from self::gatherAssertTypes(__DIR__ . '/data/input_bag_from_request.php');
5353
}
5454

55-
yield from $this->gatherAssertTypes(__DIR__ . '/data/denormalizer.php');
55+
yield from self::gatherAssertTypes(__DIR__ . '/data/denormalizer.php');
5656

57-
yield from $this->gatherAssertTypes(__DIR__ . '/data/FormInterface_getErrors.php');
58-
yield from $this->gatherAssertTypes(__DIR__ . '/data/cache.php');
59-
yield from $this->gatherAssertTypes(__DIR__ . '/data/form_data_type.php');
57+
yield from self::gatherAssertTypes(__DIR__ . '/data/FormInterface_getErrors.php');
58+
yield from self::gatherAssertTypes(__DIR__ . '/data/cache.php');
59+
yield from self::gatherAssertTypes(__DIR__ . '/data/form_data_type.php');
6060
}
6161

6262
/**

‎tests/Type/Symfony/ExtensionTestWithoutContainer.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public function dataExampleController(): iterable
1515
return;
1616
}
1717

18-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleController.php');
18+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleController.php');
1919
}
2020

2121
/** @return mixed[] */
@@ -25,7 +25,7 @@ public function dataAbstractController(): iterable
2525
return;
2626
}
2727

28-
yield from $this->gatherAssertTypes(__DIR__ . '/data/ExampleAbstractController.php');
28+
yield from self::gatherAssertTypes(__DIR__ . '/data/ExampleAbstractController.php');
2929
}
3030

3131
/**

0 commit comments

Comments
 (0)