Aligned TimeProvider usage with actual .NET 8 behavior.

Ed-Fi-Alliance-OSS · Feb 13, 2024 · 3eba10e · 3eba10e
1 parent 6ddc3d5
commit 3eba10e
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 19 deletions.
diff --git a/Application/EdFi.Ods.Api/Container/Modules/ApplicationModule.cs b/Application/EdFi.Ods.Api/Container/Modules/ApplicationModule.cs
@@ -377,8 +377,7 @@ protected override void Load(ContainerBuilder builder)
                 .As<IEdFiOdsConnectionStringWriter>()
                 .SingleInstance();
 
-            builder.RegisterType<TimeProvider>()
-                .AsSelf()
+            builder.RegisterInstance(TimeProvider.System)
                 .SingleInstance();
 
             RegisterPipeLineStepProviders();

diff --git a/Application/EdFi.Ods.Common/Configuration/CacheSettings.cs b/Application/EdFi.Ods.Common/Configuration/CacheSettings.cs
@@ -15,7 +15,7 @@ public class CacheSettings
         internal ExternalCacheProviderOption ExternalCacheProviderOption
         {
             get => Enum.TryParse<ExternalCacheProviderOption>(ExternalCacheProvider, ignoreCase: true, out var parsed)
-                ? parsed : ExternalCacheProviderOption.Undetermined;
+                ? parsed : default;
         }
 
         public DescriptorsCacheConfiguration Descriptors { get; set; } = new();

diff --git a/Application/EdFi.Ods.Common/Utils/TimeProvider.cs b/Application/EdFi.Ods.Common/Utils/TimeProvider.cs
@@ -10,5 +10,9 @@ namespace EdFi.Ods.Common.Utils;
 // This class will be obsolete with .NET 8 and should be replaced.
 public class TimeProvider
 {
-    public virtual DateTime GetUtcNow() => DateTime.UtcNow;
+    protected TimeProvider(){}
+
+    public virtual DateTimeOffset GetUtcNow() => DateTimeOffset.UtcNow;
+
+    public static TimeProvider System { get; } = new();
 }
diff --git a/Application/EdFi.Ods.Features/Notifications/NotificationsMessageSink.cs b/Application/EdFi.Ods.Features/Notifications/NotificationsMessageSink.cs
@@ -83,7 +83,7 @@ public void Receive(string messageContent)
                         {
                             // Always proceed the first time
                             evaluation.Proceed = true;
-                            return evaluation.TimeProvider.GetUtcNow();
+                            return evaluation.TimeProvider.GetUtcNow().UtcDateTime;
                         },
                         static (t, lastNotification, evaluation) =>
                         {
@@ -95,7 +95,7 @@ public void Receive(string messageContent)
                             }
 
                             evaluation.Proceed = true;
-                            return evaluation.TimeProvider.GetUtcNow();
+                            return evaluation.TimeProvider.GetUtcNow().UtcDateTime;
                         },
                         intervalEvaluation);
 

diff --git a/tests/EdFi.Ods.Features.UnitTests/FakeTimeProvider.cs b/tests/EdFi.Ods.Features.UnitTests/FakeTimeProvider.cs
@@ -14,7 +14,7 @@ public class FakeTimeProvider : TimeProvider
 
     public FakeTimeProvider()
     {
-        _dateTimeOffset = DateTimeOffset.Now;
+        _dateTimeOffset = DateTimeOffset.Parse("2000-01-01");
     }
 
     public FakeTimeProvider(DateTimeOffset dateTimeOffset)
@@ -27,10 +27,5 @@ public void Advance(TimeSpan amount)
         _dateTimeOffset = _dateTimeOffset.Add(amount);
     }
 
-    public void SetUtcNow(DateTimeOffset dateTimeOffset)
-    {
-        _dateTimeOffset = dateTimeOffset;
-    }
-
-    public override DateTime GetUtcNow() => _dateTimeOffset.DateTime;
+    public override DateTimeOffset GetUtcNow() => _dateTimeOffset;
 }
diff --git a/tests/EdFi.Ods.Features.UnitTests/Notifications/NotificationMessageSinkTests.cs b/tests/EdFi.Ods.Features.UnitTests/Notifications/NotificationMessageSinkTests.cs
@@ -44,7 +44,7 @@ public void Receive_UnrecognizedMessageType_LogsDebug()
         {
             // Arrange
             var mediator = A.Fake<IMediator>();
-            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), new TimeProvider());
+            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), TimeProvider.System);
 
             // Act
             sink.Receive(@"{""Type"":""non-attributed-test-notification"",""Data"":{}}");
@@ -63,7 +63,7 @@ public void Receive_RecognizedMessageType_PublishesNotification()
         {
             // Arrange
             var mediator = A.Fake<IMediator>();
-            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), new TimeProvider());
+            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), TimeProvider.System);
 
             var messageContent = @"{""Type"":""test-notification"",""Data"":{""Property"":""Value""}}";
 
@@ -79,7 +79,7 @@ public void Receive_InvalidMessageFormat_LogsError()
         {
             // Arrange
             var mediator = A.Fake<IMediator>();
-            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), new TimeProvider());
+            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), TimeProvider.System);
 
             var invalidMessageContent = "InvalidMessageContent";
 
@@ -98,7 +98,7 @@ public void Receive_ValidMessageFormat_LogsDebug()
         {
             // Arrange
             var mediator = A.Fake<IMediator>();
-            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), new TimeProvider());
+            var sink = new NotificationsMessageSink(mediator, new Dictionary<string, TimeSpan>(), TimeProvider.System);
 
             var validMessageContent = @"{""Type"":""test-notification"",""Data"":{""Property"":""Value""}}";
 
@@ -117,7 +117,7 @@ public void Receive_WithConfiguredMinimumInterval_PublishesNotificationOncePerIn
         {
             // Arrange
             var mediator = A.Fake<IMediator>();
-            var fakeTimeProvider = new FakeTimeProvider();
+            var fakeTimeProvider = new FakeTimeProvider(DateTimeOffset.UtcNow);
             var intervalByNotificationType = new Dictionary<string, TimeSpan>
             {
                 { "test-notification", TimeSpan.FromSeconds(5) }

diff --git a/tests/EdFi.Ods.Features.UnitTests/Notifications/Redis/RedisNotificationTests.cs b/tests/EdFi.Ods.Features.UnitTests/Notifications/Redis/RedisNotificationTests.cs
@@ -64,7 +64,7 @@ public void Should_subscribe_to_and_receive_Redis_pub_sub_notification_and_invok
         var activity = new InitializeRedisNotifications(
             _redisConnectionProvider,
             _redisNotificationSettings,
-            new NotificationsMessageSink(mediator, _intervalsByNotificationType, new TimeProvider()));
+            new NotificationsMessageSink(mediator, _intervalsByNotificationType, TimeProvider.System));
 
         activity.Execute();