Refactor Task to ValueTask (#988) (#1964)

Co-authored-by: Marko Lahma <marko.lahma@gmail.com>

changelog.md

@@ -65,7 +65,8 @@
 
   * IJobExecutionContext.RecoveringTriggerKey now returns null if IJobExecutionContext.Recovering is false instead of throwing exception.
 
-### NEW FEATURES
+  * `Task` return types and parameters have been changed to `ValueTask`.  Any consumers of Quartz expecting a `Task` will require to update the signatures to `ValueTask`,
+     or use the `AsTask()` Method on ValueTask to Return the `ValueTask` as a `Task`  (#988)
 
 #### Cron Parser
 

src/Directory.Build.props

@@ -52,7 +52,6 @@
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'net472' ">
     <DefineConstants>$(DefineConstants);REMOTING</DefineConstants>
-    <FullFramework>true</FullFramework>
   </PropertyGroup>
 
   <PropertyGroup>

src/Directory.Packages.props

@@ -7,6 +7,7 @@
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="2.1.1" />
     <PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="2.1.1" />
     <PackageVersion Include="Microsoft.Extensions.Options" Version="2.1.1" />
+    <PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.5.4" />
   </ItemGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
     <PackageVersion Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="6.0.0" />

src/Quartz.AspNetCore/AspNetCore/HttpApi/Endpoints/CalendarEndpoints.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
@@ -65,7 +65,7 @@ private static Task<IResult> AddCalendar(
         endpointHelper.AssertIsValid(request);
         return endpointHelper.ExecuteWithOkResponse(
             schedulerName,
-            scheduler => scheduler.AddCalendar(request.CalendarName, request.Calendar, request.Replace, request.UpdateTriggers, cancellationToken)
+            scheduler => scheduler.AddCalendar(request.CalendarName, request.Calendar, request.Replace, request.UpdateTriggers, cancellationToken).AsTask()
         );
     }
 

src/Quartz.AspNetCore/AspNetCore/HttpApi/Endpoints/JobEndpoints.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
@@ -155,7 +155,7 @@ private static Task<IResult> PauseJob(
         string jobName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseJob(new JobKey(jobName, jobGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseJob(new JobKey(jobName, jobGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -183,7 +183,7 @@ private static Task<IResult> ResumeJob(
         string jobName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeJob(new JobKey(jobName, jobGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeJob(new JobKey(jobName, jobGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -214,10 +214,10 @@ private static Task<IResult> TriggerJob(
     {
         if (request?.JobData != null)
         {
-            return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.TriggerJob(new JobKey(jobName, jobGroup), request.JobData, cancellationToken));
+            return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.TriggerJob(new JobKey(jobName, jobGroup), request.JobData, cancellationToken).AsTask());
         }
 
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.TriggerJob(new JobKey(jobName, jobGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.TriggerJob(new JobKey(jobName, jobGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(typeof(InterruptResponse), StatusCodes.Status200OK)]

src/Quartz.AspNetCore/AspNetCore/HttpApi/Endpoints/SchedulerEndpoints.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
@@ -92,10 +92,10 @@ private static Task<IResult> Start(
         {
             if (delayMilliseconds.HasValue)
             {
-                return scheduler.StartDelayed(TimeSpan.FromMilliseconds(delayMilliseconds.Value), cancellationToken);
+                return scheduler.StartDelayed(TimeSpan.FromMilliseconds(delayMilliseconds.Value), cancellationToken).AsTask();
             }
 
-            return scheduler.Start(cancellationToken);
+            return scheduler.Start(cancellationToken).AsTask();
         });
     }
 
@@ -105,7 +105,7 @@ private static Task<IResult> Standby(
         string schedulerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Standby(cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Standby(cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -115,7 +115,7 @@ private static Task<IResult> Shutdown(
         bool waitForJobsToComplete = false,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Shutdown(waitForJobsToComplete, cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Shutdown(waitForJobsToComplete, cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -124,7 +124,7 @@ private static Task<IResult> Clear(
         string schedulerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Clear(cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.Clear(cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -133,7 +133,7 @@ private static Task<IResult> PauseAll(
         string schedulerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseAll(cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseAll(cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -142,6 +142,6 @@ private static Task<IResult> ResumeAll(
         string schedulerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeAll(cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeAll(cancellationToken).AsTask());
     }
 }

src/Quartz.AspNetCore/AspNetCore/HttpApi/Endpoints/TriggerEndpoints.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
@@ -139,7 +139,7 @@ private static Task<IResult> ResetTriggerFromErrorState(
         string triggerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResetTriggerFromErrorState(new TriggerKey(triggerName, triggerGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResetTriggerFromErrorState(new TriggerKey(triggerName, triggerGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -150,7 +150,7 @@ private static Task<IResult> PauseTrigger(
         string triggerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseTrigger(new TriggerKey(triggerName, triggerGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.PauseTrigger(new TriggerKey(triggerName, triggerGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]
@@ -178,7 +178,7 @@ private static Task<IResult> ResumeTrigger(
         string triggerName,
         CancellationToken cancellationToken = default)
     {
-        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeTrigger(new TriggerKey(triggerName, triggerGroup), cancellationToken));
+        return endpointHelper.ExecuteWithOkResponse(schedulerName, scheduler => scheduler.ResumeTrigger(new TriggerKey(triggerName, triggerGroup), cancellationToken).AsTask());
     }
 
     [ProducesResponseType(StatusCodes.Status200OK)]

src/Quartz.AspNetCore/AspNetCore/HttpApi/Util/EndpointHelper.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http;
 
 using Quartz.HttpApiContract;
 using Quartz.Impl;

src/Quartz.Benchmark/DefaultThreadPoolBenchmark.cs

@@ -70,10 +70,10 @@ public void RunInThread_CompletedTask_MaxConcurrencyIsSixteen_MultiThreaded()
         }
 
         /// <summary>
-        /// The primary goal of this benchamrk is to measure memory allocations.
+        /// The primary goal of this benchmark is to measure memory allocations.
         /// </summary>
         /// <remarks>
-        /// Note that this includes the allocations for initializing the threadpool itself.
+        /// Note that this includes the allocations for initializing the ThreadPool itself.
         /// </remarks>
         [Benchmark]
         public void RunInThread_OneShot()

src/Quartz.Benchmark/ExecutingJobsManagerBenchmark.cs

@@ -46,28 +46,28 @@ internal sealed class ExecutingJobsManagerLegacy : IJobListener
 
             private int numJobsFired;
 
-            public Task JobToBeExecuted(
+            public ValueTask JobToBeExecuted(
                 IJobExecutionContext context,
                 CancellationToken cancellationToken = default)
             {
                 Interlocked.Increment(ref numJobsFired);
                 executingJobs[((IOperableTrigger)context.Trigger).FireInstanceId] = context;
-                return Task.CompletedTask;
+                return default;
             }
 
-            public Task JobWasExecuted(IJobExecutionContext context,
+            public ValueTask JobWasExecuted(IJobExecutionContext context,
                 JobExecutionException? jobException,
                 CancellationToken cancellationToken = default)
             {
                 executingJobs.TryRemove(((IOperableTrigger)context.Trigger).FireInstanceId, out _);
-                return Task.CompletedTask;
+                return default;
             }
 
-            public Task JobExecutionVetoed(
+            public ValueTask JobExecutionVetoed(
                 IJobExecutionContext context,
                 CancellationToken cancellationToken = default)
             {
-                return Task.CompletedTask;
+                return default;
             }
         }
     }