Implement dependency injection for application instance, server and n… #3022

wbtoms · 2025-02-28T08:20:21Z

Proposed changes

When integrating UA-.NETStandard, it is difficult to perform unit tests or even integration while you basically need to setup almost all objects from the application instance to the node managers with their actual implementations. No possibility to mock them or to create what is just necessary.

It is also diffiicult to replace an implementation of a given component by another custom implementation.

Therefore I propose this change which is, a first step, to introduce dependency injections for:

Application instance
Server
Node managers

Related Issues

No related open issue found.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply. You can also fill these out after creating the PR.

Bugfix (non-breaking change which fixes an issue)
Enhancement (non-breaking change which adds functionality)
Test enhancement (non-breaking change to increase test coverage)
Breaking change (fix or feature that would cause existing functionality to not work as expected, requires version increase of Nuget packages)
Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

I have read the CONTRIBUTING doc.
I have signed the CLA.
I ran tests locally with my changes, all passed.
I fixed all failing tests in the CI pipelines.
I fixed all introduced issues with CodeQL and LGTM.
I have added tests that prove my fix is effective or that my feature works and increased code coverage.
I have added necessary documentation (if appropriate).
Any dependent changes have been merged and published in downstream modules.

Further comments

If this proposition is interresting and at some point is merged, it might be interresting also to continue with orther types of object especially everything around NodeState. And of course, the client library should be treated the same way. But before going further, let see if this make sense for the audience.

CLAassistant · 2025-02-28T08:20:28Z

All committers have signed the CLA.

Libraries/Opc.Ua.Server/Opc.Ua.Server.csproj

codecov · 2025-02-28T14:41:25Z

Codecov Report

Attention: Patch coverage is 64.73988% with 61 lines in your changes missing coverage. Please review.

Project coverage is 56.65%. Comparing base (6bbe07c) to head (c4b74f7).

Files with missing lines	Patch %	Lines
...aries/Opc.Ua.Server/NodeManager/CoreNodeManager.cs	19.35%	24 Missing and 1 partial ⚠️
...braries/Opc.Ua.Server/Server/ServerInternalData.cs	73.68%	16 Missing and 4 partials ⚠️
Libraries/Opc.Ua.Server/Server/StandardServer.cs	65.38%	2 Missing and 7 partials ⚠️
...raries/Opc.Ua.Configuration/ApplicationInstance.cs	28.57%	5 Missing ⚠️
...ies/Opc.Ua.Server/NodeManager/MasterNodeManager.cs	89.47%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3022      +/-   ##
==========================================
+ Coverage   56.64%   56.65%   +0.01%     
==========================================
  Files         356      359       +3     
  Lines       68435    68477      +42     
  Branches    14072    14080       +8     
==========================================
+ Hits        38765    38797      +32     
- Misses      25491    25493       +2     
- Partials     4179     4187       +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

romanett · 2025-03-01T16:24:09Z

/azp run

azure-pipelines · 2025-03-01T16:24:14Z

Pull request contains merge conflicts.

romanett · 2025-03-10T14:15:44Z

/azp run

azure-pipelines · 2025-03-10T14:15:53Z

Azure Pipelines successfully started running 1 pipeline(s).

Applications/ConsoleReferenceServer/Program.cs

romanett · 2025-03-10T14:22:42Z

Applications/ConsoleReferenceServer/UAServer.cs

-                    ConfigSectionName = configSectionName,
-                    CertificatePasswordProvider = PasswordProvider
-                };
+                var passwordProvider = new CertificatePasswordProvider(Password);


previously LoadAsync created a new application instance, now it doesnt.

I need to check...

Yes, now this object comes from the DI. This was the intension.

Yeah but if you call load twice previously a new instance was created now the Same is reused. I need to Check If this could cause unwanted behaviour changes

I see, for this shadow config use case, right? I think this works becauce LoadApplicationConfiguration sets the application configuration to null before relaoding it so it is always a complete new instance of the configuration.

