Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better NodeId/ExpandedNodeId built in types handling #2230

Merged
merged 8 commits into from
Jul 28, 2023
Merged

Better NodeId/ExpandedNodeId built in types handling #2230

merged 8 commits into from
Jul 28, 2023

Conversation

mregen
Copy link
Contributor

@mregen mregen commented Jul 21, 2023

Proposed changes

  • A NodeId string can be assigned to a NodeId and is automatically parsed. However, if the string contains a "nsu=" it is considered a string type NodeId instead of decoding the namespaceUri. To avoid this error in the code an ArgumentException is thrown to uncover these coding errors. Such a variable needs to be an ExpandedNodeId to be decoded correctly.
  • Breaking change: To reduce coding errors the user group decided to throw also on a constructor call which does not contain a nodeid type prefix. e.g. new NodeId("Testnode"). If somebody wants a string NodeId in Namespace 0 then call the constructor new NodeId("TestNode", 0)
  • Implement IEquatable/IEquatable
  • Tests to ensure .Distinct treats all Null NodeIds as identical.
  • Unit tests for constructor behavior.

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

@mregen mregen marked this pull request as ready for review July 24, 2023 07:23
@mregen mregen linked an issue Jul 24, 2023 that may be closed by this pull request
5 tasks
@mregen
Copy link
Contributor Author

mregen commented Jul 24, 2023

May be related: #2168

@mregen
Copy link
Contributor Author

mregen commented Jul 27, 2023

The NodeId parser throws ServiceResultException on error, should it be rather ArgumentException?

Copy link
Contributor Author

@mregen mregen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feedback from code review in biweekly meeting

Stack/Opc.Ua.Core/Types/BuiltIn/NodeId.cs Outdated Show resolved Hide resolved
Stack/Opc.Ua.Core/Types/BuiltIn/NodeId.cs Show resolved Hide resolved
Stack/Opc.Ua.Core/Types/BuiltIn/NodeId.cs Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jul 27, 2023

Codecov Report

Merging #2230 (f62e1ed) into master (04cd9bc) will increase coverage by 0.19%.
The diff coverage is 63.94%.

@@            Coverage Diff             @@
##           master    #2230      +/-   ##
==========================================
+ Coverage   58.29%   58.49%   +0.19%     
==========================================
  Files         325      326       +1     
  Lines       62254    62292      +38     
==========================================
+ Hits        36292    36438     +146     
+ Misses      25962    25854     -108     
Files Changed Coverage Δ
...tack/Opc.Ua.Core/Types/BuiltIn/NodeIdDictionary.cs 56.44% <56.44%> (ø)
Stack/Opc.Ua.Core/Types/BuiltIn/ExpandedNodeId.cs 74.07% <83.33%> (+6.24%) ⬆️
Stack/Opc.Ua.Core/Types/BuiltIn/NodeId.cs 81.00% <95.00%> (+12.86%) ⬆️

... and 17 files with indirect coverage changes

@mregen mregen added this to the 1.4.372 feature update milestone Jul 27, 2023
@mregen mregen merged commit 1f17aad into master Jul 28, 2023
72 checks passed
@mregen mregen deleted the nodeids branch July 28, 2023 12:38
TimJoehnk pushed a commit to TimJoehnk/UA-.NETStandard that referenced this pull request Aug 4, 2023
)

- A NodeId string can be assigned to a NodeId and is automatically parsed. However, if the string contains a "nsu=" it is considered a string type NodeId instead of decoding the namespaceUri. To avoid this error in the code an `ArgumentException` is thrown to uncover these coding errors. Such a variable needs to be an ExpandedNodeId to be decoded correctly.
- Breaking change: To reduce coding errors the user group decided to throw also on a constructor call which does not contain a nodeid type prefix and namespace index. e.g. `new NodeId("Testnode")`. If somebody wants a string NodeId in Namespace 0 then call the constructor `new NodeId("TestNode", 0)`
- Implement IEquatable<NodeId>/IEquatable<ExpandedNodeId>
- Tests to ensure .Distinct treats all Null NodeIds as identical.
- Unit tests for constructor behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Opc.Ua.Client.NodeCache Find Can not Work
2 participants