Allow ScheduledTask.cancel() without actually being started

Allow ScheduledTask.cancel() without actually being started

Author: rbygrave

.github/workflows/build.yml

@@ -17,14 +17,14 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Java
       uses: actions/setup-java@v2
       with:
         java-version: ${{ matrix.java_version }}
         distribution: 'zulu'
     - name: Maven cache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       env:
         cache-name: maven-cache
       with:

metrics/src/main/java/io/avaje/metrics/DScheduledTask.java

@@ -65,6 +65,9 @@ public void start() {
 
   @Override
   public boolean cancel(boolean mayInterruptIfRunning) {
+    if (backgroundTask == null) {
+      return false;
+    }
     return this.backgroundTask.cancel(mayInterruptIfRunning);
   }
 

metrics/src/main/java/io/avaje/metrics/ScheduledTask.java

@@ -25,6 +25,7 @@ static Builder builder() {
 
   /**
    * Cancel the scheduled task.
+   * @return true if the task was cancelled otherwise false
    */
   boolean cancel(boolean mayInterruptIfRunning);
 

metrics/src/test/java/io/avaje/metrics/ScheduledTaskTest.java

@@ -9,6 +9,26 @@
 
 class ScheduledTaskTest {
 
+  @Test
+  void stopWithoutStart() {
+    ScheduledTask task = ScheduledTask.builder()
+      .schedule(1, 1, TimeUnit.MILLISECONDS)
+      .task(ScheduledTaskTest::hello)
+      .build();
+
+    task.cancel(true);
+  }
+
+  @Test
+  void waitWithoutStart() {
+    ScheduledTask task = ScheduledTask.builder()
+      .schedule(1, 1, TimeUnit.MILLISECONDS)
+      .task(ScheduledTaskTest::hello)
+      .build();
+
+    task.waitIfRunning(10, TimeUnit.SECONDS);
+  }
+
   @Test
   void runIt() throws InterruptedException {