Merge pull request #792 from bohdan-harniuk/uct-inspection-used-non-api-reference

andrewbess · web-flow · commit dceb27bfd635 · 2021-11-23T14:24:06.000+01:00
UCT-725: Developed used non api reference inspection, added factory and proxy types support
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -466,6 +466,13 @@
                          enabledByDefault="false"
                          level="WARNING"
                          implementationClass="com.magento.idea.magento2uct.inspections.php.api.UsedNonApiProperty"/>
+        <localInspection language="PHP" groupPath="UCT"
+                         shortName="UsedNonApiType"
+                         bundle="uct.bundle.inspection" key="inspection.displayName.UsedNonApiType"
+                         groupBundle="uct.bundle.inspection" groupKey="inspection.api.group.name"
+                         enabledByDefault="false"
+                         level="WARNING"
+                         implementationClass="com.magento.idea.magento2uct.inspections.php.api.UsedNonApiType"/>
         <!-- \UCT inspection -->
 
         <internalFileTemplate name="Magento Composer JSON"/>
diff --git a/resources/inspectionDescriptions/UsedNonApiType.html b/resources/inspectionDescriptions/UsedNonApiType.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+<p>[1124] The used type is not marked as an API.</p>
+<!-- tooltip end -->
+</body>
+</html>
diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties
@@ -32,6 +32,7 @@ inspection.displayName.OverriddenNonApiConstant=Overridden non Adobe Commerce AP
 inspection.displayName.OverriddenNonApiProperty=Overridden non Adobe Commerce API property
 inspection.displayName.UsedNonApiConstant=Used non Adobe Commerce API constant
 inspection.displayName.UsedNonApiProperty=Used non Adobe Commerce API property
+inspection.displayName.UsedNonApiType=Used non Adobe Commerce API type
 customCode.warnings.deprecated.1131=[1131] Extended class ''{0}'' that is @deprecated in the ''{1}''
 customCode.warnings.deprecated.1132=[1132] Imported class ''{0}'' that is @deprecated in the ''{1}''
 customCode.warnings.deprecated.1134=[1134] Used class ''{0}'' that is @deprecated in the ''{1}''
@@ -62,3 +63,4 @@ customCode.errors.api.1225=[1225] Overridden constant ''{0}'' is not marked as a
 customCode.errors.api.1525=[1525] Overridden property ''{0}'' is not marked as an API
 customCode.errors.api.1224=[1224] Used constant ''{0}'' is not marked as an API
 customCode.errors.api.1524=[1524] Used property ''{0}'' is not marked as an API
+customCode.errors.api.1124=[1124] Used type ''{0}'' is not marked as an API
diff --git a/src/com/magento/idea/magento2uct/inspections/php/UsedTypeInspection.java b/src/com/magento/idea/magento2uct/inspections/php/UsedTypeInspection.java
@@ -11,12 +11,16 @@
 import com.intellij.psi.PsiElementVisitor;
 import com.jetbrains.php.lang.inspections.PhpInspection;
 import com.jetbrains.php.lang.psi.elements.ClassReference;
+import com.jetbrains.php.lang.psi.elements.ExtendsList;
+import com.jetbrains.php.lang.psi.elements.ImplementsList;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.lang.psi.elements.PhpUse;
 import com.jetbrains.php.lang.psi.resolve.types.PhpTypeAnalyserVisitor;
 import com.magento.idea.magento2plugin.magento.packages.MagentoPhpClass;
 import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
 import com.magento.idea.magento2uct.settings.UctSettingsService;
