[container] read the DI required annotation (#100)

Author: adrienlucas

src/Handler/RequiredSetterHandler.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psalm\SymfonyPsalmPlugin\Handler;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\NodeTraverser;
+use Psalm\Codebase;
+use Psalm\FileSource;
+use Psalm\Internal\PhpVisitor\AssignmentMapVisitor;
+use Psalm\Plugin\Hook\AfterClassLikeVisitInterface;
+use Psalm\Storage\ClassLikeStorage;
+
+class RequiredSetterHandler implements AfterClassLikeVisitInterface
+{
+    public static function afterClassLikeVisit(ClassLike $stmt, ClassLikeStorage $storage, FileSource $statements_source, Codebase $codebase, array &$file_replacements = [])
+    {
+        if (!$stmt instanceof Class_) {
+            return;
+        }
+
+        foreach ($stmt->getMethods() as $method) {
+            $docComment = $method->getDocComment();
+
+            if ($docComment instanceof Doc && false !== strpos($docComment->getText(), '@required')) {
+                $traverser = new NodeTraverser();
+                $visitor = new AssignmentMapVisitor(null);
+                $traverser->addVisitor($visitor);
+                $traverser->traverse($method->getStmts() ?? []);
+
+                foreach (array_keys($visitor->getAssignmentMap()) as $assignment) {
+                    if (0 !== strpos($assignment, '$this->')) {
+                        continue;
+                    }
+
+                    $property = substr($assignment, strlen('$this->'));
+                    if (!array_key_exists($property, $storage->properties)) {
+                        continue;
+                    }
+
+                    $storage->initialized_properties[$property] = true;
+                }
+            }
+        }
+    }
+}

src/Plugin.php

@@ -12,6 +12,7 @@
 use Psalm\SymfonyPsalmPlugin\Handler\ContainerHandler;
 use Psalm\SymfonyPsalmPlugin\Handler\DoctrineRepositoryHandler;
 use Psalm\SymfonyPsalmPlugin\Handler\HeaderBagHandler;
+use Psalm\SymfonyPsalmPlugin\Handler\RequiredSetterHandler;
 use Psalm\SymfonyPsalmPlugin\Symfony\ContainerMeta;
 use Psalm\SymfonyPsalmPlugin\Twig\AnalyzedTemplatesTainter;
 use Psalm\SymfonyPsalmPlugin\Twig\CachedTemplatesMapping;
@@ -53,10 +54,12 @@ public function __invoke(RegistrationInterface $api, SimpleXMLElement $config =
         require_once __DIR__.'/Handler/ContainerHandler.php';
         require_once __DIR__.'/Handler/ConsoleHandler.php';
         require_once __DIR__.'/Handler/ContainerDependencyHandler.php';
+        require_once __DIR__.'/Handler/RequiredSetterHandler.php';
 
         $api->registerHooksFromClass(HeaderBagHandler::class);
         $api->registerHooksFromClass(ConsoleHandler::class);
         $api->registerHooksFromClass(ContainerDependencyHandler::class);
+        $api->registerHooksFromClass(RequiredSetterHandler::class);
 
         if (class_exists(AnnotationRegistry::class)) {
             require_once __DIR__.'/Handler/DoctrineRepositoryHandler.php';

tests/acceptance/acceptance/RequiredSetter.feature

@@ -0,0 +1,58 @@
+@symfony-common
+Feature: Annotation class
+
+  Background:
+    Given I have the following config
+      """
+      <?xml version="1.0"?>
+      <psalm errorLevel="1">
+        <projectFiles>
+          <directory name="."/>
+          <ignoreFiles> <directory name="../../vendor"/> </ignoreFiles>
+        </projectFiles>
+
+        <plugins>
+          <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
+            <containerXml>../../tests/acceptance/container.xml</containerXml>
+          </pluginClass>
+        </plugins>
+      </psalm>
+      """
+
+  Scenario: PropertyNotSetInConstructor error is not raised when the @required annotation is present.
+    Given I have the following code
+      """
+      <?php
+      final class MyServiceA {
+      }
+
+      final class MyServiceB {
+          private MyServiceA $a;
+          public function __construct(){}
+
+          /** @required */
+          private function setMyServiceA(MyServiceA $a): void { $this->a = $a; }
+      }
+      """
+    When I run Psalm
+    Then I see no errors
+
+  Scenario: PropertyNotSetInConstructor error is raised when the @required annotation is not present.
+    Given I have the following code
+      """
+      <?php
+      final class MyServiceA {
+      }
+
+      final class MyServiceB {
+          private MyServiceA $a;
+          public function __construct(){}
+
+          private function setMyServiceA(MyServiceA $a): void { $this->a = $a; }
+      }
+      """
+    When I run Psalm
+    Then I see these errors
+      | Type                        | Message                                                                                                                           |
+      | PropertyNotSetInConstructor | Property MyServiceB::$a is not defined in constructor of MyServiceB and in any private or final methods called in the constructor |
+    And I see no other errors