Workflow trimming (pruning) improvements

src/OrchardCore.Modules/OrchardCore.Workflows/Startup.cs

@@ -1,7 +1,6 @@
 using Fluid;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
-using OrchardCore.BackgroundTasks;
 using OrchardCore.Data;
 using OrchardCore.Data.Migration;
 using OrchardCore.Deployment;
@@ -13,7 +12,6 @@
 using OrchardCore.Recipes;
 using OrchardCore.ResourceManagement;
 using OrchardCore.Security.Permissions;
-using OrchardCore.Settings;
 using OrchardCore.Workflows.Activities;
 using OrchardCore.Workflows.Deployment;
 using OrchardCore.Workflows.Drivers;
@@ -26,9 +24,6 @@
 using OrchardCore.Workflows.Models;
 using OrchardCore.Workflows.Recipes;
 using OrchardCore.Workflows.Services;
-using OrchardCore.Workflows.Trimming;
-using OrchardCore.Workflows.Trimming.Drivers;
-using OrchardCore.Workflows.Trimming.Services;
 using OrchardCore.Workflows.WorkflowContextProviders;
 
 namespace OrchardCore.Workflows;
@@ -37,10 +32,7 @@ public sealed class Startup : StartupBase
 {
     private readonly IShellConfiguration _shellConfiguration;
 
-    public Startup(IShellConfiguration shellConfiguration)
-    {
-        _shellConfiguration = shellConfiguration;
-    }
+    public Startup(IShellConfiguration shellConfiguration) => _shellConfiguration = shellConfiguration;
 
     public override void ConfigureServices(IServiceCollection services)
     {
@@ -92,13 +84,7 @@ public override void ConfigureServices(IServiceCollection services)
         services.AddRecipeExecutionStep<WorkflowTypeStep>();
         services.AddTransient<IConfigureOptions<ResourceManagementOptions>, ResourceManagementOptionsConfiguration>();
 
-        // Trimming
-        services.AddScoped<IPermissionProvider, Permissions>();
-        services.AddScoped<IWorkflowTrimmingService, WorkflowTrimmingService>();
-        services.AddSingleton<IBackgroundTask, WorkflowTrimmingBackgroundTask>();
-        services.AddScoped<IDisplayDriver<ISite>, WorkflowTrimmingDisplayDriver>();
-        services.AddScoped<INavigationProvider, AdminMenu>();
-        services.Configure<WorkflowTrimmingOptions>(_shellConfiguration.GetSection("OrchardCore_Workflows").GetSection("Trimming"));
+        services.AddTrimmingServices(_shellConfiguration);
     }
 }
 

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Drivers/WorkflowTrimmingDisplayDriver.cs

@@ -5,6 +5,7 @@
 using OrchardCore.DisplayManagement.Entities;
 using OrchardCore.DisplayManagement.Handlers;
 using OrchardCore.DisplayManagement.Views;
+using OrchardCore.Documents;
 using OrchardCore.Settings;
 using OrchardCore.Workflows.Trimming.Models;
 using OrchardCore.Workflows.Trimming.ViewModels;
