Logging

Author: AnakinRaW

src/AET.SteamAbstraction/Library/SteamLibrary.cs

@@ -66,7 +66,7 @@ public IEnumerable<SteamAppManifest> GetApps()
             }
             catch (SteamException e)
             {
-                _logger?.LogWarning(e, $"Could not read game manifest file '{manifestFile}': {e.Message}");
+                _logger?.LogWarning(e, "Could not read game manifest file '{ManifestFile}': {Message}", manifestFile, e.Message);
             }
         }
         return apps;

src/AET.SteamAbstraction/Library/SteamLibraryFinder.cs

@@ -45,12 +45,12 @@ public IEnumerable<ISteamLibrary> FindLibraries(IDirectoryInfo steamInstallDir)
 
     private bool TryCreateLibraryFromLocation(IDirectoryInfo libraryLocation, bool isDefault, [NotNullWhen(true)] out SteamLibrary? library)
     {
-        _logger?.LogTrace($"Try creating steam library from location '{libraryLocation.FullName}'");
+        _logger?.LogTrace("Try creating steam library from location '{Library}'", libraryLocation.FullName);
         library = null;
 
         if (!libraryLocation.Exists)
         {
-            _logger?.LogTrace($"Steam library location '{libraryLocation.FullName}' does not exist. Library not created.");
+            _logger?.LogTrace("Steam library location '{Library}' does not exist. Library not created.", libraryLocation.FullName);
             return false;
         }
 
@@ -59,7 +59,7 @@ private bool TryCreateLibraryFromLocation(IDirectoryInfo libraryLocation, bool i
             var steamDll = _fileSystem.Path.Combine(libraryLocation.FullName, SteamDllFileName);
             if (!_fileSystem.File.Exists(steamDll))
             {
-                _logger?.LogTrace($"Steam library location '{libraryLocation.FullName}' does not contain 'steam.dll'. Library not created.");
+                _logger?.LogTrace("Steam library location '{Library}' does not contain 'steam.dll'. Library not created.", libraryLocation.FullName);
                 return false;
             }
         }
@@ -75,7 +75,7 @@ private bool TryCreateLibraryFromLocation(IDirectoryInfo libraryLocation, bool i
         var libraryVdf = _fileSystem.Path.Combine(libraryLocation.FullName, libraryVdfSubPath, libraryVdfName);
         if (!_fileSystem.File.Exists(libraryVdf))
         {
-            _logger?.LogTrace($"Steam library VDF file '{libraryVdf}' was not found. Library not created.");
+            _logger?.LogTrace("Steam library VDF file '{Library}' was not found. Library not created.", libraryVdf);
             return false;
         }
 

src/PG.StarWarsGame.Infrastructure/Clients/PetroglyphStarWarsGameClient.cs

@@ -90,7 +90,7 @@ public IGameProcess Debug(ArgumentCollection arguments, bool fallbackToPlay)
             if (!fallbackToPlay)
                 throw new GameStartException(Game, "Debug version of the game could not be found.");
             buildType = GameBuildType.Release;
-            Logger?.LogTrace($"Falling back to release configuration because debug executables of '{Game}' were not found.");
+            Logger?.LogTrace("Falling back to release configuration because debug executables of '{Game}' were not found.", Game);
         }
         return StartGame(arguments, buildType);
     }

src/PG.StarWarsGame.Infrastructure/Clients/Processes/GameProcessLauncher.cs

