Add event-based LogMonitor state changes to better handle batch reads (#59)

* Add event-based LogMonitor state changes to better handle batch reads

Pre-reading hackily used read-all to suppress notifications. But that broke some assumptions about what read-all meant. Furthermore, the Core UI told plugins about read-all rather than the log monitor telling them -- which is really what should be telling them.

To address these concerns, LogMonitor now provides an event that both the PluginCore and PluginEventHandler listens to or tracking logging state allowing more granular information about the activities of LogMonitor, including distinguishing between ReadAll and Pre-read batches. Plugins no longer need to track if LogMonitor is in batch-read mode or not -- PluginCore now provides it. 

I've also converted all built-in plugins to use the new event-based system. The old system is marked deprecated and will go away once other known contributed plugins have converted to the new system.

* Change LogMonitorState enum to [Flags], drop 'None' state

As requested, and did associated simplifications and cleanup that followed.

ObservatoryBotanist/Botanist.cs

@@ -29,7 +29,6 @@ namespace Observatory.Botanist
             > BioPlanets;
         ObservableCollection<object> GridCollection;
         private PluginUI pluginUI;
-        private bool readAllInProgress = false;
         private Guid? samplerStatusNotification = null;
         private BotanistSettings botanistSettings = new()
         {
@@ -102,7 +101,7 @@ namespace Observatory.Botanist
                             {
                                 case ScanOrganicType.Log:
                                 case ScanOrganicType.Sample:
-                                    if (!readAllInProgress && botanistSettings.OverlayEnabled)
+                                    if (!Core.IsLogMonitorBatchReading && botanistSettings.OverlayEnabled)
                                     {
                                         NotificationArgs args = new()
                                         {
@@ -171,22 +170,24 @@ namespace Observatory.Botanist
             Core = observatoryCore;
         }
 
-        public void ReadAllStarted()
+        public void LogMonitorStateChanged(LogMonitorStateChangedEventArgs args)
         {
-            readAllInProgress = true;
-            Core.ClearGrid(this, new BotanistGrid());
-        }
-
-        public void ReadAllFinished()
-        {
-            readAllInProgress = false;
-            UpdateUIGrid();
+            if (LogMonitorStateChangedEventArgs.IsBatchRead(args.NewState))
+            {
+                // Beginning a batch read. Clear grid.
+                Core.ClearGrid(this, new BotanistGrid());
+            }
+            else if (LogMonitorStateChangedEventArgs.IsBatchRead(args.PreviousState))
+            {
+                // Batch read is complete. Show data.
+                UpdateUIGrid();
+            }
         }
 
         private void UpdateUIGrid()
         {
             // Suppress repainting the entire contents of the grid on every ScanOrganic record we read.
-            if (readAllInProgress) return;
+            if (Core.IsLogMonitorBatchReading) return;
 
             BotanistGrid uiObject = new();
             Core.ClearGrid(this, uiObject);

ObservatoryCore/LogMonitor.cs

@@ -4,7 +4,6 @@ using System.IO;
 using System.Linq;
 using System.Reflection;
 using System.Runtime.InteropServices;
-using System.Text.Json.Serialization;
 using Observatory.Framework;
 using Observatory.Framework.Files;
 
@@ -34,6 +33,7 @@ namespace Observatory
             currentLine = new();
             journalTypes = JournalReader.PopulateEventClasses();
             InitializeWatchers(string.Empty);
+            SetLogMonitorState(LogMonitorState.Idle);
         }
 
         #endregion
@@ -50,7 +50,7 @@ namespace Observatory
             }
             journalWatcher.EnableRaisingEvents = true;
             statusWatcher.EnableRaisingEvents = true;
-            monitoring = true;
+            SetLogMonitorState(LogMonitorState.Realtime);
             JournalPoke();
         }
 
@@ -58,7 +58,7 @@ namespace Observatory
         {
             journalWatcher.EnableRaisingEvents = false;
             statusWatcher.EnableRaisingEvents = false;
-            monitoring = false;
+            SetLogMonitorState(LogMonitorState.Idle);
         }
 
         public void ChangeWatchedDirectory(string path)
@@ -70,12 +70,13 @@ namespace Observatory
 
         public bool IsMonitoring()
         {
-            return monitoring;
+            return (currentState & LogMonitorState.Realtime) == LogMonitorState.Realtime;
         }
 
+        // TODO(fredjk_gh): Remove?
         public bool ReadAllInProgress()
         {
-            return readall;
+            return LogMonitorStateChangedEventArgs.IsBatchRead(currentState);
         }
 
         public void ReadAllJournals()
@@ -87,7 +88,8 @@ namespace Observatory
         {
             // Prevent pre-reading when starting monitoring after reading all.
             firstStartMonitor = false;
-            readall = true;
+            SetLogMonitorState(currentState | LogMonitorState.Batch);
+
             DirectoryInfo logDirectory = GetJournalFolder(path);
             var files = logDirectory.GetFiles("Journal.????????????.??.log");
             var readErrors = new List<(Exception ex, string file, string line)>();
@@ -98,13 +100,15 @@ namespace Observatory
             }
 
             ReportErrors(readErrors);
-            readall = false;
+            SetLogMonitorState(currentState & ~LogMonitorState.Batch);
         }
 
         public void PrereadJournals()
         {
             if (!Properties.Core.Default.TryPrimeSystemContextOnStartMonitor) return;
 
+            SetLogMonitorState(currentState | LogMonitorState.PreRead);
+
             DirectoryInfo logDirectory = GetJournalFolder(Properties.Core.Default.JournalFolder);
             var files = logDirectory.GetFiles("Journal.????????????.??.log");
 
@@ -156,15 +160,16 @@ namespace Observatory
                 linesToRead = lastSystemLines;
             }
 
-            readall = true;
             ReportErrors(ProcessLines(linesToRead, "Pre-read"));
-            readall = false;
+            SetLogMonitorState(currentState & ~LogMonitorState.PreRead);
         }
 
         #endregion
 
         #region Public Events
 
