#1784 implement java fx based progress bars for the GUI

CHANGELOG.adoc

@@ -6,6 +6,8 @@ This file documents all notable changes to https://github.com/devonfw/IDEasy[IDE
 
 Release with new features and bugfixes:
 
+* https://github.com/devonfw/IDEasy/issues/1784[#1784]: GUI now supports displaying progress bars
+
 * https://github.com/devonfw/IDEasy/issues/1937[#1937]: Link content from settings into workspaces
 * https://github.com/devonfw/IDEasy/issues/1056[#1056]: Improve MSI license display by generating formatted RTF from AsciiDoc
 * https://github.com/devonfw/IDEasy/issues/2052[#2052]: Split issue statistics in 2 pie-charts
@@ -28,7 +30,7 @@ Release with new features and bugfixes:
 * https://github.com/devonfw/IDEasy/issues/1985[#1985]: Fix path traversal errors when extracting ZIPs on Windows
 * https://github.com/devonfw/IDEasy/issues/1255[#1255]: Enhance snapshot version recognition in IDEasy
 * https://github.com/devonfw/IDEasy/issues/1964[#1964]: Fixed gui not launching with older project java versions
-* https://github.com/devonfw/IDEasy/issues/1968[#1968]: Fixed gui blocking the terminal session while running.
+* https://github.com/devonfw/IDEasy/issues/1968[#1968]: Fixed gui blocking the terminal session while running
 * https://github.com/devonfw/IDEasy/issues/1849[#1849]: Add VSCodium support
 * https://github.com/devonfw/IDEasy/issues/1391[#1391]: Fix bashrc messed with terraform completions
 * https://github.com/devonfw/IDEasy/issues/1922[#1922]: Add Task CLI to IDEasy commandlets

gui/src/main/java/com/devonfw/ide/gui/App.java

@@ -7,13 +7,16 @@
 import javafx.geometry.Rectangle2D;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
+import javafx.scene.control.ButtonType;
 import javafx.scene.image.Image;
 import javafx.stage.Screen;
 import javafx.stage.Stage;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.devonfw.ide.gui.context.GuiStateManager;
+import com.devonfw.ide.gui.context.TaskManager;
 import com.devonfw.ide.gui.modal.IdeDialog;
 import com.devonfw.tools.ide.variable.IdeVariables;
 import com.devonfw.tools.ide.version.IdeVersion;
