Add strongly typed logging for Identity service projects

Co-authored-by: christiannagel <[email protected]>

Author: Copilot

src/Directory.Packages.props

@@ -78,13 +78,17 @@
     <PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="9.0.9" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.AzureAppConfiguration" Version="8.4.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="9.0.9" />
+    <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.3" Condition="'$(TargetFramework)' == 'net8.0'" />
+    <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.9" Condition="'$(TargetFramework)' == 'net9.0'" />
     <PackageVersion Include="Microsoft.Extensions.Diagnostics.Testing" Version="9.9.0" />
     <PackageVersion Include="Microsoft.Extensions.Hosting" Version="9.0.9" />
     <PackageVersion Include="Microsoft.Extensions.Http" Version="9.0.9" />
     <PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="9.9.0" />
     <PackageVersion Include="Microsoft.Extensions.Localization" Version="9.0.9" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.3" Condition="'$(TargetFramework)' == 'net8.0'" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.9" Condition="'$(TargetFramework)' == 'net9.0'" />
+    <PackageVersion Include="Microsoft.Extensions.Options" Version="8.0.3" Condition="'$(TargetFramework)' == 'net8.0'" />
+    <PackageVersion Include="Microsoft.Extensions.Options" Version="9.0.9" Condition="'$(TargetFramework)' == 'net9.0'" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="9.5.0" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery.Yarp" Version="9.5.0" />
     <!-- Microsoft UI and Identity packages -->

src/services/identity/Codebreaker.Identity.Tests/Extensions/LoggerExtensions.cs

@@ -0,0 +1,30 @@
+using Microsoft.Extensions.Logging;
+
+namespace Codebreaker.Identity.Tests.Extensions;
+
+public static partial class LoggerExtensions
+{
+    [LoggerMessage(
+        EventId = 35001,
+        Level = LogLevel.Information,
+        Message = "Creating mock anonymous user: {UserName}")]
+    public static partial void CreatingMockAnonymousUser(this ILogger logger, string userName);
+
+    [LoggerMessage(
+        EventId = 35002,
+        Level = LogLevel.Information,
+        Message = "Deleting stale anonymous users")]
+    public static partial void DeletingStaleAnonymousUsers(this ILogger logger);
+
+    [LoggerMessage(
+        EventId = 35003,
+        Level = LogLevel.Information,
+        Message = "Deleted {Count} stale anonymous users")]
+    public static partial void DeletedStaleAnonymousUsers(this ILogger logger, int count);
+
+    [LoggerMessage(
+        EventId = 35004,
+        Level = LogLevel.Information,
+        Message = "Promoting mock anonymous user: {UserId}")]
+    public static partial void PromotingMockAnonymousUser(this ILogger logger, string userId);
+}

src/services/identity/Codebreaker.Identity.Tests/MockAnonymousUserService.cs

@@ -1,5 +1,6 @@
 using Codebreaker.Identity.Models;
 using Codebreaker.Identity.Services;
+using Codebreaker.Identity.Tests.Extensions;
 using Microsoft.Extensions.Logging;
 
 namespace Codebreaker.Identity.Tests;
