mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-17 05:11:13 +08:00
7c965fd636
# Description - Add isolated NodeState reference images, TypeTable graph snapshots, EncodeableFactory registration forks/views, StringTable mutation versions/private copies, and ServiceMessageContext mapping-holder generation tracking. Reference images are lazy for empty nodes; selected-image clones own independent storage and publication ownership. - Add the complete generic NodeBrowser continuation-dependency capability. This does not implement server browse-history retention, NodeManager read images, or server batch/readiness admission. - Add optional client binding capture for SessionClient, native Session and ManagedSession, with managed-lease/native-channel generation composition. Bindings capture authenticated-session identity, mapping holders/versions and owned endpoint/policy/configuration observations. Replacement, reconnect, mapping ABA and disposal permanently invalidate stale bindings; disposing a binding does not dispose its owner. - Preserve cancellation and master pooled-response ownership: a rejected pooled response is released exactly once; an accepted response remains caller-owned. Keep native transport submission under its replacement gate and completion outside the gate, without routing ordinary unbound requests through binding machinery. - Rename the existing server lookup interface and all actual consumers with minimal hunks; add focused fixtures, generated FileTypeClient usage guidance, and package/transport documentation. **Breaking preview type identity:** the existing 2.0-preview server lookup `Opc.Ua.ISessionBindingProvider` becomes `Opc.Ua.IServerSessionBindingProvider`. Server lookup consumers must update their referenced type and rebuild. This is neither source-compatible nor binary-additive for that preview type. The new client capability is optional and adds no mandatory members to existing ISession/ISessionClient/ITransportChannel contracts. This preview-to-preview rename is documented in SessionBindings/Transports, not in the 1.5-to-2.0 MigrationGuide. **Ownership boundary:** no RequestLifetime changes, certificate-manager/channel-entry adoption, BaseVariableState changes, Method-result feature extraction, NodeManager batch/readiness or browse-history retention, session restoration, registry federation, WoT conversion, or WoT runtime/planners/events. DependencyInjection/ResourceIsolation/index changes are lookup/link closure only. SessionManager's PR hunk changes only its implemented lookup-interface name; newer master public diagnostic masking is not replaced. ## Related Issues _Reference all GitHub issues this PR addresses. If there is no issue yet, open one and link it here._ _If this is a relatively large or complex change, a design must have been discussed in the related tracking issue and signed off (which becomes the Architectural Decision Record (ADR))._ - Part of #4511: user-approved combined groups 5+6 Wave A extraction. This PR does not close the umbrella or publish Wave B. ## Checklist _Put an `x` in the boxes that apply. You can complete these step by step after opening the PR._ - [ ] 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. - [x] I have addressed **all** PR feedback received. ### Review qualification Review fixes are published at **`6b0eb1d5c32a439300fbcaff974b9af8b909161b`**, changing eight already-owned files. All five received review threads were replied to and resolved after verification. Factory selector installation and target-selection-plus-commit share the root publication gate, with consistent root→image release/capture ordering. TypeTable selector installation and final mutation routing share its existing gate. Native bound channel validity uses volatile observations; the two owned XML defects are corrected. | Requirement | Evidence | |---|---| | Selector installation must not hide TypeTable mutations | `SelectorInstalledDuringNodePreparationReceivesMutation`: old Add routing failed on both TFMs; corrected routing passes on both within **148/148** factory/TypeTable controls | | Selector installation must not race factory commit routing | Static common-root-gate/order proof plus baseline-GREEN `BuilderCapturedBeforeOwnershipUsesSelectedFactory`, `ViewOwnerReleasePreservesRegistrationsAndAllowsReuse`, `ViewOwnerReleaseCanRetryAfterPendingPublication`, `PublicationProtectsPendingAndRetiredFactoryImages` | | Lock-free validity must observe owner transitions | Static volatile-read reasoning plus native `BoundRequestCannotDispatchWhileNativeReplacementIsPendingAsync`, `BoundResponseRejectsInvalidationAfterNativeDispatchAsync`, `BoundClientCannotRetryAcrossFaultedManagedEntryReplacementAsync`: **12/12 each TFM**; Core binding/pooled ownership controls **17/17 each TFM** | | Correct owned XML documentation | “an unmanaged” and one multiline `ReferenceUpdate.Next` summary; scoped whitespace/INFO and build evidence below | Factory controls are **not** claimed as a deterministic factory RED, and public transport controls are **not** claimed as a deterministic weak-memory RED. No private-lock reflection, artificial production seam, or source-name assertion was added. The TypeTable RED uses the real `ILocalNode.NodeClass` callback during node preparation, and both expected RED receipts/TRX were retained. All accepted review runs use the unchanged admitted SDK wrapper, normal project references, sole mutex, one node/no shared compiler, finite resource guards and canonical short-C build outputs. Source hashes were frozen per command and matched the committed bytes afterward. SDK ownership was released **before** commit/push/review replies. No automatic merge was requested. Scoped whitespace passed across the four affected projects. Review INFO classification is **0 owned findings / 13 untouched baseline findings excluded** (whole-file formatter exits 1,1,0,0); no baseline RCS1140/RCS0055 expansion or suppression. The final normal net10 public Client/Core/Types trim/AOT-analyzer closure passed **0 warnings / 0 errors**. This is not a NativeAOT publish/run. <details> <summary>Accepted review command payloads and results</summary> These exact argument payloads were executed through the unchanged guarded SDK wrapper. `$proof` expands to the protected results-directory below. Successful explicit builds of the same source preceded the `--no-build` runs. ```powershell $proof = 'C:\Users\mschier\.copilot\session-state\a3b74048-c52f-4c87-8773-7a46c9ab0087\files\qualification-review-4752' # Exit 0: 148 passed, 0 failed dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -f net48 -p:CustomTestTarget=net48 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --no-restore --verbosity minimal --filter "FullyQualifiedName~EncodeableFactorySnapshotTests|FullyQualifiedName~TypeTableTests" --logger "trx;LogFileName=review-types-green-net48.trx" --results-directory $proof # Exit 0: 148 passed, 0 failed dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -f net10.0 --no-restore --no-build --filter "FullyQualifiedName~EncodeableFactorySnapshotTests|FullyQualifiedName~TypeTableTests" --logger "trx;LogFileName=review-types-green-net10.trx" --results-directory $proof -p:CustomTestTarget=net10.0 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal # The following two per-TFM payloads each exited 0: # Core: 17/17 net48 and 17/17 net10.0; Client: 12/12 net48 and 12/12 net10.0 foreach ($tfm in @('net48', 'net10.0')) { dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -f $tfm --no-restore --no-build --filter "FullyQualifiedName~SessionBindingResponseTests|FullyQualifiedName~SessionBindingContextTests" --logger "trx;LogFileName=review-actual-core-green-$tfm.trx" --results-directory $proof -p:CustomTestTarget=$tfm -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal dotnet test tests\Opc.Ua.Client.Tests\Opc.Ua.Client.Tests.csproj -f $tfm --no-restore --no-build --filter "FullyQualifiedName~BoundRequestCannotDispatchWhileNativeReplacementIsPendingAsync|FullyQualifiedName~BoundResponseRejectsInvalidationAfterNativeDispatchAsync|FullyQualifiedName~BoundClientCannotRetryAcrossFaultedManagedEntryReplacementAsync" --logger "trx;LogFileName=review-actual-client-green-$tfm.trx" --results-directory $proof -p:CustomTestTarget=$tfm -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal } # Exit 0: 0 warnings, 0 errors dotnet build src\Opc.Ua.Client\Opc.Ua.Client.csproj -f net10.0 -p:CustomTestTarget=net10.0 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --no-restore --verbosity minimal ``` The six expanded GREEN commands, exact results/TRX hashes and two expected RED commands are retained in `qualification-review-4752\qualification-summary.json`, SHA256 `C5E71A4D8D37BAC8803F6DF38B6BCE2B70F3D0AFD5DEC8493FAE9DB440DCFB5A`. Committed/qualified byte identity is in `publication-identity.json`, SHA256 `CD9515FE96703F8B241F2B7B9B71F73EF0FF2626C2C8BCCE40307971A8F8E809`. Per-command raw exits, guards, hashes and reports are retained outside disposable build roots. For each record in the protected `format-inputs.json` (Types/Core/Client libraries and Types.Tests), the recorded Project/Include values expand these exact payloads: ```powershell # Workspace properties recorded with the formatter receipts: $env:CustomTestTarget = 'net10.0' $env:UseArtifactsOutput = 'true' $env:ArtifactsPath = 'C:\cp56-a3b7-v2' # All four exit 0 dotnet format whitespace $Project --no-restore --verify-no-changes --verbosity minimal --include $Include # Exits 1,1,0,0 due only to untouched baseline findings; owned=0, baseline=13 dotnet format $Project --no-restore --severity info --verify-no-changes --verbosity minimal --report "$proof\formats\review-info-$i" --include $Include ``` Initial fresh matrix evidence remains separately identified and unchanged: Types274/Core119/Client151/server137 net10; Types274/Core119/Client151/server135 net48, all passing. Qualification base remains `0dff94bd378e79b8cf1a47e1aaf340f9b4b40048`; the initial published head was `9fee4583`. All 16 initial exact command arrays/results/TRX hashes remain in protected `qualification-v2\qualification-summary.json`, SHA256 `88E10240C20049B59A3401BE007C6528A85DF2F3DCFAF9D11D908CEF2946DA4E`. Failures/incidents remain retained rather than relabeled as success: original disappeared-root historical counts are invalidated; the large-TRX controller DOM-parser failure is preserved separately from accepted streaming receipts; the review argument-array defect/default-D-output controls are preserved but excluded from canonical review qualification. Correctly separated argument rechecks produced the accepted short-C Core/Client receipts. The sole SDK wrapper was not changed. Full UA.slnx, measured coverage increase, CLA verification, NativeAOT publication and current-head/master CI/CodeQL remain unclaimed. Actual merge—not resolved review threads—unlocks Wave B. </details>
129 lines
6.2 KiB
Markdown
129 lines
6.2 KiB
Markdown
# Generation-bound session clients
|
|
|
|
`ISessionBindingProvider` is an optional capability for operations whose identity
|
|
must not change during a sequence of requests or after a generated client is
|
|
returned. Stock `Session` and `ManagedSession` implement it. Existing `ISession`,
|
|
`ISessionClient` and `ITransportChannel` implementations acquire no new mandatory
|
|
members, and ordinary unbound clients retain their normal reconnect behavior.
|
|
|
|
This client capability is distinct from the server's
|
|
[`IServerSessionBindingProvider`](Transports.md#committed-session-bindings), which
|
|
provides read-only committed-session membership and classification snapshots through
|
|
`HasSession` and `TryGetSessionContext`. Neither interface requires the other's members.
|
|
|
|
## Capture and use
|
|
|
|
Establish and authenticate the owning session through the usual direct factory
|
|
or [client DI setup](Sessions.md). Then capture a client:
|
|
|
|
```csharp
|
|
if (session is not ISessionBindingProvider provider)
|
|
{
|
|
throw new ServiceResultException(StatusCodes.BadNotSupported);
|
|
}
|
|
|
|
ISessionClient binding = await provider.CreateBindingAsync(ct);
|
|
try
|
|
{
|
|
DataValue state = await binding.ReadValueAsync(
|
|
VariableIds.Server_ServerStatus_State, ct);
|
|
var file = new FileTypeClient(binding, fileNodeId, telemetry);
|
|
uint handle = await file.OpenAsync(1, ct);
|
|
try
|
|
{
|
|
ByteString bytes = await file.ReadAsync(handle, 4096, ct);
|
|
}
|
|
finally
|
|
{
|
|
await file.CloseAsync(handle, CancellationToken.None);
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
await binding.CloseAsync(CancellationToken.None);
|
|
binding.Dispose();
|
|
}
|
|
```
|
|
|
|
The existing generated ObjectType clients consume `ISessionClient`, so no
|
|
parallel Read/Browse/Call implementation or new connection manager is needed.
|
|
Capture does not create a new server session or open document content.
|
|
|
|
The binding is non-owning with respect to the original session and network
|
|
connection. Closing or disposing it invalidates only the captured client and
|
|
releases its local diagnostics. It does not hold an exclusive gate for its
|
|
lifetime. The application continues to own the original session's lifetime.
|
|
|
|
## What is captured
|
|
|
|
The binding retains the authenticated native transport generation, the
|
|
session/authentication incarnation, and private namespace/server mapping
|
|
snapshots. A source map mutation, including a change followed by restoration of
|
|
the same values, invalidates the old binding. `StringTable.GetSnapshot` captures
|
|
the mapping and its mutation `Version` together.
|
|
|
|
Capture also checks that the owning session's maps agree with the live context
|
|
of the transport actually selected for dispatch. Contradictory holders reject
|
|
capture. Both the source context and the copied context track table-holder
|
|
generations: replacing either table invalidates the binding even if the original
|
|
reference is restored before the next request. Assigning an unchanged reference
|
|
does not itself invalidate a binding.
|
|
|
|
The bound client cannot replace its channel/session incarnation or override its
|
|
authentication token. Its endpoint and channel-certificate observations are
|
|
captured values, not references to a later selected peer. Its generated clients
|
|
continue interpreting NodeIds against the captured maps.
|
|
|
|
For UA Secure Conversation binary transports, dispatch validation and submission
|
|
to the captured inner channel occur at the native channel owner's replacement
|
|
gate. Response completion is awaited outside that gate. Managed bindings compose
|
|
the lease's entry, swap and reconnect generation checks with that native path;
|
|
they do not enter the ordinary managed idempotent-retry loop.
|
|
|
|
Before-dispatch invalidation rejects the request. A request already dispatched
|
|
can complete only against its captured transport; if the binding is invalidated
|
|
while it is in flight, its result is rejected rather than treated as evidence for
|
|
the replacement generation. A transport failure associated with proven
|
|
invalidation retains the original exception as its cause.
|
|
|
|
## Invalidation, cancellation and support
|
|
|
|
Invalidated bindings report `BadSecurityChecksFailed`; a locally closed client
|
|
can also report its normal closed-client status. Invalidation is permanent for
|
|
that binding, even if the owning capability later becomes current again.
|
|
Cancellation remains
|
|
`OperationCanceledException` and is not converted into a binding success.
|
|
Capture on a closed session fails, and reconnect is not supported on the captured
|
|
transport itself.
|
|
|
|
After a legitimate reconnect, namespace-table update or authorized endpoint
|
|
relocation, capture a fresh binding and resolve portable identities again.
|
|
An old binding fails rather than silently retargeting old NodeIds. This does not
|
|
change the origin/identity policy applied by a higher-level client.
|
|
|
|
The stock implementation supports UA-SC binary native channels (including their
|
|
TCP and byte-transport-derived channels) and managed leases over those channels.
|
|
Other transport implementations and custom mapping-table subclasses without the
|
|
required owner tracking reject capture with `BadNotSupported`, as do custom
|
|
message-context implementations. Custom session
|
|
adapters may expose `ISessionBindingProvider` only if they enforce the complete
|
|
dispatch/result guarantee; comparing current endpoint labels is not sufficient.
|
|
No support is inferred merely from an adapter implementing `ISession`.
|
|
|
|
This is an additive dispatch capability, not a new resolver, cache, reconnect
|
|
engine, registry persistence mechanism or server-restoration phase.
|
|
|
|
## Compatibility and deployment
|
|
|
|
The client capability adds no mandatory members to existing session or transport
|
|
interfaces. The server lookup previously named `Opc.Ua.ISessionBindingProvider`
|
|
is renamed to `Opc.Ua.IServerSessionBindingProvider` to distinguish the two
|
|
capabilities. This is a source and binary breaking change for consumers of that
|
|
preview server lookup: update implementations, casts and DI registrations, and
|
|
rebuild against the renamed interface. Its committed-session semantics are unchanged.
|
|
|
|
Capture uses existing session factories and client DI configuration; it requires
|
|
no separate registration. The implementation introduces no dynamic code generation
|
|
or reflection-based member discovery. These facts do not replace validation of an
|
|
application's generated types, transport and dependency closure under NativeAOT.
|