Commit Graph

3 Commits

Author SHA1 Message Date
romanett 9b034f8291 Enable nullable reference types centrally; migrate all unset and annotations-only projects (#4700)
# Description

Nullable reference types are now enabled once, in `common.props`, and
every project in the repository builds warning-clean with them.

**Configuration**
- `<Nullable>enable</Nullable>` lives in `common.props`. All per-project
`<Nullable>` settings are removed: 178 project files (enable,
annotations, and the `disable` in the three Aot test projects).
- 419 per-file `#nullable enable`/`restore` directives and the 4
`#nullable disable` directives are removed.
- Kept on purpose:
- The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type
Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`,
`PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the
project setting in generated code, so the directive is required there.
- `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against
the 1.5.378 packages and does not import the repository props.
- `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now
describe the central setting.

**Migration** (the 43 unset and 13 annotations-only projects, roughly
10k diagnostics)
- **Production code: annotated at the declarations.** Covers
`tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the
LDS sample.
- Members, parameters and returns are nullable where null actually
flows.
- Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`,
`IsMethodTypeDesign`).
- `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take
`params object?[]`. `Template.AddReplacement` takes `string?` (rendering
already skips null replacements).
- `IRegisteredServerStore.RegisterAsync` returns
`Task<RegistrationEntry?>`: it returns null when a registration is
removed.
- Dereferences backed by an invariant (for example, the validated model)
use `!`, so runtime behaviour is unchanged.
- **Behavioural changes in production code** (small, deliberate):
- `NodeSetToModelDesign` throws `InvalidOperationException` when the
file is not a NodeSet. Before, it threw a NullReferenceException on the
next line.
- `ModelDesignValidator` starts its lookup tables empty instead of null.
A redundant `if (m_nodes == null) return;` guard is gone.
- **Test code: minimal annotations.**
  - `?` on values that can be null, `!` where the test asserts non-null.
  - `= null!` for fixture members assigned in SetUp.
- `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the
`IEncodeable` constraint.
- A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`)
folded into the adjacent `IsNull`/`Count` checks.

**Notes for reviewers**
- The diff is large (~1,500 files) but almost entirely mechanical: `?`,
`!` and directive removal. The non-annotation changes are listed above.
- Known follow-up, not done here:
`IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay
non-nullable even though the validator returns null before it loads a
dictionary. Making them nullable would ripple through every generator
call site.

## Related Issues

- Fixes #4439

## Checklist

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

The "no new warnings" box covers net10.0 and net48: full non-incremental
builds of `UA.slnx`, `tools/SourceGeneration.slnx`,
`tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0
warnings and 0 errors under the repository's warnings-as-errors
settings. net9.0 and net8.0 also had no nullable diagnostics, but they
were not rebuilt after the final fixes. Tests have not been run locally
yet.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 08:48:13 +02:00
Copilot f95d65754d Register mandatory opc.tcp transport in AddOpcUa (make AddOpcTcpTransport optional) (#4074)
# Description

`AddOpcUa()` did not register an `ITransportBindingRegistry`. The client
resolves it with `GetRequiredService(...)`, so a client built with
`AddOpcUa().AddClient(...)` threw during managed-session creation unless
`AddOpcTcpTransport()` was also called. (Servers tolerated a missing
registry via `ServerBase`'s lazy `WithDefaultTcp()` fallback, which is
why `MinimalBoilerServer` worked but `MinimalClient` did not.)

This change makes the mandatory `opc.tcp` transport always available
while keeping it overridable and removable, then reverts the sample
workaround.

## Changes

- **`AddOpcUa()` seeds the mandatory transport.**
`AddTransportBindingRegistry()` now seeds the registry with the
raw-socket `opc.tcp` secure-channel listener and tcp connection channel
factories **before** running the registered
`ITransportBindingConfigurator`s, and `AddOpcUa()` calls it.
`AddOpcTcpTransport()` is now optional (kept for backward
compatibility).
- **Overridable.** Because the seed runs before configurators,
`AddKestrelOpcTcpTransport()` / `AddHttpsTransport()` /
`AddWssTransport()` / `AddCustomTransport<,>()` still override the
seeded defaults last-writer-wins per URI scheme — now without needing
`AddOpcTcpTransport()` first.
- **Removable.** Added `RemoveListenerFactory(scheme)` /
`RemoveChannelFactory(scheme)` to `ITransportBindingRegistry` (+
`DefaultTransportBindingRegistry`) so an implementer can unregister the
seeded defaults from a plain `ITransportBindingConfigurator` — no fluent
API required.
- **Sample.** Reverted the `MinimalClient` `.AddOpcTcpTransport()`
workaround; it now connects with just `.AddOpcUa().AddClient(...)`.
- Small note in `docs/Transports.md` that `AddOpcTcpTransport()` is
optional.

## Tests / validation

- New/updated unit tests in `TransportBindingRegistryTests`:
mandatory-`opc.tcp`-by-default,
override-default-without-`AddOpcTcpTransport`,
implementer-can-unregister-default, and `Remove*` unit tests; updated
`ParallelServiceProvidersHaveIndependentRegistries` for the seeded
default.
- Client DI regression test in `ClientDiFluentApiTests`
(`AddOpcUa().AddClient(...)` resolves the registry + channel manager
without an explicit tcp transport).
- Updated the `SpyTransportBindingRegistry` test double for the two new
interface members.
- **End-to-end:** started `MinimalBoilerServer` and ran `MinimalClient
--auto-accept` → discovered a `SignAndEncrypt` / `Basic256Sha256`
endpoint, connected, browsed the Objects folder, read
`ServerStatus.CurrentTime`, and created a subscription (exit code 0)
with no `AddOpcTcpTransport()`.
- **Green locally:** `Opc.Ua.Core.Tests` (4123 passed),
`Opc.Ua.Client.Tests` (1962 passed), `Opc.Ua.Server.Tests` Hosting (141
passed) on **net10.0**; transport + client-DI tests on **net48**;
`Opc.Ua.Core` builds with 0 warnings.

## Related Issues

Tracked by the linked issue.

## Checklist

- [ ] 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.
- [x] I have addressed **all** PR feedback received.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Marc Schier <marcschier@hotmail.com>
Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
2026-07-23 07:26:19 +02:00
Marc Schier 7cec2d614d Move repository files to the consolidated layout 2026-07-16 06:25:54 +02:00