Skip to content

[Types] Add lossless conversion between WoT documents and NodeSet2 - #4131

Merged
marcschier merged 348 commits into
marcschier/wot-01-core-typesfrom
marcschier/wot-03-converter
Aug 5, 2026
Merged

[Types] Add lossless conversion between WoT documents and NodeSet2#4131
marcschier merged 348 commits into
marcschier/wot-01-core-typesfrom
marcschier/wot-03-converter

Conversation

@marcschier

Copy link
Copy Markdown
Collaborator

Adds a dependency-light, AOT-safe lexical model for Thing Description and Thing Model documents to Opc.Ua.Types, together with lossless converters between WoT documents and NodeSet2 and canonical NodeSet comparison for round-trip checks.

This is PR 3 of a stacked split of #4093 into independently reviewable pieces. It is self-contained, targets master directly, and depends on no other PR in the stack.

The change is a pure library in Opc.Ua.Types with no server/client involvement and no network I/O of its own. Unknown JSON-LD members are preserved as digest-protected RFC 6901 residue entries, native NodeSet projection is emitted according to the preservation mode, and resolver contracts expose asynchronous bounded resolution with structured diagnostics.

This PR is still large (~8,000 lines). Suggested review passes:

  1. Lexical model and residue preservation.
  2. Converter and native projection.
  3. Resolver contracts and NodeSet comparison.

Copilot AI review requested due to automatic review settings July 30, 2026 17:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Adds a WoT lexical document model plus lossless conversion between WoT TD/TM JSON and OPC UA NodeSet2 (including preservation envelope, native projection fallback), along with bounded async resolver contracts and canonical NodeSet comparison utilities for round-trip verification.

Changes:

  • Introduces WoT conversion core (document model, diagnostics, vocabulary, resolver/bounds, converter options/catalog).
  • Adds canonical NodeSet comparison + round-trip reporting helpers.
  • Adds extensive NUnit test coverage for synthesis, preservation modes, resolver bounds/cycles, native projection, and comparison behavior.

Reviewed changes

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

Show a summary per file
File Description
tests/Opc.Ua.Types.Tests/Wot/WotTestData.cs Adds shared NodeSet fixtures + helpers for WoT conversion tests.
tests/Opc.Ua.Types.Tests/Wot/WotSynthesisTests.cs Validates WoT JSON synthesis into NodeSet nodes/references and determinism.
tests/Opc.Ua.Types.Tests/Wot/WotResolverAndBoundsTests.cs Covers resolver context limits, cycles, redirects, cancellation, and option projection.
tests/Opc.Ua.Types.Tests/Wot/WotResolverAdditionalTests.cs Adds additional resolver/options/context/result behavioral tests.
tests/Opc.Ua.Types.Tests/Wot/WotNodeSetConverterTests.cs Tests envelope roundtrip, determinism, residue preservation, and digest rejection.
tests/Opc.Ua.Types.Tests/Wot/WotNativeProjectionTests.cs Verifies native-only projection reconstruction + determinism and reference type details.
tests/Opc.Ua.Types.Tests/Wot/WotNativeProjectionErrorTests.cs Exercises native projection validation/errors and malformed extension handling.
tests/Opc.Ua.Types.Tests/Wot/WotNativeFirstRoundtripTests.cs Tests readable mapping completeness vs fallback behaviors + residue stability.
tests/Opc.Ua.Types.Tests/Wot/WotMappingValidationTests.cs Validates mapping rules/diagnostics for event types, references, naming, and type hints.
tests/Opc.Ua.Types.Tests/Wot/WotEnvelopeTests.cs Tests envelope integrity, digest behavior, conflict detection, and spec constraints.
tests/Opc.Ua.Types.Tests/Wot/WotDocumentTests.cs Tests lexical preservation, typed accessors, pointers, and canonical writer output.
tests/Opc.Ua.Types.Tests/Wot/WotDocumentKindTests.cs Tests kind inference, forms access, pointer guards, and size-depth parse limits.
tests/Opc.Ua.Types.Tests/Wot/WotConverterPreservationTests.cs Covers preservation modes, size limits, success flags, and envelope restore diagnostics.
tests/Opc.Ua.Types.Tests/Wot/WotBindingReviewTests.cs Validates binding review rules: eventType annotation, portable identity, typed links.
tests/Opc.Ua.Types.Tests/Schema/NodeSetComparerTests.cs Adds tests for NodeSet canonical compare and roundtrip reporting.
tests/Opc.Ua.Types.Tests/Schema/NodeSetComparerAdditionalTests.cs Adds additional comparer guard and diff-report tests, including BOM handling.
src/Opc.Ua.Types/Wot/WotVocabulary.cs Centralizes UA IDs/mappings used by WoT conversion (refs, rules, JSON type mapping).
src/Opc.Ua.Types/Wot/WotThingCatalog.cs Adds catalog to preserve stable generated NodeIds across referenced Things.
src/Opc.Ua.Types/Wot/WotResolver.cs Introduces resolver contracts, bounded options, null resolver, and resolution context.
src/Opc.Ua.Types/Wot/WotNodeSetConverterOptions.cs Adds converter resource limits + mapping to resolver options.
src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Implements main NodeSet<->WoT conversion paths (envelope/projection/synthesis/residue).
src/Opc.Ua.Types/Wot/WotDocument.cs Implements lossless WoT JSON wrapper with typed accessors + pointer and canonical writer.
src/Opc.Ua.Types/Wot/WotDiagnostics.cs Defines diagnostic codes/severity/location and conversion result container.
src/Opc.Ua.Types/Schema/NodeSetComparer.cs Adds canonicalized NodeSet comparison + roundtrip reporting utility.

Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotResolver.cs
Comment thread tests/Opc.Ua.Types.Tests/Wot/WotNodeSetConverterTests.cs
Comment thread tests/Opc.Ua.Types.Tests/Wot/WotNativeProjectionErrorTests.cs Outdated
@codecov

