elsa-core/test/unit/Elsa.Workflows.Management.UnitTests/Mappers/VariableDefinitionMapperTests.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

84 lines
3.2 KiB
C#

using Elsa.Extensions;
using Elsa.Workflows.Management.Mappers;
using Elsa.Workflows.Memory;
using Elsa.Workflows.Models;
using Elsa.Workflows.Options;
using Elsa.Workflows.Services;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging.Abstractions;
using NSubstitute;
using Elsa.Common.Serialization;
namespace Elsa.Workflows.Management.UnitTests.Mappers;
public class VariableDefinitionMapperTests
{
private readonly IServiceScopeFactory _scopeFactory = Substitute.For<IServiceScopeFactory>();
private readonly SerializationTypeOptions _workflowJsonTypeOptions = new();
private readonly VariableDefinitionMapper _mapper;
public VariableDefinitionMapperTests()
{
_workflowJsonTypeOptions.RegisterTypeAlias(typeof(string), "String");
_workflowJsonTypeOptions.RegisterTypeAlias(typeof(MemoryStorageDriver), nameof(MemoryStorageDriver));
_mapper = CreateMapper(_workflowJsonTypeOptions);
}
[Fact]
public void Map_DoesNotResolveUnregisteredClrTypeName()
{
var definition = new VariableDefinition("id", "payload", typeof(UnregisteredPayload).GetSimpleAssemblyQualifiedName(), false, null, null);
var variable = _mapper.Map(definition);
Assert.Null(variable);
}
[Fact]
public void Map_ResolvesRegisteredLegacyClrTypeName()
{
var workflowJsonTypeOptions = new SerializationTypeOptions();
workflowJsonTypeOptions.RegisterTypeAlias(typeof(UnregisteredPayload), nameof(UnregisteredPayload));
workflowJsonTypeOptions.RegisterLegacySimpleAssemblyQualifiedName(typeof(UnregisteredPayload));
var mapper = CreateMapper(workflowJsonTypeOptions);
var definition = new VariableDefinition("id", "payload", typeof(UnregisteredPayload).GetSimpleAssemblyQualifiedName(), false, null, null);
var variable = mapper.Map(definition);
Assert.IsType<Variable<UnregisteredPayload>>(variable);
}
[Fact]
public void Map_WritesUnregisteredVariableTypeAsClrTypeName()
{
var variable = new Variable<UnregisteredPayload>("payload", new());
var definition = _mapper.Map(variable);
Assert.Equal(typeof(UnregisteredPayload).GetSimpleAssemblyQualifiedName(), definition.TypeName);
}
[Fact]
public void Map_WritesRegisteredVariableTypeAsAlias()
{
var workflowJsonTypeOptions = new SerializationTypeOptions();
workflowJsonTypeOptions.RegisterTypeAlias(typeof(UnregisteredPayload), nameof(UnregisteredPayload));
var mapper = CreateMapper(workflowJsonTypeOptions);
var variable = new Variable<UnregisteredPayload>("payload", new());
var definition = mapper.Map(variable);
Assert.Equal(nameof(UnregisteredPayload), definition.TypeName);
}
private VariableDefinitionMapper CreateMapper(SerializationTypeOptions workflowJsonTypeOptions)
{
var workflowJsonTypeRegistry = new SerializationTypeRegistry(Microsoft.Extensions.Options.Options.Create(workflowJsonTypeOptions));
return new(workflowJsonTypeRegistry, _scopeFactory, NullLogger<VariableDefinitionMapper>.Instance);
}
private sealed class UnregisteredPayload
{
}
}