Reduce logging and make it single line for better searchability

server/GridBattle.Api/Api/TimerBattleHub.cs

@@ -1,3 +1,4 @@
+using GridBattle.Api;
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.EntityFrameworkCore;
 using Polly;
@@ -9,9 +10,6 @@ public sealed class TimerBattleHub(
     ILogger<TimerBattleHub> logger
 ) : Hub
 {
-    private const string USERNAME = "USERNAME";
-    private const string ROOM_ID = "ROOM_ID";
-
     // Using a simple retry policy for DB operations so that we can safely use Optimistic locking
     // In the future, we should investigate better locking methods.
     private readonly ResiliencePipeline<TimerBattleRoom> _retryPipeline =
@@ -60,8 +58,10 @@ public async Task<TimerBattleRoom> CreateBattle(string name)
         await db.SaveChangesAsync();
 
         await Groups.AddToGroupAsync(Context.ConnectionId, newBattle.RoomId);
-        Context.Items[USERNAME] = name;
-        Context.Items[ROOM_ID] = newBattle.RoomId;
+
+        Context.SetUsername(name);
+        Context.SetRoomId(newBattle.RoomId);
+
         logger.LogInformation(
             "{Username} has created a new battle room {RoomId}",
             name,
@@ -115,8 +115,8 @@ public async Task<TimerBattleRoom> JoinBattle(string roomId, string name)
         );
 
         await Groups.AddToGroupAsync(Context.ConnectionId, roomId);
-        Context.Items[USERNAME] = name;
-        Context.Items[ROOM_ID] = roomId;
+        Context.SetUsername(name);
+        Context.SetRoomId(roomId);
 
         logger.LogInformation("{Username} has joined battle room {RoomId}", name, roomId);
         return battle;
@@ -138,8 +138,8 @@ public async Task<bool> LeaveBattle()
             }
         );
 
-        Context.Items.Remove(USERNAME);
-        Context.Items.Remove(ROOM_ID);
+        Context.RemoveRoomId();
+        Context.RemoveUsername();
         logger.LogInformation("{Username} has left the battle room {RoomId}", name, roomId);
         return true;
     }
@@ -287,7 +287,7 @@ public override async Task OnDisconnectedAsync(Exception? exception)
     {
         try
         {
-            var username = Context.Items[USERNAME];
+            var username = Context.GetUsername();
             if (username is not null)
             {
                 logger.LogWarning("Player {Username} disconnected", username);
@@ -415,10 +415,10 @@ await db
     }
 
     private string GetRoomId() =>
-        Context.Items[ROOM_ID]?.ToString()
+        Context.GetRoomId()
         ?? throw new InvalidOperationException("Unexpected error, Room ID not in context");
 
     private string GetUsername() =>
-        Context.Items[USERNAME]?.ToString()
-        ?? throw new InvalidOperationException("Unexpected error, Room ID not in context");
+        Context.GetUsername()
+        ?? throw new InvalidOperationException("Unexpected error, Username not in context");
 }

server/GridBattle.Api/DataCleanupService.cs

@@ -18,13 +18,16 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
         {
             try
             {
-                logger.LogInformation("Searching for stale Timer Battles to remove");
                 using var db = dbContextFactory.CreateDbContext();
                 var modifiedBefore = DateTimeOffset.UtcNow.AddHours(-1);
                 var staleBattleCount = await db
                     .TimerBattleRooms.Where(x => x.ModifiedDateTime < modifiedBefore)
                     .ExecuteDeleteAsync(stoppingToken);
-                logger.LogWarning("Deleted {Count} TimerBattleRooms", staleBattleCount);
+
+                if (staleBattleCount > 0)
+                {
+                    logger.LogWarning("Deleted {Count} TimerBattleRooms", staleBattleCount);
+                }
             }
             catch (Exception e)
             {

server/GridBattle.Api/HubFilter.cs

@@ -1,3 +1,4 @@
+using GridBattle.Data;
 using Microsoft.AspNetCore.SignalR;
 
 namespace GridBattle.Api;
@@ -13,6 +14,9 @@ private sealed record ResponseWrapper(object? Resource, ResponseWrapperError? Er
         Func<HubInvocationContext, ValueTask<object?>> next
     )
     {
+        using var usernameScope = logger.BeginScope("Username:{Username}", invocationContext.Context.GetUsername());
+        using var roomIdScope = logger.BeginScope("RoomId:{RoomId}", invocationContext.Context.GetRoomId());
+
         logger.LogInformation("Calling hub method '{MethodName}'", invocationContext.HubMethodName);
         try
         {

server/GridBattle.Api/Infrastructure/HubCallerContextExtensions.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNetCore.SignalR;
+
+namespace GridBattle.Api;
+
+public static class HubCallerContextExtensions
+{
+    private const string USERNAME = "USERNAME";
+    private const string ROOM_ID = "ROOM_ID";
+
+    public static string? GetUsername(this HubCallerContext context) =>
+        context.Items[USERNAME]?.ToString();
+
+    public static string? GetRoomId(this HubCallerContext context) =>
+        context.Items[ROOM_ID]?.ToString();
+
+    public static void RemoveUsername(this HubCallerContext context) =>
+        context.Items.Remove(USERNAME);
+
+    public static void RemoveRoomId(this HubCallerContext context) => context.Items.Remove(ROOM_ID);
+
+    public static void SetUsername(this HubCallerContext context, string username) =>
+        context.Items[USERNAME] = username;
+
+    public static void SetRoomId(this HubCallerContext context, string roomId) =>
+        context.Items[ROOM_ID] = roomId;
+}

server/GridBattle.Api/Program.cs

@@ -13,6 +13,7 @@
     {
         opt.IncludeScopes = true;
         opt.UseUtcTimestamp = true;
+        opt.SingleLine = true;
         opt.TimestampFormat = "yyyy-MM-dd'T'HH:mm:ss.fff'Z' ";
     });
 

server/GridBattle.Api/appsettings.json

@@ -2,7 +2,7 @@
   "Logging": {
     "LogLevel": {
       "Default": "Information",
-      "Microsoft.AspNetCore.Routing.EndpointMiddleware": "Warning"
+      "Microsoft.AspNetCore": "Warning"
     }
   },
   "AllowedHosts": "*",