Stabilize logger-based unit tests by enabling fake ILogger in affected suites (#1318)

* Add source-generated logging methods

* Validate generated logging changes

* Centralize logger messages per project

* Remove redundant partial modifier after logging refactor

* Extract DomainObject log message to centralized LogMessages

* Centralize remaining ILogger log statements in infrastructure and web

* Extend [LoggerMessage] source generation to all projects using ILogger

* fix: enable logger in migrator tests

* fix: enable fake loggers in entities warning-log tests

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: Copilot

backend/extensions/Squidex.Extensions/Actions/Kafka/KafkaProducer.cs

@@ -104,7 +104,7 @@ private static void LogMessage(ILogger<KafkaProducer> log, LogMessage message)
 
     private static void LogError(ILogger<KafkaProducer> log, Error error)
     {
-        log.LogWarning("Kafka error with {code} and {reason}.", error.Code, error.Reason);
+        LogMessages.LogKafkaError(log, error.Code, error.Reason);
     }
 
     public async Task SendAsync(KafkaMessageRequest job,

backend/extensions/Squidex.Extensions/Assets/Azure/AzureMetadataSource.cs

@@ -84,7 +84,7 @@ public async Task EnhanceAsync(UploadAssetCommand command,
         }
         catch (Exception ex)
         {
-            log.LogError(ex, "Failed to enrich asset.");
+            LogMessages.LogFailedToEnrichAsset(log, ex);
         }
     }
 

backend/extensions/Squidex.Extensions/LogMessages.cs

@@ -0,0 +1,19 @@
+// ==========================================================================
+//  Squidex Headless CMS
+// ==========================================================================
+//  Copyright (c) Squidex UG (haftungsbeschraenkt)
+//  All rights reserved. Licensed under the MIT license.
+// ==========================================================================
+
+using Microsoft.Extensions.Logging;
+
+namespace Squidex.Extensions;
+
+internal static partial class LogMessages
+{
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Kafka error with {code} and {reason}.")]
+    public static partial void LogKafkaError(ILogger logger, object code, string reason);
+
+    [LoggerMessage(Level = LogLevel.Error, Message = "Failed to enrich asset.")]
+    public static partial void LogFailedToEnrichAsset(ILogger logger, Exception exception);
+}

backend/src/Squidex.Data.MongoDb/Infrastructure/Counts/LogMessages.cs

@@ -0,0 +1,16 @@
+// ==========================================================================
+//  Squidex Headless CMS
+// ==========================================================================
+//  Copyright (c) Squidex UG (haftungsbeschraenkt)
+//  All rights reserved. Licensed under the MIT license.
+// ==========================================================================
+
+using Microsoft.Extensions.Logging;
+
+namespace Squidex.Infrastructure.Counts;
+
+internal static partial class LogMessages
+{
+    [LoggerMessage(Level = LogLevel.Error, Message = "Failed to update count for collection {collection}.")]
+    public static partial void LogFailedToUpdateCount(ILogger logger, string collection, Exception exception);
+}

backend/src/Squidex.Data.MongoDb/Infrastructure/Counts/MongoCountCollection.cs

@@ -50,7 +50,7 @@ private async Task RefreshSilentAsync(string key, long cachedCount, Func<Cancell
         }
         catch (Exception ex)
         {
-            log.LogError(ex, "Failed to update count for collection {collection}.", collectionName);
+            LogMessages.LogFailedToUpdateCount(log, collectionName, ex);
         }
     }
 

backend/src/Squidex.Domain.Apps.Core.Operations/HandleRules/RuleService.cs

