Only register IoC services when not already provided

bkoelman · bkoelman · commit 69ab6cea742a · 2023-11-23T04:24:43.000+01:00
diff --git a/src/Examples/GettingStarted/Program.cs b/src/Examples/GettingStarted/Program.cs
@@ -2,13 +2,14 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.MongoDb.Configuration;
 using JsonApiDotNetCore.MongoDb.Repositories;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using MongoDB.Driver;
 
 WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
 
 // Add services to the container.
 
-builder.Services.AddSingleton(_ =>
+builder.Services.TryAddSingleton(_ =>
 {
     var client = new MongoClient(builder.Configuration.GetSection("DatabaseSettings:ConnectionString").Value);
     return client.GetDatabase(builder.Configuration.GetSection("DatabaseSettings:Database").Value);
diff --git a/src/Examples/JsonApiDotNetCoreMongoDbExample/Program.cs b/src/Examples/JsonApiDotNetCoreMongoDbExample/Program.cs
@@ -22,19 +22,19 @@
 builder.Services.TryAddSingleton(TimeProvider.System);
 #endif
 
-builder.Services.AddSingleton(_ =>
+builder.Services.TryAddSingleton(_ =>
 {
     var client = new MongoClient(builder.Configuration.GetValue<string>("DatabaseSettings:ConnectionString"));
     return client.GetDatabase(builder.Configuration.GetValue<string>("DatabaseSettings:Database"));
 });
 
+builder.Services.TryAddScoped(typeof(IResourceReadRepository<,>), typeof(MongoRepository<,>));
+builder.Services.TryAddScoped(typeof(IResourceWriteRepository<,>), typeof(MongoRepository<,>));
+builder.Services.TryAddScoped(typeof(IResourceRepository<,>), typeof(MongoRepository<,>));
+
 builder.Services.AddJsonApi(ConfigureJsonApiOptions, facade => facade.AddCurrentAssembly());
 builder.Services.AddJsonApiMongoDb();
 
-builder.Services.AddScoped(typeof(IResourceReadRepository<,>), typeof(MongoRepository<,>));
-builder.Services.AddScoped(typeof(IResourceWriteRepository<,>), typeof(MongoRepository<,>));
-builder.Services.AddScoped(typeof(IResourceRepository<,>), typeof(MongoRepository<,>));
-
 WebApplication app = builder.Build();
 
 // Configure the HTTP request pipeline.
diff --git a/src/JsonApiDotNetCore.MongoDb/Configuration/ServiceCollectionExtensions.cs b/src/JsonApiDotNetCore.MongoDb/Configuration/ServiceCollectionExtensions.cs
@@ -5,6 +5,7 @@
 using JsonApiDotNetCore.MongoDb.Repositories;
 using JsonApiDotNetCore.Queries;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace JsonApiDotNetCore.MongoDb.Configuration;
 
@@ -16,7 +17,9 @@ public static class ServiceCollectionExtensions
     [PublicAPI]
     public static IServiceCollection AddJsonApiMongoDb(this IServiceCollection services)
     {
-        services.AddScoped<IMongoDataAccess, MongoDataAccess>();
+        services.TryAddScoped<IMongoDataAccess, MongoDataAccess>();
+
+        // Replace the built-in implementations from JsonApiDotNetCore.
         services.AddScoped<IOperationsTransactionFactory, MongoTransactionFactory>();
         services.AddScoped<ISparseFieldSetCache, HideRelationshipsSparseFieldSetCache>();
 
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/AtomicOperationsFixture.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/AtomicOperationsFixture.cs
@@ -1,7 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations.Meta;
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -18,9 +18,9 @@ public AtomicOperationsFixture()
 
         TestContext.UseController<OperationsController>();
 
-        TestContext.ConfigureServicesAfterStartup(services =>
+        TestContext.ConfigureServices(services =>
         {
-            services.AddSingleton<ResourceDefinitionHitCounter>();
+            services.TryAddSingleton<ResourceDefinitionHitCounter>();
 
             services.AddResourceDefinition<MusicTrackMetaDefinition>();
             services.AddResourceDefinition<TextLanguageMetaDefinition>();
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Transactions/AtomicTransactionConsistencyTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Transactions/AtomicTransactionConsistencyTests.cs
@@ -2,7 +2,7 @@
 using FluentAssertions;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -21,9 +21,9 @@ public AtomicTransactionConsistencyTests(IntegrationTestContext<TestableStartup,
 
         testContext.UseController<OperationsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
-            services.AddSingleton<ResourceDefinitionHitCounter>();
+            services.TryAddSingleton<ResourceDefinitionHitCounter>();
 
             services.AddResourceRepository<PerformerRepository>();
             services.AddResourceRepository<MusicTrackRepository>();
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/Meta/ResourceMetaTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/Meta/ResourceMetaTests.cs
@@ -3,6 +3,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -21,9 +22,9 @@ public ResourceMetaTests(IntegrationTestContext<TestableStartup, MetaDbContext>
 
         testContext.UseController<SupportTicketsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
-            services.AddSingleton<ResourceDefinitionHitCounter>();
+            services.TryAddSingleton<ResourceDefinitionHitCounter>();
             services.AddResourceDefinition<SupportTicketDefinition>();
         });
 
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/Meta/TopLevelCountTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/Meta/TopLevelCountTests.cs
@@ -4,6 +4,7 @@
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -22,9 +23,9 @@ public TopLevelCountTests(IntegrationTestContext<TestableStartup, MetaDbContext>
 
         testContext.UseController<SupportTicketsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
-            services.AddScoped(typeof(IResourceChangeTracker<>), typeof(NeverSameResourceChangeTracker<>));
+            services.TryAddScoped(typeof(IResourceChangeTracker<>), typeof(NeverSameResourceChangeTracker<>));
         });
 
         var options = (JsonApiOptions)testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/SparseFieldSets/SparseFieldSetTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/SparseFieldSets/SparseFieldSetTests.cs
@@ -3,6 +3,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -23,9 +24,9 @@ public SparseFieldSetTests(IntegrationTestContext<TestableStartup, QueryStringDb
         testContext.UseController<WebAccountsController>();
         testContext.UseController<BlogsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
-            services.AddSingleton<ResourceCaptureStore>();
+            services.TryAddSingleton<ResourceCaptureStore>();
 
             services.AddResourceRepository<ResultCapturingRepository<Blog, string?>>();
             services.AddResourceRepository<ResultCapturingRepository<BlogPost, string?>>();
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/Creating/CreateResourceWithClientGeneratedIdTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/Creating/CreateResourceWithClientGeneratedIdTests.cs
@@ -22,7 +22,7 @@ public CreateResourceWithClientGeneratedIdTests(IntegrationTestContext<TestableS
         testContext.UseController<WorkItemGroupsController>();
         testContext.UseController<RgbColorsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
             services.AddResourceDefinition<ImplicitlyChangingWorkItemGroupDefinition>();
         });
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/Updating/Resources/UpdateResourceTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/Updating/Resources/UpdateResourceTests.cs
@@ -23,7 +23,7 @@ public UpdateResourceTests(IntegrationTestContext<TestableStartup, ReadWriteDbCo
         testContext.UseController<UserAccountsController>();
         testContext.UseController<RgbColorsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
             services.AddResourceDefinition<ImplicitlyChangingWorkItemDefinition>();
             services.AddResourceDefinition<ImplicitlyChangingWorkItemGroupDefinition>();
diff --git a/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs b/test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs
@@ -3,6 +3,7 @@
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using TestBuildingBlocks;
 using Xunit;
 
@@ -23,10 +24,10 @@ public ResourceDefinitionReadTests(IntegrationTestContext<TestableStartup, Unive
         testContext.UseController<PlanetsController>();
         testContext.UseController<MoonsController>();
 
-        testContext.ConfigureServicesAfterStartup(services =>
+        testContext.ConfigureServices(services =>
         {
-            services.AddSingleton<IClientSettingsProvider, TestClientSettingsProvider>();
-            services.AddSingleton<ResourceDefinitionHitCounter>();
+            services.TryAddSingleton<IClientSettingsProvider, TestClientSettingsProvider>();
+            services.TryAddSingleton<ResourceDefinitionHitCounter>();
 
             services.AddResourceDefinition<MoonDefinition>();
             services.AddResourceDefinition<PlanetDefinition>();
diff --git a/test/TestBuildingBlocks/IntegrationTestContext.cs b/test/TestBuildingBlocks/IntegrationTestContext.cs
@@ -11,6 +11,7 @@
 using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
 using MongoDB.Driver;
 
@@ -36,8 +37,7 @@ public class IntegrationTestContext<TStartup, TMongoDbContextShim> : Integration
     private readonly Lazy<WebApplicationFactory<TStartup>> _lazyFactory;
     private readonly HashSet<Type> _resourceClrTypes = new();
     private readonly TestControllerProvider _testControllerProvider = new();
-
-    private Action<IServiceCollection>? _afterServicesConfiguration;
+    private Action<IServiceCollection>? _configureServices;
 
     protected override JsonSerializerOptions SerializerOptions
     {
@@ -86,16 +86,24 @@ private WebApplicationFactory<TStartup> CreateFactory()
     {
         var factory = new IntegrationTestWebApplicationFactory();
 
-        factory.ConfigureServicesBeforeStartup(services =>
+        factory.ConfigureServices(services =>
         {
+            _configureServices?.Invoke(services);
+
             services.ReplaceControllers(_testControllerProvider);
 
-            services.AddSingleton(_ =>
+            services.TryAddSingleton(_ =>
             {
                 var client = new MongoClient(_runner.Value.ConnectionString);
-                return client.GetDatabase($"JsonApiDotNetCore_MongoDb_{new Random().Next()}_Test");
+                return client.GetDatabase($"JsonApiDotNetCore_MongoDb_{Random.Shared.Next()}_Test");
             });
 
+            services.TryAddScoped<TMongoDbContextShim>();
+
+            services.TryAddScoped(typeof(IResourceReadRepository<,>), typeof(MongoRepository<,>));
+            services.TryAddScoped(typeof(IResourceWriteRepository<,>), typeof(MongoRepository<,>));
+            services.TryAddScoped(typeof(IResourceRepository<,>), typeof(MongoRepository<,>));
+
             services.AddJsonApi(ConfigureJsonApiOptions, resources: builder =>
             {
                 foreach (Type resourceClrType in _resourceClrTypes)
@@ -105,16 +113,8 @@ private WebApplicationFactory<TStartup> CreateFactory()
             });
 
             services.AddJsonApiMongoDb();
-
-            services.AddScoped(typeof(IResourceReadRepository<,>), typeof(MongoRepository<,>));
-            services.AddScoped(typeof(IResourceWriteRepository<,>), typeof(MongoRepository<,>));
-            services.AddScoped(typeof(IResourceRepository<,>), typeof(MongoRepository<,>));
-
-            services.AddScoped<TMongoDbContextShim>();
         });
 
-        factory.ConfigureServicesAfterStartup(_afterServicesConfiguration);
-
         // We have placed an appsettings.json in the TestBuildingBlock project folder and set the content root to there. Note that controllers
         // are not discovered in the content root but are registered manually using IntegrationTestContext.UseController.
         return factory.WithWebHostBuilder(builder => builder.UseSolutionRelativeContentRoot($"test/{nameof(TestBuildingBlocks)}"));
@@ -127,9 +127,9 @@ private void ConfigureJsonApiOptions(JsonApiOptions options)
         options.SerializerOptions.WriteIndented = true;
     }
 
-    public void ConfigureServicesAfterStartup(Action<IServiceCollection> servicesConfiguration)
+    public void ConfigureServices(Action<IServiceCollection> configureServices)
     {
-        _afterServicesConfiguration = servicesConfiguration;
+        _configureServices = configureServices;
     }
 
     public async Task RunOnDatabaseAsync(Func<TMongoDbContextShim, Task> asyncAction)
@@ -162,17 +162,11 @@ public override async Task DisposeAsync()
 
     private sealed class IntegrationTestWebApplicationFactory : WebApplicationFactory<TStartup>
     {
-        private Action<IServiceCollection>? _beforeServicesConfiguration;
-        private Action<IServiceCollection>? _afterServicesConfiguration;
-
-        public void ConfigureServicesBeforeStartup(Action<IServiceCollection>? servicesConfiguration)
-        {
-            _beforeServicesConfiguration = servicesConfiguration;
-        }
+        private Action<IServiceCollection>? _configureServices;
 
-        public void ConfigureServicesAfterStartup(Action<IServiceCollection>? servicesConfiguration)
+        public void ConfigureServices(Action<IServiceCollection>? configureServices)
         {
-            _afterServicesConfiguration = servicesConfiguration;
+            _configureServices = configureServices;
         }
 
         protected override IHostBuilder CreateHostBuilder()
@@ -184,21 +178,12 @@ protected override IHostBuilder CreateHostBuilder()
                 .CreateDefaultBuilder(null)
                 .ConfigureWebHostDefaults(webBuilder =>
                 {
-                    webBuilder.ConfigureServices(services =>
-                    {
-                        _beforeServicesConfiguration?.Invoke(services);
-                    });
-
+                    webBuilder.ConfigureServices(services => _configureServices?.Invoke(services));
                     webBuilder.UseStartup<TStartup>();
-
-                    webBuilder.ConfigureServices(services =>
-                    {
-                        _afterServicesConfiguration?.Invoke(services);
-                    });
                 });
 
-            // @formatter:keep_existing_linebreaks restore
             // @formatter:wrap_before_first_method_call restore
+            // @formatter:wrap_chained_method_calls restore
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public CreateResourceWithClientGeneratedIdTests(IntegrationTestContext<TestableS`
`22`	`22`	`testContext.UseController<WorkItemGroupsController>();`
`23`	`23`	`testContext.UseController<RgbColorsController>();`
`24`	`24`
`25`		`- testContext.ConfigureServicesAfterStartup(services =>`
	`25`	`+ testContext.ConfigureServices(services =>`
`26`	`26`	`{`
`27`	`27`	`services.AddResourceDefinition<ImplicitlyChangingWorkItemGroupDefinition>();`
`28`	`28`	`});`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public UpdateResourceTests(IntegrationTestContext<TestableStartup, ReadWriteDbCo`
`23`	`23`	`testContext.UseController<UserAccountsController>();`
`24`	`24`	`testContext.UseController<RgbColorsController>();`
`25`	`25`
`26`		`- testContext.ConfigureServicesAfterStartup(services =>`
	`26`	`+ testContext.ConfigureServices(services =>`
`27`	`27`	`{`
`28`	`28`	`services.AddResourceDefinition<ImplicitlyChangingWorkItemDefinition>();`
`29`	`29`	`services.AddResourceDefinition<ImplicitlyChangingWorkItemGroupDefinition>();`