detect missing/outdated Error Handler for 'suggested fixes' section

This commit is contained in:
Jesse Plamondon-Willard 2022-07-05 22:09:46 -04:00
parent f3a4b316b7
commit 0ba4fd1785
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
5 changed files with 105 additions and 53 deletions

View File

@ -18,6 +18,7 @@
* The [FluentHttpClient package](https://github.com/Pathoschild/FluentHttpClient#readme) is now loaded by SMAPI.
* For the web UI:
* The log parser now detects a missing or outdated Error Handler mod for its 'suggested fixes' section.
* Updated the JSON validator/schema for Content Patcher 1.27.0.
* Fixed the mod count in the log parser metadata.

View File

@ -200,6 +200,8 @@ namespace StardewModdingAPI.Web.Framework.LogParsing
log.GameVersion = match.Groups["gameVersion"].Value;
log.OperatingSystem = match.Groups["os"].Value;
smapiMod.OverrideVersion(log.ApiVersion);
log.ApiVersionParsed = smapiMod.GetParsedVersion();
}
// mod path line

View File

@ -1,10 +1,19 @@
using System;
using System.Diagnostics.CodeAnalysis;
using StardewModdingAPI.Toolkit;
namespace StardewModdingAPI.Web.Framework.LogParsing.Models
{
/// <summary>Metadata about a mod or content pack in the log.</summary>
public class LogModInfo
{
/*********
** Private fields
*********/
/// <summary>The parsed mod version, if valid.</summary>
private Lazy<ISemanticVersion?> ParsedVersionImpl;
/*********
** Accessors
*********/
@ -68,7 +77,6 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
{
this.Name = name;
this.Author = author;
this.Version = version;
this.Description = description;
this.UpdateVersion = updateVersion;
this.UpdateLink = updateLink;
@ -82,6 +90,8 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
this.IsContentPack = !string.IsNullOrWhiteSpace(this.ContentPackFor);
this.IsCodeMod = !this.IsContentPack;
}
this.OverrideVersion(version);
}
/// <summary>Add an update alert for this mod.</summary>
@ -95,9 +105,29 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
/// <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>
[MemberNotNull(nameof(LogModInfo.Version), nameof(LogModInfo.ParsedVersionImpl))]
public void OverrideVersion(string version)
{
this.Version = version;
this.ParsedVersionImpl = new Lazy<ISemanticVersion?>(this.ParseVersion);
}
/// <summary>Get the semantic version for this mod, if it's valid.</summary>
public ISemanticVersion? GetParsedVersion()
{
return this.ParsedVersionImpl.Value;
}
/*********
** Private methods
*********/
/// <summary>Get the semantic version for this mod, if it's valid.</summary>
public ISemanticVersion? ParseVersion()
{
return !string.IsNullOrWhiteSpace(this.Version) && SemanticVersion.TryParse(this.Version, out ISemanticVersion? version)
? version
: null;
}
}
}

View File

@ -28,6 +28,9 @@ namespace StardewModdingAPI.Web.Framework.LogParsing.Models
/// <summary>The SMAPI version.</summary>
public string? ApiVersion { get; set; }
/// <summary>The parsed SMAPI version, if it's valid.</summary>
public ISemanticVersion? ApiVersionParsed { get; set; }
/// <summary>The game version.</summary>
public string? GameVersion { get; set; }

View File

@ -8,24 +8,29 @@
@{
ViewData["Title"] = "SMAPI log parser";
// get log info
ParsedLog? log = Model!.ParsedLog;
IDictionary<string, LogModInfo[]> contentPacks = Model.GetContentPacksByMod();
ISet<int> screenIds = new HashSet<int>(log?.Messages.Select(p => p.ScreenId) ?? Array.Empty<int>());
// detect suggested fixes
LogModInfo[] outdatedMods = log?.Mods.Where(mod => mod.HasUpdate).ToArray() ?? Array.Empty<LogModInfo>();
LogModInfo? errorHandler = log?.Mods.FirstOrDefault(p => p.IsCodeMod && p.Name == "Error Handler");
bool hasOlderErrorHandler = errorHandler?.GetParsedVersion() is not null && log?.ApiVersionParsed is not null && log.ApiVersionParsed.IsNewerThan(errorHandler.GetParsedVersion());
// get filters
IDictionary<string, bool> defaultFilters = Enum
.GetValues<LogLevel>()
.ToDictionary(level => level.ToString().ToLower(), level => level != LogLevel.Trace);
IDictionary<int, string> logLevels = Enum
.GetValues<LogLevel>()
.ToDictionary(level => (int)level, level => level.ToString().ToLower());
IDictionary<int, string> logSections = Enum
.GetValues<LogSection>()
.ToDictionary(section => (int)section, section => section.ToString());
// get form
string curPageUrl = this.Url.PlainAction("Index", "LogParser", new { id = Model.PasteID }, absoluteUrl: true)!;
ISet<int> screenIds = new HashSet<int>(log?.Messages.Select(p => p.ScreenId) ?? Array.Empty<int>());
}
@section Head {
@ -158,7 +163,7 @@ else if (log?.IsValid == true)
<div id="os-instructions">
<div>
<ul data-tabs>
@foreach (Platform platform in new[] {Platform.Android, Platform.Linux, Platform.Mac, Platform.Windows})
@foreach (Platform platform in new[] { Platform.Android, Platform.Linux, Platform.Mac, Platform.Windows })
{
@if (platform == Platform.Windows)
{
@ -237,10 +242,20 @@ else if (log?.IsValid == true)
@if (log?.IsValid == true)
{
<div id="output">
@if (log.Mods.Any(mod => mod.HasUpdate))
@if (outdatedMods.Any() || errorHandler is null || hasOlderErrorHandler)
{
<h2>Suggested fixes</h2>
<ul id="fix-list">
@if (errorHandler is null)
{
<li>You don't have the <strong>Error Handler</strong> mod installed. This automatically prevents many game or mod errors. You can <a href="https://stardewvalleywiki.com/Modding:Player_Guide#Install_SMAPI">reinstall SMAPI</a> to re-add it.</li>
}
@if (hasOlderErrorHandler)
{
<li>Your <strong>Error Handler</strong> mod is older than SMAPI. You may be missing some game/mod error fixes. You can <a href="https://stardewvalleywiki.com/Modding:Player_Guide#Install_SMAPI">reinstall SMAPI</a> to update it.</li>
}
@if (outdatedMods.Any())
{
<li>
Consider updating these mods to fix problems:
@ -286,6 +301,7 @@ else if (log?.IsValid == true)
}
</table>
</li>
}
</ul>
}
@ -434,7 +450,7 @@ else if (log?.IsValid == true)
<div>
This website uses JavaScript to display a filterable table. To view this log, please enable JavaScript or <a href="@this.Url.PlainAction("Index", "LogParser", new { id = Model.PasteID, format = LogViewFormat.RawView })">view the raw log</a>.
</div>
<br/>
<br />
</noscript>
<log-table>