@@ -108,7 +108,7 @@ public IAsyncEnumerable<JobResult> CreateJobsAsync(Envelope<IEvent> @event, Rule
             CreateJobs(@event, context, states, ct)
                 .Catch(ex =>
                 {
-                    log.LogError(ex, "Failed to create rule job.");
+                    LogMessages.LogFailedToCreateRuleJob(log, ex);
 
                     return states.Select(state => JobResult.Skipped(state.Rule, SkipReason.Failed));
                 });
@@ -237,7 +237,7 @@ private async IAsyncEnumerable<JobResult> CreateJobs(Envelope<IEvent> @event, Ru
                 CreateTriggerJobs(typed, triggerHandler, rulesByTrigger, context, ct)
                     .Catch(ex =>
                     {
-                        log.LogError(ex, "Failed to create rule jobs from trigger.");
+                        LogMessages.LogFailedToCreateRuleJobsFromTrigger(log, ex);
 
                         return states.Select(state => JobResult.Skipped(state.Rule, SkipReason.Failed));
                     });
@@ -263,7 +263,7 @@ private async IAsyncEnumerable<JobResult> CreateTriggerJobs(Envelope<AppEvent> @
                 CreateEventJobs(@event, enrichedEvent, triggerHandler, states, context)
                     .Catch(ex =>
                     {
-                        log.LogError(ex, "Failed to create rule jobs from event.");
+                        LogMessages.LogFailedToCreateRuleJobsFromEvent(log, ex);
 
                         return states.Select(state =>
                             new JobResult

backend/src/Squidex.Domain.Apps.Core.Operations/LogMessages.cs

@@ -0,0 +1,22 @@
+// ==========================================================================
+//  Squidex Headless CMS
+// ==========================================================================
+//  Copyright (c) Squidex UG (haftungsbeschraenkt)
+//  All rights reserved. Licensed under the MIT license.
+// ==========================================================================
+
+using Microsoft.Extensions.Logging;
+
+namespace Squidex.Domain.Apps.Core;
+
+internal static partial class LogMessages
+{
+    [LoggerMessage(Level = LogLevel.Error, Message = "Failed to create rule job.")]
+    public static partial void LogFailedToCreateRuleJob(ILogger logger, Exception exception);
+
+    [LoggerMessage(Level = LogLevel.Error, Message = "Failed to create rule jobs from trigger.")]
+    public static partial void LogFailedToCreateRuleJobsFromTrigger(ILogger logger, Exception exception);
+
+    [LoggerMessage(Level = LogLevel.Error, Message = "Failed to create rule jobs from event.")]
+    public static partial void LogFailedToCreateRuleJobsFromEvent(ILogger logger, Exception exception);
+}

backend/src/Squidex.Domain.Apps.Entities/Assets/RecursiveDeleter.cs

@@ -58,7 +58,7 @@ async Task PublishAsync(SquidexCommand command)
             }
             catch (Exception ex)
             {
-                log.LogError(ex, "Failed to delete asset recursively.");
+                LogMessages.LogFailedToDeleteAssetRecursively(log, ex);
             }
         }
 

backend/src/Squidex.Domain.Apps.Entities/Backup/RestoreJob.cs

@@ -107,7 +107,7 @@ public async Task RunAsync(JobRunContext context,
             await context.LogAsync("  * Restore all objects like app, schemas and contents");
             await context.LogAsync("  * Complete the restore operation for all objects");
             await context.FlushAsync();
-            log.LogInformation("Backup with job id {backupId} with from URL '{url}' started.", context.Job.Id, state.Url);
+            LogMessages.LogRestoreJobStarted(log, context.Job.Id, state.Url);
 
             state.Reader = await DownloadAsync(context, state, ct);
 
@@ -147,7 +147,7 @@ public async Task RunAsync(JobRunContext context,
             await AssignContributorAsync(context, state);
             await context.LogAsync("Completed, Yeah!");
 
-            log.LogInformation("Backup with job id {backupId} from URL '{url}' completed.", context.Job.Id, state.Url);
+            LogMessages.LogRestoreJobCompleted(log, context.Job.Id, state.Url);
         }
         catch (Exception ex)
         {
@@ -168,7 +168,7 @@ public async Task RunAsync(JobRunContext context,
 
             await context.LogAsync(message);
 
-            log.LogError(ex, "Backup with job id {backupId} from URL '{url}' failed.", context.Job.Id, state.Url);
+            LogMessages.LogRestoreJobFailed(log, context.Job.Id, state.Url, ex);
             throw;
         }
         finally
@@ -231,7 +231,7 @@ private async Task CleanupAsync(State state)
             }
             catch (Exception ex)
             {
-                log.LogError(ex, "Failed to clean up restore.");
+                LogMessages.LogFailedToCleanUpRestore(log, ex);
             }
         }
     }

backend/src/Squidex.Domain.Apps.Entities/Collaboration/CommentCollaborationHandler.cs

@@ -116,7 +116,7 @@ public ValueTask OnDocumentLoadedAsync(DocumentLoadEvent @event)
                 catch (Exception ex)
                 {
                     // We are in an extra task, so the exception would be probably swallowed.
-                    log.LogError(ex, "Failed to handle yjs event.");
+                    LogMessages.LogFailedToHandleYjsEvent(log, ex);
                     throw;
                 }
             });