< Summary

Information
Class: Elsa.Workflows.Api.Endpoints.WorkflowInstances.List.List
Assembly: Elsa.Workflows.Api
File(s): /home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowInstances/List/Endpoint.cs
Line coverage
6%
Covered lines: 5
Uncovered lines: 72
Coverable lines: 77
Total lines: 147
Line coverage: 6.4%
Branch coverage
0%
Covered branches: 0
Total branches: 42
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
Configure()100%11100%
HandleAsync()0%342180%
ParseEnumStrings()0%2040%
ValidateInput(...)0%110100%
FindAsync()0%110100%

File(s)

/home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Api/Endpoints/WorkflowInstances/List/Endpoint.cs

#LineLine coverage
 1using Elsa.Abstractions;
 2using Elsa.Common.Entities;
 3using Elsa.Common.Models;
 4using Elsa.Workflows.Api.Models;
 5using Elsa.Workflows.Management;
 6using Elsa.Workflows.Management.Filters;
 7using Elsa.Workflows.Management.Models;
 8using JetBrains.Annotations;
 9using Microsoft.AspNetCore.Http;
 10
 11namespace Elsa.Workflows.Api.Endpoints.WorkflowInstances.List;
 12
 13[UsedImplicitly]
 314internal class List(IWorkflowInstanceStore store) : ElsaEndpoint<Request, Response>
 15{
 16    public override void Configure()
 17    {
 318        Verbs(FastEndpoints.Http.GET, FastEndpoints.Http.POST);
 319        Routes("/workflow-instances");
 320        ConfigurePermissions("read:workflow-instances");
 321    }
 22
 23    public override async Task HandleAsync(Request request, CancellationToken cancellationToken)
 24    {
 025        var pageArgs = PageArgs.FromPage(request.Page, request.PageSize);
 026        var workflowStatuses = request.Statuses?.Any() == true ? ParseEnumStrings<WorkflowStatus>(request.Statuses).ToLi
 027        var workflowSubStatuses = request.SubStatuses?.Any() == true ? ParseEnumStrings<WorkflowSubStatus>(request.SubSt
 28
 029        ValidateInput(request);
 30
 031        if (ValidationFailed)
 32        {
 033            await Send.ErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken);
 034            return;
 35        }
 36
 037        var filter = new WorkflowInstanceFilter
 038        {
 039            IsSystem = request.IsSystem,
 040            SearchTerm = request.SearchTerm,
 041            Name = request.Name,
 042            DefinitionId = request.DefinitionId,
 043            DefinitionIds = request.DefinitionIds?.Any() == true ? request.DefinitionIds : null,
 044            Version = request.Version,
 045            CorrelationId = request.CorrelationId,
 046            WorkflowStatus = request.Status,
 047            WorkflowSubStatus = request.SubStatus,
 048            WorkflowStatuses = workflowStatuses,
 049            WorkflowSubStatuses = workflowSubStatuses,
 050            HasIncidents = request.HasIncidents,
 051            TimestampFilters = request.TimestampFilters?.Any() == true ? request.TimestampFilters : null,
 052        };
 53
 054        var summaries = await FindAsync(request, filter, pageArgs, cancellationToken);
 055        var response = new Response(summaries.Items, summaries.TotalCount);
 056        await Send.OkAsync(response, cancellationToken);
 057    }
 58
 59    private IEnumerable<TEnum> ParseEnumStrings<TEnum>(IEnumerable<string> strings) where TEnum : struct
 60    {
 061        foreach (string s in strings)
 62        {
 063            if (Enum.TryParse<TEnum>(s, true, out var result))
 064                yield return result;
 65            else
 66            {
 067                AddError($"Invalid enum value '{s}'.");
 068                yield break;
 69            }
 70        }
 071    }
 72
 73    private bool ValidateInput(Request request)
 74    {
 075        if (request.Page is < 0)
 76        {
 077            AddError("Page must be greater than or equal to 1.");
 078            return false;
 79        }
 80
 081        if (request.PageSize is < 1)
 82        {
 083            AddError("Page size must be greater than or equal to 1.");
 084            return false;
 85        }
 86
 087        var hasTimestampFilterErrors = false;
 88
 089        foreach (var error in WorkflowInstanceFilter.ValidateTimestampFilters(request.TimestampFilters))
 90        {
 091            AddError(error);
 092            hasTimestampFilterErrors = true;
 93        }
 94
 095        return !hasTimestampFilterErrors;
 96    }
 97
 98    private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, WorkflowInstanceFilter filter, PageArgs
 99    {
 0100        request.OrderBy ??= OrderByWorkflowInstance.Created;
 0101        var direction = request.OrderBy == OrderByWorkflowInstance.Name ? request.OrderDirection ?? OrderDirection.Ascen
 102
 0103        switch (request.OrderBy)
 104        {
 105            default:
 106                {
 0107                    var o = new WorkflowInstanceOrder<DateTimeOffset>
 0108                    {
 0109                        KeySelector = p => p.CreatedAt,
 0110                        Direction = direction
 0111                    };
 112
 0113                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 114                }
 115            case OrderByWorkflowInstance.UpdatedAt:
 116                {
 0117                    var o = new WorkflowInstanceOrder<DateTimeOffset?>
 0118                    {
 0119                        KeySelector = p => p.UpdatedAt,
 0120                        Direction = direction
 0121                    };
 122
 0123                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 124                }
 125            case OrderByWorkflowInstance.Finished:
 126                {
 0127                    var o = new WorkflowInstanceOrder<DateTimeOffset?>
 0128                    {
 0129                        KeySelector = p => p.FinishedAt,
 0130                        Direction = direction
 0131                    };
 132
 0133                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 134                }
 135            case OrderByWorkflowInstance.Name:
 136                {
 0137                    var o = new WorkflowInstanceOrder<string>
 0138                    {
 0139                        KeySelector = p => p.Name!,
 0140                        Direction = direction
 0141                    };
 142
 0143                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 144                }
 145        }
 0146    }
 147}
Generated by: ReportGenerator 5.5.10.0
05/31/2026 - 13:48:39
GitHub | reportgenerator.io

Methods/Properties

.ctor(Elsa.Workflows.Management.IWorkflowInstanceStore)
Configure()
HandleAsync()
ParseEnumStrings()
ValidateInput(Elsa.Workflows.Api.Endpoints.WorkflowInstances.List.Request)
FindAsync()