Fix cleanResponses must handle cleaning up cancelled future (#1218)

MauriceVanVeen · web-flow · commit 3198cba903cc · 2024-08-23T13:17:23.000-04:00
* Fix `cleanResponses` must handle cleaning up cancelled future

If a future would be cancelled outside of `cleanResponses`, calling `future.get()` would throw a `CancellationException`.

This exception was not caught, breaking future cleanup.

Signed-off-by: Maurice van Veen &lt;github@mauricevanveen.com&gt;

* Catch Throwable

Signed-off-by: Maurice van Veen &lt;github@mauricevanveen.com&gt;

---------

Signed-off-by: Maurice van Veen &lt;github@mauricevanveen.com&gt;
diff --git a/src/main/java/io/nats/client/impl/NatsConnection.java b/src/main/java/io/nats/client/impl/NatsConnection.java
@@ -1171,7 +1171,7 @@ else if (future.isDone()) {
                     wasInterrupted = true;
                     break;
                 }
-                catch (ExecutionException ignore) {}
+                catch (Throwable ignore) {}
             }
 
             if (remove) {
diff --git a/src/test/java/io/nats/client/impl/RequestTests.java b/src/test/java/io/nats/client/impl/RequestTests.java
@@ -739,4 +739,24 @@ public void testNatsImplAndEmptyStatsCoverage() {
         assertEquals(0, s.getDroppedCount());
         assertEquals(0, s.getReconnects());
     }
+
+    @Test
+    public void testCancelledFutureMustNotErrorOnCleanResponses() throws Exception {
+        try (NatsTestServer ts = new NatsTestServer(false)) {
+            Options options = Options.builder()
+                    .server(ts.getURI())
+                    .noNoResponders()
+                    .requestCleanupInterval(Duration.ofSeconds(10))
+                    .build();
+            NatsConnection nc = (NatsConnection) Nats.connect(options);
+
+            NatsRequestCompletableFuture future = (NatsRequestCompletableFuture) nc.request("request", null);
+            future.cancelClosing();
+
+            // Future is already cancelled, collecting it shouldn't result in an exception being thrown.
+            assertDoesNotThrow(() -> {
+                nc.cleanResponses(false);
+            });
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1171,7 +1171,7 @@ else if (future.isDone()) {`
`1171`	`1171`	`wasInterrupted = true;`
`1172`	`1172`	`break;`
`1173`	`1173`	`}`
`1174`		`- catch (ExecutionException ignore) {}`
	`1174`	`+ catch (Throwable ignore) {}`
`1175`	`1175`	`}`
`1176`	`1176`
`1177`	`1177`	`if (remove) {`