Closes the Phase 6.1 Stream A.2 "per-instance overrides bound from DriverInstance.ResilienceConfig JSON column" work flagged as a follow-up when Stream A.1 shipped in PR #78. Every driver can now override its Polly pipeline policy per instance instead of inheriting pure tier defaults. Configuration: - DriverInstance entity gains a nullable `ResilienceConfig` string column (nvarchar(max)) + SQL check constraint `CK_DriverInstance_ResilienceConfig_IsJson` that enforces ISJSON when not null. Null = use tier defaults (decision #143 / unchanged from pre-Phase-6.1). - EF migration `20260419161008_AddDriverInstanceResilienceConfig`. - SchemaComplianceTests expected-constraint list gains the new CK name. Core.Resilience.DriverResilienceOptionsParser: - Pure-function parser. ParseOrDefaults(tier, json, out diag) returns the effective DriverResilienceOptions — tier defaults with per-capability / bulkhead overrides layered on top when the JSON payload supplies them. Partial policies (e.g. Read { retryCount: 10 }) fill missing fields from the tier default for that capability. - Malformed JSON falls back to pure tier defaults + surfaces a human-readable diagnostic via the out parameter. Callers log the diag but don't fail startup — a misconfigured ResilienceConfig must not brick a working driver. - Property names + capability keys are case-insensitive; unrecognised capability names are logged-and-skipped; unrecognised shape-level keys are ignored so future shapes land without a migration. Server wire-in: - OtOpcUaServer gains two optional ctor params: `tierLookup` (driverType → DriverTier) + `resilienceConfigLookup` (driverInstanceId → JSON string). CreateMasterNodeManager now resolves tier + JSON for each driver, parses via DriverResilienceOptionsParser, logs the diagnostic if any, and constructs CapabilityInvoker with the merged options instead of pure Tier A defaults. - OpcUaApplicationHost threads both lookups through. Default null keeps existing tests constructing without either Func unchanged (falls back to Tier A + tier defaults exactly as before). Tests (13 new DriverResilienceOptionsParserTests): - null / whitespace / empty-object JSON returns pure tier defaults. - Malformed JSON falls back + surfaces diagnostic. - Read override merged into tier defaults; other capabilities untouched. - Partial policy fills missing fields from tier default. - Bulkhead overrides honored. - Unknown capability skipped + surfaced in diagnostic. - Property names + capability keys are case-insensitive. - Every tier × every capability × empty-JSON round-trips tier defaults exactly (theory). Full solution dotnet test: 1215 passing (was 1202, +13). Pre-existing Client.CLI Subscribe flake unchanged. Production wiring (Program.cs) example: Func<string, DriverTier> tierLookup = type => type switch { "Galaxy" => DriverTier.C, "Modbus" or "S7" => DriverTier.B, "OpcUaClient" => DriverTier.A, _ => DriverTier.A, }; Func<string, string?> cfgLookup = id => db.DriverInstances.AsNoTracking().FirstOrDefault(x => x.DriverInstanceId == id)?.ResilienceConfig; var host = new OpcUaApplicationHost(..., tierLookup: tierLookup, resilienceConfigLookup: cfgLookup); Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
154 lines
6.7 KiB
C#
154 lines
6.7 KiB
C#
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging;
|
|
using Opc.Ua;
|
|
using Opc.Ua.Server;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Hosting;
|
|
using ZB.MOM.WW.OtOpcUa.Core.OpcUa;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Resilience;
|
|
using ZB.MOM.WW.OtOpcUa.Server.Security;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Server.OpcUa;
|
|
|
|
/// <summary>
|
|
/// <see cref="StandardServer"/> subclass that wires one <see cref="DriverNodeManager"/> per
|
|
/// registered driver from <see cref="DriverHost"/>. Anonymous endpoint on
|
|
/// <c>opc.tcp://0.0.0.0:4840</c>, no security — PR 16 minimum-viable scope; LDAP + security
|
|
/// profiles are deferred to their own PR on top of this.
|
|
/// </summary>
|
|
public sealed class OtOpcUaServer : StandardServer
|
|
{
|
|
private readonly DriverHost _driverHost;
|
|
private readonly IUserAuthenticator _authenticator;
|
|
private readonly DriverResiliencePipelineBuilder _pipelineBuilder;
|
|
private readonly AuthorizationGate? _authzGate;
|
|
private readonly NodeScopeResolver? _scopeResolver;
|
|
private readonly Func<string, DriverTier>? _tierLookup;
|
|
private readonly Func<string, string?>? _resilienceConfigLookup;
|
|
private readonly ILoggerFactory _loggerFactory;
|
|
private readonly List<DriverNodeManager> _driverNodeManagers = new();
|
|
|
|
public OtOpcUaServer(
|
|
DriverHost driverHost,
|
|
IUserAuthenticator authenticator,
|
|
DriverResiliencePipelineBuilder pipelineBuilder,
|
|
ILoggerFactory loggerFactory,
|
|
AuthorizationGate? authzGate = null,
|
|
NodeScopeResolver? scopeResolver = null,
|
|
Func<string, DriverTier>? tierLookup = null,
|
|
Func<string, string?>? resilienceConfigLookup = null)
|
|
{
|
|
_driverHost = driverHost;
|
|
_authenticator = authenticator;
|
|
_pipelineBuilder = pipelineBuilder;
|
|
_authzGate = authzGate;
|
|
_scopeResolver = scopeResolver;
|
|
_tierLookup = tierLookup;
|
|
_resilienceConfigLookup = resilienceConfigLookup;
|
|
_loggerFactory = loggerFactory;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Read-only snapshot of the driver node managers materialized at server start. Used by
|
|
/// the generic-driver-node-manager-driven discovery flow after the server starts — the
|
|
/// host walks each entry and invokes
|
|
/// <c>GenericDriverNodeManager.BuildAddressSpaceAsync(manager)</c> passing the manager
|
|
/// as its own <see cref="IAddressSpaceBuilder"/>.
|
|
/// </summary>
|
|
public IReadOnlyList<DriverNodeManager> DriverNodeManagers => _driverNodeManagers;
|
|
|
|
protected override MasterNodeManager CreateMasterNodeManager(IServerInternal server, ApplicationConfiguration configuration)
|
|
{
|
|
foreach (var driverId in _driverHost.RegisteredDriverIds)
|
|
{
|
|
var driver = _driverHost.GetDriver(driverId);
|
|
if (driver is null) continue;
|
|
|
|
var logger = _loggerFactory.CreateLogger<DriverNodeManager>();
|
|
// Per-driver resilience options: tier comes from lookup (Phase 6.1 Stream B.1
|
|
// DriverTypeRegistry in the prod wire-up) or falls back to Tier A. ResilienceConfig
|
|
// JSON comes from the DriverInstance row via the optional lookup Func; parser
|
|
// layers JSON overrides on top of tier defaults (Phase 6.1 Stream A.2).
|
|
var tier = _tierLookup?.Invoke(driver.DriverType) ?? DriverTier.A;
|
|
var resilienceJson = _resilienceConfigLookup?.Invoke(driver.DriverInstanceId);
|
|
var options = DriverResilienceOptionsParser.ParseOrDefaults(tier, resilienceJson, out var diag);
|
|
if (diag is not null)
|
|
logger.LogWarning("ResilienceConfig parse diagnostic for driver {DriverId}: {Diag}", driver.DriverInstanceId, diag);
|
|
|
|
var invoker = new CapabilityInvoker(_pipelineBuilder, driver.DriverInstanceId, () => options, driver.DriverType);
|
|
var manager = new DriverNodeManager(server, configuration, driver, invoker, logger,
|
|
authzGate: _authzGate, scopeResolver: _scopeResolver);
|
|
_driverNodeManagers.Add(manager);
|
|
}
|
|
|
|
return new MasterNodeManager(server, configuration, null, _driverNodeManagers.ToArray());
|
|
}
|
|
|
|
protected override void OnServerStarted(IServerInternal server)
|
|
{
|
|
base.OnServerStarted(server);
|
|
// Hook UserName / Anonymous token validation here. Anonymous passes through; UserName
|
|
// is validated against the IUserAuthenticator (LDAP in production). Rejected identities
|
|
// throw ServiceResultException which the stack translates to Bad_IdentityTokenInvalid.
|
|
server.SessionManager.ImpersonateUser += OnImpersonateUser;
|
|
}
|
|
|
|
private void OnImpersonateUser(Session session, ImpersonateEventArgs args)
|
|
{
|
|
switch (args.NewIdentity)
|
|
{
|
|
case AnonymousIdentityToken:
|
|
args.Identity = new UserIdentity(); // anonymous
|
|
return;
|
|
|
|
case UserNameIdentityToken user:
|
|
{
|
|
var result = _authenticator.AuthenticateAsync(
|
|
user.UserName, user.DecryptedPassword, CancellationToken.None)
|
|
.GetAwaiter().GetResult();
|
|
if (!result.Success)
|
|
{
|
|
throw ServiceResultException.Create(
|
|
StatusCodes.BadUserAccessDenied,
|
|
"Invalid username or password ({0})", result.Error ?? "no detail");
|
|
}
|
|
args.Identity = new RoleBasedIdentity(user.UserName, result.DisplayName, result.Roles);
|
|
return;
|
|
}
|
|
|
|
default:
|
|
throw ServiceResultException.Create(
|
|
StatusCodes.BadIdentityTokenInvalid,
|
|
"Unsupported user identity token type: {0}", args.NewIdentity?.GetType().Name ?? "null");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tiny UserIdentity carrier that preserves the resolved roles so downstream node
|
|
/// managers can gate writes by role via <c>session.Identity</c>. Anonymous identity still
|
|
/// uses the stack's default.
|
|
/// </summary>
|
|
private sealed class RoleBasedIdentity : UserIdentity, IRoleBearer
|
|
{
|
|
public IReadOnlyList<string> Roles { get; }
|
|
public string? Display { get; }
|
|
|
|
public RoleBasedIdentity(string userName, string? displayName, IReadOnlyList<string> roles)
|
|
: base(userName, "")
|
|
{
|
|
Display = displayName;
|
|
Roles = roles;
|
|
}
|
|
}
|
|
|
|
protected override ServerProperties LoadServerProperties() => new()
|
|
{
|
|
ManufacturerName = "OtOpcUa",
|
|
ProductName = "OtOpcUa.Server",
|
|
ProductUri = "urn:OtOpcUa:Server",
|
|
SoftwareVersion = "2.0.0",
|
|
BuildNumber = "0",
|
|
BuildDate = DateTime.UtcNow,
|
|
};
|
|
}
|