elsa-core/src/modules/Elsa.Alterations/ShellFeatures/AlterationsFeature.cs
Sipke Schoorstra c2fb027c41
Refactor: Overhauls workflow JSON type serialization (#7549)
* Avoid null endpoint DTO metadata in tests

* Enforce console logs hub read permission

* Remove unused console logs hub import

* Support mapped endpoint metadata in auth tests

* Reduce console log capture throughput impact

* Address Copilot console logs review

* Refactor task scheduling to support tenant-level background work and enhance logging functionality.

* Introduce ConsoleStreamHook for stdout/stderr tee and enhance logging validation. Adjust test cases and startup warnings for distributed lock provider usage.

* Refactor console logging pipeline with capture optimization and new ConsoleLogsHost; update tests accordingly.

* Add Ansi SGR parser for console logs and associated unit tests

* Remove ANSI color renderings and parsers; integrate ConsoleLogScopeAccessor for improved logging context with workflow instance ID support.

* Address console logs code quality feedback

* Address PR review feedback

* Preserve console logs extension points

* Stabilize console logs host lifecycle

* Address final automated review comments

* Tighten console log capture shutdown

* Address console log review feedback

* Address follow-up review feedback

* Cover final review feedback

* Avoid recursive console provider initialization

* Guard console host lease shutdown

* Preserve console log scope and provider lifetime

* Correlate console log scope fallback

* Tighten console scope correlation

* Expose host services during provider construction

* Redact ANSI-normalized console lines

* Remove `ConsoleCaptureTee` and related services and tests

* Use pipeline contributors for console log context

* Update CShells package versions to 0.0.24-preview.132

* Filter live console logs by workflow instance

* Enhance console logging with activity execution metadata and extend test coverage.

* Address console logs stream consumption comment

* Add diagnostics OpenTelemetry backend

* Introduce dedicated workflow JSON type registry and hardening

This change addresses GitHub issue #7541 by establishing a separate type registry (`IWorkflowJsonTypeRegistry`) for workflow JSON serialization. This decouples workflow type resolution from expression type aliases, enforcing a strict trust boundary.

Key aspects:
- New workflow JSON emits preferred aliases for registered types.
- Existing persisted workflows can be loaded via registered legacy names.
- Unknown, abstract, interface, open generic, or inappropriate collection types are rejected during deserialization, enhancing security.
- Public APIs (e.g., incident strategies) now expose consistent workflow JSON type identifiers.

This ensures secure, predictable, and backward-compatible handling of types within workflow definitions and payloads.

* Remove unused project references and streamline console log endpoint

* Move serialization type aliases to Elsa.Common

* Update serialization integration fixtures for aliases

* Stabilize missing rate limiter policy test
2026-05-31 11:09:39 +02:00

70 lines
2.8 KiB
C#

using CShells.FastEndpoints.Features;
using CShells.Features;
using Elsa.Alterations.Core.Contracts;
using Elsa.Alterations.Core.Entities;
using Elsa.Alterations.Core.Extensions;
using Elsa.Alterations.Core.Models;
using Elsa.Alterations.Core.Stores;
using Elsa.Alterations.Extensions;
using Elsa.Alterations.Services;
using Elsa.Alterations.Workflows;
using Elsa.Extensions;
using Elsa.Workflows.Options;
using JetBrains.Annotations;
using Microsoft.Extensions.DependencyInjection;
using Elsa.Common.Serialization;
namespace Elsa.Alterations.ShellFeatures;
/// <summary>
/// Adds the Elsa alterations services.
/// </summary>
[ShellFeature(
DisplayName = "Alterations",
Description = "Provides workflow alteration capabilities for modifying running workflow instances",
DependsOn = ["ElsaFastEndpoints", "WorkflowRuntime"])]
[UsedImplicitly]
public class AlterationsFeature : IFastEndpointsShellFeature
{
/// <summary>
/// Gets or sets the factory for the alteration plan store.
/// </summary>
public Func<IServiceProvider, IAlterationPlanStore> AlterationPlanStoreFactory { get; set; } = sp => sp.GetRequiredService<MemoryAlterationPlanStore>();
/// <summary>
/// Gets or sets the factory for the alteration job store.
/// </summary>
public Func<IServiceProvider, IAlterationJobStore> AlterationJobStoreFactory { get; set; } = sp => sp.GetRequiredService<MemoryAlterationJobStore>();
/// <summary>
/// Gets or sets the factory for the alteration job dispatcher.
/// </summary>
public Func<IServiceProvider, IAlterationJobDispatcher> AlterationJobDispatcherFactory { get; set; } = sp => sp.GetRequiredService<BackgroundAlterationJobDispatcher>();
public void ConfigureServices(IServiceCollection services)
{
services.Configure<SerializationTypeOptions>(options =>
{
options.RegisterTypeAlias(typeof(AlterationPlanParams), nameof(AlterationPlanParams));
options.RegisterLegacySimpleAssemblyQualifiedName(typeof(AlterationPlanParams));
});
services.AddScoped<IAlterationPlanManager, AlterationPlanManager>();
services.AddAlterations();
services.AddAlterationsCore();
services.AddScoped<BackgroundAlterationJobDispatcher>();
services.AddScoped<IAlterationPlanScheduler, DefaultAlterationPlanScheduler>();
services.AddScoped<IAlterationJobRunner, DefaultAlterationJobRunner>();
services.AddScoped<IAlterationRunner, DefaultAlterationRunner>();
services.AddMemoryStore<AlterationPlan, MemoryAlterationPlanStore>();
services.AddMemoryStore<AlterationJob, MemoryAlterationJobStore>();
services.AddScoped(AlterationPlanStoreFactory);
services.AddScoped(AlterationJobStoreFactory);
services.AddScoped(AlterationJobDispatcherFactory);
services.AddWorkflow<ExecuteAlterationPlanWorkflow>();
}
}