@@ -13,6 +14,7 @@ namespace OrchardCore.Workflows.Trimming.Drivers;
 
 public sealed class WorkflowTrimmingDisplayDriver : SiteDisplayDriver<WorkflowTrimmingSettings>
 {
+    private readonly IDocumentManager<WorkflowTrimmingState> _workflowTrimmingStateDocumentManager;
     public const string GroupId = "WorkflowTrimmingSettings";
 
     private readonly IHttpContextAccessor _httpContextAccessor;
@@ -21,24 +23,26 @@ public sealed class WorkflowTrimmingDisplayDriver : SiteDisplayDriver<WorkflowTr
     public WorkflowTrimmingDisplayDriver(
         IAuthorizationService authorizationService,
         IHttpContextAccessor httpContextAccessor
-    )
+    ,
+        IDocumentManager<WorkflowTrimmingState> workflowTrimmingStateDocumentManager)
     {
         _authorizationService = authorizationService;
         _httpContextAccessor = httpContextAccessor;
+        _workflowTrimmingStateDocumentManager = workflowTrimmingStateDocumentManager;
     }
 
     protected override string SettingsGroupId
         => GroupId;
 
     public override IDisplayResult Edit(ISite site, WorkflowTrimmingSettings settings, BuildEditorContext context)
     {
-        return Initialize<WorkflowTrimmingViewModel>("WorkflowTrimming_Fields_Edit", model =>
+        return Initialize<WorkflowTrimmingViewModel>("WorkflowTrimming_Fields_Edit", async model =>
         {
             model.RetentionDays = settings.RetentionDays;
-            model.LastRunUtc = settings.LastRunUtc;
+            model.LastRunUtc = (await _workflowTrimmingStateDocumentManager.GetOrCreateImmutableAsync()).LastRunUtc;
             model.Disabled = settings.Disabled;
 
-            foreach (var status in (settings.Statuses ?? []))
+            foreach (var status in settings.Statuses ?? [])
             {
                 model.Statuses.Single(statusItem => statusItem.Status == status).IsSelected = true;
             }

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Extensions/ServiceCollectionExtensions.cs

@@ -0,0 +1,24 @@
+using OrchardCore.BackgroundTasks;
+using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.Environment.Shell.Configuration;
+using OrchardCore.Navigation;
+using OrchardCore.Settings;
+using OrchardCore.Workflows.Trimming;
+using OrchardCore.Workflows.Trimming.Drivers;
+using OrchardCore.Workflows.Trimming.Services;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+internal static class ServiceCollectionExtensions
+{
+    public static IServiceCollection AddTrimmingServices(this IServiceCollection services, IShellConfiguration shellConfiguration)
+    {
+        services.AddScoped<IWorkflowTrimmingService, WorkflowTrimmingService>();
+        services.AddSingleton<IBackgroundTask, WorkflowTrimmingBackgroundTask>();
+        services.AddScoped<IDisplayDriver<ISite>, WorkflowTrimmingDisplayDriver>();
+        services.AddScoped<INavigationProvider, AdminMenu>();
+        services.Configure<WorkflowTrimmingOptions>(shellConfiguration.GetSection("OrchardCore_Workflows:Trimming"));
+
+        return services;
+    }
+}

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Models/WorkflowTrimmingSettings.cs

@@ -1,4 +1,3 @@
-using System;
 using OrchardCore.Entities;
 using OrchardCore.Workflows.Models;
 
@@ -8,8 +7,6 @@ public class WorkflowTrimmingSettings : Entity
 {
     public int RetentionDays { get; set; } = 90;
 
-    public DateTime? LastRunUtc { get; set; }
-
     public bool Disabled { get; set; }
 
     public WorkflowStatus[] Statuses { get; set; }

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Models/WorkflowTrimmingState.cs

@@ -0,0 +1,9 @@
+using System;
+using OrchardCore.Data.Documents;
+
+namespace OrchardCore.Workflows.Trimming.Models;
+
+public class WorkflowTrimmingState : Document
+{
+    public DateTime? LastRunUtc { get; set; }
+}

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Services/WorkflowTrimmingBackgroundTask.cs

@@ -5,7 +5,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using OrchardCore.BackgroundTasks;
-using OrchardCore.Entities;
+using OrchardCore.Documents;
 using OrchardCore.Modules;
 using OrchardCore.Settings;
 using OrchardCore.Workflows.Trimming.Models;
@@ -40,19 +40,18 @@ public async Task DoWorkAsync(IServiceProvider serviceProvider, CancellationToke
             var batchSize = serviceProvider.GetRequiredService<IOptions<WorkflowTrimmingOptions>>().Value.BatchSize;
 
             logger.LogDebug("Starting trimming Workflow instances.");
+
             var trimmedCount = await workflowTrimmingManager.TrimWorkflowInstancesAsync(
                 TimeSpan.FromDays(workflowTrimmingSettings.RetentionDays),
                 batchSize
             );
-            logger.LogDebug("Trimmed {TrimmedCount} workflow instances.", trimmedCount);
 
-            var siteSettings = await siteService.LoadSiteSettingsAsync();
-            siteSettings.Alter<WorkflowTrimmingSettings>(settings =>
-            {
-                settings.LastRunUtc = clock.UtcNow;
-            });
+            logger.LogDebug("Trimmed {TrimmedCount} workflow instances.", trimmedCount);
 
-            await siteService.UpdateSiteSettingsAsync(siteSettings);
+            var workflowTrimmingSateDocumentManager = serviceProvider.GetRequiredService<IDocumentManager<WorkflowTrimmingState>>();
+            var workflowTrimmingState = await workflowTrimmingSateDocumentManager.GetOrCreateMutableAsync();
+            workflowTrimmingState.LastRunUtc = clock.UtcNow;
+            await workflowTrimmingSateDocumentManager.UpdateAsync(workflowTrimmingState);
         }
         catch (Exception ex) when (!ex.IsFatal())
         {

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/Services/WorkflowTrimmingService.cs

@@ -17,7 +17,10 @@ public class WorkflowTrimmingService : IWorkflowTrimmingService
     private readonly ISession _session;
     private readonly IClock _clock;
 
-    public WorkflowTrimmingService(ISiteService siteService, ISession session, IClock clock)
+    public WorkflowTrimmingService(
+        ISiteService siteService,
+        ISession session,
+        IClock clock)
     {
         _siteService = siteService;
         _session = session;

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/ViewModels/WorkflowStatusItem.cs

@@ -0,0 +1,11 @@
+using OrchardCore.Workflows.Models;
+
+namespace OrchardCore.Workflows.Trimming.ViewModels;
+
+public class WorkflowStatusItem
+{
+    public WorkflowStatus Status { get; set; }
+
+    public bool IsSelected { get; set; }
+}
+

src/OrchardCore.Modules/OrchardCore.Workflows/Trimming/ViewModels/WorkflowTrimmingViewModel.cs

@@ -26,10 +26,3 @@ public WorkflowTrimmingViewModel()
             .ToArray();
     }
 }
-
-public class WorkflowStatusItem
-{
-    public WorkflowStatus Status { get; set; }
-
-    public bool IsSelected { get; set; }
-}

src/OrchardCore.Modules/OrchardCore.Workflows/Views/WorkflowTrimming.Fields.Edit.cshtml

@@ -3,10 +3,12 @@
 @using OrchardCore.Workflows.Trimming.ViewModels
 @model WorkflowTrimmingViewModel
 
-<div class="form-check">
-    <input type="checkbox" class="form-check-input" asp-for="Disabled" checked="@Model.Disabled" />
-    <label class="form-check-label" asp-for="Disabled">@T["Disable"]</label>
-    <span class="hint dashed">@T["Whether the task is disabled."]</span>
+<div class="mb-3">
+    <div class="form-check">
+        <input type="checkbox" class="form-check-input" asp-for="Disabled" checked="@Model.Disabled" />
+        <label class="form-check-label" asp-for="Disabled">@T["Disable"]</label>
+        <span class="hint dashed">@T["Whether the task is disabled."]</span>
+    </div>
 </div>
 
 <div class="mb-3" asp-validation-class-for="RetentionDays">
@@ -26,8 +28,8 @@
 </div>
 
 @* We use a hard-coded list of statuses here instead of iterating over the enum so the explicit T-strings make
-       localization easier (and so the default English displayed string can be different than the enum value's name). *@
-<div class="row">
+   localization easier (and so the default English displayed string can be different than the enum value's name). *@
+<div class="mb-3 row">
     <div class="col-xs-12">
         <div class="form-check">
             <input type="hidden" asp-for="@Model.Statuses[0].Status" />
@@ -107,5 +109,4 @@
             </label>
         </div>
     </div>
-
 </div>

src/docs/reference/modules/Workflows/README.md

@@ -443,11 +443,11 @@ Old workflow instances can be automatically deleted with the Trimming feature. T
 By default, the trimming background task runs once a day and removes at most 5000 workflow instances. You can change the frequency of the background task via [the `OrchardCore.BackgroundTasks` configuration](../BackgroundTasks/README.md), and the batch size via the `OrchardCore_Workflows` configuration from e.g. an `appsettings` file:
 
 ```json
-    "OrchardCore_Workflows": {
-      "Trimming": {
-        "BatchSize": 1000
-      }
-    }
+"OrchardCore_Workflows": {
+  "Trimming": {
+    "BatchSize": 1000
+  }
+}
 ```
 
 See [Configuration](../../core/Configuration/README.md) for more information on such configuration.

src/docs/releases/2.0.0.md

@@ -738,4 +738,4 @@ Many type commonly used by modules can be `sealed`, which improves runtime perfo
 
 ### Workflow Trimming
 
-The Workflows module now has a Trimming feature to automatically clean up old workflow instances. See [the corresponding documentation](../reference/modules/Workflows/README.md#trimming) for details.
+The Workflows module now has a `Trimming` feature to automatically clean up old workflow instances. See [the corresponding documentation](../reference/modules/Workflows/README.md#trimming) for details.