codecov Bot commented Jul 31, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 88.23529% with 432 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.05%. Comparing base (8a10139) to head (fc38861).
⚠️ Report is 5 commits behind head on master.

Files with missing lines Patch % Lines
src/Opc.Ua.Types/Wot/WotNodeSetConverter.WoT.cs 89.03% 63 Missing and 51 partials ⚠️
...rc/Opc.Ua.Types/Wot/WotNodeSetConverter.NodeSet.cs 83.99% 43 Missing and 54 partials ⚠️
src/Opc.Ua.Types/Wot/WotJsonResidue.cs 87.71% 44 Missing and 27 partials ⚠️
src/Opc.Ua.Types/Wot/WotNativeProjection.cs 92.49% 25 Missing and 34 partials ⚠️
src/Opc.Ua.Types/Schema/NodeSetComparer.cs 83.58% 15 Missing and 7 partials ⚠️
src/Opc.Ua.Types/Wot/WotDocument.cs 89.71% 15 Missing and 7 partials ⚠️
src/Opc.Ua.Types/Wot/WotVocabulary.cs 85.88% 8 Missing and 4 partials ⚠️
src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs 78.72% 7 Missing and 3 partials ⚠️
src/Opc.Ua.Types/Wot/WotResolver.cs 90.09% 4 Missing and 6 partials ⚠️
src/Opc.Ua.Types/Wot/WotDiagnostics.cs 81.25% 1 Missing and 5 partials ⚠️
... and 2 more
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4131      +/-   ##
==========================================
- Coverage   80.23%   80.05%   -0.19%     
==========================================
  Files        1515     1537      +22     
  Lines      209980   214309    +4329     
  Branches    36213    37040     +827     
