[Nullable Context] Enable on dotnet-monitor (#6949)

dotnet · Jul 23, 2024 · 9972dcd · 9972dcd
1 parent d9f6119
commit 9972dcd
Show file tree

Hide file tree

Showing 131 changed files with 610 additions and 404 deletions.
diff --git a/src/Microsoft.Diagnostics.Monitoring.Options/CorsConfigurationOptions.cs b/src/Microsoft.Diagnostics.Monitoring.Options/CorsConfigurationOptions.cs
@@ -13,6 +13,6 @@ public class CorsConfigurationOptions
         [Required]
         public string AllowedOrigins { get; set; } = string.Empty;
 
-        public string[]? GetOrigins() => AllowedOrigins?.Split(';');
+        public string[] GetOrigins() => AllowedOrigins.Split(';');
     }
 }
diff --git a/src/Microsoft.Diagnostics.Monitoring.Options/ExceptionsDebugOptionsExtensions.cs b/src/Microsoft.Diagnostics.Monitoring.Options/ExceptionsDebugOptionsExtensions.cs
@@ -5,7 +5,7 @@ namespace Microsoft.Diagnostics.Monitoring.Options
 {
     internal static class ExceptionsDebugOptionsExtensions
     {
-        public static bool GetIncludeMonitorExceptions(this ExceptionsDebugOptions options)
+        public static bool GetIncludeMonitorExceptions(this ExceptionsDebugOptions? options)
         {
             return (options?.IncludeMonitorExceptions).GetValueOrDefault(ExceptionsDebugOptionsDefaults.IncludeMonitorExceptions);
         }

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/Controllers/DiagController.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/Controllers/DiagController.cs
@@ -547,7 +547,7 @@ public Task<ActionResult<Dictionary<string, CollectionRuleDescription>>> GetColl
         [HttpGet("collectionrules/{collectionRuleName}", Name = nameof(GetCollectionRuleDetailedDescription))]
         [ProducesWithProblemDetails(ContentTypes.ApplicationJson)]
         [ProducesResponseType(typeof(CollectionRuleDetailedDescription), StatusCodes.Status200OK)]
-        public Task<ActionResult<CollectionRuleDetailedDescription>> GetCollectionRuleDetailedDescription(
+        public Task<ActionResult<CollectionRuleDetailedDescription?>> GetCollectionRuleDetailedDescription(
             string collectionRuleName,
             [FromQuery]
             int? pid = null,
@@ -556,7 +556,7 @@ public Task<ActionResult<CollectionRuleDetailedDescription>> GetCollectionRuleDe
             [FromQuery]
             string? name = null)
         {
-            return InvokeForProcess<CollectionRuleDetailedDescription>(processInfo =>
+            return InvokeForProcess<CollectionRuleDetailedDescription?>(processInfo =>
             {
                 return _collectionRuleService.GetCollectionRuleDetailedDescription(collectionRuleName, processInfo.EndpointInfo);
             },

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/DiagProcessFilter.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/DiagProcessFilter.cs
@@ -159,7 +159,7 @@ public bool MatchFilter(IProcessInfo processInfo)
             return false;
         }
 
-        private bool Compare(string value)
+        private bool Compare(string? value)
         {
             if (MatchType == DiagProcessFilterMatchType.Exact)
             {
@@ -174,12 +174,12 @@ private bool Compare(string value)
             return false;
         }
 
-        private bool ExactCompare(string value)
+        private bool ExactCompare(string? value)
         {
             return string.Equals(Value, value, StringComparison.OrdinalIgnoreCase);
         }
 
-        private bool ContainsCompare(string value)
+        private bool ContainsCompare(string? value)
         {
             return value?.IndexOf(Value, StringComparison.OrdinalIgnoreCase) > -1;
         }

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/Exceptions/ExceptionInstance.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/Exceptions/ExceptionInstance.cs
@@ -7,7 +7,7 @@
 
 namespace Microsoft.Diagnostics.Monitoring.WebApi.Exceptions
 {
-    internal record class ExceptionInstance(ulong Id, string TypeName, string ModuleName, string Message, DateTime Timestamp, CallStack CallStack, ulong[] InnerExceptionIds, string ActivityId, ActivityIdFormat ActivityIdFormat)
+    internal record class ExceptionInstance(ulong Id, string TypeName, string ModuleName, string Message, DateTime Timestamp, CallStack? CallStack, ulong[] InnerExceptionIds, string ActivityId, ActivityIdFormat ActivityIdFormat)
         : IExceptionInstance
     {
     }

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/Exceptions/ExceptionsSettingsFactory.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/Exceptions/ExceptionsSettingsFactory.cs
@@ -10,7 +10,7 @@ namespace Microsoft.Diagnostics.Monitoring.WebApi.Exceptions
     /// </summary>
     internal static class ExceptionsSettingsFactory
     {
-        public static ExceptionsConfigurationSettings ConvertExceptionsConfiguration(ExceptionsConfiguration configuration)
+        public static ExceptionsConfigurationSettings ConvertExceptionsConfiguration(ExceptionsConfiguration? configuration)
         {
             ExceptionsConfigurationSettings configurationSettings = new();
 

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/ICollectionRuleService.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/ICollectionRuleService.cs
@@ -12,6 +12,6 @@ internal interface ICollectionRuleService : IHostedService, IAsyncDisposable
     {
         Dictionary<string, CollectionRuleDescription> GetCollectionRulesDescriptions(IEndpointInfo endpointInfo);
 
-        CollectionRuleDetailedDescription GetCollectionRuleDetailedDescription(string collectionRuleName, IEndpointInfo endpointInfo);
+        CollectionRuleDetailedDescription? GetCollectionRuleDetailedDescription(string collectionRuleName, IEndpointInfo endpointInfo);
     }
 }
diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/IDiagnosticServices.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/IDiagnosticServices.cs
@@ -33,11 +33,11 @@ public interface IProcessInfo
     {
         IEndpointInfo EndpointInfo { get; }
 
-        string CommandLine { get; }
+        string? CommandLine { get; }
 
-        public string OperatingSystem { get; }
+        public string? OperatingSystem { get; }
 
-        public string ProcessArchitecture { get; }
+        public string? ProcessArchitecture { get; }
 
         string ProcessName { get; }
     }

diff --git a/src/Microsoft.Diagnostics.Monitoring.WebApi/ITraceOperationFactory.cs b/src/Microsoft.Diagnostics.Monitoring.WebApi/ITraceOperationFactory.cs
@@ -29,6 +29,6 @@ IArtifactOperation Create(
             TimeSpan duration,
             string providerName,
             string eventName,
-            IDictionary<string, string> payloadFilter);
+            IDictionary<string, string>? payloadFilter);
     }
 }
diff --git a/src/Tests/CollectionRuleActions.UnitTests/ActionListExecutorTests.cs b/src/Tests/CollectionRuleActions.UnitTests/ActionListExecutorTests.cs
@@ -11,6 +11,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
+using Moq;
 using System;
 using System.Reflection;
 using System.Threading;
@@ -30,6 +31,16 @@ public sealed class ActionListExecutorTests
 
         private const string DefaultRuleName = nameof(ActionListExecutorTests);
 
+        private static Microsoft.Diagnostics.Monitoring.WebApi.IProcessInfo CreateTestProcess()
+        {
+            Mock<Microsoft.Diagnostics.Monitoring.WebApi.IProcessInfo> mockProcessInfo = new();
+            mockProcessInfo
+                .Setup(p => p.EndpointInfo)
+                .Returns(Mock.Of<Microsoft.Diagnostics.Monitoring.WebApi.IEndpointInfo>);
+
+            return mockProcessInfo.Object;
+        }
+
         public ActionListExecutorTests(ITestOutputHelper outputHelper)
         {
             _outputHelper = outputHelper;
@@ -54,7 +65,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
                 ILogger<CollectionRuleService> logger = host.Services.GetRequiredService<ILogger<CollectionRuleService>>();
                 TimeProvider timeProvider = host.Services.GetRequiredService<TimeProvider>();
 
-                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, null, logger, timeProvider);
+                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, CreateTestProcess(), logger, timeProvider);
 
                 int callbackCount = 0;
                 Action startCallback = () => callbackCount++;
@@ -95,7 +106,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
                 ILogger<CollectionRuleService> logger = host.Services.GetRequiredService<ILogger<CollectionRuleService>>();
                 TimeProvider timeProvider = host.Services.GetRequiredService<TimeProvider>();
 
-                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, null, logger, timeProvider);
+                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, CreateTestProcess(), logger, timeProvider);
 
                 int callbackCount = 0;
                 Action startCallback = () => callbackCount++;
@@ -141,7 +152,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
                 ILogger<CollectionRuleService> logger = host.Services.GetRequiredService<ILogger<CollectionRuleService>>();
                 TimeProvider timeProvider = host.Services.GetRequiredService<TimeProvider>();
 
-                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, null, logger, timeProvider);
+                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, CreateTestProcess(), logger, timeProvider);
 
                 int callbackCount = 0;
                 Action startCallback = () => callbackCount++;

