elsa-core/src/modules/Elsa.Expressions.JavaScript/Features/JavaScriptFeature.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

103 lines
3.7 KiB
C#

using Elsa.Caching.Features;
using Elsa.Expressions.Options;
using Elsa.Common.Features;
using Elsa.Expressions.Features;
using Elsa.Extensions;
using Elsa.Features.Abstractions;
using Elsa.Features.Attributes;
using Elsa.Features.Services;
using Elsa.Expressions.JavaScript.Activities;
using Elsa.Expressions.JavaScript.Contracts;
using Elsa.Expressions.JavaScript.Extensions;
using Elsa.Expressions.JavaScript.HostedServices;
using Elsa.Expressions.JavaScript.Options;
using Elsa.Expressions.JavaScript.Providers;
using Elsa.Expressions.JavaScript.Services;
using Elsa.Expressions.JavaScript.TypeDefinitions.Contracts;
using Elsa.Expressions.JavaScript.TypeDefinitions.Services;
using Elsa.Workflows;
using Elsa.Workflows.Options;
using Microsoft.Extensions.DependencyInjection;
using Elsa.Common.Serialization;
namespace Elsa.Expressions.JavaScript.Features;
/// <summary>
/// Installs JavaScript integration.
/// </summary>
[DependsOn(typeof(MediatorFeature))]
[DependsOn(typeof(ExpressionsFeature))]
[DependsOn(typeof(MemoryCacheFeature))]
public class JavaScriptFeature : FeatureBase
{
/// <inheritdoc />
public JavaScriptFeature(IModule module) : base(module)
{
}
/// <summary>
/// Configures the Jint options.
/// </summary>
private Action<JintOptions> JintOptions { get; set; } = _ => { };
public JavaScriptFeature ConfigureJintOptions(Action<JintOptions> configure)
{
JintOptions += configure;
return this;
}
/// <inheritdoc />
public override void ConfigureHostedServices()
{
ConfigureHostedService<RegisterVariableTypesWithJavaScriptHostedService>();
}
/// <inheritdoc />
public override void Configure()
{
Module.AddFastEndpointsAssembly<JavaScriptFeature>();
}
/// <inheritdoc />
public override void Apply()
{
Services.Configure(JintOptions);
Services.Configure<ExpressionOptions>(JavaScriptExceptionTypeAliasRegistrar.Register);
Services.Configure<SerializationTypeOptions>(JavaScriptExceptionTypeAliasRegistrar.Register);
// JavaScript services.
Services
.AddScoped<IJavaScriptEvaluator, JintJavaScriptEvaluator>()
.AddScoped<ITypeDefinitionService, TypeDefinitionService>()
.AddExpressionDescriptorProvider<JavaScriptExpressionDescriptorProvider>()
;
// Type definition services.
Services
.AddScoped<ITypeDefinitionService, TypeDefinitionService>()
.AddScoped<ITypeDescriber, TypeDescriber>()
.AddScoped<ITypeDefinitionDocumentRenderer, TypeDefinitionDocumentRenderer>()
.AddSingleton<ITypeAliasRegistry, Services.TypeAliasRegistry>()
.AddFunctionDefinitionProvider<CommonFunctionsDefinitionProvider>()
.AddFunctionDefinitionProvider<ActivityOutputFunctionsDefinitionProvider>()
.AddFunctionDefinitionProvider<RunJavaScriptFunctionsDefinitionProvider>()
.AddTypeDefinitionProvider<CommonTypeDefinitionProvider>()
.AddTypeDefinitionProvider<VariableTypeDefinitionProvider>()
.AddTypeDefinitionProvider<WorkflowVariablesTypeDefinitionProvider>()
.AddVariableDefinitionProvider<WorkflowVariablesVariableProvider>()
;
// Handlers.
Services.AddNotificationHandlersFrom<JavaScriptFeature>();
// Activities.
Module.UseWorkflowManagement(management => management.AddActivity<RunJavaScript>());
// Type Script definitions.
Services.AddFunctionDefinitionProvider<InputFunctionsDefinitionProvider>();
// UI property handlers.
Services.AddScoped<IPropertyUIHandler, RunJavaScriptOptionsProvider>();
}
}