Files
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

206 lines
8.8 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/
* ======================================================================*/
using System;
using System.CommandLine;
using System.Diagnostics;
using System.Globalization;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Opc.Ua;
using Opc.Ua.Configuration;
using Serilog;
using Serilog.Events;
namespace Opc.Ua.Lds.Server.Console
{
/// <summary>
/// Console host for the OPC UA Local Discovery Server (LDS / LDS-ME).
/// </summary>
public static class Program
{
private const string ApplicationName = "ConsoleLdsServer";
private const string ConfigSectionName = "Lds.Server";
public static Task<int> Main(string[] args)
{
System.Console.WriteLine(".NET OPC UA Local Discovery Server");
System.Console.WriteLine(
"OPC UA library: {0} @ {1} -- {2}",
Utils.GetAssemblyBuildNumber(),
Utils.GetAssemblyTimestamp().ToString("G", CultureInfo.InvariantCulture),
Utils.GetAssemblySoftwareVersion());
var consoleOption = new Option<bool>("--console", "-c") { Description = "log to console" };
var autoAcceptOption = new Option<bool>("--autoaccept", "-a") { Description = "auto accept untrusted certificates (testing only)" };
var noMdnsOption = new Option<bool>("--no-mdns") { Description = "disable mDNS multicast (LDS-ME) advertisement" };
var loopbackMdnsOption = new Option<bool>("--mdns-loopback") { Description = "restrict mDNS to the loopback interface (testing)" };
var timeoutOption = new Option<int>("--timeout", "-t")
{
Description = "timeout in seconds before exiting (-1 = run until Ctrl+C)",
DefaultValueFactory = _ => -1
};
var rootCommand = new RootCommand($"Usage: dotnet {ApplicationName}.dll [OPTIONS]")
{
consoleOption,
autoAcceptOption,
noMdnsOption,
loopbackMdnsOption,
timeoutOption
};
rootCommand.SetAction(async (parseResult, cancellationToken) =>
{
bool logConsole = parseResult.GetValue(consoleOption);
bool autoAccept = parseResult.GetValue(autoAcceptOption);
bool noMdns = parseResult.GetValue(noMdnsOption);
bool loopbackMdns = parseResult.GetValue(loopbackMdnsOption);
int timeoutSec = parseResult.GetValue(timeoutOption);
int timeoutMs = timeoutSec >= 0 ? timeoutSec * 1000 : -1;
if (logConsole)
{
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
.WriteTo.Console(restrictedToMinimumLevel: LogEventLevel.Information,
formatProvider: CultureInfo.InvariantCulture)
.CreateLogger();
}
ITelemetryContext telemetry = DefaultTelemetry.Create(builder =>
{
builder.SetMinimumLevel(LogLevel.Information);
if (logConsole)
{
builder.AddSerilog(Log.Logger);
}
});
Microsoft.Extensions.Logging.ILogger logger = telemetry.LoggerFactory.CreateLogger("Main");
var sw = Stopwatch.StartNew();
var application = new ApplicationInstance(telemetry)
{
ApplicationName = ApplicationName,
ApplicationType = ApplicationType.DiscoveryServer,
ConfigSectionName = ConfigSectionName
};
try
{
System.Console.WriteLine($"Loading configuration from {ConfigSectionName}.Config.xml.");
await application
.LoadApplicationConfigurationAsync(silent: false, ct: cancellationToken)
.ConfigureAwait(false);
System.Console.WriteLine("Checking the application certificate.");
bool ok = await application
.CheckApplicationInstanceCertificatesAsync(silent: false, ct: cancellationToken)
.ConfigureAwait(false);
if (!ok)
{
System.Console.Error.WriteLine("Application instance certificate invalid.");
return 1;
}
if (autoAccept)
{
application.ApplicationConfiguration!.SecurityConfiguration
.AutoAcceptUntrustedCertificates = true;
}
var server = new LdsServer(telemetry);
if (!noMdns)
{
server.MulticastFactory = lds => new MulticastDiscovery(
lds.Store,
loopbackOnly: loopbackMdns,
logger: telemetry.LoggerFactory.CreateLogger<MulticastDiscovery>());
}
server.Store.StartPruneTimer();
System.Console.WriteLine("Starting the LDS.");
await application.StartAsync(server, cancellationToken).ConfigureAwait(false);
foreach (EndpointDescription ep in server.GetEndpoints())
{
System.Console.WriteLine(" Endpoint: {0}", ep.EndpointUrl);
}
System.Console.WriteLine($"LDS started ({sw.ElapsedMilliseconds} ms). Press Ctrl-C to exit...");
try
{
if (timeoutMs >= 0)
{
using var timeoutCts =
CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
timeoutCts.CancelAfter(timeoutMs);
await Task.Delay(Timeout.Infinite, timeoutCts.Token).ConfigureAwait(false);
}
else
{
await Task.Delay(Timeout.Infinite, cancellationToken).ConfigureAwait(false);
}
}
catch (OperationCanceledException)
{
// expected — Ctrl-C or timeout.
}
System.Console.WriteLine("Stopping the LDS.");
await application.StopAsync(default).ConfigureAwait(false);
return 0;
}
catch (Exception ex)
{
logger?.FatalErrorStartingLds(ex);
System.Console.Error.WriteLine(ex);
return 2;
}
finally
{
(telemetry as IDisposable)?.Dispose();
}
});
return rootCommand.Parse(args).InvokeAsync();
}
}
internal static partial class ProgramLog
{
[LoggerMessage(EventId = ConsoleLdsServerEventIds.Program + 0, Level = LogLevel.Error,
Message = "Fatal error starting LDS.")]
public static partial void FatalErrorStartingLds(
this Microsoft.Extensions.Logging.ILogger logger, Exception exception);
}
}