==========================================
+ Hits       168479   171557    +3078     
- Misses      28867    29890    +1023     
- Partials    12634    12862     +228     
Files with missing lines Coverage Δ
src/Opc.Ua.Types/Wot/WotThingCatalog.cs 66.66% <66.66%> (ø)
src/Opc.Ua.Types/Wot/WotNodeSetConverterOptions.cs 86.48% <86.48%> (ø)
src/Opc.Ua.Types/Wot/WotDiagnostics.cs 81.25% <81.25%> (ø)
src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs 78.72% <78.72%> (ø)
src/Opc.Ua.Types/Wot/WotResolver.cs 90.09% <90.09%> (ø)
src/Opc.Ua.Types/Wot/WotVocabulary.cs 85.88% <85.88%> (ø)
src/Opc.Ua.Types/Schema/NodeSetComparer.cs 83.58% <83.58%> (ø)
src/Opc.Ua.Types/Wot/WotDocument.cs 89.71% <89.71%> (ø)
src/Opc.Ua.Types/Wot/WotNativeProjection.cs 92.49% <92.49%> (ø)
src/Opc.Ua.Types/Wot/WotJsonResidue.cs 87.71% <87.71%> (ø)
... and 2 more

... and 70 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.Mapping.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
Comment thread src/Opc.Ua.Types/Wot/WotNodeSetConverter.cs Outdated
…-wotcon-model

