quartz: allow to clear all job data/trigger on startup

jknack · jknack · commit 728976d338f8 · 2023-08-27T11:42:36.000-03:00
- Added cleanJobs and cleanStaleJobs flags to QuartzModule - Fix #3100
diff --git a/modules/jooby-quartz/src/main/java/io/jooby/internal/quartz/JobFactoryImpl.java b/modules/jooby-quartz/src/main/java/io/jooby/internal/quartz/JobFactoryImpl.java
@@ -16,7 +16,7 @@
 public class JobFactoryImpl implements JobFactory {
   private final JobFactory next;
 
-  private Registry registry;
+  private final Registry registry;
 
   public JobFactoryImpl(Registry registry, JobFactory next) {
     this.registry = registry;
@@ -34,6 +34,6 @@ public Job newJob(TriggerFiredBundle bundle, Scheduler scheduler) {
 
   @Override
   public String toString() {
-    return getClass().getName();
+    return "JobFactory for " + registry.toString();
   }
 }
diff --git a/modules/jooby-quartz/src/main/java/io/jooby/quartz/QuartzApp.java b/modules/jooby-quartz/src/main/java/io/jooby/quartz/QuartzApp.java
@@ -35,7 +35,6 @@
 import io.jooby.Jooby;
 import io.jooby.Route;
 import io.jooby.SneakyThrows;
-import io.jooby.StatusCode;
 import io.jooby.internal.quartz.JobGenerator;
 
 /**
@@ -133,10 +132,10 @@ public class QuartzApp extends Jooby {
     delete(
         "/{group}/{name}",
         ctx -> {
-          Scheduler scheduler = getScheduler();
-          JobKey jobKey = jobKey(ctx);
-          scheduler.deleteJob(jobKey);
-          return ctx.send(StatusCode.NO_CONTENT);
+          var scheduler = getScheduler();
+          var jobKey = jobKey(ctx);
+          var deleted = scheduler.deleteJob(jobKey);
+          return Map.of("key", jobKey.toString(), "deleted", deleted);
         });
   }
 
diff --git a/modules/jooby-quartz/src/main/java/io/jooby/quartz/QuartzModule.java b/modules/jooby-quartz/src/main/java/io/jooby/quartz/QuartzModule.java
@@ -105,6 +105,8 @@ public class QuartzModule implements Extension {
 
   private List<Class<?>> jobs;
   private Scheduler scheduler;
+  private Boolean cleanStaleJobs;
+  private boolean cleanJobs;
 
   /**
    * Creates Quartz module and register the given jobs.
@@ -148,13 +150,37 @@ public QuartzModule(@NonNull Scheduler scheduler, final List<Class<?>> jobs) {
     this.jobs = jobs;
   }
 
+  /**
+   * Lookup for existing (persisted) jobs and compare with the job list from {@link
+   * #QuartzModule(Class[])}. Delete any persisted job that is not in the list.
+   *
+   * @param cleanStaleJobs True to clear/delete stale job and triggers.
+   * @return This module.
+   */
+  public QuartzModule cleanStaleJobs(boolean cleanStaleJobs) {
+    this.cleanStaleJobs = cleanStaleJobs;
+    return this;
+  }
+
+  /**
+   * Safely clear/delete all jobs before schedule startup. Use with caution.
+   *
+   * @param cleanJobs True to clear/delete all jobs and triggers.
+   * @return This module.
+   */
+  public QuartzModule cleanJobs(boolean cleanJobs) {
+    this.cleanJobs = cleanJobs;
+    return this;
+  }
+
   @Override
   public void install(@NonNull Jooby application) throws Exception {
     Config config = application.getConfig();
     Map<JobDetail, Trigger> jobMap = JobGenerator.build(application, jobs);
 
     Properties properties = properties(config);
 
+    this.cleanStaleJobs = computeCleanStaleJobs(this.scheduler == null);
     Scheduler scheduler = this.scheduler == null ? newScheduler(application) : this.scheduler;
     var context = scheduler.getContext();
     context.put("registry", application);
@@ -167,7 +193,18 @@ public void install(@NonNull Jooby application) throws Exception {
     }
     application.onStarted(
         () -> {
-          cleanStaleJobs(application.getLog(), scheduler, jobs);
+          if (scheduler.isStarted()) {
+            scheduler.standby();
+          }
+
+          if (this.cleanJobs) {
+            // clear all jobs
+            scheduler.clear();
+          } else {
+            if (this.cleanStaleJobs) {
+              cleanStaleJobs(application.getLog(), scheduler, jobs);
+            }
+          }
 
           for (Map.Entry<JobDetail, Trigger> e : jobMap.entrySet()) {
             JobDetail jobDetail = e.getKey();
@@ -202,6 +239,10 @@ public void install(@NonNull Jooby application) throws Exception {
     application.onStop(() -> scheduler.shutdown(waitForJobsToComplete));
   }
 
+  private boolean computeCleanStaleJobs(boolean defaults) {
+    return this.cleanStaleJobs == null ? defaults : this.cleanStaleJobs.booleanValue();
+  }
+
   /**
    * Cleanup any job that was persisted in previous execution and was removed from job list.
    *

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`public class JobFactoryImpl implements JobFactory {`
`17`	`17`	`private final JobFactory next;`
`18`	`18`
`19`		`- private Registry registry;`
	`19`	`+ private final Registry registry;`
`20`	`20`
`21`	`21`	`public JobFactoryImpl(Registry registry, JobFactory next) {`
`22`	`22`	`this.registry = registry;`
`@@ -34,6 +34,6 @@ public Job newJob(TriggerFiredBundle bundle, Scheduler scheduler) {`
`34`	`34`
`35`	`35`	`@Override`
`36`	`36`	`public String toString() {`
`37`		`- return getClass().getName();`
	`37`	`+ return "JobFactory for " + registry.toString();`
`38`	`38`	`}`
`39`	`39`	`}`