Rework Journal Handling

Stub ModulesInfo

Botanist/Botanist.cs

@@ -97,7 +97,7 @@ public class Botanist : IObservatoryWorker
         set => botanistSettings = (BotanistSettings)value;
     }
 
-    public void JournalEvent<TJournal>(TJournal journal) where TJournal : JournalBase
+    public void JournalEvent<TJournal>(TJournal journal) where TJournal : IJournal
     {
         switch (journal)
         {

ObservatoryFramework/Files/Journal/JournalBase.cs

@@ -277,7 +277,8 @@ using Travel;
 [JsonDerivedType(typeof(OutfittingFile))]
 [JsonDerivedType(typeof(ShipyardFile))]
 [JsonDerivedType(typeof(Status))]
-public class JournalBase
+[JsonDerivedType(typeof(JournalBase))]
+public interface IJournal
 {
     [JsonPropertyName("timestamp")]
     public DateTimeOffset Timestamp { get; init; }
@@ -288,3 +289,10 @@ public class JournalBase
     [JsonExtensionData]
     public Dictionary<string, object> AdditionalProperties { get; init; }
 }
+
+public abstract class JournalBase : IJournal
+{
+    public DateTimeOffset Timestamp { get; init; }
+    public string Event { get; init; }
+    public Dictionary<string, object> AdditionalProperties { get; init; }
+}

ObservatoryFramework/Interfaces.cs

@@ -54,7 +54,7 @@ public interface IObservatoryWorker : IObservatoryPlugin
     /// <param name="journal"><para>Elite Dangerous journal event, deserialized into a .NET object.</para>
     /// <para>Unhandled json values within a journal entry type will be contained in member property:<br/>Dictionary&lt;string, object&gt; AdditionalProperties.</para>
     /// <para>Unhandled journal event types will be type JournalBase with all values contained in AdditionalProperties.</para></param>
-    public void JournalEvent<TJournal>(TJournal journal) where TJournal : JournalBase;
+    public void JournalEvent<TJournal>(TJournal journal) where TJournal : IJournal;
 
     /// <summary>
     /// Method called when status.json content is updated.<br/>

Pulsar/Features/EventsHub.cs

@@ -15,7 +15,7 @@ public class EventsHub : Hub<IEventsHub>
     
     public async Task MarketUpdated(MarketFile market) => await Clients.All.MarketUpdated(market);
     
-    public async Task JournalUpdated(IReadOnlyCollection<JournalBase> journals) => await Clients.All.JournalUpdated(journals);
+    public async Task JournalUpdated(IReadOnlyCollection<IJournal> journals) => await Clients.All.JournalUpdated(journals);
     
     public async Task ModuleInfoUpdated(ModuleInfoFile moduleInfo) => await Clients.All.ModuleInfoUpdated(moduleInfo);
     
@@ -38,7 +38,7 @@ public interface IEventsHub
     
     Task MarketUpdated(MarketFile market);
     
-    Task JournalUpdated(IReadOnlyCollection<JournalBase> journals);
+    Task JournalUpdated(IReadOnlyCollection<IJournal> journals);
     
     Task ModuleInfoUpdated(ModuleInfoFile moduleInfo);
     

Pulsar/Features/FileHandlerService.cs

@@ -1,10 +1,12 @@
 namespace Pulsar.Features;
 
-public interface IFileHandlerService
+public interface IFileHandler
 {
-    void HandleFile(string path);
+    Task HandleFile(string path);
 }
 
+public interface IFileHandlerService : IFileHandler;
+
 public class FileHandlerService(ILogger<FileHandlerService> logger, IStatusService statusService) : IFileHandlerService
 {
     public static readonly string MarketFileName = "Market.json";
@@ -12,7 +14,8 @@ public class FileHandlerService(ILogger<FileHandlerService> logger, IStatusServi
     public static readonly string OutfittingFileName = "Outfitting.json";
     public static readonly string ShipyardFileName = "Shipyard.json";
     public static readonly string ModulesFileName = "Modules.json";
-    public static readonly string JournalFileName = "Journal.";
+    public static readonly string JournalLogFileNameRegEx = @"Journal\.\d\d\d\d-\d\d-\d\dT\d+\.\d\d\.log";
+    public static readonly string JournalLogFileName = "Journal.*.log";
     public static readonly string RouteFileName = "Route.json";
     public static readonly string CargoFileName = "Cargo.json";
     public static readonly string BackpackFileName = "Backpack.json";
@@ -27,7 +30,7 @@ public class FileHandlerService(ILogger<FileHandlerService> logger, IStatusServi
         OutfittingFileName,
         ShipyardFileName,
         ModulesFileName,
-        JournalFileName,
+        JournalLogFileNameRegEx,
         RouteFileName,
         CargoFileName,
         BackpackFileName,
@@ -38,10 +41,10 @@ public class FileHandlerService(ILogger<FileHandlerService> logger, IStatusServi
     
     private readonly Dictionary<string, IJournalHandler> Handlers = new()
     {
-        { StatusFileName, statusService },
+        { StatusFileName, statusService }
     };
     
-    public void HandleFile(string path)
+    public async Task HandleFile(string path)
     {
         var fileInfo = new FileInfo(path);
         var fileName = fileInfo.Name;
@@ -59,7 +62,7 @@ public class FileHandlerService(ILogger<FileHandlerService> logger, IStatusServi
         if (Handlers.TryGetValue(match, out var handler))
         {
             logger.LogInformation("Handling file {FileName}", fileName);
-            handler.HandleFile(fileInfo.Name);
+            await handler.HandleFile(fileInfo.Name);
             return;
         }
         

Pulsar/Features/Interfaces/IJournalHandler.cs

@@ -0,0 +1,23 @@
+using Observatory.Framework.Files.Journal;
+
+namespace Pulsar.Features;
+
+/// <summary>
+/// Interface for Handling Journal Files.
+/// </summary>
+public interface IJournalHandler : IFileHandler
+{
+    string FileName { get; }
+    Task HandleFile(string filePath);
+    public bool ValidateFile(string filePath);
+}
+
+/// <summary>
+/// Interface for Getting Journal Files.
+/// Only used for Controllers
+/// </summary>
+public interface IJournalHandler<T> : IJournalHandler
+    where T: IJournal
+{
+    Task<T> Get();
+}

Pulsar/Features/Journal/JournalController.cs

@@ -1,7 +1,7 @@
 namespace Pulsar.Features.Journal;
 
 [ApiController]
-[Route("api/journal")]
+[Route("api/[controller]")]
 public class JournalController : ControllerBase
 {
     

Pulsar/Features/ModulesInfo/ModulesInfoController.cs

@@ -0,0 +1,12 @@
+namespace Pulsar.Features.ModulesInfo;
+
+[ApiController]
+[Route("api/[controller]")]
+public class ModulesInfoController(IModulesInfoService modulesInfo) : ControllerBase
+{
+    [HttpGet]
+    public async Task<IActionResult> Get()
+    {
+        return Ok(modulesInfo.Get());
+    }
+}

Pulsar/Features/ModulesInfo/ModulesInfoService.cs

@@ -0,0 +1,24 @@
+namespace Pulsar.Features.ModulesInfo;
+
+using Observatory.Framework.Files;
+
+public interface IModulesInfoService : IJournalHandler<ModuleInfoFile>;
+
+public class ModulesInfoService : IModulesInfoService
+{
+    public string FileName => FileHandlerService.ModulesInfoFileName;
+    public Task HandleFile(string filePath)
+    {
+        throw new NotImplementedException();
+    }
+    
+    public bool ValidateFile(string filePath)
+    {
+        throw new NotImplementedException();
+    }
+
+    public Task<ModuleInfoFile> Get()
+    {
+        throw new NotImplementedException();
+    }
+}

Pulsar/Features/Status/StatusController.cs

@@ -1,30 +1,12 @@
 namespace Pulsar.Features.Status;
 
 [ApiController]
-[Route("api/status")]
-public class StatusController(IOptions<PulsarConfiguration> pulsarOptions, IHubContext<EventsHub, IEventsHub> hub) : ControllerBase
+[Route("api/[controller]")]
+public class StatusController(IStatusService status) : ControllerBase
 {
     [HttpGet]
     public async Task<IActionResult> Get()
     {
-        // TODO: put in service
-        var journalDir = pulsarOptions.Value.JournalDirectory;
-        var dir = new DirectoryInfo(journalDir);
-        
-        if (!dir.Exists)
-            return Problem("Journal directory does not exist.");
-        
-        var files = dir.GetFiles();
-        
-        var statusFile = files.FirstOrDefault(f =>
-            string.Equals(f.Name, "status.json", StringComparison.InvariantCultureIgnoreCase));
-        
-        if (statusFile == null)
-            return Problem("Status file not found.");
-
-        await using var file = System.IO.File.Open(statusFile.FullName, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
-        var status = await JsonSerializer.DeserializeAsync<Observatory.Framework.Files.Status>(file); 
-        await hub.Clients.All.StatusUpdated(status);
-        return Ok(status);
+        return Ok(status.Get());
     }
 }

Pulsar/Features/Status/StatusService.cs

@@ -1,18 +1,71 @@
 namespace Pulsar.Features.Status;
 
-public class StatusService : IStatusService
+using Observatory.Framework.Files;
+
+public interface IStatusService : IJournalHandler<Status>;
+public class StatusService(ILogger<StatusService> logger, IOptions<PulsarConfiguration> options, IEventHubContext hub) : IStatusService
 {
-    public void HandleFile(string fileInfo)
+    public string FileName => FileHandlerService.StatusFileName;
+    
+    public async Task HandleFile(string filePath)
     {
-        throw new NotImplementedException();
+        if (!ValidateFile(filePath))
+        {
+            return;
         }
-}
         
-public interface IStatusService : IJournalHandler
-{
-}
+        var file = File.Open(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
+        var status = await JsonSerializer.DeserializeAsync<Status>(file); 
+        
+        if (status == null)
+        {
+            logger.LogWarning("Failed to deserialize status file {FilePath}", filePath);
+            return;
+        }
+        
+        await hub.Clients.All.StatusUpdated(status);
+    }
+
+    public bool ValidateFile(string filePath)
+    {
+        if (!File.Exists(filePath))
+        {
+            logger.LogWarning("Status file {StatusFile} does not exist", filePath);
+            return false;
+        }
+        
+        var fileInfo = new FileInfo(filePath);
+        
+        if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase))
+        {
+            logger.LogWarning("File {StatusFile} is not a status file", filePath);
+            return false;
+        }
+
+        if (fileInfo.Length == 0)
+        {
+            logger.LogWarning("Status file {StatusFile} is empty", filePath);
+            return false;
+        }
+
+        return true;
+    }
+
+    public async Task<Status> Get()
+    {
+        var statusFile = Path.Combine(options.Value.JournalDirectory, FileName);
+        
+        if (!ValidateFile(statusFile))
+        {
+            return new Status();
+        }
+
+        await using var file = File.Open(statusFile, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
+        var status = await JsonSerializer.DeserializeAsync<Status>(file);
+        if (status != null) return status;
+        
+        logger.LogWarning("Failed to deserialize status file {StatusFile}", statusFile);
+        return new Status();
+    }
 
-public interface IJournalHandler
-{
-    void HandleFile(string fileInfo);
 }

Pulsar/Global.Usings.cs

@@ -8,4 +8,4 @@ global using System.Text.Json.Serialization;
 global using Microsoft.AspNetCore.Mvc;
 global using Microsoft.AspNetCore.SignalR;
 global using Microsoft.Extensions.Options;
-
+global using IEventHubContext = Microsoft.AspNetCore.SignalR.IHubContext<Pulsar.Features.EventsHub, Pulsar.Features.IEventsHub>;

Pulsar/PulsarServiceRegistry.cs

@@ -1,13 +1,17 @@
+using System.Diagnostics.CodeAnalysis;
 using Lamar;
 using Pulsar.Features;
+using Pulsar.Features.ModulesInfo;
 
 namespace Pulsar;
 
+[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)]
 public class PulsarServiceRegistry : ServiceRegistry
 {
     public PulsarServiceRegistry()
     {
         For<IFileHandlerService>().Use<FileHandlerService>();
         For<IStatusService>().Use<StatusService>();
+        For<IModulesInfoService>().Use<ModulesInfoService>();
     }
 }

Pulsar/Utils/JournalReader.cs

@@ -5,7 +5,7 @@ namespace Pulsar.Utils;
 
 public static class JournalReader
 {
-    public static TJournal ObservatoryDeserializer<TJournal>(string json) where TJournal : JournalBase
+    public static TJournal ObservatoryDeserializer<TJournal>(string json) where TJournal : IJournal
     {
         TJournal deserialized;