Enhanced Workflow Instance Filters

Directory.Packages.props

@@ -87,6 +87,7 @@
     <PackageVersion Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageVersion Include="System.Data.SqlClient" Version="4.8.6" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.1" />
+    <PackageVersion Include="System.Linq.Dynamic.Core" Version="1.3.8" />
     <PackageVersion Include="Testcontainers" Version="3.6.0" />
     <PackageVersion Include="Testcontainers.Redis" Version="3.6.0" />
     <PackageVersion Include="ThrottleDebounce" Version="2.0.0" />

NuGet.Config

@@ -3,8 +3,14 @@
   <packageSources>
     <clear />
     <add key="NuGet official package source" value="https://api.nuget.org/v3/index.json" />
-	<!--
     <add key="Elsa 3 Preview" value="https://f.feedz.io/elsa-workflows/elsa-3/nuget/index.json" />
-	-->
   </packageSources>
+  <packageSourceMapping>
+    <packageSource key="NuGet official package source">
+      <package pattern="*" />
+    </packageSource>
+    <packageSource key="Elsa 3 Preview">
+      <package pattern="Elsa.*" />
+    </packageSource>
+  </packageSourceMapping>
 </configuration>

src/clients/Elsa.Api.Client/Resources/WorkflowInstances/Contracts/IWorkflowInstancesApi.cs

@@ -14,7 +14,7 @@ public interface IWorkflowInstancesApi
     /// <summary>
     /// Returns a list of workflow instances.
     /// </summary>
-    [Get("/workflow-instances")]
+    [Post("/workflow-instances")]
     Task<PagedListResponse<WorkflowInstanceSummary>> ListAsync(ListWorkflowInstancesRequest request, CancellationToken cancellationToken = default);
 
     /// <summary>

src/clients/Elsa.Api.Client/Resources/WorkflowInstances/Requests/ListWorkflowInstancesRequest.cs

