Phase 3B: Site I/O & Observability — Communication, DCL, Script/Alarm actors, Health, Event Logging

Communication Layer (WP-1–5):
- 8 message patterns with correlation IDs, per-pattern timeouts
- Central/Site communication actors, transport heartbeat config
- Connection failure handling (no central buffering, debug streams killed)

Data Connection Layer (WP-6–14, WP-34):
- Connection actor with Become/Stash lifecycle (Connecting/Connected/Reconnecting)
- OPC UA + LmxProxy adapters behind IDataConnection
- Auto-reconnect, bad quality propagation, transparent re-subscribe
- Write-back, tag path resolution with retry, health reporting
- Protocol extensibility via DataConnectionFactory

Site Runtime (WP-15–25, WP-32–33):
- ScriptActor/ScriptExecutionActor (triggers, concurrent execution, blocking I/O dispatcher)
- AlarmActor/AlarmExecutionActor (ValueMatch/RangeViolation/RateOfChange, in-memory state)
- SharedScriptLibrary (inline execution), ScriptRuntimeContext (API)
- ScriptCompilationService (Roslyn, forbidden API enforcement, execution timeout)
- Recursion limit (default 10), call direction enforcement
- SiteStreamManager (per-subscriber bounded buffers, fire-and-forget)
- Debug view backend (snapshot + stream), concurrency serialization
- Local artifact storage (4 SQLite tables)

Health Monitoring (WP-26–28):
- SiteHealthCollector (thread-safe counters, connection state)
- HealthReportSender (30s interval, monotonic sequence numbers)
- CentralHealthAggregator (offline detection 60s, online recovery)

Site Event Logging (WP-29–31):
- SiteEventLogger (SQLite, 6 event categories, ISO 8601 UTC)
- EventLogPurgeService (30-day retention, 1GB cap)
- EventLogQueryService (filters, keyword search, keyset pagination)

541 tests pass, zero warnings.
This commit is contained in:
Joseph Doherty
2026-03-16 20:57:25 -04:00
parent a3bf0c43f3
commit 389f5a0378
97 changed files with 8308 additions and 127 deletions

View File

@@ -0,0 +1,120 @@
namespace ScadaLink.DataConnectionLayer.Adapters;
/// <summary>
/// WP-8: Abstraction over the LmxProxy SDK client for testability.
/// The actual LmxProxyClient SDK lives in a separate repo; this interface
/// defines the contract the adapter depends on.
///
/// LmxProxy uses gRPC streaming for subscriptions and a session-based model
/// with keep-alive for connection management.
/// </summary>
public interface ILmxProxyClient : IAsyncDisposable
{
/// <summary>
/// Opens a session to the LmxProxy server. Returns a session ID.
/// </summary>
Task<string> OpenSessionAsync(string host, int port, CancellationToken cancellationToken = default);
/// <summary>
/// Closes the current session.
/// </summary>
Task CloseSessionAsync(CancellationToken cancellationToken = default);
/// <summary>
/// Sends a keep-alive to maintain the session.
/// </summary>
Task SendKeepAliveAsync(CancellationToken cancellationToken = default);
bool IsConnected { get; }
string? SessionId { get; }
/// <summary>
/// Subscribes to tag value changes via gRPC streaming. Returns a subscription handle.
/// </summary>
Task<string> SubscribeTagAsync(
string tagPath,
Action<string, object?, DateTime, bool> onValueChanged,
CancellationToken cancellationToken = default);
Task UnsubscribeTagAsync(string subscriptionHandle, CancellationToken cancellationToken = default);
Task<(object? Value, DateTime Timestamp, bool IsGood)> ReadTagAsync(
string tagPath, CancellationToken cancellationToken = default);
Task<bool> WriteTagAsync(string tagPath, object? value, CancellationToken cancellationToken = default);
}
/// <summary>
/// Factory for creating ILmxProxyClient instances.
/// </summary>
public interface ILmxProxyClientFactory
{
ILmxProxyClient Create();
}
/// <summary>
/// Default factory that creates stub LmxProxy clients.
/// In production, this would create real LmxProxy SDK client instances.
/// </summary>
public class DefaultLmxProxyClientFactory : ILmxProxyClientFactory
{
public ILmxProxyClient Create() => new StubLmxProxyClient();
}
/// <summary>
/// Stub LmxProxy client for development/testing.
/// </summary>
internal class StubLmxProxyClient : ILmxProxyClient
{
public bool IsConnected { get; private set; }
public string? SessionId { get; private set; }
public Task<string> OpenSessionAsync(string host, int port, CancellationToken cancellationToken = default)
{
SessionId = Guid.NewGuid().ToString();
IsConnected = true;
return Task.FromResult(SessionId);
}
public Task CloseSessionAsync(CancellationToken cancellationToken = default)
{
IsConnected = false;
SessionId = null;
return Task.CompletedTask;
}
public Task SendKeepAliveAsync(CancellationToken cancellationToken = default)
{
return Task.CompletedTask;
}
public Task<string> SubscribeTagAsync(
string tagPath, Action<string, object?, DateTime, bool> onValueChanged,
CancellationToken cancellationToken = default)
{
return Task.FromResult(Guid.NewGuid().ToString());
}
public Task UnsubscribeTagAsync(string subscriptionHandle, CancellationToken cancellationToken = default)
{
return Task.CompletedTask;
}
public Task<(object? Value, DateTime Timestamp, bool IsGood)> ReadTagAsync(
string tagPath, CancellationToken cancellationToken = default)
{
return Task.FromResult<(object?, DateTime, bool)>((null, DateTime.UtcNow, true));
}
public Task<bool> WriteTagAsync(string tagPath, object? value, CancellationToken cancellationToken = default)
{
return Task.FromResult(true);
}
public ValueTask DisposeAsync()
{
IsConnected = false;
SessionId = null;
return ValueTask.CompletedTask;
}
}

