Merge pull request #838 from KhloeLeclair/clientlog

Improve log parser

3 files changed, 100 insertions, 29 deletions

diff --git a/src/SMAPI.Web/Framework/LogParsing/Models/LogMessage.cs b/src/SMAPI.Web/Framework/LogParsing/Models/LogMessage.cs
index 57d28755..7a5f32e0 100644
--- a/src/SMAPI.Web/Framework/LogParsing/Models/LogMessage.cs
+++ b/src/SMAPI.Web/Framework/LogParsing/Models/LogMessage.cs
@@ -1,4 +1,4 @@
-#nullable disable
+using System.Diagnostics.CodeAnalysis;
 
 namespace StardewModdingAPI.Web.Framework.LogParsing.Models
 {
@@ -9,19 +9,19 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
         ** Accessors
         *********/
         /// <summary>The local time when the log was posted.</summary>
-        public string Time { get; set; }
+        public string Time { get; }
 
         /// <summary>The log level.</summary>
-        public LogLevel Level { get; set; }
+        public LogLevel Level { get; }
 
         /// <summary>The screen ID in split-screen mode.</summary>
-        public int ScreenId { get; set; }
+        public int ScreenId { get; }
 
         /// <summary>The mod name.</summary>
-        public string Mod { get; set; }
+        public string Mod { get; }
 
         /// <summary>The log text.</summary>
-        public string Text { get; set; }
+        public string Text { get; }
 
         /// <summary>The number of times this message was repeated consecutively.</summary>
         public int Repeated { get; set; }
@@ -30,6 +30,32 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
         public LogSection? Section { get; set; }
 
         /// <summary>Whether this message is the first one of its section.</summary>
+        [MemberNotNullWhen(true, nameof(LogMessage.Section))]
         public bool IsStartOfSection { get; set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance/</summary>
+        /// <param name="time">The local time when the log was posted.</param>
+        /// <param name="level">The log level.</param>
+        /// <param name="screenId">The screen ID in split-screen mode.</param>
+        /// <param name="mod">The mod name.</param>
+        /// <param name="text">The log text.</param>
+        /// <param name="repeated">The number of times this message was repeated consecutively.</param>
+        /// <param name="section">The section that this log message belongs to.</param>
+        /// <param name="isStartOfSection">Whether this message is the first one of its section.</param>
+        public LogMessage(string time, LogLevel level, int screenId, string mod, string text, int repeated = 0, LogSection? section = null, bool isStartOfSection = false)
+        {
+            this.Time = time;
+            this.Level = level;
+            this.ScreenId = screenId;
+            this.Mod = mod;
+            this.Text = text;
+            this.Repeated = repeated;
+            this.Section = section;
+            this.IsStartOfSection = isStartOfSection;
+        }
     }
 }
