Merge pull request #1238 from DuendeSoftware/brock/nullable-types

configure nullable types for some public APIs
DuendeSoftware · Apr 11, 2023 · b6da8a9 · b6da8a9
2 parents 3c10811 + d451e01
commit b6da8a9
Show file tree

Hide file tree

Showing 203 changed files with 785 additions and 527 deletions.
diff --git a/src/AspNetIdentity/IdentityServerBuilderExtensions.cs b/src/AspNetIdentity/IdentityServerBuilderExtensions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using System.Linq;
@@ -119,12 +120,16 @@ internal static void AddDecorator<TService>(this IServiceCollection services)
                 return new DisposableDecorator<TService>((TService)registration.ImplementationFactory(provider));
             }, registration.Lifetime));
         }
-        else
+        else if (registration.ImplementationType != null)
         {
             var type = registration.ImplementationType;
             var innerType = typeof(Decorator<,>).MakeGenericType(typeof(TService), registration.ImplementationType);
             services.Add(new ServiceDescriptor(typeof(Decorator<TService>), innerType, ServiceLifetime.Transient));
             services.Add(new ServiceDescriptor(type, type, registration.Lifetime));
         }
+        else
+        {
+            throw new InvalidOperationException("Invalid registration in DI for: " + typeof(TService).Name);
+        }
     }
 }
diff --git a/src/EntityFramework.Storage/Configuration/ServiceCollectionExtensions.cs b/src/EntityFramework.Storage/Configuration/ServiceCollectionExtensions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using Duende.IdentityServer.EntityFramework.DbContexts;
@@ -23,7 +24,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <param name="storeOptionsAction">The store options action.</param>
     /// <returns></returns>
     public static IServiceCollection AddConfigurationDbContext(this IServiceCollection services,
-        Action<ConfigurationStoreOptions> storeOptionsAction = null)
+        Action<ConfigurationStoreOptions>? storeOptionsAction = null)
     {
         return services.AddConfigurationDbContext<ConfigurationDbContext>(storeOptionsAction);
     }
@@ -36,7 +37,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <param name="storeOptionsAction">The store options action.</param>
     /// <returns></returns>
     public static IServiceCollection AddConfigurationDbContext<TContext>(this IServiceCollection services,
-        Action<ConfigurationStoreOptions> storeOptionsAction = null)
+        Action<ConfigurationStoreOptions>? storeOptionsAction = null)
         where TContext : DbContext, IConfigurationDbContext
     {
         var options = new ConfigurationStoreOptions();
@@ -97,7 +98,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <param name="storeOptionsAction">The store options action.</param>
     /// <returns></returns>
     public static IServiceCollection AddOperationalDbContext(this IServiceCollection services,
-        Action<OperationalStoreOptions> storeOptionsAction = null)
+        Action<OperationalStoreOptions>? storeOptionsAction = null)
     {
         return services.AddOperationalDbContext<PersistedGrantDbContext>(storeOptionsAction);
     }