View File

@@ -0,0 +1,94 @@
namespace ScadaLink.DataConnectionLayer.Adapters;
/// <summary>
/// WP-7: Abstraction over OPC UA client library for testability.
/// The real implementation would wrap an OPC UA SDK (e.g., OPC Foundation .NET Standard Library).
/// </summary>
public interface IOpcUaClient : IAsyncDisposable
{
Task ConnectAsync(string endpointUrl, CancellationToken cancellationToken = default);
Task DisconnectAsync(CancellationToken cancellationToken = default);
bool IsConnected { get; }
/// <summary>
/// Creates a monitored item subscription for a node. Returns a subscription handle.
/// </summary>
Task<string> CreateSubscriptionAsync(
string nodeId,
Action<string, object?, DateTime, uint> onValueChanged,
CancellationToken cancellationToken = default);
Task RemoveSubscriptionAsync(string subscriptionHandle, CancellationToken cancellationToken = default);
Task<(object? Value, DateTime SourceTimestamp, uint StatusCode)> ReadValueAsync(
string nodeId, CancellationToken cancellationToken = default);
Task<uint> WriteValueAsync(string nodeId, object? value, CancellationToken cancellationToken = default);
}
/// <summary>
/// Factory for creating IOpcUaClient instances.
/// </summary>
public interface IOpcUaClientFactory
{
IOpcUaClient Create();
}
/// <summary>
/// Default factory that creates stub OPC UA clients.
/// In production, this would create real OPC UA SDK client instances.
/// </summary>
public class DefaultOpcUaClientFactory : IOpcUaClientFactory
{
public IOpcUaClient Create() => new StubOpcUaClient();
}
/// <summary>
/// Stub OPC UA client for development/testing. A real implementation would
/// wrap the OPC Foundation .NET Standard Library.
/// </summary>
internal class StubOpcUaClient : IOpcUaClient
{
public bool IsConnected { get; private set; }
public Task ConnectAsync(string endpointUrl, CancellationToken cancellationToken = default)
{
IsConnected = true;
return Task.CompletedTask;
}
public Task DisconnectAsync(CancellationToken cancellationToken = default)
{
IsConnected = false;
return Task.CompletedTask;
}
public Task<string> CreateSubscriptionAsync(
string nodeId, Action<string, object?, DateTime, uint> onValueChanged,
CancellationToken cancellationToken = default)
{
return Task.FromResult(Guid.NewGuid().ToString());
}
public Task RemoveSubscriptionAsync(string subscriptionHandle, CancellationToken cancellationToken = default)
{
return Task.CompletedTask;
}
public Task<(object? Value, DateTime SourceTimestamp, uint StatusCode)> ReadValueAsync(
string nodeId, CancellationToken cancellationToken = default)
{
return Task.FromResult<(object?, DateTime, uint)>((null, DateTime.UtcNow, 0));
}
public Task<uint> WriteValueAsync(string nodeId, object? value, CancellationToken cancellationToken = default)
{
return Task.FromResult<uint>(0); // Good status
}
public ValueTask DisposeAsync()
{
IsConnected = false;
return ValueTask.CompletedTask;
}
}

