Using a more descriptive error message when using VERY long wait conditions or poll durations (issue 290)

johanhaleby · johanhaleby · commit 5550079b8a45 · 2025-02-14T15:20:48.000+01:00
diff --git a/awaitility/src/main/java/org/awaitility/core/DurationFactory.java b/awaitility/src/main/java/org/awaitility/core/DurationFactory.java
@@ -49,6 +49,18 @@ public static Duration of(long amount, TimeUnit timeUnit) {
             default:
                 throw new IllegalStateException("Cannot convert " + TimeUnit.class.getSimpleName() + " to a " + ChronoUnit.class.getSimpleName());
         }
-        return Duration.of(amount, chronoUnit);
+
+        Duration duration = Duration.of(amount, chronoUnit);
+        checkThatDurationCanBeConvertedToNanos(duration, amount, timeUnit);
+        return duration;
+    }
+
+    @SuppressWarnings("ResultOfMethodCallIgnored")
+    private static void checkThatDurationCanBeConvertedToNanos(Duration timeout, long amount, TimeUnit timeUnit) {
+        try {
+            timeout.toNanos();
+        } catch (ArithmeticException e) {
+            throw new IllegalArgumentException(String.format("Cannot convert %s %s to nanoseconds, as required by Awaitility, because this value is too large", amount, timeUnit), e);
+        }
     }
 }
diff --git a/awaitility/src/test/java/org/awaitility/AwaitilityTest.java b/awaitility/src/test/java/org/awaitility/AwaitilityTest.java
@@ -503,6 +503,15 @@ public void awaitDuringTimeOnConditionMessingAtLeastAtMost() throws Exception {
         assertThat(duration.toMillis(), greaterThan(1000L));
     }
 
+    @Test
+    public void throwsIAEWhenTimeoutIsTooLargeForTheUnit() {
+        int timeoutMinutes = Integer.MAX_VALUE;
+        exception.expect(IllegalArgumentException.class);
+        exception.expectMessage("Cannot convert " + timeoutMinutes + " MINUTES to nanoseconds, as required by Awaitility, because this value is too large");
+
+        Awaitility.await().atMost(timeoutMinutes, TimeUnit.MINUTES).until(() -> true);
+    }
+
     private Callable<Boolean> fakeRepositoryValueEqualsOne() {
         return new FakeRepositoryEqualsOne(fakeRepository);
     }
diff --git a/changelog.txt b/changelog.txt
@@ -2,6 +2,7 @@ Changelog next version
 ----------------------
 * Support for kotlin.time.Duration in Kotlin DSL (thanks to Ivo Šmíd for PR)
 * Upgraded kotlin version in the awaitility-kotlin module to 2.1.10
+* Using a more descriptive error message when using VERY long wait conditions or poll durations (issue 290)
 
 Changelog 4.2.2 (2024-08-07)
 ----------------------------
