mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 22:55:08 +08:00
romanett
9b034f8291
# Description Nullable reference types are now enabled once, in `common.props`, and every project in the repository builds warning-clean with them. **Configuration** - `<Nullable>enable</Nullable>` lives in `common.props`. All per-project `<Nullable>` settings are removed: 178 project files (enable, annotations, and the `disable` in the three Aot test projects). - 419 per-file `#nullable enable`/`restore` directives and the 4 `#nullable disable` directives are removed. - Kept on purpose: - The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`, `PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the project setting in generated code, so the directive is required there. - `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against the 1.5.378 packages and does not import the repository props. - `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now describe the central setting. **Migration** (the 43 unset and 13 annotations-only projects, roughly 10k diagnostics) - **Production code: annotated at the declarations.** Covers `tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the LDS sample. - Members, parameters and returns are nullable where null actually flows. - Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`, `IsMethodTypeDesign`). - `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take `params object?[]`. `Template.AddReplacement` takes `string?` (rendering already skips null replacements). - `IRegisteredServerStore.RegisterAsync` returns `Task<RegistrationEntry?>`: it returns null when a registration is removed. - Dereferences backed by an invariant (for example, the validated model) use `!`, so runtime behaviour is unchanged. - **Behavioural changes in production code** (small, deliberate): - `NodeSetToModelDesign` throws `InvalidOperationException` when the file is not a NodeSet. Before, it threw a NullReferenceException on the next line. - `ModelDesignValidator` starts its lookup tables empty instead of null. A redundant `if (m_nodes == null) return;` guard is gone. - **Test code: minimal annotations.** - `?` on values that can be null, `!` where the test asserts non-null. - `= null!` for fixture members assigned in SetUp. - `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the `IEncodeable` constraint. - A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`) folded into the adjacent `IsNull`/`Count` checks. **Notes for reviewers** - The diff is large (~1,500 files) but almost entirely mechanical: `?`, `!` and directive removal. The non-annotation changes are listed above. - Known follow-up, not done here: `IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay non-nullable even though the validator returns null before it loads a dictionary. Making them nullable would ripple through every generator call site. ## Related Issues - Fixes #4439 ## Checklist - [ ] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [ ] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received. The "no new warnings" box covers net10.0 and net48: full non-incremental builds of `UA.slnx`, `tools/SourceGeneration.slnx`, `tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0 warnings and 0 errors under the repository's warnings-as-errors settings. net9.0 and net8.0 also had no nullable diagnostics, but they were not rebuilt after the final fixes. Tests have not been run locally yet. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
654 lines
28 KiB
C#
654 lines
28 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
#pragma warning disable CA2016
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Client;
|
|
using Opc.Ua.Client.Subscriptions;
|
|
using Opc.Ua.Client.Subscriptions.MonitoredItems;
|
|
using Opc.Ua.Client.TestFramework;
|
|
|
|
namespace Opc.Ua.Subscriptions.Tests
|
|
{
|
|
/// <summary>
|
|
/// V2 follow-up coverage: handler state-change callback,
|
|
/// fluent stream-based LoadSubscriptionsAsync, SendInitialValuesOnTransfer
|
|
/// behavior, snapshot edge cases (empty / with-filter / concurrent).
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Client")]
|
|
[Category("V2")]
|
|
[Category("FollowUp")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
public class SubscriptionCoverageTests : ClientTestFramework
|
|
{
|
|
[OneTimeSetUp]
|
|
public override Task OneTimeSetUpAsync()
|
|
{
|
|
SupportsExternalServerUrl = true;
|
|
SingleSession = false;
|
|
return OneTimeSetUpCoreAsync(securityNone: true);
|
|
}
|
|
|
|
[OneTimeTearDown]
|
|
public override Task OneTimeTearDownAsync()
|
|
{
|
|
return base.OneTimeTearDownAsync();
|
|
}
|
|
|
|
[SetUp]
|
|
public override Task SetUpAsync()
|
|
{
|
|
return base.SetUpAsync();
|
|
}
|
|
|
|
[TearDown]
|
|
public override Task TearDownAsync()
|
|
{
|
|
return base.TearDownAsync();
|
|
}
|
|
|
|
[Test]
|
|
[Order(100)]
|
|
[CancelAfter(60_000)]
|
|
public async Task HandlerStateChangedFiresOnLifecycleV2Async(
|
|
CancellationToken ct)
|
|
{
|
|
ManagedSession session = await ConnectV2Async(
|
|
nameof(HandlerStateChangedFiresOnLifecycleV2Async), ct)
|
|
.ConfigureAwait(false);
|
|
try
|
|
{
|
|
var handler = new RecordingSubscriptionHandler();
|
|
ISubscription sub = session.AddSubscription(handler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true
|
|
});
|
|
bool created = await WaitForAsync(() => sub.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false);
|
|
Assert.That(created, Is.True);
|
|
|
|
bool sawStateChanges = await WaitForAsync(
|
|
() => handler.StateChangedCount > 0,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false);
|
|
Assert.That(sawStateChanges, Is.True,
|
|
"OnSubscriptionStateChangedAsync should fire during subscription lifecycle");
|
|
|
|
IReadOnlyList<RecordedStateChange> snap = handler.GetStateChangeSnapshot();
|
|
Assert.That(snap, Is.Not.Empty);
|
|
|
|
// Sub-test: derive a "is currently created" indicator from
|
|
// the callback stream — proves the handler-maintains-state
|
|
// pattern that replaced the dropped PublishingStopped
|
|
// property on ISubscription.
|
|
bool sawCreated = false;
|
|
foreach (RecordedStateChange c in snap)
|
|
{
|
|
if (c.State is Client.Subscriptions.SubscriptionState.Created or
|
|
Client.Subscriptions.SubscriptionState.Modified or
|
|
Client.Subscriptions.SubscriptionState.Opened)
|
|
{
|
|
sawCreated = true;
|
|
}
|
|
}
|
|
Assert.That(sawCreated, Is.True,
|
|
"State stream should include at least one Created / " +
|
|
"Modified / Opened transition");
|
|
|
|
await sub.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
await session.CloseAsync().ConfigureAwait(false);
|
|
await session.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
[Order(200)]
|
|
[CancelAfter(60_000)]
|
|
public async Task FluentLoadSubscriptionsAsyncStreamV2Async(
|
|
CancellationToken ct)
|
|
{
|
|
ManagedSession originSession = await ConnectV2Async(
|
|
nameof(FluentLoadSubscriptionsAsyncStreamV2Async) + "_origin", ct)
|
|
.ConfigureAwait(false);
|
|
ManagedSession? targetSession = null;
|
|
try
|
|
{
|
|
var originHandler = new RecordingSubscriptionHandler();
|
|
ISubscription origin = originSession.AddSubscription(originHandler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true
|
|
});
|
|
Assert.That(await WaitForAsync(() => origin.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(origin.TryAddMonitoredItem("Time",
|
|
VariableIds.Server_ServerStatus_CurrentTime,
|
|
o => o with { SamplingInterval = TimeSpan.FromMilliseconds(200) },
|
|
out _), Is.True);
|
|
Assert.That(await originHandler.WaitForFirstDataAsync(
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
|
|
using var ms = new MemoryStream();
|
|
await originSession.SaveSubscriptionsAsync(ms, ct: ct)
|
|
.ConfigureAwait(false);
|
|
byte[] saved = ms.ToArray();
|
|
Assert.That(saved, Has.Length.GreaterThan(0));
|
|
|
|
targetSession = await ConnectV2Async(
|
|
nameof(FluentLoadSubscriptionsAsyncStreamV2Async) + "_target", ct)
|
|
.ConfigureAwait(false);
|
|
var targetHandler = new RecordingSubscriptionHandler();
|
|
using var input = new MemoryStream(saved);
|
|
IReadOnlyList<ISubscription> loaded = await targetSession
|
|
.LoadSubscriptionsAsync(input, _ => targetHandler,
|
|
transferSubscriptions: false, ct)
|
|
.ConfigureAwait(false);
|
|
Assert.That(loaded, Has.Count.EqualTo(1));
|
|
Assert.That(await WaitForAsync(() => loaded[0].Created,
|
|
TimeSpan.FromSeconds(15), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(await targetHandler.WaitForFirstDataAsync(
|
|
TimeSpan.FromSeconds(15), ct).ConfigureAwait(false), Is.True);
|
|
|
|
await loaded[0].DisposeAsync().ConfigureAwait(false);
|
|
await origin.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
await originSession.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await originSession.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
if (targetSession != null)
|
|
{
|
|
try
|
|
{
|
|
await targetSession.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await targetSession.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
[Order(300)]
|
|
[CancelAfter(60_000)]
|
|
public async Task SendInitialValuesOnTransferV2Async(CancellationToken ct)
|
|
{
|
|
// When the test runs against a reference server that denies
|
|
// cross-anonymous-session transfer with BadUserAccessDenied,
|
|
// the V2 manager falls back to recreate. Recreate always
|
|
// delivers an initial value (server first-sample behavior),
|
|
// so the SendInitialValuesOnTransfer option's effect can't
|
|
// be distinguished. Document that and verify the option
|
|
// propagates structurally + the subscription works after
|
|
// restore regardless of which path the server took.
|
|
string saveFile = Path.Combine(Path.GetTempPath(),
|
|
$"V2InitVals-{Guid.NewGuid():N}.bin");
|
|
ManagedSession originSession = await ConnectV2Async(
|
|
nameof(SendInitialValuesOnTransferV2Async) + "_origin", ct)
|
|
.ConfigureAwait(false);
|
|
originSession.DeleteSubscriptionsOnClose = false;
|
|
ManagedSession? targetSession = null;
|
|
try
|
|
{
|
|
var originHandler = new RecordingSubscriptionHandler();
|
|
ISubscription origin = originSession.AddSubscription(originHandler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true,
|
|
SendInitialValuesOnTransfer = true
|
|
});
|
|
Assert.That(await WaitForAsync(() => origin.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(origin.TryAddMonitoredItem("Time",
|
|
VariableIds.Server_ServerStatus_CurrentTime,
|
|
o => o with { SamplingInterval = TimeSpan.FromMilliseconds(200) },
|
|
out _), Is.True);
|
|
Assert.That(await originHandler.WaitForFirstDataAsync(
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
|
|
// Snapshot includes the SendInitialValuesOnTransfer
|
|
// option through SubscriptionStateSnapshot.ToOptions().
|
|
SubscriptionStateSnapshot snap = ((LogicalSubscription)origin).Snapshot();
|
|
Assert.That(snap.SendInitialValuesOnTransfer, Is.True,
|
|
"SendInitialValuesOnTransfer option must round-trip through Snapshot");
|
|
|
|
using (FileStream output = File.Create(saveFile))
|
|
{
|
|
await originSession.SaveSubscriptionsAsync(output, ct: ct)
|
|
.ConfigureAwait(false);
|
|
}
|
|
StatusCode originClose = await originSession.CloseAsync()
|
|
.ConfigureAwait(false);
|
|
// The origin session is closed WITHOUT deleting its subscriptions
|
|
// (DeleteSubscriptionsOnClose == false) so the target can take
|
|
// them over. On a loaded CI agent the deliberate close can race
|
|
// the transfer/state-manager and the inner Session.CloseAsync
|
|
// then returns the interrupted/invalidated status instead of
|
|
// Good. That close-time race is benign here - the subscription
|
|
// state was already persisted to saveFile above and is retained
|
|
// server-side - so accept those transient statuses. The strict
|
|
// end-to-end proof is the load + transfer + data flow on the
|
|
// fresh target session below, which is unchanged.
|
|
bool closeAcceptable = ServiceResult.IsGood(originClose) ||
|
|
originClose.Code == (uint)StatusCodes.BadSessionIdInvalid ||
|
|
originClose.Code == (uint)StatusCodes.BadRequestInterrupted ||
|
|
originClose.Code == (uint)StatusCodes.BadConnectionClosed ||
|
|
originClose.Code == (uint)StatusCodes.BadSecureChannelClosed ||
|
|
originClose.Code == (uint)StatusCodes.BadServerHalted;
|
|
Assert.That(closeAcceptable, Is.True,
|
|
"Unexpected origin close status: " + originClose.ToString());
|
|
|
|
targetSession = await ConnectV2Async(
|
|
nameof(SendInitialValuesOnTransferV2Async) + "_target", ct)
|
|
.ConfigureAwait(false);
|
|
var targetHandler = new RecordingSubscriptionHandler();
|
|
using FileStream input = File.OpenRead(saveFile);
|
|
IReadOnlyList<ISubscription> loaded = await targetSession
|
|
.LoadSubscriptionsAsync(input, _ => targetHandler,
|
|
transferSubscriptions: true, ct)
|
|
.ConfigureAwait(false);
|
|
Assert.That(loaded, Has.Count.EqualTo(1));
|
|
bool gotData = await targetHandler.WaitForFirstDataAsync(
|
|
TimeSpan.FromSeconds(15), ct).ConfigureAwait(false);
|
|
Assert.That(gotData, Is.True,
|
|
"Target subscription should publish (transfer or recreate)");
|
|
|
|
await loaded[0].DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
await originSession.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
if (targetSession != null)
|
|
{
|
|
try
|
|
{
|
|
await targetSession.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await targetSession.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
}
|
|
try
|
|
{
|
|
File.Delete(saveFile);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
[Order(400)]
|
|
[CancelAfter(60_000)]
|
|
public async Task SnapshotEmptySubscriptionRoundTripV2Async(
|
|
CancellationToken ct)
|
|
{
|
|
ManagedSession session = await ConnectV2Async(
|
|
nameof(SnapshotEmptySubscriptionRoundTripV2Async), ct)
|
|
.ConfigureAwait(false);
|
|
ManagedSession? target = null;
|
|
try
|
|
{
|
|
var handler = new RecordingSubscriptionHandler();
|
|
ISubscription sub = session.AddSubscription(handler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true
|
|
});
|
|
Assert.That(await WaitForAsync(() => sub.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(sub.MonitoredItems.Count, Is.Zero);
|
|
|
|
SubscriptionStateSnapshot snap = ((LogicalSubscription)sub).Snapshot();
|
|
Assert.That(snap.MonitoredItems.Count, Is.Zero);
|
|
|
|
target = await ConnectV2Async(
|
|
nameof(SnapshotEmptySubscriptionRoundTripV2Async) + "_target", ct)
|
|
.ConfigureAwait(false);
|
|
ISubscriptionManager targetManager = target.RequireSubscriptionManager();
|
|
Assert.That(targetManager, Is.InstanceOf<SubscriptionManager>());
|
|
ISubscription restored = await ((SubscriptionManager)targetManager)
|
|
.RestoreAsync(
|
|
new RecordingSubscriptionHandler(),
|
|
snap,
|
|
transferSubscriptions: false,
|
|
ct)
|
|
.ConfigureAwait(false);
|
|
Assert.That(await WaitForAsync(() => restored.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(restored.MonitoredItems.Count, Is.Zero);
|
|
|
|
await restored.DisposeAsync().ConfigureAwait(false);
|
|
await sub.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
await session.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await session.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
if (target != null)
|
|
{
|
|
try
|
|
{
|
|
await target.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await target.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
[Order(500)]
|
|
[CancelAfter(60_000)]
|
|
public async Task SnapshotWithDataChangeFilterRoundTripV2Async(
|
|
CancellationToken ct)
|
|
{
|
|
ManagedSession session = await ConnectV2Async(
|
|
nameof(SnapshotWithDataChangeFilterRoundTripV2Async), ct)
|
|
.ConfigureAwait(false);
|
|
ManagedSession? target = null;
|
|
try
|
|
{
|
|
var handler = new RecordingSubscriptionHandler();
|
|
ISubscription sub = session.AddSubscription(handler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true
|
|
});
|
|
Assert.That(await WaitForAsync(() => sub.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
|
|
var dataChangeFilter = new DataChangeFilter
|
|
{
|
|
Trigger = DataChangeTrigger.StatusValueTimestamp,
|
|
DeadbandType = (uint)DeadbandType.None,
|
|
DeadbandValue = 0.0
|
|
};
|
|
Assert.That(sub.TryAddMonitoredItem("Trigger",
|
|
VariableIds.Server_ServerStatus_CurrentTime,
|
|
o => o with
|
|
{
|
|
SamplingInterval = TimeSpan.FromMilliseconds(250),
|
|
Filter = dataChangeFilter
|
|
},
|
|
out IMonitoredItem? item), Is.True);
|
|
Assert.That(await WaitForAsync(() => item!.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
|
|
SubscriptionStateSnapshot snap = ((LogicalSubscription)sub).Snapshot();
|
|
Assert.That(snap.MonitoredItems.Count, Is.EqualTo(1));
|
|
MonitoredItemStateSnapshot itemSnap = snap.MonitoredItems[0];
|
|
Assert.That(itemSnap.Filter, Is.Not.Null);
|
|
Assert.That(itemSnap.Filter, Is.InstanceOf<DataChangeFilter>());
|
|
var restoredFilter = (DataChangeFilter)itemSnap.Filter!;
|
|
Assert.That(restoredFilter.Trigger,
|
|
Is.EqualTo(dataChangeFilter.Trigger));
|
|
Assert.That(restoredFilter.DeadbandType,
|
|
Is.EqualTo(dataChangeFilter.DeadbandType));
|
|
|
|
// Round-trip through the manager
|
|
target = await ConnectV2Async(
|
|
nameof(SnapshotWithDataChangeFilterRoundTripV2Async) + "_target", ct)
|
|
.ConfigureAwait(false);
|
|
ISubscriptionManager targetManager = target.RequireSubscriptionManager();
|
|
Assert.That(targetManager, Is.InstanceOf<SubscriptionManager>());
|
|
ISubscription restored = await ((SubscriptionManager)targetManager)
|
|
.RestoreAsync(
|
|
new RecordingSubscriptionHandler(),
|
|
snap,
|
|
transferSubscriptions: false,
|
|
ct)
|
|
.ConfigureAwait(false);
|
|
Assert.That(await WaitForAsync(() => restored.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
Assert.That(restored.MonitoredItems.Count, Is.EqualTo(1u));
|
|
|
|
await restored.DisposeAsync().ConfigureAwait(false);
|
|
await sub.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
await session.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await session.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
if (target != null)
|
|
{
|
|
try
|
|
{
|
|
await target.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
try
|
|
{
|
|
await target.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{ /* best effort */
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
[Order(600)]
|
|
[CancelAfter(60_000)]
|
|
public async Task SnapshotUnderConcurrentMutationV2Async(
|
|
CancellationToken ct)
|
|
{
|
|
ManagedSession session = await ConnectV2Async(
|
|
nameof(SnapshotUnderConcurrentMutationV2Async), ct)
|
|
.ConfigureAwait(false);
|
|
try
|
|
{
|
|
var handler = new RecordingSubscriptionHandler();
|
|
ISubscription sub = session.AddSubscription(handler,
|
|
new Client.Subscriptions.SubscriptionOptions
|
|
{
|
|
PublishingInterval = TimeSpan.FromMilliseconds(500),
|
|
KeepAliveCount = 10,
|
|
LifetimeCount = 100,
|
|
PublishingEnabled = true
|
|
});
|
|
Assert.That(await WaitForAsync(() => sub.Created,
|
|
TimeSpan.FromSeconds(10), ct).ConfigureAwait(false), Is.True);
|
|
|
|
// Concurrently add items while taking snapshots. The
|
|
// snapshot must always return an internally consistent
|
|
// count (the names must all exist) — proves the
|
|
// manager-lock contract.
|
|
const int itemCount = 20;
|
|
var addTasks = new Task[itemCount];
|
|
for (int i = 0; i < itemCount; i++)
|
|
{
|
|
int idx = i;
|
|
addTasks[i] = Task.Run(() => sub.TryAddMonitoredItem(
|
|
string.Format(System.Globalization.CultureInfo.InvariantCulture,
|
|
"item-{0}", idx),
|
|
VariableIds.Server_ServerStatus_CurrentTime,
|
|
o => o with { SamplingInterval = TimeSpan.Zero },
|
|
out _), ct);
|
|
}
|
|
var subConcrete = (LogicalSubscription)sub;
|
|
var snapTasks = new Task<SubscriptionStateSnapshot>[5];
|
|
for (int i = 0; i < snapTasks.Length; i++)
|
|
{
|
|
snapTasks[i] = Task.Run(() => subConcrete.Snapshot(), ct);
|
|
}
|
|
await Task.WhenAll(addTasks).ConfigureAwait(false);
|
|
SubscriptionStateSnapshot[] snaps = await Task
|
|
.WhenAll(snapTasks).ConfigureAwait(false);
|
|
|
|
foreach (SubscriptionStateSnapshot s in snaps)
|
|
{
|
|
int count = s.MonitoredItems.Count;
|
|
// Snapshot is captured at a point in time — count is
|
|
// between 0 and itemCount inclusive. The critical
|
|
// invariant: each captured item has a non-empty name
|
|
// (i.e. no partially-constructed entries leaked).
|
|
foreach (MonitoredItemStateSnapshot it in s.MonitoredItems)
|
|
{
|
|
Assert.That(it.Name, Is.Not.Null.And.Not.Empty);
|
|
}
|
|
}
|
|
|
|
Assert.That(sub.MonitoredItems.Count, Is.EqualTo((uint)itemCount));
|
|
|
|
await sub.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
await session.CloseAsync().ConfigureAwait(false);
|
|
await session.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
private async Task<ManagedSession> ConnectV2Async(
|
|
string sessionName, CancellationToken ct)
|
|
{
|
|
ConfiguredEndpoint endpoint = await ClientFixture
|
|
.GetEndpointAsync(ServerUrl, SecurityPolicies.None)
|
|
.ConfigureAwait(false);
|
|
return await new ManagedSessionBuilder(ClientFixture.Config, Telemetry)
|
|
.UseEndpoint(endpoint)
|
|
.WithSessionName(sessionName)
|
|
.WithSessionTimeout(TimeSpan.FromSeconds(120))
|
|
.ConnectAsync(ct).ConfigureAwait(false);
|
|
}
|
|
|
|
private static async Task<bool> WaitForAsync(
|
|
Func<bool> predicate, TimeSpan timeout, CancellationToken ct)
|
|
{
|
|
DateTime deadline = DateTime.UtcNow + timeout;
|
|
while (DateTime.UtcNow < deadline)
|
|
{
|
|
ct.ThrowIfCancellationRequested();
|
|
if (predicate())
|
|
{
|
|
return true;
|
|
}
|
|
await Task.Delay(50, ct).ConfigureAwait(false);
|
|
}
|
|
return predicate();
|
|
}
|
|
}
|
|
}
|