< 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: 148
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.Authorization;
 2using Elsa.Abstractions;
 3using Elsa.Common.Entities;
 4using Elsa.Common.Models;
 5using Elsa.Workflows.Api.Models;
 6using Elsa.Workflows.Management;
 7using Elsa.Workflows.Management.Filters;
 8using Elsa.Workflows.Management.Models;
 9using JetBrains.Annotations;
 10using Microsoft.AspNetCore.Http;
 11
 12namespace Elsa.Workflows.Api.Endpoints.WorkflowInstances.List;
 13
 14[UsedImplicitly]
 315internal class List(IWorkflowInstanceStore store) : ElsaEndpoint<Request, Response>
 16{
 17    public override void Configure()
 18    {
 319        Verbs(FastEndpoints.Http.GET, FastEndpoints.Http.POST);
 320        Routes("/workflow-instances");
 321        RequirePermission(Elsa.Workflows.Api.Permissions.WorkflowPermissions.Instances, CoreVerbs.View);
 322    }
 23
 24    public override async Task HandleAsync(Request request, CancellationToken cancellationToken)
 25    {
 026        var pageArgs = PageArgs.FromPage(request.Page, request.PageSize);
 027        var workflowStatuses = request.Statuses?.Any() == true ? ParseEnumStrings<WorkflowStatus>(request.Statuses).ToLi
 028        var workflowSubStatuses = request.SubStatuses?.Any() == true ? ParseEnumStrings<WorkflowSubStatus>(request.SubSt
 29
 030        ValidateInput(request);
 31
 032        if (ValidationFailed)
 33        {
 034            await Send.ErrorsAsync(StatusCodes.Status400BadRequest, cancellationToken);
 035            return;
 36        }
 37
 038        var filter = new WorkflowInstanceFilter
 039        {
 040            IsSystem = request.IsSystem,
 041            SearchTerm = request.SearchTerm,
 042            Name = request.Name,
 043            DefinitionId = request.DefinitionId,
 044            DefinitionIds = request.DefinitionIds?.Any() == true ? request.DefinitionIds : null,
 045            Version = request.Version,
 046            CorrelationId = request.CorrelationId,
 047            WorkflowStatus = request.Status,
 048            WorkflowSubStatus = request.SubStatus,
 049            WorkflowStatuses = workflowStatuses,
 050            WorkflowSubStatuses = workflowSubStatuses,
 051            HasIncidents = request.HasIncidents,
 052            TimestampFilters = request.TimestampFilters?.Any() == true ? request.TimestampFilters : null,
 053        };
 54
 055        var summaries = await FindAsync(request, filter, pageArgs, cancellationToken);
 056        var response = new Response(summaries.Items, summaries.TotalCount);
 057        await Send.OkAsync(response, cancellationToken);
 058    }
 59
 60    private IEnumerable<TEnum> ParseEnumStrings<TEnum>(IEnumerable<string> strings) where TEnum : struct
 61    {
 062        foreach (string s in strings)
 63        {
 064            if (Enum.TryParse<TEnum>(s, true, out var result))
 065                yield return result;
 66            else
 67            {
 068                AddError($"Invalid enum value '{s}'.");
 069                yield break;
 70            }
 71        }
 072    }
 73
 74    private bool ValidateInput(Request request)
 75    {
 076        if (request.Page is < 0)
 77        {
 078            AddError("Page must be greater than or equal to 1.");
 079            return false;
 80        }
 81
 082        if (request.PageSize is < 1)
 83        {
 084            AddError("Page size must be greater than or equal to 1.");
 085            return false;
 86        }
 87
 088        var hasTimestampFilterErrors = false;
 89
 090        foreach (var error in WorkflowInstanceFilter.ValidateTimestampFilters(request.TimestampFilters))
 91        {
 092            AddError(error);
 093            hasTimestampFilterErrors = true;
 94        }
 95
 096        return !hasTimestampFilterErrors;
 97    }
 98
 99    private async Task<Page<WorkflowInstanceSummary>> FindAsync(Request request, WorkflowInstanceFilter filter, PageArgs
 100    {
 0101        request.OrderBy ??= OrderByWorkflowInstance.Created;
 0102        var direction = request.OrderBy == OrderByWorkflowInstance.Name ? request.OrderDirection ?? OrderDirection.Ascen
 103
 0104        switch (request.OrderBy)
 105        {
 106            default:
 107                {
 0108                    var o = new WorkflowInstanceOrder<DateTimeOffset>
 0109                    {
 0110                        KeySelector = p => p.CreatedAt,
 0111                        Direction = direction
 0112                    };
 113
 0114                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 115                }
 116            case OrderByWorkflowInstance.UpdatedAt:
 117                {
 0118                    var o = new WorkflowInstanceOrder<DateTimeOffset?>
 0119                    {
 0120                        KeySelector = p => p.UpdatedAt,
 0121                        Direction = direction
 0122                    };
 123
 0124                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 125                }
 126            case OrderByWorkflowInstance.Finished:
 127                {
 0128                    var o = new WorkflowInstanceOrder<DateTimeOffset?>
 0129                    {
 0130                        KeySelector = p => p.FinishedAt,
 0131                        Direction = direction
 0132                    };
 133
 0134                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 135                }
 136            case OrderByWorkflowInstance.Name:
 137                {
 0138                    var o = new WorkflowInstanceOrder<string>
 0139                    {
 0140                        KeySelector = p => p.Name!,
 0141                        Direction = direction
 0142                    };
 143
 0144                    return await store.SummarizeManyAsync(filter, pageArgs, o, cancellationToken);
 145                }
 146        }
 0147    }
 148}
Generated by: ReportGenerator 5.5.11.0
09/09/2026 - 11:01:44
GitHub | reportgenerator.io

Methods/Properties

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