diff --git a/...itoring.Tool.FunctionalTests/Microsoft.Diagnostics.Monitoring.Tool.FunctionalTests.csproj b/...itoring.Tool.FunctionalTests/Microsoft.Diagnostics.Monitoring.Tool.FunctionalTests.csproj
@@ -74,6 +74,7 @@
     <Compile Include="..\..\Tools\dotnet-monitor\LoggingEventIds.cs" Link="LoggingEventIds.cs" />
     <Compile Include="..\..\Tools\dotnet-monitor\OutputFormat.cs" Link="Options\OutputFormat.cs" />
     <Compile Include="..\..\Tools\dotnet-monitor\RootOptions.cs" Link="Options\RootOptions.cs" />
+    <Compile Include="..\..\Tools\dotnet-monitor\ConvertUtils.cs" Link="ConvertUtils.cs" />
     <Compile Include="..\Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon\ExecuteActionTestHelper.cs" Link="ExecuteActionTestHelper.cs" />
     <Compile Include="..\Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon\Options\CollectionRuleOptionsExtensions.cs" Link="Options\CollectionRuleOptionsExtensions.cs" />
   </ItemGroup>

diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTests/ActionDependencyAnalyzerTests.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTests/ActionDependencyAnalyzerTests.cs
@@ -107,7 +107,8 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
                 ILogger<CollectionRuleService> logger = host.Services.GetRequiredService<ILogger<CollectionRuleService>>();
                 TimeProvider timeProvider = host.Services.GetRequiredService<TimeProvider>();
 