diff --git a/src/SMAPI.Web/Framework/LogParsing/Models/LogModInfo.cs b/src/SMAPI.Web/Framework/LogParsing/Models/LogModInfo.cs
index 349312df..a6b9165c 100644
--- a/src/SMAPI.Web/Framework/LogParsing/Models/LogModInfo.cs
+++ b/src/SMAPI.Web/Framework/LogParsing/Models/LogModInfo.cs
@@ -1,4 +1,4 @@
-#nullable disable
+using System.Diagnostics.CodeAnalysis;
 
 namespace StardewModdingAPI.Web.Framework.LogParsing.Models
 {
@@ -9,36 +9,81 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
         ** Accessors
         *********/
         /// <summary>The mod name.</summary>
-        public string Name { get; set; }
+        public string Name { get; }
 
         /// <summary>The mod author.</summary>
-        public string Author { get; set; }
-
-        /// <summary>The update version.</summary>
-        public string UpdateVersion { get; set; }
-
-        /// <summary>The update link.</summary>
-        public string UpdateLink { get; set; }
+        public string Author { get; }
 
         /// <summary>The mod version.</summary>
-        public string Version { get; set; }
+        public string Version { get; private set; }
 
         /// <summary>The mod description.</summary>
-        public string Description { get; set; }
+        public string Description { get; }
+
+        /// <summary>The update version.</summary>
+        public string? UpdateVersion { get; private set; }
+
+        /// <summary>The update link.</summary>
+        public string? UpdateLink { get; private set; }
 
         /// <summary>The name of the mod for which this is a content pack (if applicable).</summary>
-        public string ContentPackFor { get; set; }
+        public string? ContentPackFor { get; }
 
         /// <summary>The number of errors logged by this mod.</summary>
         public int Errors { get; set; }
 
         /// <summary>Whether the mod was loaded into the game.</summary>
-        public bool Loaded { get; set; }
+        public bool Loaded { get; }
 
         /// <summary>Whether the mod has an update available.</summary>
+        [MemberNotNullWhen(true, nameof(LogModInfo.UpdateVersion), nameof(LogModInfo.UpdateLink))]
         public bool HasUpdate => this.UpdateVersion != null && this.Version != this.UpdateVersion;
 
         /// <summary>Whether the mod is a content pack for another mod.</summary>
+        [MemberNotNullWhen(true, nameof(LogModInfo.ContentPackFor))]
         public bool IsContentPack => !string.IsNullOrWhiteSpace(this.ContentPackFor);
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="name">The mod name.</param>
+        /// <param name="author">The mod author.</param>
+        /// <param name="version">The mod version.</param>
+        /// <param name="description">The mod description.</param>
+        /// <param name="updateVersion">The update version.</param>
+        /// <param name="updateLink">The update link.</param>
+        /// <param name="contentPackFor">The name of the mod for which this is a content pack (if applicable).</param>
+        /// <param name="errors">The number of errors logged by this mod.</param>
+        /// <param name="loaded">Whether the mod was loaded into the game.</param>
+        public LogModInfo(string name, string author, string version, string description, string? updateVersion = null, string? updateLink = null, string? contentPackFor = null, int errors = 0, bool loaded = true)
+        {
+            this.Name = name;
+            this.Author = author;
+            this.Version = version;
+            this.Description = description;
+            this.UpdateVersion = updateVersion;
+            this.UpdateLink = updateLink;
+            this.ContentPackFor = contentPackFor;
+            this.Errors = errors;
+            this.Loaded = loaded;
+        }
+
+        /// <summary>Add an update alert for this mod.</summary>
+        /// <param name="updateVersion">The update version.</param>
+        /// <param name="updateLink">The update link.</param>
+        public void SetUpdate(string updateVersion, string updateLink)
+        {
+            this.UpdateVersion = updateVersion;
+            this.UpdateLink = updateLink;
+        }
+
+        /// <summary>Override the version number, for cases like SMAPI itself where the version is only known later during parsing.</summary>
+        /// <param name="version">The new mod version.</param>
+        public void OverrideVersion(string version)
+        {
+            this.Version = version;
+        }
     }
 }
diff --git a/src/SMAPI.Web/Framework/LogParsing/Models/ParsedLog.cs b/src/SMAPI.Web/Framework/LogParsing/Models/ParsedLog.cs
index dae91d84..6951e434 100644
--- a/src/SMAPI.Web/Framework/LogParsing/Models/ParsedLog.cs
+++ b/src/SMAPI.Web/Framework/LogParsing/Models/ParsedLog.cs
@@ -1,6 +1,5 @@
-#nullable disable
-
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace StardewModdingAPI.Web.Framework.LogParsing.Models
 {
@@ -14,31 +13,32 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
         ** Metadata
         ****/
         /// <summary>Whether the log file was successfully parsed.</summary>
+        [MemberNotNullWhen(true, nameof(ParsedLog.RawText))]
         public bool IsValid { get; set; }
 
         /// <summary>An error message indicating why the log file is invalid.</summary>
-        public string Error { get; set; }
+        public string? Error { get; set; }
 
         /// <summary>The raw log text.</summary>
-        public string RawText { get; set; }
+        public string? RawText { get; set; }
 
         /****
         ** Log data
         ****/
         /// <summary>The SMAPI version.</summary>
-        public string ApiVersion { get; set; }
+        public string? ApiVersion { get; set; }
 
         /// <summary>The game version.</summary>
-        public string GameVersion { get; set; }
+        public string? GameVersion { get; set; }
 
         /// <summary>The player's operating system.</summary>
-        public string OperatingSystem { get; set; }
+        public string? OperatingSystem { get; set; }
 
         /// <summary>The game install path.</summary>
-        public string GamePath { get; set; }
+        public string? GamePath { get; set; }
 
         /// <summary>The mod folder path.</summary>
-        public string ModPath { get; set; }
+        public string? ModPath { get; set; }
 
         /// <summary>The ISO 8601 timestamp when the log was started.</summary>
         public DateTimeOffset Timestamp { get; set; }
@@ -47,6 +47,6 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
         public LogModInfo[] Mods { get; set; } = Array.Empty<LogModInfo>();
 
         /// <summary>The log messages.</summary>
-        public LogMessage[] Messages { get; set; }
+        public LogMessage[] Messages { get; set; } = Array.Empty<LogMessage>();
     }
 }