Merge pull request #47 from agorapulse/feature/default-executor

ability to set default executor

docs/guide/src/docs/asciidoc/usage.adoc

@@ -210,6 +210,16 @@ You can set the default queue type using the `worker.queue-type` configuration p
 include::{root-dir}/libs/micronaut-worker/src/test/resources/application-local.yml[]
 ----
 
+You can override the default scheduler (`TaskExecutors.SCHEDULED`) by setting the `worker.scheduler` property.
+
+[source,yaml]
+.Setting the Default Scheduler
+----
+include::{root-dir}/libs/micronaut-worker/src/test/resources/application-virtual.yml[]
+----
+
+TIP: You can let your jobs executed using virtual threads by using `virtual` executor.
+
 === Job Configuration
 
 Anything you can configure using annotations can be configured externally.

libs/micronaut-worker/src/main/java/com/agorapulse/worker/WorkerConfiguration.java

@@ -17,8 +17,12 @@
  */
 package com.agorapulse.worker;
 
+import io.micronaut.scheduling.TaskExecutors;
+
 public interface WorkerConfiguration {
 
+    String DEFAULT_SCHEDULER = TaskExecutors.SCHEDULED;
+
     WorkerConfiguration ENABLED = new WorkerConfiguration() {
         @Override
         public boolean isEnabled() {
@@ -30,6 +34,11 @@ public String getQueueType() {
             return null;
         }
 
+        @Override
+        public String getScheduler() {
+            return DEFAULT_SCHEDULER;
+        }
+
     };
 
     boolean isEnabled();
@@ -39,4 +48,6 @@ public String getQueueType() {
      */
     String getQueueType();
 
+    String getScheduler();
+
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/annotation/Cron.java

@@ -17,8 +17,8 @@
  */
 package com.agorapulse.worker.annotation;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import io.micronaut.context.annotation.AliasFor;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -49,6 +49,6 @@
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
     @AliasFor(annotation = Job.class, member = "scheduler")
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/annotation/FixedDelay.java

@@ -17,8 +17,8 @@
  */
 package com.agorapulse.worker.annotation;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import io.micronaut.context.annotation.AliasFor;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -49,6 +49,6 @@
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
     @AliasFor(annotation = Job.class, member = "scheduler")
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default  WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/annotation/FixedRate.java

@@ -17,8 +17,8 @@
  */
 package com.agorapulse.worker.annotation;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import io.micronaut.context.annotation.AliasFor;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -49,6 +49,6 @@
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
     @AliasFor(annotation = Job.class, member = "scheduler")
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default  WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/annotation/InitialDelay.java

@@ -17,8 +17,8 @@
  */
 package com.agorapulse.worker.annotation;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import io.micronaut.context.annotation.AliasFor;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -49,6 +49,6 @@
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
     @AliasFor(annotation = Job.class, member = "scheduler")
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default  WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/annotation/Job.java

@@ -17,11 +17,11 @@
  */
 package com.agorapulse.worker.annotation;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import io.micronaut.context.annotation.AliasFor;
 import io.micronaut.context.annotation.Executable;
 import io.micronaut.context.annotation.Parallel;
 import io.micronaut.core.annotation.EntryPoint;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -45,7 +45,7 @@
     /**
      * Allows to override the default name of the job which is <code>JobClassName</code> if there is only one executable
      * method (e.g. job definition) in the class or <code>JobClassName-methodName</code> if there is more then one executable method in the class.
-     *
+     * <p>
      * Either the job name specified here or the default name is converted using {@link io.micronaut.core.naming.NameUtils#hyphenate(String)}.
      *
      * @return the name of the job used for configuration
@@ -86,6 +86,6 @@
      * @return The name of a {@link jakarta.inject.Named} bean that is a
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/configuration/DefaultJobConfiguration.java

@@ -26,7 +26,6 @@
 import io.micronaut.context.annotation.EachProperty;
 import io.micronaut.context.annotation.Parameter;
 import io.micronaut.core.util.StringUtils;
-import io.micronaut.scheduling.TaskExecutors;
 
 import jakarta.annotation.Nullable;
 import jakarta.validation.constraints.Min;
@@ -133,7 +132,7 @@ public void mergeWith(ConsumerQueueConfiguration overrides) {
     @Nullable private Duration fixedDelay;
     @Nullable private Duration initialDelay;
     @Nullable private Duration fixedRate;
-    @NotBlank private String scheduler = TaskExecutors.SCHEDULED;
+    @NotBlank private String scheduler;
 
     @Positive private int fork = 1;
 
@@ -147,6 +146,7 @@ public DefaultJobConfiguration(@Parameter String name, WorkerConfiguration worke
         this.enabled = workerConfiguration.isEnabled();
         this.consumer.setQueueType(workerConfiguration.getQueueType());
         this.producer.setQueueType(workerConfiguration.getQueueType());
+        this.scheduler = workerConfiguration.getScheduler();
         this.name = name;
     }
 
@@ -324,7 +324,7 @@ public JobConfiguration mergeWith(JobConfiguration overrides) {
             this.initialDelay = overrides.getInitialDelay();
         }
 
-        if (overrides.getScheduler() != null && !overrides.getScheduler().equals(TaskExecutors.SCHEDULED)) {
+        if (overrides.getScheduler() != null && !overrides.getScheduler().equals(WorkerConfiguration.DEFAULT_SCHEDULER)) {
             this.scheduler = overrides.getScheduler();
         }
 

libs/micronaut-worker/src/main/java/com/agorapulse/worker/configuration/DefaultWorkerConfiguration.java

@@ -26,6 +26,7 @@ public class DefaultWorkerConfiguration implements WorkerConfiguration {
 
     private boolean enabled;
     private String queueType;
+    private String scheduler = WorkerConfiguration.DEFAULT_SCHEDULER;
 
     public DefaultWorkerConfiguration(Environment env) {
         // disable for tests and functions
@@ -51,4 +52,14 @@ public String getQueueType() {
     public void setQueueType(String queueType) {
         this.queueType = queueType;
     }
+
+    @Override
+    public String getScheduler() {
+        return scheduler;
+    }
+
+    public void setScheduler(String scheduler) {
+        this.scheduler = scheduler;
+    }
+
 }

libs/micronaut-worker/src/main/java/com/agorapulse/worker/convention/QueueProducer.java

@@ -17,10 +17,10 @@
  */
 package com.agorapulse.worker.convention;
 
+import com.agorapulse.worker.WorkerConfiguration;
 import com.agorapulse.worker.annotation.Job;
 import com.agorapulse.worker.annotation.Produces;
 import io.micronaut.context.annotation.AliasFor;
-import io.micronaut.scheduling.TaskExecutors;
 import jakarta.inject.Named;
 
 import java.lang.annotation.Documented;
@@ -46,7 +46,7 @@
     /**
      * Allows to override the default name of the job which is <code>JobClassName</code> if there is only one executable
      * method (e.g. job definition) in the class or <code>JobClassName-methodName</code> if there is more then one executable method in the class.
-     *
+     * <p>
      * Either the job name specified here or the default name is converted using {@link io.micronaut.core.naming.NameUtils#hyphenate(String)}.
      *
      * @return the name of the job used for configuration
@@ -98,6 +98,6 @@
      * {@link java.util.concurrent.ScheduledExecutorService} to use to schedule the task
      */
     @AliasFor(annotation = Job.class, member = "scheduler")
-    String scheduler() default TaskExecutors.SCHEDULED;
+    String scheduler() default WorkerConfiguration.DEFAULT_SCHEDULER;
 
 }

libs/micronaut-worker/src/test/resources/application-virtual.yml

@@ -0,0 +1,2 @@
+worker:
+  scheduler: virtual