Merge pull request #511 from bohdan-harniuk/entity-creator-enhance-ux-and-do-action-in-the-separate-thread

Enhanced UX with generation process, generation in the separate thread (non-blocking UI), fixed multiple action listener firing

Author: eduard13

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEntityDialog.java

@@ -17,6 +17,7 @@
 import com.magento.idea.magento2plugin.actions.generation.data.dialog.NewEntityDialogData;
 import com.magento.idea.magento2plugin.actions.generation.data.ui.ComboBoxItemData;
 import com.magento.idea.magento2plugin.actions.generation.dialog.util.ClassPropertyFormatterUtil;
+import com.magento.idea.magento2plugin.actions.generation.dialog.util.ProcessWorker;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.annotation.FieldValidation;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.annotation.RuleRegistry;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.AclResourceIdRule;
@@ -57,6 +58,7 @@
 import com.magento.idea.magento2plugin.util.FirstLetterToLowercaseUtil;
 import com.magento.idea.magento2plugin.util.magento.GetAclResourcesListUtil;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
+import java.awt.Cursor;
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
@@ -184,6 +186,7 @@ public class NewEntityDialog extends AbstractDialog {
     private JTextPane exampleGridName;
     private JPanel uiComponentsPanel;
     private JTextField observerName;
+    private final ProcessWorker.InProgressFlag onOkActionFired;
 
     /**
      * Constructor.
@@ -203,7 +206,8 @@ public NewEntityDialog(final @NotNull Project project, final PsiDirectory direct
         setTitle(NewEntityAction.ACTION_DESCRIPTION);
         getRootPane().setDefaultButton(buttonOK);
 
-        buttonOK.addActionListener((final ActionEvent event) -> onOK());
+        onOkActionFired = new ProcessWorker.InProgressFlag(false);
+        buttonOK.addActionListener(this::generateNewEntityFiles);
         buttonCancel.addActionListener((final ActionEvent event) -> onCancel());
 
         // call onCancel() when cross is clicked
@@ -294,13 +298,35 @@ private void initPropertiesTable() {
         entityPropertiesTableGroupWrapper.initTableGroup();
     }
 
+    /**
+     * Generate new entity files.
+     *
+     * @param event ActionEvent
+     */
+    @SuppressWarnings("PMD.UnusedFormalParameter")
+    private void generateNewEntityFiles(final @NotNull ActionEvent event) {
+        if (!onOkActionFired.isInProgress()) {
+            buttonOK.setEnabled(false);
+            buttonCancel.setEnabled(false);
+
+            new ProcessWorker(
+                    this::onOK,
+                    this::releaseDialogAfterGeneration,
+                    onOkActionFired
+            ).execute();
+        }
+    }
+
     /**
      * Perform code generation using input data.
      */
     private void onOK() {
         if (!validateFormFields()) {
+            onOkActionFired.setInProgress(false);
             return;
         }
+        setCursor(new Cursor(Cursor.WAIT_CURSOR));
+
         formatProperties();
 
         final NewEntityDialogData dialogData = getNewEntityDialogData();
@@ -315,8 +341,20 @@ private void onOK() {
         );
 
         generatorPoolHandler.run();
+        onOkActionFired.setFinished(true);
+    }
+
+    /**
+     * Release dialog buttons and hide.
+     */
+    private void releaseDialogAfterGeneration() {
+        setCursor(new Cursor(Cursor.DEFAULT_CURSOR));
+        buttonCancel.setEnabled(true);
+        buttonOK.setEnabled(true);
 
-        this.setVisible(false);
+        if (onOkActionFired.isFinished()) {
+            this.setVisible(false);
+        }
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/dialog/util/ProcessWorker.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.dialog.util;
+
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.application.ModalityState;
+import javax.swing.SwingWorker;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * This worker is used to allow button on click action to be performed in the separate thread.
+ * It releases UI to not be blocked.
+ */
+public final class ProcessWorker extends SwingWorker<Boolean, String> {
+
+    private final Runnable processExecutorService;
+    private final Runnable processReleaserService;
+    private final InProgressFlag inProgressFlag;
+
+    /**
+     * Process worker constructor.
+     *
+     * @param processExecutorService Runnable
+     * @param processReleaserService Runnable
+     * @param inProgressFlag InProgressFlag
+     */
+    public ProcessWorker(
+            final @NotNull Runnable processExecutorService,
+            final @NotNull Runnable processReleaserService,
+            final InProgressFlag inProgressFlag
+    ) {
+        super();
+        this.processExecutorService = processExecutorService;
+        this.processReleaserService = processReleaserService;
+        this.inProgressFlag = inProgressFlag;
+    }
+
+    @Override
+    protected Boolean doInBackground() {
+        if (!inProgressFlag.isInProgress()) {
+            inProgressFlag.setInProgress(true);
+            // Run action event process
+            ApplicationManager.getApplication().invokeAndWait(
+                    processExecutorService,
+                    ModalityState.defaultModalityState()
+            );
+            // Run release dialog action process
+            ApplicationManager.getApplication().invokeAndWait(
+                    processReleaserService,
+                    ModalityState.defaultModalityState()
+            );
+        }
+        return null;
+    }
+
+    /**
+     * Inner class used only to stop actionPerformed method executing.
+     */
+    public static final class InProgressFlag {
+
+        /**
+         * Is action in progress flag.
+         */
+        private boolean inProgress;
+
+        /**
+         * Is action finished flag.
+         */
+        private boolean isFinished;
+
+        /**
+         * In progress flag constructor.
+         *
+         * @param inProgress boolean
+         */
+        public InProgressFlag(final boolean inProgress) {
+            this.inProgress = inProgress;
+            isFinished = false;
+        }
+
+        /**
+         * Get is in progress value.
+         *
+         * @return boolean
+         */
+        public boolean isInProgress() {
+            return inProgress;
+        }
+
+        /**
+         * Set is in progress flag value.
+         *
+         * @param inProgress boolean
+         */
+        public void setInProgress(final boolean inProgress) {
+            this.inProgress = inProgress;
+        }
+
+        /**
+         * Get is progress finished flag value.
+         */
+        public boolean isFinished() {
+            return isFinished;
+        }
+
+        /**
+         * Set is progress finished flag value.
+         *
+         * @param finished boolean
+         */
+        public void setFinished(boolean finished) {
+            isFinished = finished;
+        }
+    }
+}