add detailed logging

Author: kentico-ericd

README.md

@@ -36,7 +36,7 @@ The anonymization/deanonymization process will _only_ run if there are two appli
 
 Add these keys to your `web.config` with the desired salt, and upon the next application start, the database will be anonymized. A new settings key (installed automatically) named "XperienceCommunityDatabaseAnonymized" tracks the current state of the database, so it is safe to leave these keys in the `web.config`- the process will only run once.
 
-The anonymization process runs in the background on application start. To monitor its progress, check the __Event log__ for "ANONYMIZE_START" and "ANONYMIZE_END" events (or, the equivalent "DEANONYMIZE" events). To restore the database to its original state, set the "XperienceCommunityEnableAnonymization" key to false. If you are shipping the entire project (not just the sanitized database), be sure to remove the salt from the `web.config`!
+The anonymization process runs in the background on application start. To monitor its progress, check the __Event log__ for "ANONYMIZE_START" and "ANONYMIZE_END" events (or, the equivalent "DEANONYMIZE" events). The "END" event will contain a detailed description of the process and modified records. To restore the database to its original state, set the "XperienceCommunityEnableAnonymization" key to false. If you are shipping the entire project (not just the sanitized database), be sure to remove the salt from the `web.config`!
 
 ## Full Instructions
 

src/Services/AnonymizationLogger.cs

@@ -0,0 +1,72 @@
+using System.Text;
+
+using CMS;
+using CMS.Helpers;
+
+using XperienceCommunity.DatabaseAnonymizer.Services;
+
+[assembly: RegisterImplementation(typeof(IAnonymizationLogger), typeof(AnonymizationLogger))]
+namespace XperienceCommunity.DatabaseAnonymizer.Services
+{
+    public class AnonymizationLogger : IAnonymizationLogger
+    {
+        private DateTime? mEnd;
+        private DateTime? mStart;
+        private readonly Dictionary<string, int> mModifications = [];
+
+
+        public void LogEnd() => mEnd = DateTime.Now;
+
+
+        public void LogModification(string table, int rowsModified)
+        {
+            if (rowsModified <= 0)
+            {
+                return;
+            }
+
+            if (!mModifications.ContainsKey(table))
+            {
+                mModifications.Add(table, rowsModified);
+
+                return;
+            }
+
+            int modifications = mModifications[table];
+            mModifications[table] = modifications + rowsModified;
+        }
+
+
+        public void LogStart() => mStart = DateTime.Now;
+
+
+        public string GetLog()
+        {
+            var msgBuilder = new StringBuilder();
+            foreach (string table in mModifications.Keys)
+            {
+                msgBuilder
+                    .Append("- [")
+                    .Append(table)
+                    .Append("] updated ")
+                    .Append(mModifications[table])
+                    .AppendLine(" rows");
+            }
+
+            return $"Process finished in {GetMinutes()} minutes:{Environment.NewLine}{msgBuilder}";
+        }
+
+
+        private int GetMinutes()
+        {
+            if (mStart is null || mEnd is null)
+            {
+                return 0;
+            }
+
+            double seconds = (mEnd - mStart).Value.TotalSeconds;
+
+            return ValidationHelper.GetInteger(Math.Ceiling(seconds / 60), 0);
+        }
+    }
+}

src/Services/AnonymizerService.cs

@@ -15,7 +15,8 @@ namespace XperienceCommunity.DatabaseAnonymizer.Services
     public class AnonymizerService(
         IEventLogService eventLogService,
         IAnonymizationTableProvider anonymizationTableProvider,
-        IAppSettingsService appSettingsService) : IAnonymizerService
+        IAppSettingsService appSettingsService,
+        IAnonymizationLogger anonmyzationLogger) : IAnonymizerService
     {
         private byte[]? mKey;
         private string? mSalt;
@@ -26,6 +27,7 @@ public class AnonymizerService(
         private const string ANONYMIZE_ENABLED_KEYNAME = "XperienceCommunityEnableAnonymization";
         private readonly IEventLogService eventLogService = eventLogService;
         private readonly IAppSettingsService appSettingsService = appSettingsService;
+        private readonly IAnonymizationLogger anonymizationLogger = anonmyzationLogger;
         private readonly IAnonymizationTableProvider anonymizationTableProvider = anonymizationTableProvider;
 
         /// <summary>
@@ -118,7 +120,8 @@ private void ModifyTable(string table, bool anonymize)
                 if (updateStatements.Any())
                 {
                     string query = string.Join(Environment.NewLine, updateStatements);
-                    ConnectionHelper.ExecuteNonQuery(query, null, QueryTypeEnum.SQLQuery);
+                    int rowsModified = ConnectionHelper.ExecuteNonQuery(query, null, QueryTypeEnum.SQLQuery);
+                    anonymizationLogger.LogModification(table, rowsModified);
                 }
 
                 currentPage++;
@@ -217,13 +220,17 @@ private string GetUpdateRowStatement(
         }
 
 
-        private void SetProcessStarted(bool isAnonymized) =>
+        private void SetProcessStarted(bool isAnonymized)
+        {
+            anonymizationLogger.LogStart();
             eventLogService.LogInformation(nameof(AnonymizerService), isAnonymized ? "ANONYMIZE_START" : "DEANONYMIZE_START");
+        }
 
 
         private void SetProcessFinished(bool isAnonymized)
         {
-            eventLogService.LogInformation(nameof(AnonymizerService), isAnonymized ? "ANONYMIZE_END" : "DEANONYMIZE_END");
+            anonymizationLogger.LogEnd();
+            eventLogService.LogInformation(nameof(AnonymizerService), isAnonymized ? "ANONYMIZE_END" : "DEANONYMIZE_END", anonymizationLogger.GetLog());
             SettingsKeyInfoProvider.SetGlobalValue(ISANONYMIZED_SETTINGNAME, isAnonymized);
         }
 

src/Services/IAnonymizationLogger.cs

@@ -0,0 +1,33 @@
+namespace XperienceCommunity.DatabaseAnonymizer.Services
+{
+    /// <summary>
+    /// Contains methods for recording anonymization operations.
+    /// </summary>
+    public interface IAnonymizationLogger
+    {
+        /// <summary>
+        /// Logs the start time of the anonymization process.
+        /// </summary>
+        void LogStart();
+
+
+        /// <summary>
+        /// Updates the number of rows modified for a table.
+        /// </summary>
+        /// <param name="table">The database table.</param>
+        /// <param name="rowsModified">The number of rows modified.</param>
+        void LogModification(string table, int rowsModified);
+
+
+        /// <summary>
+        /// Logs the end time of the anonymization process.
+        /// </summary>
+        void LogEnd();
+
+
+        /// <summary>
+        /// Gets a string summarizing the anonymization process suitable for the Event log.
+        /// </summary>
+        string GetLog();
+    }
+}