Files
UA-.NETStandard/tools/Opc.Ua.SourceGeneration.Core/Generators/NodeManagerTemplates.cs
romanett 96c5ef1623 Run the fluent configure pipeline in FluentNodeManagerBase (#4537) (#4538)
## Proposed changes

Closes #4537. The configure pipeline now lives in
`FluentNodeManagerBase`, so a hand-written fluent node manager only
overrides `ConfigureAsync` and no longer writes
`CreateAddressSpaceAsync` itself.

`FluentNodeManagerBase.CreateAddressSpaceAsync` now:
1. loads the predefined nodes (as `AsyncCustomNodeManager` did before),
2. creates a builder for `NamespaceIndex` with `CreateFluentBuilder`,
3. awaits `ConfigureAsync(builder, ct)`,
4. runs `RegisterAuthoredNodesAsync` and then `CompleteConfigureAsync`,
5. finishes with `SealConfigurationAsync`, which seals the builder,
replays `NotifyNodeAdded`, then activates behaviors and simulations.

### Breaking change (2.0)
Some managers need a different order, for example a post-setup runner
before sealing, a builder for another namespace, or work after sealing.
They must stop calling `base.CreateAddressSpaceAsync`, because that
would now run a second, empty pipeline and seal the manager-owned
registries too early. These managers now call
`LoadPredefinedNodesAsync(SystemContext, externalReferences, ct)` and
keep driving their own pipeline:
- the source-generated `NodeManager` template (the ordering test in
`NodeManagerGeneratorTests` is updated)
- `DiNodeManager`, `Isa95NodeManager`, `PositioningNodeManager`,
`RobotIntentNodeManager`, `VisionNodeManager`
- `samples/OpenUsd/SiteCompositionServer/SiteNodeManager`

These now use the base pipeline:
- `samples/FluentApi/BasicFluentApiServer/BasicFluentNodeManager`
becomes a single `ConfigureAsync` override. Before this change it never
sealed its builder.
- the hosting `FluentNodeManager` (from `AddNodeManager(namespaceUri,
build)`) becomes a `ConfigureAsync` override. It now seals through
`SealConfigurationAsync`, so `OnNodeAdded` handlers wired in the build
delegate fire. Before, it called `builder.SealAsync()` directly and they
did not.

Docs (`NodeManagers.md`, `DeviceIntegration.md`) are updated.
`NodeManagers.md` gets a short hand-written `ConfigureAsync` example.

## Types of changes

- [x] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Enhancement (non-breaking change which adds functionality)

## Checklist

- [x] I have read the CONTRIBUTING doc.
- [x] I have signed the CLA.
- [x] I ran tests locally with my changes, all passed.
- [x] I fixed all failing tests in the CI pipelines.
- [x] I fixed all introduced issues with CodeQL and LGTM.
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added necessary documentation (if appropriate).

## Tests

New `FluentNodeManagerBasePipelineTests`: nodes authored in
`ConfigureAsync` get registered, the Objects-folder reference is
mirrored into `externalReferences`, `OnNodeAdded` fires once, and the
builder is sealed afterwards.

Local run on net10.0, all passing:
- Opc.Ua.Server.Tests (Fluent/Hosting/StateMachine/RuntimeNodeSet
filter): 1286
- Opc.Ua.SourceGeneration.Core.Tests (NodeManager filter): 40
- Opc.Ua.Di.Tests 426, ISA95 136, Positioning 69, Robotics 636,
Robotics.Intent 22, Vision 484 (+1 skipped), Vision.Intent 14, OpenUsd
921

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 07:48:29 +02:00

434 lines
23 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/
* ======================================================================*/
namespace Opc.Ua.SourceGeneration
{
/// <summary>
/// Templates emitted by the <see cref="NodeManagerGenerator"/>.
/// </summary>
/// <remarks>
/// All emitted code uses fully-qualified type names so the consuming
/// project only needs to reference <c>Opc.Ua.Server</c> (which itself
/// transitively brings in <c>Opc.Ua.Core</c>).
/// </remarks>
internal static class NodeManagerTemplates
{
/// <summary>
/// Top-level template for the partial <c>NodeManager</c> class.
/// </summary>
public static readonly TemplateString File = TemplateString.Parse(
$$"""
{{Tokens.CodeHeader}}
// The namespace-taking constructor is emitted for every manager,
// but the user's partial decides whether the class is sealed and
// the generator cannot see that. In a sealed manager the protected
// constructor is merely unreachable, not wrong.
#pragma warning disable CS0628 // New protected member in sealed type
namespace {{Tokens.NamespacePrefix}}
{
/// <summary>
/// Source-generated node manager for the
/// <c>{{Tokens.NamespaceUri}}</c> namespace.
/// </summary>
/// <remarks>
/// Implement <c>partial void Configure(INodeManagerBuilder builder)</c>
/// in a sibling partial to wire per-node callbacks using the
/// fluent API in <c>Opc.Ua.Server.Fluent</c>. Wiring that has to
/// await — materialising instances, reading a store — goes into
/// an override of
/// <c>ConfigureAsync(INodeManagerBuilder, CancellationToken)</c>,
/// which runs first so <c>Configure</c> sees the nodes it created.
/// </remarks>
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("{{Tokens.Tool}}", "{{Tokens.Version}}")]
public partial class {{Tokens.NodeManagerClassName}} :
global::Opc.Ua.Server.Fluent.FluentNodeManagerBase,
global::Opc.Ua.Server.Nodes.INodeSetImportFactoryProvider
{
private global::Opc.Ua.Server.Fluent.NodeManagerBuilder? __m_builder;
/// <summary>
/// The namespace URIs this manager owns, in the order they
/// are reported to the master node manager. The first entry
/// becomes <c>NamespaceIndexes[0]</c> and therefore the
/// manager's own <c>NamespaceIndex</c>: the namespace an
/// unqualified browse path resolves in. Where runtime
/// NodeIds are minted is the NodeId factory's to decide,
/// not this order's. Pass a different array to the
/// protected constructor to change the set or the order.
/// </summary>
public static string[] DefaultNamespaceUris()
{
return new string[] { {{Tokens.NamespaceUri}}{{Tokens.AdditionalNamespaceUris}} };
}
{{Tokens.NodeManagerDefaultConstructor}}
/// <summary>
/// Initializes a new <see cref="{{Tokens.NodeManagerClassName}}"/>
/// that owns <paramref name="namespaceUris"/>. Chain to this
/// from a constructor of your own to take collaborators the
/// generated signature does not carry, to change which
/// namespaces the manager owns, or to change their order.
/// </summary>
/// <param name="server">The hosting server.</param>
/// <param name="configuration">The application configuration.</param>
/// <param name="namespaceUris">
/// The namespace URIs to report, in order. <c>null</c> adopts
/// <see cref="DefaultNamespaceUris"/>.
/// </param>
protected {{Tokens.NodeManagerClassName}}(
global::Opc.Ua.Server.IServerInternal server,
global::Opc.Ua.ApplicationConfiguration configuration,
string[]? namespaceUris)
: base(
server,
configuration,
global::Opc.Ua.TelemetryExtensions.CreateLogger<{{Tokens.NodeManagerClassName}}>(
server.Telemetry),
namespaceUris ?? DefaultNamespaceUris())
{
}
/// <summary>
/// User extensibility hook. Implement in a sibling
/// <c>partial</c> to wire callbacks via the fluent builder.
/// Override
/// <c>FluentNodeManagerBase.ConfigureAsync</c> instead when
/// the wiring has to await.
/// </summary>
partial void Configure(global::Opc.Ua.Server.Fluent.INodeManagerBuilder builder);
/// <summary>
/// Source-generated typed counterpart of
/// <see cref="Configure(global::Opc.Ua.Server.Fluent.INodeManagerBuilder)"/>.
/// Implement in a sibling <c>partial</c> to wire callbacks via the
/// strongly-typed model-traversal surface generated for this manager.
/// </summary>
partial void Configure(I{{Tokens.NodeManagerClassName}}Builder builder);
/// <summary>
/// Supplies the concrete states used when a NodeSet2
/// document imported through
/// <c>INodeManagerBuilder.Import</c> declares a node of
/// this model.
/// </summary>
public global::Opc.Ua.ArrayOf<
global::Opc.Ua.Server.Nodes.INodeSetImportFactory>
GetNodeSetImportFactories()
{
var __factories = new global::System.Collections.Generic.List<
global::Opc.Ua.Server.Nodes.INodeSetImportFactory>();
global::Opc.Ua.ArrayOf<
global::Opc.Ua.Server.Nodes.INodeSetImportFactory>
__generatedFactories =
global::{{Tokens.Prefix}}.
{{Tokens.NodeSetImportFactoryProviderClassName}}.Instance.
GetNodeSetImportFactories();
for (int __index = 0;
__index < __generatedFactories.Count;
__index++)
{
__factories.Add(__generatedFactories[__index]);
}
AddNodeSetImportFactories(__factories);
return new global::Opc.Ua.ArrayOf<
global::Opc.Ua.Server.Nodes.INodeSetImportFactory>(
__factories.ToArray());
}
/// <summary>
/// Adds import factories supplied by dependency models or
/// by the application. Implement in a sibling
/// <c>partial</c>.
/// </summary>
partial void AddNodeSetImportFactories(
global::System.Collections.Generic.List<
global::Opc.Ua.Server.Nodes.INodeSetImportFactory> factories);
/// <inheritdoc/>
protected override global::System.Threading.Tasks.ValueTask<global::Opc.Ua.NodeStateCollection> LoadPredefinedNodesAsync(
global::Opc.Ua.ISystemContext context,
global::System.Threading.CancellationToken cancellationToken = default)
{
return new global::System.Threading.Tasks.ValueTask<global::Opc.Ua.NodeStateCollection>(
global::{{Tokens.Prefix}}.{{Tokens.Namespace}}Extensions.Add{{Tokens.Namespace}}(
new global::Opc.Ua.NodeStateCollection(),
context));
}
/// <inheritdoc/>
public override async global::System.Threading.Tasks.ValueTask CreateAddressSpaceAsync(
global::System.Collections.Generic.IDictionary<global::Opc.Ua.NodeId,
global::System.Collections.Generic.IList<global::Opc.Ua.IReference>> externalReferences,
global::System.Threading.CancellationToken cancellationToken = default)
{
await LoadPredefinedNodesAsync(SystemContext, externalReferences, cancellationToken).ConfigureAwait(false);
ushort __nsIndex = Server.NamespaceUris.GetIndexOrAppend({{Tokens.NamespaceUri}});
__m_builder = new global::Opc.Ua.Server.Fluent.NodeManagerBuilder(
SystemContext,
this,
__nsIndex,
__FindRootByBrowseName,
__FindRootByNodeId,
__FindByTypeDefinitionId,
__FindByDataTypeId);
// Attach the FluentNodeManagerBase event-source registry
// to the builder so Publish(...) extensions can resolve
// it before the user's Configure partial(s) run.
AttachToBuilder(__m_builder);
// The awaitable wiring seam. Runs before the synchronous
// Configure partial(s) so instances it materialises are in
// the address space by the time they wire callbacks.
await ConfigureAsync(__m_builder, cancellationToken).ConfigureAwait(false);
Configure(__m_builder);
Configure(new {{Tokens.NodeManagerClassName}}TypedBuilder(__m_builder));
// Register nodes created by the Configure partial(s)
// through the builder's Add* methods before the
// reverse-reference pass runs, so their references to
// externally owned nodes are mirrored too.
await RegisterAuthoredNodesAsync(__m_builder, cancellationToken).ConfigureAwait(false);
// Mirror references from configure-created nodes to
// nodes owned by other node managers (e.g. the Objects
// folder) into the externalReferences dictionary.
await CompleteConfigureAsync(externalReferences, cancellationToken).ConfigureAwait(false);
// Seals the builder, replays NotifyNodeAdded for every
// predefined node so per-node lifecycle hooks fire
// deterministically, and only then completes the
// registrations Configure could not await (root
// notifiers) and starts the simulations, so no
// simulated value change can precede the OnNodeAdded
// handler of its own node.
await SealConfigurationAsync(__m_builder, cancellationToken).ConfigureAwait(false);
}
/// <inheritdoc/>
protected override async global::System.Threading.Tasks.ValueTask AddPredefinedNodeAsync(
global::Opc.Ua.ISystemContext context,
global::Opc.Ua.NodeState node,
global::System.Threading.CancellationToken cancellationToken = default)
{
await base.AddPredefinedNodeAsync(context, node, cancellationToken).ConfigureAwait(false);
if (__m_builder is { } __b)
{
__b.Dispatcher.NotifyNodeAdded(context, node);
}
}
/// <inheritdoc/>
protected override async global::System.Threading.Tasks.ValueTask RemovePredefinedNodeAsync(
global::Opc.Ua.ISystemContext context,
global::Opc.Ua.NodeState node,
global::System.Collections.Generic.List<global::Opc.Ua.Server.LocalReference> referencesToRemove,
global::System.Threading.CancellationToken cancellationToken = default)
{
if (__m_builder is { } __b)
{
__b.Dispatcher.NotifyNodeRemoved(context, node);
}
await base.RemovePredefinedNodeAsync(context, node, referencesToRemove, cancellationToken).ConfigureAwait(false);
}
private global::Opc.Ua.NodeState __FindRootByBrowseName(global::Opc.Ua.QualifiedName browseName)
{
if (browseName == null)
{
return null;
}
foreach (global::Opc.Ua.NodeState __node in PredefinedNodes.Values)
{
if (__node.BrowseName == browseName)
{
return __node;
}
}
return null;
}
private global::Opc.Ua.NodeState __FindRootByNodeId(global::Opc.Ua.NodeId nodeId)
{
if (nodeId.IsNull)
{
return null;
}
return PredefinedNodes.TryGetValue(nodeId, out global::Opc.Ua.NodeState __node) ? __node : null;
}
private global::System.Collections.Generic.IReadOnlyList<global::Opc.Ua.NodeState> __FindByTypeDefinitionId(
global::Opc.Ua.NodeId typeDefinitionId)
{
if (typeDefinitionId == null || typeDefinitionId.IsNull)
{
return global::System.Array.Empty<global::Opc.Ua.NodeState>();
}
var __matches = new global::System.Collections.Generic.List<global::Opc.Ua.NodeState>();
var __queue = new global::System.Collections.Generic.Queue<global::Opc.Ua.NodeState>();
var __seen = new global::System.Collections.Generic.HashSet<global::Opc.Ua.NodeState>();
var __scratch = new global::System.Collections.Generic.List<global::Opc.Ua.BaseInstanceState>();
foreach (global::Opc.Ua.NodeState __root in PredefinedNodes.Values)
{
if (__root != null && __seen.Add(__root))
{
__queue.Enqueue(__root);
}
}
while (__queue.Count > 0)
{
global::Opc.Ua.NodeState __current = __queue.Dequeue();
if (__current is global::Opc.Ua.BaseInstanceState __instance &&
__instance.TypeDefinitionId == typeDefinitionId)
{
__matches.Add(__current);
}
__scratch.Clear();
__current.GetChildren(SystemContext, __scratch);
for (int __i = 0; __i < __scratch.Count; __i++)
{
global::Opc.Ua.BaseInstanceState __child = __scratch[__i];
if (__child != null && __seen.Add(__child))
{
__queue.Enqueue(__child);
}
}
}
return __matches;
}
private global::Opc.Ua.ArrayOf<global::Opc.Ua.NodeState> __FindByDataTypeId(
global::Opc.Ua.NodeId dataTypeId)
{
if (dataTypeId == null || dataTypeId.IsNull)
{
return [];
}
var __matches = new global::System.Collections.Generic.List<global::Opc.Ua.NodeState>();
var __queue = new global::System.Collections.Generic.Queue<global::Opc.Ua.NodeState>();
var __seen = new global::System.Collections.Generic.HashSet<global::Opc.Ua.NodeState>();
var __scratch = new global::System.Collections.Generic.List<global::Opc.Ua.BaseInstanceState>();
foreach (global::Opc.Ua.NodeState __root in PredefinedNodes.Values)
{
if (__root != null && __seen.Add(__root))
{
__queue.Enqueue(__root);
}
}
while (__queue.Count > 0)
{
global::Opc.Ua.NodeState __current = __queue.Dequeue();
if (__current is global::Opc.Ua.BaseVariableState __variable &&
__variable.DataType == dataTypeId)
{
__matches.Add(__current);
}
__scratch.Clear();
__current.GetChildren(SystemContext, __scratch);
for (int __i = 0; __i < __scratch.Count; __i++)
{
global::Opc.Ua.BaseInstanceState __child = __scratch[__i];
if (__child != null && __seen.Add(__child))
{
__queue.Enqueue(__child);
}
}
}
return new global::Opc.Ua.ArrayOf<global::Opc.Ua.NodeState>(
__matches.ToArray());
}
}
}
""");
/// <summary>
/// The public <c>(server, configuration)</c> constructor. Emitted
/// unless the binding sets <c>GenerateDefaultConstructor=false</c>,
/// which managers do when they cannot be built from those two
/// arguments alone.
/// </summary>
public static readonly TemplateString DefaultConstructor = TemplateString.Parse(
$$"""
/// <summary>
/// Initializes a new <see cref="{{Tokens.NodeManagerClassName}}"/>
/// owning <see cref="DefaultNamespaceUris"/>.
/// </summary>
/// <param name="server">The hosting server.</param>
/// <param name="configuration">The application configuration.</param>
public {{Tokens.NodeManagerClassName}}(
global::Opc.Ua.Server.IServerInternal server,
global::Opc.Ua.ApplicationConfiguration configuration)
: this(server, configuration, null)
{
}
""");
/// <summary>
/// Top-level template for the generated factory class.
/// </summary>
public static readonly TemplateString FactoryFile = TemplateString.Parse(
$$"""
{{Tokens.CodeHeader}}
namespace {{Tokens.NamespacePrefix}}
{
/// <summary>
/// Source-generated <see cref="global::Opc.Ua.Server.INodeManagerFactory"/>
/// for the <c>{{Tokens.NamespaceUri}}</c> namespace.
/// </summary>
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("{{Tokens.Tool}}", "{{Tokens.Version}}")]
public partial class {{Tokens.NodeManagerFactoryClassName}} : global::Opc.Ua.Server.IAsyncNodeManagerFactory
{
/// <inheritdoc/>
public virtual global::Opc.Ua.ArrayOf<string> NamespacesUris
=> new global::Opc.Ua.ArrayOf<string>(new string[] { {{Tokens.NamespaceUri}}{{Tokens.AdditionalNamespaceUris}} });
/// <inheritdoc/>
public virtual global::System.Threading.Tasks.ValueTask<global::Opc.Ua.Server.IAsyncNodeManager> CreateAsync(
global::Opc.Ua.Server.IServerInternal server,
global::Opc.Ua.ApplicationConfiguration configuration,
global::System.Threading.CancellationToken cancellationToken = default)
{
return new global::System.Threading.Tasks.ValueTask<global::Opc.Ua.Server.IAsyncNodeManager>(
new {{Tokens.NodeManagerClassName}}(server, configuration));
}
}
}
""");
}
}