Merge pull request #1 from skiptirengu/develop

Allow customization to the scheduler instance

Author: Thiago

README.md

@@ -6,16 +6,24 @@ Easily integrate .NET Core's Host with Quartz
 
 ## Usage
 
-To enable the Quartz integration, simply call the extension method `UseQuartz()` on your HostBuilder.
+Check out the [working example](./examples).
+
+To enable the Quartz integration, simply call one of the three `UseQuartz()` extension methods on your HostBuilder.
 
 ```c#
-new HostBuilder().UseQuartz((context, config) =>
+new HostBuilder().UseQuartz((context, provider, scheduler) =>
 {
-    config.Set("quartz.threadPool.threadCount", "2");
+    // You can further configure the scheduler instance here, like 
+    // add job listeners, trigger listeners, etc.
+    // DO NOT call the Start method here as it will be automatically
+    // invoked by the hosted service once it has started.
+    scheduler.ListenerManager.AddJobListener(
+      new JobChainingJobListener("TestListener"), KeyMatcher<JobKey>.KeyEquals(new JobKey("DummyJob"))
+    );
 })
 ```
 
-The callback is opitional and can be used to customize Quartz default options. You can also set the options in your `appsettings.json` file.
+To change Quartz options, add a section to your `appsettings.json` file, or use the `UserQuartz()` method.
 
 ```json
 {
@@ -29,7 +37,16 @@ The callback is opitional and can be used to customize Quartz default options. Y
 }
 ```
 
