mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-22 17:50:03 +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>
1137 lines
47 KiB
C#
1137 lines
47 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/
|
|
* ======================================================================*/
|
|
|
|
using System;
|
|
using System.Collections.Concurrent;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics.Metrics;
|
|
using System.Linq;
|
|
using System.Security.Cryptography;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Extensions.Logging;
|
|
using Moq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Bindings;
|
|
using Opc.Ua.Security.Certificates;
|
|
using Opc.Ua.Tests;
|
|
|
|
// CA2000: test code; disposables are released by test cleanup paths.
|
|
#pragma warning disable CA2000
|
|
|
|
namespace Opc.Ua.Core.Tests.Stack.Client
|
|
{
|
|
/// <summary>
|
|
/// Tests certificate-rotation integration for <see cref="ClientChannelManager"/>.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Client")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
[Parallelizable]
|
|
public sealed class ClientChannelManagerCertRotationTests
|
|
{
|
|
private static readonly ICertificateFactory s_factory = DefaultCertificateFactory.Instance;
|
|
private static readonly int[] s_firstTwoReconnectAttempts = [0, 1];
|
|
|
|
[TestCase(false)]
|
|
[TestCase(true)]
|
|
public async Task QueuedRotationRetainsProducerCertificateMaterialAsync(bool sendChain)
|
|
{
|
|
using Certificate original = s_factory.CreateCertificate("CN=queued-original").CreateForRSA();
|
|
using Certificate first = s_factory.CreateCertificate("CN=queued-first").CreateForRSA();
|
|
var changes = new TestCertificateChangeSource();
|
|
var certificateManager = new Mock<ICertificateManager>();
|
|
certificateManager.SetupGet(value => value.CertificateChanges).Returns(changes);
|
|
var configuration = new ApplicationConfiguration(NUnitTelemetryContext.Create())
|
|
{
|
|
CertificateManager = certificateManager.Object
|
|
};
|
|
configuration.SecurityConfiguration.ApplicationCertificate = new CertificateIdentifier
|
|
{
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
Thumbprint = original.Thumbprint
|
|
};
|
|
configuration.SecurityConfiguration.SendCertificateChain = sendChain;
|
|
var installed = new ConcurrentQueue<(Certificate Certificate, CertificateCollection? Chain)>();
|
|
var entered = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
var started = new TaskCompletionSource<Task>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
using var release = new ManualResetEventSlim();
|
|
var host = new RotationHost(
|
|
configuration,
|
|
task =>
|
|
{
|
|
if (task != null)
|
|
{
|
|
started.TrySetResult(task);
|
|
}
|
|
},
|
|
(certificate, chain) =>
|
|
{
|
|
if (installed.IsEmpty)
|
|
{
|
|
entered.TrySetResult(true);
|
|
if (!release.Wait(TimeSpan.FromSeconds(5)))
|
|
{
|
|
throw new TimeoutException("The first certificate installation was not released.");
|
|
}
|
|
}
|
|
installed.Enqueue((certificate, chain));
|
|
});
|
|
using var rotation = new ClientChannelManagerCertRotation(host);
|
|
rotation.WireCertificateRotation();
|
|
Task drain = Task.CompletedTask;
|
|
try
|
|
{
|
|
changes.Raise(new CertificateChangeEvent(
|
|
CertificateChangeKind.ApplicationCertificateUpdated, TrustListIdentifier.Peers,
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType, original, first, null));
|
|
drain = await started.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
|
|
await entered.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
|
|
string thumbprint;
|
|
using (Certificate next = s_factory.CreateCertificate("CN=queued-next").CreateForRSA())
|
|
using (CertificateCollection chain = [next])
|
|
{
|
|
thumbprint = next.Thumbprint;
|
|
changes.Raise(new CertificateChangeEvent(
|
|
CertificateChangeKind.ApplicationCertificateUpdated, TrustListIdentifier.Peers,
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType, original, next, chain));
|
|
}
|
|
release.Set();
|
|
await drain.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
|
|
Assert.That(installed, Has.Count.EqualTo(2));
|
|
Assert.That(installed.Last().Certificate.Thumbprint, Is.EqualTo(thumbprint));
|
|
Assert.That(installed.Last().Certificate.HasPrivateKey, Is.True);
|
|
Assert.That(installed.Last().Chain != null, Is.EqualTo(sendChain));
|
|
}
|
|
finally
|
|
{
|
|
release.Set();
|
|
await drain.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
|
|
while (installed.TryDequeue(out (Certificate Certificate, CertificateCollection? Chain) material))
|
|
{
|
|
material.Certificate.Dispose();
|
|
material.Chain?.Dispose();
|
|
}
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task CertificateRotationTriggersReconnectAllAsync()
|
|
{
|
|
using Certificate oldCertificate = s_factory.CreateCertificate("CN=old-client").CreateForRSA();
|
|
using Certificate newCertificate = s_factory.CreateCertificate("CN=new-client").CreateForRSA();
|
|
using Certificate serverCertificate = s_factory.CreateCertificate("CN=server").CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(oldCertificate, changes, openSettings);
|
|
ConfiguredEndpoint endpoint = GetTestEndpoint(serverCertificate);
|
|
TestParticipant firstParticipant = new("first", endpoint);
|
|
TestParticipant secondParticipant = new("second", endpoint);
|
|
IManagedTransportChannel? firstChannel = null;
|
|
IManagedTransportChannel? secondChannel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(oldCertificate, null);
|
|
firstChannel = await sut.GetAsync(firstParticipant).ConfigureAwait(false);
|
|
secondChannel = await sut.GetAsync(secondParticipant).ConfigureAwait(false);
|
|
|
|
changes.Raise(new CertificateChangeEvent(
|
|
CertificateChangeKind.ApplicationCertificateUpdated,
|
|
TrustListIdentifier.Peers,
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
oldCertificate,
|
|
newCertificate,
|
|
null));
|
|
|
|
await WaitUntilAsync(() =>
|
|
firstParticipant.NotificationCount == 1 &&
|
|
secondParticipant.NotificationCount == 1 &&
|
|
openSettings.Count >= 2).ConfigureAwait(false);
|
|
|
|
TransportChannelSettings[] settings = [.. openSettings];
|
|
Assert.That(settings[^1].ClientCertificate?.Thumbprint, Is.EqualTo(newCertificate.Thumbprint));
|
|
Assert.That(firstParticipant.NotificationCount, Is.EqualTo(1));
|
|
Assert.That(secondParticipant.NotificationCount, Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
if (firstChannel != null)
|
|
{
|
|
await firstChannel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
|
|
if (secondChannel != null)
|
|
{
|
|
await secondChannel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task CertificateRotationIgnoresUnrelatedCerts()
|
|
{
|
|
using Certificate oldCertificate = s_factory.CreateCertificate("CN=old-client").CreateForRSA();
|
|
using Certificate unrelatedOldCertificate = s_factory.CreateCertificate("CN=old-other").CreateForRSA();
|
|
using Certificate unrelatedNewCertificate = s_factory.CreateCertificate("CN=new-other").CreateForRSA();
|
|
using Certificate serverCertificate = s_factory.CreateCertificate("CN=server").CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(oldCertificate, changes, openSettings);
|
|
ConfiguredEndpoint endpoint = GetTestEndpoint(serverCertificate);
|
|
TestParticipant participant = new("participant", endpoint);
|
|
IManagedTransportChannel? channel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(oldCertificate, null);
|
|
channel = await sut.GetAsync(participant).ConfigureAwait(false);
|
|
|
|
changes.Raise(new CertificateChangeEvent(
|
|
CertificateChangeKind.ApplicationCertificateUpdated,
|
|
TrustListIdentifier.Peers,
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
unrelatedOldCertificate,
|
|
unrelatedNewCertificate,
|
|
null));
|
|
|
|
await Task.Delay(TimeSpan.FromMilliseconds(100)).ConfigureAwait(false);
|
|
|
|
Assert.That(participant.NotificationCount, Is.Zero);
|
|
Assert.That(openSettings, Has.Count.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
if (channel != null)
|
|
{
|
|
await channel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[TestCase(false)]
|
|
[TestCase(true)]
|
|
public async Task ReconnectUsesLatestCertificateForEachEntryTypeAsync(bool reusableTransport)
|
|
{
|
|
using Certificate oldRsa = s_factory.CreateCertificate("CN=old-rsa").CreateForRSA();
|
|
using Certificate newRsa = s_factory.CreateCertificate("CN=new-rsa").CreateForRSA();
|
|
using Certificate oldEcc = s_factory.CreateCertificate("CN=old-ecc")
|
|
.SetECCurve(ECCurve.NamedCurves.nistP256).CreateForECDsa();
|
|
using Certificate newEcc = s_factory.CreateCertificate("CN=new-ecc")
|
|
.SetECCurve(ECCurve.NamedCurves.nistP256).CreateForECDsa();
|
|
using Certificate server = s_factory.CreateCertificate("CN=server").CreateForRSA();
|
|
var changes = new TestCertificateChangeSource();
|
|
var settings = new ConcurrentQueue<TransportChannelSettings>();
|
|
await using ClientChannelManager manager = CreateSut(
|
|
oldRsa, changes, settings, reusableTransport: reusableTransport);
|
|
ConfiguredEndpoint rsaEndpoint = GetTestEndpoint(server);
|
|
ConfiguredEndpoint eccEndpoint = GetTestEndpoint(server);
|
|
eccEndpoint.Description.EndpointUrl = "opc.tcp://localhost:4841";
|
|
eccEndpoint.Description.SecurityPolicyUri = SecurityPolicies.ECC_nistP256;
|
|
try
|
|
{
|
|
manager.UpdateClientCertificate(oldRsa.AddRef(), null);
|
|
using IManagedTransportChannel rsa = await manager.GetAsync(new TestParticipant("rsa", rsaEndpoint))
|
|
.ConfigureAwait(false);
|
|
manager.UpdateClientCertificate(oldEcc.AddRef(), null);
|
|
using IManagedTransportChannel ecc = await manager.GetAsync(new TestParticipant("ecc", eccEndpoint))
|
|
.ConfigureAwait(false);
|
|
|
|
await manager.ReconnectAllAsync().ConfigureAwait(false);
|
|
Assert.That(settings.Last(value => value.Description?.EndpointUrl == rsa.Key.EndpointUrl)
|
|
.ClientCertificate!.Thumbprint, Is.EqualTo(oldRsa.Thumbprint));
|
|
|
|
manager.UpdateClientCertificate(newRsa.AddRef(), null);
|
|
manager.UpdateClientCertificate(newEcc.AddRef(), null);
|
|
await manager.ReconnectAllAsync().ConfigureAwait(false);
|
|
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(settings.Last(value => value.Description?.EndpointUrl == rsa.Key.EndpointUrl)
|
|
.ClientCertificate!.Thumbprint, Is.EqualTo(newRsa.Thumbprint));
|
|
Assert.That(settings.Last(value => value.Description?.EndpointUrl == ecc.Key.EndpointUrl)
|
|
.ClientCertificate!.Thumbprint, Is.EqualTo(newEcc.Thumbprint));
|
|
Assert.That(manager.GetChannelDiagnostics().Select(value => value.Refcount), Is.All.EqualTo(1));
|
|
Assert.That(rsa.State, Is.EqualTo(ChannelState.Ready));
|
|
Assert.That(ecc.State, Is.EqualTo(ChannelState.Ready));
|
|
});
|
|
int opened = settings.Count;
|
|
await manager.ReconnectAllAsync().ConfigureAwait(false);
|
|
Assert.That(settings, Has.Count.EqualTo(reusableTransport ? opened : opened + 2));
|
|
}
|
|
finally
|
|
{
|
|
await manager.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(settings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ReconnectCompletionWaitsForCycleCleanupAsync()
|
|
{
|
|
using Certificate client = s_factory.CreateCertificate("CN=cleanup-client").CreateForRSA();
|
|
using Certificate server = s_factory.CreateCertificate("CN=cleanup-server").CreateForRSA();
|
|
var settings = new ConcurrentQueue<TransportChannelSettings>();
|
|
var changes = new TestCertificateChangeSource();
|
|
await using ClientChannelManager manager = CreateSut(client, changes, settings);
|
|
ConfiguredEndpoint endpoint = GetTestEndpoint(server);
|
|
endpoint.Description.EndpointUrl = "opc.tcp://localhost:4842/reconnect-cleanup";
|
|
var participant = new BlockingRecreateParticipant("cleanup", endpoint);
|
|
var completedDuringCleanup = new TaskCompletionSource<bool>(
|
|
TaskCreationOptions.RunContinuationsAsynchronously);
|
|
Task<bool>? reconnect = null;
|
|
using var listener = new MeterListener
|
|
{
|
|
InstrumentPublished = (instrument, meterListener) =>
|
|
{
|
|
if (instrument.Name == "opc.ua.channel.reconnect.duration")
|
|
{
|
|
meterListener.EnableMeasurementEvents(instrument);
|
|
}
|
|
}
|
|
};
|
|
listener.SetMeasurementEventCallback<double>((_, _, tags, _) =>
|
|
{
|
|
foreach (KeyValuePair<string, object?> tag in tags)
|
|
{
|
|
if (tag.Key == "endpoint" &&
|
|
tag.Value is string endpointUrl &&
|
|
endpointUrl == endpoint.Description.EndpointUrl)
|
|
{
|
|
completedDuringCleanup.TrySetResult(reconnect!.IsCompleted);
|
|
}
|
|
}
|
|
});
|
|
listener.Start();
|
|
ManagedTransportChannelLease? lease = null;
|
|
try
|
|
{
|
|
manager.UpdateClientCertificate(client.AddRef(), null);
|
|
lease = (ManagedTransportChannelLease)await manager.GetAsync(participant).ConfigureAwait(false);
|
|
reconnect = lease.Entry.RequestReconnectAsync(default);
|
|
await participant.RecreateStarted.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false);
|
|
participant.ReleaseRecreate();
|
|
|
|
Assert.That(await reconnect.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false), Is.True);
|
|
Assert.That(
|
|
await completedDuringCleanup.Task.WaitAsync(TimeSpan.FromSeconds(5)).ConfigureAwait(false),
|
|
Is.False,
|
|
"Reconnect waiters must not resume before the completed cycle releases its coalescer.");
|
|
Assert.That(lease.State, Is.EqualTo(ChannelState.Ready));
|
|
Assert.That(lease.Entry.RefCount, Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
participant.ReleaseRecreate();
|
|
if (lease != null)
|
|
{
|
|
await lease.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
await manager.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(settings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ReconnectWaitsForRequiredParticipantRecreationAsync()
|
|
{
|
|
using Certificate clientCertificate = s_factory
|
|
.CreateCertificate("CN=recreate-client")
|
|
.CreateForRSA();
|
|
using Certificate serverCertificate = s_factory
|
|
.CreateCertificate("CN=recreate-server")
|
|
.CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(
|
|
clientCertificate,
|
|
changes,
|
|
openSettings);
|
|
var participant = new BlockingRecreateParticipant(
|
|
"recreate",
|
|
GetTestEndpoint(serverCertificate));
|
|
IManagedTransportChannel? channel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(clientCertificate, null);
|
|
channel = await sut.GetAsync(participant).ConfigureAwait(false);
|
|
|
|
Task reconnect = sut.ReconnectAsync(channel).AsTask();
|
|
await participant.RecreateStarted.Task
|
|
.WaitAsync(TimeSpan.FromSeconds(5))
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(reconnect.IsCompleted, Is.False);
|
|
Assert.That(channel.State, Is.Not.EqualTo(ChannelState.Ready));
|
|
|
|
participant.ReleaseRecreate();
|
|
await reconnect.ConfigureAwait(false);
|
|
|
|
Assert.That(participant.RecreateCount, Is.EqualTo(1));
|
|
Assert.That(channel.State, Is.EqualTo(ChannelState.Ready));
|
|
}
|
|
finally
|
|
{
|
|
participant.ReleaseRecreate();
|
|
if (channel != null)
|
|
{
|
|
await channel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ReconnectRetriesAfterParticipantRecreationFailureAsync()
|
|
{
|
|
using Certificate clientCertificate = s_factory
|
|
.CreateCertificate("CN=retry-client")
|
|
.CreateForRSA();
|
|
using Certificate serverCertificate = s_factory
|
|
.CreateCertificate("CN=retry-server")
|
|
.CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(
|
|
clientCertificate,
|
|
changes,
|
|
openSettings,
|
|
new FixedAttemptReconnectPolicy(2));
|
|
var participant = new FailingRecreateParticipant(
|
|
"retry",
|
|
GetTestEndpoint(serverCertificate),
|
|
failuresBeforeSuccess: 1);
|
|
var states = new ConcurrentQueue<ChannelState>();
|
|
IManagedTransportChannel? channel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(clientCertificate, null);
|
|
channel = await sut.GetAsync(participant).ConfigureAwait(false);
|
|
channel.StateChanged += (_, change) => states.Enqueue(change.NewState);
|
|
|
|
await sut.ReconnectAsync(channel).ConfigureAwait(false);
|
|
|
|
Assert.That(participant.RecreateCount, Is.EqualTo(2));
|
|
Assert.That(participant.ReconnectAttempts, Is.EqualTo(s_firstTwoReconnectAttempts));
|
|
Assert.That(
|
|
states.Count(state => state == ChannelState.TransportReconnecting),
|
|
Is.EqualTo(2));
|
|
Assert.That(
|
|
states.Count(state => state == ChannelState.TransportConnectedSessionReactivating),
|
|
Is.EqualTo(2));
|
|
Assert.That(channel.State, Is.EqualTo(ChannelState.Ready));
|
|
}
|
|
finally
|
|
{
|
|
if (channel != null)
|
|
{
|
|
await channel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ReconnectFaultsAfterParticipantRecreationFailuresExhaustPolicyAsync()
|
|
{
|
|
using Certificate clientCertificate = s_factory
|
|
.CreateCertificate("CN=failure-client")
|
|
.CreateForRSA();
|
|
using Certificate serverCertificate = s_factory
|
|
.CreateCertificate("CN=failure-server")
|
|
.CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(
|
|
clientCertificate,
|
|
changes,
|
|
openSettings,
|
|
new FixedAttemptReconnectPolicy(2));
|
|
var participant = new FailingRecreateParticipant(
|
|
"failure",
|
|
GetTestEndpoint(serverCertificate),
|
|
failuresBeforeSuccess: int.MaxValue);
|
|
IManagedTransportChannel? channel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(clientCertificate, null);
|
|
channel = await sut.GetAsync(participant).ConfigureAwait(false);
|
|
|
|
await sut.ReconnectAsync(channel).ConfigureAwait(false);
|
|
|
|
Assert.That(participant.RecreateCount, Is.EqualTo(2));
|
|
Assert.That(participant.ReconnectAttempts, Is.EqualTo(s_firstTwoReconnectAttempts));
|
|
Assert.That(channel.State, Is.EqualTo(ChannelState.Faulted));
|
|
Assert.That(
|
|
sut.GetChannelDiagnostics().Single().LastReconnectAttempt,
|
|
Is.EqualTo(2));
|
|
}
|
|
finally
|
|
{
|
|
if (channel != null)
|
|
{
|
|
await channel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task DisposeCancelsParticipantRecreationAndCleansEntryAsync()
|
|
{
|
|
using Certificate clientCertificate = s_factory
|
|
.CreateCertificate("CN=cancel-client")
|
|
.CreateForRSA();
|
|
using Certificate serverCertificate = s_factory
|
|
.CreateCertificate("CN=cancel-server")
|
|
.CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(
|
|
clientCertificate,
|
|
changes,
|
|
openSettings,
|
|
new FixedAttemptReconnectPolicy(3));
|
|
var participant = new CancellationAwareRecreateParticipant(
|
|
"cancel",
|
|
GetTestEndpoint(serverCertificate));
|
|
IManagedTransportChannel? channel = null;
|
|
|
|
try
|
|
{
|
|
channel = await sut.GetAsync(participant).ConfigureAwait(false);
|
|
Task reconnect = sut.ReconnectAsync(channel).AsTask();
|
|
await participant.RecreateStarted.Task
|
|
.WaitAsync(TimeSpan.FromSeconds(5))
|
|
.ConfigureAwait(false);
|
|
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
await participant.RecreateCanceled.Task
|
|
.WaitAsync(TimeSpan.FromSeconds(5))
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
async () => await reconnect.ConfigureAwait(false),
|
|
Throws.InstanceOf<OperationCanceledException>());
|
|
Assert.That(participant.RecreateCount, Is.EqualTo(1));
|
|
Assert.That(channel.State, Is.EqualTo(ChannelState.Closed));
|
|
Assert.That(sut.GetChannelDiagnostics(), Is.Empty);
|
|
}
|
|
finally
|
|
{
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ReconnectingStaleLeasesReusesReplacementEntryAsync()
|
|
{
|
|
using Certificate clientCertificate = s_factory
|
|
.CreateCertificate("CN=stale-client")
|
|
.CreateForRSA();
|
|
using Certificate serverCertificate = s_factory
|
|
.CreateCertificate("CN=stale-server")
|
|
.CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(clientCertificate, changes, openSettings);
|
|
ConfiguredEndpoint endpoint = GetTestEndpoint(serverCertificate);
|
|
var fatalOnce = new FatalOnceParticipant("fatal-once", endpoint);
|
|
var stable = new TestParticipant("stable", endpoint);
|
|
IManagedTransportChannel? firstChannel = null;
|
|
IManagedTransportChannel? secondChannel = null;
|
|
|
|
try
|
|
{
|
|
sut.UpdateClientCertificate(clientCertificate, null);
|
|
firstChannel = await sut.GetAsync(fatalOnce).ConfigureAwait(false);
|
|
secondChannel = await sut.GetAsync(stable).ConfigureAwait(false);
|
|
|
|
await sut.ReconnectAsync(firstChannel).ConfigureAwait(false);
|
|
Assert.That(firstChannel.State, Is.EqualTo(ChannelState.Faulted));
|
|
Assert.That(secondChannel.State, Is.EqualTo(ChannelState.Faulted));
|
|
|
|
await sut.ReconnectAsync(firstChannel).ConfigureAwait(false);
|
|
await sut.ReconnectAsync(secondChannel).ConfigureAwait(false);
|
|
|
|
ManagedChannelDiagnostic diagnostic = sut.GetChannelDiagnostics().Single();
|
|
Assert.That(firstChannel.State, Is.EqualTo(ChannelState.Ready));
|
|
Assert.That(secondChannel.State, Is.EqualTo(ChannelState.Ready));
|
|
Assert.That(diagnostic.Refcount, Is.EqualTo(2));
|
|
Assert.That(diagnostic.ParticipantCount, Is.EqualTo(2));
|
|
}
|
|
finally
|
|
{
|
|
if (firstChannel != null)
|
|
{
|
|
await firstChannel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
if (secondChannel != null)
|
|
{
|
|
await secondChannel.CloseAsync().ConfigureAwait(false);
|
|
}
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
DisposeOpenedCertificates(openSettings);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task DisposeUnsubscribesFromCertEvent()
|
|
{
|
|
using Certificate oldCertificate = s_factory.CreateCertificate("CN=old-client").CreateForRSA();
|
|
using Certificate newCertificate = s_factory.CreateCertificate("CN=new-client").CreateForRSA();
|
|
|
|
TestCertificateChangeSource changes = new();
|
|
ConcurrentQueue<TransportChannelSettings> openSettings = new();
|
|
ClientChannelManager sut = CreateSut(oldCertificate, changes, openSettings);
|
|
|
|
Assert.That(changes.ObserverCount, Is.EqualTo(1));
|
|
|
|
await sut.DisposeAsync().ConfigureAwait(false);
|
|
changes.Raise(new CertificateChangeEvent(
|
|
CertificateChangeKind.ApplicationCertificateUpdated,
|
|
TrustListIdentifier.Peers,
|
|
ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
oldCertificate,
|
|
newCertificate,
|
|
null));
|
|
|
|
await Task.Delay(TimeSpan.FromMilliseconds(100)).ConfigureAwait(false);
|
|
|
|
Assert.That(changes.ObserverCount, Is.Zero);
|
|
Assert.That(openSettings, Is.Empty);
|
|
}
|
|
|
|
private sealed class RotationHost(
|
|
ApplicationConfiguration configuration,
|
|
Action<Task?> stateChanged,
|
|
Action<Certificate, CertificateCollection?> install) : IChannelCertRotationHost
|
|
{
|
|
public ApplicationConfiguration Configuration => configuration;
|
|
|
|
public ILogger? Logger => null;
|
|
|
|
public bool IsDisposed => false;
|
|
|
|
public ChannelEntry[] SnapshotEntries()
|
|
{
|
|
return [];
|
|
}
|
|
|
|
public void ReplaceClientCertificate(Certificate? certificate, CertificateCollection? chain)
|
|
{
|
|
install(certificate ?? throw new ArgumentNullException(nameof(certificate)), chain);
|
|
}
|
|
|
|
public void SetCertificateRotationTask(Task? task)
|
|
{
|
|
stateChanged(task);
|
|
}
|
|
}
|
|
|
|
private static ClientChannelManager CreateSut(
|
|
Certificate applicationCertificate,
|
|
TestCertificateChangeSource changes,
|
|
ConcurrentQueue<TransportChannelSettings> openSettings,
|
|
IChannelReconnectPolicy? reconnectPolicy = null,
|
|
bool reusableTransport = false)
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
var certificateManager = new Mock<ICertificateManager>();
|
|
certificateManager.SetupGet(m => m.CertificateChanges).Returns(changes);
|
|
|
|
var channel = new Mock<IChannel>();
|
|
channel.Setup(c => c.OpenAsync(
|
|
It.IsAny<Uri>(),
|
|
It.IsAny<TransportChannelSettings>(),
|
|
It.IsAny<CancellationToken>()))
|
|
.Callback<Uri, TransportChannelSettings, CancellationToken>((_, settings, _) =>
|
|
openSettings.Enqueue(settings))
|
|
.Returns(new ValueTask());
|
|
channel.Setup(c => c.OpenAsync(
|
|
It.IsAny<ITransportWaitingConnection>(),
|
|
It.IsAny<TransportChannelSettings>(),
|
|
It.IsAny<CancellationToken>()))
|
|
.Callback<ITransportWaitingConnection, TransportChannelSettings, CancellationToken>((_, settings, _) =>
|
|
openSettings.Enqueue(settings))
|
|
.Returns(new ValueTask());
|
|
channel.Setup(c => c.CloseAsync(It.IsAny<CancellationToken>())).Returns(new ValueTask());
|
|
channel.Setup(c => c.SupportedFeatures).Returns(reusableTransport
|
|
? TransportChannelFeatures.Reconnect
|
|
: TransportChannelFeatures.None);
|
|
|
|
var bindings = new Mock<ITransportChannelBindings>();
|
|
bindings.Setup(b => b.Create(It.IsAny<string>(), It.IsAny<ITelemetryContext>()))
|
|
.Returns(channel.Object);
|
|
|
|
var configuration = new ApplicationConfiguration(telemetry)
|
|
{
|
|
CertificateManager = certificateManager.Object
|
|
};
|
|
configuration.SecurityConfiguration.ApplicationCertificate = new CertificateIdentifier
|
|
{
|
|
CertificateType = ObjectTypeIds.RsaSha256ApplicationCertificateType,
|
|
Thumbprint = applicationCertificate.Thumbprint
|
|
};
|
|
configuration.SecurityConfiguration.SendCertificateChain = false;
|
|
|
|
return new ClientChannelManager(
|
|
configuration,
|
|
telemetry,
|
|
bindings.Object,
|
|
reconnectPolicy ?? new ImmediateReconnectPolicy());
|
|
}
|
|
|
|
private static ConfiguredEndpoint GetTestEndpoint(Certificate serverCertificate)
|
|
{
|
|
var endpoint = new ConfiguredEndpoint
|
|
{
|
|
Configuration = new EndpointConfiguration
|
|
{
|
|
OperationTimeout = 6000
|
|
}
|
|
};
|
|
endpoint.Description.EndpointUrl = "opc.tcp://localhost:4840";
|
|
endpoint.Description.SecurityMode = MessageSecurityMode.SignAndEncrypt;
|
|
endpoint.Description.SecurityPolicyUri = SecurityPolicies.Basic256Sha256;
|
|
endpoint.Description.ServerCertificate = serverCertificate.RawData.ToByteString();
|
|
return endpoint;
|
|
}
|
|
|
|
private static async Task WaitUntilAsync(Func<bool> condition)
|
|
{
|
|
DateTime deadline = DateTime.UtcNow.AddSeconds(5);
|
|
while (!condition())
|
|
{
|
|
if (DateTime.UtcNow >= deadline)
|
|
{
|
|
Assert.Fail("The certificate rotation reconnect did not complete in time.");
|
|
}
|
|
|
|
await Task.Delay(TimeSpan.FromMilliseconds(20)).ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Releases the certificate handles a real channel would own.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// A production channel takes over everything on the settings and
|
|
/// releases it when it closes: the server certificate it parses out of
|
|
/// the description, and the client certificate and chain the manager
|
|
/// hands it a reference of its own on. The mock channel captures the
|
|
/// settings and does neither, so the test stands in for it.
|
|
/// </remarks>
|
|
private static void DisposeOpenedCertificates(
|
|
ConcurrentQueue<TransportChannelSettings> openSettings)
|
|
{
|
|
while (openSettings.TryDequeue(out TransportChannelSettings? opened))
|
|
{
|
|
opened.ServerCertificate?.Dispose();
|
|
opened.ClientCertificate?.Dispose();
|
|
opened.ClientCertificateChain?.Dispose();
|
|
}
|
|
}
|
|
|
|
public interface IChannel : ITransportChannel, ISecureChannel;
|
|
|
|
private sealed class ImmediateReconnectPolicy : IChannelReconnectPolicy
|
|
{
|
|
public TimeSpan GetDelay(int attempt)
|
|
{
|
|
return attempt == 0 ? TimeSpan.Zero : Timeout.InfiniteTimeSpan;
|
|
}
|
|
}
|
|
|
|
private sealed class FixedAttemptReconnectPolicy : IChannelReconnectPolicy
|
|
{
|
|
public FixedAttemptReconnectPolicy(int maxAttempts)
|
|
{
|
|
m_maxAttempts = maxAttempts;
|
|
}
|
|
|
|
public TimeSpan GetDelay(int attempt)
|
|
{
|
|
return attempt < m_maxAttempts
|
|
? TimeSpan.Zero
|
|
: Timeout.InfiniteTimeSpan;
|
|
}
|
|
|
|
private readonly int m_maxAttempts;
|
|
}
|
|
|
|
private sealed class TestCertificateChangeSource : IObservable<CertificateChangeEvent>
|
|
{
|
|
public int ObserverCount
|
|
{
|
|
get
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
return m_observers.Count;
|
|
}
|
|
}
|
|
}
|
|
|
|
public IDisposable Subscribe(IObserver<CertificateChangeEvent> observer)
|
|
{
|
|
if (observer == null)
|
|
{
|
|
throw new ArgumentNullException(nameof(observer));
|
|
}
|
|
|
|
lock (m_lock)
|
|
{
|
|
m_observers.Add(observer);
|
|
}
|
|
|
|
return new Subscription(this, observer);
|
|
}
|
|
|
|
public void Raise(CertificateChangeEvent evt)
|
|
{
|
|
IObserver<CertificateChangeEvent>[] snapshot;
|
|
lock (m_lock)
|
|
{
|
|
snapshot = [.. m_observers];
|
|
}
|
|
|
|
for (int i = 0; i < snapshot.Length; i++)
|
|
{
|
|
snapshot[i].OnNext(evt);
|
|
}
|
|
}
|
|
|
|
private void Unsubscribe(IObserver<CertificateChangeEvent> observer)
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
m_observers.Remove(observer);
|
|
}
|
|
}
|
|
|
|
private sealed class Subscription : IDisposable
|
|
{
|
|
public Subscription(
|
|
TestCertificateChangeSource owner,
|
|
IObserver<CertificateChangeEvent> observer)
|
|
{
|
|
m_owner = owner;
|
|
m_observer = observer;
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
if (Interlocked.Exchange(ref m_disposed, 1) != 0)
|
|
{
|
|
return;
|
|
}
|
|
|
|
m_owner.Unsubscribe(m_observer);
|
|
}
|
|
|
|
private readonly TestCertificateChangeSource m_owner;
|
|
private readonly IObserver<CertificateChangeEvent> m_observer;
|
|
private int m_disposed;
|
|
}
|
|
|
|
private readonly Lock m_lock = new();
|
|
private readonly List<IObserver<CertificateChangeEvent>> m_observers = [];
|
|
}
|
|
|
|
private sealed class TestParticipant : IReconnectParticipant
|
|
{
|
|
private int m_notificationCount;
|
|
|
|
public TestParticipant(string id, ConfiguredEndpoint endpoint)
|
|
{
|
|
Id = id;
|
|
Endpoint = endpoint;
|
|
}
|
|
|
|
public string Id { get; }
|
|
|
|
public ConfiguredEndpoint Endpoint { get; }
|
|
|
|
public int NotificationCount => Volatile.Read(ref m_notificationCount);
|
|
|
|
/// <inheritdoc/>
|
|
public IRetryBudget? CreateReconnectBudget(TimeProvider timeProvider)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
public ValueTask<ParticipantReconnectResult> OnReconnectAsync(
|
|
IManagedTransportChannel channel,
|
|
int reconnectAttempt,
|
|
CancellationToken ct)
|
|
{
|
|
Interlocked.Increment(ref m_notificationCount);
|
|
return new ValueTask<ParticipantReconnectResult>(ParticipantReconnectResult.Reactivated);
|
|
}
|
|
}
|
|
|
|
private sealed class BlockingRecreateParticipant :
|
|
IRecreateAwareReconnectParticipant
|
|
{
|
|
public BlockingRecreateParticipant(
|
|
string id,
|
|
ConfiguredEndpoint endpoint)
|
|
{
|
|
Id = id;
|
|
Endpoint = endpoint;
|
|
}
|
|
|
|
public string Id { get; }
|
|
|
|
public ConfiguredEndpoint Endpoint { get; }
|
|
|
|
public TaskCompletionSource<bool> RecreateStarted { get; } =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
public int RecreateCount => Volatile.Read(ref m_recreateCount);
|
|
|
|
/// <inheritdoc/>
|
|
public IRetryBudget? CreateReconnectBudget(TimeProvider timeProvider)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
public ValueTask<ParticipantReconnectResult> OnReconnectAsync(
|
|
IManagedTransportChannel channel,
|
|
int reconnectAttempt,
|
|
CancellationToken ct)
|
|
{
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
reconnectAttempt < 0
|
|
? ParticipantReconnectResult.Reactivated
|
|
: ParticipantReconnectResult.RequiresSessionRecreate);
|
|
}
|
|
|
|
public async ValueTask RecreateAsync(CancellationToken ct = default)
|
|
{
|
|
Interlocked.Increment(ref m_recreateCount);
|
|
RecreateStarted.TrySetResult(true);
|
|
await m_release.Task.WaitAsync(ct).ConfigureAwait(false);
|
|
}
|
|
|
|
public void ReleaseRecreate()
|
|
{
|
|
m_release.TrySetResult(true);
|
|
}
|
|
|
|
private readonly TaskCompletionSource<bool> m_release =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
private int m_recreateCount;
|
|
}
|
|
|
|
private sealed class FailingRecreateParticipant :
|
|
IRecreateAwareReconnectParticipant
|
|
{
|
|
public FailingRecreateParticipant(
|
|
string id,
|
|
ConfiguredEndpoint endpoint,
|
|
int failuresBeforeSuccess)
|
|
{
|
|
Id = id;
|
|
Endpoint = endpoint;
|
|
m_failuresBeforeSuccess = failuresBeforeSuccess;
|
|
}
|
|
|
|
public string Id { get; }
|
|
|
|
public ConfiguredEndpoint Endpoint { get; }
|
|
|
|
public int RecreateCount => Volatile.Read(ref m_recreateCount);
|
|
|
|
public int[] ReconnectAttempts => [.. m_reconnectAttempts];
|
|
|
|
/// <inheritdoc/>
|
|
public IRetryBudget? CreateReconnectBudget(TimeProvider timeProvider)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
public ValueTask<ParticipantReconnectResult> OnReconnectAsync(
|
|
IManagedTransportChannel channel,
|
|
int reconnectAttempt,
|
|
CancellationToken ct)
|
|
{
|
|
if (reconnectAttempt < 0)
|
|
{
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
ParticipantReconnectResult.Reactivated);
|
|
}
|
|
|
|
m_reconnectAttempts.Enqueue(reconnectAttempt);
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
ParticipantReconnectResult.RequiresSessionRecreate);
|
|
}
|
|
|
|
public ValueTask RecreateAsync(CancellationToken ct = default)
|
|
{
|
|
int attempt = Interlocked.Increment(ref m_recreateCount);
|
|
if (attempt <= m_failuresBeforeSuccess)
|
|
{
|
|
throw new InvalidOperationException("Injected recreation failure.");
|
|
}
|
|
|
|
return default;
|
|
}
|
|
|
|
private readonly ConcurrentQueue<int> m_reconnectAttempts = new();
|
|
private readonly int m_failuresBeforeSuccess;
|
|
private int m_recreateCount;
|
|
}
|
|
|
|
private sealed class CancellationAwareRecreateParticipant :
|
|
IRecreateAwareReconnectParticipant
|
|
{
|
|
public CancellationAwareRecreateParticipant(
|
|
string id,
|
|
ConfiguredEndpoint endpoint)
|
|
{
|
|
Id = id;
|
|
Endpoint = endpoint;
|
|
}
|
|
|
|
public string Id { get; }
|
|
|
|
public ConfiguredEndpoint Endpoint { get; }
|
|
|
|
public int RecreateCount => Volatile.Read(ref m_recreateCount);
|
|
|
|
public TaskCompletionSource<bool> RecreateStarted { get; } =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
public TaskCompletionSource<bool> RecreateCanceled { get; } =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
/// <inheritdoc/>
|
|
public IRetryBudget? CreateReconnectBudget(TimeProvider timeProvider)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
public ValueTask<ParticipantReconnectResult> OnReconnectAsync(
|
|
IManagedTransportChannel channel,
|
|
int reconnectAttempt,
|
|
CancellationToken ct)
|
|
{
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
reconnectAttempt < 0
|
|
? ParticipantReconnectResult.Reactivated
|
|
: ParticipantReconnectResult.RequiresSessionRecreate);
|
|
}
|
|
|
|
public async ValueTask RecreateAsync(CancellationToken ct = default)
|
|
{
|
|
Interlocked.Increment(ref m_recreateCount);
|
|
RecreateStarted.TrySetResult(true);
|
|
try
|
|
{
|
|
await Task.Delay(Timeout.InfiniteTimeSpan, ct).ConfigureAwait(false);
|
|
}
|
|
finally
|
|
{
|
|
if (ct.IsCancellationRequested)
|
|
{
|
|
RecreateCanceled.TrySetResult(true);
|
|
}
|
|
}
|
|
}
|
|
|
|
private int m_recreateCount;
|
|
}
|
|
|
|
private sealed class FatalOnceParticipant : IReconnectParticipant
|
|
{
|
|
public FatalOnceParticipant(string id, ConfiguredEndpoint endpoint)
|
|
{
|
|
Id = id;
|
|
Endpoint = endpoint;
|
|
}
|
|
|
|
public string Id { get; }
|
|
|
|
public ConfiguredEndpoint Endpoint { get; }
|
|
|
|
/// <inheritdoc/>
|
|
public IRetryBudget? CreateReconnectBudget(TimeProvider timeProvider)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
public ValueTask<ParticipantReconnectResult> OnReconnectAsync(
|
|
IManagedTransportChannel channel,
|
|
int reconnectAttempt,
|
|
CancellationToken ct)
|
|
{
|
|
if (reconnectAttempt < 0)
|
|
{
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
ParticipantReconnectResult.Reactivated);
|
|
}
|
|
|
|
return new ValueTask<ParticipantReconnectResult>(
|
|
Interlocked.Exchange(ref m_fatalReturned, 1) == 0
|
|
? ParticipantReconnectResult.FatalForChannel
|
|
: ParticipantReconnectResult.Reactivated);
|
|
}
|
|
|
|
private int m_fatalReturned;
|
|
}
|
|
}
|
|
}
|