feat: Conditionally execute jobs

Author: linkdotnet

Directory.Packages.props

@@ -30,7 +30,7 @@
     <PackageVersion Include="Blazorise.Markdown" Version="[1.8.1]" />
     <PackageVersion Include="Markdig" Version="0.44.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="10.0.1" />
-    <PackageVersion Include="NCronJob" Version="4.7.0" />
+    <PackageVersion Include="NCronJob" Version="4.9.0" />
     <PackageVersion Include="LinkDotNet.BuildInformation" Version="2.1.2" />
     <PackageVersion Include="ReverseMarkdown" Version="4.7.1" />
     <PackageVersion Include="System.ServiceModel.Syndication" Version="10.0.1" />
@@ -60,4 +60,4 @@
     <PackageVersion Include="Microsoft.Playwright" Version="1.57.0" />
     <PackageVersion Include="Spectre.Console" Version="0.54.0" />
   </ItemGroup>
-</Project>
+</Project>

src/LinkDotNet.Blog.Web/Features/SimilarBlogPostJob.cs

@@ -15,29 +15,19 @@ public class SimilarBlogPostJob : IJob
 {
     private readonly IRepository<BlogPost> blogPostRepository;
     private readonly IRepository<SimilarBlogPost> similarBlogPostRepository;
-    private readonly bool showSimilarPosts;
 
     public SimilarBlogPostJob(
         IRepository<BlogPost> blogPostRepository,
-        IRepository<SimilarBlogPost> similarBlogPostRepository,
-        IOptions<ApplicationConfiguration> applicationConfiguration)
+        IRepository<SimilarBlogPost> similarBlogPostRepository)
     {
-        ArgumentNullException.ThrowIfNull(applicationConfiguration);
-
         this.blogPostRepository = blogPostRepository;
         this.similarBlogPostRepository = similarBlogPostRepository;
-        showSimilarPosts = applicationConfiguration.Value.ShowSimilarPosts;
     }
 
     public async Task RunAsync(IJobExecutionContext context, CancellationToken token)
     {
         ArgumentNullException.ThrowIfNull(context);
 
-        if (!showSimilarPosts)
-        {
-            return;
-        }
-
         var isInstantJobTriggered = context.Parameter is not null;
         var noJobPublished = context.ParentOutput is null or 0;
         if (noJobPublished && !isInstantJobTriggered)

src/LinkDotNet.Blog.Web/RegistrationExtensions/BackgroundServiceRegistrationExtensions.cs

@@ -2,6 +2,7 @@
 using NCronJob;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Options;
 
 namespace LinkDotNet.Blog.Web.RegistrationExtensions;
 
@@ -19,10 +20,13 @@ public static void AddBackgroundServices(this IServiceCollection services)
         {
             options
                 .AddJob<BlogPostPublisher>(p => p.WithCronExpression("* * * * *"))
-                .ExecuteWhen(s => s.RunJob<SimilarBlogPostJob>());
+                .ExecuteWhen(s => s.RunJob<SimilarBlogPostJob>()
+                    .OnlyIf((IOptions<ApplicationConfiguration> applicationConfiguration) => applicationConfiguration.Value.ShowSimilarPosts));
 
             options.AddJob<TransformBlogPostRecordsJob>(p => p.WithCronExpression("0/10 * * * *"));
-            options.AddJob<SimilarBlogPostJob>();
+            options.AddJob<SimilarBlogPostJob>(c => c
+                .WithName(nameof(SimilarBlogPostJob))
+                .OnlyIf((IOptions<ApplicationConfiguration> applicationConfiguration) => applicationConfiguration.Value.ShowSimilarPosts));
         });
     }
 }

tests/LinkDotNet.Blog.IntegrationTests/Web/Features/SimilarBlogPostJobTests.cs

@@ -29,9 +29,8 @@ public async Task ShouldCalculateSimilarBlogPosts()
         await Repository.StoreAsync(blogPost1);
         await Repository.StoreAsync(blogPost2);
         await Repository.StoreAsync(blogPost3);
-        var config = Options.Create(new ApplicationConfigurationBuilder().WithShowSimilarPosts(true).Build());
 
-        var job = new SimilarBlogPostJob(Repository, similarBlogPostRepository, config);
+        var job = new SimilarBlogPostJob(Repository, similarBlogPostRepository);
         var context = Substitute.For<IJobExecutionContext>();
         context.Parameter.Returns(true);
         await job.RunAsync(context, CancellationToken.None);
@@ -40,26 +39,6 @@ public async Task ShouldCalculateSimilarBlogPosts()
         similarBlogPosts.Count.ShouldBe(3);
     }
 
-    [Fact]
-    public async Task ShouldNotCalculateWhenDisabledInApplicationConfiguration()
-    {
-        var blogPost1 = new BlogPostBuilder().WithTitle("Title 1").Build();
-        var blogPost2 = new BlogPostBuilder().WithTitle("Title 2").Build();
-        var blogPost3 = new BlogPostBuilder().WithTitle("Title 3").Build();
-        await Repository.StoreAsync(blogPost1);
-        await Repository.StoreAsync(blogPost2);
-        await Repository.StoreAsync(blogPost3);
-        var config = Options.Create(new ApplicationConfigurationBuilder().WithShowSimilarPosts(false).Build());
-        
-        var job = new SimilarBlogPostJob(Repository, similarBlogPostRepository, config);
-        var context = Substitute.For<IJobExecutionContext>();
-        context.Parameter.Returns(true);
-        await job.RunAsync(context, CancellationToken.None);
-        
-        var similarBlogPosts = await similarBlogPostRepository.GetAllAsync();
-        similarBlogPosts.ShouldBeEmpty();
-    }
-    
     [Fact]
     public async Task ShouldNotCalculateWhenNotTriggeredAsInstantJob()
     {
@@ -69,9 +48,8 @@ public async Task ShouldNotCalculateWhenNotTriggeredAsInstantJob()
         await Repository.StoreAsync(blogPost1);
         await Repository.StoreAsync(blogPost2);
         await Repository.StoreAsync(blogPost3);
-        var config = Options.Create(new ApplicationConfigurationBuilder().WithShowSimilarPosts(true).Build());
 
-        var job = new SimilarBlogPostJob(Repository, similarBlogPostRepository, config);
+        var job = new SimilarBlogPostJob(Repository, similarBlogPostRepository);
         await job.RunAsync(Substitute.For<IJobExecutionContext>(), CancellationToken.None);
 
         var similarBlogPosts = await similarBlogPostRepository.GetAllAsync();