But what is the shadow configuration use case for excatly? do you know?

Libraries/Opc.Ua.Configuration/IApplicationInstance.cs

Libraries/Opc.Ua.Configuration/Opc.Ua.Configuration.csproj

Libraries/Opc.Ua.Server/NodeManager/CoreNodeManager.cs

Libraries/Opc.Ua.Server/NodeManager/MasterNodeManager.cs

Libraries/Opc.Ua.Server/Server/IServerInternal.cs

Libraries/Opc.Ua.Server/Server/StandardServer.cs

…ode managers

romanett

Thank you for this valuable additions. We really appreciate it.

Please add the new constructors as an option in addition to the existing ones. We cannot break all existing implementations with this PR.

romanett · 2025-06-27T12:36:20Z

@wbtoms I will gradually introduce these changes with multiple PRs in a more compatible manner. Thank you for all the work you put into this.

Copilot

Pull Request Overview

This PR introduces dependency injection for core server components to improve testability and enable easier integration of the UA-.NETStandard library. The changes add interfaces for key server classes and provide DI service registration methods.

Introduces interfaces for major server components (IStandardServer, IServerInternal, IApplicationInstance, etc.)
Adds service collection extension methods for registering server services
Updates tests to use dependency injection for server instantiation

Reviewed Changes

Copilot reviewed 49 out of 50 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
Multiple test files	Updated to use DI container for server instantiation
IStandardServer.cs	New interface for StandardServer
IApplicationInstance.cs	New interface for ApplicationInstance
IServerInternal.cs	Enhanced interface with additional methods
ServiceCollectionExtensions.cs	DI registration methods
StandardServer.cs	Implements IStandardServer, requires DI parameters
Various other interface files	New interfaces for core components

Copilot · 2025-07-31T05:19:30Z

Tests/Opc.Ua.Server.Tests/ReferenceServerTest.cs

                NodeId[] testSet = CommonTestWorkers.NodeIdTestSetStatic.Select(n => ExpandedNodeId.ToNodeId(n, namespaceUris)).ToArray();
                transferRequestHeader.Timestamp = DateTime.UtcNow;
-                var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize, -1);
+                var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize);


The method call is missing a parameter. The original call had 5 parameters including a -1 value, but now only 4 parameters are provided. This suggests the method signature changed but this call wasn't fully updated.

Suggested change

var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize);

var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize, -1);

Copilot · 2025-07-31T05:19:31Z

Libraries/Opc.Ua.Server/Server/StandardServer.cs

-            m_nodeManagerFactories = new List<INodeManagerFactory>();
+            m_applicationInstance = applicationInstance ?? throw new ArgumentNullException(nameof(applicationInstance));
+            m_serverInternal = serverInternal ?? throw new ArgumentNullException(nameof(serverInternal));
+            m_mainNodeManagerFactory = mainNodeManagerFactory ?? throw new ArgumentNullException(nameof(mainNodeManagerFactory)); ;


There's an extra semicolon at the end of this line. The double semicolon should be reduced to a single semicolon.

Suggested change

m_mainNodeManagerFactory = mainNodeManagerFactory ?? throw new ArgumentNullException(nameof(mainNodeManagerFactory)); ;

m_mainNodeManagerFactory = mainNodeManagerFactory ?? throw new ArgumentNullException(nameof(mainNodeManagerFactory));

Copilot · 2025-07-31T05:19:31Z

Libraries/Opc.Ua.Server/Server/IServerInternal.cs

+        public void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);
+
+        /// <summary>
+        /// Stores the MasterNodeManager and the CoreNodeManager
+        /// </summary>
+        /// <param name="nodeManager">The node manager.</param>
+        public void SetNodeManager(IMasterNodeManager nodeManager);
+
+        /// <summary>
+        /// Stores the SessionManager, the SubscriptionManager in the datastore.
+        /// </summary>
+        /// <param name="sessionManager">The session manager.</param>
+        /// <param name="subscriptionManager">The subscription manager.</param>
+        public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);