View File

@@ -0,0 +1,196 @@
using Microsoft.Extensions.Logging;
using ScadaLink.Commons.Interfaces.Protocol;
using ScadaLink.Commons.Types.Enums;
namespace ScadaLink.DataConnectionLayer.Adapters;
/// <summary>
/// WP-8: LmxProxy adapter implementing IDataConnection.
/// Maps IDataConnection to LmxProxy SDK calls.
///
/// LmxProxy-specific behavior:
/// - Session-based connection with 30s keep-alive
/// - gRPC streaming for subscriptions
/// - SessionId management (required for all operations)
/// </summary>
public class LmxProxyDataConnection : IDataConnection
{
private readonly ILmxProxyClientFactory _clientFactory;
private readonly ILogger<LmxProxyDataConnection> _logger;
private ILmxProxyClient? _client;
private string _host = "localhost";
private int _port = 5000;
private ConnectionHealth _status = ConnectionHealth.Disconnected;
private Timer? _keepAliveTimer;
private readonly Dictionary<string, string> _subscriptionHandles = new();
public LmxProxyDataConnection(ILmxProxyClientFactory clientFactory, ILogger<LmxProxyDataConnection> logger)
{
_clientFactory = clientFactory;
_logger = logger;
}
public ConnectionHealth Status => _status;
public async Task ConnectAsync(IDictionary<string, string> connectionDetails, CancellationToken cancellationToken = default)
{
_host = connectionDetails.TryGetValue("Host", out var host) ? host : "localhost";
if (connectionDetails.TryGetValue("Port", out var portStr) && int.TryParse(portStr, out var port))
_port = port;
_status = ConnectionHealth.Connecting;
_client = _clientFactory.Create();
var sessionId = await _client.OpenSessionAsync(_host, _port, cancellationToken);
_status = ConnectionHealth.Connected;
// Start 30s keep-alive timer per design spec
_keepAliveTimer = new Timer(
async _ => await SendKeepAliveAsync(),
null,
TimeSpan.FromSeconds(30),
TimeSpan.FromSeconds(30));
_logger.LogInformation("LmxProxy connected to {Host}:{Port}, sessionId={SessionId}", _host, _port, sessionId);
}
public async Task DisconnectAsync(CancellationToken cancellationToken = default)
{
_keepAliveTimer?.Dispose();
_keepAliveTimer = null;
if (_client != null)
{
await _client.CloseSessionAsync(cancellationToken);
_status = ConnectionHealth.Disconnected;
_logger.LogInformation("LmxProxy disconnected from {Host}:{Port}", _host, _port);
}
}
public async Task<string> SubscribeAsync(string tagPath, SubscriptionCallback callback, CancellationToken cancellationToken = default)
{
EnsureConnected();
var handle = await _client!.SubscribeTagAsync(
tagPath,
(path, value, timestamp, isGood) =>
{
var quality = isGood ? QualityCode.Good : QualityCode.Bad;
callback(path, new TagValue(value, quality, new DateTimeOffset(timestamp, TimeSpan.Zero)));
},
cancellationToken);
_subscriptionHandles[handle] = tagPath;
return handle;
}
public async Task UnsubscribeAsync(string subscriptionId, CancellationToken cancellationToken = default)
{
if (_client != null)
{
await _client.UnsubscribeTagAsync(subscriptionId, cancellationToken);
_subscriptionHandles.Remove(subscriptionId);
}
}
public async Task<ReadResult> ReadAsync(string tagPath, CancellationToken cancellationToken = default)
{
EnsureConnected();
var (value, timestamp, isGood) = await _client!.ReadTagAsync(tagPath, cancellationToken);
var quality = isGood ? QualityCode.Good : QualityCode.Bad;
if (!isGood)
return new ReadResult(false, null, "LmxProxy read returned bad quality");
return new ReadResult(true, new TagValue(value, quality, new DateTimeOffset(timestamp, TimeSpan.Zero)), null);
}
public async Task<IReadOnlyDictionary<string, ReadResult>> ReadBatchAsync(IEnumerable<string> tagPaths, CancellationToken cancellationToken = default)
{
var results = new Dictionary<string, ReadResult>();
foreach (var tagPath in tagPaths)
{
results[tagPath] = await ReadAsync(tagPath, cancellationToken);
}
return results;
}
public async Task<WriteResult> WriteAsync(string tagPath, object? value, CancellationToken cancellationToken = default)
{
EnsureConnected();
var success = await _client!.WriteTagAsync(tagPath, value, cancellationToken);
return success
? new WriteResult(true, null)
: new WriteResult(false, "LmxProxy write failed");
}
public async Task<IReadOnlyDictionary<string, WriteResult>> WriteBatchAsync(IDictionary<string, object?> values, CancellationToken cancellationToken = default)
{
var results = new Dictionary<string, WriteResult>();
foreach (var (tagPath, value) in values)
{
results[tagPath] = await WriteAsync(tagPath, value, cancellationToken);
}
return results;
}
public async Task<bool> WriteBatchAndWaitAsync(
IDictionary<string, object?> values, string flagPath, object? flagValue,
string responsePath, object? responseValue, TimeSpan timeout,
CancellationToken cancellationToken = default)
{
var allValues = new Dictionary<string, object?>(values) { [flagPath] = flagValue };
var writeResults = await WriteBatchAsync(allValues, cancellationToken);
if (writeResults.Values.Any(r => !r.Success))
return false;
var deadline = DateTimeOffset.UtcNow + timeout;
while (DateTimeOffset.UtcNow < deadline)
{
cancellationToken.ThrowIfCancellationRequested();
var readResult = await ReadAsync(responsePath, cancellationToken);
if (readResult.Success && readResult.Value != null && Equals(readResult.Value.Value, responseValue))
return true;
await Task.Delay(100, cancellationToken);
}
return false;
}
public async ValueTask DisposeAsync()
{
_keepAliveTimer?.Dispose();
_keepAliveTimer = null;
if (_client != null)
{
await _client.DisposeAsync();
_client = null;
}
_status = ConnectionHealth.Disconnected;
}
private void EnsureConnected()
{
if (_client == null || !_client.IsConnected)
throw new InvalidOperationException("LmxProxy client is not connected.");
}
private async Task SendKeepAliveAsync()
{
try
{
if (_client?.IsConnected == true)
await _client.SendKeepAliveAsync();
}
catch (Exception ex)
{
_logger.LogWarning(ex, "LmxProxy keep-alive failed for {Host}:{Port}", _host, _port);
}
}
}

