mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 09:06:37 +08:00
romanett
28f1401324
Profiling the reference server under load showed most request-path CPU spent spinning on contended locks, plus several avoidable allocations per request or per node. This PR removes them, switches the reference server to Server GC, and adds the load harness used to measure it. ## Results Paired A/B against `master` (3 alternating rounds, medians, 20 sessions, workstation GC on both sides, 24-core machine): | Scenario | Throughput | p50 | p90 | Server CPU / op | Server alloc / op | Lock contention | |---|---|---|---|---|---|---| | Read, 1 value | **+45%** (94k → 137k req/s) | −20% | −46% | −37% | −39% | −94% | | Read, 100 values | **+40%** | −26% | −17% | −24% | −25% | +130% ¹ | | Read, 100 values, SignAndEncrypt | **+48%** | −36% | −20% | −30% | −26% | +106% ¹ | | Browse (Server object) | **+33%** | −31% | −12% | −13% | −14% | −40% | | Write, 100 values | +13% | −12% | −4% | −10% | −19% | −23% | | Data-change subscriptions | ±0 ² | ≈ | ≈ | −14% | −17% | −29% | ¹ The faster server spends more time in the remaining per-node locks. ² Throughput is bounded by the writer rate in this scenario. Separately, Server GC instead of workstation GC doubles Read-100 throughput (21k → 44k req/s) and cuts p90 from 2.1 ms to 0.6 ms, because workstation GC paused the server for about half the wall time under load. The working set grows from ~210 MB to ~430 MB. ## Changes - **`ObjectPool<T>`**: lock-free slot array. `ConcurrentBag.Count` took every per-thread lock on each `Return` of the pooled response value-task source, once per request. - **`FairRequestQueue`**: - drops redundant gate entries: the fail-fast pre-checks and the stopped check read volatile fields and are re-checked under the gate; the owner count is folded into selection; - coalesces wake pulses with a pending flag, so the bounded signal channel's lock is only taken when no token is outstanding. Wake-count semantics in the tests are unchanged. - **`DefaultServerResourceIsolationProvider`**: - compares peer addresses without `GetAddressBytes()` allocations; - builds the unsecured verification context only when a classifier is configured. - **TCP listener / channel**: caches the certificate DER copies per channel, keyed on the certificate instance. `X509Certificate2.RawData` returns a fresh copy on every access, and the listener read it for every request. - **`EndpointBase`**: resolves the request `ActivitySource` once instead of `Assembly.GetCallingAssembly()` per request. - **Node managers**: - one `ServerSystemContext` copy per request (cached on the `OperationContext`) for per-node callbacks: permission metadata, node metadata, view membership, method lookup; - removes a discarded copy in `GetReferenceDescriptionAsync`; - per-request operation caches are plain `Dictionary` instead of a `ConcurrentDictionary` with 24 lock objects; - the validation cache is built in one pass; - fixes zero-capacity error lists. - **`ResourceManager`**: translation lookups read an immutable snapshot that is rebuilt after writes. Browse serialised on the global lock for every display name. - **`MonitoredItem`**: shares the default `DataChangeFilter` instead of allocating one per sampled value. - **Reference server**: `ServerGarbageCollection=true`; new "Garbage collector mode" section in `docs/ServerScalability.md`. - **`perf/`**: `ServerLoadHarness` (out-of-process server plus load driver, server-side CPU/GC/alloc/contention deltas, optional `dotnet-trace` capture), `TraceAnalyzer` (TraceEvent-based CPU/allocation/contention aggregation), and paired A/B scripts. Not part of `UA.slnx`. ### Behaviour notes for custom node managers - The `IDictionary<NodeId, NodeState>` operation cache handed to overrides is now a `Dictionary`. It was a `ConcurrentDictionary`, but only one request flow uses it. - Within one request, per-node callbacks of a node manager share one `ServerSystemContext` copy. ### Later commits on this PR - **Permission checks without `NodeMetadata`** (`9068684c3`): the role-permission and access-restriction validators run on an internal `PermissionMetadata` struct; `AsyncCustomNodeManager` fills it on the stack from the same attributes and namespace defaults. Browse's reference filter reads 3 attributes per target instead of 13. Read 100 values: 120.6 → 95.7 KB/request, ~21k → 26k req/s; Browse 67.6 → 51.8 KB, 26.7k → 29.8k req/s. - **Read-only channel evidence** (`936b28d76`, `dc638ab9f`): `SecureChannelContext.ClientChannelCertificate`, `ServerChannelCertificate` and `ChannelThumbprint` are `ByteString`, so the cached per-channel certificate buffer is shared without a copy and cannot be altered by handlers or classifiers. **Public API change**, see the new section in `docs/MigrationGuide.md`. The isolation provider's revalidation snapshot still copies. - **Session lookup** (`936b28d76`): `SessionManager.TryGetSessionContext` takes the candidate snapshot without the bindings lock; the validating check under the lock is unchanged (2 instead of 4 global lock acquisitions per request). - Unit tests for `ObjectPool`, the per-request system context cache, the translation snapshot, `SecureChannelContext` null semantics and a stopped `FairRequestQueue`; `perf/` follows the repository conventions. ## Testing - `Opc.Ua.Server.Tests` (net10.0): 8386 passed before the `ByteString` change. After it, 13 secure-session and isolation tests failed; both causes are fixed in `dc638ab9f` and those tests (25 with their variants) pass. A full rerun of the Server, Sessions, Core, Redundancy, LDS and GDS suites on the final commit is in progress. - Full solution builds for net10.0 and net48; `dotnet format whitespace` clean. ### o6-automation opcua-benchmarks (sampling, deep pipelines) Replicated both tests of the [o6-automation benchmark](https://github.com/o6-automation/opcua-benchmarks) in the harness (`--scenario counters`, and `read` with 10 clients × N outstanding), paired against `origin/master`: | Test | master | this PR | |---|---|---| | Subscription sampling, 100 Hz, every item ≥ 99 % of samples, 1 item | FAIL (75–94 %) | PASS (100 %) | | same, 1024 items | FAIL (64–73 %) | PASS (99.9 %) | | same, capacity | — | between 4096 and 6144 items (~410–520k samples/s) | | Read, 10 clients × 100 outstanding, None | stalls (0–1.7k req/s) | 121–131k req/s | | Read, 10 clients × 100 outstanding, SignAndEncrypt | stalls (0 req/s) | 89–91k req/s | | Read, 10 clients × 1000 outstanding | channels faulted (`BadTcpNotEnoughResources`) | 0 errors, ~45–54k req/s | - **Fixed-rate sampling** (`30b769d13`): the sampling loop waited one interval after each sample, adding timer overshoot and sampling time to every cycle; samples now have absolute deadlines. - **Async response send** (`cdac5c5ca`): `SendResponse` blocked thread-pool workers on the channel gate; with many requests in flight the receive loop that was handed the gate waited for a pool thread and the channel stalled. The TCP, Kestrel TCP and WebSocket listeners now use `SendResponseAsync`. - **Backpressure instead of channel fault** (`191cd2ba7`): server channels stop reading while more than 100 responses are queued and resume at 50, instead of faulting the channel. Client channels keep reading. At 10,000 outstanding requests throughput is ~50k req/s with or without the limit engaged, so the remaining gap to the 100-per-client case is not the backpressure. ## Not changed - `SentMessageQueue` deep-clones every `NotificationMessage`. Retained messages return their pooled payloads on acknowledgement while the response copy may still be queued for send, and a client can acknowledge a sequence number before receiving it; the clone keeps a recycled payload from reaching another session's response. Removing it needs a send-completion hook from the transport. - Generated responses allocate a default `ResponseHeader` that is replaced (~2-3 % of per-request allocation). Fixing it means making structure fields of every generated type lazily initialized, a generator-wide change to default values, equality and encoding. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
745 lines
29 KiB
C#
745 lines
29 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2026 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/
|
|
* ======================================================================*/
|
|
|
|
// CA2007: tests run without a SynchronizationContext; ConfigureAwait(false)
|
|
// adds noise without a behavioural benefit. Disabled file-level for the suite.
|
|
#pragma warning disable CA2007
|
|
|
|
using System;
|
|
using System.Collections.Concurrent;
|
|
using System.Linq;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Moq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Security.Certificates;
|
|
using Opc.Ua.Server.TestFramework;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Server.Tests
|
|
{
|
|
/// <summary>
|
|
/// Tests for session restoration via <see cref="SessionManager.SupportsSessionRestore"/>.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Session")]
|
|
[NonParallelizable]
|
|
public sealed class SessionRestoreTests
|
|
{
|
|
[Test]
|
|
public void DefaultSupportsSessionRestoreIsFalse()
|
|
{
|
|
var server = new Mock<IServerInternal>();
|
|
server.Setup(s => s.Telemetry).Returns(NUnitTelemetryContext.Create());
|
|
|
|
using var manager = new DefaultSessionManagerAccessor(server.Object, CreateConfiguration());
|
|
|
|
Assert.That(manager.SupportsRestore, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task DefaultSessionManagerRejectsUnknownAuthenticationTokenAsync()
|
|
{
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t))
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader
|
|
{
|
|
AuthenticationToken = new NodeId("unknown-token", 2)
|
|
},
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false))!;
|
|
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadSessionIdInvalid));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task RestoredSessionIsAdmittedAndActivatedAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.Restore);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
var authenticationToken = new NodeId("restored-token", 2);
|
|
|
|
ActivateSessionResponse response = await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader
|
|
{
|
|
AuthenticationToken = authenticationToken
|
|
},
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false);
|
|
|
|
ServerFixtureUtils.ValidateResponse(response.ResponseHeader);
|
|
Assert.That(factory.Manager, Is.Not.Null);
|
|
Assert.That(factory.Manager!.SupportsSessionRestoreForTests, Is.True);
|
|
Assert.That(factory.Manager.GetSession(authenticationToken), Is.Not.Null);
|
|
Assert.That(factory.Manager.RestoreAttempts[authenticationToken.ToString()], Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issue #4627 RS-5: the restore is admitted (and a distributed manager consumes
|
|
/// its single-use nonce) exactly once, after the activation passed validation.
|
|
/// </summary>
|
|
[Test]
|
|
public async Task RestoredSessionIsAdmittedOnceAfterValidationAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.Restore);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
var authenticationToken = new NodeId("admitted-token", 2);
|
|
var header = new RequestHeader { AuthenticationToken = authenticationToken };
|
|
|
|
ActivateSessionResponse response = await server.ActivateSessionAsync(
|
|
CreateChannelContext(server), header, null, [], [], default, null, RequestLifetime.None)
|
|
.ConfigureAwait(false);
|
|
ServerFixtureUtils.ValidateResponse(response.ResponseHeader);
|
|
|
|
// A re-activation of the admitted session is an ordinary activation.
|
|
response = await server.ActivateSessionAsync(
|
|
CreateChannelContext(server), header, null, [], [], default, null, RequestLifetime.None)
|
|
.ConfigureAwait(false);
|
|
ServerFixtureUtils.ValidateResponse(response.ResponseHeader);
|
|
|
|
Assert.That(factory.Manager!.AdmitAttempts[authenticationToken.ToString()], Is.EqualTo(1));
|
|
Assert.That(factory.Manager.RestoreAttempts[authenticationToken.ToString()], Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issue #4627 RS-5: a restored session whose first activation fails validation is
|
|
/// discarded again before anything was admitted, so it neither occupies the
|
|
/// session table nor times out into a close of the mirrored session.
|
|
/// </summary>
|
|
[Test]
|
|
public async Task RestoredSessionFailingValidationIsDiscardedWithoutAdmissionAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.RestoreWithDifferentOwner);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
var authenticationToken = new NodeId("foreign-owner-token", 2);
|
|
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader { AuthenticationToken = authenticationToken },
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false))!;
|
|
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadIdentityChangeNotSupported));
|
|
Assert.That(factory.Manager!.AdmitAttempts.ContainsKey(authenticationToken.ToString()), Is.False);
|
|
Assert.That(factory.Manager.GetSession(authenticationToken), Is.Null);
|
|
Assert.That(
|
|
factory.Manager.DisposedRestoredSessions[authenticationToken.ToString()],
|
|
Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Issue #4627 RS-5: a restore the manager refuses to admit (for example because
|
|
/// its single-use nonce was consumed by another replica) fails the activation
|
|
/// with Bad_SessionIdInvalid and leaves no session behind.
|
|
/// </summary>
|
|
[Test]
|
|
public async Task RejectedRestoreAdmissionFailsActivationAndDiscardsSessionAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.RestoreRejectAdmission);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
var authenticationToken = new NodeId("rejected-admission-token", 2);
|
|
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader { AuthenticationToken = authenticationToken },
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false))!;
|
|
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadSessionIdInvalid));
|
|
Assert.That(factory.Manager!.AdmitAttempts[authenticationToken.ToString()], Is.EqualTo(1));
|
|
Assert.That(factory.Manager.GetSession(authenticationToken), Is.Null);
|
|
Assert.That(
|
|
factory.Manager.DisposedRestoredSessions[authenticationToken.ToString()],
|
|
Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task RestoreOverrideReturningNullStillRejectsUnknownTokenAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.ReturnNull);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
var authenticationToken = new NodeId("missing-token", 2);
|
|
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader
|
|
{
|
|
AuthenticationToken = authenticationToken
|
|
},
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false))!;
|
|
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadSessionIdInvalid));
|
|
Assert.That(factory.Manager, Is.Not.Null);
|
|
Assert.That(factory.Manager!.RestoreAttempts[authenticationToken.ToString()], Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task RestoredSessionWithoutTransferSecurityStateFailsClosedAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(
|
|
RestoreBehavior.RestoreWithoutSecurityState);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader
|
|
{
|
|
AuthenticationToken = new NodeId("missing-security-state", 2)
|
|
},
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).ConfigureAwait(false))!;
|
|
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadSecurityChecksFailed));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task DelayedRestoreDoesNotBlockConcurrentSessionOperationsAsync()
|
|
{
|
|
var factory = new TestSessionManagerFactory(RestoreBehavior.DelayThenRestore);
|
|
var fixture = new ServerFixture<StandardServer>(t => new StandardServer(t)
|
|
{
|
|
SessionManagerFactory = factory
|
|
})
|
|
{
|
|
SecurityNone = true
|
|
};
|
|
|
|
try
|
|
{
|
|
StandardServer server = await fixture.StartAsync().ConfigureAwait(false);
|
|
TestRestoreSessionManager manager = factory.Manager!;
|
|
var sameToken = new NodeId("shared-token", 2);
|
|
var differentToken = new NodeId("different-token", 2);
|
|
|
|
Task<ActivateSessionResponse> first = ActivateUnknownAsync(server, sameToken);
|
|
await manager.WaitForRestoreAttemptsAsync(1).ConfigureAwait(false);
|
|
|
|
Task<ActivateSessionResponse> second = ActivateUnknownAsync(server, sameToken);
|
|
Task<ActivateSessionResponse> third = ActivateUnknownAsync(server, differentToken);
|
|
|
|
// Issue #4627 RS-3/RS-5: the second activation of the same token shares the
|
|
// pending restore instead of materializing a competing copy.
|
|
await manager.WaitForRestoreAttemptsAsync(2).ConfigureAwait(false);
|
|
|
|
Task<(RequestHeader, SecureChannelContext)> unrelatedCreate =
|
|
server.CreateAndActivateSessionAsync("ConcurrentCreate", useSecurity: false);
|
|
Task completed = await Task.WhenAny(
|
|
unrelatedCreate,
|
|
Task.Delay(TimeSpan.FromSeconds(2))).ConfigureAwait(false);
|
|
|
|
Assert.That(completed, Is.SameAs(unrelatedCreate),
|
|
"Create/ActivateSession should not be blocked by a delayed restore.");
|
|
|
|
manager.ReleaseDelayedRestores();
|
|
|
|
ServerFixtureUtils.ValidateResponse((await first.ConfigureAwait(false)).ResponseHeader);
|
|
ServerFixtureUtils.ValidateResponse((await second.ConfigureAwait(false)).ResponseHeader);
|
|
ServerFixtureUtils.ValidateResponse((await third.ConfigureAwait(false)).ResponseHeader);
|
|
|
|
Assert.That(manager.GetSession(sameToken), Is.Not.Null);
|
|
Assert.That(manager.GetSession(differentToken), Is.Not.Null);
|
|
Assert.That(manager.GetSessions(), Has.Count.EqualTo(3));
|
|
Assert.That(manager.RestoreAttempts[sameToken.ToString()], Is.EqualTo(1));
|
|
Assert.That(manager.RestoreAttempts[differentToken.ToString()], Is.EqualTo(1));
|
|
Assert.That(manager.DisposedRestoredSessions.ContainsKey(sameToken.ToString()), Is.False);
|
|
Assert.That(manager.AdmitAttempts[sameToken.ToString()], Is.EqualTo(1));
|
|
}
|
|
finally
|
|
{
|
|
await fixture.StopAsync().ConfigureAwait(false);
|
|
}
|
|
}
|
|
|
|
private static Task<ActivateSessionResponse> ActivateUnknownAsync(
|
|
StandardServer server,
|
|
NodeId authenticationToken)
|
|
{
|
|
return server.ActivateSessionAsync(
|
|
CreateChannelContext(server),
|
|
new RequestHeader
|
|
{
|
|
AuthenticationToken = authenticationToken
|
|
},
|
|
null,
|
|
[],
|
|
[],
|
|
default,
|
|
null,
|
|
RequestLifetime.None).AsTask();
|
|
}
|
|
|
|
private static SecureChannelContext CreateChannelContext(StandardServer server)
|
|
{
|
|
EndpointDescription endpoint = server.GetEndpoints()
|
|
.Find(e => e.SecurityMode == MessageSecurityMode.None)!;
|
|
return new SecureChannelContext(
|
|
"session-restore-channel",
|
|
endpoint,
|
|
RequestEncoding.Binary,
|
|
null,
|
|
null,
|
|
null);
|
|
}
|
|
|
|
private enum RestoreBehavior
|
|
{
|
|
ReturnNull,
|
|
Restore,
|
|
RestoreWithoutSecurityState,
|
|
DelayThenRestore,
|
|
RestoreRejectAdmission,
|
|
RestoreWithDifferentOwner
|
|
}
|
|
|
|
private static ApplicationConfiguration CreateConfiguration()
|
|
{
|
|
return new ApplicationConfiguration
|
|
{
|
|
ServerConfiguration = new ServerConfiguration
|
|
{
|
|
MinSessionTimeout = 1000,
|
|
MaxSessionTimeout = 3_600_000,
|
|
MaxSessionCount = 100,
|
|
MaxRequestAge = 60_000,
|
|
MaxBrowseContinuationPoints = 10,
|
|
MaxHistoryContinuationPoints = 10
|
|
}
|
|
};
|
|
}
|
|
|
|
private sealed class DefaultSessionManagerAccessor : SessionManager
|
|
{
|
|
public DefaultSessionManagerAccessor(IServerInternal server, ApplicationConfiguration configuration)
|
|
: base(server, configuration)
|
|
{
|
|
}
|
|
|
|
public bool SupportsRestore => SupportsSessionRestore;
|
|
}
|
|
|
|
private sealed class TestSessionManagerFactory : ISessionManagerFactory
|
|
{
|
|
public TestSessionManagerFactory(RestoreBehavior behavior)
|
|
{
|
|
m_behavior = behavior;
|
|
}
|
|
|
|
public TestRestoreSessionManager? Manager { get; private set; }
|
|
|
|
public ISessionManager Create(
|
|
IServerInternal server,
|
|
ApplicationConfiguration configuration,
|
|
TimeProvider timeProvider,
|
|
Func<string, Certificate?> serverCertificateProvider)
|
|
{
|
|
Manager = new TestRestoreSessionManager(server, configuration, m_behavior, timeProvider);
|
|
return Manager;
|
|
}
|
|
|
|
private readonly RestoreBehavior m_behavior;
|
|
}
|
|
|
|
private sealed class TestRestoreSessionManager : SessionManager
|
|
{
|
|
public TestRestoreSessionManager(
|
|
IServerInternal server,
|
|
ApplicationConfiguration configuration,
|
|
RestoreBehavior behavior,
|
|
TimeProvider? timeProvider)
|
|
: base(server, configuration, timeProvider)
|
|
{
|
|
m_server = server;
|
|
m_behavior = behavior;
|
|
m_serverCertificate = CertificateBuilder
|
|
.Create("CN=SessionRestoreTests")
|
|
.SetRSAKeySize(CertificateFactory.DefaultKeySize)
|
|
.CreateForRSA();
|
|
}
|
|
|
|
public bool SupportsSessionRestoreForTests => SupportsSessionRestore;
|
|
|
|
public ConcurrentDictionary<string, int> RestoreAttempts { get; } = new(StringComparer.Ordinal);
|
|
|
|
public ConcurrentDictionary<string, int> DisposedRestoredSessions { get; } = new(StringComparer.Ordinal);
|
|
|
|
public ConcurrentDictionary<string, int> AdmitAttempts { get; } = new(StringComparer.Ordinal);
|
|
|
|
protected override ValueTask<bool> AdmitRestoredSessionAsync(
|
|
NodeId authenticationToken,
|
|
ISession session,
|
|
OperationContext context,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
AdmitAttempts.AddOrUpdate(authenticationToken.ToString(), 1, static (_, value) => value + 1);
|
|
return new ValueTask<bool>(m_behavior != RestoreBehavior.RestoreRejectAdmission);
|
|
}
|
|
|
|
public Task WaitForRestoreAttemptsAsync(int count)
|
|
{
|
|
return WaitForAsync(
|
|
() => RestoreAttempts.Values.Sum() >= count,
|
|
TimeSpan.FromSeconds(10));
|
|
}
|
|
|
|
public void ReleaseDelayedRestores()
|
|
{
|
|
m_restoreGate.TrySetResult(true);
|
|
}
|
|
|
|
protected override bool SupportsSessionRestore => true;
|
|
|
|
protected override async ValueTask<ISession?> RestoreSessionAsync(
|
|
NodeId authenticationToken,
|
|
OperationContext context,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
RestoreAttempts.AddOrUpdate(authenticationToken.ToString(), 1, static (_, value) => value + 1);
|
|
|
|
if (m_behavior == RestoreBehavior.ReturnNull)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
if (m_behavior == RestoreBehavior.DelayThenRestore)
|
|
{
|
|
using CancellationTokenRegistration registration = cancellationToken.Register(
|
|
static state => ((TaskCompletionSource<bool>)state!).TrySetCanceled(),
|
|
m_restoreGate);
|
|
await m_restoreGate.Task.ConfigureAwait(false);
|
|
}
|
|
|
|
return await CreateRestoredSessionAsync(authenticationToken, context, cancellationToken)
|
|
.ConfigureAwait(false);
|
|
}
|
|
|
|
protected override ISession CreateSession(
|
|
OperationContext context,
|
|
IServerInternal server,
|
|
Certificate serverCertificate,
|
|
NodeId sessionCookie,
|
|
ByteString clientNonce,
|
|
Nonce serverNonce,
|
|
string sessionName,
|
|
ApplicationDescription clientDescription,
|
|
string endpointUrl,
|
|
Certificate clientCertificate,
|
|
CertificateCollection clientCertificateChain,
|
|
double sessionTimeout,
|
|
uint maxResponseMessageSize,
|
|
int maxRequestAge,
|
|
int maxContinuationPoints)
|
|
{
|
|
return new TrackingSession(
|
|
context,
|
|
server,
|
|
serverCertificate,
|
|
sessionCookie,
|
|
clientNonce,
|
|
serverNonce,
|
|
sessionName,
|
|
clientDescription,
|
|
endpointUrl,
|
|
clientCertificate,
|
|
clientCertificateChain,
|
|
sessionTimeout,
|
|
maxBrowseContinuationPoints: 10,
|
|
maxHistoryContinuationPoints: 10,
|
|
onDispose: () => DisposedRestoredSessions.AddOrUpdate(
|
|
sessionCookie.ToString(),
|
|
1,
|
|
static (_, value) => value + 1));
|
|
}
|
|
|
|
protected override void Dispose(bool disposing)
|
|
{
|
|
if (disposing)
|
|
{
|
|
m_serverCertificate.Dispose();
|
|
}
|
|
|
|
base.Dispose(disposing);
|
|
}
|
|
|
|
private async ValueTask<ISession> CreateRestoredSessionAsync(
|
|
NodeId authenticationToken,
|
|
OperationContext context,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
ISession session = CreateSession(
|
|
context,
|
|
m_server,
|
|
m_serverCertificate,
|
|
authenticationToken,
|
|
ByteString.Empty,
|
|
Nonce.CreateNonce(SecurityPolicies.None),
|
|
"restored-" + authenticationToken,
|
|
new ApplicationDescription
|
|
{
|
|
ApplicationUri = "urn:test:restored",
|
|
ApplicationName = new LocalizedText("RestoredSession"),
|
|
ApplicationType = ApplicationType.Client
|
|
},
|
|
context.ChannelContext!.EndpointDescription!.EndpointUrl!,
|
|
null!,
|
|
[],
|
|
60_000,
|
|
0,
|
|
0,
|
|
0);
|
|
await session.InitializeAsync(context, cancellationToken).ConfigureAwait(false);
|
|
if (m_behavior != RestoreBehavior.RestoreWithoutSecurityState)
|
|
{
|
|
EndpointDescription endpoint =
|
|
context.ChannelContext!.EndpointDescription!;
|
|
SetRestoredSessionTransferSecurityState(
|
|
session,
|
|
context.ChannelContext.ClientChannelCertificate,
|
|
endpoint.SecurityPolicyUri ?? SecurityPolicies.None,
|
|
endpoint.SecurityMode,
|
|
m_behavior == RestoreBehavior.RestoreWithDifferentOwner
|
|
? UserTokenType.UserName
|
|
: UserTokenType.Anonymous,
|
|
clientUserId: m_behavior == RestoreBehavior.RestoreWithDifferentOwner
|
|
? "another-user"
|
|
: null);
|
|
}
|
|
return session;
|
|
}
|
|
|
|
private readonly IServerInternal m_server;
|
|
private readonly RestoreBehavior m_behavior;
|
|
private readonly Certificate m_serverCertificate;
|
|
|
|
private readonly TaskCompletionSource<bool> m_restoreGate =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
}
|
|
|
|
private sealed class TrackingSession : Server.Session
|
|
{
|
|
public TrackingSession(
|
|
OperationContext context,
|
|
IServerInternal server,
|
|
Certificate serverCertificate,
|
|
NodeId authenticationToken,
|
|
ByteString clientNonce,
|
|
Nonce serverNonce,
|
|
string sessionName,
|
|
ApplicationDescription clientDescription,
|
|
string endpointUrl,
|
|
Certificate clientCertificate,
|
|
CertificateCollection clientCertificateChain,
|
|
double sessionTimeout,
|
|
int maxBrowseContinuationPoints,
|
|
int maxHistoryContinuationPoints,
|
|
Action onDispose)
|
|
: base(
|
|
context,
|
|
server,
|
|
serverCertificate,
|
|
authenticationToken,
|
|
clientNonce,
|
|
serverNonce,
|
|
sessionName,
|
|
clientDescription,
|
|
endpointUrl,
|
|
clientCertificate,
|
|
clientCertificateChain,
|
|
sessionTimeout,
|
|
maxBrowseContinuationPoints,
|
|
maxHistoryContinuationPoints)
|
|
{
|
|
m_onDispose = onDispose;
|
|
}
|
|
|
|
protected override void Dispose(bool disposing)
|
|
{
|
|
if (disposing)
|
|
{
|
|
m_onDispose();
|
|
}
|
|
|
|
base.Dispose(disposing);
|
|
}
|
|
|
|
private readonly Action m_onDispose;
|
|
}
|
|
|
|
private static async Task WaitForAsync(Func<bool> condition, TimeSpan timeout)
|
|
{
|
|
DateTime deadline = DateTime.UtcNow + timeout;
|
|
while (DateTime.UtcNow < deadline)
|
|
{
|
|
if (condition())
|
|
{
|
|
return;
|
|
}
|
|
|
|
await Task.Delay(50).ConfigureAwait(false);
|
|
}
|
|
|
|
Assert.That(condition(), Is.True);
|
|
}
|
|
}
|
|
}
|