Merge pull request #1198 from bohdan-harniuk/merge-4.4.0-develop-into-4.4.1-develop

VitaliyBoyko · web-flow · commit 02f8189f9833 · 2022-09-19T16:19:52.000+03:00
Merge 4.4.0 develop into 4.4.1 develop
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,9 +24,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 - Code completion for `system.xml` and `config.xml` [#1077](https://github.com/magento/magento2-phpstorm-plugin/pull/1077)
 - Added easier navigation through plugins [#1121](https://github.com/magento/magento2-phpstorm-plugin/pull/1121)
 - Added inspection to check if type attr value in the virtual type tag attribute value exists [#1176](https://github.com/magento/magento2-phpstorm-plugin/pull/1176)
+- Added checks and detailed error messages during plugin activation [#1181](https://github.com/magento/magento2-phpstorm-plugin/pull/1181)
 
 ### Fixed
 
+- Fixed NullPointerException at ObserverDeclarationInspection.java:188 [#1143](https://github.com/magento/magento2-phpstorm-plugin/issues/1143)
 - Fixed IncorrectOperationException: Rebind cannot be performed for class PolyVariantReferenceBase [#1173](https://github.com/magento/magento2-phpstorm-plugin/pull/1173)
 - Fixed create an observer for an event doesn't work through the context menu [#1166](https://github.com/magento/magento2-phpstorm-plugin/pull/1166)
 - Fixed IOException: Invalid file name at ReportBuilder [#1154](https://github.com/magento/magento2-phpstorm-plugin/pull/1154)
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -60,7 +60,6 @@
             <separator/>
             <!-- Context dependent actions -->
             <action id="MagentoCreateAclFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewAclXmlAction"/>
-            <action id="MagentoCreateGraphQlSchemaFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewGraphQLSchemaAction"/>
             <action id="MagentoCreateConfigFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewConfigXmlAction"/>
             <action id="MagentoCreateCrontabFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewCrontabXmlAction"/>
             <action id="MagentoCreateDiFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewDiXmlAction"/>
@@ -91,7 +90,6 @@
             <action id="MagentoCreateACronjob" class="com.magento.idea.magento2plugin.actions.generation.NewCronjobAction" />
             <action id="MagentoCreateACronGroup" class="com.magento.idea.magento2plugin.actions.generation.NewCronGroupAction" />
             <action id="MagentoCreateAViewModel" class="com.magento.idea.magento2plugin.actions.generation.NewViewModelAction" />
-            <action id="MagentoCreateAGraphQlResolver" class="com.magento.idea.magento2plugin.actions.generation.NewGraphQlResolverAction" />
             <action id="MagentoCreateCLICommand" class="com.magento.idea.magento2plugin.actions.generation.NewCLICommandAction" />
             <action id="MagentoCreateEmailTemplate" class="com.magento.idea.magento2plugin.actions.generation.NewEmailTemplateAction" />
             <action id="MagentoCreateUiComponentGrid" class="com.magento.idea.magento2plugin.actions.generation.NewUiComponentGridAction" />
@@ -621,7 +619,6 @@
         <internalFileTemplate name="Magento Regular Class"/>
         <internalFileTemplate name="Magento Observer Class"/>
         <internalFileTemplate name="Magento Events XML"/>
-        <internalFileTemplate name="Magento GraphQL Resolver Class"/>
         <internalFileTemplate name="Magento Cron Job Class"/>
         <internalFileTemplate name="Magento Cron Tab XML"/>
         <internalFileTemplate name="Magento CLI Command Class"/>
@@ -635,7 +632,6 @@
         <internalFileTemplate name="Magento Routes XML"/>
         <internalFileTemplate name="Magento Layout XML"/>
         <internalFileTemplate name="Magento ACL XML"/>
-        <internalFileTemplate name="Magento GraphQL Schema"/>
         <internalFileTemplate name="Magento Collection Class"/>
         <internalFileTemplate name="Magento Model Class"/>
         <internalFileTemplate name="Magento Resource Model Class"/>
diff --git a/resources/META-INF/withJsGraphQl.xml b/resources/META-INF/withJsGraphQl.xml
@@ -6,6 +6,19 @@
 -->
 
 <idea-plugin>
+    <actions>
+        <group id="GraphQL.MagentoContextBasedActionsGroup">
+            <add-to-group group-id="MagentoContextBasedActionsGroup" anchor="last"/>
+            <action id="MagentoCreateGraphQlSchemaFile"
+                    class="com.magento.idea.magento2plugin.actions.context.xml.NewGraphQLSchemaAction"/>
+        </group>
+        <group id="GraphQL.MagentoNewModuleFileGroup"
+               text="GraphQL"
+               popup="false">
+            <add-to-group group-id="MagentoNewModuleFileGroup" anchor="last"/>
+            <action id="MagentoCreateAGraphQlResolver" class="com.magento.idea.magento2plugin.actions.generation.NewGraphQlResolverAction" />
+        </group>
+    </actions>
     <extensions defaultExtensionNs="com.intellij">
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex" />
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.linemarker.php.GraphQlResolverUsageLineMarkerProvider"/>
@@ -22,5 +35,8 @@
                          enabledByDefault="true"
                          level="ERROR"
                          implementationClass="com.magento.idea.magento2plugin.inspections.graphqls.SchemaResolverInspection"/>
+
+        <internalFileTemplate name="Magento GraphQL Resolver Class"/>
+        <internalFileTemplate name="Magento GraphQL Schema"/>
     </extensions>
 </idea-plugin>
diff --git a/resources/fileTemplates/internal/Magento Customer Eav Attribute Data Patch Class.php.ft b/resources/fileTemplates/internal/Magento Customer Eav Attribute Data Patch Class.php.ft
@@ -77,7 +77,7 @@ class ${CLASS_NAME} implements ${IMPLEMENTS}
         $eavSetup->addAttributeToSet(
                 ${CUSTOMER_METADATA_INTERFACE}::ENTITY_TYPE_CUSTOMER,
                 ${CUSTOMER_METADATA_INTERFACE}::ATTRIBUTE_SET_ID_CUSTOMER,
-                null,
+                'Default',
                 '${ATTRIBUTE_CODE}'
         );
 
diff --git a/resources/magento2/validation.properties b/resources/magento2/validation.properties
@@ -1,6 +1,8 @@
 validator.notEmpty=The {0} field must not be empty
 validator.box.notEmpty=The {0} field must contain a valid selection from the dropdown
 validator.package.validPath=Please specify a valid Magento 2 installation path
+validator.package.validPathComposerFiles=File composer.json is missing in the current Magento 2 installation path
+validator.package.validPathVendor=Vendor dir is corrupt or missing in the current Magento 2 installation path
 validator.properties.notEmpty=The properties must not be empty
 validator.alphaNumericCharacters=The {0} field must contain letters and numbers only
 validator.alphaNumericAndUnderscoreCharacters={0} must contain letters, numbers and underscores only
diff --git a/src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java b/src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java
@@ -8,6 +8,7 @@
 import com.intellij.codeInspection.ProblemHighlightType;
 import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.ide.highlighter.XmlFileType;
+import com.intellij.openapi.externalSystem.service.execution.NotSupportedException;
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiElement;
@@ -71,6 +72,10 @@ public void visitFile(final @NotNull PsiFile file) {
                     return;
                 }
 
+                // This added to cover case if file exists only in memory.
+                if (file.getContainingDirectory() == null) {
+                    return;
+                }
                 final EventIndex eventIndex = new EventIndex(file.getProject());
                 final HashMap<String, XmlTag> targetObserversHash = new HashMap<>();
 
@@ -108,7 +113,8 @@ public void visitFile(final @NotNull PsiFile file) {
                         }
 
                         final String observerName = observerNameAttribute.getValue();
-                        if (observerName == null) {
+                        if (observerName == null
+                                || observerNameAttribute.getValueElement() == null) {
                             continue;
                         }
 
@@ -188,6 +194,11 @@ private List<HashMap<String, String>> fetchModuleNamesWhereSameObserverNameUsed(
                     final EventIndex eventIndex,
                     final PsiFile file
             ) {
+                if (file.getContainingDirectory() == null) {
+                    throw new NotSupportedException(
+                            "Operation is not supported for files in memory"
+                    );
+                }
                 final List<HashMap<String, String>> modulesName = new ArrayList<>();
                 final String currentFileDirectory = file.getContainingDirectory().toString();
                 final String currentFileFullPath = currentFileDirectory
diff --git a/src/com/magento/idea/magento2plugin/lang/php/MagentoProxyDeclarationFilter.java b/src/com/magento/idea/magento2plugin/lang/php/MagentoProxyDeclarationFilter.java
@@ -58,7 +58,7 @@ private <E extends PhpNamedElement> boolean isValidFqn(final E candidate) {
         PhpClass targetClass = null;
 
         if (candidate instanceof Method) {
-            targetClass = (PhpClass) candidate.getParent();
+            targetClass = ((Method) candidate).getContainingClass();
         } else if (candidate instanceof PhpClass) {
             targetClass = (PhpClass) candidate;
         }
diff --git a/src/com/magento/idea/magento2plugin/project/validator/SettingsFormValidator.java b/src/com/magento/idea/magento2plugin/project/validator/SettingsFormValidator.java
@@ -28,14 +28,30 @@ public SettingsFormValidator(
      *
      * @throws ConfigurationException Exception
      */
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.AvoidDeeplyNestedIfStmts"})
     public void validate() throws ConfigurationException {
         if (form.isBeingUsed()) {
-            if (!MagentoBasePathUtil.isMagentoFolderValid(form.getMagentoPath())) {
+            final String magentoRootPath = form.getMagentoPath();
+            final boolean isMagentoFrameworkDirExist =
+                    MagentoBasePathUtil.isMagentoFolderValid(magentoRootPath);
+
+            if (!MagentoBasePathUtil.isComposerJsonExists(magentoRootPath)) {
+                if (isMagentoFrameworkDirExist) {
+                    throw new ConfigurationException(
+                            validatorBundle.message("validator.package.validPathComposerFiles")
+                    );
+                }
                 throw new ConfigurationException(
                         validatorBundle.message("validator.package.validPath")
                 );
             }
 
+            if (!isMagentoFrameworkDirExist) {
+                throw new ConfigurationException(
+                        validatorBundle.message("validator.package.validPathVendor")
+                );
+            }
+
             final String magentoVersion = form.getMagentoVersion();
             if (magentoVersion.length() == 0) {
                 throw new ConfigurationException(
diff --git a/src/com/magento/idea/magento2plugin/util/magento/MagentoBasePathUtil.java b/src/com/magento/idea/magento2plugin/util/magento/MagentoBasePathUtil.java
@@ -9,6 +9,7 @@
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
+import com.magento.idea.magento2plugin.magento.files.ComposerJson;
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import java.util.Arrays;
 import org.jetbrains.annotations.NotNull;
@@ -18,7 +19,7 @@ public final class MagentoBasePathUtil {
     private MagentoBasePathUtil() {}
 
     /**
-     * Method detects Magento Framework Root.
+     * Method detects Magento Framework Root (check if magento framework exists).
      *
      * @param path String
      * @return boolean
@@ -42,6 +43,25 @@ public static boolean isMagentoFolderValid(final String path) {
         return false;
     }
 
+    /**
+     * Check if composer.json exists in directory.
+     *
+     * @param path String
+     * @return boolean
+     */
+    public static Boolean isComposerJsonExists(final String path) {
+        if (StringUtil.isEmptyOrSpaces(path)) {
+            return false;
+        }
+        final VirtualFile magentoRoot = LocalFileSystem.getInstance().findFileByPath(path);
+
+        if (magentoRoot == null || !magentoRoot.isDirectory()) {
+            return false;
+        }
+
+        return magentoRoot.findChild(ComposerJson.FILE_NAME) != null;
+    }
+
     /**
      * Check if specified path belongs to the correct vendor name.
      *
diff --git a/testData/actions/generation/generator/CustomerAttributeSetupPatchGenerator/generateMultiselectAttributeDataPatch/AddMultiselectTestCustomerAttribute.php b/testData/actions/generation/generator/CustomerAttributeSetupPatchGenerator/generateMultiselectAttributeDataPatch/AddMultiselectTestCustomerAttribute.php
@@ -96,7 +96,7 @@ public function apply()
         $eavSetup->addAttributeToSet(
             CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER,
             CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER,
-            null,
+            'Default',
             'multiselect_test'
         );
 

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ private <E extends PhpNamedElement> boolean isValidFqn(final E candidate) {`
`58`	`58`	`PhpClass targetClass = null;`
`59`	`59`
`60`	`60`	`if (candidate instanceof Method) {`
`61`		`- targetClass = (PhpClass) candidate.getParent();`
	`61`	`+ targetClass = ((Method) candidate).getContainingClass();`
`62`	`62`	`} else if (candidate instanceof PhpClass) {`
`63`	`63`	`targetClass = (PhpClass) candidate;`
`64`	`64`	`}`