Merge branch 'merge/release/3.1-to-master' of https://github.com/dotn…

…et-maestro-bot/Common into dotnet-maestro-bot-merge/release/3.1-to-master
dotnet · Jan 16, 2020 · 3873a07 · 3873a07
2 parents 259a64a + 08a9b86
commit 3873a07
Show file tree

Hide file tree

Showing 13 changed files with 214 additions and 851 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -55,7 +55,7 @@
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(IsUnitTestProject)' == 'true' ">
-    <Reference Include="Microsoft.AspNetCore.Testing" />
+    <ProjectReference Include="$(MSBuildThisFileDirectory)src\TestingUtils\Microsoft.AspNetCore.Testing\src\Microsoft.AspNetCore.Testing.csproj" />
     <Reference Include="Moq" />
   </ItemGroup>
 

diff --git a/eng/ProjectReferences.props b/eng/ProjectReferences.props
@@ -56,7 +56,6 @@
     <ProjectReferenceProvider Include="Microsoft.Extensions.Options.DataAnnotations" ProjectPath="$(RepoRoot)src\Options\DataAnnotations\src\Microsoft.Extensions.Options.DataAnnotations.csproj" RefProjectPath="$(RepoRoot)src\Options\DataAnnotations\ref\Microsoft.Extensions.Options.DataAnnotations.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.Options" ProjectPath="$(RepoRoot)src\Options\Options\src\Microsoft.Extensions.Options.csproj" RefProjectPath="$(RepoRoot)src\Options\Options\ref\Microsoft.Extensions.Options.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.Primitives" ProjectPath="$(RepoRoot)src\Primitives\src\Microsoft.Extensions.Primitives.csproj" RefProjectPath="$(RepoRoot)src\Primitives\ref\Microsoft.Extensions.Primitives.csproj" />
-    <ProjectReferenceProvider Include="Microsoft.AspNetCore.Testing" ProjectPath="$(RepoRoot)src\TestingUtils\Microsoft.AspNetCore.Testing\src\Microsoft.AspNetCore.Testing.csproj" RefProjectPath="$(RepoRoot)src\TestingUtils\Microsoft.AspNetCore.Testing\ref\Microsoft.AspNetCore.Testing.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.WebEncoders" ProjectPath="$(RepoRoot)src\WebEncoders\src\Microsoft.Extensions.WebEncoders.csproj" RefProjectPath="$(RepoRoot)src\WebEncoders\ref\Microsoft.Extensions.WebEncoders.csproj" />
   </ItemGroup>
 </Project>
diff --git a/src/Hosting/IntegrationTesting/src/Microsoft.Extensions.Hosting.IntegrationTesting.csproj b/src/Hosting/IntegrationTesting/src/Microsoft.Extensions.Hosting.IntegrationTesting.csproj
@@ -15,7 +15,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Reference Include="Microsoft.AspNetCore.Testing" />
     <Reference Include="Microsoft.Extensions.Hosting.Abstractions" />
     <Reference Include="Microsoft.Extensions.FileProviders.Embedded" />
     <Reference Include="Microsoft.Extensions.Logging" />

diff --git a/src/HttpClientFactory/Http/src/DependencyInjection/HttpClientBuilderExtensions.cs b/src/HttpClientFactory/Http/src/DependencyInjection/HttpClientBuilderExtensions.cs
@@ -324,7 +324,13 @@ public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder
                 throw new ArgumentNullException(nameof(builder));
             }
 
-            ReserveClient(builder, typeof(TClient), builder.Name);
+            return AddTypedClientCore<TClient>(builder, validateSingleType: false);
+        }
+
+        internal static IHttpClientBuilder AddTypedClientCore<TClient>(this IHttpClientBuilder builder, bool validateSingleType)
+            where TClient : class
+        {
+            ReserveClient(builder, typeof(TClient), builder.Name, validateSingleType);
 
             builder.Services.AddTransient<TClient>(s =>
             {
@@ -378,7 +384,14 @@ public static IHttpClientBuilder AddTypedClient<TClient, TImplementation>(this I
                 throw new ArgumentNullException(nameof(builder));
             }
 
-            ReserveClient(builder, typeof(TClient), builder.Name);
+            return AddTypedClientCore<TClient, TImplementation>(builder, validateSingleType: false);
+        }
+
+        internal static IHttpClientBuilder AddTypedClientCore<TClient, TImplementation>(this IHttpClientBuilder builder, bool validateSingleType)
+            where TClient : class
+            where TImplementation : class, TClient
+        {
+            ReserveClient(builder, typeof(TClient), builder.Name, validateSingleType);
 
             builder.Services.AddTransient<TClient>(s =>
             {
@@ -426,7 +439,13 @@ public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder
                 throw new ArgumentNullException(nameof(factory));
             }
 
-            ReserveClient(builder, typeof(TClient), builder.Name);
+            return AddTypedClientCore<TClient>(builder, factory, validateSingleType: false);
+        }
+
+        internal static IHttpClientBuilder AddTypedClientCore<TClient>(this IHttpClientBuilder builder, Func<HttpClient, TClient> factory, bool validateSingleType)
+            where TClient : class
+        {
+            ReserveClient(builder, typeof(TClient), builder.Name, validateSingleType);
 
             builder.Services.AddTransient<TClient>(s =>
             {
@@ -473,7 +492,23 @@ public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder
                 throw new ArgumentNullException(nameof(factory));
             }
 
-            ReserveClient(builder, typeof(TClient), builder.Name);
+            return AddTypedClientCore<TClient>(builder, factory, validateSingleType: false);
+        }
+
+        internal static IHttpClientBuilder AddTypedClientCore<TClient>(this IHttpClientBuilder builder, Func<HttpClient, IServiceProvider, TClient> factory, bool validateSingleType)
+            where TClient : class
+        {
+            if (builder == null)
+            {
+                throw new ArgumentNullException(nameof(builder));
+            }
+
+            if (factory == null)
+            {
+                throw new ArgumentNullException(nameof(factory));
+            }
+
+            ReserveClient(builder, typeof(TClient), builder.Name, validateSingleType);
 
             builder.Services.AddTransient<TClient>(s =>
             {
@@ -583,23 +618,19 @@ public static IHttpClientBuilder SetHandlerLifetime(this IHttpClientBuilder buil
         }
 
         // See comments on HttpClientMappingRegistry.
-        private static void ReserveClient(IHttpClientBuilder builder, Type type, string name)
+        private static void ReserveClient(IHttpClientBuilder builder, Type type, string name, bool validateSingleType)
         {
             var registry = (HttpClientMappingRegistry)builder.Services.Single(sd => sd.ServiceType == typeof(HttpClientMappingRegistry)).ImplementationInstance;
             Debug.Assert(registry != null);
 
-            // Check for same type registered twice. This can't work because typed clients have to be unique for DI to function.
-            if (registry.TypedClientRegistrations.TryGetValue(type, out var otherName))
-            {
-                var message =
-                    $"The HttpClient factory already has a registered client with the type '{type.FullName}'. " +
-                    $"Client types must be unique. " +
-                    $"Consider using inheritance to create multiple unique types with the same API surface.";
-                throw new InvalidOperationException(message);
-            }
-
             // Check for same name registered to two types. This won't work because we rely on named options for the configuration.
-            if (registry.NamedClientRegistrations.TryGetValue(name, out var otherType))
+            if (registry.NamedClientRegistrations.TryGetValue(name, out var otherType) &&
+
+                // Allow using the same name with multiple types in some cases (see callers).
+                validateSingleType &&
+
+                // Allow registering the same name twice to the same type.
+                type != otherType)
             {
                 var message =
                     $"The HttpClient factory already has a registered client with the name '{name}', bound to the type '{otherType.FullName}'. " +
@@ -608,8 +639,10 @@ private static void ReserveClient(IHttpClientBuilder builder, Type type, string
                 throw new InvalidOperationException(message);
             }
 
-            registry.TypedClientRegistrations[type] = name;
-            registry.NamedClientRegistrations[name] = type;
+            if (validateSingleType)
+            {
+                registry.NamedClientRegistrations[name] = type;
+            }
         }
     }
 }
diff --git a/...lientFactory/Http/src/DependencyInjection/HttpClientFactoryServiceCollectionExtensions.cs b/...lientFactory/Http/src/DependencyInjection/HttpClientFactoryServiceCollectionExtensions.cs
@@ -210,7 +210,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
 
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: true);
             return builder;
         }
 
@@ -253,7 +253,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
 
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: true);
             return builder;
         }
 
@@ -298,7 +298,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
             AddHttpClient(services);
 
             var builder = new DefaultHttpClientBuilder(services, name);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: false); // Name was explicitly provided.
             return builder;
         }
 
@@ -349,7 +349,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
             AddHttpClient(services);
 
             var builder = new DefaultHttpClientBuilder(services, name);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: false); // name was explicitly provided
             return builder;
         }
 
@@ -394,7 +394,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: true);
             return builder;
         }
 
@@ -439,7 +439,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: true);
             return builder;
         }
 
@@ -489,7 +489,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: true);
             return builder;
         }
 
@@ -539,7 +539,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
             var name = TypeNameHelper.GetTypeDisplayName(typeof(TClient), fullName: false);
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: true);
             return builder;
         }
 
@@ -591,7 +591,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
 
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: false); // name was explicitly provided
             return builder;
         }
 
@@ -643,7 +643,7 @@ public static IHttpClientBuilder AddHttpClient<TClient>(this IServiceCollection
 
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient>();
+            builder.AddTypedClientCore<TClient>(validateSingleType: false); // name was explictly provided
             return builder;
         }
 
@@ -700,7 +700,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
 
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: false); // name was explicitly provided
             return builder;
         }
 
@@ -757,7 +757,7 @@ public static IHttpClientBuilder AddHttpClient<TClient, TImplementation>(this IS
 
             var builder = new DefaultHttpClientBuilder(services, name);
             builder.ConfigureHttpClient(configureClient);
-            builder.AddTypedClient<TClient, TImplementation>();
+            builder.AddTypedClientCore<TClient, TImplementation>(validateSingleType: false); // name was explicitly provided
             return builder;
         }
     }

diff --git a/src/HttpClientFactory/Http/src/DependencyInjection/HttpClientMappingRegistry.cs b/src/HttpClientFactory/Http/src/DependencyInjection/HttpClientMappingRegistry.cs
@@ -13,8 +13,6 @@ namespace Microsoft.Extensions.DependencyInjection
     // See: https://github.com/dotnet/extensions/issues/960
     internal class HttpClientMappingRegistry
     {
-        public Dictionary<Type, string> TypedClientRegistrations { get; } = new Dictionary<Type, string>();
-
         public Dictionary<string, Type> NamedClientRegistrations { get; } = new Dictionary<string, Type>();
     }
 }