+        public event EventHandler<LogMonitorStateChangedEventArgs> LogMonitorStateChanged;
+
         public event EventHandler<JournalEventArgs> JournalEntry;
 
         public event EventHandler<JournalEventArgs> StatusUpdate;
@@ -177,14 +182,27 @@ namespace Observatory
         private FileSystemWatcher statusWatcher;
         private Dictionary<string, Type> journalTypes;
         private Dictionary<string, int> currentLine;
+        private LogMonitorState currentState = LogMonitorState.Idle; // Change via #SetLogMonitorState
         private bool monitoring = false;
-        private bool readall = false;
         private bool firstStartMonitor = true;
 
         #endregion
 
         #region Private Methods
 
+        private void SetLogMonitorState(LogMonitorState newState)
+        {
+            var oldState = currentState;
+            currentState = newState;
+            LogMonitorStateChanged?.Invoke(this, new LogMonitorStateChangedEventArgs
+            {
+                PreviousState = oldState,
+                NewState = newState
+            });;
+
+            System.Diagnostics.Debug.WriteLine("LogMonitor State change: {0} -> {1}", oldState, newState);
+        }
+
         private void InitializeWatchers(string path)
         {
             DirectoryInfo logDirectory = GetJournalFolder(path);

ObservatoryCore/PluginManagement/PluginCore.cs

@@ -11,6 +11,7 @@ namespace Observatory.PluginManagement
 
         private readonly NativeVoice NativeVoice;
         private readonly NativePopup NativePopup;
+        private LogMonitorState currentLogMonitorState = LogMonitorState.Idle;
 
         public PluginCore()
         {
@@ -18,6 +19,11 @@ namespace Observatory.PluginManagement
             NativePopup = new();
         }
 
+        internal void OnLogMonitorStateChanged(object sender, LogMonitorStateChangedEventArgs e)
+        {
+            currentLogMonitorState = e.NewState;
+        }
+
         public string Version => System.Reflection.Assembly.GetEntryAssembly().GetName().Version.ToString();
 
         public Status GetStatus()
@@ -34,7 +40,7 @@ namespace Observatory.PluginManagement
         {
             var guid = Guid.Empty;
 
-            if (!LogMonitor.GetInstance.ReadAllInProgress())
+            if (!IsLogMonitorBatchReading)
             {
                 if (notificationArgs.Rendering.HasFlag(NotificationRendering.PluginNotifier))
                 {
@@ -63,7 +69,7 @@ namespace Observatory.PluginManagement
 
         public void UpdateNotification(Guid id, NotificationArgs notificationArgs)
         {
-            if (!LogMonitor.GetInstance.ReadAllInProgress())
+            if (!IsLogMonitorBatchReading)
             {
 
                 if (notificationArgs.Rendering.HasFlag(NotificationRendering.PluginNotifier))
@@ -134,6 +140,16 @@ namespace Observatory.PluginManagement
             get => Observatory.HttpClient.Client;
         }
 
+        public LogMonitorState CurrentLogMonitorState
+        {
+            get => currentLogMonitorState;
+        }
+
+        public bool IsLogMonitorBatchReading
+        {
+            get => LogMonitorStateChangedEventArgs.IsBatchRead(currentLogMonitorState);
+        }
+
         public event EventHandler<NotificationArgs> Notification;
     }
 }

ObservatoryCore/PluginManagement/PluginEventHandler.cs

@@ -61,6 +61,21 @@ namespace Observatory.PluginManagement
             }
         }
 
+        internal void OnLogMonitorStateChanged(object sender, LogMonitorStateChangedEventArgs e)
+        {
+            foreach (var worker in observatoryWorkers)
+            {
+                try
+                {
+                    worker.LogMonitorStateChanged(e);
+                }
+                catch (Exception ex)
+                {
+                    RecordError(ex, worker.Name, "LogMonitorStateChanged event");
+                }
+            }
+        }
+
         public void OnNotificationEvent(object source, NotificationArgs notificationArgs)
         {
             foreach (var notifier in observatoryNotifiers)

ObservatoryCore/PluginManagement/PluginManager.cs

@@ -46,8 +46,10 @@ namespace Observatory.PluginManagement
 
             logMonitor.JournalEntry += pluginHandler.OnJournalEvent;
             logMonitor.StatusUpdate += pluginHandler.OnStatusUpdate;
+            logMonitor.LogMonitorStateChanged += pluginHandler.OnLogMonitorStateChanged;
 
             var core = new PluginCore();
+            logMonitor.LogMonitorStateChanged += core.OnLogMonitorStateChanged;
 
             List<IObservatoryPlugin> errorPlugins = new();
             

ObservatoryCore/UI/ViewModels/CoreViewModel.cs

@@ -65,8 +65,10 @@ namespace Observatory.UI.ViewModels
 
         public void ReadAll()
         {
+            // TODO(fredjk_gh): remove.
             SetWorkerReadAllState(true);
             LogMonitor.GetInstance.ReadAllJournals();
+            // TODO(fredjk_gh): remove.
             SetWorkerReadAllState(false);
         }
 
@@ -82,8 +84,10 @@ namespace Observatory.UI.ViewModels
             else
             {
                 // HACK: Find a better way of suppressing notifications when pre-reading.
+                // TODO(fredjk_gh): remove.
                 SetWorkerReadAllState(true);
                 logMonitor.Start();
+                // TODO(fredjk_gh): remove.
                 SetWorkerReadAllState(false);
                 ToggleButtonText = "Stop Monitor";
             }
@@ -138,6 +142,7 @@ namespace Observatory.UI.ViewModels
             get { return tabs; }
         }
 
+        // TODO(fredjk_gh): remove.
         private void SetWorkerReadAllState(bool isReadingAll)
         {
             foreach (var worker in workers)

ObservatoryExplorer/Worker.cs

@@ -34,8 +34,7 @@ namespace Observatory.Explorer
         private ObservableCollection<object> resultsGrid;
         private IObservatoryCore Core;
 
-        private bool readAllStarting = false;
-        private bool readAllInProgress = false;
+        private bool recordProcessedSinceBatchStart = false;
 
         public string Name => "Observatory Explorer";
 
@@ -57,12 +56,12 @@ namespace Observatory.Explorer
 
         public void JournalEvent<TJournal>(TJournal journal) where TJournal : JournalBase
         {
-            bool recordProcessed = false;
             switch (journal)
             {
                 case Scan scan:
-                    explorer.ProcessScan(scan, readAllInProgress);
-                    recordProcessed = true;
+                    explorer.ProcessScan(scan, Core.IsLogMonitorBatchReading && recordProcessedSinceBatchStart);
+                    // Set this *after* the first scan processes so that we get the current custom criteria file.
+                    if (Core.IsLogMonitorBatchReading) recordProcessedSinceBatchStart = true;
                     break;
                 case FSSBodySignals signals:
                     explorer.RecordSignal(signals);
@@ -84,24 +83,20 @@ namespace Observatory.Explorer
                     break;
             }
             
-            //Set this *after* the first scan processes so that we get the current custom criteria file.
-            if (readAllStarting && recordProcessed)
-                readAllInProgress = true;
         }
 
-        public void ReadAllStarted()
+        public void LogMonitorStateChanged(LogMonitorStateChangedEventArgs args)
         {
-            readAllStarting = true;
-            Core.ClearGrid(this, new ExplorerUIResults());
-            explorer.Clear();
-        }
-
-        public void ReadAllFinished()
-        {
-            readAllStarting = false;
-            readAllInProgress = false;
+            if (LogMonitorStateChangedEventArgs.IsBatchRead(args.NewState))
+            {
+                // Beginning a batch read. Clear grid.
+                recordProcessedSinceBatchStart = false;
+                Core.ClearGrid(this, new ExplorerUIResults());
+                explorer.Clear();
+            }
         }
 
+        
         public object Settings
         {
             get => settings;

ObservatoryFramework/EventArgs.cs

@@ -18,7 +18,7 @@ namespace Observatory.Framework
         /// </summary>
         public object journalEvent;
     }
-    
+
     /// <summary>
     /// Provides values used as arguments for Observatory notification events.
     /// </summary>
@@ -69,4 +69,40 @@ namespace Observatory.Framework
         PluginNotifier = 4,
         All = (NativeVisual | NativeVocal | PluginNotifier)
     }
+
+    [Flags]
+    public enum LogMonitorState : uint
+    {
+        // These need to be multiples of 2 as they're used via masking.
+        Idle = 0, // Monitoring is stopped
+        Realtime = 1, // Real-time monitoring is active
+        Batch = 2, // Performing a batch read of history
+        PreRead = 4 // Currently pre-reading current system context (a batch read)
+    }
+
+    /// <summary>
+    /// Provides information about a LogMonitor state transition.
+    /// </summary>
+    public class LogMonitorStateChangedEventArgs : EventArgs
+    {
+        /// <summary>
+        /// The previous LogMonitor state.
+        /// </summary>
+        public LogMonitorState PreviousState;
+
+        /// <summary>
+        /// The new, current LogMonitor state.
+        /// </summary>
+        public LogMonitorState NewState;
+
+        /// <summary>
+        /// Determins if the given state is a batch read of any form.
+        /// </summary>
+        /// <param name="state">The state to evaluate</param>
+        /// <returns>A boolean; True iff the state provided represents a batch-mode read.</returns>
+        public static bool IsBatchRead(LogMonitorState state)
+        {
+            return (state & (LogMonitorState.Batch | LogMonitorState.PreRead)) > 0;
+        }
+    }
 }

