refactor: replace custom SystemClock with native TimeProvider

The custom written SystemClock and its fake counterpart for integration tests have been removed. They have been replaced with the TimeProvider from the Microsoft.Extensions.Time.Testing package. This change affects several places across the codebase, where the system time was primarily used.

Author: kamilbaczek

Chapter-2-modules-separation/Src/Common/Fitnet.Common.Core/SystemClock/ISystemClock.cs

@@ -6,8 +6,8 @@ public static class SystemClockModule
 {
     public static IServiceCollection AddSystemClock(this IServiceCollection services)
     {
-        services.AddSingleton<ISystemClock, SystemClock>();
+        services.AddSingleton(TimeProvider.System);
 
         return services;
     }
-}
+}

Chapter-2-modules-separation/Src/Common/Fitnet.Common.Core/SystemClock/SystemClock.cs

@@ -3,6 +3,7 @@
     <ItemGroup>
         <PackageReference Include="Bogus" Version="34.0.2" />
         <PackageReference Include="FluentAssertions" Version="6.10.0" />
+        <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" Version="8.0.0" />
         <PackageReference Include="Verify.Xunit" Version="19.11.2" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
             <PrivateAssets>all</PrivateAssets>

Chapter-2-modules-separation/Src/Common/Fitnet.Common.Core/SystemClock/SystemClockModule.cs

@@ -1,12 +1,11 @@
 namespace EvolutionaryArchitecture.Fitnet.Common.IntegrationTests.TestEngine.Configuration;
 
