enhance LongOperation and LongOperationMonitorWindow to support multiple exception and progress consumers; add logging feature for progress updates

Author: marioserrano09

zk/src/main/java/tools/dynamia/zk/ui/LongOperationMonitorWindow.java

@@ -19,14 +19,18 @@
 import org.zkoss.zk.ui.event.Events;
 import org.zkoss.zul.*;
 import tools.dynamia.commons.ClassMessages;
+import tools.dynamia.commons.DateTimeUtils;
 import tools.dynamia.commons.Messages;
+import tools.dynamia.commons.logger.LoggingService;
 import tools.dynamia.integration.ProgressEvent;
 import tools.dynamia.integration.ProgressMonitor;
 import tools.dynamia.ui.MessageType;
 import tools.dynamia.ui.UIMessages;
 import tools.dynamia.zk.util.LongOperation;
 import tools.dynamia.zk.util.ZKUtil;
 
+import java.util.Date;
+
 public class LongOperationMonitorWindow extends Window {
 
     private static final long serialVersionUID = 1L;
@@ -40,6 +44,8 @@ public class LongOperationMonitorWindow extends Window {
     private Label messageLabel;
 
     private String messageTemplate = messages.get("DefaultProgressMessage");
+    private Listbox logListbox;
+    private boolean showLog;
 
     public LongOperationMonitorWindow(LongOperation longOperation, ProgressMonitor monitor) {
         this.longOperation = longOperation;
@@ -56,6 +62,7 @@ public static LongOperationMonitorWindow show(String title,
         win.setTitle(title);
         win.setPosition("center");
         win.doModal();
+        longOperation.onException(e -> win.detach());
         return win;
     }
 
@@ -104,6 +111,10 @@ private void updateProgress(ProgressEvent evt) {
         progress.setValue(evt.getPercent());
         progress.setTooltiptext(evt.getPercent() + "%");
         messageLabel.setValue(evt.getMessage());
+        if (isShowLog()) {
+            var item = logListbox.appendItem(DateTimeUtils.formatTime(new Date()) + " - " + evt.getMessage(), "");
+            logListbox.scrollToIndex(item.getIndex());
+        }
 
         String title = Messages.format(messageTemplate,
                 evt.getCurrent(), evt.getMax(), evt.getPercent());
@@ -127,6 +138,11 @@ private void initUI() {
         layout.setHflex("1");
         layout.setParent(this);
 
+        logListbox = new Listbox();
+        logListbox.setVisible(false);
+        logListbox.setHeight("150px");
+        logListbox.setParent(layout);
+
         progress = new Progressmeter();
         progress.setHflex("2");
         progress.setValue(0);
@@ -137,6 +153,43 @@ private void initUI() {
         messageLabel = new Label();
         messageLabel.setParent(msg);
         msg.setParent(layout);
+
+        Hlayout hlayout = new Hlayout();
+        hlayout.setHflex("1");
+        hlayout.setParent(layout);
+        hlayout.setVisible(false);
+
+        Label confirmStopLabel = new Label(messages.get("ConfirmStopProcess"));
+        confirmStopLabel.setStyle("font-weight:bold");
+        confirmStopLabel.setParent(hlayout);
+
+        Button yesBtn = new Button(messages.get("yes"));
+        yesBtn.setZclass("btn btn-success  btn-sm");
+        yesBtn.setParent(hlayout);
+        yesBtn.addEventListener(Events.ON_CLICK, evt -> stop());
+
+        Button noBtn = new Button(messages.get("no"));
+        noBtn.setZclass("btn btn-danger btn-sm");
+        noBtn.setParent(hlayout);
+        noBtn.addEventListener(Events.ON_CLICK, evt -> hlayout.setVisible(false));
+
+        addEventListener(Events.ON_CLOSE, evt -> {
+            evt.stopPropagation();
+            hlayout.setVisible(true);
+        });
+
+    }
+
+    protected void stop() {
+        try {
+            longOperation.onFinish(null);
+            monitor.stop();
+        } catch (Exception e) {
+            LoggingService.get(LongOperationMonitorWindow.class).error("Error stopping long operation", e);
+        } finally {
+            finish();
+        }
+
     }
 
     @Override
@@ -147,4 +200,13 @@ public void setTitle(String title) {
     public void setMessageTemplate(String messageTemplate) {
         this.messageTemplate = messageTemplate;
     }
+
+    public boolean isShowLog() {
+        return showLog;
+    }
+
+    public void setShowLog(boolean showLog) {
+        this.showLog = showLog;
+        logListbox.setVisible(showLog);
+    }
 }

zk/src/main/java/tools/dynamia/zk/util/LongOperation.java

@@ -25,6 +25,8 @@
 import tools.dynamia.integration.ProgressEvent;
 import tools.dynamia.integration.scheduling.SchedulerUtil;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -51,6 +53,7 @@
 public class LongOperation implements Runnable {
 
     private static final LoggingService LOGGER = LoggingService.get(LongOperation.class);
+    private EventQueue<LongOpEvent> opQueue;
 
     /**
      * Types of UI events triggered by a running LongOperation.
@@ -99,8 +102,8 @@ public Exception getError() {
     private Callback onFinishCallback;
     private Callback onCancelCallback;
     private Callback onCleanupCallback;
-    private Consumer<Exception> onExceptionConsumer;
-    private Consumer<ProgressEvent> onProgressConsumer;
+    private List<Consumer<Exception>> onExceptionConsumer;
+    private List<Consumer<ProgressEvent>> onProgressConsumer;
 
     private CompletableFuture<Void> future;
     private final AtomicBoolean cancelled = new AtomicBoolean(false);
@@ -153,10 +156,13 @@ public LongOperation onCancel(Callback cb) {
     }
 
     /**
-     * Register callback when an uncaught exception occurs.
+     * Register callback when an uncaught exception occurs. Supports multiple consumers.
      */
     public LongOperation onException(Consumer<Exception> cb) {
-        this.onExceptionConsumer = cb;
+        if (onExceptionConsumer == null) {
+            onExceptionConsumer = new ArrayList<>();
+        }
+        this.onExceptionConsumer.add(cb);
         return this;
     }
 
@@ -169,10 +175,13 @@ public LongOperation onCleanup(Callback cb) {
     }
 
     /**
-     * Register callback to receive UI progress reports (0-100).
+     * Register callback to receive UI progress reports (0-100). Sopports multiple consumers.
      */
     public LongOperation onProgress(Consumer<ProgressEvent> cb) {
-        this.onProgressConsumer = cb;
+        if (onProgressConsumer == null) {
+            onProgressConsumer = new ArrayList<>();
+        }
+        this.onProgressConsumer.add(cb);
         return this;
     }
 
@@ -239,7 +248,10 @@ private void safeExecute(Callback cb) {
     // ========================
 
     private EventQueue<LongOpEvent> queue() {
-        return EventQueues.lookup(name + "-" + taskId, EventQueues.SESSION, true);
+        if (opQueue == null) {
+            opQueue = EventQueues.lookup(name + "-" + taskId, EventQueues.SESSION, true);
+        }
+        return opQueue;
     }
 
     private void postEvent(LongOpEventType type, ProgressEvent progress, Exception ex) {
@@ -268,12 +280,12 @@ public void onEvent(EventListener<LongOpEvent> listener) {
     }
 
     private void safeException(Exception e) {
-        if (onExceptionConsumer != null) onExceptionConsumer.accept(e);
+        if (onExceptionConsumer != null) onExceptionConsumer.forEach(c -> c.accept(e));
         LOGGER.error("Unhandled exception in task {}", name, e);
     }
 
     private void safeProgress(ProgressEvent p) {
-        if (onProgressConsumer != null && p != null) onProgressConsumer.accept(p);
+        if (onProgressConsumer != null && p != null) onProgressConsumer.forEach(c -> c.accept(p));
     }
 
     private void cleanup() {