ObservatoryFramework/Interfaces.cs

@@ -76,11 +76,19 @@ namespace Observatory.Framework.Interfaces
         public void StatusChange(Status status)
         { }
 
+        /// <summary>
+        /// Called when the LogMonitor changes state. Useful for suppressing output in certain situations
+        /// such as batch reads (ie. "Read all") or responding to other state transitions.
+        /// </summary>
+        public void LogMonitorStateChanged(LogMonitorStateChangedEventArgs eventArgs)
+        { }
+
         /// <summary>
         /// Method called when the user begins "Read All" journal processing, before any journal events are sent.<br/>
         /// Used to track if a "Read All" operation is in progress or not to avoid unnecessary processing or notifications.<br/>
         /// Can be omitted for plugins which do not require the distinction.
         /// </summary>
+        [Obsolete] // Replaced by LogMonitorStateChanged 
         public void ReadAllStarted()
         { }
 
@@ -89,6 +97,7 @@ namespace Observatory.Framework.Interfaces
         /// Used to track if a "Read All" operation is in progress or not to avoid unnecessary processing or notifications.<br/>
         /// Can be omitted for plugins which do not require the distinction.
         /// </summary>
+        [Obsolete] // Replaced by LogMonitorStateChanged
         public void ReadAllFinished()
         { }
     }
@@ -175,5 +184,15 @@ namespace Observatory.Framework.Interfaces
         /// Shared application HttpClient object. Provided so that plugins can adhere to .NET recommended behaviour of a single HttpClient object per application.
         /// </summary>
         public HttpClient HttpClient { get; }
+
+        /// <summary>
+        /// Returns the current LogMonitor state.
+        /// </summary>
+        public LogMonitorState CurrentLogMonitorState { get; }
+
+        /// <summary>
+        /// Returns true if the current LogMonitor state represents a batch-read mode.
+        /// </summary>
+        public bool IsLogMonitorBatchReading { get; }
     }
 }