< Summary

Information
Class: Program
Assembly: Elsa.Server.Web
File(s): /home/runner/work/elsa-core/elsa-core/src/apps/Elsa.Server.Web/Program.cs
Line coverage
85%
Covered lines: 170
Uncovered lines: 30
Coverable lines: 200
Total lines: 307
Line coverage: 85%
Branch coverage
67%
Covered branches: 38
Total branches: 56
Branch coverage: 67.8%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
<Main>$()67.85%675684.92%
get_ConfigureForTest()100%11100%

File(s)

/home/runner/work/elsa-core/elsa-core/src/apps/Elsa.Server.Web/Program.cs

#LineLine coverage
 1using System.Text.Encodings.Web;
 2using System.Threading.RateLimiting;
 3using Elsa.Caching.Options;
 4using Elsa.Common.RecurringTasks;
 5using Elsa.Expressions.Helpers;
 6using Elsa.Extensions;
 7using Elsa.Features.Services;
 8using Elsa.Http.Options;
 9using Elsa.Identity.Multitenancy;
 10using Elsa.Persistence.EFCore.Extensions;
 11using Elsa.Persistence.EFCore.Modules.Management;
 12using Elsa.Persistence.EFCore.Modules.Runtime;
 13using Elsa.Server.Web.Activities;
 14using Elsa.Server.Web.ActivityHosts;
 15using Elsa.Server.Web.Filters;
 16using Elsa.Tenants;
 17using Elsa.Tenants.AspNetCore;
 18using Elsa.Tenants.Extensions;
 19using Elsa.WorkflowProviders.BlobStorage.ElsaScript.Extensions;
 20using Elsa.Workflows;
 21using Elsa.Workflows.Activities.Flowchart.Extensions;
 22using Elsa.Workflows.Api;
 23using Elsa.Workflows.CommitStates.Strategies;
 24using Elsa.Workflows.IncidentStrategies;
 25using Elsa.Workflows.LogPersistence;
 26using Elsa.Workflows.Options;
 27using Elsa.Workflows.Runtime.Distributed.Extensions;
 28using Elsa.Workflows.Runtime.Options;
 29using Elsa.Workflows.Runtime.Tasks;
 30using JetBrains.Annotations;
 31using Microsoft.AspNetCore.RateLimiting;
 32using Microsoft.Extensions.Diagnostics.HealthChecks;
 33using Microsoft.Extensions.Options;
 34
 35// ReSharper disable RedundantAssignment
 36const bool useReadOnlyMode = false;
 37const bool useSignalR = false; // Disabled until Elsa Studio sends authenticated requests.
 38const bool useStructuredLogs = false; // Enable to inspect backend logs from Elsa Studio.
 39const bool useMultitenancy = true;
 40const bool disableVariableWrappers = false;
 41const string elsaApiRateLimitingPolicy = "elsa-api";
 42const string httpWorkflowRateLimitingPolicy = "elsa-http-workflows";
 43
 344ObjectConverter.StrictMode = true;
 45
 346var builder = WebApplication.CreateBuilder(args);
 347var services = builder.Services;
 348var configuration = builder.Configuration;
 349var identitySection = configuration.GetSection("Identity");
 350var identityTokenSection = identitySection.GetSection("Tokens");
 351var ingressRateLimitingSection = configuration.GetSection("IngressRateLimiting");
 352var useIngressRateLimiting = ingressRateLimitingSection.GetValue("Enabled", false);
 353var registerIngressRateLimitingPolicies = ingressRateLimitingSection.GetValue("RegisterReferencePolicies", useIngressRat
 354var configuredAllowLocalDistributedRuntimeLockProvider = configuration.GetValue<bool?>("DistributedRuntime:AllowLocalLoc
 355var allowLocalDistributedRuntimeLockProvider =
 356    configuredAllowLocalDistributedRuntimeLockProvider ?? builder.Environment.IsDevelopment();
 57
 358services
 359    .AddElsa(elsa =>
 360    {
 361        elsa
 362            .AddActivitiesFrom<Program>()
 363            .AddActivityHost<Penguin>()
 364            .AddWorkflowsFrom<Program>()
 365            .UseIdentity(identity =>
 366            {
 667                identity.TokenOptions += options => identityTokenSection.Bind(options);
 368                identity.UseConfigurationBasedUserProvider(options => identitySection.Bind(options));
 369                identity.UseConfigurationBasedApplicationProvider(options => identitySection.Bind(options));
 370                identity.UseConfigurationBasedRoleProvider(options => identitySection.Bind(options));
 371            })
 372            .UseDefaultAuthentication()
 373            .UseWorkflows(workflows =>
 374            {
 375                workflows.UseCommitStrategies(strategies =>
 376                {
 377                    strategies.AddStandardStrategies();
 378                    strategies.Add("Every 10 seconds", new PeriodicWorkflowStrategy(TimeSpan.FromSeconds(10)));
 679                });
 380            })
 381            .UseFlowchart(flowchart => flowchart.UseTokenBasedExecution())
 382            .UseWorkflowManagement(management =>
 383            {
 684                management.UseEntityFrameworkCore(ef => ef.UseSqlite());
 385                management.SetDefaultLogPersistenceMode(LogPersistenceMode.Inherit);
 386                management.UseCache();
 387                management.UseReadOnlyMode(useReadOnlyMode);
 388            })
 389            .UseWorkflowRuntime(runtime =>
 390            {
 691                runtime.UseEntityFrameworkCore(ef => ef.UseSqlite());
 392                runtime.UseCache();
 393                runtime.UseDistributedRuntime();
 394                // This sample host acknowledges single-host file-system locks in development or explicit single-host op
 395                runtime.DistributedLockingOptions = options => options.AllowLocalLockProviderInDistributedRuntime = allo
 396            })
 397            .UseWorkflowsApi()
 398            .UseDashboardApi()
 399            .UseFluentStorageProvider()
 3100            .UseElsaScriptBlobStorage()
 3101            .UseScheduling()
 3102            .UseCSharp(options =>
 3103            {
 3104                configuration.GetSection("Scripting:CSharp").Bind(options);
 3105                options.DisableWrappers = disableVariableWrappers;
 3106                options.AppendScript("string Greet(string name) => $\"Hello {name}!\";");
 3107                options.AppendScript("string SayHelloWorld() => Greet(\"World\");");
 3108            })
 3109            .UseJavaScript(options =>
 3110            {
 3111                options.AllowClrAccess = true;
 3112                options.ConfigureEngine(engine =>
 3113                {
 19114                    engine.Execute("function greet(name) { return `Hello ${name}!`; }");
 19115                    engine.Execute("function sayHelloWorld() { return greet('World'); }");
 22116                });
 3117            })
 3118            .UsePython(python =>
 3119            {
 3120                python.PythonOptions += options =>
 3121                {
 3122                    // Make sure to configure the path to the python DLL. E.g. /opt/homebrew/Cellar/python@3.11/3.11.6_1
 3123                    // alternatively, you can set the PYTHONNET_PYDLL environment variable.
 3124                    configuration.GetSection("Scripting:Python").Bind(options);
 3125
 3126                    options.AddScript(sb =>
 3127                    {
 3128                        sb.AppendLine("def greet():");
 3129                        sb.AppendLine("    return \"Hello, welcome to Python!\"");
 6130                    });
 6131                };
 3132            })
 6133            .UseLiquid(liquid => liquid.FluidOptions = options => options.Encoder = HtmlEncoder.Default)
 3134            .UseHttp(http =>
 3135            {
 6136                http.ConfigureHttpOptions = options => configuration.GetSection("Http").Bind(options);
 3137                http.UseCache();
 6138            });
 3139
 3140        if(useMultitenancy)
 3141        {
 3142            elsa.UseTenants(tenants =>
 3143            {
 4144                tenants.UseConfigurationBasedTenantsProvider(options => configuration.GetSection("Multitenancy").Bind(op
 4145                tenants.ConfigureMultitenancy(options => options.TenantResolverPipelineBuilder = new TenantResolverPipel
 4146                    .Append<CurrentUserTenantResolver>());
 6147            });
 3148        }
 3149
 3150        if(useStructuredLogs)
 3151            elsa.UseStructuredLogs();
 3152
 3153        ConfigureForTest?.Invoke(elsa);
 6154    });
 155
 156// Obfuscate HTTP request headers.
 3157services.AddActivityStateFilter<HttpRequestAuthenticationHeaderFilter>();
 158
 159// Optionally configure recurring tasks using alternative schedules.
 3160services.Configure<RecurringTaskOptions>(options =>
 3161{
 3162    options.Schedule.ConfigureTask<TriggerBookmarkQueueRecurringTask>(TimeSpan.FromSeconds(300));
 3163    options.Schedule.ConfigureTask<PurgeBookmarkQueueRecurringTask>(TimeSpan.FromSeconds(300));
 3164    options.Schedule.ConfigureTask<RestartInterruptedWorkflowsTask>(TimeSpan.FromSeconds(15));
 6165});
 166
 9167services.Configure<RuntimeOptions>(options => { options.InactivityThreshold = TimeSpan.FromSeconds(15); });
 3168services.Configure<BookmarkQueuePurgeOptions>(options => options.Ttl = TimeSpan.FromSeconds(3600));
 6169services.Configure<CachingOptions>(options => options.CacheDuration = TimeSpan.FromDays(1));
 3170services.Configure<IncidentOptions>(options => options.DefaultIncidentStrategy = typeof(ContinueWithIncidentsStrategy));
 3171if (useIngressRateLimiting)
 172{
 0173    services.PostConfigure<ApiEndpointOptions>(options =>
 0174    {
 0175        if (options.RateLimitingPolicyName == null)
 0176            options.RateLimitingPolicyName = elsaApiRateLimitingPolicy;
 0177    });
 0178    services.PostConfigure<HttpActivityOptions>(options =>
 0179    {
 0180        if (options.RateLimitingPolicyName == null)
 0181            options.RateLimitingPolicyName = httpWorkflowRateLimitingPolicy;
 0182    });
 183}
 184
 3185services.AddRateLimiter(options =>
 3186{
 0187    options.RejectionStatusCode = StatusCodes.Status429TooManyRequests;
 3188
 0189    if (registerIngressRateLimitingPolicies)
 3190    {
 0191        options.AddFixedWindowLimiter(elsaApiRateLimitingPolicy, limiterOptions =>
 0192        {
 0193            limiterOptions.PermitLimit = ingressRateLimitingSection.GetValue("ApiPermitLimit", 120);
 0194            limiterOptions.Window = TimeSpan.FromSeconds(ingressRateLimitingSection.GetValue("ApiWindowSeconds", 60));
 0195            limiterOptions.QueueProcessingOrder = QueueProcessingOrder.OldestFirst;
 0196            limiterOptions.QueueLimit = ingressRateLimitingSection.GetValue("ApiQueueLimit", 0);
 0197        });
 0198        options.AddFixedWindowLimiter(httpWorkflowRateLimitingPolicy, limiterOptions =>
 0199        {
 0200            limiterOptions.PermitLimit = ingressRateLimitingSection.GetValue("HttpWorkflowPermitLimit", 60);
 0201            limiterOptions.Window = TimeSpan.FromSeconds(ingressRateLimitingSection.GetValue("HttpWorkflowWindowSeconds"
 0202            limiterOptions.QueueProcessingOrder = QueueProcessingOrder.OldestFirst;
 0203            limiterOptions.QueueLimit = ingressRateLimitingSection.GetValue("HttpWorkflowQueueLimit", 0);
 0204        });
 3205    }
 3206});
 3207services
 3208    .AddHealthChecks()
 3209    .AddElsaReadinessChecks(includeDistributedLocks: true);
 3210services.AddControllers();
 9211services.AddCors(cors => cors.AddDefaultPolicy(policy => policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin().WithE
 212
 213// Build the web application.
 3214var app = builder.Build();
 215
 216
 217// Configure the pipeline.
 3218if (app.Environment.IsDevelopment())
 3219    app.UseDeveloperExceptionPage();
 220
 221// CORS.
 3222app.UseCors();
 223
 224// Health checks.
 3225app.MapHealthChecks("/health/live", new()
 3226{
 0227    Predicate = _ => false
 3228});
 3229app.MapHealthChecks("/health/ready", new()
 3230{
 0231    Predicate = check => check.Tags.Contains(HealthCheckExtensions.ElsaTag) && check.Tags.Contains(HealthCheckExtensions
 3232    ResultStatusCodes =
 3233    {
 3234        [HealthStatus.Degraded] = StatusCodes.Status503ServiceUnavailable,
 3235        [HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable
 3236    }
 3237});
 3238app.MapHealthChecks("/", new()
 3239{
 0240    Predicate = _ => false
 3241});
 242
 243// Elsa API endpoints for designer.
 3244var apiEndpointOptions = app.Services.GetRequiredService<IOptions<ApiEndpointOptions>>().Value;
 3245var routePrefix = apiEndpointOptions.RoutePrefix;
 3246app.MapWorkflowsApi(routePrefix);
 247
 248// Routing used for SignalR.
 3249app.UseRouting();
 250
 3251app.UseWorkflowsApiRateLimiting(routePrefix, apiEndpointOptions.RateLimitingPolicyName);
 252
 253// Elsa HTTP Endpoint activities.
 3254var httpActivityOptions = app.Services.GetRequiredService<IOptions<HttpActivityOptions>>().Value;
 3255app.UseWorkflowsRateLimiting(httpActivityOptions.BasePath, httpActivityOptions.RateLimitingPolicyName);
 3256if (useIngressRateLimiting ||
 3257    !string.IsNullOrWhiteSpace(apiEndpointOptions.RateLimitingPolicyName) ||
 3258    !string.IsNullOrWhiteSpace(httpActivityOptions.RateLimitingPolicyName))
 0259    app.UseRateLimiter();
 260
 261// Security.
 3262app.UseAuthentication();
 3263app.UseAuthorization();
 264
 265// Multitenancy.
 266if (useMultitenancy)
 3267    app.UseTenants();
 268
 269// Captures unhandled exceptions and returns a JSON response.
 3270app.UseJsonSerializationErrorHandler();
 271
 3272app.UseWorkflows();
 273
 3274app.MapControllers();
 275
 276// Swagger API documentation.
 3277if (app.Environment.IsDevelopment())
 278{
 3279    app.UseSwaggerUI();
 280}
 281
 282// SignalR.
 283if (useSignalR)
 284{
 285    app.UseWorkflowsSignalRHubs();
 286}
 287
 288// Structured log streaming for Studio diagnostics.
 289if (useStructuredLogs)
 290{
 291    app.UseStructuredLogs();
 292}
 293
 294// Run.
 3295await app.RunAsync();
 296
 297/// <summary>
 298/// The main entry point for the application made public for end to end testing.
 299/// </summary>
 300[UsedImplicitly]
 301public partial class Program
 302{
 303    /// <summary>
 304    /// Set by the test runner to configure the module for testing.
 305    /// </summary>
 7306    public static Action<IModule>? ConfigureForTest { get; set; }
 307}

Methods/Properties

<Main>$()
get_ConfigureForTest()