@@ -31,14 +34,19 @@ public class App extends Application {
   public void start(Stage primaryStage) throws IOException {
 
     Thread.setDefaultUncaughtExceptionHandler((thread, throwable) -> {
-          LOG.error("Uncaught exception in thread {}: {}", thread.getName(), throwable.getMessage(), throwable);
+          System.out.println("Uncaught exception in thread " + thread.getName() + ":" + throwable.getMessage());
+
+          //Left this in, because of issues with printing errors when the Fx Application Thread crashes. Needs further research.
+          throwable.printStackTrace();
           Platform.runLater(() -> new IdeDialog(IdeDialog.AlertType.ERROR, throwable.getMessage()).showAndWait());
         }
     );
+    TaskManager taskManager = new TaskManager();
+    GuiStateManager guiStateManager = new GuiStateManager(taskManager, null);
 
     FXMLLoader fxmlLoader = new FXMLLoader(App.class.getResource("main-view.fxml"));
     fxmlLoader.setController(
-        new MainController(System.getenv(IdeVariables.IDE_ROOT.getName()))
+        new MainController(System.getenv(IdeVariables.IDE_ROOT.getName()), guiStateManager)
     );
     root = fxmlLoader.load();
 
@@ -52,6 +60,30 @@ public void start(Stage primaryStage) throws IOException {
     primaryStage.setMinWidth(scene.getWidth());
     primaryStage.setMinHeight(scene.getHeight());
     primaryStage.show();
+
+    primaryStage.setOnCloseRequest(event -> {
+
+      LOG.info("Closing application");
+      if (!taskManager.getTasks().isEmpty()) {
+        IdeDialog closeConfirm = new IdeDialog(IdeDialog.AlertType.CONFIRMATION, "There are still running tasks. Are you sure you want to exit?",
+            ButtonType.CLOSE, ButtonType.CANCEL);
+        closeConfirm.showAndWait().ifPresent(response -> {
+          if (response == ButtonType.CLOSE) {
+            exitApplication();
+          } else {
+            event.consume();
+          }
+        });
+      } else {
+        exitApplication();
+      }
+    });
+  }
+
+  private void exitApplication() {
+
+    Platform.exit();
+    System.exit(0);
   }
 
 

gui/src/main/java/com/devonfw/ide/gui/AppLauncher.java

@@ -6,8 +6,7 @@
  */
 public class AppLauncher {
 
-  @SuppressWarnings("MissingJavadoc")
-  public static void main(final String[] args) {
+  static void main(final String[] args) {
 
     App.main(args);
   }

gui/src/main/java/com/devonfw/ide/gui/FxHelper.java

@@ -0,0 +1,24 @@
+package com.devonfw.ide.gui;
+
+import javafx.application.Platform;
+
+/**
+ * Helper class containing tools for interacting with JavaFX
+ */
+public class FxHelper {
+
+  /**
+   * Allows running operations on the Fx Application Thread, but only if the call is originating from the Fx Application Thread. Idea: Some tasks that are doing
+   * (potentially heavy) background work might not originate from the Fx Application (UI) Thread but will still interact with javafx observable collections.
+   *
+   * @param runnable code to execute
+   */
+  public static void runFxSafe(Runnable runnable) {
+    if (Platform.isFxApplicationThread()) {
+      runnable.run();
+    } else {
+      Platform.runLater(runnable);
+    }
+  }
+
+}

gui/src/main/java/com/devonfw/ide/gui/MainController.java

@@ -4,25 +4,36 @@
 import java.nio.file.NotDirectoryException;
 import java.nio.file.Path;
 import java.util.List;
+import javafx.application.Platform;
+import javafx.collections.ListChangeListener;
+import javafx.concurrent.Task;
 import javafx.fxml.FXML;
+import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Button;
 import javafx.scene.control.ComboBox;
+import javafx.scene.control.Label;
+import javafx.scene.control.ProgressBar;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.devonfw.ide.gui.context.IdeGuiStateManager;
+import com.devonfw.ide.gui.context.GuiStateManager;
 import com.devonfw.ide.gui.context.ProjectManager;
+import com.devonfw.ide.gui.context.TaskManager;
 import com.devonfw.ide.gui.modal.IdeDialog;
+import com.devonfw.ide.gui.progress.ProgressBarTask;
+import com.devonfw.ide.gui.progress.taskwindow.TaskOverviewWindow;
 
 /**
  * Controller of the main screen of the dashboard GUI.
  */
 public class MainController {
 
-  private static Logger LOG = LoggerFactory.getLogger(MainController.class);
+  private static final Logger LOG = LoggerFactory.getLogger(MainController.class);
 
-  private ProjectManager projectManager;
+  private final GuiStateManager guiStateManager;
+  private final ProjectManager projectManager;
+  private final TaskManager taskManager;
 
 
   @FXML
@@ -43,19 +54,60 @@ public class MainController {
   @FXML
   private Button vsCodeOpen;
 
-  private final String directoryPath;
+  @FXML
+  private Label statusLabel;
+
+  @FXML
+  private ProgressBar statusProgressBar;
+  private final double PROGRESSBAR_VISIBLE_WIDTH = 150.0;
+
+  private final String ideRootPath;
   private Path projectValue;
   private Path workspaceValue;
 
   /**
    * Constructor
+   *
+   * @param ideRoot the IDE_ROOT path
+   * @param guiStateManager the {@link GuiStateManager} to be used in this application instance
    */
-  public MainController(String directoryPath) {
+  public MainController(String ideRoot, GuiStateManager guiStateManager) {
 
-    LOG.debug("IDE_ROOT path={}", directoryPath);
-    this.directoryPath = directoryPath;
+    LOG.debug("IDE_ROOT path={}", ideRoot);
+    this.ideRootPath = ideRoot;
+    this.guiStateManager = guiStateManager;
+    this.taskManager = guiStateManager.getTaskManager();
+    this.projectManager = guiStateManager.getProjectManager();
 
-    this.projectManager = IdeGuiStateManager.getInstance().getProjectManager();
+    setUpTaskListListener();
+  }
+
+  private void setUpTaskListListener() {
+
+    ListChangeListener<ProgressBarTask> taskListChangeListener = change -> {
+      List<ProgressBarTask> tasks = taskManager.getTasks();
+
+      while (change.next()) {
+        if (change.wasAdded()) {
+          LOG.debug("Added: {}", change.getAddedSubList());
+
+          for (ProgressBarTask product : change.getAddedSubList()) {
+            product.currentProgressProperty().addListener((_, _, _) ->
+                updateStatusLabel(tasks)
+            );
+          }
+          updateStatusLabel(tasks);
+        } else if (change.wasRemoved()) {
+          LOG.debug("Removed: {}", change.getRemoved());
+
+          updateStatusLabel(tasks);
+        } else if (change.wasUpdated()) {
+
+          updateStatusLabel(tasks);
+        }
+      }
+    };
+    taskManager.getTasks().addListener(taskListChangeListener);
   }
 
   @FXML
@@ -90,7 +142,7 @@ private void openVsCode() {
 
   private void setProjectsComboBox() {
 
-    assert (directoryPath != null) : "directoryPath is null! Please check the setup of your environment variables (IDE_ROOT)";
+    assert (ideRootPath != null) : "directoryPath is null! Please check the setup of your environment variables (IDE_ROOT)";
 
     List<String> projects = projectManager.getProjectNames();
 
@@ -107,7 +159,7 @@ private void setProjectsComboBox() {
 
   private void setWorkspaceComboBox() {
 
-    List<String> workspaces = null;
+    List<String> workspaces;
     try {
       workspaces = projectManager.getWorkspaceNames(selectedProject.getValue());
     } catch (NotDirectoryException e) {
@@ -129,20 +181,89 @@ private void setWorkspaceComboBox() {
 
   private void openIDE(String inIde) {
 
-    IdeGuiStateManager
-        .getInstance()
-        .getCurrentContext()
-        .getCommandletManager()
-        .getCommandlet(inIde)
-        .run();
+    Task<Void> downloadTask = runIdeCommandTask(inIde);
+
+    new Thread(downloadTask).start();
+  }
+
+  private Task<Void> runIdeCommandTask(String inIde) {
+
+    try (ProgressBarTask task = (ProgressBarTask) guiStateManager.getCurrentContext()
+        .newProgressBarIndeterminate("Starting " + inIde)) {
+      Task<Void> downloadTask = new Task<>() {
+        @Override
+        protected Void call() {
+          guiStateManager
+              .getCurrentContext()
+              .getCommandletManager()
+              .getCommandlet(inIde)
+              .run();
+          task.close();
+          return null;
+        }
+      };
+
+      downloadTask.setOnFailed(_ -> Platform.runLater(() -> {
+        task.close();
+        IdeDialog errorDialog = new IdeDialog(AlertType.ERROR, "Error occurred while launching " + inIde);
+        errorDialog.showAndWait();
+      }));
+      return downloadTask;
+    }
   }
 
   private void updateContext(String selectedProjectName, String selectedWorkspaceName) {
+
     try {
-      IdeGuiStateManager.getInstance().switchContext(selectedProjectName, selectedWorkspaceName);
+      guiStateManager.switchContext(selectedProjectName, selectedWorkspaceName);
     } catch (FileNotFoundException e) {
-      IdeDialog errorDialog = new IdeDialog(IdeDialog.AlertType.ERROR, e.getMessage());
+      IdeDialog errorDialog = new IdeDialog(AlertType.ERROR, e.getMessage());
       errorDialog.showAndWait();
     }
   }
+
+  private void updateStatusLabel(List<ProgressBarTask> taskList) {
+
+    Platform.runLater(() -> {
+
+      if (taskList.size() > 1) {
+        statusLabel.setOnMouseClicked(e -> TaskOverviewWindow.getInstance(taskManager).showRelativeToReferenceNode(statusLabel));
+
+        statusProgressBar.setVisible(false);
+        statusProgressBar.setPrefWidth(0);
+        statusLabel.setText(taskList.size() + " tasks running...");
+
+        statusLabel.setUnderline(true);
+        statusLabel.setStyle(
+            "-fx-text-fill: blue;"
+                + "-fx-cursor: hand"
+        );
+      } else if (taskList.size() == 1) {
+        statusLabel.setOnMouseClicked(null);
+
+        ProgressBarTask task = taskList.getFirst();
+        statusLabel.setText(String.format(
+            ProgressBarTask.TASK_DESCRIPTION_STRING_FORMAT,
+            task.getTitle(),
+            task.getCurrentProgress(),
+            task.getMaxSize(),
+            task.getUnitName())
+        );
+        statusLabel.setUnderline(false);
+        statusLabel.setStyle("");
+
+        statusProgressBar.setVisible(true);
+        statusProgressBar.setPrefWidth(PROGRESSBAR_VISIBLE_WIDTH);
+        statusProgressBar.setProgress((double) (task.getCurrentProgress()) / task.getMaxSize());
+      } else {
+        statusLabel.setOnMouseClicked(null);
+        statusLabel.setText("IDEasy is ready.");
+        statusProgressBar.setVisible(false);
+        statusProgressBar.setPrefWidth(0);
+
+        statusLabel.setUnderline(false);
+        statusLabel.setStyle("");
+      }
+    });
+  }
 }