Merge pull request bisq-network#1801 from HenrikJannsen/improve-shutd…

…own-process

Improve shutdown process

application/src/main/java/bisq/application/Executable.java

@@ -37,15 +37,22 @@ public void shutdown() {
             return;
         }
         shutDownStarted = true;
+        notifyAboutShutdown();
         if (applicationService != null) {
             applicationService.shutdown()
                     .thenRun(() -> {
                         shutDownHandlers.forEach(Runnable::run);
                         exitJvm();
                     });
+        } else {
+            shutDownHandlers.forEach(Runnable::run);
+            exitJvm();
         }
     }
 
+    protected void notifyAboutShutdown() {
+    }
+
     protected void exitJvm() {
         log.info("Exiting JVM");
         System.exit(OsUtils.EXIT_SUCCESS);

application/src/main/java/bisq/updater/UpdaterService.java

@@ -99,10 +99,12 @@ public void clear() {
 
     @Override
     public CompletableFuture<Boolean> shutdown() {
-        if (executorService != null) {
-            ExecutorFactory.shutdownAndAwaitTermination(executorService, 100);
-        }
-        return CompletableFuture.completedFuture(true);
+        return CompletableFuture.supplyAsync(() -> {
+            if (executorService != null) {
+                ExecutorFactory.shutdownAndAwaitTermination(executorService, 100);
+            }
+            return true;
+        });
     }
 
 

apps/desktop/desktop-app/src/main/java/bisq/desktop_app/DesktopApplicationService.java

@@ -26,6 +26,7 @@
 import bisq.common.application.Service;
 import bisq.common.observable.Observable;
 import bisq.common.util.CompletableFutureUtils;
+import bisq.common.util.ExceptionUtil;
 import bisq.contract.ContractService;
 import bisq.desktop.ServiceProvider;
 import bisq.desktop.State;
@@ -63,10 +64,17 @@
 
 @Slf4j
 public class DesktopApplicationService extends ApplicationService {
+    public static final long STARTUP_TIMEOUT_SEC = 300;
+    public static final long SHUTDOWN_TIMEOUT_SEC = 10;
+
     @Getter
     private final ServiceProvider serviceProvider;
     @Getter
     private final Observable<State> state = new Observable<>(State.INITIALIZE_APP);
+    @Getter
+    private final Observable<String> shutDownErrorMessage = new Observable<>();
+    @Getter
+    private final Observable<String> startupErrorMessage = new Observable<>();
 
     private final SecurityService securityService;
     private final Optional<WalletService> walletService;
@@ -235,18 +243,20 @@ public CompletableFuture<Boolean> initialize() {
                 .thenCompose(result -> tradeService.initialize())
                 .thenCompose(result -> updaterService.initialize())
                 .thenCompose(result -> bisqEasyService.initialize())
-                .orTimeout(5, TimeUnit.MINUTES)
+                .orTimeout(STARTUP_TIMEOUT_SEC, TimeUnit.SECONDS)
                 .handle((result, throwable) -> {
                     if (throwable == null) {
                         if (result != null && result) {
                             setState(State.APP_INITIALIZED);
                             log.info("ApplicationService initialized");
                             return true;
                         } else {
-                            log.error("Initializing applicationService failed");
+                            startupErrorMessage.set("Initializing applicationService failed with result=false");
+                            log.error(startupErrorMessage.get());
                         }
                     } else {
                         log.error("Initializing applicationService failed", throwable);
+                        startupErrorMessage.set(ExceptionUtil.getMessageOrToString(throwable));
                     }
                     setState(State.FAILED);
                     return false;
@@ -274,13 +284,15 @@ public CompletableFuture<Boolean> shutdown() {
                 .thenCompose(result -> walletService.map(Service::shutdown)
                         .orElse(CompletableFuture.completedFuture(true)))
                 .thenCompose(result -> securityService.shutdown())
-                .orTimeout(10, TimeUnit.SECONDS)
+                .orTimeout(SHUTDOWN_TIMEOUT_SEC, TimeUnit.SECONDS)
                 .handle((result, throwable) -> {
                     if (throwable != null) {
                         log.error("Error at shutdown", throwable);
+                        shutDownErrorMessage.set(ExceptionUtil.getMessageOrToString(throwable));
                         return false;
                     } else if (!result) {
-                        log.error("Shutdown resulted with false");
+                        shutDownErrorMessage.set("Shutdown failed with result=false");
+                        log.error(startupErrorMessage.get());
                         return false;
                     }
                     return true;

apps/desktop/desktop-app/src/main/java/bisq/desktop_app/DesktopExecutable.java

@@ -19,8 +19,10 @@
 
 import bisq.application.Executable;
 import bisq.desktop.DesktopController;
+import bisq.desktop.common.threading.UIScheduler;
 import bisq.desktop.common.threading.UIThread;
 import bisq.desktop.components.overlay.Popup;
+import bisq.i18n.Res;
 import javafx.application.Application;
 import javafx.application.Platform;
 import lombok.extern.slf4j.Slf4j;
@@ -33,6 +35,8 @@
 public class DesktopExecutable extends Executable<DesktopApplicationService> {
     @Nullable
     private DesktopController desktopController;
+    @Nullable
+    private Popup shutdownInProcessPopup;
 
     public DesktopExecutable(String[] args) {
         super(args);
@@ -55,7 +59,9 @@ protected void launchApplication(String[] args) {
                     if (throwable == null) {
                         try {
                             log.info("Java FX Application launched");
-                            desktopController = new DesktopController(applicationService.getState(), applicationService.getServiceProvider(),
+                            setupStartupAndShutdownErrorHandlers();
+                            desktopController = new DesktopController(applicationService.getState(),
+                                    applicationService.getServiceProvider(),
                                     applicationData,
                                     this::onApplicationLaunched);
                             desktopController.init();
@@ -95,11 +101,72 @@ protected void setDefaultUncaughtExceptionHandler() {
         });
     }
 
+    @Override
+    protected void notifyAboutShutdown() {
+        if (shutdownInProcessPopup != null) {
+            return;
+        }
+        try {
+            UIThread.run(() -> {
+                shutdownInProcessPopup = new Popup()
+                        .headline(Res.get("action.shutDown"))
+                        .feedback(Res.get("popup.shutdown", DesktopApplicationService.SHUTDOWN_TIMEOUT_SEC));
+                shutdownInProcessPopup.hideCloseButton().show();
+            });
+        } catch (Exception ignore) {
+        }
+    }
+
     @Override
     protected void exitJvm() {
+        if (applicationService.getShutDownErrorMessage().get() == null) {
+            doExit();
+        }
+        // If we have an error popup we leave it to the user to close it and shutdown the app by clicking the shutdown button
+    }
+
+    private void doExit() {
         log.info("Exiting JavaFX Platform");
         Platform.exit();
-
         super.exitJvm();
     }
+
+    private void setupStartupAndShutdownErrorHandlers() {
+        applicationService.getStartupErrorMessage().addObserver(errorMessage -> {
+            if (errorMessage != null) {
+                UIThread.run(() ->
+                        new Popup().error(Res.get("popup.startup.error", errorMessage))
+                                .closeButtonText(Res.get("action.shutDown"))
+                                .onClose(this::doExit)
+                                .show()
+                );
+            }
+        });
+        applicationService.getShutDownErrorMessage().addObserver(errorMessage -> {
+            if (errorMessage != null) {
+                UIThread.run(() -> {
+                    if (shutdownInProcessPopup != null) {
+                        shutdownInProcessPopup.hide();
+                        shutdownInProcessPopup = null;
+                    }
+                    Popup popup = new Popup();
+                    popup.error(Res.get("popup.shutdown.error", errorMessage))
+                            .closeButtonText(Res.get("action.shutDown"))
+                            .onClose(this::doExit)
+                            .show();
+                    // The error popup allow to report to GH, in that case we get closed the error popup.
+                    // We leave the app open and reset the shutDownStarted flag, so that at another
+                    // shutdown action shut down can happen. Only when the user clicks the close
+                    // button we actually shut down.
+                    popup.getIsHiddenProperty().addListener((observableValue, oldValue, newValue) -> {
+                        if (newValue) {
+                            shutDownStarted = false;
+                        }
+                    });
+                    // We reset the error so that it can get triggered again our error popup in case the user shutdown again.
+                    UIScheduler.run(() -> applicationService.getShutDownErrorMessage().set(null)).after(1000);
+                });
+            }
+        });
+    }
 }

apps/desktop/desktop/src/main/java/bisq/desktop/components/overlay/Overlay.java

@@ -405,7 +405,7 @@ public T error(Throwable throwable) {
     public T error(String message) {
         type = Type.ERROR;
         showReportErrorButtons();
-        width = 1100;
+        width = 800;
         if (headline == null)
             this.headline = Res.get("popup.headline.error");
         processMessage(message);

apps/desktop/desktop/src/main/java/bisq/desktop/main/content/bisq_easy/open_trades/trade_state/states/SellerState1.java

@@ -85,24 +85,24 @@ public void onActivate() {
 
             model.getSortedAccounts().setComparator(Comparator.comparing(Account::getAccountName));
 
-            accountsPin = accountService.getAccounts().addObserver(() -> {
-                List<UserDefinedFiatAccount> accounts = accountService.getAccounts().stream()
-                        .filter(account -> account instanceof UserDefinedFiatAccount)
-                        .map(account -> (UserDefinedFiatAccount) account)
-                        .collect(Collectors.toList());
-                model.setAllAccounts(accounts);
-                model.getAccountSelectionVisible().set(accounts.size() > 1);
-                maybeSelectFirstAccount();
-            });
-            selectedAccountPin = accountService.selectedAccountAsObservable().addObserver(account -> {
-                UIThread.run(() -> {
-                    if (account instanceof UserDefinedFiatAccount) {
-                        UserDefinedFiatAccount userDefinedFiatAccount = (UserDefinedFiatAccount) account;
-                        model.selectedAccountProperty().set(userDefinedFiatAccount);
-                        model.getPaymentAccountData().set(userDefinedFiatAccount.getAccountPayload().getAccountData());
-                    }
-                });
-            });
+            accountsPin = accountService.getAccounts().addObserver(() ->
+                    UIThread.run(() -> {
+                        List<UserDefinedFiatAccount> accounts = accountService.getAccounts().stream()
+                                .filter(account -> account instanceof UserDefinedFiatAccount)
+                                .map(account -> (UserDefinedFiatAccount) account)
+                                .collect(Collectors.toList());
+                        model.setAllAccounts(accounts);
+                        model.getAccountSelectionVisible().set(accounts.size() > 1);
+                        maybeSelectFirstAccount();
+                    }));
+            selectedAccountPin = accountService.selectedAccountAsObservable().addObserver(account ->
+                    UIThread.run(() -> {
+                        if (account instanceof UserDefinedFiatAccount) {
+                            UserDefinedFiatAccount userDefinedFiatAccount = (UserDefinedFiatAccount) account;
+                            model.selectedAccountProperty().set(userDefinedFiatAccount);
+                            model.getPaymentAccountData().set(userDefinedFiatAccount.getAccountPayload().getAccountData());
+                        }
+                    }));
 
             model.getButtonDisabled().bind(model.getPaymentAccountData().isEmpty());
             findUsersAccountData().ifPresent(accountData -> model.getPaymentAccountData().set(accountData));

apps/desktop/desktop/src/main/java/bisq/desktop/main/content/user/accounts/PaymentAccountsController.java

@@ -25,6 +25,7 @@
 import bisq.common.observable.Pin;
 import bisq.desktop.ServiceProvider;
 import bisq.desktop.common.observable.FxBindings;
+import bisq.desktop.common.threading.UIThread;
 import bisq.desktop.common.view.Controller;
 import bisq.desktop.common.view.Navigation;
 import bisq.i18n.Res;
@@ -61,13 +62,15 @@ public void onActivate() {
         model.getSortedAccounts().setComparator(Comparator.comparing(Account::getAccountName));
 
         accountsPin = accountService.getAccounts().addObserver(() -> {
-            model.setAllAccounts(accountService.getAccounts());
-            maybeSelectFirstAccount();
-            model.getNoAccountsSetup().set(!accountService.hasAccounts());
-            model.getHeadline().set(accountService.hasAccounts() ?
-                    Res.get("user.paymentAccounts.headline") :
-                    Res.get("user.paymentAccounts.noAccounts.headline")
-            );
+            UIThread.run(() -> {
+                model.setAllAccounts(accountService.getAccounts());
+                maybeSelectFirstAccount();
+                model.getNoAccountsSetup().set(!accountService.hasAccounts());
+                model.getHeadline().set(accountService.hasAccounts() ?
+                        Res.get("user.paymentAccounts.headline") :
+                        Res.get("user.paymentAccounts.noAccounts.headline")
+                );
+            });
         });
 
         selectedAccountPin = FxBindings.bind(model.selectedAccountProperty())

apps/desktop/desktop/src/main/java/bisq/desktop/splash/SplashController.java

@@ -50,9 +50,9 @@ public SplashController(Observable<State> applicationServiceState, ServiceProvid
 
     @Override
     public void onActivate() {
-        applicationServiceStatePin = applicationServiceState.addObserver(state -> {
-            UIThread.run(() -> model.getApplicationServiceState().set(Res.get("splash.applicationServiceState." + state.name())));
-        });
+        applicationServiceStatePin = applicationServiceState.addObserver(state ->
+                UIThread.run(() -> model.getApplicationServiceState().set(Res.get("splash.applicationServiceState." + state.name())))
+        );
 
         if (networkService.getSupportedTransportTypes().contains(TransportType.CLEAR)) {
             model.getBootstrapStateDisplays().add(new BootstrapStateDisplay(TransportType.CLEAR, serviceProvider));

i18n/src/main/resources/application.properties

@@ -232,6 +232,10 @@ popup.reportError={0}\n\nTo help us to improve the software please report this b
 The above error message will be copied to the clipboard when you click any of the buttons below.\n\
 It will make debugging easier if you include the bisq.log file by pressing 'Open log file', saving a copy, and attaching it to your bug report.
 popup.reportBug=Report bug to Bisq developers
+popup.startup.error=An error occurred at initializing Bisq: {0}.
+popup.shutdown=Shut down is in process.\n\n\
+  It might take up to {0} seconds until shut down is completed.
+popup.shutdown.error=An error occurred at shut down: {0}.
 
 
 ####################################################################

network/network/src/main/java/bisq/network/NetworkService.java

@@ -205,12 +205,15 @@ public CompletableFuture<Boolean> initialize() {
 
     public CompletableFuture<Boolean> shutdown() {
         log.info("shutdown");
-        messageDeliveryStatusService.ifPresent(MessageDeliveryStatusService::shutdown);
-        resendMessageService.ifPresent(ResendMessageService::shutdown);
-        networkLoadService.ifPresent(NetworkLoadService::shutdown);
-        dataService.ifPresent(DataService::shutdown);
-        return serviceNodesByTransport.shutdown()
-                .thenApply(list -> list.stream().filter(e -> e).count() == supportedTransportTypes.size());
+        return CompletableFuture.supplyAsync(() -> {
+                    messageDeliveryStatusService.ifPresent(MessageDeliveryStatusService::shutdown);
+                    resendMessageService.ifPresent(ResendMessageService::shutdown);
+                    networkLoadService.ifPresent(NetworkLoadService::shutdown);
+                    dataService.ifPresent(DataService::shutdown);
+                    return true;
+                })
+                .thenCompose(result -> serviceNodesByTransport.shutdown()
+                        .thenApply(list -> list.stream().filter(e -> e).count() == supportedTransportTypes.size()));
     }
 
 

network/network/src/main/java/bisq/network/p2p/ServiceNode.java

@@ -55,7 +55,6 @@
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CopyOnWriteArraySet;
-import java.util.concurrent.TimeUnit;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static java.util.concurrent.CompletableFuture.runAsync;
@@ -245,8 +244,6 @@ CompletableFuture<Boolean> shutdown() {
         inventoryService.ifPresent(InventoryService::shutdown);
         confidentialMessageService.ifPresent(ConfidentialMessageService::shutdown);
         return nodesById.shutdown()
-                .orTimeout(10, TimeUnit.SECONDS)
-                .handle((result, throwable) -> throwable == null && result)
                 .thenCompose(result -> transportService.shutdown())
                 .whenComplete((result, throwable) -> setState(State.TERMINATED));
     }

network/network/src/main/java/bisq/network/p2p/node/transport/TorTransportService.java

@@ -70,8 +70,7 @@ public CompletableFuture<Boolean> shutdown() {
             startBootstrapProgressUpdater.stop();
             startBootstrapProgressUpdater = null;
         }
-        torService.shutdown().join();
-        return CompletableFuture.completedFuture(true);
+        return torService.shutdown();
     }
 
     @Override

network/tor/tor/src/main/java/bisq/tor/TorService.java

@@ -106,9 +106,12 @@ public CompletableFuture<Boolean> initialize() {
 
     @Override
     public CompletableFuture<Boolean> shutdown() {
-        nativeTorController.shutdown();
-        torProcess.ifPresent(NativeTorProcess::waitUntilExited);
-        return CompletableFuture.completedFuture(true);
+        log.info("shutdown");
+        return CompletableFuture.supplyAsync(() -> {
+            nativeTorController.shutdown();
+            torProcess.ifPresent(NativeTorProcess::waitUntilExited);
+            return true;
+        });
     }
 
     public Observable<BootstrapEvent> getBootstrapEvent() {

network/tor/tor/src/main/java/bisq/tor/controller/NativeTorController.java

@@ -151,6 +151,7 @@ public void waitUntilBootstrapped() {
     }
 
     public void shutdown() {
+        log.info("Send SHUTDOWN signal to tor control");
         boolean canShutdown = isRunning.compareAndSet(true, false);
         if (!canShutdown) {
             return;