@@ -110,7 +111,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <param name="storeOptionsAction">The store options action.</param>
     /// <returns></returns>
     public static IServiceCollection AddOperationalDbContext<TContext>(this IServiceCollection services,
-        Action<OperationalStoreOptions> storeOptionsAction = null)
+        Action<OperationalStoreOptions>? storeOptionsAction = null)
         where TContext : DbContext, IPersistedGrantDbContext
     {
         var storeOptions = new OperationalStoreOptions();

diff --git a/src/EntityFramework.Storage/Extensions/DbContextExtensions.cs b/src/EntityFramework.Storage/Extensions/DbContextExtensions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer.EntityFramework.Interfaces;
 using Microsoft.EntityFrameworkCore;

diff --git a/src/EntityFramework.Storage/Extensions/ModelBuilderExtensions.cs b/src/EntityFramework.Storage/Extensions/ModelBuilderExtensions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer.EntityFramework.Entities;
 using Duende.IdentityServer.EntityFramework.Options;

diff --git a/src/EntityFramework.Storage/Interfaces/IConfigurationDbContext.cs b/src/EntityFramework.Storage/Interfaces/IConfigurationDbContext.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using Duende.IdentityServer.EntityFramework.Entities;

diff --git a/src/EntityFramework.Storage/Interfaces/IPersistedGrantDbContext.cs b/src/EntityFramework.Storage/Interfaces/IPersistedGrantDbContext.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using System.Threading;

diff --git a/src/EntityFramework.Storage/Options/ConfigurationStoreOptions.cs b/src/EntityFramework.Storage/Options/ConfigurationStoreOptions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using Microsoft.EntityFrameworkCore;
@@ -18,23 +19,23 @@ public class ConfigurationStoreOptions
     /// <value>
     /// The configure database context.
     /// </value>
-    public Action<DbContextOptionsBuilder> ConfigureDbContext { get; set; }
+    public Action<DbContextOptionsBuilder>? ConfigureDbContext { get; set; }
 
     /// <summary>
     /// Callback in DI resolve the EF DbContextOptions. If set, ConfigureDbContext will not be used.
     /// </summary>
     /// <value>
     /// The configure database context.
     /// </value>
-    public Action<IServiceProvider, DbContextOptionsBuilder> ResolveDbContextOptions { get; set; }
+    public Action<IServiceProvider, DbContextOptionsBuilder>? ResolveDbContextOptions { get; set; }
 
     /// <summary>
     /// Gets or sets the default schema.
     /// </summary>
     /// <value>
     /// The default schema.
     /// </value>
-    public string DefaultSchema { get; set; } = null;
+    public string? DefaultSchema { get; set; } = null;
 
     /// <summary>
     /// Gets or sets the identity resource table configuration.

diff --git a/src/EntityFramework.Storage/Options/OperationalStoreOptions.cs b/src/EntityFramework.Storage/Options/OperationalStoreOptions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using Microsoft.EntityFrameworkCore;
@@ -18,23 +19,23 @@ public class OperationalStoreOptions
     /// <value>
     /// The configure database context.
     /// </value>
-    public Action<DbContextOptionsBuilder> ConfigureDbContext { get; set; }
+    public Action<DbContextOptionsBuilder>? ConfigureDbContext { get; set; }
 
     /// <summary>
     /// Callback in DI resolve the EF DbContextOptions. If set, ConfigureDbContext will not be used.
     /// </summary>
     /// <value>
     /// The configure database context.
     /// </value>
-    public Action<IServiceProvider, DbContextOptionsBuilder> ResolveDbContextOptions { get; set; }
+    public Action<IServiceProvider, DbContextOptionsBuilder>? ResolveDbContextOptions { get; set; }
 
     /// <summary>
     /// Gets or sets the default schema.
     /// </summary>
     /// <value>
     /// The default schema.
     /// </value>
-    public string DefaultSchema { get; set; } = null;
+    public string? DefaultSchema { get; set; } = null;
 
     /// <summary>
     /// Gets or sets the persisted grants table configuration.

diff --git a/src/EntityFramework.Storage/Options/TableConfiguration.cs b/src/EntityFramework.Storage/Options/TableConfiguration.cs
@@ -1,6 +1,7 @@
-// Copyright (c) Duende Software. All rights reserved.
+// Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 namespace Duende.IdentityServer.EntityFramework.Options;
 
@@ -43,5 +44,5 @@ public TableConfiguration(string name, string schema)
     /// <value>
     /// The schema.
     /// </value>
-    public string Schema { get; set; }
+    public string? Schema { get; set; }
 }
diff --git a/src/EntityFramework.Storage/TokenCleanup/IOperationalStoreNotification.cs b/src/EntityFramework.Storage/TokenCleanup/IOperationalStoreNotification.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System.Collections.Generic;
 using System.Threading;

diff --git a/src/EntityFramework.Storage/TokenCleanup/ITokenCleanupService.cs b/src/EntityFramework.Storage/TokenCleanup/ITokenCleanupService.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System.Threading;
 using System.Threading.Tasks;

