Added logs for snackbar updates

Author: Iridium-IO

CompactGUI.Core/Compactor.cs

@@ -27,7 +27,9 @@ public class Compactor : ICompressor, IDisposable
     public Compactor(string folderPath, WOFCompressionAlgorithm compressionLevel, string[] excludedFileTypes)
     {
         workingDirectory = folderPath;
-        excludedFileExtensions = new HashSet<string>(excludedFileTypes);
+        excludedFileExtensions = new HashSet<string>(excludedFileTypes).MyTag();
+
+        int sum = 1 + 2.MyTag();
         wofCompressionAlgorithm = compressionLevel;
 
         InitializeCompressionInfoPointer();
@@ -156,3 +158,8 @@ public void Dispose()
 
 
 }
+
+public static class MyTagExtensions
+{
+    public static T MyTag<T>(this T obj) => obj;
+}

CompactGUI.Logging/SnackbarServiceLog.cs

@@ -0,0 +1,35 @@
+using Microsoft.Extensions.Logging;
+
+namespace CompactGUI.Logging;
+
+public static partial class SnackbarServiceLog
+{
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Invalid Folder {FolderName}: {message}")]
+    public static partial void ShowInvalidFoldersMessage(ILogger logger, string FolderName, string message);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing insufficient permission snackbar for folder: {FolderName}")]
+    public static partial void ShowInsufficientPermission(ILogger logger, string folderName);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing update available snackbar for version: {NewVersion}, pre-release: {IsPreRelease}")]
+    public static partial void ShowUpdateAvailable(ILogger logger, string newVersion, bool isPreRelease);
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Showing failed to submit to wiki snackbar.")]
+    public static partial void ShowFailedToSubmitToWiki(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing submitted to wiki snackbar for UID: {UID}, Game: {GameName}, SteamID: {SteamID}, Compression: {CompressionMode}")]
+    public static partial void ShowSubmittedToWiki(ILogger logger, string UID, string GameName, string SteamID, string CompressionMode);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing applied to all folders snackbar.")]
+    public static partial void ShowAppliedToAllFolders(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Warning, Message = "Showing cannot remove folder snackbar.")]
+    public static partial void ShowCannotRemoveFolder(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing added to queue snackbar.")]
+    public static partial void ShowAddedToQueue(ILogger logger);
+
+    [LoggerMessage(Level = LogLevel.Information, Message = "Showing DirectStorage warning for: {DisplayName}")]
+    public static partial void ShowDirectStorageWarning(ILogger logger, string displayName);
+
+}

CompactGUI/Services/CustomSnackBarService.vb

@@ -1,14 +1,23 @@
 Imports CommunityToolkit.Mvvm.Input
 
 Imports CompactGUI.Core.SharedMethods
+Imports CompactGUI.Logging
+
+Imports Microsoft.Extensions.Logging
 
 Imports Wpf.Ui.Controls
 
 Public Class CustomSnackBarService
     Inherits Wpf.Ui.SnackbarService
 
+    Private ReadOnly logger As ILogger(Of CustomSnackBarService)
     Public _snackbar As Snackbar
 
+    Public Sub New(logger As ILogger(Of CustomSnackBarService))
+        MyBase.New()
+        Me.logger = logger
+    End Sub
+
     Public Sub ShowCustom(message As UIElement, title As String, appearance As ControlAppearance, Optional icon As IconElement = Nothing, Optional timeout As TimeSpan = Nothing)
 
         If GetSnackbarPresenter() Is Nothing Then Throw New InvalidOperationException("The SnackbarPresenter was never set")
@@ -29,11 +38,11 @@ Public Class CustomSnackBarService
 
         Dim messageString = ""
         For i = 0 To InvalidFolders.Count - 1
-            If InvalidMessages(i) = FolderVerificationResult.InsufficientPermission Then
+            SnackbarServiceLog.ShowInvalidFoldersMessage(logger, InvalidFolders(i), GetFolderVerificationMessage(InvalidMessages(i)))
+            If InvalidFolders.Count = 1 AndAlso InvalidMessages(i) = FolderVerificationResult.InsufficientPermission Then
                 ShowInsufficientPermission(InvalidFolders(i))
                 Return
             End If
-
             messageString &= $"{InvalidFolders(i)}: {GetFolderVerificationMessage(InvalidMessages(i))}" & vbCrLf
         Next
 
@@ -55,6 +64,7 @@ Public Class CustomSnackBarService
         textBlock.Text = "Click to download"
 
         ' Show the custom snackbar
+        SnackbarServiceLog.ShowUpdateAvailable(logger, newVersion, isPreRelease)
         ShowCustom(textBlock, $"Update Available ▸ Version {newVersion}", If(isPreRelease, ControlAppearance.Info, ControlAppearance.Success), timeout:=TimeSpan.FromSeconds(10))
 
         Dim handler As MouseButtonEventHandler = Nothing
@@ -77,23 +87,28 @@ Public Class CustomSnackBarService
 
     Public Sub ShowFailedToSubmitToWiki()
         Show("Failed to submit to wiki", "Please check your internet connection and try again", Wpf.Ui.Controls.ControlAppearance.Danger, Nothing, TimeSpan.FromSeconds(5))
+        SnackbarServiceLog.ShowFailedToSubmitToWiki(logger)
     End Sub
 
     Public Sub ShowSubmittedToWiki(steamsubmitdata As SteamSubmissionData, compressionMode As Integer)
         Show("Submitted to wiki", $"UID: {steamsubmitdata.UID}{vbCrLf}Game: {steamsubmitdata.GameName}{vbCrLf}SteamID: {steamsubmitdata.SteamID}{vbCrLf}Compression: {[Enum].GetName(GetType(Core.WOFCompressionAlgorithm), Core.WOFHelper.WOFConvertCompressionLevel(compressionMode))}", Wpf.Ui.Controls.ControlAppearance.Success, Nothing, TimeSpan.FromSeconds(10))
+        SnackbarServiceLog.ShowSubmittedToWiki(logger, steamsubmitdata.UID, steamsubmitdata.GameName, steamsubmitdata.SteamID, steamsubmitdata.CompressionMode)
     End Sub
 
 
     Public Sub ShowAppliedToAllFolders()
         Show("Applied to all folders", "Compression options have been applied to all folders", Wpf.Ui.Controls.ControlAppearance.Success, Nothing, TimeSpan.FromSeconds(5))
+        SnackbarServiceLog.ShowAppliedToAllFolders(logger)
     End Sub
 
     Public Sub ShowCannotRemoveFolder()
         Show("Cannot remove folder", "Please wait until the current operation is finished", Wpf.Ui.Controls.ControlAppearance.Caution, Nothing, TimeSpan.FromSeconds(5))
+        SnackbarServiceLog.ShowCannotRemoveFolder(logger)
     End Sub
 
     Public Sub ShowAddedToQueue()
         Show("Success", "Added to Queue", Wpf.Ui.Controls.ControlAppearance.Success, Nothing, TimeSpan.FromSeconds(5))
+        SnackbarServiceLog.ShowAddedToQueue(logger)
     End Sub
 
     Public Sub ShowDirectStorageWarning(displayName As String)
@@ -102,6 +117,6 @@ Public Class CustomSnackBarService
             Wpf.Ui.Controls.ControlAppearance.Info,
             Nothing,
             TimeSpan.FromSeconds(20))
-
+        SnackbarServiceLog.ShowDirectStorageWarning(logger, displayName)
     End Sub
 End Class