chore: configurable global UncaughtExceptionHandler for wiring framework (#19164)

Signed-off-by: Michael Heinrichs <[email protected]>

Author: netopyr

platform-sdk/consensus-otter-tests/src/testFixtures/java/org/hiero/otter/fixtures/turtle/TurtleNode.java

@@ -47,6 +47,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.ThreadContext;
+import org.assertj.core.api.Assertions;
 import org.hiero.consensus.model.node.KeysAndCerts;
 import org.hiero.consensus.model.node.NodeId;
 import org.hiero.consensus.model.status.PlatformStatus;
@@ -318,6 +319,9 @@ private void doStartNode() {
 
         model = WiringModelBuilder.create(platformContext.getMetrics(), time)
                 .withDeterministicModeEnabled(true)
+                .withUncaughtExceptionHandler((t, e) -> {
+                    Assertions.fail("Unexpected exception in wiring framework", e);
+                })
                 .build();
         final SemanticVersion version =
                 currentConfiguration.getValue(TurtleNodeConfiguration.SOFTWARE_VERSION, SemanticVersion.class);

platform-sdk/swirlds-common/src/main/java/com/swirlds/common/utility/RuntimeObjectRegistry.java

@@ -30,7 +30,7 @@ public final class RuntimeObjectRegistry {
     /**
      * The time provider. This is used to get the current time for the records.
      *
-     * <p>We also use this field to check if the registry has already been initialized by checking if it is {code null}.
+     * <p>We also use this field to check if the registry has already been initialized by checking if it is {@code null}.
      * An {@link AtomicReference} is used to make the check thread-safe.
      *
      */

platform-sdk/swirlds-component-framework/src/main/java/com/swirlds/component/framework/model/DeterministicWiringModel.java

@@ -9,6 +9,8 @@
 import com.swirlds.component.framework.wires.output.OutputWire;
 import com.swirlds.metrics.api.Metrics;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
+import java.lang.Thread.UncaughtExceptionHandler;
 import java.time.Duration;
 import java.time.Instant;
 import java.util.ArrayList;
@@ -36,16 +38,23 @@ public class DeterministicWiringModel extends TraceableWiringModel {
 
     private final DeterministicHeartbeatScheduler heartbeatScheduler;
 
+    private final UncaughtExceptionHandler taskSchedulerExceptionHandler;
+
     /**
      * Constructor.
      *
      * @param metrics the metrics
      * @param time the time
+     * @param taskSchedulerExceptionHandler the global {@link UncaughtExceptionHandler}
      */
-    DeterministicWiringModel(@NonNull final Metrics metrics, @NonNull final Time time) {
+    DeterministicWiringModel(
+            @NonNull final Metrics metrics,
+            @NonNull final Time time,
+            @Nullable final UncaughtExceptionHandler taskSchedulerExceptionHandler) {
         super(false);
         this.metrics = Objects.requireNonNull(metrics);
         this.heartbeatScheduler = new DeterministicHeartbeatScheduler(this, time, "heartbeat");
+        this.taskSchedulerExceptionHandler = taskSchedulerExceptionHandler;
     }
 
     /**
@@ -80,7 +89,12 @@ private void submitWork(@NonNull final Runnable work) {
     @NonNull
     @Override
     public <O> TaskSchedulerBuilder<O> schedulerBuilder(@NonNull final String name) {
-        return new DeterministicTaskSchedulerBuilder<>(metrics, this, name, this::submitWork);
+        final DeterministicTaskSchedulerBuilder<O> builder =
+                new DeterministicTaskSchedulerBuilder<>(metrics, this, name, this::submitWork);
+        if (taskSchedulerExceptionHandler != null) {
+            builder.withUncaughtExceptionHandler(taskSchedulerExceptionHandler);
+        }
+        return builder;
     }
 
     /**

platform-sdk/swirlds-component-framework/src/main/java/com/swirlds/component/framework/model/StandardWiringModel.java

@@ -19,6 +19,7 @@
 import com.swirlds.metrics.api.Metrics;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
+import java.lang.Thread.UncaughtExceptionHandler;
 import java.time.Duration;
 import java.time.Instant;
 import java.util.ArrayList;
@@ -84,6 +85,11 @@ public class StandardWiringModel extends TraceableWiringModel {
      */
     private final Duration healthyReportThreshold;
 
+    /**
+     * The (optional) global {@link UncaughtExceptionHandler} for the wiring framework
+     */
+    private final UncaughtExceptionHandler taskSchedulerExceptionHandler;
+
     /**
      * Constructor.
      *
@@ -119,6 +125,8 @@ public class StandardWiringModel extends TraceableWiringModel {
         } else {
             anchor = null;
         }
+
+        taskSchedulerExceptionHandler = builder.getTaskSchedulerExceptionHandler();
     }
 
     /**
@@ -128,7 +136,12 @@ public class StandardWiringModel extends TraceableWiringModel {
     @Override
     public final <O> TaskSchedulerBuilder<O> schedulerBuilder(@NonNull final String name) {
         throwIfStarted();
-        return new StandardTaskSchedulerBuilder<>(this.time, this.metrics, this, name, defaultPool);
+        final StandardTaskSchedulerBuilder<O> builder =
+                new StandardTaskSchedulerBuilder<>(this.time, this.metrics, this, name, defaultPool);
+        if (taskSchedulerExceptionHandler != null) {
+            builder.withUncaughtExceptionHandler(taskSchedulerExceptionHandler);
+        }
+        return builder;
     }
 
     /**

platform-sdk/swirlds-component-framework/src/main/java/com/swirlds/component/framework/model/WiringModelBuilder.java

@@ -4,6 +4,7 @@
 import com.swirlds.base.time.Time;
 import com.swirlds.metrics.api.Metrics;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.lang.Thread.UncaughtExceptionHandler;
 import java.time.Duration;
 import java.util.Objects;
 import java.util.concurrent.ForkJoinPool;
@@ -25,6 +26,7 @@ public class WiringModelBuilder {
     private final Metrics metrics;
     private final Time time;
     private Duration healthyReportThreshold = Duration.ofSeconds(1);
+    private UncaughtExceptionHandler taskSchedulerExceptionHandler = null;
 
     /**
      * Create a new builder.
@@ -174,6 +176,21 @@ public WiringModelBuilder withHealthyReportThreshold(@NonNull final Duration hea
         return this;
     }
 
+    /**
+     * Set the global {@link UncaughtExceptionHandler}. Default is {@code null}. Allows to set a global uncaught
+     * exception handler for all threads created by the wiring model. This is useful for tests and during development
+     * while in production the default handler should be used.
+     *
+     * @param taskSchedulerExceptionHandler the global uncaught exception handler
+     * @return this
+     */
+    @NonNull
+    public WiringModelBuilder withUncaughtExceptionHandler(
+            @NonNull final UncaughtExceptionHandler taskSchedulerExceptionHandler) {
+        this.taskSchedulerExceptionHandler = Objects.requireNonNull(taskSchedulerExceptionHandler);
+        return this;
+    }
+
     /**
      * Build the wiring model.
      *
@@ -184,7 +201,7 @@ public WiringModelBuilder withHealthyReportThreshold(@NonNull final Duration hea
     @NonNull
     public <T extends WiringModel> T build() {
         if (deterministicModeEnabled) {
-            return (T) new DeterministicWiringModel(metrics, time);
+            return (T) new DeterministicWiringModel(metrics, time, taskSchedulerExceptionHandler);
         } else {
             return (T) new StandardWiringModel(this);
         }
@@ -296,4 +313,14 @@ Time getTime() {
     Duration getHealthyReportThreshold() {
         return healthyReportThreshold;
     }
+
+    /**
+     * Get the global {@link UncaughtExceptionHandler}.
+     *
+     * @return the global {@code UncaughtExceptionHandler}
+     */
+    @NonNull
+    UncaughtExceptionHandler getTaskSchedulerExceptionHandler() {
+        return taskSchedulerExceptionHandler;
+    }
 }