mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-29 07:07:24 +08:00
ecc-testing-fixes-2
13
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 Marc Schier
|
736b92ac7e |
Fix #3768: stop emitting unimplemented Optional children on singleton instances (#3828)
# Description Singleton instances declared in `StandardTypes.xml` and `Opc.Ua.NodeSet2.xml` (`Server`, `Server.ServerConfiguration`, `HistoryServerCapabilities`, `OPCUANamespaceMetadata`, the well-known role objects, the Part 17 `Aliases` category, etc.) were emitting Optional Variable/Method children that the SDK does not implement — for example `ServerConfiguration.ApplicationUri`, `ProductUri`, `ApplicationType`, `HasSecureElement`, `CancelChanges`, `ResetToServerDefaults`, `Server.UrisVersion`, `Server.EstimatedReturnTime`, `Server.LocalTime`, `Server.ServerCapabilities.ConformanceUnits` and friends. The cause was the source generator promoting every type-definition child's modelling rule into the singleton-instance factory whenever `UseTypeDefinitionModellingRules` was enabled (#3799), which made every Optional child unconditionally appear in the singleton's `CreateXxx` body. This PR fixes the regression at the generator level (without touching `StandardTypes.xml`) and lets the SDK opt back in to just the Optional children it actually implements. ## New: chainable `Add{Child}` API with configure-callback overloads Per review feedback ("the existing predefined node is used. A user adds optional children using `.AddXY(NodeId? nodeId = default)`. The Add calls should be possible to chain. … Instead of AddAndGet, emit an Add overload with a callback to configure the created node state further, add another Add to take a condition predicate that decides whether the Create is executed or not"), the source generator now emits **five** chainable `Add{Child}` overloads per Optional child of every typed state class. All return the **owner** (`this`) so multi-child wiring collapses into a single fluent chain: ```csharp // (1) base — idempotent ensure-child public TOwner Add{Child}(ISystemContext context, NodeId? nodeId = default); // (2) Action — always run, mutate the just-created child in-line public TOwner Add{Child}(ISystemContext context, Action<TChild> configure, NodeId? nodeId = default); // (3) Action — conditional; when false: no Add, no callback public TOwner Add{Child}(ISystemContext context, bool condition, Action<TChild> configure, NodeId? nodeId = default); // (4) Func — always run, transform/replace the typed slot public TOwner Add{Child}(ISystemContext context, Func<TChild, TChild> configure, NodeId? nodeId = default); // (5) Func — conditional public TOwner Add{Child}(ISystemContext context, bool condition, Func<TChild, TChild> configure, NodeId? nodeId = default); ``` The previous `AddAndGet{Child}(context, NodeId?)` helper is **removed**; every call site is migrated to one of the new overloads. The Action overloads cover the common "set Value / wire OnCallAsync" case in-line; the Func overloads allow callers to replace the typed slot with a wrapper or subclass instance. The boolean overloads short-circuit when the condition is `false`. When `nodeId` is `null`: if `context.NodeIdFactory` is non-null the helper mints a fresh NodeId via `context.NodeIdFactory.New(context, child)`; otherwise it leaves the type-level NodeId assigned by the generated factory unchanged (the caller can patch later). `NodeState.Create(context, source)` stays authoritative (the loaded NodeSet XML / passive source is the source of truth for what children exist). The new chainable `Add{Child}` overloads are the runtime-extension API for SDK code and downstream users that want to add Optional children programmatically after load. A new `Tokens.OwnerClassName` carries the owning typed state class name through the per-child template loop so `Add{Child}` can return `this` typed as the owner; the template engine's outer-scope lookup cascades the value from `AddNodeStateClassTypeReplacements` / `AddNodeStateClassMethodTypeReplacements` into the per-child template scope. ### SDK migration in `Libraries/Opc.Ua.Server` - `DiagnosticsNodeManager` add-back helpers collapse into single fluent chains; the `SetSubscriptionDurable` conditional folds into the Server chain via the bool-condition overload (`AddSetSubscriptionDurable(context, m_durableSubscriptionsEnabled, _ => { }, MethodIds.Server_SetSubscriptionDurable)`); the `OperationLimits` add-back inlines via `.AddOperationLimits(...).OperationLimits!.AddMax...()`. - `ConfigurationNodeManager` chains `AddGetCertificates(context).AddCreateSelfSignedCertificate(context)` before `Create(context, passiveNode)`. - `HistoricalDataConfigurationInstaller.PopulateProperties` is now a single fluent chain using the conditional Action overload — `.AddMaxTimeInterval(context, capabilities.MaxTimeInterval > 0, c => c.Value = capabilities.MaxTimeInterval)` replaces the `if (cond) { config.AddAndGetMaxTimeInterval(context).Value = ...; }` ceremony. - `KeyCredentialPushSubject` folds `OnCall = null; OnCallAsync = ...` into Action callbacks on the chain: `state.AddUpdateCredential(context, c => { c.OnCall = null; c.OnCallAsync = OnUpdateCredentialAsync; }).AddDeleteCredential(...)`. - `WotConnectivityNodeManager.WireManagementMethods` chains `.AddDiscoverAssets(ctx, c => c.OnCallAsync = ...).AddCreateAssetForEndpoint(...).AddConnectionTest(...).AddSupportedWoTBindings(...)`. - `AssetRegistry` and `AlarmConditionTypeHolder` updated from `state.X ??= state.AddX(context)` to plain `state.AddX(context)` + null-forgiving access on the typed slot (idempotent `Add{Child}` makes the `??=` ceremony obsolete). ## Generator fix `Tools/Opc.Ua.SourceGeneration.Core/Generators/NodeStateGenerator.cs`: `NodeToGenerate` gains a structural `IsUnderSingletonInstance` flag, set `true` on the singleton-instance root in `CollectNodesToGenerate` and propagated to every descendant in `GetChildren`. Mirrors the existing `RootIsTypeDefinition` propagation pattern; the gate becomes an O(1) lookup. ```csharp bool isSingletonInstanceContext = m_context.Options.UseTypeDefinitionModellingRules && node.IsUnderSingletonInstance && node.Parent != null && instance is VariableDesign or MethodDesign; ModellingRule effectiveRule = isSingletonInstanceContext ? GetEffectiveModellingRule(node, instance) : instance.ModellingRule; ``` The `topLevelInstanceException` is preserved for **TYPE-DEF** roots — its `UseTypeDefinitionModellingRules` gate only fires when the parent is an `InstanceDesign` singleton. Without this, the type-def factories (e.g. `CreateNamespaceMetadataType`) stop emitting their Optional children which breaks deep code paths that rely on the type-def factory shape (e.g. `ConfigurationNodeManager.CreateNamespaceMetadataStateAsync`). ### Why the gate is transitive but narrowed to Variables/Methods The gate applies **transitively** to every Variable/Method descendant of a singleton-instance subtree. Deep Optional Variable/Method descendants such as `Server.ServerCapabilities.MaxArrayLength`, `Server.ServerCapabilities.OperationLimits.MaxNodesPerRead`, `Server.ServerRedundancy.RedundantServerArray`, `Server.UrisVersion`, `Server.EstimatedReturnTime`, `Server.LocalTime`, `PublishSubscribe.AddConnection` / `RemoveConnection`, the Optional methods on every well-known role, the OPCUANamespaceMetadata Default* properties, and `Aliases.LastChange` are now all suppressed by the generator. Optional **Object** instances under singletons are intentionally exempt: they are still emitted by the singleton-specific factory with their correct instance-level NodeIds. Their subtrees use well-known descendant NodeIds (e.g. `ServerConfiguration.CertificateGroups.DefaultHttpsGroup.TrustList.Open = NodeId 14095`) that the SDK and `ConfigurationNodeManager` bind against directly. Optional Variable/Method children of those Objects are still gated transitively (e.g. `OperationLimits.MaxNodesPerRead` is suppressed even though `OperationLimits` itself stays emitted). ### EURange regression analysis The earlier attempt at this fix regressed `AnalogItemType.EURange` (which is `Mandatory` on `AnalogItemType` per the OPC UA spec — a type-level promotion of `BaseAnalogType.EURange`). `IsUnderSingletonInstance` is `false` on type-def and synthetic type-instance roots, so the gate cannot fire on either type-template tree. Combined with the topLevelInstanceException preserved for type-def roots, every type-def factory continues to emit its full child set. ## SDK programmatic Add* (Opc.Ua.Server) `DiagnosticsNodeManager.AddSdkImplementedOptionalChildren` now dispatches per loaded predefined node type. Each lazy-add call patches the resulting NodeId (and Method `InputArguments` / `OutputArguments` NodeIds where applicable) to the well-known singleton-instance value via `ObjectIds.*` / `MethodIds.*` / `VariableIds.*`. The generator-emitted `Add{Child}` extension uses the type-level factory which assigns the type NodeId; the SDK overrides each NodeId after construction. - **`Server` (ServerObjectState)**: `GetMonitoredItems`, `ResendData`, `SetSubscriptionDurable` (when enabled), `Namespaces`, `UrisVersion`, `EstimatedReturnTime`, `LocalTime`. - **`Server.ServerCapabilities`** (14 Properties): `MaxArrayLength`, `MaxStringLength`, `MaxByteStringLength`, `MaxSessions`, `MaxSubscriptions`, `MaxMonitoredItems`, `MaxSubscriptionsPerSession`, `MaxMonitoredItemsPerSubscription`, `MaxSelectClauseParameters`, `MaxWhereClauseParameters`, `MaxMonitoredItemsQueueSize`, `ConformanceUnits`, `RoleSet`, `OperationLimits`. Required to keep `ServerInternalData.CreateServerObjectAsync`'s non-null assertions working and to keep `Session.FetchOperationLimitsAsync` round-trip values matching master. - **`Server.ServerCapabilities.OperationLimits`** (12 Properties): every `MaxNodesPerXxx` and `MaxMonitoredItemsPerCall`. - **`Server.ServerRedundancy.RedundantServerArray`**: re-added for `DefaultServerRedundancyHandler` (client-side) compatibility. - **`HistoryServerCapabilities.ServerTimestampSupported`**. - **6 modifiable well-known roles** (Observer, Operator, Engineer, Supervisor, ConfigureAdmin, SecurityAdmin) × 11 RoleType children (`ApplicationsExclude`, `Applications`, `EndpointsExclude`, `Endpoints`, `CustomConfiguration`, `AddIdentity`, `RemoveIdentity`, `AddApplication`, `RemoveApplication`, `AddEndpoint`, `RemoveEndpoint`). The three immutable roles (Anonymous, AuthenticatedUser, TrustedApplication) have no well-known instance NodeIds for these methods in the spec and are left untouched. - **`OPCUANamespaceMetadata`** (i=15957, standard Part 6 namespace metadata loaded from `Opc.Ua.NodeSet2.xml`): `DefaultRolePermissions`, `DefaultUserRolePermissions`, `DefaultAccessRestrictions`. - **Part 17 `Aliases`** (i=23470): `LastChange`. Required by `AliasNameResolverRefreshMode.AutoOnLastChangeMonitoredItem` in `Opc.Ua.Client` which subscribes to LastChange to invalidate its cache. `ConfigurationNodeManager` continues to assign `CreateSelfSignedCertificate = new CreateSelfSignedCertificateMethodState(activeNode)` before `Create(...)` (it is no longer emitted by the singleton factory). ## Related Issues - Fixes #3768 - Follow-up to #3799 ## Verification - **Generated code inspection**: `CreateServerConfiguration` does **not** emit `ApplicationUri` / `ProductUri` / `ApplicationType` / `HasSecureElement` / `CancelChanges` / `ResetToServerDefaults` at `forInstance=true`. `CreateServer_ServerCapabilities` no longer emits the 14 SDK-handled Optional Properties at `forInstance=true`; the SDK re-adds them with the correct instance NodeIds. `CreateServerConfiguration_CertificateGroups` still emits `DefaultHttpsGroup` and `DefaultUserTokenGroup` (Object exemption) preserving the subtree NodeIds that `ConfigurationNodeManager` binds against. `CreateNamespaceMetadataType` (the type-def factory) emits all Optional Properties unconditionally so `ConfigurationNodeManager.CreateNamespaceMetadataStateAsync` keeps working for runtime-created metadata instances. - **Strengthened regression test** `ServerConfiguration_OptionalUnimplementedChildren_NotInAddressSpaceAsync`: - Negative: 8 expected-suppressed Variable/Method NodeIds (ServerConfiguration + PublishSubscribe) are absent. - Positive: all SDK-added children resolve at their well-known singleton-instance NodeIds — 14 ServerCapabilities Properties + 12 OperationLimits Properties + RedundantServerArray + 3 Server Optional Variables + the existing Server.Namespaces / GetMonitoredItems / ResendData / HistoryServerCapabilities.ServerTimestampSupported set. - Regression guard: `Server_ServerConfiguration_CertificateGroups_DefaultApplicationGroup_CertificateTypes` resolves at its well-known NodeId, and the Optional `DefaultHttpsGroup` / `DefaultUserTokenGroup` roots remain emitted (Object exemption). - WellKnownRole regression guard: one method per modifiable role resolves at its well-known NodeId (Observer.AddIdentity, Observer.ApplicationsExclude, Observer.AddApplication, Operator.AddEndpoint, Engineer.RemoveIdentity, Supervisor.RemoveApplication, ConfigureAdmin.RemoveEndpoint, SecurityAdmin.AddIdentity). - `Opc.Ua.Server.Tests`: **1683 / 1683** pass on net10 (5 pre-existing skips). - `Opc.Ua.Core.Security.Tests`: **547 / 547** pass on net10 (68 pre-existing skips). Includes the RoleManagementTests, SecurityRoleServerBase2Tests, and SecurityRoleServerDefaultPermsTests fixtures. - `Opc.Ua.Features.Tests`: **128 / 128** pass on net10 (22 pre-existing skips). Includes the RoleManagementClient and MonitoredItemAliasNameRefreshStrategySignAndEncryptTests fixtures. - `Opc.Ua.InformationModel.Tests`: **1052 / 1052** pass on net10 (24 pre-existing skips). - `Opc.Ua.Gds.Tests`: **875 / 875** pass on net10 (29 pre-existing skips). - `Opc.Ua.SourceGeneration.Core.Tests`: **3514 / 3514** pass on net10 (8 long-running compile-cycle integration tests skipped by the framework). - No `AnalogItemType.EURange` regression. ## Checklist - [x] 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. - [x] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [ ] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [x] 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. |
||
|
Marc Schier
|
4756e7c245 |
DI (OPC 10000-100) with samples (Pump, SW Update), fluent API gap closures and model dependency implementation (#3808)
This PR implements the **OPC UA Device Integration (DI, OPC 10000-100)** companion-spec library trio (`Opc.Ua.Di` / `Opc.Ua.Di.Server` / `Opc.Ua.Di.Client`) plus a worked example (`Applications/MinimalPumpServer`) demonstrating the OPC 40223 Pumps companion specification end-to-end with full simulation. It also closes 11 fluent-API gaps in `Opc.Ua.Server.Fluent`, three source-generator bugs, integrates the DI layer into the unified `services.AddOpcUa()` Microsoft.Extensions DI hosting pattern, and adds 250+ new tests. **Worked example — `Applications/MinimalPumpServer/`** - AOT-compatible console host using `Host.CreateApplicationBuilder` + `AddOpcUa()`. - `PumpNodeManager` inherits from `DiNodeManager`; multi-namespace (DI + Machinery + Pumps) via runtime NodeSet2 loading and `ModelLoaderBuilder`. - Demonstrates declarative second-pump creation via `.ConfigureDevicesFor<PumpNodeManager>(...)` and software-package seeding from the same configurator. - Full simulation: pressure, temperatures, power, flow, efficiency, level, cavitation/overheat fault injection, alarm setup, NAMUR-style supervision. **Documentation** - `Docs/Opc.Ua.Di/` — README, DeviceBuilder, Hosting, LockService, SoftwareUpdate, ClientHelpers (6 new developer guides). - `Docs/Opc.Ua.Di/ComplianceMatrix.md` — every DI declaration mapped to In-v1 / Generated / Deferred / Excluded. - `Docs/CompanionSpecLibraries.md` — packaging guide for new companion-spec libraries. - `Docs/FluentApiGaps.md` — historical record of G1–G11. - `Docs/SourceGeneratedNodeManagers.md` updated for richer node managers. - `Docs/plans/StateMachineBuilder.md` — deferred state-machine builder design. |
||
|
Marc Schier
|
01d7162313 |
Part 9 Alarms & Conditions: complete server + client implementation (#3805)
Complete implementation of **OPC UA Part 9 ΓÇö Alarms & Conditions** for
both server and client, **OPC UA Part 16 ΓÇö State Machines** (generic
extensible client + server API), and the supporting infrastructure
(source-generated event records, source-generated ObjectType proxies,
`IAsyncEnumerable` streaming subscriptions, address-space model change
tracking, per-node `INodeCache` invalidation, unified DI integration).
### Server-side (Part 9 complete)
- **`AlarmConditionState`** ΓÇö every Part 9 method wired automatically
in `OnAfterCreate`: `Silence`, `Suppress`/`Suppress2`,
`Unsuppress`/`Unsuppress2`, `RemoveFromService`/`RemoveFromService2`,
`PlaceInService`/`PlaceInService2`, `Reset`/`Reset2`,
`GetGroupMemberships`. Each method generates the spec-mandated audit
event and supports an optional veto-delegate hook.
- **Latched alarms** ΓÇö `ActiveState` reflects real process state;
`LatchedState` persists until explicit `Reset` (with full precondition
validation).
- **Re-alarming** ΓÇö
`ProcessReAlarm`/`ResetReAlarmRepeatCount`/`IsReAlarmEnabled` helpers
(opt-in, no hidden timer).
- **Audible alarms** ΓÇö `UpdateAudibleState` for
`AudibleEnabled`/`AudibleSound`/`SilenceState` lifecycle.
- **Suppression + groups** ΓÇö `AlarmGroup`, `AlarmSuppressionEngine`
(with first-in-group), `AlarmRateTracker` (for `AlarmMetricsType`).
- **Spec-compliance fixes** ΓÇö `SuppressedOrShelved` now includes
`OutOfServiceState`; `GetRetainState` includes `LatchedState`;
`EffectiveDisplayName` composition includes `OutOfServiceState` +
`LatchedState`.
### Client-side Part 9 API
- **`AlarmClient`** ΓÇö typed Part 9 operations. Each method delegates
to the matching source-generated `*TypeClient` proxy
(`ConditionTypeClient`, `AcknowledgeableConditionTypeClient`,
`AlarmConditionTypeClient`, `DialogConditionTypeClient`,
`ShelvedStateMachineTypeClient`) ΓÇö one source of truth for every
method NodeId.
- **Interface hierarchy** — `IConditionOperations` →
`IAcknowledgeableConditionOperations` → `IAlarmOperations` +
`IDialogConditionOperations`.
- **Source-generated event records** ΓÇö new `EventRecordGenerator`
(alongside `ObjectTypeProxyGenerator`) emits `{Type}TypeRecord` per OPC
UA event type: `ConditionTypeRecord` →
`AcknowledgeableConditionTypeRecord` → `AlarmConditionTypeRecord` →
`LimitAlarmTypeRecord`/`ExclusiveLimitAlarmTypeRecord`/… all the way
to vendor subtypes. **Vendor alarm types get records automatically.**
- **`AlarmEventDecoder`** ΓÇö decodes `EventNotification.Fields` into
the most-specific generated record.
- **`AlarmEventFilterBuilder`** ΓÇö fluent builder for Part 9
`EventFilter`s.
- **`ISession.GetAlarmClient(telemetry)`** convenience extension.
### Part 16 state machines (generic, extensible)
- **Client**: extension methods on the source-generated
`StateMachineTypeClient` / `FiniteStateMachineTypeClient` ΓÇö
`GetCurrentStateAsync`, `ObserveFiniteTransitionsAsync`
(`IAsyncEnumerable<FiniteStateSnapshot>`), `WaitForStateAsync`,
`GetAvailableStatesAsync` / `GetAvailableTransitionsAsync`. **Vendor
proxies inherit the API automatically** through the generated
inheritance chain.
- **Server**: `StateMachineBuilder` (fluent: `AddState` /
`AddTransition` / `OnCause` / validation) +
`FluentFiniteStateMachineState` ΓÇö declare a Part 16 state machine
without subclassing the abstract base.
- **Alarms alignment**: `AlarmClient.GetShelvingStateAsync` /
`ObserveShelvingTransitionsAsync` surface the API for every alarm's
`ShelvingState` child.
### IAsyncEnumerable streaming subscription
- **`IStreamingSubscription`** with
`SubscribeDataChangesAsync`/`SubscribeEventsAsync` returning
`IAsyncEnumerable<T>` (Channel-backed).
- **`ManagedSession.DefaultStreaming`** ΓÇö lazy shared subscription;
disposed with the session.
- **Helpers** ΓÇö `TakeUntilAsync`, `WithTimeoutAsync`, `TakeAsync`,
`BufferedAsync` for state-machine waits and bounded observation windows.
- **`AlarmStreamExtensions`** ΓÇö
`SubscribeAlarmsAsync`/`SubscribeConditionsAsync`/`SubscribeDialogsAsync`
returning the source-generated record types.
### Address-space model change tracking
- **Server**: `RaiseGeneralModelChangeEvent` on both `CustomNodeManager`
and `AsyncCustomNodeManager`; `ModelChangeAggregator` (in
`Opc.Ua.Server.NodeManager`, used by every node manager) batches changes
per service call; **auto-emit** from `CreateNode`/`DeleteNode` (opt-out
via `ModelChangeEmissionEnabled = false`).
- **Client**: `IModelChangeTracker` subscribes to
`BaseModelChangeEventType` via the streaming subscription, decodes
`ModelChangeStructureDataType` payloads, invalidates the `INodeCache`
per-node.
- **`INodeCache.InvalidateNode(NodeId)`** ΓÇö new interface member (true
per-node eviction in `NodeCache`).
- **`ManagedSession.EnableModelChangeTrackingAsync()`** +
`ManagedSessionOptions.ModelChangeTracking` +
`ManagedSessionBuilder.WithModelChangeTracking()` fluent method.
### Dependency Injection integration
- **`services.AddOpcUa().AddClient(...).AddAlarms()`** ΓÇö registers
`AlarmClientFactory` so DI-hosted apps can resolve a Part 9 client per
session without `new`-ing one manually.
- Cross-link added to the unified DI surface (`AddServer` / `AddClient`
/ `AddComplexTypes` / `AddGdsServer` / `AddLdsServer` /
`AddWotConServer`).
### Quickstart server modernization
- `Quickstarts.Servers/Alarms/AlarmNodeManager.cs` ported to
`AsyncCustomNodeManager` and demonstrates the new `AlarmGroup` +
`AlarmSuppressionEngine` end-to-end via a writable `MaintenanceMode`
boolean that suppresses every member alarm.
### Documentation
- New: `Docs/AlarmsAndConditions.md`, `Docs/StreamingSubscription.md`,
`Docs/ModelChangeTracking.md`, `Docs/StateMachines.md` ΓÇö full
developer guides.
- Updated: `Docs/DependencyInjection.md` (`AddAlarms()` row + section),
`Docs/README.md` index, `Docs/MigrationGuide.md` (Part 9 / Part 16 /
model change tracking sections covering behavior changes + breaking API
surface).
- Sample: `Applications/ConsoleReferenceClient/AlarmClientSample.cs`.
|
||
|
Marc Schier
|
239a40b183 |
GC reduction via IPooledEncodeable activator pooling (#3793)
* GC reduction via IPooledEncodeable activator pooling
Add opt-in activator-level pooling for IEncodeable instances decoded
during V2 subscription publish dispatch. The design replaces the
earlier IAllocator-on-IServiceMessageContext approach (which had a
cross-contamination hazard for non-publish decodes) with a clean
factory-based model where pooling lives on the encodeable activator.
New public API:
- IPooledEncodeable : IEncodeable - opt-in marker with Reuse() method
- PooledEncodeableType<T> : EncodeableType<T> - activator base with
BoundedObjectPool<T> (lock-free, no new package dependency)
- ISubscriptionManager.PoolNotifications { get; set; }
- ManagedSessionOptions.PoolNotifications { get; init; }
- ManagedSessionBuilder.WithPoolNotifications(bool)
Source-gen:
- All concrete non-abstract structure types (including service
request/response types) are generated with PooledEncodeableType<T>
activators and IPooledEncodeable.Reuse() bodies by default
- Derived types use 'new' to hide inherited Reuse/ClearPooledSentinel
so each concrete type routes through its own activator's pool
- No changes to external design XML files (UA Core Services.xml etc.)
- poolable selection is hardcoded in the generator
Benchmarks (MonitoredItemNotification, 1000 ops):
- Allocations: 128 KB -> 408 B (~315x reduction)
- Gen0 collections: 29.75 -> 0.09 per 1000 ops
No interface changes to IEncodeable, IDecoder, IServiceMessageContext,
or ISubscriptionNotificationHandler. Handlers retain by copy when
pooling is enabled.
Call IPooledEncodeable.Reuse() on decoded IServiceRequest and
IServiceResponse after the server is done with them:
- TcpTransportListener.OnRequestReceivedAsync: reuse both request
and response in a finally block after ProcessRequestAsync +
SendResponse complete
- EndpointBase.InvokeServiceAsync (HTTPS path): same pattern after
ProcessRequestAsync + BinaryEncoder.EncodeMessage
Walk acknowledged, overflow-evicted, and disposed NotificationMessage
objects and call IPooledEncodeable.Reuse() on their notification
payloads (MonitoredItemNotification, DataChangeNotification,
EventFieldList, EventNotificationList).
Insertion points in Subscription.cs:
- Acknowledge(): after RemoveAt from m_sentMessages
- InnerPublish() overflow: before RemoveRange/Clear on m_sentMessages
- Dispose(): before m_sentMessages.Clear()
- InnerPublish() unsent-message overflow: before RemoveRange on
the messages list
Replace new T() with XxxActivator.Instance.CreateInstance() for all
server-side notification payload types so instances are rented from
the activator pool instead of heap-allocated:
New static helper ReuseNotificationPayloads() walks the
NotificationMessage.NotificationData, extracts DataChangeNotification
and EventNotificationList via TryGetValue, iterates their items, and
calls Reuse() on each pooled payload.
|
||
|
Marc Schier
|
bd4543e961 |
ManagedSession, Pluggable Subscription engine, and fluent builder + DI (#3730)
- Add new managed session, wrapping session and providing connection management and failover handling - Add new Subscription engine that can act as alternative to current engine, but is based on channels with worker tasks - Add a fluent builder for managed session clients - Replace NodeCache with LruNodeCache, rename ILruNodeCache and LruNodeCache to INodeCache and NodeCache - Update migration guide and document new functionality. |
||
|
Marc SchierandCopilot
|
70abb05841 |
Remove Default JSON encoding infrastructure (#3713)
* Remove Default JSON encoding infrastructure Remove IJsonEncodeable interface, JsonEncodingId properties, DefaultJson constants, and all source generator JSON encoding output. The actual JsonEncoder/JsonDecoder and PubSub JSON encoding are not affected. - Delete IJsonEncodeable interface from IEncodable.cs - Remove DataTypeAttribute.JsonEncodingId and simplify TryGetTypeIdsFromType - Remove JSON encoding from 9 source generator files - Remove IJsonEncodeable from 13 built-in types and 12 node types - Remove JSON registration from EncodeableFactory and unboundTypeIds infra - Remove jsonEncodingId from OptionSet, ComplexTypeSystem, IComplexTypeFactory - Remove BrowseNames.DefaultJson and 25 *_Encoding_DefaultJson constants - Update ~14 test files and 2 documentation files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add IJsonEncodeable removal to migration guide Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * minor --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> |
||
|
Marc Schier
|
39fa3030fa |
Add a fluent api for server, a sample and generate node managers to use with it. (#3684)
* Add source-generated NodeManagers and fluent wiring API Adds a fluent INodeManagerBuilder API for wiring per-node callbacks and a model-aware source generator that emits a partial CustomNodeManager2 plus an INodeManagerFactory for each design file. Opt-in is per class via [Opc.Ua.Server.Fluent.NodeManager] on a partial class (recommended) or project-wide via the ModelSourceGeneratorGenerateNodeManager MSBuild property (legacy). The attribute supports NamespaceUri / Design selectors for multi-design projects and a GenerateFactory toggle. Diagnostics MODELGEN010 / MODELGEN011 surface unmatched bindings and non-partial classes. Adds the ConsoleBoilerServer NativeAOT sample driving the new pipeline end-to-end with Microsoft.Extensions.Logging.Console and updated docs in Docs/SourceGeneratedNodeManagers.md. * Add BoilerServer AOT smoke test Verifies the source-generated Boiler.BoilerNodeManagerFactory loads the boiler address space, registers its namespace, and dispatches the fluent OnRead callbacks wired in BoilerNodeManager.Configure.cs. All 3 new tests pass in JIT mode and against the NativeAOT-published binary; total Aot.Tests suite: 71/71 pass. |
||
|
Marc Schier
|
d14cd10a86 |
Model dependency annotations using source generator + flaky test fixes (#3687)
* Fix publish/dispose race that hangs Client tests
Subscription.Dispose pre-disposed m_publishTimer and m_messageWorkerCts
before calling ResetPublishTimerAndWorkerState, causing Cancel() to throw
ObjectDisposedException and leaving the publish worker stuck. Removed the
duplicate disposal so the reset method is the single owner of those resources,
and guarded Cancel/Dispose with try/catch ObjectDisposedException for defense
in depth.
Session.OnPublishComplete could run after Session.Dispose disposed
m_reconnectLock, throwing ObjectDisposedException from SemaphoreSlim.Wait()
and re-arming via the throttle path indefinitely. Added an early Disposed
guard, wrapped Wait/Release in try/catch ObjectDisposedException, and added
a Disposed guard in QueueBeginPublish so the throttle cannot reschedule
publishes after disposal.
Fixes the macOS net10.0 hang seen in Azure pipeline build 13257
(TransferSubscriptionAsync, ReconnectWithSavedSessionSecretsAsync).
* fix lockout test and use UserName token for SuccessfulAuthenticationClearsFailedAttempts test
After
|
||
|
Marc Schier
|
26a0b21881 |
Replace session state encoder with IEncodable generation using source generators (#3673)
* Replace SessionStateEncoder with IEncodeable on session/subscription models - Source-gen [DataType]/[DataTypeField] on: MonitoredItemOptions, MonitoredItemState, SubscriptionOptions, SubscriptionState (auto-generated Encode/Decode/IsEqual/Clone) - Manual IEncodeable on: SessionOptions, SessionState, SessionConfiguration (ConfiguredEndpoint and IUserIdentity require manual encoding) - Delete SessionStateEncoder.cs (488 lines removed) - Remove [DataContract]/[DataMember]/[KnownType]/[CollectionDataContract] attributes - Remove JsonSerializerContext classes - Change init -> set, byte[] -> ByteString, DateTime -> DateTimeUtc - MonitoredItems: ArrayOf<MonitoredItemState> with StructureHandling.Inline - Subscriptions: ArrayOf<SubscriptionState> * Source generator: support partial init properties with backing fields Add IsInitOnly detection to the [DataType] source generator so that partial properties with init-only setters can be used in IEncodeable types. For each init-only partial property, the generator: - Emits a private backing field (__PropertyName) - Emits the partial property implementation (get => __field; init => __field = value) - Uses the backing field in Decode() instead of the property - Skips simple init-only fields in Clone() (record 'with' already copies them) Detection uses both IPropertySymbol.SetMethod.IsInitOnly and syntax-tree fallback (SyntaxKind.InitAccessorDeclaration) for partial definitions. * docs: add partial init properties and session state migration sections - SourceGeneratedDataTypes.md: new 'Partial Init Properties' section documenting backing field generation for init-only partial properties - MigrationGuide.md: new 'Session State Persistence' section covering |
||
|
Marc SchierandCopilot
|
c71f2e7733 |
Fix source generator generated structures with optional fields (#3674)
Split validator load/validate; split DesignFileCollection Targets/Dependencies ModelDesignValidator.LoadNodes now skips ValidateDictionary when a model is loaded purely as a dependency. The flag is plumbed through LoadModelDesign and LoadDesignFile; the dep loop in ValidateModel passes false, the primary target passes true. This lets callers supply unrelated or reverse dependencies (deps that import the target) without triggering premature validation failures. DesignFileCollection exposes Targets + Dependencies; generators and tests updated. MergeNamespace preserves FilePath across PublicationDate-based replacement so later loads can still find the source file. Tester simplified to treat every other xml/csv pair as a dependency of each target. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> |
||
|
Marc Schier
|
fd41681f4b |
Add support to publish OPC UA applications as Native AOT (#3633)
* make most ptojects aot compatible * Remove newtonsoft * Migrate all projects from Mono.Options to System.CommandLine 2.0.5 * Fix array clone * Replace serializers for storage using new attribute driven type geberator * Add new AOT integration tests covering all functional areas * Documentation updates |
||
|
Marc Schier
|
03777ecb09 |
New Json decoder/encoders, array/matrix abstractions, ByteString, and more. (#3619)
- **Collections overhaul** — new/rewritten collection types (`ArrayOf`, `Collections` commits)
- **`Variant` builder/accessor** — new APIs for constructing and accessing Variants
- **`NodeId` operators made explicit** — breaking change for implicit conversions
- **Version bumped to 1.6** with preview build support
- **NumericRange** uses Variant
- **object** type accessors and general usage removed.
### 🏗️ Infrastructure
- Build config updated; `.NET 10` targeting
- InternalsVisibleTo moved to `.csproj`
- Pipeline/CI adjustments
|
||
|
Marc Schier
|
f66ceffd75 |
Immutable built in types and code generation (#3534)
Generate stack and application code using source generators Change built in types to readonly structs Update localized text implementation to use JSON text serializer Status code with symbolic names Immutable node ids No boxing for all built in types <= 8 bytes in Variant. Split user identity token and token handling via token handler Add migration guide for breaking changes |