-To schedule a new job, call the extension method `AddJobService()` from an `IServiceCollection` instance.
+or
+
+```c#
+new HostBuilder().UseQuartz((context, config) =>
+{
+    config.Set("quartz.threadPool.threadCount", "2");
+})
+```
+
+To schedule a new job, call the extension method `AddJobService()` on a `IServiceCollection` instance.
 
 ```c#
 new HostBuilder().ConfigureServices((services) =>

examples/Program.cs

@@ -28,10 +28,23 @@ public static async Task Main(string[] args)
                         trigger.StartNow().WithSimpleSchedule((x) => x.WithIntervalInSeconds(2).RepeatForever());
                     });
                 })
-                .UseQuartz((context, config) =>
-                {
-                    config.Set("quartz.threadPool.threadCount", Environment.ProcessorCount.ToString());
-                })
+                // You can use the other `UserQuartz` 2 methods
+                // if you only want to configure either the scheduler factory
+                // or the scheduler instance
+                .UseQuartz(
+                    (context, config) =>
+                    {
+                        // Here you can further customize options passed down to the StdSchedulerFactory
+                        config.Set("quartz.threadPool.threadCount", Environment.ProcessorCount.ToString());
+                    },
+                    (context, provider, scheduler) =>
+                    {
+                        // You can further configure the scheduler instance here, like 
+                        // add job listeners, trigger listeners, etc.
+                        // DO NOT call the Start method here as it will be automatically
+                        // invoked by the hosted service once it is started.
+                    }
+                )
                 .UseConsoleLifetime()
                 .UseSerilog()
                 .Build();

src/HostBuilderExtensions.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Quartz;
 using Quartz.Impl;
 using Quartz.Spi;
 using System;
@@ -15,7 +16,37 @@ public static class HostBuilderExtensions
         /// <param name="builder">The NET Core HostBuilder</param>
         /// <param name="configure">A function that will receive the HostBuilderContext and the StdSchedulerFactory config collection</param>
         /// <returns>The HostBuilder itselft</returns>
-        public static IHostBuilder UseQuartz(this IHostBuilder builder, Action<HostBuilderContext, QuartzConfigCollection> configure = null)
+        public static IHostBuilder UseQuartz(
+            this IHostBuilder builder,
+            Action<HostBuilderContext, QuartzConfigCollection> configure = null)
+        {
+            return UseQuartz(builder, configure);
+        }
+
+        /// <summary>
+        /// Registers the Scheduler, JobFactory, QuartzConfigCollection and the QuartzHostedService on the service collection
+        /// </summary>
+        /// <param name="builder">The NET Core HostBuilder</param>
+        /// <param name="configure">A function that will receive the HostBuilderContext, the ServiceProvider and the IScheduler instance</param>
+        /// <returns>The HostBuilder itselft</returns>
+        public static IHostBuilder UseQuartz(
+            this IHostBuilder builder,
+            Action<HostBuilderContext, IServiceProvider, IScheduler> configure)
+        {
+            return UseQuartz(builder, null, configure);
+        }
+
+        /// <summary>
+        /// Registers the Scheduler, JobFactory, QuartzConfigCollection and the QuartzHostedService on the service collection
+        /// </summary>
+        /// <param name="builder">The NET Core HostBuilder</param>
+        /// <param name="configureFactory">A function that will receive the HostBuilderContext and the StdSchedulerFactory config collection</param>
+        /// <param name="configureScheduler">A function that will receive the HostBuilderContext, the ServiceProvider and the IScheduler instance</param>
+        /// <returns>The HostBuilder itselft</returns>
+        public static IHostBuilder UseQuartz(
+            this IHostBuilder builder,
+            Action<HostBuilderContext, QuartzConfigCollection> configureFactory = null,
+            Action<HostBuilderContext, IServiceProvider, IScheduler> configureScheduler = null)
         {
             builder.ConfigureServices((context, collection) =>
             {
@@ -26,11 +57,11 @@ public static IHostBuilder UseQuartz(this IHostBuilder builder, Action<HostBuild
                 collection.AddSingleton<IJobFactory, JobFactory>();
                 collection.AddSingleton((provider) =>
                 {
-                    configure?.Invoke(context, config);
+                    configureFactory?.Invoke(context, config);
                     var factory = new StdSchedulerFactory(config);
-
                     var scheduler = factory.GetScheduler().Result;
                     scheduler.JobFactory = provider.GetRequiredService<IJobFactory>();
+                    configureScheduler?.Invoke(context, provider, scheduler);
                     return scheduler;
                 });
             });

tests/QuartzTest.cs

@@ -2,6 +2,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Quartz;
+using Quartz.Impl.Matchers;
+using Quartz.Listener;
 using Quartz.Spi;
 using System.Collections.Generic;
 using System.Linq;
@@ -22,13 +24,22 @@ public void HostBuilderExtension()
 
             var host = new HostBuilder()
                 .ConfigureAppConfiguration(x => x.AddInMemoryCollection(dictionary))
-                .UseQuartz((ctx, c) => c.Set("quartz.threadPool.threadCount", "4"))
+                .UseQuartz(
+                    (ctx, c) =>
+                    {
+                        c.Set("quartz.threadPool.threadCount", "4");
+                    },
+                    (context, provider, sched) =>
+                    {
+                        sched.ListenerManager.AddJobListener(new JobChainingJobListener("TestListener"), KeyMatcher<JobKey>.KeyEquals(new JobKey("DummyJob")));
+                    }
+                )
                 .ConfigureServices((context, services) =>
                 {
                     services
                         .AddJobService<IDummyJob, DummyJob>((job, trigger) =>
                         {
-                            job.WithDescription("IDummyJob_Job");
+                            job.WithIdentity("DummyJob").WithDescription("IDummyJob_Job");
                             trigger.WithDescription("IDummyJob_Trigger");
                         })
                         .AddJobService<EvenDummierJob>((job, trigger) =>
@@ -58,6 +69,10 @@ public void HostBuilderExtension()
             Assert.True(jobs[1].JobDetail.JobType.IsAssignableFrom(typeof(EvenDummierJob)));
             Assert.Equal("EvenDummierJob_Job", jobs[1].JobDetail.Description);
             Assert.Equal("EvenDummierJob_Trigger", jobs[1].Trigger.Description);
+
+            var matchers = scheduler.ListenerManager.GetJobListeners();
+            Assert.Single(matchers);
+            Assert.Equal("TestListener", matchers.First().Name);
         }
     }
 }