#1784 implement java fx based progress bars for the GUI

cli/pom.xml

@@ -138,8 +138,6 @@
               </archive>
             </configuration>
           </execution>
-
-          <!-- jar for test classes -->
           <execution>
             <id>test-jar</id>
             <goals>

cli/src/main/java/com/devonfw/tools/ide/tool/gui/Gui.java

@@ -62,7 +62,7 @@ protected void doRun() {
 
     Mvn mvn = context.getCommandletManager().getCommandlet(Mvn.class);
 
-    Path pomPath = context.getIdeInstallationPath().resolve("gui/pom.xml");
+    Path pomPath = context.getIdeInstallationPath().resolve("gui").resolve("pom.xml");
     if (!Files.exists(pomPath)) {
       LOG.error("Fatal error: The pom.xml file required for launching the IDEasy GUI could not be found in expected location: {}", pomPath);
       return;

cli/src/test/java/com/devonfw/tools/ide/context/IdeContextTest.java

@@ -5,13 +5,6 @@
 import java.util.Properties;
 
 import org.junit.jupiter.api.Test;
-import com.devonfw.tools.ide.security.ToolVersionChoice;
-import com.devonfw.tools.ide.tool.ToolEditionAndVersion;
-import com.devonfw.tools.ide.security.ToolVulnerabilities;
-import com.devonfw.tools.ide.version.VersionIdentifier;
-import com.devonfw.tools.ide.version.VersionRange;
-import com.devonfw.tools.ide.url.model.file.json.Cve;
-import com.devonfw.tools.ide.tool.ToolEdition;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -24,13 +17,20 @@
 import com.devonfw.tools.ide.log.IdeLogLevel;
 import com.devonfw.tools.ide.os.SystemInfo;
 import com.devonfw.tools.ide.os.SystemInfoMock;
+import com.devonfw.tools.ide.security.ToolVersionChoice;
+import com.devonfw.tools.ide.security.ToolVulnerabilities;
+import com.devonfw.tools.ide.tool.ToolEdition;
+import com.devonfw.tools.ide.tool.ToolEditionAndVersion;
+import com.devonfw.tools.ide.url.model.file.json.Cve;
 import com.devonfw.tools.ide.variable.IdeVariables;
 import com.devonfw.tools.ide.version.IdeVersion;
+import com.devonfw.tools.ide.version.VersionIdentifier;
+import com.devonfw.tools.ide.version.VersionRange;
 
 /**
  * Test of {@link IdeContext}.
  */
-class IdeContextTest extends AbstractIdeContextTest {
+public class IdeContextTest extends AbstractIdeContextTest {
 
   private static final Logger LOG = LoggerFactory.getLogger(IdeContextTest.class);
 
@@ -284,7 +284,7 @@ void testFindBashOnSystemPathOnWindowsWithInvalidBashPathSet() {
   @Test
   void testQuestionWithMultipleOptions() {
     IdeTestContext context = newContext(PROJECT_BASIC, null, false);
-    String[] options = {"option1", "option2"};
+    String[] options = { "option1", "option2" };
     context.setAnswers("option1");
     String result = context.question(options, "Which option?");
     assertThat(result).isEqualTo("option1");
@@ -293,7 +293,7 @@ void testQuestionWithMultipleOptions() {
   @Test
   void testQuestionWithSingleOptionAndEmptyAnswer() {
     IdeTestContext context = newContext(PROJECT_BASIC, null, false);
-    String[] options = {"onlyOption"};
+    String[] options = { "onlyOption" };
     context.setAnswers(""); // Empty answer (Enter)
     String result = context.question(options, "Which option?");
     assertThat(result).isEqualTo("onlyOption");
@@ -306,7 +306,7 @@ void testQuestionWithSingleToolVersionChoiceAndEmptyAnswer() {
     VersionIdentifier version = VersionIdentifier.of("17");
     Cve cve = new Cve("CVE-2023-XXXX", 9.8, List.of(VersionRange.of("[17,18)")));
     ToolVersionChoice choice = new ToolVersionChoice(new ToolEditionAndVersion(edition, version), "current", ToolVulnerabilities.of(List.of(cve)));
-    ToolVersionChoice[] options = {choice};
+    ToolVersionChoice[] options = { choice };
 
     context.setAnswers(""); // Empty answer (Enter)
     ToolVersionChoice result = context.question(options, "Which version?");

documentation/images/gui/Task Management structure.puml

@@ -0,0 +1,20 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+class TaskManager
+class IdeGuiContext
+class MainController implements ProgressListener
+interface ProgressListener {
+ +void onUpdateTaskProgress(Task task)
+ +void onTaskAdded()
+  +void onTaskRemoved()
+}
+class GuiProgressBarHandling
+
+IdeGuiContext ..> GuiProgressBarHandling : instantiates
+IdeGuiContext ..> TaskManager : adds instantiated task to
+TaskManager ..> MainController : notifies about task updates
+TaskManager <.. GuiProgressBarHandling : when close() called: removes itself from TaskManager
+MainController ..> TaskManager : registers itself for updates
+
+@enduml

documentation/images/gui/gui.puml

@@ -0,0 +1,87 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+title GUI Structure
+
+
+package "cli" {
+abstract class AbstractIdeContext
+}
+package "gui" {
+  class AppLauncher {
+    +void main(String [])
+  }
+
+  class App {
+    +void main(String [])
+    +void start()
+  }
+
+  class IdeGuiStateManager <<Thread safe singleton>> {
+      -String projectDirectory
+      -IdeGuiContext currentContext
+      --
+      -IdeGuiStateManager()
+      +{static} IdeGuiStateManager getInstance()
+      ..GUI context handling..
+      +IdeGuiContext switchContext(projectName: String, workspaceName: String)
+      +IdeGuiContext getCurrentContext()
+      +void addStateChangeListener(StateChangeListener listener)
+      +void removeStateChangeListener(StateChangeListener listener)
+  }
+
+  -static class "IdeGuiStateManager.Holder" as Holder {
+    -{static} INSTANCE
+  }
+
+  class MainController {
+    -void initialize()
+    ..
+    -void setProjectsCombobox()
+    -void setWorkspaceValue()
+    ..
+    -void updateContext(String projectName, String workspaceName)
+  }
+
+  abstract class "IdeGuiStateManager.StateChangeListener" as StateChangeListener {
+    +void onStateChange(IdeGuiContext newContext)
+  }
+
+  class IdeGuiContext
+
+
+  note right of IdeGuiStateManager
+    In the most basic sense, the GUI state depends on the current project context.
+    This is important to ensure that any commandlets will be executed in the correct project.
+  end note
+  note bottom of StateChangeListener
+    Idea: This listener is implemented by any UI component to get notified of any context changes.
+    Alternative: an abstract StateDependentGuiComponent class that implements the listener and provides an abstract method for handling context changes.
+    Or: restart the app everytime the context changes (probably not the user-friendliest idea)
+  end note
+  note right of App: FXML layout is loaded here
+  note bottom of Holder: simple instance wrapper class for Bill Pugh singleton
+  note right of IdeGuiContext: This will implement modals/progress bars
+  note top of AppLauncher
+    <b>Current considerations regarding the UI state management:</b>
+    - Darf die GUI mehr als einmal offen sein? (Fall: Fenster mit gleichem Projekt parallel offen)
+    - Wie Context-Handling implementieren?
+    - Wie werden Log messages gehandelt?
+  end note
+}
+
+
+'' Relations ''
+
+AppLauncher --> App : launches
+
+IdeGuiContext ..> AbstractIdeContext : extends
+
+IdeGuiStateManager ..> IdeGuiContext : creates/manages instances of
+IdeGuiStateManager --> StateChangeListener : inner class
+IdeGuiStateManager -left> Holder : inner class
+
+App ..> MainController : initializes when loading layout
+MainController ..> IdeGuiStateManager : accesses/interacts with
+
+@enduml

gui/pom.xml

@@ -30,7 +30,6 @@
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>ide-cli</artifactId>
-      <classifier>tests</classifier>
       <version>${project.version}</version>
       <type>test-jar</type>
       <scope>test</scope>
@@ -68,6 +67,14 @@
       <artifactId>openjfx-monocle</artifactId>
       <scope>test</scope>
     </dependency>
+
+    <!-- required for using ide-cli testing classes -->
+    <dependency>
+      <groupId>org.wiremock</groupId>
+      <artifactId>wiremock</artifactId>
+      <version>3.13.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

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

@@ -2,14 +2,20 @@
 
 import java.io.IOException;
 import javafx.application.Application;
+import javafx.application.Platform;
 import javafx.fxml.FXMLLoader;
-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.scene.layout.BorderPane;
 import javafx.stage.Stage;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.devonfw.ide.gui.modal.IdeDialog;
+import com.devonfw.ide.gui.progress.TaskManager;
 import com.devonfw.tools.ide.variable.IdeVariables;
 import com.devonfw.tools.ide.version.IdeVersion;
 
@@ -20,25 +26,57 @@ public class App extends Application {
 
   Parent root;
 
+  private static final Logger LOG = LoggerFactory.getLogger(App.class);
+
   @Override
   public void start(Stage primaryStage) throws IOException {
 
+    Thread.setDefaultUncaughtExceptionHandler((thread, 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());
+        }
+    );
+
     FXMLLoader fxmlLoader = new FXMLLoader(App.class.getResource("main-view.fxml"));
     fxmlLoader.setController(
         new MainController(System.getenv(IdeVariables.IDE_ROOT.getName()))
     );
     root = fxmlLoader.load();
 
-    Rectangle2D bounds = Screen.getPrimary().getVisualBounds();
-    Scene scene = new Scene(root, bounds.getWidth() / 2, bounds.getHeight() / 2);
-
+    Scene scene = new Scene(root, ((BorderPane) fxmlLoader.getRoot()).getPrefWidth(), ((BorderPane) fxmlLoader.getRoot()).getPrefHeight());
     Image icon = new Image("com/devonfw/ide/gui/assets/devonfw.png");
     primaryStage.getIcons().add(icon);
     primaryStage.setTitle("IDEasy - version " + IdeVersion.getVersionString());
     primaryStage.setScene(scene);
     primaryStage.setMinWidth(scene.getWidth());
     primaryStage.setMinHeight(scene.getHeight());
     primaryStage.show();
+
+    primaryStage.setOnCloseRequest(event -> {
+
+      LOG.info("Closing application");
+      if (!TaskManager.getInstance().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

@@ -2,10 +2,11 @@
 
 /**
  * Launcher class for the App. Workaround for "Error: JavaFX runtime components are missing, and are required to run this application." Inspired by
- * <ahref=https://stackoverflow.com/questions/56894627/how-to-fix-error-javafx-runtime-components-are-missing-and-are-required-to-ru>StackOverflow</a>
+ * <a href=https://stackoverflow.com/questions/56894627/how-to-fix-error-javafx-runtime-components-are-missing-and-are-required-to-ru>StackOverflow</a>
  */
 public class AppLauncher {
 
+  @SuppressWarnings("MissingJavadoc")
   public 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 to run operations on the Fx Application Thread, but only, if the call is originating from the Fx Application Thread. Idea: Some tasks which are
+   * doing (potentially heavy) background work, might not originate from the Fx Application (UI) Thread.
+   *
+   * @param runnable code to execute
+   */
+  public static void runFxSafe(Runnable runnable) {
+    if (Platform.isFxApplicationThread()) {
+      runnable.run();
+    } else {
+      Platform.runLater(runnable);
+    }
+  }
+
+}