-                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, null, logger, timeProvider);
+                Guid instanceId = Guid.NewGuid();
+                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, new TestProcessInfo(instanceId), logger, timeProvider);
 
                 int callbackCount = 0;
                 Action startCallback = () => callbackCount++;
@@ -200,7 +201,8 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
                 ILogger<CollectionRuleService> logger = host.Services.GetRequiredService<ILogger<CollectionRuleService>>();
                 TimeProvider timeProvider = host.Services.GetRequiredService<TimeProvider>();
 
-                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, null, logger, timeProvider);
+                Guid instanceId = Guid.NewGuid();
+                CollectionRuleContext context = new(DefaultRuleName, ruleOptions, new TestProcessInfo(instanceId), logger, timeProvider);
 
                 ActionOptionsDependencyAnalyzer analyzer = ActionOptionsDependencyAnalyzer.Create(context);
                 analyzer.GetActionDependencies(1);

diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTests/EgressExtensibilityTests.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTests/EgressExtensibilityTests.cs
@@ -39,7 +39,8 @@ public void FoundExtension_Failure()
             HostBuilderSettings settings = new()
             {
                 SharedConfigDirectory = sharedConfigDir.FullName,
-                UserConfigDirectory = userConfigDir.FullName
+                UserConfigDirectory = userConfigDir.FullName,
+                ContentRootDirectory = AppContext.BaseDirectory
             };
 
             IHost host = TestHostHelper.CreateHost(_outputHelper, rootOptions => { }, host => { }, settings: settings);
@@ -61,7 +62,8 @@ public void FoundExtensionFile_Success(ConfigDirectory configDirectory)
             HostBuilderSettings settings = new()
             {
                 SharedConfigDirectory = sharedConfigDir.FullName,
-                UserConfigDirectory = userConfigDir.FullName
+                UserConfigDirectory = userConfigDir.FullName,
+                ContentRootDirectory = AppContext.BaseDirectory
             };
 
             IEgressExtension extension = FindEgressExtension(configDirectory, settings);