diff --git a/src/EntityFramework/IdentityServerEntityFrameworkBuilderExtensions.cs b/src/EntityFramework/IdentityServerEntityFrameworkBuilderExtensions.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using System;
 using Duende.IdentityServer.EntityFramework;
@@ -28,7 +29,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <returns></returns>
     public static IIdentityServerBuilder AddConfigurationStore(
         this IIdentityServerBuilder builder,
-        Action<ConfigurationStoreOptions> storeOptionsAction = null)
+        Action<ConfigurationStoreOptions>? storeOptionsAction = null)
     {
         return builder.AddConfigurationStore<ConfigurationDbContext>(storeOptionsAction);
     }
@@ -42,7 +43,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <returns></returns>
     public static IIdentityServerBuilder AddConfigurationStore<TContext>(
         this IIdentityServerBuilder builder,
-        Action<ConfigurationStoreOptions> storeOptionsAction = null)
+        Action<ConfigurationStoreOptions>? storeOptionsAction = null)
         where TContext : DbContext, IConfigurationDbContext
     {
         builder.Services.AddConfigurationDbContext<TContext>(storeOptionsAction);
@@ -82,7 +83,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <returns></returns>
     public static IIdentityServerBuilder AddOperationalStore(
         this IIdentityServerBuilder builder,
-        Action<OperationalStoreOptions> storeOptionsAction = null)
+        Action<OperationalStoreOptions>? storeOptionsAction = null)
     {
         return builder.AddOperationalStore<PersistedGrantDbContext>(storeOptionsAction);
     }
@@ -96,7 +97,7 @@ public static class IdentityServerEntityFrameworkBuilderExtensions
     /// <returns></returns>
     public static IIdentityServerBuilder AddOperationalStore<TContext>(
         this IIdentityServerBuilder builder,
-        Action<OperationalStoreOptions> storeOptionsAction = null)
+        Action<OperationalStoreOptions>? storeOptionsAction = null)
         where TContext : DbContext, IPersistedGrantDbContext
     {
         builder.Services.AddOperationalDbContext<TContext>(storeOptionsAction);

diff --git a/src/IdentityServer/Configuration/CryptoHelper.cs b/src/IdentityServer/Configuration/CryptoHelper.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using IdentityModel;
 using Microsoft.IdentityModel.Tokens;
@@ -114,7 +115,7 @@ internal static ECCurve GetCurveFromCrvValue(string crv)
     /// <summary>
     /// Returns the matching curve name for signing algorithm.
     /// </summary>
-    internal static string GetCurveNameFromSigningAlgorithm(string alg)
+    internal static string? GetCurveNameFromSigningAlgorithm(string alg)
     {
         return alg switch
         {
@@ -185,9 +186,9 @@ internal static string GetECDsaSigningAlgorithmValue(IdentityServerConstants.ECD
         };
     }
 
-    internal static X509Certificate2 FindCertificate(string name, StoreLocation location, NameType nameType)
+    internal static X509Certificate2? FindCertificate(string name, StoreLocation location, NameType nameType)
     {
-        X509Certificate2 certificate = null;
+        X509Certificate2? certificate = null;
 
         if (location == StoreLocation.LocalMachine)
         {

diff --git a/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Additional.cs b/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Additional.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer.ResponseHandling;
 using Duende.IdentityServer.Services;
@@ -406,7 +407,7 @@ public static IIdentityServerBuilder AddBackChannelLogoutService<T>(this IIdenti
     /// <param name="builder">The builder.</param>
     /// <param name="configureClient">The configuration callback.</param>
     /// <returns></returns>
-    public static IHttpClientBuilder AddBackChannelLogoutHttpClient(this IIdentityServerBuilder builder, Action<HttpClient> configureClient = null)
+    public static IHttpClientBuilder AddBackChannelLogoutHttpClient(this IIdentityServerBuilder builder, Action<HttpClient>? configureClient = null)
     {
         const string name = IdentityServerConstants.HttpClients.BackChannelLogoutHttpClient;
         IHttpClientBuilder httpBuilder;
@@ -443,7 +444,7 @@ public static IHttpClientBuilder AddBackChannelLogoutHttpClient(this IIdentitySe
     /// <param name="builder">The builder.</param>
     /// <param name="configureClient">The configuration callback.</param>
     /// <returns></returns>
-    public static IHttpClientBuilder AddJwtRequestUriHttpClient(this IIdentityServerBuilder builder, Action<HttpClient> configureClient = null)
+    public static IHttpClientBuilder AddJwtRequestUriHttpClient(this IIdentityServerBuilder builder, Action<HttpClient>? configureClient = null)
     {
         const string name = IdentityServerConstants.HttpClients.JwtRequestUriHttpClient;
         IHttpClientBuilder httpBuilder;

diff --git a/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Core.cs b/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Core.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer;
 using Duende.IdentityServer.Configuration;
@@ -390,12 +391,16 @@ internal static void AddDecorator<TService>(this IServiceCollection services)
                 return new DisposableDecorator<TService>((TService)registration.ImplementationFactory(provider));
             }, registration.Lifetime));
         }
-        else
+        else if (registration.ImplementationType != null)
         {
             var type = registration.ImplementationType;
             var innerType = typeof(Decorator<,>).MakeGenericType(typeof(TService), registration.ImplementationType);
             services.Add(new ServiceDescriptor(typeof(Decorator<TService>), innerType, ServiceLifetime.Transient));
             services.Add(new ServiceDescriptor(type, type, registration.Lifetime));
         }
+        else
+        {
+            throw new InvalidOperationException("Invalid registration in DI for: " + typeof(TService).Name);
+        }
     }
 }
diff --git a/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Crypto.cs b/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/Crypto.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer;
 using Duende.IdentityServer.Configuration;
@@ -161,7 +162,7 @@ public static IIdentityServerBuilder AddSigningCredential(this IIdentityServerBu
     public static IIdentityServerBuilder AddDeveloperSigningCredential(
         this IIdentityServerBuilder builder,
         bool persistKey = true,
-        string filename = null,
+        string? filename = null,
         IdentityServerConstants.RsaSigningAlgorithm signingAlgorithm = IdentityServerConstants.RsaSigningAlgorithm.RS256)
     {
         if (filename == null)

diff --git a/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/InMemory.cs b/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/InMemory.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer.Models;
 using Duende.IdentityServer.Services;

diff --git a/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/SessionManagement.cs b/src/IdentityServer/Configuration/DependencyInjection/BuilderExtensions/SessionManagement.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Duende.IdentityServer.Configuration;
 using Duende.IdentityServer.Services;
@@ -77,7 +78,8 @@ public static IIdentityServerBuilder AddServerSideSessionStore<T>(this IIdentity
     {
         builder.Services.AddTransient<IServerSideSessionStore>(svcs =>
         {
-            if (svcs.GetService<IServerSideSessionsMarker>() == null) return null;
+            // odd that this Func is marked as non-null return value, since it is allowed to return null here.
+            if (svcs.GetService<IServerSideSessionsMarker>() == null) return null!;
             return svcs.GetRequiredService<T>();
         });
 

diff --git a/src/IdentityServer/Configuration/DependencyInjection/IIdentityServerBuilder.cs b/src/IdentityServer/Configuration/DependencyInjection/IIdentityServerBuilder.cs
@@ -1,6 +1,7 @@
-// Copyright (c) Duende Software. All rights reserved.
+// Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 namespace Microsoft.Extensions.DependencyInjection;
 

diff --git a/src/IdentityServer/Configuration/DependencyInjection/IdentityServerBuilder.cs b/src/IdentityServer/Configuration/DependencyInjection/IdentityServerBuilder.cs
@@ -1,6 +1,7 @@
-// Copyright (c) Duende Software. All rights reserved.
+// Copyright (c) Duende Software. All rights reserved.
 // See LICENSE in the project root for license information.
 
+#nullable enable
 
 using Microsoft.Extensions.DependencyInjection;
 using System;