Add Roslyn analyser to block DateTime Now properties

src/BannedSymbols.txt

@@ -0,0 +1,4 @@
+P:System.DateTime.Now;Use TimeProvider instead.
+P:System.DateTime.UtcNow;Use TimeProvider instead.
+P:System.DateTimeOffset.Now;Use TimeProvider instead.
+P:System.DateTimeOffset.UtcNow;Use TimeProvider instead.

src/Custom.Build.props

@@ -31,6 +31,12 @@
     <InstanceName Include="Particular.ServiceControl.Monitoring" />
   </ItemGroup>
 
+  <!-- WPF-generated XAML compilation projects do not need analyzers. -->
+  <ItemGroup Condition="!$(MSBuildProjectFile.EndsWith('_wpftmp.csproj'))">
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" PrivateAssets="All" />
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)BannedSymbols.txt" Visible="false" />
+  </ItemGroup>
+
   <PropertyGroup>
     <RuntimeIdentifier Condition="'$(WindowsSelfContained)' == 'true'">win-x64</RuntimeIdentifier>
     <RuntimeIdentifier Condition="'$(TargetArch)' == 'amd64'">linux-x64</RuntimeIdentifier>

src/Directory.Packages.props

@@ -22,6 +22,7 @@
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="$(RuntimeFrameworkVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="$(RuntimeFrameworkVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(RuntimeFrameworkVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="5.6.0" />
     <PackageVersion Include="Microsoft.Data.SqlClient.Extensions.Azure" Version="7.0.2" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="$(RuntimeFrameworkVersion)" />
     <PackageVersion Include="Microsoft.Extensions.DependencyModel" Version="$(RuntimeFrameworkVersion)" />

src/Particular.LicensingComponent.Persistence.InMemory/.editorconfig

@@ -8,4 +8,4 @@ dotnet_diagnostic.CA2007.severity = none
 # Justification: Rider displays an error to do with "Accessibility modifiers required (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/ide0040)"
 dotnet_diagnostic.IDE0040.severity = none
 
-csharp_style_var_elsewhere = true:error
+csharp_style_var_elsewhere = true:error

src/Particular.LicensingComponent.Persistence.InMemory/InMemoryLicensingDataStore.cs

@@ -134,19 +134,25 @@ public async Task UpdateUserIndicatorOnEndpoints(List<UpdateUserIndicator> userI
         await Task.CompletedTask;
     }
 
+#pragma warning disable RS0030 // Do not use banned apis: Throughput is based on external clocks
     public async Task<bool> IsThereThroughputForLastXDays(int days, CancellationToken cancellationToken = default) => await Task.FromResult(
         allThroughput.Any(endpointThroughput => endpointThroughput.Value.Any(
             t => t.Key >= DateOnly.FromDateTime(DateTime.UtcNow).AddDays(-days) &&
                  t.Key <= DateOnly.FromDateTime(DateTime.UtcNow).AddDays(-1))));
+#pragma warning restore RS0030
 
     public async Task<bool> IsThereThroughputForLastXDaysForSource(int days, ThroughputSource throughputSource, bool includeToday, CancellationToken cancellationToken = default)
     {
+#pragma warning disable RS0030 // Do not use banned apis: Throughput is based on external clocks
         var endDate = includeToday ? DateOnly.FromDateTime(DateTime.UtcNow) : DateOnly.FromDateTime(DateTime.UtcNow).AddDays(-1);
+#pragma warning restore RS0030
 
         return await Task.FromResult(
             allThroughput.Any(
                 endpointThroughput => endpointThroughput.Key.ThroughputSource == throughputSource &&
+#pragma warning disable RS0030 // Do not use banned apis: Throughput is based on external clocks
                 endpointThroughput.Value.Any(t => t.Key >= DateOnly.FromDateTime(DateTime.UtcNow).AddDays(-days) && t.Key <= endDate)));
+#pragma warning restore RS0030
     }
 
     List<Endpoint> GetAllConnectedEndpoints(string name) => endpoints.Where(w => w.SanitizedName == name || w.Id.Name == name).ToList();

src/Particular.LicensingComponent.UnitTests/.editorconfig

@@ -2,4 +2,5 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 dotnet_diagnostic.PS0018.severity = none

src/Particular.LicensingComponent/.editorconfig

@@ -11,4 +11,4 @@ dotnet_diagnostic.IDE0040.severity = none
 dotnet_diagnostic.IDE0010.severity = suggestion
 
 csharp_style_var_elsewhere = true:error
-csharp_style_var_for_built_in_types = true:error
+csharp_style_var_for_built_in_types = true:error

src/Particular.LicensingComponent/AuditThroughput/AuditThroughputCollectorHostedService.cs

@@ -91,7 +91,9 @@ async Task GatherThroughput(CancellationToken cancellationToken)
 
             var missingAuditThroughput = auditCounts
                 .Where(auditCount => auditCount.UtcDate > endpoint.LastCollectedDate &&
+#pragma warning disable RS0030 // Do not use banned apis: Throughput collection periods are based on current calendar dates
                                      auditCount.UtcDate < DateOnly.FromDateTime(DateTime.UtcNow))
+#pragma warning restore RS0030
                 .Select(auditCount => new EndpointDailyThroughput(auditCount.UtcDate, auditCount.Count))
                 .ToList();
 

src/Particular.LicensingComponent/ThroughputCollector.cs

@@ -123,7 +123,9 @@ public async Task<SignedReport> GenerateThroughputReport(string spVersion, DateT
 
         if (reportEndDate is null || reportEndDate == DateTime.MinValue)
         {
+#pragma warning disable RS0030 // Do not use banned apis: Throughput collection periods are based on current calendar dates
             reportEndDate = DateTime.UtcNow.Date;
+#pragma warning restore RS0030
         }
 
         var queueThroughputs = new List<QueueThroughput>();

src/ServiceControl.AcceptanceTesting/.editorconfig

@@ -2,3 +2,6 @@
 
 # Justification: Usage is from test projects
 dotnet_diagnostic.CA2007.severity = none
+
+# Justification: Usage is from test projects
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.AcceptanceTests.PostgreSql/.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# Justification: Test project
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.AcceptanceTests.RavenDB/.editorconfig

@@ -2,3 +2,4 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.AcceptanceTests.SqlServer/.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# Justification: Test project
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.AcceptanceTests/.editorconfig

@@ -4,3 +4,4 @@
 dotnet_diagnostic.CA2007.severity = none
 dotnet_diagnostic.PS0013.severity = none
 dotnet_diagnostic.PS0018.severity = none
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.Audit.AcceptanceTests.RavenDB/.editorconfig

@@ -2,4 +2,5 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 dotnet_diagnostic.PS0018.severity = none

src/ServiceControl.Audit.AcceptanceTests/.editorconfig

@@ -3,3 +3,4 @@
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
 dotnet_diagnostic.PS0018.severity = none
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.Audit.Persistence.InMemory/.editorconfig

@@ -1,4 +1,4 @@
 [*.cs]
 
 # Justification: ServiceControl app has no synchronization context
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = none

src/ServiceControl.Audit.Persistence.RavenDB/.editorconfig

@@ -1,4 +1,4 @@
 [*.cs]
 
 # Justification: ServiceControl app has no synchronization context
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = none

src/ServiceControl.Audit.Persistence.RavenDB/CustomChecks/CheckRavenDBIndexLag.cs

@@ -38,7 +38,9 @@ int CheckAndReportIndexesWithTooMuchIndexLag(IndexInformation[] indexes)
             {
                 if (indexStats.IsStale && indexStats.LastIndexingTime.HasValue)
                 {
+#pragma warning disable RS0030 // Do not use banned apis: RavenDB retention, index lag, and date boundaries require current wall-clock time
                     var indexLag = DateTime.UtcNow - indexStats.LastIndexingTime.Value;
+#pragma warning restore RS0030
 
                     if (indexLag > IndexLagThresholdError)
                     {

src/ServiceControl.Audit.Persistence.RavenDB/RavenAuditDataStore.cs

@@ -146,7 +146,9 @@ public async Task<QueryResult<IList<AuditCount>>> QueryAuditCounts(string endpoi
 
             if (oldestMsg != null)
             {
+#pragma warning disable RS0030 // Do not use banned apis: RavenDB retention, index lag, and date boundaries require current wall-clock time
                 var endDate = DateTime.UtcNow.Date.AddDays(1);
+#pragma warning restore RS0030
                 var oldestMsgDate = oldestMsg.ProcessedAt.ToUniversalTime().Date;
                 var thirtyDays = endDate.AddDays(-30);
 
@@ -181,7 +183,9 @@ public async Task<QueryResult<IList<AuditCount>>> QueryAuditCounts(string endpoi
                 {
                     results.Add(new AuditCount
                     {
+#pragma warning disable RS0030 // Do not use banned apis: RavenDB retention, index lag, and date boundaries require current wall-clock time
                         UtcDate = DateTime.UtcNow.Date,
+#pragma warning restore RS0030
                         Count = 0
                     });
                 }

src/ServiceControl.Audit.Persistence.RavenDB/UnitOfWork/RavenAuditIngestionUnitOfWork.cs

@@ -43,7 +43,9 @@ public async Task RecordProcessedMessage(ProcessedMessage processedMessage, Read
         MetadataAsDictionary GetExpirationMetadata() =>
             new()
             {
+#pragma warning disable RS0030 // Do not use banned apis: RavenDB retention, index lag, and date boundaries require current wall-clock time
                 [Constants.Documents.Metadata.Expires] = DateTime.UtcNow.Add(auditRetentionPeriod)
+#pragma warning restore RS0030
             };
 
         public Task RecordSagaSnapshot(SagaSnapshot sagaSnapshot, CancellationToken cancellationToken = default)

src/ServiceControl.Audit.Persistence.Tests.RavenDB/.editorconfig

@@ -2,4 +2,5 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 dotnet_diagnostic.PS0018.severity = none

src/ServiceControl.Audit.Persistence.Tests/.editorconfig

@@ -2,6 +2,7 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 dotnet_diagnostic.PS0018.severity = none
 
 # Justification: Tests don't support cancellation and don't need to forward IMessageHandlerContext.CancellationToken

src/ServiceControl.Audit.Persistence/.editorconfig

@@ -1,4 +1,4 @@
 [*.cs]
 
 # Justification: ServiceControl app has no synchronization context
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = none

src/ServiceControl.Audit.Persistence/ProcessedMessage.cs

@@ -22,14 +22,18 @@ public ProcessedMessage(Dictionary<string, string> headers, Dictionary<string, o
             var processingStartedTicks =
                 headers.TryGetValue(NServiceBus.Headers.ProcessingStarted, out var processingStartedValue)
                     ? DateTimeOffsetHelper.ToDateTimeOffset(processingStartedValue).UtcDateTime.Ticks.ToString()
+#pragma warning disable RS0030 // Do not use banned apis: Missing message timestamps fall back to the current wall-clock time
                     : DateTime.UtcNow.Ticks.ToString();
+#pragma warning restore RS0030
 
             var documentId = $"{processingStartedTicks}-{headers.ProcessingId()}";
 
             Id = $"ProcessedMessages-{documentId}";
 
             ProcessedAt = Headers.TryGetValue(NServiceBus.Headers.ProcessingEnded, out var processedAt) ?
+#pragma warning disable RS0030 // Do not use banned apis: Missing message timestamps fall back to the current wall-clock time
                 DateTimeOffsetHelper.ToDateTimeOffset(processedAt).UtcDateTime : DateTime.UtcNow; // best guess
+#pragma warning restore RS0030
         }
 
         public string Id { get; set; }

src/ServiceControl.Audit.UnitTests/.editorconfig

@@ -2,4 +2,5 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 dotnet_diagnostic.PS0018.severity = none

src/ServiceControl.Audit/.editorconfig

@@ -1,4 +1,4 @@
 [*.cs]
 
 # Justification: ServiceControl app has no synchronization context
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = none

src/ServiceControl.Audit/Monitoring/DetectNewEndpointsFromAuditImportsEnricher.cs

@@ -49,7 +49,9 @@ void TryAddEndpoint(EndpointDetails endpointDetails, AuditEnricherContext contex
             {
                 context.AddForSend(new RegisterNewEndpoint
                 {
+#pragma warning disable RS0030 // Do not use banned apis: Audit enrichment timestamps must reflect when events are processed
                     DetectedAt = DateTime.UtcNow,
+#pragma warning restore RS0030
                     Endpoint = endpointDetails
                 });
             }

src/ServiceControl.Audit/Recoverability/DetectSuccessfulRetriesEnricher.cs

@@ -34,7 +34,9 @@ public void Enrich(AuditEnricherContext context)
                 //and did not send the acknowledgment. We send it here to the acknowledgment queue.
                 var ackMessage = new OutgoingMessage(Guid.NewGuid().ToString(), new Dictionary<string, string>
                 {
+#pragma warning disable RS0030 // Do not use banned apis: Audit enrichment timestamps must reflect when events are processed
                     ["ServiceControl.Retry.Successful"] = DateTimeOffsetHelper.ToWireFormattedString(DateTimeOffset.UtcNow),
+#pragma warning restore RS0030
                     ["ServiceControl.Retry.UniqueMessageId"] = newRetryMessageId
                 }, Array.Empty<byte>());
                 var ackOperation = new TransportOperation(ackMessage, new UnicastAddressTag(ackQueue));

src/ServiceControl.Config.Tests/.editorconfig

@@ -2,6 +2,7 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 
 # Justification: Executable specifications intentionally assign properties after the
 # object initializer to mirror user interaction order (e.g. typing a name after load)

src/ServiceControl.Config/UI/Shell/ShellViewModel.cs

@@ -35,7 +35,9 @@ IEventAggregator eventAggregator
             DisplayName = "ServiceControl Config";
             IsModal = false;
             LoadAppVersion();
+#pragma warning disable RS0030 // Do not use banned apis: UtcNow for copyright is acceptable
             CopyrightInfo = $"{DateTime.UtcNow.Year} © Particular Software";
+#pragma warning restore RS0030
 
             RefreshInstancesCmd = Command.Create(async () =>
             {

src/ServiceControl.Infrastructure.Metrics/Counter.cs

@@ -20,7 +20,9 @@ internal Counter(string name, bool enabled)
             eventsPerSecond = new int[2];
             movingAverage = new int[300];
             movingAverageEpochs = new long[300];
+#pragma warning disable RS0030 // Do not use banned apis: metrics do not need to use external time provider
             epoch = DateTime.UtcNow.Minute;
+#pragma warning restore RS0030
         }
 
         public void Mark()

src/ServiceControl.Infrastructure.Metrics/Meter.cs

@@ -26,7 +26,9 @@ internal Meter(string name, bool enabled, float scale = 1)
             movingAverageSums = new long[300];
             movingAverageCounts = new long[300];
             movingAverageEpochs = new long[300];
+#pragma warning disable RS0030 // Do not use banned apis: metrics do not need to use external time provider
             epoch = DateTime.UtcNow.Minute;
+#pragma warning restore RS0030
         }
 
         public Measurement Measure() => new Measurement(this, enabled);

src/ServiceControl.Infrastructure.Tests/.editorconfig

@@ -2,4 +2,5 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 

src/ServiceControl.Infrastructure/.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# Justification: Test project
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.Infrastructure/Auth/AuthorizationAuditLog.cs

@@ -54,7 +54,9 @@ static string BuildEcsEvent(string subjectId, string subjectName, string permiss
     {
         var ecs = new Dictionary<string, object?>
         {
+#pragma warning disable RS0030 // Do not use banned apis: logging should use real time
             ["@timestamp"] = DateTimeOffset.UtcNow.ToString("O"),
+#pragma warning restore RS0030
             ["ecs"] = new { version = EcsVersion },
             ["event"] = new
             {

src/ServiceControl.Infrastructure/Auth/MessageActionAuditLog.cs

@@ -65,7 +65,9 @@ static string BuildEcsEvent(AuditUser user, MessageActionKind kind, string permi
     {
         var ecs = new Dictionary<string, object?>
         {
+#pragma warning disable RS0030 // Do not use banned apis: logging should use real time
             ["@timestamp"] = DateTimeOffset.UtcNow.ToString("O"),
+#pragma warning restore RS0030
             ["ecs"] = new { version = AuthorizationAuditLog.EcsVersion },
             ["event"] = new
             {

src/ServiceControl.Infrastructure/LoggingConfigurator.cs

@@ -34,7 +34,9 @@ public static string ConfigureNLog(string logFileName, string logPath, LogLevel
 
             NLog.LogManager.Configuration = nlogConfig;
 
+#pragma warning disable RS0030 // Do not use banned apis: logging should use real time
             var logEventInfo = new LogEventInfo { TimeStamp = DateTime.UtcNow };
+#pragma warning restore RS0030
             var fileTarget = nlogConfig.FindTargetByName<FileTarget>("file");
             return AppEnvironment.RunningInContainer ? "console" : fileTarget.FileName.Render(logEventInfo);
         }

src/ServiceControl.LicenseManagement/.editorconfig

@@ -0,0 +1 @@
+[*.cs]

src/ServiceControl.LicenseManagement/LicenseDetails.cs

@@ -58,7 +58,9 @@ public static LicenseDetails TrialExpired()
             return FromLicense(new License
             {
                 LicenseType = "Trial",
+#pragma warning disable RS0030 // Do not use banned apis: License expiry must be evaluated against current wall-clock time
                 ExpirationDate = DateTime.UtcNow.Date.AddDays(-2), //HasLicenseDateExpired uses a grace period of 1 day
+#pragma warning restore RS0030
                 IsExtendedTrial = false,
                 ValidApplications = ["All"]
             });
@@ -74,7 +76,9 @@ internal static LicenseDetails FromLicense(License license)
                 UpgradeProtectionExpiration = license.UpgradeProtectionExpiration,
                 //If expiration date is greater that 50 years treat is as no expiration date
                 ExpirationDate = license.ExpirationDate.HasValue
+#pragma warning disable RS0030 // Do not use banned apis: License expiry must be evaluated against current wall-clock time
                     ? license.ExpirationDate.Value > DateTime.UtcNow.AddYears(50) ? null : license.ExpirationDate
+#pragma warning restore RS0030
                     : license.ExpirationDate,
                 RegisteredTo = license.RegisteredTo,
                 IsCommercialLicense = license.IsCommercialLicense,
@@ -107,7 +111,9 @@ static bool HasLicenseDateExpired(DateTime licenseDate)
                 oneDayGrace = licenseDate.AddDays(1);
             }
 
+#pragma warning disable RS0030 // Do not use banned apis: License expiry must be evaluated against current wall-clock time
             return oneDayGrace < DateTime.UtcNow.Date;
+#pragma warning restore RS0030
         }
     }
 

src/ServiceControl.Monitoring.AcceptanceTests/.editorconfig

@@ -2,3 +2,4 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none

src/ServiceControl.Monitoring.UnitTests/.editorconfig

@@ -2,5 +2,6 @@
 
 # Justification: Test project
 dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.RS0030.severity = none
 csharp_style_var_elsewhere = true:error
 csharp_style_var_for_built_in_types = true:error

src/ServiceControl.Monitoring/.editorconfig

@@ -1,4 +1,4 @@
 [*.cs]
 
 # Justification: Application synchronization contexts don't require ConfigureAwait(false)
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = none