fix(opcuaclient): #910 name the per-endpoint connect budget; widen it in the #816 host-name tests

Cause: the client-side PerEndpointConnectTimeout (3 s), not opc-plc. The
validate:null case is the first test the assembly runs, so it pays the
cold-process cost of the first Basic256Sha256 connect: loading the fresh
throwaway certificate, validating the server's, and the asymmetric handshake.
In the G2 full-solution run that local work used up the budget. The opc-plc
log at 13:13:50-53Z shows the discovery channel closing at 50.709, then nothing
from the client for 3 s, then OpenSecureChannel answered at 53.775 and the
client closing the channel 48 ms later. The SDK reports a wait cancelled by
that budget as BadRequestInterrupted. opc-plc auto-accepted the certificate
(--aa, "Trusting certificate ... command line option") with no reject and no
store round-trip.

- Driver: a per-endpoint budget expiry now surfaces as TimeoutException naming
  PerEndpointConnectTimeout instead of BadRequestInterrupted or a bare
  TaskCanceledException. There is no behaviour change. Unit test added
  against a silent TCP listener.
- Test: the ServerHostNameValidationTests secure options use a 15 s budget,
  the same as the browser integration tests' 10 s. Connect latency is not
  what these tests check.
- docs/drivers/OpcUaClient.md: documents what the budget covers.
This commit is contained in:
Joseph Doherty
2026-11-13 12:42:45 -05:00
parent e299dc090a
commit 73132b7d78
4 changed files with 63 additions and 3 deletions
@@ -1053,8 +1053,33 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
using var cts = CancellationTokenSource.CreateLinkedTokenSource(ct);
cts.CancelAfter(_options.PerEndpointConnectTimeout);
try
{
return await OpenSessionWithinBudgetAsync(appConfig, endpointUrl, policy, mode, identity, cts.Token)
.ConfigureAwait(false);
}
catch (Exception ex) when (cts.IsCancellationRequested && !ct.IsCancellationRequested)
{
// Gitea #910: the SDK reports a wait cut short by this budget as BadRequestInterrupted (or a bare
// TaskCanceledException), which reads like a server or network fault. Name the budget instead. It also
// covers CLIENT-side work (loading the application certificate, validating the server's, the asymmetric
// crypto of OpenSecureChannel), so a cold process on a busy host can exceed it with a healthy server.
throw new TimeoutException(
"The connect did not complete within PerEndpointConnectTimeout " +
$"({_options.PerEndpointConnectTimeout.TotalSeconds:0.###} s); the SDK reported: {ex.Message}", ex);
}
}
private async Task<ISession> OpenSessionWithinBudgetAsync(
ApplicationConfiguration appConfig,
string endpointUrl,
OpcUaSecurityPolicy policy,
OpcUaSecurityMode mode,
UserIdentity identity,
CancellationToken budget)
{
var selected = await SelectMatchingEndpointAsync(
appConfig, endpointUrl, policy, mode, cts.Token).ConfigureAwait(false);
appConfig, endpointUrl, policy, mode, budget).ConfigureAwait(false);
var endpointConfig = EndpointConfiguration.Create(appConfig);
endpointConfig.OperationTimeout = (int)_options.Timeout.TotalMilliseconds;
var endpoint = new ConfiguredEndpoint(null, selected, endpointConfig);
@@ -1073,7 +1098,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
(uint)_options.SessionTimeout.TotalMilliseconds,
identity,
default, // preferredLocales
cts.Token).ConfigureAwait(false);
budget).ConfigureAwait(false);
session.KeepAliveInterval = (int)_options.KeepAliveInterval.TotalMilliseconds;
return session;