Optimize reflection-based lookups using caches by marcschier · Pull Request #3179 · OPCFoundation/UA-.NETStandard

marcschier · 2025-08-26T17:59:41Z

Proposed changes

This PR optimizes reflection-based lookups throughout the OPC UA Core library by implementing caching mechanisms. The changes replace expensive reflection operations with pre-built dictionaries that are lazily initialized for better performance when repeatedly looking up TypeInfo objects, status codes, attributes, and security policies.

Key changes include:

Replaced direct TypeInfo constructor calls with cached factory methods
Added lookup dictionaries for status codes, attributes, and security policies
Introduced utility methods and overloaded constructors for better API usability

Related Issues

Fixes #

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 is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

codecov · 2025-08-26T18:01:11Z

Codecov Report

❌ Patch coverage is 52.98013% with 142 lines in your changes missing coverage. Please review.
✅ Project coverage is 57.70%. Comparing base (25ba2a2) to head (0166e0f).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
.../Opc.Ua.Core/Types/Constants/Attributes.Helpers.cs	8.00%	46 Missing ⚠️
...k/Opc.Ua.Core/Stack/Constants/DataTypes.Helpers.cs	0.00%	32 Missing ⚠️
....Ua.Core/Stack/Constants/ReferenceTypes.Helpers.cs	0.00%	29 Missing ⚠️
...Opc.Ua.Core/Types/Constants/StatusCodes.Helpers.cs	72.34%	13 Missing ⚠️
Stack/Opc.Ua.Core/Types/Utils/Utils.cs	31.25%	11 Missing ⚠️
Stack/Opc.Ua.Core/Types/Utils/TypeInfo.cs	89.55%	4 Missing and 3 partials ⚠️
...Server/Subscription/MonitoredItem/MonitoredItem.cs	0.00%	1 Missing ⚠️
...Opc.Ua.Core/Security/Constants/SecurityPolicies.cs	97.82%	0 Missing and 1 partial ⚠️
Stack/Opc.Ua.Core/Types/BuiltIn/StatusCode.cs	50.00%	1 Missing ⚠️
Stack/Opc.Ua.Core/Types/Encoders/BinaryDecoder.cs	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3179      +/-   ##
==========================================
+ Coverage   57.63%   57.70%   +0.06%     
==========================================
  Files         354      354              
  Lines       77908    78086     +178     
  Branches    13816    13817       +1     
==========================================
+ Hits        44903    45057     +154     
- Misses      28776    28810      +34     
+ Partials     4229     4219      -10

☔ 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.

Copilot

Pull Request Overview

This PR optimizes reflection-based lookups throughout the OPC UA Core library by implementing caching mechanisms. The changes replace expensive reflection operations with pre-built dictionaries that are lazily initialized for better performance when repeatedly looking up TypeInfo objects, status codes, attributes, and security policies.

Key changes include:

Replaced direct TypeInfo constructor calls with cached factory methods
Added lookup dictionaries for status codes, attributes, and security policies
Introduced utility methods and overloaded constructors for better API usability

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
TypeInfo.cs	Adds caching for scalar and array TypeInfo objects with factory methods
StatusCodes.Helpers.cs	Replaces reflection loops with cached dictionaries for status code lookups
Attributes.Helpers.cs	Implements cached attribute name/ID mappings
SecurityPolicies.cs	Adds cached security policy URI to name mappings
Various test and encoder files	Updates to use new cached TypeInfo factory methods
Utils.cs	Adds utility methods for UTF8 operations and array equality checks
Variant.cs	Adds new constructors and removes duplicate documentation
StatusCode.cs	Adds UTF8 symbolic ID lookup and removes redundant documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Co-authored-by: Copilot <[email protected]>

romanett

Looks like a good addition, no major concerns just a small fix in the SecurityPolicies needed eventually

romanett · 2025-08-27T04:03:11Z

+                foreach (FieldInfo field in fields)
+                {
+                    var policyUri = (string)field.GetValue(typeof(SecurityPolicies));
+                    if (field.Name == nameof(BaseUri) ||


the exclusion of BaseUri and Https was before explicit in the GetDisplayNames() Method, now it also applies to GetDisplayName() (probably makes sense), just wanted to point this out.

public static bool IsValidSecurityPolicyUri() should also use this efficient lookup (there it does not make sense to exclude BaseUri & Https)

GetUri() also should work for https amd BaseUri

So my understanding is this - baseuri should be excluded - because it is just a prefix and no valid uri. Https however is a valid Uri. But is it a valid "SecurityProfile"? Anyway, displaynames should include https, is that correct?

The link for https is not working, so I assume you are right in the assumption it is not a real "SecurityProfile" . For most of the methods it is removed anyway by the check IsPlatformSupportedName.

So I propose to remove https. It seems to be only relevant in the stack for loading an https server certificate.

sorry for the misleading comment, seems to be fully okay in the first implementation you had. I think https was added as an afterthought without really checking the implications

Optimize lookups using reflection using caches, Cleanup code.

54b59c5

marcschier changed the title ~~Optimize lookups using reflection using caches,~~ Optimize lookups using reflection using caches Aug 26, 2025

marcschier requested review from Copilot and romanett August 26, 2025 17:59

Copilot AI reviewed Aug 26, 2025

View reviewed changes

marcschier and others added 7 commits August 26, 2025 11:04

Update Stack/Opc.Ua.Core/Types/Constants/StatusCodes.Helpers.cs

63131f9

Co-authored-by: Copilot <[email protected]>

Update Stack/Opc.Ua.Core/Types/Constants/StatusCodes.Helpers.cs

2a7934c

Co-authored-by: Copilot <[email protected]>

Update Stack/Opc.Ua.Core/Types/Utils/TypeInfo.cs

a62e664

Co-authored-by: Copilot <[email protected]>

Update Stack/Opc.Ua.Core/Types/Utils/TypeInfo.cs

ac9a630

Co-authored-by: Copilot <[email protected]>

Update

294fa96

Merge

2650d04

Update

6d4ded7

romanett approved these changes Aug 27, 2025

View reviewed changes

marcschier added 7 commits August 27, 2025 10:45

Update

3372568

Merged

df0be5f

More lookups

7f0b119

Update

b704873

Update

dd041e8

Update

af1c787

Add single solution file

3d5f3be

romanett changed the title ~~Optimize lookups using reflection using caches~~ Optimize reflection-based lookups using caches Aug 28, 2025

Revert changes based on PR discussion

0166e0f

marcschier merged commit 520351c into master Aug 29, 2025
119 of 120 checks passed

marcschier deleted the logging branch August 29, 2025 01:39

Uh oh!

Conversation

marcschier commented Aug 26, 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!

codecov Bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

romanett Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

romanett Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

marcschier Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

romanett Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

romanett Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

marcschier commented Aug 26, 2025 •

edited

Loading

codecov Bot commented Aug 26, 2025 •

edited

Loading