# Conflicts:
#	tests/Opc.Ua.SourceGeneration.Core.Tests/Schema/NodeSetToModelDesignTests.cs
#	tools/Opc.Ua.SourceGeneration.Core/Generators/FluentBuilderGenerator.cs
#	tools/Opc.Ua.SourceGeneration.Core/Generators/MethodDesignArgumentResolver.cs
#	tools/Opc.Ua.SourceGeneration.Core/Generators/ObjectTypeProxyGenerator.cs
#	tools/Opc.Ua.SourceGeneration.Core/Schema/ModelDesignValidator.cs
#	tools/Opc.Ua.SourceGeneration.Core/Schema/NodeSetToModelDesign.cs
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9e6a5abf-3299-4cd1-9855-010fedbf0ad8
…ransfer' into marcschier/wot-09-xregistry-client
@marcschier marcschier added the ready Ready to merge once CI Passes label Aug 5, 2026
…ion (#4156)

Adds the runnable WoT Connectivity samples and completes the
documentation. This is **PR 16 of a
stack** splitting #4093, and the last one.

## Samples

Three projects under `samples/WotCon/`:

* **FlatTagServer** — a plain OPC UA server exposing flat tags, used as
an aggregation source.
* **AggregationServer** — registers Thing Descriptions with the WoT
registry and materializes two
flat sources into a runtime-loaded DI/Machinery/Pumps Pump model. It
also ships a small in-memory
protocol binding, which is the worked example the binding contributor
guide walks through.
* **AggregationClient** — drives the aggregated model: commands,
`Refresh`, monitoring, and
  generation replacement.

## Documentation

* New `docs/WotBindings.md` — the bindings that ship today
(planner/executor architecture, bundled
vs separate packages, operation coverage, target mapping, lazy channels,
generation lifetime) plus
the contributor guide for adding your own, with diagnostics, tests,
packaging, TFM, trimming and
  NativeAOT guidance.
* Expanded `docs/WoTConnectivity.md` covering the registry,
dependency-closure materialization and
  runtime NodeSet projection.
* `docs/RuntimeNodeSets.md` gains the shadow-reload section and
`docs/XRegistry.md` the shared
byte-store section. Both document APIs introduced earlier in the stack;
they are collected here
  because this is the documentation PR.
* `docs/README.md` links the new pages.

## Solution registration

Registers the three samples and `Opc.Ua.WotCon.Samples.Tests` in
`UA.slnx` so CI actually builds
and runs them.

## Stack position

Sits on top of **#4154** (materialization) and additionally merges
**#4142** (registry client) and
**#4144** (protocol executors), because the samples exercise the whole
stack — `AggregationServer`
needs the OPC UA executor and the client sample needs the registry
client. Its diff therefore shows
their content until they land.

It also carries `WotRegistryProjectionLiveTests.cs`, which #4154
deliberately left out: those tests
need both the materialization runtime *and* the registry client, so this
is the first branch where
they compile.

## Validation

* All three samples build clean on every target framework.
* `Opc.Ua.WotCon.Tests`: **830 passed**, 0 failed (769 from #4154 plus
61 from the live projection
  tests).
* `Opc.Ua.WotCon.Samples.Tests`: 6 of 7 pass locally; the remaining one
fails with
`CryptographicException: The system cannot find the path specified`, a
known certificate-store
problem on this machine that was previously reproduced against a clean
baseline worktree and is
  not related to this change. CI will confirm.
* 0 warnings, 0 errors.

One fix was needed while bringing the sample across: its memory binding
called `ResolveCodec` with
the pre-`out WotPayloadDescriptor` signature. The API gained the payload
out-parameter and a
`bool` result during review of the binding PRs, so the sample now
follows the same
`if (!ResolveCodec(...)) return Unsupported(...)` pattern as the shipped
planners.

Integration PR: #4093.
…pace (#4154)

PR 14 of the stacked series splitting the large WoT Connectivity
integration PR #4093.

This PR adds the server-side materialization runtime that turns WoT
Thing Description resources from the xRegistry snapshot into OPC UA
address-space projections. The coordinator builds the dependency closure
for each resource, plans binding metadata, activates binding channels,
and publishes the resulting projection through the registry NodeManager
so refresh, retire, and reload operations remain observable and
deterministic.

Projection intentionally goes through the NodeManager lifecycle reload
API instead of mutating live nodes directly. That keeps complex type
reload, runtime NodeSet publication, shadow reload, immediate reload,
and retirement on the same lifecycle path as other dynamic server
address-space changes.

This branch has a triple dependency. It is based on #4146 (registry),
and additionally needs #4147 (lifecycle reload API) and #4128
(2-argument TryGetStructure). Both #4147 and #4128 are merged into this
branch, so this PR's diff will show their content until those
dependencies land.

Validation performed:
- dotnet build src\Opc.Ua.WotCon.Server\Opc.Ua.WotCon.Server.csproj -c
Release -f net10.0 -v:m
- dotnet build tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 -v:m
- dotnet test tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 --no-build
- dotnet build tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net48 -v:m
- dotnet test tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net48 --no-build
- dotnet build tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 -v:m
- dotnet test tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 --no-build (one known inherited
failure: LiveNodeManagerAddRefreshesTheClientNamespaceTable)
PR 15 of a stacked split of integration PR #4093 into independently
reviewable pieces.

This branch is stacked on #4139 (`marcschier/wot-10-wotcon-model`) and
additionally has #4128 (`marcschier/wot-01-core-types`) and #4130
(`marcschier/wot-09-xregistry-client`) merged in so this client slice
can build.

Those extra dependencies are intentional:
- Without #4130: `WotRegistryClient.cs:83` — `error CS1729:
'XRegistryClient' does not contain a constructor that takes 4
arguments`.
- Without #4128: `WotRegistryClient.cs:346,375` and
`WotRegistryResourceClient.cs:144` — `error CS1501: No overload for
method 'TryGetStructure' takes 2 arguments`.

The extra diff from #4128 and #4130 disappears once those PRs land.

This PR adds the WoT Connectivity registry client surface for browsing
and reading registry groups, resources and versions, uploading documents
through FileTransfer, invoking registry methods, and registering the
client through DI/builder helpers.
Adds the WoT Connectivity registry service and stores for Thing
Description and Thing Model documents.

This is PR 13 of the stacked split of integration PR #4093 and is
stacked on #4140 (`marcschier/wot-11-bindings-core`). The
materialization runtime that consumes this registry follows separately.

The registry has no dependency on the binding runtime or the NodeManager
lifecycle; the stacking is only because this change shares the WoT
Connectivity server project file with the preceding PRs.

Validation:
- `dotnet build src\Opc.Ua.WotCon.Server\Opc.Ua.WotCon.Server.csproj -c
Release -f net10.0 -v:m`
- `dotnet build tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test tests\Opc.Ua.WotCon.Tests\Opc.Ua.WotCon.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 --no-build -v:q`
- `dotnet build src\Opc.Ua.WotCon.Server\Opc.Ua.WotCon.Server.csproj -c
Release -v:m`
## Summary
- Adds the concrete WoT binding transport executors for HTTP, Modbus
TCP, OPC UA and MQTT.
- Includes executor/channel tests and in-process HTTP, Modbus, MQTT and
OPC UA harness coverage.
- Leaves CoAP, BACnet, PROFINET and LoRaWAN planner-only because this
stack split intentionally lands validation/planning before executable
transports.

## Stack context
This is PR 12 of the stacked split of integration PR #4093. It is
stacked on #4140, where the protocol-agnostic planner layer landed
separately, so this PR is limited to the concrete transport
implementations.

## Validation
- `dotnet build
tests\Opc.Ua.WotCon.Bindings.Tests\Opc.Ua.WotCon.Bindings.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test
tests\Opc.Ua.WotCon.Bindings.Tests\Opc.Ua.WotCon.Bindings.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 --no-build` (512 passed)
- `dotnet build src\Opc.Ua.WotCon.Bindings\Opc.Ua.WotCon.Bindings.csproj
-c Release -v:m`
- `dotnet build
src\Opc.Ua.WotCon.Bindings.Mqtt\Opc.Ua.WotCon.Bindings.Mqtt.csproj -c
Release -v:m`
## Summary

PR 11 of the stacked split for integration PR #4093. This adds the
protocol-agnostic core of `Opc.Ua.WotCon.Bindings`: binder, planner,
executor and channel-factory contracts; payload codec and credential
provider seams; the binding plan model; polling subscriptions for forms
without native observation; and DI/builder registration helpers.

This PR is stacked on #4139, which itself depends on #4132 and #4134.

## Scope

The included planners validate forms and produce binding plans without
transport I/O:

- HTTP planner and validation only; the concrete HTTP executor follows
in the next PR.
- MQTT planner and validation only; the separate MQTT executor package
follows in the next PR.
- Modbus TCP planner and shared Modbus type/limit definitions only; the
Modbus executor and TCP client follow in the next PR.
- OPC UA planner and validation only; the concrete OPC UA executor
follows in the next PR.
- CoAP, BACnet, PROFINET and LoRaWAN are planner/validation-only in this
split.

Keeping concrete transport executors out of this PR makes the
abstractions and planning layer reviewable without a network stack.

## Validation

- `dotnet build
tests\Opc.Ua.WotCon.Bindings.Tests\Opc.Ua.WotCon.Bindings.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test
tests\Opc.Ua.WotCon.Bindings.Tests\Opc.Ua.WotCon.Bindings.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 --no-build`
- `dotnet build src\Opc.Ua.WotCon.Bindings\Opc.Ua.WotCon.Bindings.csproj
-c Release -v:m`
This is PR 10 of the stacked split of integration PR #4093 into
independently reviewable pieces.

Stack/dependency shape:

- This branch is stacked on #4134 (`marcschier/wot-04-generator-wot`).
- It also requires #4132 (`marcschier/wot-02-sourcegen`), which is
merged into this branch so the model can build.

The #4132 dependency is functional, not cosmetic. Without #4132,
building the WoT Connectivity model on #4134 alone fails with duplicate
generated declarations, for example:

```text
CS0102: The type 'Methods' already contains a definition for 'CreateAssetMethodType'
```

That occurs because the combined WoT-Con NodeSet ships the 1.02
`CreateAssetMethodType` node explicitly; without #4132's
NodeSet-to-ModelDesign fix, the generator synthesizes a second
declaration with the same name.

Once #4132 and #4134 land, the extra diff from those dependencies
disappears and this PR reduces to the three WoT Connectivity model
files:

- `src\Opc.Ua.WotCon\Design\Opc.Ua.WotCon.NodeSet2.xml`
- `src\Opc.Ua.WotCon\Design\Opc.Ua.WotCon.NodeSet2.csv`
- `src\Opc.Ua.WotCon\Opc.Ua.WotCon.csproj`

The generated C# is produced from the pinned NodeSet2 at build time. I
verified it builds from clean after deleting the WotCon `bin`/`obj`, the
source-generation tool `bin`/`obj` directories, and shutting down dotnet
build servers.
This extracts the xRegistry client generalisation from #4093 as PR 9 of
the stacked split into independently reviewable pieces.

The change lets the xRegistry client base accept an explicit registry
root NodeId while preserving the existing well-known-root default.
GenericXRegistryClient exposes the same explicit-root path so callers
can drive registries whose root Object is discovered separately, and the
tests cover the supplied-root and fallback behavior across the lifecycle
helpers.

This PR is independent of the other stack PRs and contains no WoT
registry implementation or Opc.Ua.WotCon.* references. A later PR adds
the WoT registry client on top of this general xRegistry client surface.
…4150)

This is PR 7 of the stacked series splitting integration PR #4093,
stacked on #4147 (`marcschier/wot-05-lifecycle`).

This PR makes subscription transfer between sessions transactional:
subscriptions are prepared before any ownership move, publish-queue
transfer claims block stale source-session publishing, and rollback
restores monitored-item resend-data trigger state.

`ServerInternalData` also gains asynchronous disposal so the
asynchronously disposable subscription manager is shut down without
blocking, with sync and async dispose paths guarded so repeated disposal
is a no-op.

It also brings the transfer-focused coverage for subscription transfer,
publish-queue transfer claims, and `ServerInternalData`
async/double-disposal behavior.

The immediate monitored-item retirement mechanism present in #4093 is
deliberately excluded per maintainer decision. `IRetirableMonitoredItem`
and `INodeManagerMonitoredItemRetirementTracker` do not appear in this
PR.
## Summary

Adds PR 5 of the stack splitting #4093 into independently reviewable
pieces, targeting `master` directly.

This PR extends the NodeManager lifecycle with live shadow reload
support and RuntimeNodeSet lifecycle helpers. `ShadowReloadAsync` stages
a replacement generation and routes new service requests to it while
monitored items already owned by the retired generation continue there
until subscriptions drain.

`ImmediateReloadAsync` keeps the immediate policy but implements it on
the existing detach machinery at the maintainer's request: affected
non-durable monitored items are detached/marked deleted with
`IDetachableMonitoredItem`, queue `BadNodeIdUnknown`, and are not
migrated to the replacement generation.

The prior NodeManager generation is disposed before
`ImmediateReloadAsync` returns in the covered lifecycle path. The
bespoke permanent retirement-error path is intentionally removed, so
follow-up operations use the existing detached-item semantics rather
than a separate retirement state.

## Validation

- `dotnet build src\Opc.Ua.Server\Opc.Ua.Server.csproj -c Release -f
net10.0 -v:m`
- `dotnet build tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net10.0 --no-build` — 3914 passed, 9
skipped, 0 failed
- `dotnet build tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net48 -v:m`
- `dotnet test tests\Opc.Ua.Server.Tests\Opc.Ua.Server.Tests.csproj -c
Release -p:CustomTestTarget=net48 --no-build` — full run hit local
durable queue file-lock flake; the failed test passed in isolation. Full
run otherwise reported 3913 passed, 9 skipped, 1 failed.
…files (#4134)

## Summary
- Adds WoT Thing Description and Thing Model AdditionalFiles support to
Opc.Ua.SourceGeneration for .tm.json, .td.json, .tm.jsonld, .td.jsonld,
and explicitly opted-in .jsonld inputs.
- Converts WoT inputs to an in-memory UANodeSet and reuses the existing
NodeSet generation pipeline for constants, node states, and proxies.
- Reports parsing, conversion, and virtual path collision failures as
MODELGEN030 through MODELGEN034 diagnostics instead of generator
exceptions.

## Stack context
This is PR 4 of the stacked split of integration PR #4093. It is stacked
on #4131 (`marcschier/wot-03-converter`) and should be reviewed and
merged after that PR.

The source-generation entry-point project is included whole in this PR
because its final state is irreducibly WoT-coupled. The genuinely
generic generator work lives in the separate PR 2 branch.

## Notes
Roslyn source generators must run synchronously. This PR drives WoT
conversion through the converter's synchronous entry point and does not
use the asynchronous resolver contracts from generator code.

## Validation
- `dotnet build
tools\Opc.Ua.SourceGeneration\Opc.Ua.SourceGeneration.csproj -c Release
-v:m`
- `dotnet build
tests\Opc.Ua.SourceGeneration.Tests\Opc.Ua.SourceGeneration.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test
tests\Opc.Ua.SourceGeneration.Tests\Opc.Ua.SourceGeneration.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 --no-build`
- `dotnet build
tests\Opc.Ua.SourceGeneration.Tests\Opc.Ua.SourceGeneration.Tests.csproj
-c Release -p:CustomTestTarget=net48 -v:m`
- `dotnet test
tests\Opc.Ua.SourceGeneration.Tests\Opc.Ua.SourceGeneration.Tests.csproj
-c Release -p:CustomTestTarget=net48 --no-build`
…rated node state (#4132)

## Summary
- Improves NodeSet to ModelDesign conversion for combined and
multi-namespace NodeSets.
- Fixes generated method declarations, argument resolution, object type
proxies, fluent builders, generated node state, shared generation
helpers, and validation.
- Regenerates ISA95 NodeIds as generator output from these changes, not
as a hand edit.

## Stack context
This is PR 2 of a stacked split of integration PR #4093 into
independently reviewable pieces. This PR is independent of the other
stack PRs and contains no WoT content.

## Validation
- `dotnet build
tests\Opc.Ua.SourceGeneration.Core.Tests\Opc.Ua.SourceGeneration.Core.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 -v:m`
- `dotnet test
tests\Opc.Ua.SourceGeneration.Core.Tests\Opc.Ua.SourceGeneration.Core.Tests.csproj
-c Release -p:CustomTestTarget=net10.0 --no-build`
- `dotnet build
tests\Opc.Ua.SourceGeneration.Core.Tests\Opc.Ua.SourceGeneration.Core.Tests.csproj
-c Release -p:CustomTestTarget=net48 -v:m`
- `dotnet test
tests\Opc.Ua.SourceGeneration.Core.Tests\Opc.Ua.SourceGeneration.Core.Tests.csproj
-c Release -p:CustomTestTarget=net48 --no-build`
- `dotnet build src\Opc.Ua.ISA95\Opc.Ua.ISA95.csproj -c Release -f
net10.0 -v:m`
- Confirmed ISA95 build leaves
`src\Opc.Ua.ISA95\Design\Common\Opc.ISA95.NodeIds.csv` with no unstaged
regeneration diff.
@marcschier
marcschier merged commit f3178c3 into marcschier/wot-01-core-types Aug 5, 2026
marcschier added a commit that referenced this pull request Aug 5, 2026
…ation, Server and xRegistry work it builds on (#4128)

## Summary

Adds OPC UA WoT Connectivity 1.1 to the stack, together with the Types,
source generation, Server and xRegistry work it is built on. This branch
is the merge point for the fourteen-PR stack that replaced integration
PR #4093; every constituent PR was reviewed and approved separately and
is listed below.

414 files changed, +108,936 / -3,199. Roughly 46k added lines of product
code, 57k of tests, plus samples, tools and documentation.

## Types

- Complete `ExtensionObject` raw-body decoding for binary, XML and JSON
bodies by resolving the concrete type through the message context's
encodeable factory, and simplify the `Variant` structure helpers by
delegating to it (#4128).
- Add `IAtomicFileReplace` as an optional `IFileSystem` capability so
existing external implementations keep working, with atomic publish for
`LocalFileSystem` via `File.Replace`/`File.Move` and for
`VirtualFileSystem` by re-keying the in-memory entry (#4128).
- Add lossless conversion between WoT documents and NodeSet2
(`Opc.Ua.Wot.WotNodeSetConverter`). A byte-exact `uav:nodeSet` envelope
is preserved when requested, the structured `uav:nodes` projection is
used when the readable vocabulary is incomplete, and NodeSet2 is
otherwise synthesized from readable WoT terms. Unmapped JSON members
survive a round trip as pointer-addressed residue (#4131).

## Source generation

- Improve the NodeSet to ModelDesign conversion and the generated node
state (#4132).
- Generate OPC UA models directly from WoT Thing Description files
(#4134).

## Server

- Add live NodeManager shadow and immediate reload. A reload
materializes a new generation beside the active one and switches
atomically; the superseded generation is retired gracefully so existing
MonitoredItems keep being served until they drain, or immediately when
the caller asks for it. Includes the request admission and drain
machinery that lets an orderly shutdown wait for admitted requests
instead of tearing down underneath them (#4147).
- Make subscription transfer between sessions transactional, so a failed
transfer leaves neither session holding a partially moved subscription
(#4150).

## xRegistry

- Allow clients to use explicit registry roots rather than assuming a
well-known location (#4130).

## WoT Connectivity

- Add the WoT Connectivity 1.1 information model: a registry-first
revision layered on the abstract xRegistry base model, incorporating the
complete published OPC 10100-1 v1.02 surface as deprecated nodes in the
same namespace so existing 1.02 clients keep working (#4139).
- Add the protocol binding abstractions and planners that compile WoT
forms into executable plans (#4140).
- Add the HTTP, Modbus, OPC UA and MQTT binding executors (#4144).
- Add the registry and its stores, including document versioning,
validation, dependency resolution and refresh (#4146).
- Add the registry client (#4142).
- Materialize WoT Thing Descriptions into the server address space,
deriving types from Thing Models and instances from Thing Descriptions
(#4154).
- Restore the WoT asset registry bridge so the deprecated 1.02 asset
surface is backed by the registry (#4171).
- Add the WoT Connectivity samples and complete the documentation
(#4156), and restore the remaining coverage and docs (#4172).

## New projects

`src/Opc.Ua.WotCon.Bindings`, `src/Opc.Ua.WotCon.Bindings.Mqtt`,
`tests/Opc.Ua.WotCon.Bindings.Tests`,
`tests/Opc.Ua.WotCon.Samples.Tests`, and the `samples/WotCon`
AggregationServer, AggregationClient and FlatTagServer samples.

## Constituent pull requests

Merged into this branch top-down, each independently approved:

| PR | Title |
| --- | --- |
| #4128 | [Types] Complete ExtensionObject decoding and add an atomic
file replace capability |
| #4131 | [Types] Add lossless conversion between WoT documents and
NodeSet2 |
| #4132 | [SourceGeneration] Improve NodeSet to ModelDesign conversion
and generated node state |
| #4134 | [SourceGeneration] Generate OPC UA models from WoT Thing
Description files |
| #4147 | [Server] Add live NodeManager shadow and immediate reload |
| #4150 | [Server] Make subscription transfer between sessions
transactional |
| #4130 | [XRegistry] Allow clients to use explicit registry roots |
| #4139 | [WotCon] Add the WoT Connectivity 1.1 information model |
| #4140 | [WotCon] Add the WoT protocol binding abstractions and
planners |
| #4144 | [WotCon] Add the HTTP, Modbus, OPC UA and MQTT binding
executors |
| #4146 | [WotCon] Add the WoT Connectivity registry and its stores |
| #4142 | [WotCon] Add the WoT Connectivity registry client |
| #4154 | [WotCon] Materialize WoT Thing Descriptions into the server
address space |
| #4156 | [WotCon] Add the WoT Connectivity samples and complete the
documentation |
| #4171 | Restore WoT asset registry bridge |
| #4172 | Restore WoT coverage and docs |

Supersedes #4093.

## Follow-up

The WoT Connectivity and WoT Binding drafts have moved to 1.1-draft2
since this work was authored. Aligning with that revision - the removed
group vocabulary, the new projection/View construct, the remaining model
vocabulary terms and the two new portable-identity validation rules - is
tracked separately and will follow in its own pull request.

## Validation

Built for every target framework with zero warnings and zero errors, and
validated at the tip of the stack with `Opc.Ua.WotCon.Tests` at 999
passed / 0 failed and `Opc.Ua.Server.Tests` at 4024 passed / 0 failed.

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9e6a5abf-3299-4cd1-9855-010fedbf0ad8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready Ready to merge once CI Passes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants