Added logs for Core.Compactor

Author: Iridium-IO

CompactGUI.Core/CompactGUI.Core.csproj

@@ -20,4 +20,9 @@
     <PackageReference Include="ZLinq" Version="1.4.10" />
   </ItemGroup>
 
+  
+  <ItemGroup>
+    <ProjectReference Include="..\CompactGUI.Logging\CompactGUI.Logging.csproj" />
+  </ItemGroup>
+
 </Project>

CompactGUI.Core/Compactor.cs

@@ -1,4 +1,7 @@
 
+using CompactGUI.Logging.Core;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Win32.SafeHandles;
 using System.Collections.Concurrent;
 using System.Diagnostics;
@@ -23,13 +26,14 @@ public class Compactor : ICompressor, IDisposable
     private readonly SemaphoreSlim pauseSemaphore = new SemaphoreSlim(1, 2);
     private readonly CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
 
+    private ILogger<Compactor> _logger;
 
-    public Compactor(string folderPath, WOFCompressionAlgorithm compressionLevel, string[] excludedFileTypes)
+    public Compactor(string folderPath, WOFCompressionAlgorithm compressionLevel, string[] excludedFileTypes, ILogger<Compactor>? logger = null)
     {
         workingDirectory = folderPath;
         excludedFileExtensions = new HashSet<string>(excludedFileTypes);
         wofCompressionAlgorithm = compressionLevel;
-
+        _logger = logger ?? NullLogger<Compactor>.Instance;
         InitializeCompressionInfoPointer();
     }
 
@@ -47,14 +51,18 @@ public async Task<bool> RunAsync(List<string> filesList, IProgress<CompressionPr
     {
         if(cancellationTokenSource.IsCancellationRequested) { return false; }
 
+        CompactorLog.BuildingWorkingFilesList(_logger, workingDirectory);
         var workingFiles = await BuildWorkingFilesList().ConfigureAwait(false);
         long totalFilesSize = workingFiles.Sum((f) => f.UncompressedSize);
 
         totalProcessedBytes = 0;
 
-        if(maxParallelism <= 0) maxParallelism = Environment.ProcessorCount;
+        var sw = Stopwatch.StartNew();
+
+        if (maxParallelism <= 0) maxParallelism = Environment.ProcessorCount;
         ParallelOptions parallelOptions = new() { MaxDegreeOfParallelism = maxParallelism, CancellationToken = cancellationTokenSource.Token };
 
+        CompactorLog.StartingCompression(_logger, workingDirectory, wofCompressionAlgorithm.ToString(), maxParallelism);
         try
         {
             await Parallel.ForEachAsync(workingFiles, parallelOptions,
@@ -68,11 +76,15 @@ await Parallel.ForEachAsync(workingFiles, parallelOptions,
         catch (OperationCanceledException){ return false; }
         catch (Exception){ return false; }
 
+
+        sw.Stop();
+        CompactorLog.CompressionCompleted(_logger, Math.Round(sw.Elapsed.TotalSeconds, 3));
         return true;
     }
 
     private async Task PauseAndProcessFile(FileDetails file, long totalFilesSize, CancellationToken token, IProgress<CompressionProgress> progressMonitor)
     {
+        CompactorLog.ProcessingFile(_logger, file.FileName, file.UncompressedSize);
 
         await pauseSemaphore.WaitAsync(token).ConfigureAwait(false);
         pauseSemaphore.Release();
@@ -94,7 +106,7 @@ private async Task PauseAndProcessFile(FileDetails file, long totalFilesSize, Ca
         }
         catch (Exception ex)
         {
-            Debug.WriteLine(ex.Message);
+            CompactorLog.FileCompressionFailed(_logger, filePath, ex.Message);
             return null;
         }
     }
@@ -123,18 +135,21 @@ public async Task<IEnumerable<FileDetails>> BuildWorkingFilesList()
 
     public void Pause()
     {
+        CompactorLog.CompressionPaused(_logger);
         pauseSemaphore.Wait(cancellationTokenSource.Token);
     }
 
 
     public void Resume()
     {
+        CompactorLog.CompressionResumed(_logger);
         if (pauseSemaphore.CurrentCount == 0) pauseSemaphore.Release();  
     }
 
 
     public void Cancel()
     {
+        CompactorLog.CompressionCanceled(_logger);
         Resume();
         cancellationTokenSource.Cancel();
     }

CompactGUI.Logging/Core/CompactorLog.cs

@@ -0,0 +1,37 @@
+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 CompactorLog
+{
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Starting compression in directory: {Directory} with algorithm: {Algorithm} and using {MaxParallelism} threads")]
+    public static partial void StartingCompression(ILogger logger, string directory, string algorithm, int maxParallelism);
+
+    [LoggerMessage(Level = LogLevel.Debug, Message = "Building working files list for directory: {Directory}")]
+    public static partial void BuildingWorkingFilesList(ILogger logger, string directory);
+
+    [LoggerMessage(Level = LogLevel.Trace, Message = "Processing file: {FileName} ({UncompressedSize} bytes)")]
+    public static partial void ProcessingFile(ILogger logger, string fileName, long uncompressedSize);
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "File compression failed for: {FileName} with error: {ErrorMessage}")]
+    public static partial void FileCompressionFailed(ILogger logger, string fileName, string errorMessage);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Compression paused.")]
+    public static partial void CompressionPaused(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Compression resumed.")]
+    public static partial void CompressionResumed(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Compression canceled.")]
+    public static partial void CompressionCanceled(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Compression completed successfully in {TimeTaken}s.")]
+    public static partial void CompressionCompleted(ILogger logger, double timeTaken);
+
+}

CompactGUI/Models/NewModels/ICompressableFolder.vb

@@ -7,6 +7,8 @@ Imports CommunityToolkit.Mvvm.ComponentModel
 Imports CompactGUI.Core
 Imports CompactGUI.Core.WOFHelper
 
+Imports Microsoft.Extensions.Logging
+
 Imports PropertyChanged
 
 
@@ -72,10 +74,10 @@ Public MustInherit Class CompressableFolder : Inherits ObservableObject
 
 
     Public Compressor As ICompressor
-
+    Private Shared ReadOnly CompressorLogger As ILogger = Application.GetService(Of ILogger(Of Compactor))()
     Public Async Function CompressFolder() As Task(Of Boolean)
 
-        Compressor = New Compactor(FolderName, WOFConvertCompressionLevel(CompressionOptions.SelectedCompressionMode), GetSkipList)
+        Compressor = New Compactor(FolderName, WOFConvertCompressionLevel(CompressionOptions.SelectedCompressionMode), GetSkipList, CompressorLogger)
         Return Await RunCompressionAsync(Compressor, Nothing, True)
 
     End Function
@@ -180,7 +182,7 @@ Public MustInherit Class CompressableFolder : Inherits ObservableObject
             sw.Start()
             estimatedData = Await Task.Run(Function() estimator.EstimateCompression(AnalysisResults.ToList, IsHDD, GetThreadCount, Core.SharedMethods.GetClusterSize(FolderName), CancellationTokenSource.Token))
             sw.Stop()
-            Debug.WriteLine($"Estimated compression took {sw.ElapsedMilliseconds}ms")
+            'Debug.WriteLine($"Estimated compression took {sw.ElapsedMilliseconds}ms")
         Catch ex As AggregateException
             IsGettingEstimate = False
             Return
@@ -265,11 +267,11 @@ Public MustInherit Class CompressableFolder : Inherits ObservableObject
     Protected Overridable Function GetSkipList() As String()
         Dim exclist As String() = Array.Empty(Of String)()
         If CompressionOptions.SkipPoorlyCompressedFileTypes AndAlso SettingsHandler.AppSettings.NonCompressableList.Count <> 0 Then
-            Debug.WriteLine("Adding non-compressable list to exclusion list")
+            'Debug.WriteLine("Adding non-compressable list to exclusion list")
             exclist = exclist.Union(SettingsHandler.AppSettings.NonCompressableList).ToArray
         End If
         If CompressionOptions.SkipUserSubmittedFiletypes AndAlso WikiPoorlyCompressedFiles?.Count <> 0 Then
-            Debug.WriteLine("Adding estimator poorly compressed list to exclusion list")
+            'Debug.WriteLine("Adding estimator poorly compressed list to exclusion list")
             exclist = exclist.Union(WikiPoorlyCompressedFiles).ToArray
         End If