@@ -13,64 +13,74 @@ public class ListWorkflowInstancesRequest
     /// Gets or sets the page number.
     /// </summary>
     public int? Page { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the page size.
     /// </summary>
     public int? PageSize { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the search term.
     /// </summary>
     public string? SearchTerm { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the workflow definition id.
     /// </summary>
     public string? DefinitionId { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the workflow definition ids.
     /// </summary>
-    [Query(CollectionFormat.Multi)] public ICollection<string>? DefinitionIds { get; set; }
-    
+    public ICollection<string>? DefinitionIds { get; set; }
+
     /// <summary>
     /// Gets or sets the correlation id.
     /// </summary>
     public string? CorrelationId { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the version.
     /// </summary>
     public int? Version { get; set; }
-
+
+    /// <summary>
+    /// Gets or sets whether the workflow instances have incidents or not.
+    /// </summary>
+    public bool? HasIncidents { get; set; }
+
     /// <summary>
     /// Gets or sets the status.
     /// </summary>
     public WorkflowStatus? Status { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the statuses.
     /// </summary>
-    [Query(CollectionFormat.Multi)] public ICollection<WorkflowStatus>? Statuses { get; set; }
-    
+    public ICollection<WorkflowStatus>? Statuses { get; set; }
+
     /// <summary>
     /// Gets or sets the sub status.
     /// </summary>
     public WorkflowSubStatus? SubStatus { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the sub statuses.
     /// </summary>
-    [Query(CollectionFormat.Multi)] public ICollection<WorkflowSubStatus>? SubStatuses { get; set; }
+    public ICollection<WorkflowSubStatus>? SubStatuses { get; set; }
 
     /// <summary>
     /// Gets or sets the key to order by.
     /// </summary>
     public OrderByWorkflowInstance? OrderBy { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the order direction.
     /// </summary>
     public OrderDirection? OrderDirection { get; set; }
+
+    /// <summary>
+    /// Gets or sets the timestamp filters.
+    /// </summary>
+    public ICollection<TimestampFilter>? TimestampFilters { get; set; }
 }

src/clients/Elsa.Api.Client/Shared/Enums/TimestampFilterOperator.cs

@@ -0,0 +1,37 @@
+namespace Elsa.Api.Client.Shared.Enums;
+
+/// <summary>
+/// Specifies the operators for filtering timestamps in a TimestampFilter object.
+/// </summary>
+public enum TimestampFilterOperator
+{
+    /// <summary>
+    /// The timestamp is equal to the specified value.
+    /// </summary>
+    Is,
+
+    /// <summary>
+    /// The timestamp is not equal to the specified value.
+    /// </summary>
+    IsNot,
+
+    /// <summary>
+    /// The timestamp is before the specified value.
+    /// </summary>
+    LessThan,
+
+    /// <summary>
+    /// The timestamp is greater than the specified value.
+    /// </summary>
+    GreaterThan,
+
+    /// <summary>
+    /// The timestamp is less than or equal to the specified value.
+    /// </summary>
+    LessThanOrEqual,
+
+    /// <summary>
+    /// The timestamp is greater than or equal to the specified value.
+    /// </summary>
+    GreaterThanOrEqual
+}

src/clients/Elsa.Api.Client/Shared/Models/TimestampFilter.cs

@@ -0,0 +1,26 @@
+using Elsa.Api.Client.Shared.Enums;
+using JetBrains.Annotations;
+
+namespace Elsa.Api.Client.Shared.Models;
+
+/// <summary>
+/// Represents a timestamp filter used for filtering data based on a specified timestamp column and operator.
+/// </summary>
+[UsedImplicitly]
+public class TimestampFilter
+{
+    /// <summary>
+    /// Gets or sets the column to filter by.
+    /// </summary>
+    public string Column { get; set; } = default!;
+
+    /// <summary>
+    /// Gets or sets the operator to use for filtering.
+    /// </summary>
+    public TimestampFilterOperator Operator { get; set; }
+
+    /// <summary>
+    /// Gets or sets the timestamp to filter by.
+    /// </summary>
+    public DateTimeOffset Timestamp { get; set; }
+}

src/modules/Elsa.Workflows.Api/Endpoints/WorkflowInstances/List/Endpoint.cs

@@ -6,65 +6,106 @@
 using Elsa.Workflows.Management.Filters;
 using Elsa.Workflows.Management.Models;
 using JetBrains.Annotations;
+using Microsoft.AspNetCore.Http;
 
 namespace Elsa.Workflows.Api.Endpoints.WorkflowInstances.List;
 
-[PublicAPI]
-internal class List : ElsaEndpoint<Request, Response>
+[UsedImplicitly]
+internal class List(IWorkflowInstanceStore store) : ElsaEndpoint<Request, Response>
 {
-    private readonly IWorkflowInstanceStore _store;
-
-    public List(IWorkflowInstanceStore store)
-    {
-        _store = store;
-    }
-
     public override void Configure()
     {
-        Get("/workflow-instances");
+        Verbs(FastEndpoints.Http.GET, FastEndpoints.Http.POST);
+        Routes("/workflow-instances");
         ConfigurePermissions("read:workflow-instances");
     }
 
-    public override async Task<Response> ExecuteAsync(Request request, CancellationToken cancellationToken)
+    public override async Task HandleAsync(Request request, CancellationToken cancellationToken)
     {
         var pageArgs = PageArgs.FromPage(request.Page, request.PageSize);
 
+        if (!await ValidateInputAsync(request, cancellationToken))
+        {
+            await SendErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken);
+            return;
+        }
+
         var filter = new WorkflowInstanceFilter
         {
             SearchTerm = request.SearchTerm,
             DefinitionId = request.DefinitionId,
-            DefinitionIds = request.DefinitionIds,
+            DefinitionIds = request.DefinitionIds?.Any() == true ? request.DefinitionIds : null,
             Version = request.Version,
             CorrelationId = request.CorrelationId,
             WorkflowStatus = request.Status,
             WorkflowSubStatus = request.SubStatus,
-            WorkflowStatuses = request.Statuses?.Select(Enum.Parse<WorkflowStatus>).ToList(),
-            WorkflowSubStatuses = request.SubStatuses?.Select(Enum.Parse<WorkflowSubStatus>).ToList(),
-            ToCreatedAt = request.ToCreatedAt,
-            FromCreatedAt = request.FromCreatedAt,
+            WorkflowStatuses = request.Statuses?.Any() == true ? request.Statuses : null,
+            WorkflowSubStatuses = request.SubStatuses?.Any() == true ? request.SubStatuses : null,
+            HasIncidents = request.HasIncidents,
+            TimestampFilters = request.TimestampFilters?.Any() == true ? request.TimestampFilters : null,
         };
 
         var summaries = await FindAsync(request, filter, pageArgs, cancellationToken);
-        return new Response(summaries.Items, summaries.TotalCount);
+        var response = new Response(summaries.Items, summaries.TotalCount);
+        await SendOkAsync(response, cancellationToken);
+    }
+
+    private async Task<bool> ValidateInputAsync(Request request, CancellationToken cancellationToken)
+    {
+        if (request.Page is < 0)
+        {
+            AddError("Page must be greater than or equal to 1.");
+            return false;
+        }
+
+        if (request.PageSize is < 1)
+        {
+            AddError("Page size must be greater than or equal to 1.");
+            return false;
+        }
+
+        var columnWhitelist = new[]
+        {
+            "CreatedAt", "UpdatedAt", "FinishedAt"
+        };
+
+        if (request.TimestampFilters?.Any() == true)
+        {
+            foreach (var timestampFilter in request.TimestampFilters)
+            {
+                if (string.IsNullOrWhiteSpace(timestampFilter.Column))
+                {
+                    AddError("Column must be specified.");
+                    return false;
+                }
+
+                if (!columnWhitelist.Contains(timestampFilter.Column))
+                {
+                    AddError($"Invalid column '{timestampFilter.Column}'.");
+                    return false;
+                }
+            }
+        }
+
+        return true;
     }
 
     private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, WorkflowInstanceFilter filter, PageArgs pageArgs, CancellationToken cancellationToken)
     {
-        request.OrderBy = request.OrderBy ?? OrderByWorkflowInstance.Created;
-        var direction = request.OrderBy == OrderByWorkflowInstance.Name ? (request.OrderDirection ?? OrderDirection.Ascending) : (request.OrderDirection ?? OrderDirection.Descending);
+        request.OrderBy ??= OrderByWorkflowInstance.Created;
+        var direction = request.OrderBy == OrderByWorkflowInstance.Name ? request.OrderDirection ?? OrderDirection.Ascending : request.OrderDirection ?? OrderDirection.Descending;
 
         switch (request.OrderBy)
         {
             default:
-            case OrderByWorkflowInstance.Created:
                 {
                     var o = new WorkflowInstanceOrder<DateTimeOffset>
                     {
                         KeySelector = p => p.CreatedAt,
                         Direction = direction
                     };
 
-                    return await _store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
+                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
                 }
             case OrderByWorkflowInstance.UpdatedAt:
                 {
@@ -74,7 +115,7 @@ private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, Wor
                         Direction = direction
                     };
 
-                    return await _store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
+                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
                 }
             case OrderByWorkflowInstance.Finished:
                 {
@@ -84,7 +125,7 @@ private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, Wor
                         Direction = direction
                     };
 
-                    return await _store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
+                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
                 }
             case OrderByWorkflowInstance.Name:
                 {
@@ -94,7 +135,7 @@ private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, Wor
                         Direction = direction
                     };
 
-                    return await _store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
+                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
                 }
         }
     }

src/modules/Elsa.Workflows.Api/Endpoints/WorkflowInstances/List/Models.cs

@@ -12,25 +12,21 @@ public class Request
     public string? DefinitionId { get; set; }
     public ICollection<string>? DefinitionIds { get; set; }
     public string? CorrelationId { get; set; }
+    public string? Name { get; set; }
     public int? Version { get; set; }
+    public bool? HasIncidents { get; set; }
     public WorkflowStatus? Status { get; set; }
-    public ICollection<string>? Statuses { get; set; }
+    public ICollection<WorkflowStatus>? Statuses { get; set; }
     public WorkflowSubStatus? SubStatus { get; set; }
-    public ICollection<string>? SubStatuses { get; set; }
+    public ICollection<WorkflowSubStatus>? SubStatuses { get; set; }
     public OrderByWorkflowInstance? OrderBy { get; set; }
     public OrderDirection? OrderDirection { get; set; }
-    public DateTimeOffset? FromCreatedAt { get; set; }
-    public DateTimeOffset? ToCreatedAt { get; set; }
+    public ICollection<TimestampFilter>? TimestampFilters { get; set; }
 }
 
-public class Response
+internal class Response(ICollection<WorkflowInstanceSummary> items, long totalCount)
 {
-    public Response(ICollection<WorkflowInstanceSummary> items, long totalCount)
-    {
-        Items = items;
-        TotalCount = totalCount;
-    }
+    public ICollection<WorkflowInstanceSummary> Items { get; set; } = items;
+    public long TotalCount { get; set; } = totalCount;
+}
 
-    public ICollection<WorkflowInstanceSummary> Items { get; set; }
-    public long TotalCount { get; set; }
-}

src/modules/Elsa.Workflows.Management/Elsa.Workflows.Management.csproj

@@ -10,7 +10,7 @@
     <ItemGroup>
         <PackageReference Include="Humanizer.Core" />
         <PackageReference Include="IronCompress" />
-        <PackageReference Include="System.Linq.Async" />
+        <PackageReference Include="System.Linq.Dynamic.Core" />
     </ItemGroup>
 
     <ItemGroup>