View File

@@ -0,0 +1,183 @@
using Microsoft.Extensions.Logging;
using ScadaLink.Commons.Interfaces.Protocol;
using ScadaLink.Commons.Types.Enums;
namespace ScadaLink.DataConnectionLayer.Adapters;
/// <summary>
/// WP-7: OPC UA adapter implementing IDataConnection.
/// Maps IDataConnection methods to OPC UA concepts via IOpcUaClient abstraction.
///
/// OPC UA mapping:
/// - TagPath → NodeId (e.g., "ns=2;s=MyDevice.Temperature")
/// - Subscribe → MonitoredItem with DataChangeNotification
/// - Read/Write → Read/Write service calls
/// - Quality → OPC UA StatusCode mapping
/// </summary>
public class OpcUaDataConnection : IDataConnection
{
private readonly IOpcUaClientFactory _clientFactory;
private readonly ILogger<OpcUaDataConnection> _logger;
private IOpcUaClient? _client;
private string _endpointUrl = string.Empty;
private ConnectionHealth _status = ConnectionHealth.Disconnected;
/// <summary>
/// Maps subscription IDs to their tag paths for cleanup.
/// </summary>
private readonly Dictionary<string, string> _subscriptionHandles = new();
public OpcUaDataConnection(IOpcUaClientFactory clientFactory, ILogger<OpcUaDataConnection> logger)
{
_clientFactory = clientFactory;
_logger = logger;
}
public ConnectionHealth Status => _status;
public async Task ConnectAsync(IDictionary<string, string> connectionDetails, CancellationToken cancellationToken = default)
{
_endpointUrl = connectionDetails.TryGetValue("EndpointUrl", out var url) ? url : "opc.tcp://localhost:4840";
_status = ConnectionHealth.Connecting;
_client = _clientFactory.Create();
await _client.ConnectAsync(_endpointUrl, cancellationToken);
_status = ConnectionHealth.Connected;
_logger.LogInformation("OPC UA connected to {Endpoint}", _endpointUrl);
}
public async Task DisconnectAsync(CancellationToken cancellationToken = default)
{
if (_client != null)
{
await _client.DisconnectAsync(cancellationToken);
_status = ConnectionHealth.Disconnected;
_logger.LogInformation("OPC UA disconnected from {Endpoint}", _endpointUrl);
}
}
public async Task<string> SubscribeAsync(string tagPath, SubscriptionCallback callback, CancellationToken cancellationToken = default)
{
EnsureConnected();
var subscriptionId = await _client!.CreateSubscriptionAsync(
tagPath,
(nodeId, value, timestamp, statusCode) =>
{
var quality = MapStatusCode(statusCode);
callback(tagPath, new TagValue(value, quality, new DateTimeOffset(timestamp, TimeSpan.Zero)));
},
cancellationToken);
_subscriptionHandles[subscriptionId] = tagPath;
return subscriptionId;
}
public async Task UnsubscribeAsync(string subscriptionId, CancellationToken cancellationToken = default)
{
if (_client != null)
{
await _client.RemoveSubscriptionAsync(subscriptionId, cancellationToken);
_subscriptionHandles.Remove(subscriptionId);
}
}
public async Task<ReadResult> ReadAsync(string tagPath, CancellationToken cancellationToken = default)
{
EnsureConnected();
var (value, timestamp, statusCode) = await _client!.ReadValueAsync(tagPath, cancellationToken);
var quality = MapStatusCode(statusCode);
if (quality == QualityCode.Bad)
return new ReadResult(false, null, $"OPC UA read returned bad status: 0x{statusCode:X8}");
return new ReadResult(true, new TagValue(value, quality, new DateTimeOffset(timestamp, TimeSpan.Zero)), null);
}
public async Task<IReadOnlyDictionary<string, ReadResult>> ReadBatchAsync(IEnumerable<string> tagPaths, CancellationToken cancellationToken = default)
{
var results = new Dictionary<string, ReadResult>();
foreach (var tagPath in tagPaths)
{
results[tagPath] = await ReadAsync(tagPath, cancellationToken);
}
return results;
}
public async Task<WriteResult> WriteAsync(string tagPath, object? value, CancellationToken cancellationToken = default)
{
EnsureConnected();
var statusCode = await _client!.WriteValueAsync(tagPath, value, cancellationToken);
if (statusCode != 0)
return new WriteResult(false, $"OPC UA write failed with status: 0x{statusCode:X8}");
return new WriteResult(true, null);
}
public async Task<IReadOnlyDictionary<string, WriteResult>> WriteBatchAsync(IDictionary<string, object?> values, CancellationToken cancellationToken = default)
{
var results = new Dictionary<string, WriteResult>();
foreach (var (tagPath, value) in values)
{
results[tagPath] = await WriteAsync(tagPath, value, cancellationToken);
}
return results;
}
public async Task<bool> WriteBatchAndWaitAsync(
IDictionary<string, object?> values, string flagPath, object? flagValue,
string responsePath, object? responseValue, TimeSpan timeout,
CancellationToken cancellationToken = default)
{
// Write all values including the flag
var allValues = new Dictionary<string, object?>(values) { [flagPath] = flagValue };
var writeResults = await WriteBatchAsync(allValues, cancellationToken);
if (writeResults.Values.Any(r => !r.Success))
return false;
// Poll for response value within timeout
var deadline = DateTimeOffset.UtcNow + timeout;
while (DateTimeOffset.UtcNow < deadline)
{
cancellationToken.ThrowIfCancellationRequested();
var readResult = await ReadAsync(responsePath, cancellationToken);
if (readResult.Success && readResult.Value != null && Equals(readResult.Value.Value, responseValue))
return true;
await Task.Delay(100, cancellationToken);
}
return false;
}
public async ValueTask DisposeAsync()
{
if (_client != null)
{
await _client.DisposeAsync();
_client = null;
}
_status = ConnectionHealth.Disconnected;
}
private void EnsureConnected()
{
if (_client == null || !_client.IsConnected)
throw new InvalidOperationException("OPC UA client is not connected.");
}
/// <summary>
/// Maps OPC UA StatusCode to QualityCode.
/// StatusCode 0 = Good, high bit set = Bad, otherwise Uncertain.
/// </summary>
private static QualityCode MapStatusCode(uint statusCode)
{
if (statusCode == 0) return QualityCode.Good;
if ((statusCode & 0x80000000) != 0) return QualityCode.Bad;
return QualityCode.Uncertain;
}
}