4.2.3 ALPHA release

.github/workflows/gradle.yml

@@ -5,7 +5,7 @@ name: Run automated tests
 
 on:
   pull_request:
-    branches: [ master, 4.2.0-develop ]
+    branches: [ master, 4.2.3-develop ]
 
 jobs:
   build-linux:

CHANGELOG.md

@@ -4,6 +4,74 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 
+## 4.2.3
+
+## 4.2.2
+
+### Added
+
+- Added custom search scope to exclude test files from search [#read-more](https://github.com/magento/magento2-phpstorm-plugin/wiki/4.2.2-Release)
+- Added the ability to open all plugins in the Find Tool Window [#read-more](https://github.com/magento/magento2-phpstorm-plugin/wiki/4.2.2-Release)
+- Added uiComponent registration syntax highlighting as JSON [#read-more](https://github.com/magento/magento2-phpstorm-plugin/wiki/4.2.2-Release)
+- Added new Magento version support (2.4.4-beta4) for the UCT feature in [#922](https://github.com/magento/magento2-phpstorm-plugin/pull/922)
+
+### Changed
+
+- Eliminated com.google.gson.JsonParser#parse usage in [#928](https://github.com/magento/magento2-phpstorm-plugin/pull/928)
+- Eliminated LineMarkerXmlTagDecorator#checkDelete usage in [#910](https://github.com/magento/magento2-phpstorm-plugin/pull/910)
+- Eliminated LineMarkerXmlTagDecorator#checkAdd usage in [#909](https://github.com/magento/magento2-phpstorm-plugin/pull/909)
+- Enhanced errors showing for the new Magento 2 UI Component Form dialog window in [#892](https://github.com/magento/magento2-phpstorm-plugin/pull/892)
+- Enhanced errors showing for the new Magento 2 UI Component Grid dialog window in [#891](https://github.com/magento/magento2-phpstorm-plugin/pull/891)
+- Enhanced errors showing for the new Magento 2 DB Schema XML dialog window in [#890](https://github.com/magento/magento2-phpstorm-plugin/pull/890)
+- Enhanced errors showing for the new Magento 2 Message Queue dialog window in [#889](https://github.com/magento/magento2-phpstorm-plugin/pull/889)
+- Enhanced errors showing for the new Magento 2 Data Model dialog window in [#888](https://github.com/magento/magento2-phpstorm-plugin/pull/888)
+- Enhanced errors showing for the new Magento 2 Models dialog window in [#887](https://github.com/magento/magento2-phpstorm-plugin/pull/887)
+- Enhanced errors showing for the new Magento 2 Email Template dialog window in [#886](https://github.com/magento/magento2-phpstorm-plugin/pull/886)
+- Enhanced errors showing for the new Magento 2 CLI Command dialog window in [#885](https://github.com/magento/magento2-phpstorm-plugin/pull/885)
+- Enhanced errors showing for the new Magento 2 GraphQl Resolver dialog window in [#884](https://github.com/magento/magento2-phpstorm-plugin/pull/884)
+- Enhanced errors showing for the new Magento 2 View Model dialog window in [#883](https://github.com/magento/magento2-phpstorm-plugin/pull/883)
+- Enhanced errors showing for the new Magento 2 Cron Group dialog window in [#882](https://github.com/magento/magento2-phpstorm-plugin/pull/882)
+- Enhanced errors showing for the new Magento 2 Cron Job dialog window in [#881](https://github.com/magento/magento2-phpstorm-plugin/pull/881)
+- Enhanced errors showing for the new Magento 2 Controller dialog window in [#880](https://github.com/magento/magento2-phpstorm-plugin/pull/880)
+- Enhanced errors showing for the new Magento 2 Block dialog window in [#865](https://github.com/magento/magento2-phpstorm-plugin/pull/865)
+
+### Fixed
+
+- Fixed overriding layouts and templates allows to select an incompatible theme in [#930](https://github.com/magento/magento2-phpstorm-plugin/pull/930)
+- Fixed observer action visibility in [#936](https://github.com/magento/magento2-phpstorm-plugin/pull/936)
+- Fixed general exception while accessing phpIndex.getAnyByFQN(classFQN) in [#934](https://github.com/magento/magento2-phpstorm-plugin/pull/934)
+- Fixed ClassCastException for the GraphQlResolverIndex.getGraphQLUsages in [#927](https://github.com/magento/magento2-phpstorm-plugin/pull/927)
+- Fixed plugin inspection does not work correctly in [#902](https://github.com/magento/magento2-phpstorm-plugin/pull/902)
+- Fixed module name declaration inspection flags valid code in [#898](https://github.com/magento/magento2-phpstorm-plugin/pull/898)
+- Fixed ClassCastException: PsiPlainTextFileImpl cannot be cast to class XmlFile in WebApiTypeIndex in [#897](https://github.com/magento/magento2-phpstorm-plugin/pull/897)
+- Fixed IndexNotReadyException while opening a context menu in [#896](https://github.com/magento/magento2-phpstorm-plugin/pull/896)
+- Fixed IllegalArgumentException: URLDecoder: Incomplete trailing escape (%) pattern in [#894](https://github.com/magento/magento2-phpstorm-plugin/pull/894)
+- Fixed Throwable: AWT events are not allowed inside write action (UI Form) in [#893](https://github.com/magento/magento2-phpstorm-plugin/pull/893)
+- Fixed Slow operations are prohibited on EDT when calling update method on the CreateAPluginAction in [#862](https://github.com/magento/magento2-phpstorm-plugin/pull/862)
+- Fixed Throwable: when an IOException is thrown during new plugin generation in [#860](https://github.com/magento/magento2-phpstorm-plugin/pull/860)
+- Fixed IndexOutOfBoundsException in case when entered no fields during ui form generation in [#859](https://github.com/magento/magento2-phpstorm-plugin/pull/859)
+- Fixed NullPointerException when opening new cron job dialog for an invalid Magento 2 module in [#856](https://github.com/magento/magento2-phpstorm-plugin/pull/856)
+- Fixed NoSuchElementException when creating new controller in [#844](https://github.com/magento/magento2-phpstorm-plugin/pull/844)
+- Fixed Message Queue Connection does not match Naming Conventions in [#854](https://github.com/magento/magento2-phpstorm-plugin/pull/854)
+- Fixed StringIndexOutOfBoundsException during UCT inspection via action execution in [852](https://github.com/magento/magento2-phpstorm-plugin/pull/852)
+- Fixed NullPointerException in the PluginDeclarationInspection.fetchModuleNamesWhereSamePluginNameUsed (calling toString on null) in [#849](https://github.com/magento/magento2-phpstorm-plugin/pull/849)
+
+## 4.2.1
+
+### Fixed
+
+- Fixed ArrayIndexOutOfBoundsException when used Copy Path/Reference action on the requirejs-config.js file in [#808](https://github.com/magento/magento2-phpstorm-plugin/pull/808)
+- Fixed dialog disposition issue in [#811](https://github.com/magento/magento2-phpstorm-plugin/pull/811)
+- Fixed stack overflow error for line-marker providers in [#813](https://github.com/magento/magento2-phpstorm-plugin/pull/813)
+- Fixed stub ids not found for key in index in [#814](https://github.com/magento/magento2-phpstorm-plugin/pull/814)
+- Fixed failed to build require-js index in [815](https://github.com/magento/magento2-phpstorm-plugin/pull/815)
+- Fixed empty psi elements in the plugin inspections in [#816](https://github.com/magento/magento2-phpstorm-plugin/pull/816)
+- Fixed empty psi element in module xml inspection in [#817](https://github.com/magento/magento2-phpstorm-plugin/pull/817)
+- Fixed NullPointerException for the firstSortOrder.compareTo in [#818](https://github.com/magento/magento2-phpstorm-plugin/pull/818)
+- Fixed invalid column types provided exception during db_schema.xml file generation in [#819](https://github.com/magento/magento2-phpstorm-plugin/pull/819)
+- Fixed method designed for fully qualified names only in [#830](https://github.com/magento/magento2-phpstorm-plugin/pull/830)
+- Fixed NoClassDefFoundError for com.intellij.lang.jsgraphql.GraphQLIcons in [#850](https://github.com/magento/magento2-phpstorm-plugin/pull/850)
+
 ## 4.2.0
 
 ### Added

README.md

@@ -43,7 +43,7 @@
 
 1. Check out this repository
 1. Open a folder with the project in the IntelliJ Ultimate using the `open` action button.
-1. Make sure that you on the latest develop branch (e.g `4.2.0-develop`)
+1. Make sure that you on the latest develop branch (e.g `4.2.3-develop`)
 1. Right-click on the `build.gradle` file, choose "Import Gradle project" (if this is not exist look for "Build module '<root folder name>'") (you need to have Gradle plugin installed)
 1. Check if the right SDK version is used for the project.
    - Current Java version for the project is **java 11**, so you should additionally download **SDK 11** and choose it in the module settings: `Right click by the project root > Open Module Settings > Project Settings > Project > Project SDK`

build.gradle

@@ -15,7 +15,7 @@ repositories {
 }
 
 group 'com.magento.idea'
-version '4.2.0'
+version '4.2.3'
 
 apply plugin: 'org.jetbrains.intellij'
 apply plugin: 'java'
@@ -41,7 +41,7 @@ intellij {
             'properties',
             'CSS',
             'JavaScriptLanguage',
-            'com.intellij.lang.jsgraphql:3.0.0',
+            'com.intellij.lang.jsgraphql:3.1.2',
             'platform-images',
             'copyright'
     ]
@@ -69,7 +69,7 @@ sourceSets {
 publishPlugin {
     token = System.getenv("MAGENTO_PHPSTORM_intellijPublishToken")
     if (Boolean.valueOf(System.getenv("MAGENTO_PHPSTORM_isAlpha"))) {
-        channels 'alpha'
+        channels = ['alpha']
         version = version + "-alpha-" + getDate()
     }
 }
@@ -106,6 +106,7 @@ idea {
 
 dependencies {
     testImplementation 'junit:junit:4.13'
+    implementation 'org.json:json:20211205'
 }
 
 test {

resources/META-INF/plugin.xml

@@ -7,7 +7,7 @@
 <idea-plugin require-restart="true">
     <id>com.magento.idea.magento2plugin</id>
     <name>Magento PhpStorm</name>
-    <version>4.2.0</version>
+    <version>4.2.3</version>
     <vendor url="https://github.com/magento/magento2-phpstorm-plugin">Magento Inc.</vendor>
 
     <description><![CDATA[
@@ -561,6 +561,11 @@
         <errorHandler implementation="com.magento.idea.magento2plugin.project.diagnostic.DefaultErrorReportSubmitter"/>
 
         <configurationType implementation="com.magento.idea.magento2uct.execution.configurations.UctRunConfigurationType"/>
+
+        <testSourcesFilter implementation="com.magento.idea.magento2plugin.lang.roots.MagentoTestSourceFilter"/>
+        <searchScopesProvider implementation="com.magento.idea.magento2plugin.lang.psi.search.MagentoSearchScopesProvider"/>
+
+        <multiHostInjector implementation="com.magento.idea.magento2plugin.lang.injection.UiComponentSyntaxInjector"/>
     </extensions>
 
     <extensions defaultExtensionNs="com.jetbrains.php">

resources/magento2/validation.properties

@@ -1,6 +1,7 @@
 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.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
 validator.alphaAndPeriodCharacters=The {0} field must contain alphabets and periods only
@@ -22,6 +23,7 @@ validator.command.isNotValid=The {0} field does not contain a valid Magento 2 CL
 validator.module.noSuchModule=No such module {0}
 validator.file.alreadyExists={0} already exists
 validator.file.cantBeCreated={0} can't be created
+validator.file.cantBeCreatedWithException=The ''{0}'' cannot be created. Original message was: ''{1}''
 validator.file.isNotWritable=%s file is binary or has no document associations
 validator.file.noDocumentAssociations={0} file is binary or has no document associations
 validator.class.alreadyDeclared={0} already declared in the target module
@@ -38,3 +40,4 @@ validator.db.invalidTableNameLength=Table name must contain up to 64 characters
 validator.lowerSnakeCase=The {0} field must be of the lower snake case format
 validator.menuIdentifierInvalid=The menu identifier is invalid
 validator.someFieldsHaveErrors=Please, check the dialog. Some fields have errors
+validator.dbSchema.invalidColumnType=Invalid ''{0}'' column type specified

src/com/magento/idea/magento2plugin/actions/CopyMagentoPath.java

@@ -21,6 +21,7 @@
 import org.jetbrains.annotations.Nullable;
 
 public class CopyMagentoPath extends CopyPathProvider {
+
     public static final String PHTML_EXTENSION = "phtml";
     public static final String JS_EXTENSION = "js";
     public static final String CSS_EXTENSION = "css";
@@ -56,23 +57,23 @@ private boolean isNotValidFile(final VirtualFile virtualFile) {
                 || virtualFile != null && !acceptedTypes.contains(virtualFile.getExtension());
     }
 
-    @Nullable
     @Override
-    public String getPathToElement(
-            @NotNull final Project project,
-            @Nullable final VirtualFile virtualFile,
-            @Nullable final Editor editor
+    public @Nullable String getPathToElement(
+            final @NotNull Project project,
+            final @Nullable VirtualFile virtualFile,
+            final @Nullable Editor editor
     ) {
         if (virtualFile == null) {
             return null;
         }
-        final PsiFile file
-                = PsiManager.getInstance(project).findFile(virtualFile);
+        final PsiFile file = PsiManager.getInstance(project).findFile(virtualFile);
+
         if (file == null) {
             return null;
         }
         final PsiDirectory directory = file.getContainingDirectory();
         final String moduleName = GetModuleNameByDirectoryUtil.execute(directory, project);
+
         if (moduleName == null) {
             return null;
         }
@@ -89,15 +90,30 @@ public String getPathToElement(
         } else {
             return fullPath.toString();
         }
+        int endIndex;
 
-        final int endIndex = getIndexOf(paths, fullPath, paths[++index]);
+        try {
+            endIndex = getIndexOf(paths, fullPath, paths[++index]);
+        } catch (ArrayIndexOutOfBoundsException exception) {
+            // endIndex could not be found.
+            return "";
+        }
         final int offset = paths[index].length();
 
         fullPath.replace(0, endIndex + offset, "");
 
         return moduleName + SEPARATOR + fullPath;
     }
 
+    /**
+     * Get index where web|template path starts in the fullPath.
+     *
+     * @param paths String[]
+     * @param fullPath StringBuilder
+     * @param path String
+     *
+     * @return int
+     */
     private int getIndexOf(final String[] paths, final StringBuilder fullPath, final String path) {
         return fullPath.lastIndexOf(path) == -1
                 ? getIndexOf(paths, fullPath, paths[++index])

src/com/magento/idea/magento2plugin/actions/generation/CreateAPluginAction.java

@@ -25,6 +25,7 @@
 import org.jetbrains.annotations.NotNull;
 
 public class CreateAPluginAction extends DumbAwareAction {
+
     public static final String ACTION_NAME = "Create a new Plugin for this method";
     public static final String ACTION_DESCRIPTION = "Create a new Magento 2 Plugin";
     private final GetFirstClassOfFile getFirstClassOfFile;
@@ -47,10 +48,12 @@ public void update(final AnActionEvent event) {
         targetClass = null;// NOPMD
         targetMethod = null;// NOPMD
         final Project project = event.getData(PlatformDataKeys.PROJECT);
-        if (Settings.isEnabled(project)) {
+
+        if (project != null && Settings.isEnabled(project)) {
             final Pair<PsiFile, PhpClass> pair = this.findPhpClass(event);
             final PsiFile psiFile = pair.getFirst();
             final PhpClass phpClass = pair.getSecond();
+
             if (phpClass == null
                     || !(psiFile instanceof PhpFile)
                     || phpClass.isFinal()
@@ -74,16 +77,21 @@ private void setStatus(final AnActionEvent event, final boolean status) {
     }
 
     @Override
-    public void actionPerformed(@NotNull final AnActionEvent event) {
-        CreateAPluginDialog.open(event.getProject(), this.targetMethod, this.targetClass);
+    public void actionPerformed(final @NotNull AnActionEvent event) {
+        final Project project = event.getProject();
+
+        if (project == null) {
+            return;
+        }
+        CreateAPluginDialog.open(project, this.targetMethod, this.targetClass);
     }
 
     @Override
     public boolean isDumbAware() {
         return false;
     }
 
-    private Pair<PsiFile, PhpClass> findPhpClass(@NotNull final AnActionEvent event) {
+    private Pair<PsiFile, PhpClass> findPhpClass(final @NotNull AnActionEvent event) {
         final PsiFile psiFile = event.getData(PlatformDataKeys.PSI_FILE);
 
         PhpClass phpClass = null;
@@ -96,27 +104,31 @@ private Pair<PsiFile, PhpClass> findPhpClass(@NotNull final AnActionEvent event)
     }
 
     private void fetchTargetMethod(
-            @NotNull final AnActionEvent event,
+            final @NotNull AnActionEvent event,
             final PsiFile psiFile,
             final PhpClass phpClass
     ) {
         final Caret caret = event.getData(PlatformDataKeys.CARET);
+
         if (caret == null) {
             return;
         }
         final int offset = caret.getOffset();
         final PsiElement element = psiFile.findElementAt(offset);
+
         if (element == null) {
             return;
         }
-        if (element instanceof Method && element.getParent()
-                == phpClass && IsPluginAllowedForMethodUtil.check((Method) element)) {
+
+        if (element instanceof Method && element.getParent().equals(phpClass)
+                && IsPluginAllowedForMethodUtil.check((Method) element)) {
             this.targetMethod = (Method) element;
             return;
         }
         final PsiElement parent = element.getParent();
-        if (parent instanceof Method && parent.getParent()
-                == phpClass && IsPluginAllowedForMethodUtil.check((Method) parent)) {
+
+        if (parent instanceof Method && parent.getParent().equals(phpClass)
+                && IsPluginAllowedForMethodUtil.check((Method) parent)) {
             this.targetMethod = (Method) parent;
         }
     }