@@ -18,8 +18,7 @@ public IGameProcess StartGameProcess(IFileInfo executable, GameProcessInfo proce
         {
             var arguments = ArgumentCommandLineBuilder.BuildCommandLine(processInfo.Arguments);
 
-            _logger?.LogDebug(
-                $"Starting game '{processInfo.Game}' with '{processInfo.BuildType}' configuration and with launch arguments '{arguments}'");
+            _logger?.LogDebug("Starting game '{Process}' with '{BuildType}' configuration and with launch arguments '{Args}'", processInfo.Game, processInfo.BuildType, arguments);
 
             var processStartInfo = new ProcessStartInfo(executable.FullName)
             {

src/PG.StarWarsGame.Infrastructure/Services/Detection/Games/CompositeGameDetector.cs

@@ -56,7 +56,7 @@ public GameDetectionResult Detect(GameType gameType, params ICollection<GamePlat
         GameDetectionResult? lastResult = null;
         foreach (var detector in SortedDetectors)
         {
-            _logger?.LogTrace($"Searching for game '{gameType}' with detector: '{detector}'");
+            _logger?.LogTrace("Searching for game '{GameType}' with detector: '{GameDetector}'", gameType, detector);
             detector.InitializationRequested += PassThroughInitializationRequest;
 
             try
@@ -70,7 +70,7 @@ public GameDetectionResult Detect(GameType gameType, params ICollection<GamePlat
             }
             catch (Exception e)
             {
-                _logger?.LogDebug($"Failed detecting game using detector {detector}. {e}");
+                _logger?.LogDebug("Failed detecting game using detector {GameDetector}. {Exception}", detector, e);
                 errors.Add(e);
 
                 if (detector.Equals(SortedDetectors[^1]))

src/PG.StarWarsGame.Infrastructure/Services/Detection/Games/DirectoryGameDetector.cs

@@ -23,7 +23,7 @@ public sealed class DirectoryGameDetector(IDirectoryInfo directory, IServiceProv
     /// <inheritdoc/>
     protected override GameLocationData FindGameLocation(GameType gameType)
     {
-        Logger?.LogTrace($"Searching for game {gameType} at directory: {_directory}");
+        Logger?.LogTrace("Searching for game {GameType} at directory: {DirectoryInfo}", gameType, _directory);
         return !MinimumGameFilesExist(gameType, _directory) ? GameLocationData.NotInstalled : new GameLocationData(_directory);
     }
 }

src/PG.StarWarsGame.Infrastructure/Services/Detection/Games/GameDetectorBase.cs

@@ -76,7 +76,7 @@ public GameDetectionResult Detect(GameType gameType, params ICollection<GamePlat
 
         if (!locationData.IsInstalled)
         {
-            Logger?.LogTrace($"Unable to find an installed game of type {gameType}.");
+            Logger?.LogTrace("Unable to find an installed game of type {GameType}.", gameType);
             return GameDetectionResult.NotInstalled(gameType);
         }
 
@@ -91,20 +91,19 @@ public GameDetectionResult Detect(GameType gameType, params ICollection<GamePlat
         // the detector returned a false result.
         if (!GameExeExists(location, gameType) || !DataAndMegaFilesXmlExists(location))
         {
-            Logger?.LogTrace($"Unable to find the game's executable or megafiles.xml at the given location: {location.FullName}");
+            Logger?.LogTrace("Unable to find the game's executable or megafiles.xml at the given location: {Location}", location.FullName);
             return GameDetectionResult.NotInstalled(gameType);
         }
 
         if (!MatchesOptionsPlatform(platforms, actualPlatform))
         {
             var wrongGameFound = GameDetectionResult.NotInstalled(gameType);
-            Logger?.LogTrace($"Game detected at location: {wrongGameFound.GameLocation?.FullName} " +
-                                   $"but Platform {actualPlatform} was not requested.");
+            Logger?.LogTrace("Game detected at location: {Location} but Platform {Platform} was not requested.", wrongGameFound.GameLocation?.FullName, actualPlatform);
             return wrongGameFound;
         }
 
         var detectedResult = GameDetectionResult.FromInstalled(new GameIdentity(gameType, actualPlatform), location);
-        Logger?.LogDebug($"Game detected: {detectedResult.GameIdentity} at location: '{location.FullName}'");
+        Logger?.LogDebug("Game detected: {Identity} at location: '{Location}'", detectedResult.GameIdentity, location.FullName);
         return detectedResult;
     }
 
@@ -166,7 +165,7 @@ private bool HandleInitialization(GameType gameType, ref GameLocationData locati
         if (!locationData.InitializationRequired)
             return true;
 
-        Logger?.LogDebug($"It appears that the game '{locationData}' exists but it is not initialized. Game type '{gameType}'.");
+        Logger?.LogDebug("It appears that the game '{Location}' exists but it is not initialized. Game type '{GameType}'.", locationData, gameType);
         if (!_tryHandleInitialization)
             return false;
 

src/PG.StarWarsGame.Infrastructure/Services/Detection/Games/Platform/GamePlatformIdentifier.cs

@@ -43,11 +43,11 @@ public GamePlatform GetGamePlatform(GameType type, ref IDirectoryInfo location)
         foreach (var platform in DefaultGamePlatformOrdering)
         {
             var validator = GamePlatformIdentifierFactory.Create(platform, _serviceProvider);
-            _logger?.LogTrace($"Validating location for {platform}...");
+            _logger?.LogTrace("Validating location for {GamePlatform}...", platform);
             if (!validator.IsPlatform(type, ref location))
                 continue;
 
-            _logger?.LogTrace($"Game location was identified as {platform}.");
+            _logger?.LogTrace("Game location was identified as {GamePlatform}.", platform);
             return platform;
         }
 

src/PG.StarWarsGame.Infrastructure/Services/Detection/Games/Platform/OriginIdentifier.cs

@@ -66,7 +66,7 @@ private void TryFixBrokenFocLocation(ref IDirectoryInfo location)
         var correctedPath = location.FileSystem.Path.Combine(parentDir.FullName, "EAWX");
         if (!location.FileSystem.Directory.Exists(correctedPath))
         {
-            Logger?.LogTrace($"Unable to sanitize origin path: Corrected path '{correctedPath}' does not exists.");
+            Logger?.LogTrace("Unable to sanitize origin path: Corrected path '{Path}' does not exists.", correctedPath);
             return;
         }
         location = location.FileSystem.DirectoryInfo.New(correctedPath);

src/PG.StarWarsGame.Infrastructure/Services/Detection/Mods/ModFinder.cs

@@ -26,7 +26,7 @@ public IEnumerable<DetectedModReference> FindMods(IGame game)
             throw new ArgumentNullException(nameof(game));
         if (!game.Exists())
             throw new GameException("The game does not exist");
-        _logger?.LogDebug($"Searching mods for game '{game}'");
+        _logger?.LogDebug("Searching mods for game '{Game}'", game);
         return GetNormalMods(game).Union(GetWorkshopsMods(game));
     }
 
@@ -40,13 +40,13 @@ public IEnumerable<DetectedModReference> FindMods(IGame game, IDirectoryInfo dir
             throw new GameException($"The game '{game}' does not exist");
 
         var modLocationKind = GetModLocationKind(game, directory);
-        _logger?.LogTrace($"Searching mods with at location '{directory.FullName}' of location kind '{modLocationKind}' for game '{game}'");
+        _logger?.LogTrace("Searching mods with at location '{Directory}' of location kind '{Kind}' for game '{Game}'", directory.FullName, modLocationKind, game);
         return GetModsFromDirectory(directory, modLocationKind, game.Type);
     }
 
     private IEnumerable<DetectedModReference> GetNormalMods(IGame game)
     {
-        _logger?.LogTrace($"Searching normal mods for game '{game}'");
+        _logger?.LogTrace("Searching normal mods for game '{Game}'", game);
         return GetAllModsFromContainerPath(game.ModsLocation, ModReferenceBuilder.ModLocationKind.GameModsDirectory, game.Type);
     }
 
@@ -55,7 +55,7 @@ private IEnumerable<DetectedModReference> GetWorkshopsMods(IGame game)
         if (game.Platform != GamePlatform.SteamGold)
             return [];
 
-        _logger?.LogTrace($"Searching Steam Workshop mods for game '{game}'");
+        _logger?.LogTrace("Searching Steam Workshop mods for game '{Game}'", game);
         return GetAllModsFromContainerPath(_steamHelper.GetWorkshopsLocation(game),
             ModReferenceBuilder.ModLocationKind.SteamWorkshops, game.Type);
     }
@@ -81,7 +81,7 @@ private IEnumerable<DetectedModReference> GetModsFromDirectory(
         if (locationKind == ModReferenceBuilder.ModLocationKind.SteamWorkshops && !_steamHelper.ToSteamWorkshopsId(modDirectory.Name, out _))
             yield break;
 
-        _logger?.LogTrace($"Searching for mods at location '{modDirectory.FullName}'");
+        _logger?.LogTrace("Searching for mods at location '{Location}'", modDirectory.FullName);
 
         ModinfoFinderCollection modinfoFiles;
         modinfoFiles = ModinfoFileFinder.FindModinfoFiles(modDirectory);
@@ -90,7 +90,7 @@ private IEnumerable<DetectedModReference> GetModsFromDirectory(
         {
             if (_gameTypeResolver.IsDefinitelyNotCompatibleToGame(modRef, requestedGameType))
             {
-                _logger?.LogTrace($"Skipping mod reference '{modRef.ModReference}' because it is not compatible to '{requestedGameType}'");
+                _logger?.LogTrace("Skipping mod reference '{ModRef}' because it is not compatible to '{GameType}'", modRef.ModReference, requestedGameType);
                 continue;
             }
             yield return modRef;