Merge pull request #1989 from Haehnchen/feature/1984-deprecated-service

#1984 detected deprecated services usage inside "Autowire" attribute

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/codeInspection/service/ServiceDeprecatedClassesInspection.java

@@ -169,6 +169,20 @@ public void visitElement(PsiElement psiElement) {
                 return;
             }
 
+            // #[Autowire(service: 'foobar')]
+            PsiElement leafText = PsiElementUtils.getTextLeafElementFromStringLiteralExpression((StringLiteralExpression) psiElement);
+
+            if (leafText != null && PhpElementsUtil.getAttributeNamedArgumentStringPattern(ServiceContainerUtil.AUTOWIRE_ATTRIBUTE_CLASS, "service").accepts(leafText)) {
+                String contents = ((StringLiteralExpression) psiElement).getContents();
+                if(StringUtils.isNotBlank(contents)) {
+                    this.problemRegistrar.attachDeprecatedProblem(psiElement, contents, holder);
+                    this.problemRegistrar.attachServiceDeprecatedProblem(psiElement, contents, holder);
+                }
+
+                super.visitElement(psiElement);
+                return;
+            }
+
             MethodReference methodReference = PsiElementUtils.getMethodReferenceWithFirstStringParameter((StringLiteralExpression) psiElement);
             if (methodReference == null || !PhpElementsUtil.isMethodReferenceInstanceOf(methodReference, ServiceContainerUtil.SERVICE_GET_SIGNATURES)) {
                 super.visitElement(psiElement);

src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/inspection/MissingServiceInspection.java

@@ -6,7 +6,6 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
 import com.jetbrains.php.lang.PhpLanguage;
-import com.jetbrains.php.lang.lexer.PhpTokenTypes;
 import com.jetbrains.php.lang.psi.elements.MethodReference;
 import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
@@ -20,8 +19,6 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.yaml.YAMLLanguage;
 
-import java.util.Arrays;
-
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
@@ -59,11 +56,7 @@ public void visitElement(PsiElement element) {
                 }
 
                 // #[Autowire(service: 'foobar')]
-                // get leaf element
-                PsiElement leafText = Arrays.stream(YamlHelper.getChildrenFix(element))
-                    .filter(p -> p.getNode().getElementType() == PhpTokenTypes.STRING_LITERAL_SINGLE_QUOTE || p.getNode().getElementType() == PhpTokenTypes.STRING_LITERAL)
-                    .findFirst()
-                    .orElse(null);
+                PsiElement leafText = PsiElementUtils.getTextLeafElementFromStringLiteralExpression((StringLiteralExpression) element);
 
                 if (leafText != null && PhpElementsUtil.getAttributeNamedArgumentStringPattern(ServiceContainerUtil.AUTOWIRE_ATTRIBUTE_CLASS, "service").accepts(leafText)) {
                     String serviceName = ((StringLiteralExpression) element).getContents();

src/main/java/fr/adrienbrault/idea/symfony2plugin/util/PsiElementUtils.java

@@ -12,7 +12,9 @@
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.Processor;
 import com.jetbrains.php.lang.PhpLanguage;
+import com.jetbrains.php.lang.lexer.PhpTokenTypes;
 import com.jetbrains.php.lang.psi.elements.*;
+import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -389,6 +391,14 @@ public static String getStringBeforeCursor(StringLiteralExpression literal, int
         return content.length() >= cursorOffsetClean ? content.substring(0, cursorOffsetClean) : null;
     }
 
+    @Nullable
+    public static PsiElement getTextLeafElementFromStringLiteralExpression(@NotNull StringLiteralExpression psiElement) {
+        return Arrays.stream(YamlHelper.getChildrenFix(psiElement))
+            .filter(p -> p.getNode().getElementType() == PhpTokenTypes.STRING_LITERAL_SINGLE_QUOTE || p.getNode().getElementType() == PhpTokenTypes.STRING_LITERAL)
+            .findFirst()
+            .orElse(null);
+    }
+
     @NotNull
     public static Collection<PsiFile> convertVirtualFilesToPsiFiles(@NotNull Project project, @NotNull Collection<VirtualFile> files) {
 

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInspection/service/ServiceDeprecatedClassesInspectionTest.java

@@ -36,6 +36,30 @@ public void testPhpServiceDeprecated() {
         );
     }
 
+    public void testPhpServiceInsideAutowireAttributeDeprecated() {
+        assertLocalInspectionContains("foo.php", "<?php" +
+                "\n" +
+                "class HandlerCollection\n" +
+                "{\n" +
+                "    public function __construct(\n" +
+                "        #[\\Symfony\\Component\\DependencyInjection\\Attribute\\Autowire(service: 'foo_depr<caret>ecated')] $handlers\n" +
+                "    ) {}\n" +
+                "}",
+            "Service 'foo_deprecated' is deprecated"
+        );
+
+        assertLocalInspectionContains("foo.php", "<?php" +
+                "\n" +
+                "class HandlerCollection\n" +
+                "{\n" +
+                "    public function __construct(\n" +
+                "        #[\\Symfony\\Component\\DependencyInjection\\Attribute\\Autowire(service: \"foo_depr<caret>ecated\")] $handlers\n" +
+                "    ) {}\n" +
+                "}",
+            "Service 'foo_deprecated' is deprecated"
+        );
+    }
+
     public void testYmlClassDocBlockDeprecated() {
         assertLocalInspectionContains("foo.yml", "@f<caret>oo", "Class 'FooBar' is deprecated");
         assertLocalInspectionContains("foo.yml", "class: Foo\\Bar<caret>\\FooBar", "Class 'FooBar' is deprecated");

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInspection/service/fixtures/classes.php

@@ -25,4 +25,9 @@ interface Twig_ExtensionInterface {}
 namespace Tag\InstanceCheck
 {
     class EmptyClass {}
+}
+
+namespace Symfony\Component\DependencyInjection\Attribute
+{
+    class Autowire {}
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/inspection/fixtures/classes.php

@@ -23,7 +23,7 @@ public function __construct($foobar)
     }
 }
 
-namespace  Symfony\Component\DependencyInjection\Attribute
+namespace Symfony\Component\DependencyInjection\Attribute
 {
     class Autowire {}
 }