Files
lmxopcua/src/Server/ZB.MOM.WW.OtOpcUa.Runtime/Drivers/ActorNodeWriteGateway.cs
T
Joseph Doherty 2e0743ad25 fix(v3-batch4-wp3): realm-qualified write routing + dormant discovery guard + self-correction/byte-parity tests (Wave B review H1/M1/M2/L1/L3)
H1 (HIGH): write-routing key now (AddressSpaceRealm, bareId), not bare-only.
A raw s=<RawPath> and a UNS s=<Area/Line/Equip/Eff> can collide as bare
strings; the bare-only key let a colliding raw+UNS pair route to the WRONG
driver ref (last-writer-wins). The realm the node manager resolves (RealmOf)
is now threaded through IOpcUaNodeWriteGateway.WriteAsync -> RouteNodeWrite ->
_driverRefByNodeId keyed by (realm, bareId). New regression test:
Colliding_raw_and_uns_bare_ids_route_to_their_own_driver_by_realm.

M1 (MEDIUM): discovered-node injection made coherently DORMANT. HandleDiscoveredNodes
hard-short-circuits (single enforcement point; _discoveredByDriver never
populates so the re-inject tail is inert too), with a clear log pointing at the
/raw browse-commit flow. New pin: Discovered_nodes_are_ignored_dormant_in_v3;
the 16+2 v2 injection scenarios re-pointed to an accurate skip reason
(DiscoveryInjectionDormantV3).

M2 (MEDIUM): realm-qualified dual-node self-correction tests —
Failed_uns_write_reverts_uns_node_and_leaves_raw_node_untouched +
Raw_realm_revert_reverts_raw_node_only (the second fails if the realm is dropped).

L1: removed the = AddressSpaceRealm.Uns defaults from the consequential
node-manager mutation methods (WriteValue/WriteAlarmCondition/MaterialiseAlarmCondition/
EnsureFolder/EnsureVariable/UpdateFolderDisplayName/UpdateTagAttributes/
RaiseNodesAddedModelChange/Remove*/RevertOptimisticWriteIfNeeded) + the
AttributeValueUpdate/AlarmStateUpdate records, so the compiler forces explicit
realm; read-only accessors + internal builders retain their defaults.

L3: fixed the stale VirtualTagHostActor class comment (V3NodeIds.Uns, not the
retired EquipmentNodeIds.Variable).

Also: DeploymentArtifactRawUnsParityTests — Raw/UNS node-set byte-parity
round-trip between AddressSpaceComposer.Compose and DeploymentArtifact.ParseComposition.

Claude-Session: https://claude.ai/code/session_01LVneM3eh1UtJxEisFXgmox
2026-07-16 11:30:13 -04:00

80 lines
3.9 KiB
C#

using Akka.Actor;
using Microsoft.Extensions.Logging;
using ZB.MOM.WW.OtOpcUa.Commons.OpcUa;
namespace ZB.MOM.WW.OtOpcUa.Runtime.Drivers;
/// <summary>
/// Akka adapter for the Commons <see cref="IOpcUaNodeWriteGateway"/>: routes an inbound OPC UA
/// operator write to the local <see cref="DriverHostActor"/> by Asking it a
/// <see cref="DriverHostActor.RouteNodeWrite"/> and translating the reply
/// <see cref="DriverHostActor.NodeWriteResult"/> into a <see cref="NodeWriteOutcome"/>.
///
/// <para>
/// The node manager calls <see cref="WriteAsync"/> fire-and-forget from its OnWriteValue handler,
/// which runs under the node-manager Lock, so the method does no blocking work before its first
/// await — resolving the actor and building the Ask returns a Task promptly. The
/// <see cref="DriverHostActor"/> reference is resolved <em>lazily per write</em> via
/// <c>resolveDriverHost</c>: the host wires this gateway during StartAsync, before the Akka
/// <see cref="DriverHostActor"/> registers, so a one-shot resolve at construction would always miss
/// and leave every write unavailable. By write time (long after startup) the registry has it.
/// </para>
/// </summary>
public sealed class ActorNodeWriteGateway : IOpcUaNodeWriteGateway
{
/// <summary>Default Ask timeout — matches the legacy inline lambda in the hosted service.</summary>
private static readonly TimeSpan DefaultAskTimeout = TimeSpan.FromSeconds(10);
private readonly Func<IActorRef?> _resolveDriverHost;
private readonly TimeSpan _askTimeout;
private readonly ILogger _logger;
/// <summary>Creates the gateway.</summary>
/// <param name="resolveDriverHost">Lazy per-write resolver for the local <see cref="DriverHostActor"/>;
/// returns null until the actor has registered (StartAsync ordering — the actor registers AFTER the host
/// wires this gateway).</param>
/// <param name="logger">Logger for dropped/rejected/timed-out writes.</param>
/// <param name="askTimeout">Ask timeout; defaults to 10s (the legacy lambda's value).</param>
public ActorNodeWriteGateway(Func<IActorRef?> resolveDriverHost, ILogger logger, TimeSpan? askTimeout = null)
{
_resolveDriverHost = resolveDriverHost ?? throw new ArgumentNullException(nameof(resolveDriverHost));
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
_askTimeout = askTimeout ?? DefaultAskTimeout;
}
/// <inheritdoc />
public async Task<NodeWriteOutcome> WriteAsync(string nodeId, object? value, AddressSpaceRealm realm, CancellationToken ct)
{
var driverHost = _resolveDriverHost();
if (driverHost is null)
{
_logger.LogWarning("Inbound write to {NodeId} dropped: no DriverHostActor registered", nodeId);
return new NodeWriteOutcome(false, "writes unavailable");
}
try
{
var result = await driverHost.Ask<DriverHostActor.NodeWriteResult>(
new DriverHostActor.RouteNodeWrite(nodeId, value, realm), _askTimeout, ct).ConfigureAwait(false);
if (!result.Success)
_logger.LogWarning("Operator write to {NodeId} rejected: {Reason}", nodeId, result.Reason);
return new NodeWriteOutcome(result.Success, result.Reason);
}
catch (OperationCanceledException ex)
{
_logger.LogWarning(ex, "Operator write to {NodeId} cancelled", nodeId);
return new NodeWriteOutcome(false, "write cancelled");
}
catch (AskTimeoutException ex)
{
_logger.LogWarning(ex, "Operator write to {NodeId} timed out", nodeId);
return new NodeWriteOutcome(false, "write timeout");
}
catch (Exception ex)
{
_logger.LogError(ex, "Operator write to {NodeId} failed unexpectedly", nodeId);
return new NodeWriteOutcome(false, "write error");
}
}
}