@@ -96,7 +98,8 @@ private async Task<EgressArtifactResult> GetExtensionResponse(bool shouldSucceed
             HostBuilderSettings settings = new()
             {
                 SharedConfigDirectory = sharedConfigDir.FullName,
-                UserConfigDirectory = userConfigDir.FullName
+                UserConfigDirectory = userConfigDir.FullName,
+                ContentRootDirectory = AppContext.BaseDirectory
             };
 
             EgressExtension extension = (EgressExtension)FindEgressExtension(ConfigDirectory.UserConfigDirectory, settings);

diff --git a/src/Tools/dotnet-monitor/ActivityExtensions.cs b/src/Tools/dotnet-monitor/ActivityExtensions.cs
@@ -7,7 +7,7 @@ namespace Microsoft.Diagnostics.Tools.Monitor
 {
     internal static class ActivityExtensions
     {
-        public static string GetSpanId(this Activity activity)
+        public static string? GetSpanId(this Activity activity)
         {
             switch (activity.IdFormat)
             {
@@ -19,7 +19,7 @@ public static string GetSpanId(this Activity activity)
             return string.Empty;
         }
 
-        public static string GetParentId(this Activity activity)
+        public static string? GetParentId(this Activity activity)
         {
             switch (activity.IdFormat)
             {
@@ -31,7 +31,7 @@ public static string GetParentId(this Activity activity)
             return string.Empty;
         }
 
-        public static string GetTraceId(this Activity activity)
+        public static string? GetTraceId(this Activity activity)
         {
             switch (activity.IdFormat)
             {

diff --git a/src/Tools/dotnet-monitor/AddressListenResults.cs b/src/Tools/dotnet-monitor/AddressListenResults.cs
@@ -69,7 +69,7 @@ public void Listen(KestrelServerOptions options, IEnumerable<string> defaultUrls
         /// </summary>
         private bool Listen(KestrelServerOptions options, string url, bool isAuthEnabled)
         {
-            BindingAddress address = null;
+            BindingAddress? address = null;
             try
             {
                 address = BindingAddress.Parse(url);
@@ -95,7 +95,7 @@ private bool Listen(KestrelServerOptions options, string url, bool isAuthEnabled
                 {
                     options.ListenLocalhost(address.Port, configureListenOptions);
                 }
-                else if (IPAddress.TryParse(address.Host, out IPAddress ipAddress))
+                else if (IPAddress.TryParse(address.Host, out IPAddress? ipAddress))
                 {
                     options.Listen(ipAddress, address.Port, configureListenOptions);
                 }

diff --git a/src/Tools/dotnet-monitor/AddressListenResultsStartupLogger.cs b/src/Tools/dotnet-monitor/AddressListenResultsStartupLogger.cs
@@ -29,9 +29,11 @@ public AddressListenResultsStartupLogger(
             _logger = logger;
             _server = server;
 
+#nullable disable
             _applicationStartedRegistration = lifetime.ApplicationStarted.Register(
                 l => ((AddressListenResultsStartupLogger)l).OnStarted(),
                 this);
+#nullable restore
         }
 
         public void Dispose()
@@ -52,6 +54,7 @@ public void Log()
             }
         }
 
+#nullable disable
         private void OnStarted()
         {
             IServerAddressesFeature serverAddresses = _server.Features.Get<IServerAddressesFeature>();
@@ -69,5 +72,6 @@ private void OnStarted()
                 _logger.BoundMetricsAddress(metricAddress);
             }
         }
+#nullable restore
     }
 }
diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/JwtBearerChangeTokenSource.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/JwtBearerChangeTokenSource.cs
@@ -18,7 +18,7 @@ internal sealed class JwtBearerChangeTokenSource :
         IDisposable
     {
         private readonly IOptionsMonitor<MonitorApiKeyConfiguration> _optionsMonitor;
-        private readonly IDisposable _changeRegistration;
+        private readonly IDisposable? _changeRegistration;
 
         private ConfigurationReloadToken _reloadToken = new ConfigurationReloadToken();
 
@@ -42,7 +42,7 @@ public IChangeToken GetChangeToken()
 
         public void Dispose()
         {
-            _changeRegistration.Dispose();
+            _changeRegistration?.Dispose();
         }
 
         private void OnReload(MonitorApiKeyConfiguration options)

diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/JwtBearerPostConfigure.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/JwtBearerPostConfigure.cs
@@ -21,10 +21,10 @@ public JwtBearerPostConfigure(
             _apiKeyConfig = apiKeyConfig;
         }
 
-        public void PostConfigure(string name, JwtBearerOptions options)
+        public void PostConfigure(string? name, JwtBearerOptions options)
         {
             MonitorApiKeyConfiguration configSnapshot = _apiKeyConfig.CurrentValue;
-            if (!configSnapshot.Configured || configSnapshot.ValidationErrors.Any())
+            if (!configSnapshot.Configured || configSnapshot.ValidationErrors?.Any() == true)
             {
 #if NET8_0_OR_GREATER
                 // https://github.com/aspnet/Announcements/issues/508
@@ -37,7 +37,9 @@ public void PostConfigure(string name, JwtBearerOptions options)
                 return;
             }
 
+#nullable disable
             options.ConfigureApiKeyTokenValidation(configSnapshot.PublicKey, configSnapshot.Issuer);
+#nullable restore
         }
     }
 }
diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyAuthConfigurator.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyAuthConfigurator.cs
@@ -17,11 +17,11 @@ namespace Microsoft.Diagnostics.Tools.Monitor.Auth.ApiKey
 {
     internal sealed class MonitorApiKeyAuthConfigurator : IAuthenticationConfigurator
     {
-        private readonly GeneratedJwtKey _pinnedJwtKey;
+        private readonly GeneratedJwtKey? _pinnedJwtKey;
         private readonly bool _enableNegotiation;
 
 
-        public MonitorApiKeyAuthConfigurator(GeneratedJwtKey pinnedJwtKey = null)
+        public MonitorApiKeyAuthConfigurator(GeneratedJwtKey? pinnedJwtKey = null)
         {
             _pinnedJwtKey = pinnedJwtKey;
 

diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyChangeTokenSource.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyChangeTokenSource.cs
@@ -17,7 +17,7 @@ internal sealed class MonitorApiKeyChangeTokenSource :
         IDisposable
     {
         private readonly IOptionsMonitor<MonitorApiKeyOptions> _optionsMonitor;
-        private readonly IDisposable _changeRegistration;
+        private readonly IDisposable? _changeRegistration;
 
         private ConfigurationReloadToken _reloadToken = new ConfigurationReloadToken();
 
@@ -37,7 +37,7 @@ public IChangeToken GetChangeToken()
 
         public void Dispose()
         {
-            _changeRegistration.Dispose();
+            _changeRegistration?.Dispose();
         }
 
         private void OnReload(MonitorApiKeyOptions options)

diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyConfiguration.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyConfiguration.cs
@@ -16,9 +16,9 @@ namespace Microsoft.Diagnostics.Tools.Monitor.Auth.ApiKey
     internal class MonitorApiKeyConfiguration : AuthenticationSchemeOptions
     {
         public bool Configured { get; set; }
-        public string Subject { get; set; }
-        public SecurityKey PublicKey { get; set; }
-        public IEnumerable<ValidationResult> ValidationErrors { get; set; }
-        public string Issuer { get; set; }
+        public string? Subject { get; set; }
+        public SecurityKey? PublicKey { get; set; }
+        public IEnumerable<ValidationResult>? ValidationErrors { get; set; }
+        public string? Issuer { get; set; }
     }
 }
diff --git a/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyConfigurationObserver.cs b/src/Tools/dotnet-monitor/Auth/ApiKey/MonitorApiKeyConfigurationObserver.cs
@@ -17,7 +17,7 @@ internal class MonitorApiKeyConfigurationObserver :
         private readonly ILogger<MonitorApiKeyConfigurationObserver> _logger;
         private readonly IOptionsMonitor<MonitorApiKeyConfiguration> _options;
 
-        private IDisposable _changeRegistration;
+        private IDisposable? _changeRegistration;
 
         public MonitorApiKeyConfigurationObserver(
             ILogger<MonitorApiKeyConfigurationObserver> logger,