@@ -24,7 +25,7 @@ public MockAnonymousUserService(ILogger<MockAnonymousUserService> logger)
     /// <inheritdoc />
     public Task<AnonymousUser> CreateAnonUser(string userName)
     {
-        _logger.LogInformation("Creating mock anonymous user: {UserName}", userName);
+        _logger.CreatingMockAnonymousUser(userName);
 
         var user = new AnonymousUser
         {
@@ -43,22 +44,22 @@ public Task<AnonymousUser> CreateAnonUser(string userName)
     /// <inheritdoc />
     public Task<int> DeleteAnonUsers()
     {
-        _logger.LogInformation("Deleting stale anonymous users");
+        _logger.DeletingStaleAnonymousUsers();
 
         // Delete users older than 3 months
         DateTimeOffset cutoffDate = DateTimeOffset.UtcNow.AddMonths(-3);
         int count = _users.RemoveAll(u => 
             (u.LastLoginAt == null && u.CreatedAt < cutoffDate) || 
             (u.LastLoginAt != null && u.LastLoginAt < cutoffDate));
 
-        _logger.LogInformation("Deleted {Count} stale anonymous users", count);
+        _logger.DeletedStaleAnonymousUsers(count);
         return Task.FromResult(count);
     }
 
     /// <inheritdoc />
     public Task<AnonymousUser> PromoteAnonUser(string anonymousUserId, string email, string displayName, string password)
     {
-        _logger.LogInformation("Promoting mock anonymous user: {UserId}", anonymousUserId);
+        _logger.PromotingMockAnonymousUser(anonymousUserId);
 
         var user = _users.FirstOrDefault(u => u.Id == anonymousUserId);
         if (user == null)

src/services/identity/Codebreaker.Identity/Extensions/LoggerExtensions.cs

@@ -0,0 +1,60 @@
+using Microsoft.Extensions.Logging;
+
+namespace Codebreaker.Identity.Extensions;
+
+public static partial class LoggerExtensions
+{
+    [LoggerMessage(
+        EventId = 30001,
+        Level = LogLevel.Information,
+        Message = "Creating anonymous user with name {UserName}")]
+    public static partial void CreatingAnonymousUser(this ILogger logger, string userName);
+
+    [LoggerMessage(
+        EventId = 30002,
+        Level = LogLevel.Error,
+        Message = "Failed to create anonymous user {UserName}: {Message}")]
+    public static partial void FailedToCreateAnonymousUser(this ILogger logger, Exception ex, string userName, string message);
+
+    [LoggerMessage(
+        EventId = 30003,
+        Level = LogLevel.Information,
+        Message = "Deleting anonymous users that haven't logged in for at least three months")]
+    public static partial void DeletingStaleAnonymousUsers(this ILogger logger);
+
+    [LoggerMessage(
+        EventId = 30004,
+        Level = LogLevel.Information,
+        Message = "No anonymous users found")]
+    public static partial void NoAnonymousUsersFound(this ILogger logger);
+
+    [LoggerMessage(
+        EventId = 30005,
+        Level = LogLevel.Information,
+        Message = "Deleted anonymous user: {UserId}, {DisplayName}")]
+    public static partial void DeletedAnonymousUser(this ILogger logger, string userId, string? displayName);
+
+    [LoggerMessage(
+        EventId = 30006,
+        Level = LogLevel.Information,
+        Message = "Deleted {Count} anonymous users")]
+    public static partial void DeletedAnonymousUsers(this ILogger logger, int count);
+
+    [LoggerMessage(
+        EventId = 30007,
+        Level = LogLevel.Error,
+        Message = "Failed to delete anonymous users: {Message}")]
+    public static partial void FailedToDeleteAnonymousUsers(this ILogger logger, Exception ex, string message);
+
+    [LoggerMessage(
+        EventId = 30008,
+        Level = LogLevel.Information,
+        Message = "Promoting anonymous user {UserId} to registered user")]
+    public static partial void PromotingAnonymousUser(this ILogger logger, string userId);
+
+    [LoggerMessage(
+        EventId = 30009,
+        Level = LogLevel.Error,
+        Message = "Failed to promote anonymous user {UserId}: {Message}")]
+    public static partial void FailedToPromoteAnonymousUser(this ILogger logger, Exception ex, string userId, string message);
+}

src/services/identity/Codebreaker.Identity/Services/GraphAnonymousUserService.cs

@@ -1,5 +1,6 @@
 using Azure.Identity;
 using Codebreaker.Identity.Configuration;
+using Codebreaker.Identity.Extensions;
 using Codebreaker.Identity.Models;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
@@ -42,7 +43,7 @@ public GraphAnonymousUserService(
     /// <inheritdoc />
     public async Task<AnonymousUser> CreateAnonUser(string userName)
     {
-        _logger.LogInformation("Creating anonymous user with name {UserName}", userName);
+        _logger.CreatingAnonymousUser(userName);
 
         // Generate a secure random password
         string password = GenerateSecurePassword(_options.PasswordLength);
@@ -99,15 +100,15 @@ await _graphClient.Users[createdUser.Id].PatchAsync(new User
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Failed to create anonymous user {UserName}: {Message}", userName, ex.Message);
+            _logger.FailedToCreateAnonymousUser(ex, userName, ex.Message);
             throw;
         }
     }
 
     /// <inheritdoc />
     public async Task<int> DeleteAnonUsers()
     {
-        _logger.LogInformation("Deleting anonymous users that haven't logged in for at least three months");
+        _logger.DeletingStaleAnonymousUsers();
 
         try
         {
@@ -125,7 +126,7 @@ public async Task<int> DeleteAnonUsers()
 
             if (usersToDelete?.Value == null)
             {
-                _logger.LogInformation("No anonymous users found");
+                _logger.NoAnonymousUsersFound();
                 return 0;
             }
 
@@ -163,24 +164,23 @@ createdAtObj is string createdAtStr &&
                 await _graphClient.Users[user.Id].DeleteAsync();
                 deletedCount++;
 
-                _logger.LogInformation("Deleted anonymous user: {UserId}, {DisplayName}", 
-                    user.Id, user.DisplayName);
+                _logger.DeletedAnonymousUser(user.Id, user.DisplayName);
             }
 
-            _logger.LogInformation("Deleted {Count} anonymous users", deletedCount);
+            _logger.DeletedAnonymousUsers(deletedCount);
             return deletedCount;
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Failed to delete anonymous users: {Message}", ex.Message);
+            _logger.FailedToDeleteAnonymousUsers(ex, ex.Message);
             throw;
         }
     }
 
     /// <inheritdoc />
     public async Task<AnonymousUser> PromoteAnonUser(string anonymousUserId, string email, string displayName, string password)
     {
-        _logger.LogInformation("Promoting anonymous user {UserId} to registered user", anonymousUserId);
+        _logger.PromotingAnonymousUser(anonymousUserId);
 
         try
         {
@@ -245,7 +245,7 @@ await _graphClient.Users[anonymousUserId].PatchAsync(new User
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "Failed to promote anonymous user {UserId}: {Message}", anonymousUserId, ex.Message);
+            _logger.FailedToPromoteAnonymousUser(ex, anonymousUserId, ex.Message);
             throw;
         }
     }