-using Core.SystemClock;
 using Database;
 using Infrastructure.Events.EventBus;
 using Infrastructure.Mediator;
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
-using SystemClock;
+using Microsoft.Extensions.Time.Testing;
 
 public static class ConfigurationExtensions
 {
@@ -32,7 +31,7 @@ public static WebApplicationFactory<T> SetFakeSystemClock<T>(
         where T : class =>
         webApplicationFactory.WithWebHostBuilder(webHostBuilder =>
             webHostBuilder.ConfigureTestServices(services =>
-                services.AddSingleton<ISystemClock>(new FakeSystemClock(fakeDateTimeOffset))));
+                services.AddSingleton<TimeProvider>(new FakeTimeProvider(fakeDateTimeOffset))));
 
     public static WebApplicationFactory<T> WithFakeEventBus<T>(
         this WebApplicationFactory<T> webApplicationFactory,

Chapter-2-modules-separation/Src/Common/Fitnet.Common.IntegrationTests/Fitnet.Common.IntegrationTests.csproj

@@ -1,23 +1,23 @@
 namespace EvolutionaryArchitecture.Fitnet.Contracts.Application.Sign;
 
 using Common.Api.ErrorHandling;
-using Common.Core.SystemClock;
 using Common.Infrastructure.Events.EventBus;
 using Core;
 using IntegrationEvents;
 
 [UsedImplicitly]
 internal sealed class SignContractCommandHandler(
     IContractsRepository contractsRepository,
-    ISystemClock systemClock,
+    TimeProvider timeProvider,
     IEventBus eventBus) : IRequestHandler<SignContractCommand>
 {
     public async Task Handle(SignContractCommand command, CancellationToken cancellationToken)
     {
         var contract = await contractsRepository.GetByIdAsync(command.Id, cancellationToken) ??
                        throw new ResourceNotFoundException(command.Id);
 
-        contract.Sign(command.SignedAt, systemClock.Now);
+        var nowDate = timeProvider.GetUtcNow();
+        contract.Sign(command.SignedAt, nowDate);
         await contractsRepository.CommitAsync(cancellationToken);
         var @event = ContractSignedEvent.Create(contract.Id,
             contract.CustomerId,

Chapter-2-modules-separation/Src/Common/Fitnet.Common.IntegrationTests/TestEngine/Configuration/ConfigurationExtensions.cs

@@ -1,6 +1,5 @@
 namespace EvolutionaryArchitecture.Fitnet.Offers.Api.Prepare;
 
-using Common.Core.SystemClock;
 using Common.Infrastructure.Events;
 using Common.Infrastructure.Events.EventBus;
 using DataAccess;
@@ -10,11 +9,12 @@ namespace EvolutionaryArchitecture.Fitnet.Offers.Api.Prepare;
 internal sealed class PassExpiredEventHandler(
     IEventBus eventBus,
     OffersPersistence persistence,
-    ISystemClock systemClock) : IIntegrationEventHandler<PassExpiredEvent>
+    TimeProvider timeProvider) : IIntegrationEventHandler<PassExpiredEvent>
 {
     public async Task Handle(PassExpiredEvent @event, CancellationToken cancellationToken)
     {
-        var offer = Offer.PrepareStandardPassExtension(@event.CustomerId, systemClock.Now);
+        var nowDate = timeProvider.GetUtcNow();
+        var offer = Offer.PrepareStandardPassExtension(@event.CustomerId, nowDate);
         persistence.Offers.Add(offer);
         await persistence.SaveChangesAsync(cancellationToken);
 

Chapter-2-modules-separation/Src/Common/Fitnet.Common.IntegrationTests/TestEngine/SystemClock/FakeSystemClock.cs

@@ -1,6 +1,5 @@
 namespace EvolutionaryArchitecture.Fitnet.Passes.Api.MarkPassAsExpired;
 
-using Common.Core.SystemClock;
 using IntegrationEvents;
 using Common.Infrastructure.Events.EventBus;
 using DataAccess.Database;
@@ -15,7 +14,7 @@ internal static void MapMarkPassAsExpired(this IEndpointRouteBuilder app) => app
             async (
                 Guid id,
                 PassesPersistence persistence,
-                ISystemClock systemClock,
+                TimeProvider systemClock,
                 IEventBus eventBus,
                 CancellationToken cancellationToken) =>
             {
@@ -26,7 +25,8 @@ internal static void MapMarkPassAsExpired(this IEndpointRouteBuilder app) => app
                     return Results.NotFound();
                 }
 
-                pass.MarkAsExpired(systemClock.Now);
+                var nowDate = systemClock.GetUtcNow();
+                pass.MarkAsExpired(nowDate);
                 await persistence.SaveChangesAsync(cancellationToken);
 
                 var passExpiredEvent = PassExpiredEvent.Create(pass.Id, pass.CustomerId);

Chapter-2-modules-separation/Src/Contracts/Fitnet.Contracts.Application/Sign/SignContractCommandHandler.cs

@@ -1,13 +1,12 @@
 namespace EvolutionaryArchitecture.Fitnet.Reports.GenerateNewPassesRegistrationsPerMonthReport.DataRetriever;
 
-using Common.Core.SystemClock;
 using Dapper;
 using Dtos;
 using DataAccess;
 
 internal sealed class NewPassesRegistrationPerMonthReportDataRetriever(
     IDatabaseConnectionFactory databaseConnectionFactory,
-    ISystemClock clock) : INewPassesRegistrationPerMonthReportDataRetriever
+    TimeProvider timeProvider) : INewPassesRegistrationPerMonthReportDataRetriever
 {
     public async Task<IReadOnlyCollection<NewPassesRegistrationsPerMonthDto>> GetReportDataAsync(
         CancellationToken cancellationToken = default)
@@ -18,7 +17,7 @@ SELECT EXTRACT(MONTH FROM ""Passes"".""From"")::INTEGER AS ""{nameof(NewPassesRe
                to_char(""Passes"".""From"", 'Month') AS ""{nameof(NewPassesRegistrationsPerMonthDto.MonthName)}"",
                COUNT(*) AS ""{nameof(NewPassesRegistrationsPerMonthDto.RegisteredPasses)}""
         FROM ""Passes"".""Passes""
-        WHERE EXTRACT(YEAR FROM ""Passes"".""From"") = '{clock.Now.Year}'
+        WHERE EXTRACT(YEAR FROM ""Passes"".""From"") = '{timeProvider.GetUtcNow().Year}'
         GROUP BY ""{nameof(NewPassesRegistrationsPerMonthDto.MonthName)}"", ""{nameof(NewPassesRegistrationsPerMonthDto.MonthOrder)}""
         ORDER BY ""{nameof(NewPassesRegistrationsPerMonthDto.MonthOrder)}""";