feat(m9/T32c): schema-library CRUD commands + handlers + Central UI page + read-accessor
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,165 @@
|
||||
using System.Security.Claims;
|
||||
using System.Text.Json;
|
||||
using Akka.Actor;
|
||||
using Microsoft.AspNetCore.Components.Authorization;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Schemas;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
||||
using ZB.MOM.WW.ScadaBridge.ManagementService;
|
||||
using ZB.MOM.WW.ScadaBridge.Security;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Default <see cref="ISchemaLibraryService"/> implementation — a thin facade that
|
||||
/// dispatches the schema-library CRUD commands to the central <c>ManagementActor</c>
|
||||
/// through the in-process <see cref="ManagementActorHolder"/> (the same Ask seam the
|
||||
/// HTTP <c>/management</c> endpoint uses). The actor authorizes the command against the
|
||||
/// supplied <see cref="AuthenticatedUser"/> (Designer-gated mutations), enforces the
|
||||
/// unique-name guard, validates the JSON Schema, and writes the audit row — none of
|
||||
/// that is re-implemented here. Mirrors <see cref="SecuredWriteService"/> /
|
||||
/// <see cref="DataConnectionMoveService"/>.
|
||||
/// </summary>
|
||||
public sealed class SchemaLibraryService : ISchemaLibraryService
|
||||
{
|
||||
/// <summary>
|
||||
/// camelCase + case-insensitive, matching <c>ManagementActor.SerializeResult</c>'s
|
||||
/// options. <see cref="ManagementSuccess.JsonData"/> is produced with those settings,
|
||||
/// so the deserializer must mirror them to bind every property.
|
||||
/// </summary>
|
||||
private static readonly JsonSerializerOptions ResultDeserializerOptions = new()
|
||||
{
|
||||
PropertyNameCaseInsensitive = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
};
|
||||
|
||||
private static readonly TimeSpan AskTimeout = TimeSpan.FromSeconds(30);
|
||||
|
||||
private readonly ManagementActorHolder _holder;
|
||||
private readonly AuthenticationStateProvider _auth;
|
||||
private readonly ILogger<SchemaLibraryService> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="SchemaLibraryService"/>.
|
||||
/// </summary>
|
||||
/// <param name="holder">Holder for the central <c>ManagementActor</c> reference.</param>
|
||||
/// <param name="auth">Authentication state provider used to project the current principal.</param>
|
||||
/// <param name="logger">Logger instance.</param>
|
||||
public SchemaLibraryService(
|
||||
ManagementActorHolder holder,
|
||||
AuthenticationStateProvider auth,
|
||||
ILogger<SchemaLibraryService> logger)
|
||||
{
|
||||
_holder = holder ?? throw new ArgumentNullException(nameof(holder));
|
||||
_auth = auth ?? throw new ArgumentNullException(nameof(auth));
|
||||
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public async Task<IReadOnlyList<SharedSchema>> ListAsync(CancellationToken cancellationToken = default)
|
||||
{
|
||||
var response = await SendAsync(new ListSharedSchemasCommand(), cancellationToken);
|
||||
if (response is ManagementSuccess success)
|
||||
{
|
||||
var items = JsonSerializer.Deserialize<List<SharedSchema>>(
|
||||
success.JsonData, ResultDeserializerOptions);
|
||||
return items ?? new List<SharedSchema>();
|
||||
}
|
||||
|
||||
// Read path: log + return empty so the list table renders gracefully.
|
||||
_logger.LogWarning("ListSharedSchemas failed: {Response}", DescribeFailure(response));
|
||||
return Array.Empty<SharedSchema>();
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public Task<SchemaLibraryActionResult> CreateAsync(
|
||||
string name, string? scope, string schemaJson, CancellationToken cancellationToken = default)
|
||||
=> DispatchAsync(new CreateSharedSchemaCommand(name, scope, schemaJson), cancellationToken);
|
||||
|
||||
/// <inheritdoc/>
|
||||
public Task<SchemaLibraryActionResult> UpdateAsync(
|
||||
int id, string name, string? scope, string schemaJson, CancellationToken cancellationToken = default)
|
||||
=> DispatchAsync(new UpdateSharedSchemaCommand(id, name, scope, schemaJson), cancellationToken);
|
||||
|
||||
/// <inheritdoc/>
|
||||
public Task<SchemaLibraryActionResult> DeleteAsync(int id, CancellationToken cancellationToken = default)
|
||||
=> DispatchAsync(new DeleteSharedSchemaCommand(id), cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Dispatches a single mutating command and maps the response (or any fault) to a
|
||||
/// typed <see cref="SchemaLibraryActionResult"/>.
|
||||
/// </summary>
|
||||
private async Task<SchemaLibraryActionResult> DispatchAsync(
|
||||
object command, CancellationToken cancellationToken)
|
||||
{
|
||||
var response = await SendAsync(command, cancellationToken);
|
||||
return response switch
|
||||
{
|
||||
ManagementSuccess => SchemaLibraryActionResult.Ok(),
|
||||
ManagementUnauthorized unauthorized => SchemaLibraryActionResult.Fail(unauthorized.Message),
|
||||
ManagementError error => SchemaLibraryActionResult.Fail(error.Error),
|
||||
_ => SchemaLibraryActionResult.Fail(DescribeFailure(response)),
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Wraps <paramref name="command"/> in a <see cref="ManagementEnvelope"/> for the
|
||||
/// current principal and Asks the <c>ManagementActor</c>. Transport faults (timeout,
|
||||
/// actor not yet started, cancellation→propagated) become a synthetic
|
||||
/// <see cref="ManagementError"/> so callers handle one response shape.
|
||||
/// </summary>
|
||||
private async Task<object> SendAsync(object command, CancellationToken cancellationToken)
|
||||
{
|
||||
var actor = _holder.ActorRef;
|
||||
if (actor is null)
|
||||
{
|
||||
return new ManagementError(
|
||||
string.Empty, "Management service is not ready.", "SERVICE_UNAVAILABLE");
|
||||
}
|
||||
|
||||
var user = await BuildAuthenticatedUserAsync();
|
||||
var envelope = new ManagementEnvelope(user, command, Guid.NewGuid().ToString("N"));
|
||||
|
||||
try
|
||||
{
|
||||
return await actor.Ask<object>(envelope, AskTimeout, cancellationToken);
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
// Caller-initiated cancel (e.g. circuit teardown) — propagate cleanly.
|
||||
throw;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "ManagementActor Ask failed for {Command}", command.GetType().Name);
|
||||
return new ManagementError(string.Empty, ex.Message, "TRANSPORT_ERROR");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Projects the current Blazor <see cref="ClaimsPrincipal"/> to the
|
||||
/// <see cref="AuthenticatedUser"/> the actor authorizes against — username,
|
||||
/// display name, role claims, and the permitted-site scope claims (mirrors the
|
||||
/// claim set the HTTP endpoint constructs).
|
||||
/// </summary>
|
||||
private async Task<AuthenticatedUser> BuildAuthenticatedUserAsync()
|
||||
{
|
||||
var state = await _auth.GetAuthenticationStateAsync();
|
||||
var principal = state.User;
|
||||
|
||||
var username = principal.FindFirst(JwtTokenService.UsernameClaimType)?.Value ?? "unknown";
|
||||
var displayName = principal.FindFirst(JwtTokenService.DisplayNameClaimType)?.Value ?? username;
|
||||
var roles = principal.FindAll(JwtTokenService.RoleClaimType).Select(c => c.Value).ToArray();
|
||||
var permittedSiteIds = principal.FindAll(JwtTokenService.SiteIdClaimType).Select(c => c.Value).ToArray();
|
||||
|
||||
return new AuthenticatedUser(username, displayName, roles, permittedSiteIds);
|
||||
}
|
||||
|
||||
/// <summary>Renders a fallback description for an unexpected/failure response.</summary>
|
||||
private static string DescribeFailure(object response) => response switch
|
||||
{
|
||||
ManagementUnauthorized unauthorized => unauthorized.Message,
|
||||
ManagementError error => error.Error,
|
||||
_ => "Unexpected response from the management service.",
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user