Skip to content

trellis-api-mediator-fluentvalidation.md

Latest commit

 

History

History
135 lines (98 loc) · 9.83 KB

trellis-api-mediator-fluentvalidation.md

File metadata and controls

135 lines (98 loc) · 9.83 KB

package: Trellis.Mediator.FluentValidation namespaces: [Trellis.Mediator.FluentValidation] types: [FluentValidationServiceCollectionExtensions, FluentValidationMessageValidatorAdapter] version: v3 last_verified: 2026-06-04 audience: [llm]

Trellis.Mediator.FluentValidation — API Reference

Header

  • Package: Trellis.Mediator.FluentValidation
  • Namespace: Trellis.Mediator.FluentValidation
  • Purpose: Plugs FluentValidation validators into the Trellis Mediator validation stage. Provides one DI extension class and one open-generic IMessageValidator<TMessage> adapter; no additional pipeline behavior is added.
  • Depends on: Trellis.Mediator (for IMessageValidator<TMessage> and the IMessage constraint) and Trellis.FluentValidation (for JsonPointerNormalizer and the standalone Result<T> helpers).

Why this is a separate package. Trellis.FluentValidation carries the Mediator-agnostic helpers — the ValidationResult → Result<T> extensions and the JsonPointerNormalizer. The Mediator-specific bits (the adapter and its DI extension) live here so an application that only wants the standalone helpers does not pull in Trellis.Mediator. The adapter's behavior, idempotency guarantees, and AOT/trim contract are unchanged from prior versions; only the package and namespace moved.

See also: trellis-api-cookbook.md — recipes using this package.

Use this file when

  • You want FluentValidation validators to run inside the Trellis Mediator validation behavior.
  • You need to register validators by assembly scanning (non-AOT) or explicitly (AOT/trim-safe).
  • You need the wire-up rules for combining FluentValidation failures with IValidate.Validate() failures into a single Error.InvalidInput.

Patterns Index

Goal Canonical API / pattern See
Add the FluentValidation adapter without scanning services.AddTrellisFluentValidation() plus explicit IValidator<T> registrations FluentValidationServiceCollectionExtensions
Add the adapter and scan assemblies services.AddTrellisFluentValidation(typeof(SomeType).Assembly) FluentValidationServiceCollectionExtensions
Keep AOT/trim safety Use the parameterless adapter overload and register validators explicitly FluentValidationServiceCollectionExtensions
Understand nested/indexed field paths FluentValidation names are normalized to RFC 6901 JSON Pointers via JsonPointerNormalizer Pointer normalization

Common traps

  • AddTrellisFluentValidation() does not add a second mediator pipeline behavior; it registers IMessageValidator<TMessage> so the existing ValidationBehavior can aggregate failures.
  • The assembly-scanning overload is intentionally not AOT/trim-safe. Use explicit registrations for AOT-sensitive apps.
  • Keep primitive-to-value-object parsing at the transport seam; validators should normally validate already-shaped command/value-object inputs.
  • The diagnostic log category emitted by the scanning overload is still "Trellis.FluentValidation" so existing logging filters continue to work after the package split.

Types

FluentValidationServiceCollectionExtensions

Declaration

public static class FluentValidationServiceCollectionExtensions

Methods

Signature Returns Description
public static IServiceCollection AddTrellisFluentValidation(this IServiceCollection services) IServiceCollection Registers FluentValidationMessageValidatorAdapter<TMessage> as the open-generic IMessageValidator<TMessage> implementation. Every IValidator<T> registered for the message in DI then runs inside the existing ValidationBehavior<TMessage,TResponse> and contributes its failures to an aggregated Error.InvalidInput. AOT/trim-safe; uses open-generic DI registration with no reflection. Idempotent — repeated calls do not duplicate the adapter. Throws ArgumentNullException when services is null. Validators must be registered explicitly (e.g., services.AddScoped<IValidator<CreateOrderCommand>, CreateOrderCommandValidator>()).
public static IServiceCollection AddTrellisFluentValidation(this IServiceCollection services, params Assembly[] assemblies) IServiceCollection Calls the parameterless overload, then scans the supplied assemblies for concrete IValidator<T> implementations and registers each as a scoped service. Not AOT or trim-compatible — annotated [RequiresUnreferencedCode] and [RequiresDynamicCode]. Skips abstract/interface/open-generic types. Deduplicates so repeated calls (or overlapping assemblies) do not register the same validator twice. Throws ArgumentNullException for null services/assemblies, and ArgumentException when assemblies is empty or contains a null element. Tolerates ReflectionTypeLoadException by using only loadable types and emits a single Warning per affected assembly via ILoggerFactory (when one is registered). The diagnostic log category remains "Trellis.FluentValidation" for log-filter compatibility.

