From 6d11c41facb2e1397a25110517cc281f87be2caf Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 28 Jun 2022 18:17:27 -0400
Subject: migrate update checks to FluentHttpClient

WebClient isn't needed for compatibility with macOS after the .NET 5 update in Stardew Valley 1.5.5, and causes noticeable lag for some players even when running on a background thread.
---
 src/SMAPI/Framework/SCore.cs | 44 +++++++++++++++++++++++++++++---------------
 src/SMAPI/SMAPI.csproj       |  1 +
 2 files changed, 30 insertions(+), 15 deletions(-)

(limited to 'src/SMAPI')

diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs
index 16c168a0..fdfe70fc 100644
--- a/src/SMAPI/Framework/SCore.cs
+++ b/src/SMAPI/Framework/SCore.cs
@@ -10,6 +10,7 @@ using System.Runtime.ExceptionServices;
 using System.Security;
 using System.Text;
 using System.Threading;
+using System.Threading.Tasks;
 using Microsoft.Xna.Framework;
 #if SMAPI_FOR_WINDOWS
 using Microsoft.Win32;
@@ -406,7 +407,7 @@ namespace StardewModdingAPI.Framework
                 this.CheckForSoftwareConflicts();
 
                 // check for updates
-                this.CheckForUpdatesAsync(mods);
+                _ = this.CheckForUpdatesAsync(mods); // ignore task since the main thread doesn't need to wait for it
             }
 
             // update window titles
@@ -1450,16 +1451,15 @@ namespace StardewModdingAPI.Framework
 
         /// <summary>Asynchronously check for a new version of SMAPI and any installed mods, and print alerts to the console if an update is available.</summary>
         /// <param name="mods">The mods to include in the update check (if eligible).</param>
-        private void CheckForUpdatesAsync(IModMetadata[] mods)
+        private async Task CheckForUpdatesAsync(IModMetadata[] mods)
         {
-            if (!this.Settings.CheckForUpdates)
-                return;
-
-            new Thread(() =>
+            try
             {
+                if (!this.Settings.CheckForUpdates)
+                    return;
+
                 // create client
-                string url = this.Settings.WebApiBaseUrl;
-                WebApiClient client = new(url, Constants.ApiVersion);
+                using WebApiClient client = new(this.Settings.WebApiBaseUrl, Constants.ApiVersion);
                 this.Monitor.Log("Checking for updates...");
 
                 // check SMAPI version
@@ -1469,9 +1469,15 @@ namespace StardewModdingAPI.Framework
                     try
                     {
                         // fetch update check
-                        ModEntryModel response = client.GetModInfo(new[] { new ModSearchEntryModel("Pathoschild.SMAPI", Constants.ApiVersion, new[] { $"GitHub:{this.Settings.GitHubProjectName}" }) }, apiVersion: Constants.ApiVersion, gameVersion: Constants.GameVersion, platform: Constants.Platform).Single().Value;
-                        updateFound = response.SuggestedUpdate?.Version;
-                        updateUrl = response.SuggestedUpdate?.Url;
+                        IDictionary<string, ModEntryModel> response = await client.GetModInfoAsync(
+                            mods: new[] { new ModSearchEntryModel("Pathoschild.SMAPI", Constants.ApiVersion, new[] { $"GitHub:{this.Settings.GitHubProjectName}" }) },
+                            apiVersion: Constants.ApiVersion,
+                            gameVersion: Constants.GameVersion,
+                            platform: Constants.Platform
+                        );
+                        ModEntryModel updateInfo = response.Single().Value;
+                        updateFound = updateInfo.SuggestedUpdate?.Version;
+                        updateUrl = updateInfo.SuggestedUpdate?.Url;
 
                         // log message
                         if (updateFound != null)
@@ -1480,10 +1486,10 @@ namespace StardewModdingAPI.Framework
                             this.Monitor.Log("   SMAPI okay.");
 
                         // show errors
-                        if (response.Errors.Any())
+                        if (updateInfo.Errors.Any())
                         {
                             this.Monitor.Log("Couldn't check for a new version of SMAPI. This won't affect your game, but you may not be notified of new versions if this keeps happening.", LogLevel.Warn);
-                            this.Monitor.Log($"Error: {string.Join("\n", response.Errors)}");
+                            this.Monitor.Log($"Error: {string.Join("\n", updateInfo.Errors)}");
                         }
                     }
                     catch (Exception ex)
@@ -1523,7 +1529,7 @@ namespace StardewModdingAPI.Framework
 
                         // fetch results
                         this.Monitor.Log($"   Checking for updates to {searchMods.Count} mods...");
-                        IDictionary<string, ModEntryModel> results = client.GetModInfo(searchMods.ToArray(), apiVersion: Constants.ApiVersion, gameVersion: Constants.GameVersion, platform: Constants.Platform);
+                        IDictionary<string, ModEntryModel> results = await client.GetModInfoAsync(searchMods.ToArray(), apiVersion: Constants.ApiVersion, gameVersion: Constants.GameVersion, platform: Constants.Platform);
 
                         // extract update alerts & errors
                         var updates = new List<Tuple<IModMetadata, ISemanticVersion, string>>();
@@ -1573,7 +1579,15 @@ namespace StardewModdingAPI.Framework
                         );
                     }
                 }
-            }).Start();
+            }
+            catch (Exception ex)
+            {
+                this.Monitor.Log("Couldn't check for updates. This won't affect your game, but you won't be notified of SMAPI or mod updates if this keeps happening.", LogLevel.Warn);
+                this.Monitor.Log(ex is WebException && ex.InnerException == null
+                    ? ex.Message
+                    : ex.ToString()
+                );
+            }
         }
 
         /// <summary>Create a directory path if it doesn't exist.</summary>
diff --git a/src/SMAPI/SMAPI.csproj b/src/SMAPI/SMAPI.csproj
index 3abefeab..c05512e9 100644
--- a/src/SMAPI/SMAPI.csproj
+++ b/src/SMAPI/SMAPI.csproj
@@ -25,6 +25,7 @@
     <PackageReference Include="Mono.Cecil" Version="0.11.4" />
     <PackageReference Include="MonoMod.Common" Version="22.3.5.1" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="Pathoschild.Http.FluentClient" Version="4.1.1" />
     <PackageReference Include="Pintail" Version="2.2.0" />
     <PackageReference Include="Platonymous.TMXTile" Version="1.5.9" />
     <PackageReference Include="System.Reflection.Emit" Version="4.7.0" />
-- 
cgit