This interface method should not use the 'public' access modifier within an interface definition. Interface methods are implicitly public.

Suggested change

public void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);

/// <summary>

/// Stores the MasterNodeManager and the CoreNodeManager

/// </summary>

/// <param name="nodeManager">The node manager.</param>

public void SetNodeManager(IMasterNodeManager nodeManager);

/// <summary>

/// Stores the SessionManager, the SubscriptionManager in the datastore.

/// </summary>

/// <param name="sessionManager">The session manager.</param>

/// <param name="subscriptionManager">The subscription manager.</param>

public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);

/// <summary>

/// Stores the MasterNodeManager and the CoreNodeManager

/// </summary>

/// <param name="nodeManager">The node manager.</param>

void SetNodeManager(IMasterNodeManager nodeManager);

/// <summary>

/// Stores the SessionManager, the SubscriptionManager in the datastore.

/// </summary>

/// <param name="sessionManager">The session manager.</param>

/// <param name="subscriptionManager">The subscription manager.</param>

void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

Copilot · 2025-07-31T05:19:31Z

Libraries/Opc.Ua.Server/Server/IServerInternal.cs

+        public void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);
+
+        /// <summary>
+        /// Stores the MasterNodeManager and the CoreNodeManager
+        /// </summary>
+        /// <param name="nodeManager">The node manager.</param>
+        public void SetNodeManager(IMasterNodeManager nodeManager);
+
+        /// <summary>
+        /// Stores the SessionManager, the SubscriptionManager in the datastore.
+        /// </summary>
+        /// <param name="sessionManager">The session manager.</param>
+        /// <param name="subscriptionManager">The subscription manager.</param>
+        public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);


This interface method should not use the 'public' access modifier within an interface definition. Interface methods are implicitly public.

Suggested change

public void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);

/// <summary>

/// Stores the MasterNodeManager and the CoreNodeManager

/// </summary>

/// <param name="nodeManager">The node manager.</param>

public void SetNodeManager(IMasterNodeManager nodeManager);

/// <summary>

/// Stores the SessionManager, the SubscriptionManager in the datastore.

/// </summary>

/// <param name="sessionManager">The session manager.</param>

/// <param name="subscriptionManager">The subscription manager.</param>

public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

void CreateServerObject(EventManager eventManager, ResourceManager resourceManager, RequestManager requestManager);

/// <summary>

/// Stores the MasterNodeManager and the CoreNodeManager

/// </summary>

/// <param name="nodeManager">The node manager.</param>

void SetNodeManager(IMasterNodeManager nodeManager);

/// <summary>

/// Stores the SessionManager, the SubscriptionManager in the datastore.

/// </summary>

/// <param name="sessionManager">The session manager.</param>

/// <param name="subscriptionManager">The subscription manager.</param>

void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

Copilot · 2025-07-31T05:19:31Z

Libraries/Opc.Ua.Server/Server/IServerInternal.cs

+        /// </summary>
+        /// <param name="sessionManager">The session manager.</param>
+        /// <param name="subscriptionManager">The subscription manager.</param>
+        public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);


This interface method should not use the 'public' access modifier within an interface definition. Interface methods are implicitly public.

Suggested change

public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

Copilot · 2025-07-31T05:19:32Z

Libraries/Opc.Ua.Server/Server/IServerInternal.cs

+        /// <summary>
+        /// Stores the MonitoredItemQueueFactory in the datastore.
+        /// </summary>
+        /// <param name="monitoredItemQueueFactory">The MonitoredItemQueueFactory.</param>


[nitpick] This method is missing documentation while other methods in the interface have XML documentation comments. For consistency, all public interface methods should be documented.

Suggested change

