Added base logging for Analyser class

Author: Iridium-IO

CompactGUI.Core/Analyser.cs

@@ -1,5 +1,8 @@
-using System.Collections.Concurrent;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+using System.Collections.Concurrent;
 using System.Diagnostics;
+using CompactGUI.Logging.Core;
 
 namespace CompactGUI.Core;
 
@@ -12,18 +15,22 @@ public class Analyser
     public bool ContainsCompressedFiles { get; set; }
     public List<AnalysedFileDetails> FileCompressionDetailsList { get; set; } = new List<AnalysedFileDetails>();
 
+    private ILogger<Analyser> _logger;
 
-    public Analyser(string folder)
+    public Analyser(string folder, ILogger<Analyser> logger)
     {
         FolderName = folder;
         UncompressedBytes = 0;
         CompressedBytes = 0;
         ContainsCompressedFiles = false;
+        _logger = logger;
     }
 
 
     public async Task<Boolean?> AnalyseFolder(CancellationToken cancellationToken)
     {
+        AnalyserLog.StartingAnalysis(_logger, FolderName);
+        Stopwatch sw = Stopwatch.StartNew();
         try
         {
             var allFiles = await Task.Run(() => Directory.EnumerateFiles(FolderName, "*", new EnumerationOptions { RecurseSubdirectories = true, IgnoreInaccessible = true, AttributesToSkip = FileAttributes.ReparsePoint }).AsShortPathNames(), cancellationToken).ConfigureAwait(false);
@@ -39,22 +46,25 @@ public Analyser(string folder)
             ContainsCompressedFiles = fileDetails.Any(f => f.CompressionMode != WOFCompressionAlgorithm.NO_COMPRESSION);
 
             FileCompressionDetailsList = fileDetails;
-
-            return ContainsCompressedFiles;
         }
         catch (Exception ex)
         {
-            Debug.WriteLine(ex.Message);
+            AnalyserLog.AnalysisFailed(_logger, FolderName, ex.Message);
             return null;
         }
+        finally { sw.Stop(); }
+        
+        AnalyserLog.AnalysisCompleted(_logger, FolderName, Math.Round(sw.Elapsed.TotalSeconds, 3), CompressedBytes, UncompressedBytes, ContainsCompressedFiles);
 
+        return ContainsCompressedFiles;
 
 
     }
 
 
     private AnalysedFileDetails? AnalyseFile(string file)
     {
+        AnalyserLog.ProcessingFile(_logger, file);
         try
         {
             FileInfo fileInfo = new FileInfo(file);
@@ -67,8 +77,9 @@ public Analyser(string folder)
 
             return new AnalysedFileDetails { FileName = file, CompressedSize = compressedSize, UncompressedSize = uncompressedSize, CompressionMode = compressionMode, FileInfo = fileInfo };
         }
-        catch (IOException)
+        catch (IOException ex)
         {
+            AnalyserLog.ProcessingFileFailed(_logger, file, ex.Message);
             return null;
         }
     }

CompactGUI.Core/Compactor.cs

@@ -116,7 +116,7 @@ public async Task<IEnumerable<FileDetails>> BuildWorkingFilesList()
     {
         uint clusterSize = SharedMethods.GetClusterSize(workingDirectory);
 
-        var analyser = new Analyser(workingDirectory);
+        var analyser = new Analyser(workingDirectory, NullLogger<Analyser>.Instance);
         var ret = await analyser.AnalyseFolder(cancellationTokenSource.Token);
 
         var filesList = analyser.FileCompressionDetailsList

CompactGUI.Logging/Core/AnalyserLog.cs

@@ -0,0 +1,31 @@
+using Microsoft.Extensions.Logging;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CompactGUI.Logging.Core;
+
+public static partial class AnalyserLog
+{
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Starting analysis of directory: {Directory}")]
+    public static partial void StartingAnalysis(ILogger logger, string directory);
+
+    [LoggerMessage(Level = LogLevel.Trace, Message = "Processing file: {FileName}")]
+    public static partial void ProcessingFile(ILogger logger, string fileName);
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Processing file failed: {FileName} with message: {Message}")]
+    public static partial void ProcessingFileFailed(ILogger logger, string fileName, string message);
+
+
+    [LoggerMessage(Level = LogLevel.Trace, Message = "Processing folder: {FolderName}")]
+    public static partial void ProcessingFolder(ILogger logger, string folderName);
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Analysis failed for: {Path} with error: {ErrorMessage}")]
+    public static partial void AnalysisFailed(ILogger logger, string path, string errorMessage);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Analysis completed for directory: {Directory} in {TimeTaken}s. Uncompressed Size: {UncompressedBytes}b, CompressedSize: {CompressedBytes}b, ContainsCompressedFiles: {ContainsCompressedFiles}")]
+    public static partial void AnalysisCompleted(ILogger logger, string directory, double timeTaken, long compressedBytes, long uncompressedBytes, bool containsCompressedFiles);
+}

CompactGUI.Watcher/BackgroundCompactor.vb

@@ -1,6 +1,8 @@
 Imports System.Collections.ObjectModel
 Imports System.Threading
 
+Imports Microsoft.Extensions.Logging.Abstractions
+
 Public Class BackgroundCompactor
 
     Public Property IsCompactorActive As Boolean = False
@@ -96,7 +98,7 @@ Public Class BackgroundCompactor
             If result AndAlso folders.Contains(folder) Then
                 ' Ensure the folder is still in the original collection before updating
 
-                Dim analyser As New Core.Analyser(folder.Folder)
+                Dim analyser As New Core.Analyser(folder.Folder, NullLogger(Of Core.Analyser).Instance)
 
                 Await analyser.AnalyseFolder(Nothing)
 

CompactGUI.Watcher/CompactGUI.Watcher.vbproj

@@ -15,6 +15,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="9.0.5" />
     <PackageReference Include="PropertyChanged.Fody" Version="4.1.0" PrivateAssets="All" />
   </ItemGroup>
 

CompactGUI.Watcher/Watcher.vb

@@ -1,9 +1,13 @@
 Imports System.Collections.ObjectModel
 Imports System.Text.Json
-Imports CompactGUI.Core
 Imports System.Threading
+
 Imports CommunityToolkit.Mvvm.ComponentModel
 
+Imports CompactGUI.Core
+
+Imports Microsoft.Extensions.Logging.Abstractions
+
 <PropertyChanged.AddINotifyPropertyChangedInterface>
 Public Class Watcher : Inherits ObservableObject
     <PropertyChanged.AlsoNotifyFor(NameOf(TotalSaved))>
@@ -325,7 +329,7 @@ Public Class Watcher : Inherits ObservableObject
 
     Public Async Function Analyse(folder As String, checkDiskModified As Boolean) As Task(Of Boolean)
         Debug.WriteLine("Background Analysing: " & folder)
-        Dim analyser As New Analyser(folder)
+        Dim analyser As New Analyser(folder, NullLogger(Of Analyser).Instance)
 
         Dim watched = WatchedFolders.First(Function(f) f.Folder = folder)
         watched.IsWorking = True

CompactGUI/Models/NewModels/ICompressableFolder.vb

@@ -119,6 +119,8 @@ Public MustInherit Class CompressableFolder : Inherits ObservableObject
     Private CancellationTokenSource As CancellationTokenSource
 
     Public Analyser As Analyser
+    Private Shared ReadOnly AnalyserLogger As ILogger = Application.GetService(Of ILogger(Of Analyser))()
+
 
     Public Async Function AnalyseFolderAsync() As Task(Of Integer)
 
@@ -129,7 +131,7 @@ Public MustInherit Class CompressableFolder : Inherits ObservableObject
         CancellationTokenSource = New CancellationTokenSource()
         Dim token = CancellationTokenSource.Token
 
-        Analyser = New Analyser(FolderName)
+        Analyser = New Analyser(FolderName, AnalyserLogger)
 
         If Not Core.SharedMethods.HasDirectoryWritePermission(FolderName) Then
             FolderActionState = ActionState.Idle