FluentValidationMessageValidatorAdapter<TMessage>

Declaration

public sealed class FluentValidationMessageValidatorAdapter<TMessage>
    : IMessageValidator<TMessage>
    where TMessage : Mediator.IMessage
{
    // Throws ArgumentNullException when validators is null.
    public FluentValidationMessageValidatorAdapter(IEnumerable<IValidator<TMessage>> validators);
}

Methods

Signature Returns Description
public ValueTask<IResult> ValidateAsync(TMessage message, CancellationToken cancellationToken) ValueTask<IResult> Runs every injected IValidator<TMessage> against message. Returns Result.Ok() when all validators pass (or none are registered — the empty injected sequence allocates no violations). Otherwise aggregates every ValidationFailure into a single new Error.InvalidInput(EquatableArray.Create(violations)), where violations is the collected FieldViolation set. Each FluentValidation failure becomes a FieldViolation(new InputPointer(pointerPath), reasonCode) { Detail = failure.ErrorMessage }. pointerPath is derived by JsonPointerNormalizer.ToJsonPointer from the FV property name; reasonCode defaults to "validation.error" when failure.ErrorCode is null/whitespace. Root-level failures (whitespace PropertyName) use typeof(TMessage).Name.

Pointer normalization (RFC 6901)

FluentValidation property names are converted to JSON Pointers via JsonPointerNormalizer so they round-trip through InputPointer:

FluentValidation PropertyName Resulting InputPointer.RawValue
Email /email
Address.PostCode /address/postCode
Items[0].Sku /items/0/sku

Dotted FluentValidation paths split into separate JSON-pointer segments; bracketed indexers become numeric segments. Other producers (e.g., the ASP integration) build InputPointer values directly via InputPointer.ForProperty(...), which does not split on ., so the normalizer is FluentValidation-specific.

Behavioral notes

  • FluentValidation does not add an additional pipeline behavior. It plugs into the existing ValidationBehavior<TMessage,TResponse> via the open-generic IMessageValidator<TMessage> extension point.
  • The adapter is registered scoped, matching the typical scoped lifetime of FluentValidation validators.
  • When no IValidator<TMessage> is registered for a message type, IEnumerable<IValidator<TMessage>> is empty, the adapter returns Result.Ok(), and no allocations are performed.
  • All validators are awaited sequentially; failures from every validator are aggregated into a single Error.InvalidInput rather than short-circuiting on the first failure.
  • The adapter forwards the ambient CancellationToken to validator.ValidateAsync.
  • AddTrellisFluentValidation() is idempotent — calling it multiple times (directly, or via the scanning overload) only registers the open-generic adapter once.
  • The assembly-scan overload deduplicates (serviceType, implementationType) pairs against existing registrations, so calling it twice with overlapping assemblies will not register a validator more than once.

Code examples

Wire FluentValidation into the Mediator pipeline (AOT-safe)

using FluentValidation;
using Microsoft.Extensions.DependencyInjection;
using Trellis.Mediator;
using Trellis.Mediator.FluentValidation;

services.AddTrellisBehaviors();
services.AddTrellisFluentValidation();

// Register validators explicitly so the call site is AOT/trim-friendly.
services.AddScoped<IValidator<CreateOrderCommand>, CreateOrderCommandValidator>();
services.AddScoped<IValidator<UpdateOrderCommand>, UpdateOrderCommandValidator>();

Wire FluentValidation with assembly scanning (not AOT-compatible)

using Trellis.Mediator.FluentValidation;

services.AddTrellisBehaviors();
services.AddTrellisFluentValidation(typeof(CreateOrderCommandValidator).Assembly);

Cross-references