/// <param name="monitoredItemQueueFactory">The MonitoredItemQueueFactory.</param>

/// <param name="monitoredItemQueueFactory">The MonitoredItemQueueFactory.</param>

/// <summary>

/// Stores the MonitoredItemQueueFactory in the datastore.

/// </summary>

/// <param name="monitoredItemQueueFactory">The factory used to create monitored item queues.</param>

wbtoms force-pushed the IntroduceDependencyInjection branch from 6feb171 to 357cb10 Compare February 28, 2025 08:36

romanett reviewed Feb 28, 2025

View reviewed changes

Libraries/Opc.Ua.Server/Opc.Ua.Server.csproj Outdated Show resolved Hide resolved

wbtoms force-pushed the IntroduceDependencyInjection branch from 357cb10 to c326401 Compare February 28, 2025 09:57

wbtoms force-pushed the IntroduceDependencyInjection branch from c326401 to 7dfa024 Compare March 7, 2025 10:05

wbtoms requested a review from romanett March 7, 2025 10:06

wbtoms marked this pull request as ready for review March 9, 2025 11:26

romanett reviewed Mar 10, 2025

View reviewed changes

wbtoms added 10 commits March 13, 2025 16:17

Implement dependency injection for application instance, server and n…

7b3e87b

…ode managers

Adjustments after rebase

76724a7

Revert use of CommunityToolkit.Diagnostics for Guard

0d4d3df

Adjust server applications

461cfd9

Set namespace of new classes/interfaces into the main project namespace

3532fa1

Use <inheritdoc/> where needed

e7c339f

Update package version for Microsoft.Extensions.DependencyInjection

8871598

Rework dispose of ServerInternalData

cb51153

Add test of server restart

f2e48fa

Improve DI configuration

c4b74f7

wbtoms force-pushed the IntroduceDependencyInjection branch from 6cce6c8 to c4b74f7 Compare March 13, 2025 16:42

romanett reviewed Mar 20, 2025

View reviewed changes

romanett added this to the 1.5.376 Maintenance Update milestone Apr 21, 2025

romanett removed this from the 1.5.376 Maintenance Update milestone May 6, 2025

marcschier marked this pull request as draft June 26, 2025 13:37

mregen requested a review from Copilot July 31, 2025 05:18

Copilot AI reviewed Jul 31, 2025

View reviewed changes

	var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize);
	var subscriptionIds = CommonTestWorkers.CreateSubscriptionForTransfer(serverTestServices, transferRequestHeader, testSet, kQueueSize, -1);

	m_mainNodeManagerFactory = mainNodeManagerFactory ?? throw new ArgumentNullException(nameof(mainNodeManagerFactory)); ;
	m_mainNodeManagerFactory = mainNodeManagerFactory ?? throw new ArgumentNullException(nameof(mainNodeManagerFactory));

	public void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);
	void SetSessionManager(SessionManager sessionManager, SubscriptionManager subscriptionManager);

Implement dependency injection for application instance, server and n… #3022

Are you sure you want to change the base?

Implement dependency injection for application instance, server and n… #3022

Uh oh!

Conversation

wbtoms commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Related Issues

Types of changes

Checklist

Further comments

Uh oh!

CLAassistant commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

romanett commented Mar 1, 2025

Uh oh!

azure-pipelines bot commented Mar 1, 2025

Uh oh!

romanett commented Mar 10, 2025

Uh oh!

azure-pipelines bot commented Mar 10, 2025

Uh oh!

Uh oh!

romanett Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

wbtoms Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

romanett Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

wbtoms Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

romanett left a comment

Choose a reason for hiding this comment

Uh oh!

romanett commented Jun 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

wbtoms commented Feb 28, 2025 •

edited

Loading

CLAassistant commented Feb 28, 2025 •

edited

Loading

codecov bot commented Feb 28, 2025 •

edited

Loading

wbtoms Mar 14, 2025 •

edited

Loading