Replace ISystemClock with TimeProvider

Author: bkoelman

src/Examples/DapperExample/Definitions/TodoItemDefinition.cs

@@ -11,14 +11,14 @@ namespace DapperExample.Definitions;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class TodoItemDefinition : JsonApiResourceDefinition<TodoItem, long>
 {
-    private readonly IClock _clock;
+    private readonly TimeProvider _timeProvider;
 
-    public TodoItemDefinition(IResourceGraph resourceGraph, IClock clock)
+    public TodoItemDefinition(IResourceGraph resourceGraph, TimeProvider timeProvider)
         : base(resourceGraph)
     {
-        ArgumentNullException.ThrowIfNull(clock);
+        ArgumentNullException.ThrowIfNull(timeProvider);
 
-        _clock = clock;
+        _timeProvider = timeProvider;
     }
 
     public override SortExpression OnApplySort(SortExpression? existingSort)
@@ -38,11 +38,11 @@ public override Task OnWritingAsync(TodoItem resource, WriteOperationKind writeO
     {
         if (writeOperation == WriteOperationKind.CreateResource)
         {
-            resource.CreatedAt = _clock.UtcNow;
+            resource.CreatedAt = _timeProvider.GetUtcNow();
         }
         else if (writeOperation == WriteOperationKind.UpdateResource)
         {
-            resource.LastModifiedAt = _clock.UtcNow;
+            resource.LastModifiedAt = _timeProvider.GetUtcNow();
         }
 
         return Task.CompletedTask;

src/Examples/DapperExample/IClock.cs

@@ -11,13 +11,12 @@
 using JsonApiDotNetCore.Repositories;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Diagnostics;
-using Microsoft.Extensions.DependencyInjection.Extensions;
 
 WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
 
 // Add services to the container.
 
-builder.Services.TryAddSingleton<IClock, SystemClock>();
+builder.Services.AddSingleton<TimeProvider>();
 
 DatabaseProvider databaseProvider = GetDatabaseProvider(builder.Configuration);
 string? connectionString = builder.Configuration.GetConnectionString($"DapperExample{databaseProvider}");

src/Examples/DapperExample/Program.cs

@@ -12,7 +12,7 @@ namespace JsonApiDotNetCoreExample.Definitions;
 public sealed class TodoItemDefinition(IResourceGraph resourceGraph, TimeProvider timeProvider)
     : JsonApiResourceDefinition<TodoItem, long>(resourceGraph)
 {
-    private readonly Func<DateTimeOffset> _getUtcNow = timeProvider.GetUtcNow;
+    private readonly TimeProvider _timeProvider = timeProvider;
 
     public override SortExpression OnApplySort(SortExpression? existingSort)
     {
@@ -31,11 +31,11 @@ public override Task OnWritingAsync(TodoItem resource, WriteOperationKind writeO
     {
         if (writeOperation == WriteOperationKind.CreateResource)
         {
-            resource.CreatedAt = _getUtcNow();
+            resource.CreatedAt = _timeProvider.GetUtcNow();
         }
         else if (writeOperation == WriteOperationKind.UpdateResource)
         {
-            resource.LastModifiedAt = _getUtcNow();
+            resource.LastModifiedAt = _timeProvider.GetUtcNow();
         }
 
         return Task.CompletedTask;

src/Examples/DapperExample/SystemClock.cs

@@ -4,19 +4,17 @@
 using DapperExample.Models;
 using DapperExample.Repositories;
 using DapperExample.TranslationToSql.DataModel;
-using FluentAssertions.Common;
-using FluentAssertions.Extensions;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Metadata;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Logging;
 using TestBuildingBlocks;
 using Xunit.Abstractions;
-using IClock = DapperExample.IClock;
 
 namespace DapperTests.IntegrationTests;
 
@@ -29,7 +27,7 @@ public sealed class DapperTestContext : IntegrationTest
         EXEC sp_MSForEachTable 'ALTER TABLE ? CHECK CONSTRAINT ALL';
         """;
 
-    public static readonly DateTimeOffset FrozenTime = 29.September(2018).At(16, 41, 56).AsUtc().ToDateTimeOffset();
+    public static readonly DateTimeOffset FrozenTime = DefaultDateTimeUtc;
 
     private readonly Lazy<WebApplicationFactory<TodoItem>> _lazyFactory;
     private ITestOutputHelper? _testOutputHelper;
@@ -82,10 +80,7 @@ private WebApplicationFactory<TodoItem> CreateFactory()
 
             builder.ConfigureServices(services =>
             {
-                services.AddSingleton<IClock>(new FrozenClock
-                {
-                    UtcNow = FrozenTime
-                });
+                services.Replace(ServiceDescriptor.Singleton<TimeProvider>(new FrozenTimeProvider(FrozenTime)));
 
                 ServiceDescriptor scopedCaptureStore = services.Single(descriptor => descriptor.ImplementationType == typeof(SqlCaptureStore));
                 services.Remove(scopedCaptureStore);

src/Examples/JsonApiDotNetCoreExample/Definitions/TodoItemDefinition.cs

@@ -26,8 +26,6 @@ public AtomicCreateResourceTests(IntegrationTestContext<TestableStartup<Operatio
         testContext.UseController<MusicTracksController>();
         testContext.UseController<PlaylistsController>();
 
-        testContext.ConfigureServices(services => services.AddSingleton<ISystemClock, FrozenSystemClock>());
-
         var options = (JsonApiOptions)testContext.Factory.Services.GetRequiredService<IJsonApiOptions>();
         options.AllowUnknownFieldsInRequestBody = false;
     }

test/DapperTests/IntegrationTests/DapperTestContext.cs

@@ -28,7 +28,6 @@ public AtomicCreateResourceWithClientGeneratedIdTests(IntegrationTestContext<Tes
             services.AddResourceDefinition<AssignIdToTextLanguageDefinition>();
 
             services.AddSingleton<ResourceDefinitionHitCounter>();
-            services.AddSingleton<ISystemClock, FrozenSystemClock>();
         });
     }
 

test/DapperTests/IntegrationTests/FrozenClock.cs

@@ -2,7 +2,6 @@
 using System.Reflection;
 using JsonApiDotNetCore.Resources;
 using Microsoft.Extensions.DependencyInjection;
-using TestBuildingBlocks;
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.AtomicOperations;
 
@@ -20,9 +19,11 @@ internal sealed class DateMustBeInThePastAttribute : ValidationAttribute
             if (propertyInfo.PropertyType == typeof(DateTimeOffset) || propertyInfo.PropertyType == typeof(DateTimeOffset?))
             {
                 var typedValue = (DateTimeOffset?)propertyInfo.GetValue(validationContext.ObjectInstance);
-                var systemClock = validationContext.GetRequiredService<ISystemClock>();
 
-                if (typedValue >= systemClock.UtcNow)
+                var timeProvider = validationContext.GetRequiredService<TimeProvider>();
+                DateTimeOffset utcNow = timeProvider.GetUtcNow();
+
+                if (typedValue >= utcNow)
                 {
                     return new ValidationResult($"{validationContext.MemberName} must be in the past.");
                 }