Merge branch '1.0.0-develop' into fixed-plugin-inspection-closure

Vitaliy · web-flow · commit f8929b06e4fe · 2020-04-20T16:35:49.000+03:00
diff --git a/resources/magento2/inspection.properties b/resources/magento2/inspection.properties
@@ -1,2 +1,3 @@
 inspection.plugin.duplicateInSameFile=The plugin name already used in this file. For more details see Inspection Description.
-inspection.plugin.duplicateInOtherPlaces=The plugin name "{0}" for targeted "{1}" class is already used in the module "{2}" ({3} scope). For more details see Inspection Description.
+inspection.plugin.duplicateInOtherPlaces=The plugin name "{0}" for targeted "{1}" class is already used in the module "{2}" ({3} scope). For more details see Inspection Description.
+inspection.graphql.resolver.mustImplement=Class must implements any of the following interfaces: \\Magento\\Framework\\GraphQl\\Query\\ResolverInterface, \\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchResolverInterface, \\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchServiceContractResolverInterface
diff --git a/src/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspection.java b/src/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspection.java
@@ -12,6 +12,7 @@
 import com.jetbrains.php.lang.inspections.PhpInspection;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import com.magento.idea.magento2plugin.bundles.InspectionBundle;
 import com.magento.idea.magento2plugin.inspections.php.fix.PhpImplementResolverClassQuickFix;
 import com.magento.idea.magento2plugin.util.magento.graphql.GraphQlUsagesCollector;
 import com.magento.idea.magento2plugin.util.magento.graphql.GraphQlUtil;
@@ -21,7 +22,7 @@
 
 public class GraphQlResolverInspection extends PhpInspection {
 
-    public static final String GraphQlResolverProblemDescription = "Class must implements \\Magento\\Framework\\GraphQl\\Query\\ResolverInterface";
+    private final InspectionBundle inspectionBundle = new InspectionBundle();
 
     @NotNull
     @Override
@@ -32,11 +33,13 @@ public void visitPhpClass(PhpClass resolverClass) {
                 GraphQlUsagesCollector collector = new GraphQlUsagesCollector();
                 results = collector.getGraphQLUsages(resolverClass);
                 if (results.size() > 0 ) {
-                    if (GraphQlUtil.isResolver(resolverClass)) {
+                    if (!GraphQlUtil.isResolver(resolverClass)) {
                         PsiElement currentClassNameIdentifier = resolverClass.getNameIdentifier();
                         assert currentClassNameIdentifier != null;
                         problemsHolder.registerProblem(currentClassNameIdentifier,
-                                GraphQlResolverProblemDescription,
+                                inspectionBundle.message(
+                                    "inspection.graphql.resolver.mustImplement"
+                                ),
                                 ProblemHighlightType.ERROR,
                                 new PhpImplementResolverClassQuickFix());
                     }
diff --git a/src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java b/src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java
@@ -71,6 +71,9 @@ public void visitFile(PsiFile file) {
                     }
 
                     List<XmlTag> targetObservers = fetchObserverTagsFromEventTag(eventXmlTag);
+                    if (targetObservers.isEmpty()) {
+                        continue;
+                    }
 
                     for (XmlTag observerXmlTag: targetObservers) {
                         XmlAttribute observerNameAttribute = observerXmlTag.getAttribute("name");
diff --git a/src/com/magento/idea/magento2plugin/linemarker/php/GraphQlResolverUsageLineMarkerProvider.java b/src/com/magento/idea/magento2plugin/linemarker/php/GraphQlResolverUsageLineMarkerProvider.java
@@ -39,7 +39,7 @@ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNu
             if (psiElement instanceof PhpClass) {
                 List<? extends PsiElement> results;
 
-                if (GraphQlUtil.isResolver((PhpClass) psiElement)) {
+                if (!GraphQlUtil.isResolver((PhpClass) psiElement)) {
                     return;
                 }
                 GraphQlUsagesCollector collector = new GraphQlUsagesCollector();
diff --git a/src/com/magento/idea/magento2plugin/magento/files/GraphQlResolver.java b/src/com/magento/idea/magento2plugin/magento/files/GraphQlResolver.java
@@ -6,5 +6,7 @@
 
 public class GraphQlResolver {
     public static final String RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\ResolverInterface";
+    public static final String BATCH_RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchResolverInterface";
+    public static final String BATCH_SERVICE_CONTRACT_RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchServiceContractResolverInterface";
     public static final String CLASS_ARGUMENT = "class";
 }
diff --git a/src/com/magento/idea/magento2plugin/util/magento/graphql/GraphQlUtil.java b/src/com/magento/idea/magento2plugin/util/magento/graphql/GraphQlUtil.java
@@ -44,14 +44,19 @@ public static GraphQLStringValue fetchResolverQuotedStringFromArgument(PsiElemen
         return argumentStringValue;
     }
 
-    public static boolean isResolver(PhpClass psiElement) {
+    public static boolean  isResolver(PhpClass psiElement) {
         PhpClass[] implementedInterfaces = psiElement.getImplementedInterfaces();
         for (PhpClass implementedInterface: implementedInterfaces) {
-            if (!implementedInterface.getFQN().equals(GraphQlResolver.RESOLVER_INTERFACE)) {
-                continue;
+            if (implementedInterface.getFQN().equals(
+                GraphQlResolver.RESOLVER_INTERFACE
+            ) || implementedInterface.getFQN().equals(
+                GraphQlResolver.BATCH_RESOLVER_INTERFACE
+            ) || implementedInterface.getFQN().equals(
+                GraphQlResolver.BATCH_SERVICE_CONTRACT_RESOLVER_INTERFACE
+            )) {
+                return true;
             }
-            return false;
         }
-        return true;
+        return false;
     }
 }
diff --git a/testData/inspections/php/GraphQlResolverInspection/withInvalidResolverInterface/ResolverTest.php b/testData/inspections/php/GraphQlResolverInspection/withInvalidResolverInterface/ResolverTest.php
@@ -5,7 +5,8 @@
  */
 namespace Magento\Test;
 use Magento\Framework\GraphQl\Query\InvalidInterface;
-class <error descr="Class must implements \Magento\Framework\GraphQl\Query\ResolverInterface">InvalidResolverTest</error> implements InvalidInterface
+
+class ResolverTest implements InvalidInterface
 {
 }
 ?>
diff --git a/testData/inspections/php/GraphQlResolverInspection/withValidBatchResolverInterface/ResolverTest.php b/testData/inspections/php/GraphQlResolverInspection/withValidBatchResolverInterface/ResolverTest.php
@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Test;
+class ResolverTest implements \Magento\Framework\GraphQl\Query\Resolver\BatchResolverInterface
+{
+}
+?>
diff --git a/testData/inspections/php/GraphQlResolverInspection/withValidBatchServiceContractResolverInterface/ResolverTest.php b/testData/inspections/php/GraphQlResolverInspection/withValidBatchServiceContractResolverInterface/ResolverTest.php
@@ -0,0 +1,10 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Test;
+class ResolverTest implements \Magento\Framework\GraphQl\Query\Resolver\BatchServiceContractResolverInterface
+{
+}
+?>
diff --git a/testData/inspections/php/GraphQlResolverInspection/withValidResolverInterface/ResolverTest.php b/testData/inspections/php/GraphQlResolverInspection/withValidResolverInterface/ResolverTest.php
@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 namespace Magento\Test;
-class ValidResolverTest implements \Magento\Framework\GraphQl\Query\ResolverInterface
+class ResolverTest implements \Magento\Framework\GraphQl\Query\ResolverInterface
 {
 }
 ?>
diff --git a/testData/project/magento2/vendor/magento/framework/BatchResolverInterface.php b/testData/project/magento2/vendor/magento/framework/BatchResolverInterface.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Magento\Framework\GraphQl\Query\Resolver;
+
+interface BatchResolverInterface
+{
+}
+
+
diff --git a/testData/project/magento2/vendor/magento/framework/BatchServiceContractResolverInterface.php b/testData/project/magento2/vendor/magento/framework/BatchServiceContractResolverInterface.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Magento\Framework\GraphQl\Query\Resolver;
+
+interface BatchServiceContractResolverInterface
+{
+}
+
+
diff --git a/testData/project/magento2/vendor/magento/framework/ResolverInterface.php b/testData/project/magento2/vendor/magento/framework/ResolverInterface.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Magento\Framework\GraphQl\Query;
+
+interface ResolverInterface
+{
+}
+
+
diff --git a/testData/project/magento2/vendor/magento/module-catalog/etc/schema.graphqls b/testData/project/magento2/vendor/magento/module-catalog/etc/schema.graphqls
@@ -0,0 +1,3 @@
+type Query {
+    test(input: test!): test @resolver(class: "\\Magento\\Test\\ResolverTest") @doc(description: "Test")
+}
diff --git a/tests/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspectionTest.java b/tests/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspectionTest.java
@@ -4,8 +4,15 @@
  */
 package com.magento.idea.magento2plugin.inspections.php;
 
+import com.magento.idea.magento2plugin.bundles.InspectionBundle;
+
 public class GraphQlResolverInspectionTest extends InspectionPhpFixtureTestCase {
 
+    private final InspectionBundle inspectionBundle = new InspectionBundle();
+    private final String errorMessage =  inspectionBundle.message(
+        "inspection.graphql.resolver.mustImplement"
+    );
+
     @Override
     public void setUp() throws Exception {
         super.setUp();
@@ -18,18 +25,26 @@ protected boolean isWriteActionRequired() {
     }
 
     public void testWithInvalidResolverInterface() throws Exception {
-        myFixture.addFileToProject("schema.graphqls", "type Query {" +
-                "InvalidResolverTest: InvalidResolver @resolver(class: \"\\\\Magento\\\\Test\\\\InvalidResolverTest\")" +
-                "}");
-        myFixture.configureByFile(getFixturePath("InvalidResolverTest.php"));
-        myFixture.checkHighlighting();
+        myFixture.configureByFile(getFixturePath("ResolverTest.php"));
+
+        assertHasHighlighting(errorMessage);
     }
 
     public void testWithValidResolverInterface() throws Exception {
-        myFixture.addFileToProject("schema.graphqls", "type mutation {" +
-                "    ValidResolverTest(): ValidResolver @resolver(class: \"\\\\Magento\\\\Test\\\\ValidResolverTest\")" +
-                "}");
-        myFixture.configureByFile(getFixturePath("ValidResolverTest.php"));
-        myFixture.checkHighlighting();
+        myFixture.configureByFile(getFixturePath("ResolverTest.php"));
+
+        assertHasNoHighlighting(errorMessage);
+    }
+
+    public void testWithValidBatchResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath("ResolverTest.php"));
+
+        assertHasNoHighlighting(errorMessage);
+    }
+
+    public void testWithValidBatchServiceContractResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath("ResolverTest.php"));
+
+        assertHasNoHighlighting(errorMessage);
     }
 }
diff --git a/tests/com/magento/idea/magento2plugin/inspections/php/InspectionPhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/inspections/php/InspectionPhpFixtureTestCase.java
@@ -1,8 +1,13 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin.inspections.php;
 
+import com.intellij.codeInsight.daemon.impl.HighlightInfo;
 import com.magento.idea.magento2plugin.BaseProjectTestCase;
-
 import java.io.File;
+import java.util.List;
 
 abstract public class InspectionPhpFixtureTestCase extends BaseProjectTestCase {
 
@@ -23,4 +28,37 @@ protected boolean isWriteActionRequired() {
     protected String getFixturePath(String fileName) {
         return prepareFixturePath(fileName, fixturesFolderPath);
     }
+
+    protected void assertHasHighlighting(String message) {
+        String highlightingNotFound = "Failed that documents contains highlighting with the description `%s`";
+
+        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
+        if (highlightingList.isEmpty()) {
+            fail(String.format(highlightingNotFound, message));
+        }
+
+        for (HighlightInfo highlighting :
+            highlightingList) {
+            if (highlighting.getDescription().equals(message)) {
+                return;
+            }
+        }
+        fail(String.format(highlightingNotFound, message));
+    }
+
+    protected void assertHasNoHighlighting(String message) {
+        String highlightingFound = "Failed that documents not contains highlighting with the description `%s`";
+
+        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
+        if (highlightingList.isEmpty()) {
+            return;
+        }
+
+        for (HighlightInfo highlighting :
+            highlightingList) {
+            if (highlighting.getDescription().equals(message)) {
+                fail(String.format(highlightingFound, message));
+            }
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,9 @@ public void visitFile(PsiFile file) {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`List<XmlTag> targetObservers = fetchObserverTagsFromEventTag(eventXmlTag);`
	`74`	`+ if (targetObservers.isEmpty()) {`
	`75`	`+ continue;`
	`76`	`+ }`
`74`	`77`
`75`	`78`	`for (XmlTag observerXmlTag: targetObservers) {`
`76`	`79`	`XmlAttribute observerNameAttribute = observerXmlTag.getAttribute("name");`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNu`
`39`	`39`	`if (psiElement instanceof PhpClass) {`
`40`	`40`	`List<? extends PsiElement> results;`
`41`	`41`
`42`		`- if (GraphQlUtil.isResolver((PhpClass) psiElement)) {`
	`42`	`+ if (!GraphQlUtil.isResolver((PhpClass) psiElement)) {`
`43`	`43`	`return;`
`44`	`44`	`}`
`45`	`45`	`GraphQlUsagesCollector collector = new GraphQlUsagesCollector();`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,7 @@`
`6`	`6`
`7`	`7`	`public class GraphQlResolver {`
`8`	`8`	`public static final String RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\ResolverInterface";`
	`9`	`+ public static final String BATCH_RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchResolverInterface";`
	`10`	`+ public static final String BATCH_SERVICE_CONTRACT_RESOLVER_INTERFACE = "\\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchServiceContractResolverInterface";`
`9`	`11`	`public static final String CLASS_ARGUMENT = "class";`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,14 +44,19 @@ public static GraphQLStringValue fetchResolverQuotedStringFromArgument(PsiElemen`
`44`	`44`	`return argumentStringValue;`
`45`	`45`	`}`
`46`	`46`
`47`		`- public static boolean isResolver(PhpClass psiElement) {`
	`47`	`+ public static boolean isResolver(PhpClass psiElement) {`
`48`	`48`	`PhpClass[] implementedInterfaces = psiElement.getImplementedInterfaces();`
`49`	`49`	`for (PhpClass implementedInterface: implementedInterfaces) {`
`50`		`- if (!implementedInterface.getFQN().equals(GraphQlResolver.RESOLVER_INTERFACE)) {`
`51`		`- continue;`
	`50`	`+ if (implementedInterface.getFQN().equals(`
	`51`	`+ GraphQlResolver.RESOLVER_INTERFACE`
	`52`	`+ ) \|\| implementedInterface.getFQN().equals(`
	`53`	`+ GraphQlResolver.BATCH_RESOLVER_INTERFACE`
	`54`	`+ ) \|\| implementedInterface.getFQN().equals(`
	`55`	`+ GraphQlResolver.BATCH_SERVICE_CONTRACT_RESOLVER_INTERFACE`
	`56`	`+ )) {`
	`57`	`+ return true;`
`52`	`58`	`}`
`53`		`- return false;`
`54`	`59`	`}`
`55`		`- return true;`
	`60`	`+ return false;`
`56`	`61`	`}`
`57`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Test;`
`7`	`7`	`use Magento\Framework\GraphQl\Query\InvalidInterface;`
`8`		`-class <error descr="Class must implements \Magento\Framework\GraphQl\Query\ResolverInterface">InvalidResolverTest</error> implements InvalidInterface`
	`8`	`+`
	`9`	`+class ResolverTest implements InvalidInterface`
`9`	`10`	`{`
`10`	`11`	`}`
`11`	`12`	`?>`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Test;`
`7`		`-class ValidResolverTest implements \Magento\Framework\GraphQl\Query\ResolverInterface`
	`7`	`+class ResolverTest implements \Magento\Framework\GraphQl\Query\ResolverInterface`
`8`	`8`	`{`
`9`	`9`	`}`
`10`	`10`	`?>`