mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-28 22:55:49 +08:00
02fb72e2d3
# Description
`NodeSetToModelDesign.ImportNode` only stored Numeric and String NodeId
identifiers. Guid and Opaque identifiers (both valid per OPC 10000-3
5.2.2) fell through to an `Information` log line, so the node was
registered in `NodesByQName`/`NodesById` with no identifier at all and
code generation continued against a node whose identity had been
discarded.
The `ModelDesign` schema has no representation for Guid/Opaque
identifiers (`NodeDesign` exposes only `NumericId`/`StringId`), so the
import now fails loudly instead of emitting output that looks correct.
- **Importer**: the fall-through branches in `ImportNode` are replaced
with an `InvalidDataException` naming the NodeId, browse name and
identifier type. This matches the existing unsupported-input handling in
the file and surfaces through `ModelCompilation` as a generator
diagnostic.
- **Logger removal**: `m_logger` had no remaining use in
`NodeSetToModelDesign` and was removed along with its
`Microsoft.Extensions.Logging` import.
- **Tests**: `ImportUnsupportedNodeIdTypeThrowsInvalidDataException`
covers Guid, empty Guid and Opaque identifiers via an in-memory NodeSet.
- **Docs**: the source generator readme states the NodeSet2 identifier
restriction.
```csharp
else
{
// The model design can only carry numeric and string identifiers.
// Guid and Opaque identifiers (OPC 10000-3 5.2.2) would be dropped
// and code would be generated for a node without any identity, so
// the import fails instead of silently producing wrong output.
throw new InvalidDataException(
$"NodeId ({input.NodeId}) of node '{input.BrowseName}' uses the " +
$"{nodeId.IdType} identifier type which is not supported by the model " +
"design. Only Numeric and String identifiers can be imported.");
}
```
Note on behaviour: a null/unspecified NodeId parses as a Numeric
identifier (`i=0`) and is still handled by the numeric branch, so the
removed `IsNull` branch was only ever reachable for an empty Guid or
Opaque identifier, which is now reported as unsupported.
## Related Issues
## Checklist
_Put an `x` in the boxes that apply. You can complete these step by step
after opening the PR._
- [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.
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [ ] 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.
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes #4504
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: marcschier <11168470+marcschier@users.noreply.github.com>
Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
260 lines
18 KiB
C#
260 lines
18 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
|
|
{
|
|
internal static class Tokens
|
|
{
|
|
public static string AdditionalNamespaceUris => nameof(AdditionalNamespaceUris);
|
|
public static string ArrayDimensions => nameof(ArrayDimensions);
|
|
public static string BaseClassName => nameof(BaseClassName);
|
|
public static string BaseInterfaces => nameof(BaseInterfaces);
|
|
public static string BaseType => nameof(BaseType);
|
|
public static string BaseTypeNamespacePrefix => nameof(BaseTypeNamespacePrefix);
|
|
public static string BaseTypeNamespaceUri => nameof(BaseTypeNamespaceUri);
|
|
public static string BinaryEncodingId => nameof(BinaryEncodingId);
|
|
public static string BrowseName => nameof(BrowseName);
|
|
public static string BrowseNameLiteral => nameof(BrowseNameLiteral);
|
|
public static string BrowseNameNamespacePrefix => nameof(BrowseNameNamespacePrefix);
|
|
public static string BrowseNameNamespaceUri => nameof(BrowseNameNamespaceUri);
|
|
public static string BrowseNameSymbol => nameof(BrowseNameSymbol);
|
|
public static string SymbolicNameSymbol => nameof(SymbolicNameSymbol);
|
|
public static string BuiltInTypes => nameof(BuiltInTypes);
|
|
public static string ChildDataType => nameof(ChildDataType);
|
|
public static string ValueWrite => nameof(ValueWrite);
|
|
public static string ValueComparison => nameof(ValueComparison);
|
|
public static string ChildName => nameof(ChildName);
|
|
public static string ChildBrowseName => nameof(ChildBrowseName);
|
|
public static string ChildBrowseNameLiteral => nameof(ChildBrowseNameLiteral);
|
|
public static string ChildPath => nameof(ChildPath);
|
|
public static string ClassName => nameof(ClassName);
|
|
public static string ClassFactory => nameof(ClassFactory);
|
|
public static string ClientApi => nameof(ClientApi);
|
|
public static string ClientMethod => nameof(ClientMethod);
|
|
public static string CodeName => nameof(CodeName);
|
|
public static string CollectionType => nameof(CollectionType);
|
|
public static string DataType => nameof(DataType);
|
|
public static string StructureType => nameof(StructureType);
|
|
public static string FirstExplicitFieldIndex => nameof(FirstExplicitFieldIndex);
|
|
public static string DataTypeNamespacePrefix => nameof(DataTypeNamespacePrefix);
|
|
public static string DataTypeNamespaceUri => nameof(DataTypeNamespaceUri);
|
|
public static string DefaultValue => nameof(DefaultValue);
|
|
public static string Description => nameof(Description);
|
|
public static string DictionaryUri => nameof(DictionaryUri);
|
|
public static string Documentation => nameof(Documentation);
|
|
public static string EmitDefaultValue => nameof(EmitDefaultValue);
|
|
public static string EncodingMaskModifier => nameof(EncodingMaskModifier);
|
|
public static string EncodingMaskFieldNamesModifier =>
|
|
nameof(EncodingMaskFieldNamesModifier);
|
|
public static string EncodingMaskEncode => nameof(EncodingMaskEncode);
|
|
public static string EncodingMaskDecode => nameof(EncodingMaskDecode);
|
|
public static string EnumerationName => nameof(EnumerationName);
|
|
public static string ElementNamespaceOverride => nameof(ElementNamespaceOverride);
|
|
public static string EventNotifier => nameof(EventNotifier);
|
|
public static string FieldIndex => nameof(FieldIndex);
|
|
public static string ExtraInterfaces => nameof(ExtraInterfaces);
|
|
public static string FieldName => nameof(FieldName);
|
|
public static string ListOfChildOperations => nameof(ListOfChildOperations);
|
|
public static string Historizing => nameof(Historizing);
|
|
public static string Identifier => nameof(Identifier);
|
|
public static string IdType => nameof(IdType);
|
|
public static string IdModifier => nameof(IdModifier);
|
|
public static string Imports => nameof(Imports);
|
|
public static string InitializeOptionalChildren => nameof(InitializeOptionalChildren);
|
|
public static string InvokeServiceAsync => nameof(InvokeServiceAsync);
|
|
public static string Purpose => nameof(Purpose);
|
|
public static string IsAbstract => nameof(IsAbstract);
|
|
public static string IsOptionSet => nameof(IsOptionSet);
|
|
public static string IsRequired => nameof(IsRequired);
|
|
public static string LengthInBits => nameof(LengthInBits);
|
|
public static string ListOfBrowseNames => nameof(ListOfBrowseNames);
|
|
public static string ListOfChildInitializers => nameof(ListOfChildInitializers);
|
|
public static string ListOfChildMethods => nameof(ListOfChildMethods);
|
|
public static string ListOfClonedFields => nameof(ListOfClonedFields);
|
|
public static string ListOfAppendStringFields => nameof(ListOfAppendStringFields);
|
|
public static string ListOfComparedFields => nameof(ListOfComparedFields);
|
|
public static string ListOfDecodedFields => nameof(ListOfDecodedFields);
|
|
public static string ListOfEncodedFields => nameof(ListOfEncodedFields);
|
|
public static string ListOfEncodingMaskFields => nameof(ListOfEncodingMaskFields);
|
|
public static string ListOfFieldInitializers => nameof(ListOfFieldInitializers);
|
|
public static string ListOfFields => nameof(ListOfFields);
|
|
public static string ListOfSwitchFieldNames => nameof(ListOfSwitchFieldNames);
|
|
public static string ListOfEncodingMaskFieldNames => nameof(ListOfEncodingMaskFieldNames);
|
|
public static string ListOfFindChildCase => nameof(ListOfFindChildCase);
|
|
public static string ListOfFindChildren => nameof(ListOfFindChildren);
|
|
public static string ListOfIdentifiers => nameof(ListOfIdentifiers);
|
|
public static string ListOfIdentifersToNames => nameof(ListOfIdentifersToNames);
|
|
public static string ListOfNamesToIdentifiers => nameof(ListOfNamesToIdentifiers);
|
|
public static string ListOfImports => nameof(ListOfImports);
|
|
public static string ListOfInputArguments => nameof(ListOfInputArguments);
|
|
public static string ListOfNamespaceUris => nameof(ListOfNamespaceUris);
|
|
public static string ListOfNodeIds => nameof(ListOfNodeIds);
|
|
public static string ListOfOutputArguments => nameof(ListOfOutputArguments);
|
|
public static string ListOfOutputArgumentsFromResult => nameof(ListOfOutputArgumentsFromResult);
|
|
public static string ListOfOutputDeclarations => nameof(ListOfOutputDeclarations);
|
|
public static string ListOfProperties => nameof(ListOfProperties);
|
|
public static string ListOfNonMandatoryChildren => nameof(ListOfNonMandatoryChildren);
|
|
public static string ListOfRemoveChild => nameof(ListOfRemoveChild);
|
|
public static string ListOfChildCopies => nameof(ListOfChildCopies);
|
|
public static string ListOfChildHashes => nameof(ListOfChildHashes);
|
|
public static string ListOfEqualityComparers => nameof(ListOfEqualityComparers);
|
|
public static string ListOfCreateOrReplaceChild => nameof(ListOfCreateOrReplaceChild);
|
|
public static string ListOfResultProperties => nameof(ListOfResultProperties);
|
|
public static string ListOfSwitchFields => nameof(ListOfSwitchFields);
|
|
public static string ListOfTypes => nameof(ListOfTypes);
|
|
public static string ListOfTypeActivators => nameof(ListOfTypeActivators);
|
|
public static string ListOfDataTypeDefinitions => nameof(ListOfDataTypeDefinitions);
|
|
public static string DataTypeDefinitionsClass => nameof(DataTypeDefinitionsClass);
|
|
public static string ListOfUpdateChildrenChangeMasks => nameof(ListOfUpdateChildrenChangeMasks);
|
|
public static string ListOfValues => nameof(ListOfValues);
|
|
public static string ListOfActivatorRegistrations => nameof(ListOfActivatorRegistrations);
|
|
public static string ListOfChildren => nameof(ListOfChildren);
|
|
public static string MethodList => nameof(MethodList);
|
|
public static string Name => nameof(Name);
|
|
public static string IsOptional => nameof(IsOptional);
|
|
public static string Namespace => nameof(Namespace);
|
|
public static string NamespacePrefix => nameof(NamespacePrefix);
|
|
public static string NamespaceUri => nameof(NamespaceUri);
|
|
public static string NodeManagerClassName => nameof(NodeManagerClassName);
|
|
public static string NodeManagerDefaultConstructor => nameof(NodeManagerDefaultConstructor);
|
|
public static string NodeManagerFactoryClassName => nameof(NodeManagerFactoryClassName);
|
|
public static string NodeSetImportFactoryProviderClassName =>
|
|
nameof(NodeSetImportFactoryProviderClassName);
|
|
public static string Nillable => nameof(Nillable);
|
|
public static string NodeClass => nameof(NodeClass);
|
|
public static string OnCallAsyncDeclaration => nameof(OnCallAsyncDeclaration);
|
|
public static string OnCallAsyncImplementation => nameof(OnCallAsyncImplementation);
|
|
public static string OnCallDeclaration => nameof(OnCallDeclaration);
|
|
public static string OnCallImplementation => nameof(OnCallImplementation);
|
|
public static string Prefix => nameof(Prefix);
|
|
public static string PropertyName => nameof(PropertyName);
|
|
public static string OwnerClassName => nameof(OwnerClassName);
|
|
public static string RequestParameters => nameof(RequestParameters);
|
|
public static string ResponseParameters => nameof(ResponseParameters);
|
|
public static string ServerApi => nameof(ServerApi);
|
|
public static string ServerStubs => nameof(ServerStubs);
|
|
public static string ServiceSet => nameof(ServiceSet);
|
|
public static string ServiceSets => nameof(ServiceSets);
|
|
public static string SymbolicId => nameof(SymbolicId);
|
|
public static string SymbolicName => nameof(SymbolicName);
|
|
public static string TypedVariableType => nameof(TypedVariableType);
|
|
public static string TypeName => nameof(TypeName);
|
|
public static string ValueRank => nameof(ValueRank);
|
|
public static string VariableTypeValue => nameof(VariableTypeValue);
|
|
public static string Version => nameof(Version);
|
|
public static string Tool => nameof(Tool);
|
|
public static string XmlEncodingId => nameof(XmlEncodingId);
|
|
public static string VariantFrom => nameof(VariantFrom);
|
|
public static string VariantTryGet => nameof(VariantTryGet);
|
|
public static string XmlIdentifier => nameof(XmlIdentifier);
|
|
public static string XmlNamespaceUri => nameof(XmlNamespaceUri);
|
|
public static string XmlnsS0ListOfNamespaces => nameof(XmlnsS0ListOfNamespaces);
|
|
public static string TypeList => nameof(TypeList);
|
|
public static string BasicType => nameof(BasicType);
|
|
public static string Flags => nameof(Flags);
|
|
public static string AddKnownType => nameof(AddKnownType);
|
|
public static string ModelUri => nameof(ModelUri);
|
|
public static string TargetPublicationDate => nameof(TargetPublicationDate);
|
|
public static string TargetVersion => nameof(TargetVersion);
|
|
public static string BaseT => nameof(BaseT);
|
|
public static string XsRestrictionBaseType => nameof(XsRestrictionBaseType);
|
|
public static string AccessorSymbol => nameof(AccessorSymbol);
|
|
|
|
public static string ServerMethodAsync => nameof(ServerMethodAsync);
|
|
public static string ClientMethodAsync => nameof(ClientMethodAsync);
|
|
public static string ClientMethodSync => nameof(ClientMethodSync);
|
|
public static string ClientMethodBegin => nameof(ClientMethodBegin);
|
|
public static string ClientMethodEnd => nameof(ClientMethodEnd);
|
|
public static string CodeHeader => nameof(CodeHeader);
|
|
public static string XmlHeader => nameof(XmlHeader);
|
|
public static string ResourceName => nameof(ResourceName);
|
|
public static string Resource => nameof(Resource);
|
|
public static string ListOfResourceGroups => nameof(ListOfResourceGroups);
|
|
public static string ListOfResourceDeclarations => nameof(ListOfResourceDeclarations);
|
|
public static string ListOfModelDependencies => nameof(ListOfModelDependencies);
|
|
public static string ModelVersion => nameof(ModelVersion);
|
|
public static string ModelPublicationDate => nameof(ModelPublicationDate);
|
|
public static string ModelName => nameof(ModelName);
|
|
public static string ModelPayload => nameof(ModelPayload);
|
|
public static string AccessModifier => nameof(AccessModifier);
|
|
public static string IdentifierReflection => nameof(IdentifierReflection);
|
|
public static string ListOfNodeStateInitializers => nameof(ListOfNodeStateInitializers);
|
|
public static string ListOfNodeStateTypeFactories => nameof(ListOfNodeStateTypeFactories);
|
|
public static string ListOfNodeStateInstanceFactories => nameof(ListOfNodeStateInstanceFactories);
|
|
public static string ListOfChildNodeStates => nameof(ListOfChildNodeStates);
|
|
public static string ListOfOptionalChildNodeStates => nameof(ListOfOptionalChildNodeStates);
|
|
public static string ListOfReferences => nameof(ListOfReferences);
|
|
public static string NodeIdConstant => nameof(NodeIdConstant);
|
|
|
|
public static string EventFilterParameters => nameof(EventFilterParameters);
|
|
|
|
public static string EventFilterParameterDocumentation =>
|
|
nameof(EventFilterParameterDocumentation);
|
|
|
|
public static string EventTypeId => nameof(EventTypeId);
|
|
public static string InstanceNodeIdOverride => nameof(InstanceNodeIdOverride);
|
|
public static string ListOfInstanceNodeIdBranches => nameof(ListOfInstanceNodeIdBranches);
|
|
public static string ParentNodeIdConstant => nameof(ParentNodeIdConstant);
|
|
public static string IfOrElseIf => nameof(IfOrElseIf);
|
|
public static string SuperTypeId => nameof(SuperTypeId);
|
|
public static string TypeDefinitionId => nameof(TypeDefinitionId);
|
|
public static string ReferenceTypeId => nameof(ReferenceTypeId);
|
|
public static string ModellingRuleId => nameof(ModellingRuleId);
|
|
public static string StateClassName => nameof(StateClassName);
|
|
public static string StateClassFactory => nameof(StateClassFactory);
|
|
public static string DisplayName => nameof(DisplayName);
|
|
public static string DataTypeDefinition => nameof(DataTypeDefinition);
|
|
public static string DescriptionValue => nameof(DescriptionValue);
|
|
public static string ValueCode => nameof(ValueCode);
|
|
public static string DataTypeIdConstant => nameof(DataTypeIdConstant);
|
|
public static string InverseNameValue => nameof(InverseNameValue);
|
|
public static string SymmetricValue => nameof(SymmetricValue);
|
|
public static string ReleaseStatusValue => nameof(ReleaseStatusValue);
|
|
public static string CategoriesValue => nameof(CategoriesValue);
|
|
public static string SpecificationValue => nameof(SpecificationValue);
|
|
public static string WriteMaskValue => nameof(WriteMaskValue);
|
|
public static string UserWriteMaskValue => nameof(UserWriteMaskValue);
|
|
public static string NumericIdValue => nameof(NumericIdValue);
|
|
public static string AccessRestrictionsValue => nameof(AccessRestrictionsValue);
|
|
public static string ListOfRolePermissions => nameof(ListOfRolePermissions);
|
|
public static string RoleIdConstant => nameof(RoleIdConstant);
|
|
public static string PermissionsValue => nameof(PermissionsValue);
|
|
public static string ContainsNoLoopsValue => nameof(ContainsNoLoopsValue);
|
|
public static string ExecutableValue => nameof(ExecutableValue);
|
|
public static string MethodDeclarationId => nameof(MethodDeclarationId);
|
|
public static string MinimumSamplingIntervalValue => nameof(MinimumSamplingIntervalValue);
|
|
public static string HistorizingValue => nameof(HistorizingValue);
|
|
public static string AccessLevelValue => nameof(AccessLevelValue);
|
|
public static string UserAccessLevelValue => nameof(UserAccessLevelValue);
|
|
public static string ListOfInitOnlyBackingFields => nameof(ListOfInitOnlyBackingFields);
|
|
public static string ListOfPooledExtensions => nameof(ListOfPooledExtensions);
|
|
public static string ListOfFieldResets => nameof(ListOfFieldResets);
|
|
}
|
|
}
|