+import com.magento.idea.magento2uct.util.php.ReferenceResolverUtil;
 import org.jetbrains.annotations.NotNull;
 
 public abstract class UsedTypeInspection extends PhpInspection {
@@ -30,14 +34,19 @@ public abstract class UsedTypeInspection extends PhpInspection {
 
             @Override
             public void visitPhpClassReference(final ClassReference reference) {
+                if (reference.getContext() instanceof PhpUse
+                        || reference.getContext() instanceof ExtendsList
+                        || reference.getContext() instanceof ImplementsList) {
+                    return;
+                }
                 final Project project = reference.getProject();
                 final UctSettingsService settings = UctSettingsService.getInstance(project);
 
                 if (!settings.isEnabled()
                         || !settings.isIssueLevelSatisfiable(getSeverityLevel())) {
                     return;
                 }
-                PsiElement resolved = reference.resolve();
+                PsiElement resolved = ReferenceResolverUtil.resolve(reference);
 
                 if (resolved instanceof Method
                         && MagentoPhpClass.CONSTRUCT_METHOD_NAME
diff --git a/src/com/magento/idea/magento2uct/inspections/php/api/UsedNonApiType.java b/src/com/magento/idea/magento2uct/inspections/php/api/UsedNonApiType.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.inspections.php.api;
+
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.project.Project;
+import com.jetbrains.php.lang.psi.elements.ClassReference;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.UsedTypeInspection;
+import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
+import com.magento.idea.magento2uct.packages.SupportedIssue;
+import com.magento.idea.magento2uct.versioning.VersionStateManager;
+import org.jetbrains.annotations.NotNull;
+
+public class UsedNonApiType extends UsedTypeInspection {
+
+    @Override
+    protected void execute(
+            final Project project,
+            final @NotNull ProblemsHolder problemsHolder,
+            final PhpClass phpClass,
+            final ClassReference reference
+    ) {
+        if (VersionStateManager.getInstance(project).isApi(phpClass.getFQN())) {
+            return;
+        }
+        final String message = SupportedIssue.USED_NON_API_TYPE.getMessage(phpClass.getFQN());
+
+        if (problemsHolder instanceof UctProblemsHolder) {
+            ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
+                    SupportedIssue.USED_NON_API_TYPE.getCode()
+            );
+        }
+        problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
+    }
+
+    @Override
+    protected IssueSeverityLevel getSeverityLevel() {
+        return SupportedIssue.USED_NON_API_TYPE.getLevel();
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java
@@ -16,6 +16,7 @@
 import com.magento.idea.magento2uct.inspections.php.api.OverriddenNonApiProperty;
 import com.magento.idea.magento2uct.inspections.php.api.UsedNonApiConstant;
 import com.magento.idea.magento2uct.inspections.php.api.UsedNonApiProperty;
+import com.magento.idea.magento2uct.inspections.php.api.UsedNonApiType;
 import com.magento.idea.magento2uct.inspections.php.deprecation.CallingDeprecatedMethod;
 import com.magento.idea.magento2uct.inspections.php.deprecation.ExtendingDeprecatedClass;
 import com.magento.idea.magento2uct.inspections.php.deprecation.ImplementedDeprecatedInterface;
@@ -226,6 +227,12 @@ public enum SupportedIssue {
             IssueSeverityLevel.ERROR,
             "customCode.errors.api.1524",
             UsedNonApiProperty.class
+    ),
+    USED_NON_API_TYPE(
+            1124,
+            IssueSeverityLevel.ERROR,
+            "customCode.errors.api.1124",
+            UsedNonApiType.class
     );
 
     private final int code;
diff --git a/src/com/magento/idea/magento2uct/util/php/MagentoTypeEscapeUtil.java b/src/com/magento/idea/magento2uct/util/php/MagentoTypeEscapeUtil.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.util.php;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.jetbrains.annotations.NotNull;
+
+public final class MagentoTypeEscapeUtil {
+
+    public static final String FACTORY_PROXY_TYPE_REGEX
+            = "(Factory|\\\\Proxy|Factory\\\\Proxy)($|\\.)";
+    public static final Pattern FACTORY_PROXY_TYPE_PATTERN
+            = Pattern.compile(FACTORY_PROXY_TYPE_REGEX, Pattern.MULTILINE);
+
+    private MagentoTypeEscapeUtil() {
+    }
+
+    /**
+     * Escape Magento Type (convert Factory and Proxy types to the simple type).
+     *
+     * @param typeFqn String
+     *
+     * @return String
+     */
+    public static @NotNull String escape(final @NotNull String typeFqn) {
+        final Matcher matcher = FACTORY_PROXY_TYPE_PATTERN.matcher(typeFqn);
+
+        String result = typeFqn;
+
+        while (matcher.find()) {
+            result = result.substring(0, matcher.start(0)) + result.substring(matcher.end(0));
+        }
+
+        return typeFqn.equals(result) ? typeFqn : result;
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/util/php/ReferenceResolverUtil.java b/src/com/magento/idea/magento2uct/util/php/ReferenceResolverUtil.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.util.php;
+
+import com.intellij.psi.PsiElement;
+import com.jetbrains.php.PhpIndex;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.lang.psi.elements.PhpReference;
+import java.util.Collection;
+import java.util.regex.Matcher;
+import org.jetbrains.annotations.NotNull;
+
+public final class ReferenceResolverUtil {
+
+    private ReferenceResolverUtil() {
+    }
+
+    /**
+     * Resolve reference.
+     *
+     * @param reference PhpReference
+     *
+     * @return PsiElement
+     */
+    public static PsiElement resolve(final @NotNull PhpReference reference) {
+        final String fqn = reference.getFQN();
+
+        if (fqn == null) {
+            return null;
+        }
+        PsiElement resolved = null;
+
+        if (isFactoryOrProxy(fqn)) {
+            final Collection<PhpClass> classes = PhpIndex.getInstance(reference.getProject())
+                    .getAnyByFQN(
+                            MagentoTypeEscapeUtil.escape(reference.getFQN())
+                    );
+
+            if (!classes.isEmpty()) {
+                resolved = classes.stream().iterator().next();
+            }
+        } else {
+            resolved = reference.resolve();
+        }
+
+        return resolved;
+    }
+
+    /**
+     * Check if provided FQN is a Factory or Proxy.
+     *
+     * @param fqn String
+     *
+     * @return boolean
+     */
+    private static boolean isFactoryOrProxy(final @NotNull String fqn) {
+        final Matcher matcher = MagentoTypeEscapeUtil.FACTORY_PROXY_TYPE_PATTERN.matcher(fqn);
+
+        return matcher.find();
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java b/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java
@@ -8,6 +8,7 @@
 import com.intellij.openapi.project.Project;
 import com.magento.idea.magento2uct.packages.SupportedVersion;
 import com.magento.idea.magento2uct.settings.UctSettingsService;
+import com.magento.idea.magento2uct.util.php.MagentoTypeEscapeUtil;
 import com.magento.idea.magento2uct.versioning.indexes.data.ApiCoverageStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.DeprecationStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.ExistenceStateIndex;
@@ -58,7 +59,7 @@ public static synchronized VersionStateManager getInstance(
      * @return boolean
      */
     public boolean isDeprecated(final @NotNull String fqn) {
-        return deprecationStateIndex.has(fqn);
+        return deprecationStateIndex.has(escapeFqn(fqn));
     }
 
     /**
@@ -69,7 +70,7 @@ public boolean isDeprecated(final @NotNull String fqn) {
      * @return String
      */
     public String getDeprecatedInVersion(final @NotNull String fqn) {
-        return deprecationStateIndex.getVersion(fqn);
+        return deprecationStateIndex.getVersion(escapeFqn(fqn));
     }
 
     /**
@@ -80,7 +81,7 @@ public String getDeprecatedInVersion(final @NotNull String fqn) {
      * @return boolean
      */
     public boolean isExists(final @NotNull String fqn) {
-        return existenceStateIndex.has(fqn);
+        return existenceStateIndex.has(escapeFqn(fqn));
     }
 
     /**
@@ -91,7 +92,7 @@ public boolean isExists(final @NotNull String fqn) {
      * @return String
      */
     public String getRemovedInVersion(final @NotNull String fqn) {
-        return existenceStateIndex.getVersion(fqn);
+        return existenceStateIndex.getVersion(escapeFqn(fqn));
     }
 
     /**
@@ -102,7 +103,7 @@ public String getRemovedInVersion(final @NotNull String fqn) {
      * @return boolean
      */
     public boolean isApi(final @NotNull String fqn) {
-        return apiCoverageStateIndex.has(fqn);
+        return apiCoverageStateIndex.has(escapeFqn(fqn));
     }
 
     /**
@@ -173,4 +174,15 @@ private void compute(final VersionStateIndex index) {
 
         index.load(versionsToLoad);
     }
+
+    /**
+     * Escape FQN for adding Factory and Proxy support.
+     *
+     * @param fqn String
+     *
+     * @return String
+     */
+    private String escapeFqn(final @NotNull String fqn) {
+        return MagentoTypeEscapeUtil.escape(fqn);
+    }
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +<html>
 +<body>
 +<p>[1124] The used type is not marked as an API.</p>
 +<!-- tooltip end -->
 +</body>
 +</html>