From c9465898a19255eb45e0c319c32ca68745492525 Mon Sep 17 00:00:00 2001
From: Brett Hazen <2651260+bhazen@users.noreply.github.com>
Date: Mon, 7 Apr 2025 16:50:10 -0500
Subject: [PATCH] Updating logging in V2 license code to use source generators

---
 .../Licensing/V2/LicenseAccessor.cs           |  2 +-
 .../Licensing/V2/LicenseExpirationChecker.cs  |  2 +-
 .../src/IdentityServer/Licensing/V2/Log.cs    | 29 +++++++++++++++++++
 .../Licensing/V2/ProtocolRequestCounter.cs    |  4 ++-
 4 files changed, 34 insertions(+), 3 deletions(-)
 create mode 100644 identity-server/src/IdentityServer/Licensing/V2/Log.cs

diff --git a/identity-server/src/IdentityServer/Licensing/V2/LicenseAccessor.cs b/identity-server/src/IdentityServer/Licensing/V2/LicenseAccessor.cs
index fc25553ca..2999b7bea 100644
--- a/identity-server/src/IdentityServer/Licensing/V2/LicenseAccessor.cs
+++ b/identity-server/src/IdentityServer/Licensing/V2/LicenseAccessor.cs
@@ -90,7 +90,7 @@ internal class LicenseAccessor(IdentityServerOptions options, ILogger<LicenseAcc
         var validateResult = handler.ValidateTokenAsync(licenseKey, parms).Result;
         if (!validateResult.IsValid)
         {
-            logger.LogCritical(validateResult.Exception, "Error validating the Duende software license key");
+            logger.ErrorValidatingLicenseKey(validateResult.Exception);
         }
 
         return validateResult.ClaimsIdentity?.Claims.ToArray() ?? [];
diff --git a/identity-server/src/IdentityServer/Licensing/V2/LicenseExpirationChecker.cs b/identity-server/src/IdentityServer/Licensing/V2/LicenseExpirationChecker.cs
index 74610db3e..a0384b2c3 100644
--- a/identity-server/src/IdentityServer/Licensing/V2/LicenseExpirationChecker.cs
+++ b/identity-server/src/IdentityServer/Licensing/V2/LicenseExpirationChecker.cs
@@ -21,7 +21,7 @@ internal class LicenseExpirationChecker(
         if (!_expiredLicenseWarned && !license.Current.Redistribution && IsExpired)
         {
             _expiredLicenseWarned = true;
-            _logger.LogError("The IdentityServer license is expired. In a future version of IdentityServer, license expiration will be enforced after a grace period.");
+            _logger.LicenseHasExpired();
         }
     }
 
diff --git a/identity-server/src/IdentityServer/Licensing/V2/Log.cs b/identity-server/src/IdentityServer/Licensing/V2/Log.cs
new file mode 100644
index 000000000..dbd0196bd
--- /dev/null
+++ b/identity-server/src/IdentityServer/Licensing/V2/Log.cs
@@ -0,0 +1,29 @@
+// Copyright (c) Duende Software. All rights reserved.
+// See LICENSE in the project root for license information.
+
+using Microsoft.Extensions.Logging;
+
+namespace Duende.IdentityServer.Licensing.V2;
+
+internal static class LicenseLogParameters
+{
+    public const string Threshold = "Threshold";
+}
+
+internal static partial class Log
+{
+    [LoggerMessage(
+        LogLevel.Critical,
+        message: "Error validating the Duende software license key")]
+    public static partial void ErrorValidatingLicenseKey(this ILogger logger, Exception ex);
+
+    [LoggerMessage(
+        LogLevel.Error,
+        message: "The IdentityServer license is expired. In a future version of IdentityServer, license expiration will be enforced after a grace period.")]
+    public static partial void LicenseHasExpired(this ILogger logger);
+
+    [LoggerMessage(LogLevel.Error,
+        Message =
+            $"You are using IdentityServer in trial mode and have exceeded the trial threshold of {{{LicenseLogParameters.Threshold}}} requests handled by IdentityServer. In a future version, you will need to restart the server or configure a license key to continue testing. For more information, please see https://docs.duendesoftware.com/trial-mode.")]
+    public static partial void TrialModeRequestCountExceeded(this ILogger logger, ulong threshold);
+}
diff --git a/identity-server/src/IdentityServer/Licensing/V2/ProtocolRequestCounter.cs b/identity-server/src/IdentityServer/Licensing/V2/ProtocolRequestCounter.cs
index 4aaa479ef..b166405c6 100644
--- a/identity-server/src/IdentityServer/Licensing/V2/ProtocolRequestCounter.cs
+++ b/identity-server/src/IdentityServer/Licensing/V2/ProtocolRequestCounter.cs
@@ -28,12 +28,14 @@ internal class ProtocolRequestCounter(
         {
             return;
         }
+
         var total = Interlocked.Increment(ref _requestCount);
         if (total <= Threshold || _warned)
         {
             return;
         }
-        _logger.LogError($"You are using IdentityServer in trial mode and have exceeded the trial threshold of {Threshold} requests handled by IdentityServer. In a future version, you will need to restart the server or configure a license key to continue testing. For more information, please see https://docs.duendesoftware.com/trial-mode.");
+
+        _logger.TrialModeRequestCountExceeded(Threshold);
         _warned = true;
     }
 }