From 6773406bb69b3b4845997d835de5d41a8dca0678 Mon Sep 17 00:00:00 2001
From: GreemDev <greemdev@ryujinx.app>
Date: Thu, 19 Jun 2025 04:18:02 -0500
Subject: [PATCH] infra: Use Ryujinx.UpdateClient NuGet package for checking
 for updates. Main benefit to this is sharing the C# model definitions from
 what the server returns and Ryujinx uses in-app without differences.
 Additionally removed the GitHub API JSON models.

---
 Directory.Packages.props                      |  2 +
 nuget.config                                  |  2 +
 .../Github/GithubReleaseAssetJsonResponse.cs  |  9 --
 .../Github/GithubReleasesJsonResponse.cs      | 12 ---
 .../GithubReleasesJsonSerializerContext.cs    |  7 --
 src/Ryujinx/Ryujinx.csproj                    |  2 +
 src/Ryujinx/Systems/Updater/Updater.GitLab.cs | 91 ++++++-------------
 src/Ryujinx/Systems/Updater/Updater.cs        | 14 +--
 8 files changed, 38 insertions(+), 101 deletions(-)
 delete mode 100644 src/Ryujinx/Common/Models/Github/GithubReleaseAssetJsonResponse.cs
 delete mode 100644 src/Ryujinx/Common/Models/Github/GithubReleasesJsonResponse.cs
 delete mode 100644 src/Ryujinx/Common/Models/Github/GithubReleasesJsonSerializerContext.cs

diff --git a/Directory.Packages.props b/Directory.Packages.props
index ccbcb3f6b..ce2a152d1 100644
--- a/Directory.Packages.props
+++ b/Directory.Packages.props
@@ -42,6 +42,8 @@
     <PackageVersion Include="Ryujinx.Graphics.Vulkan.Dependencies.MoltenVK" Version="1.2.0" />
     <PackageVersion Include="Ryujinx.LibHac" Version="0.20.0" />
     <PackageVersion Include="Ryujinx.SDL2-CS" Version="2.30.0-build32" />
+    <PackageVersion Include="Ryujinx.UpdateClient" Version="1.0.28" />
+    <PackageVersion Include="Ryujinx.Systems.Update.Common" Version="1.0.28" />
     <PackageVersion Include="Gommon" Version="2.7.1.1" />
     <PackageVersion Include="securifybv.ShellLink" Version="0.1.0" />
     <PackageVersion Include="Sep" Version="0.6.0" />
diff --git a/nuget.config b/nuget.config
index 77eadcf88..26f795ba1 100644
--- a/nuget.config
+++ b/nuget.config
@@ -10,11 +10,13 @@
     </packageSources>
     <packageSourceMapping>
         <!-- key value for <packageSource> should match key values from <packageSources> element -->
+        <!-- These are defined and .NET still yells about multiple package sources with no mappings. Not sure what to do, this is in the docs lol -->
         <packageSource key="nuget.org">
             <package pattern="*" />
         </packageSource>
         <packageSource key="Ryujinx.UpdateClient">
             <package pattern="Ryujinx.UpdateClient" />
+            <package pattern="Ryujinx.Systems.Update.Common" />
         </packageSource>
         <!--<packageSource key="LibHacAlpha">
             <package pattern="Ryujinx.LibHac" />
diff --git a/src/Ryujinx/Common/Models/Github/GithubReleaseAssetJsonResponse.cs b/src/Ryujinx/Common/Models/Github/GithubReleaseAssetJsonResponse.cs
deleted file mode 100644
index 633e16596..000000000
--- a/src/Ryujinx/Common/Models/Github/GithubReleaseAssetJsonResponse.cs
+++ /dev/null
@@ -1,9 +0,0 @@
-namespace Ryujinx.Ava.Common.Models.Github
-{
-    public class GithubReleaseAssetJsonResponse
-    {
-        public string Name { get; set; }
-        public string State { get; set; }
-        public string BrowserDownloadUrl { get; set; }
-    }
-}
diff --git a/src/Ryujinx/Common/Models/Github/GithubReleasesJsonResponse.cs b/src/Ryujinx/Common/Models/Github/GithubReleasesJsonResponse.cs
deleted file mode 100644
index af00121fe..000000000
--- a/src/Ryujinx/Common/Models/Github/GithubReleasesJsonResponse.cs
+++ /dev/null
@@ -1,12 +0,0 @@
-using System.Collections.Generic;
-
-namespace Ryujinx.Ava.Common.Models.Github
-{
-    public class GithubReleasesJsonResponse
-    {
-        public string Name { get; set; }
-
-        public string TagName { get; set; }
-        public List<GithubReleaseAssetJsonResponse> Assets { get; set; }
-    }
-}
diff --git a/src/Ryujinx/Common/Models/Github/GithubReleasesJsonSerializerContext.cs b/src/Ryujinx/Common/Models/Github/GithubReleasesJsonSerializerContext.cs
deleted file mode 100644
index a450ab22d..000000000
--- a/src/Ryujinx/Common/Models/Github/GithubReleasesJsonSerializerContext.cs
+++ /dev/null
@@ -1,7 +0,0 @@
-using System.Text.Json.Serialization;
-
-namespace Ryujinx.Ava.Common.Models.Github
-{
-    [JsonSerializable(typeof(GithubReleasesJsonResponse), GenerationMode = JsonSourceGenerationMode.Metadata)]
-    public partial class GithubReleasesJsonSerializerContext : JsonSerializerContext;
-}
diff --git a/src/Ryujinx/Ryujinx.csproj b/src/Ryujinx/Ryujinx.csproj
index 6860e2c4e..480d14781 100644
--- a/src/Ryujinx/Ryujinx.csproj
+++ b/src/Ryujinx/Ryujinx.csproj
@@ -65,6 +65,8 @@
     <PackageReference Include="Ryujinx.Audio.OpenAL.Dependencies" Condition="'$(RuntimeIdentifier)' != 'linux-x64' AND '$(RuntimeIdentifier)' != 'linux-arm64' AND '$(RuntimeIdentifier)' != 'osx-x64' AND '$(RuntimeIdentifier)' != 'osx-arm64'" />
     <PackageReference Include="Ryujinx.Graphics.Nvdec.Dependencies.AllArch" />
     <PackageReference Include="Ryujinx.Graphics.Vulkan.Dependencies.MoltenVK" Condition="'$(RuntimeIdentifier)' != 'linux-x64' AND '$(RuntimeIdentifier)' != 'linux-arm64' AND '$(RuntimeIdentifier)' != 'win-x64' AND '$(RuntimeIdentifier)' != 'win-arm64'" />
+    <PackageReference Include="Ryujinx.UpdateClient" />
+    <PackageReference Include="Ryujinx.Systems.Update.Common" />
     <PackageReference Include="securifybv.ShellLink" />
     <PackageReference Include="Sep" />
     <PackageReference Include="Silk.NET.Vulkan" />
diff --git a/src/Ryujinx/Systems/Updater/Updater.GitLab.cs b/src/Ryujinx/Systems/Updater/Updater.GitLab.cs
index f49f60ab9..dce3fb3c1 100644
--- a/src/Ryujinx/Systems/Updater/Updater.GitLab.cs
+++ b/src/Ryujinx/Systems/Updater/Updater.GitLab.cs
@@ -4,42 +4,27 @@ using Ryujinx.Ava.UI.Helpers;
 using Ryujinx.Common;
 using Ryujinx.Common.Helper;
 using Ryujinx.Common.Logging;
+using Ryujinx.Systems.Update.Client;
+using Ryujinx.Systems.Update.Common;
+using Ryujinx.Systems.Updater.Common;
 using System;
-using System.Net.Http;
-using System.Net.Http.Json;
-using System.Runtime.InteropServices;
-using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace Ryujinx.Ava.Systems
 {
     internal static partial class Updater
     {
-        private static string CreateUpdateQueryUrl()
-        {
-#pragma warning disable CS8524
-            var os = RunningPlatform.CurrentOS switch
-#pragma warning restore CS8524
-            {
-                OperatingSystemType.MacOS => "mac",
-                OperatingSystemType.Linux => "linux",
-                OperatingSystemType.Windows => "win"
-            };
+        private static VersionResponse _versionResponse;
 
-            var arch = RunningPlatform.Architecture switch
-            {
-                Architecture.Arm64 => "arm",
-                Architecture.X64 => "amd64",
-                _ => null
-            };
-
-            if (arch is null)
-                return null;
-
-            var rc = ReleaseInformation.IsCanaryBuild ? "canary" : "stable";
-
-            return $"https://update.ryujinx.app/latest/query?os={os}&arch={arch}&rc={rc}";
-        }
+        private static UpdateClient CreateUpdateClient()
+            => UpdateClient.Builder()
+                .WithServerEndpoint("https://update.ryujinx.app") // This is the default, and doesn't need to be provided; it's here for transparency.
+                .WithLogger((format, args, caller) => 
+                    Logger.Info?.Print(
+                        LogClass.Application, 
+                        args.Length is 0 ? format : format.Format(args), 
+                        caller: caller)
+                    );
 
         public static async Task<Optional<(Version Current, Version Incoming)>> CheckVersionAsync(bool showVersionUpToDate = false)
         {
@@ -57,39 +42,31 @@ namespace Ryujinx.Ava.Systems
                 return default;
             }
 
-            if (CreateUpdateQueryUrl() is not {} updateUrl)
-            {
-                Logger.Error?.Print(LogClass.Application, "Could not determine URL for updates.");
-                
-                _running = false;
-
-                return default;
-            }
-
-            Logger.Info?.Print(LogClass.Application, $"Checking for updates from {updateUrl}.");
-
-            // Get latest version number from update.ryujinx.app API
-            using HttpClient jsonClient = ConstructHttpClient();
+            using UpdateClient updateClient = CreateUpdateClient();
 
             try
             {
-                UpdaterResponse response =
-                    await jsonClient.GetFromJsonAsync(updateUrl, UpdaterResponseJsonContext.Default.UpdaterResponse);
-
-                _buildVer = response.Tag;
-                _buildUrl = response.DownloadUrl;
-                _changelogUrlFormat = response.ReleaseUrlFormat;
+                _versionResponse = await updateClient.QueryLatestAsync(ReleaseInformation.IsCanaryBuild
+                    ? ReleaseChannel.Canary
+                    : ReleaseChannel.Stable);
             }
             catch (Exception e)
             {
-                Logger.Error?.Print(LogClass.Application, $"An error occurred when parsing JSON response from API ({e.GetType().AsFullNamePrettyString()}): {e.Message}");
+                Logger.Error?.Print(LogClass.Application, $"An error occurred when requesting for updates ({e.GetType().AsFullNamePrettyString()}): {e.Message}");
 
                 _running = false;
                 return default;
             }
+            
+            if (_versionResponse == null)
+            {
+                // logging is done via the UpdateClient library
+                _running = false;
+                return default;
+            }
 
             // If build URL not found, assume no new update is available.
-            if (_buildUrl is null or "")
+            if (_versionResponse.ArtifactUrl is null or "")
             {
                 if (showVersionUpToDate)
                 {
@@ -99,7 +76,7 @@ namespace Ryujinx.Ava.Systems
 
                     if (userResult is UserResult.Ok)
                     {
-                        OpenHelper.OpenUrl(_changelogUrlFormat.Format(currentVersion));
+                        OpenHelper.OpenUrl(_versionResponse.ReleaseUrlFormat.Format(currentVersion));
                     }
                 }
 
@@ -111,7 +88,7 @@ namespace Ryujinx.Ava.Systems
             }
 
 
-            if (!Version.TryParse(_buildVer, out Version newVersion))
+            if (!Version.TryParse(_versionResponse.Version, out Version newVersion))
             {
                 Logger.Error?.Print(LogClass.Application,
                     $"Failed to convert the received {RyujinxApp.FullAppName} version from the update server!");
@@ -127,17 +104,5 @@ namespace Ryujinx.Ava.Systems
 
             return (currentVersion, newVersion);
         }
-        
-        [JsonSerializable(typeof(UpdaterResponse))]
-        partial class UpdaterResponseJsonContext : JsonSerializerContext;
-
-        public class UpdaterResponse
-        {
-            [JsonPropertyName("tag")] public string Tag { get; set; }
-            [JsonPropertyName("download_url")] public string DownloadUrl { get; set; }
-            [JsonPropertyName("web_url")] public string ReleaseUrl { get; set; }
-
-            [JsonIgnore] public string ReleaseUrlFormat => ReleaseUrl.Replace(Tag, "{0}");
-        }
     }
 }
diff --git a/src/Ryujinx/Systems/Updater/Updater.cs b/src/Ryujinx/Systems/Updater/Updater.cs
index 40c1da175..39bb5d9d4 100644
--- a/src/Ryujinx/Systems/Updater/Updater.cs
+++ b/src/Ryujinx/Systems/Updater/Updater.cs
@@ -5,13 +5,11 @@ using ICSharpCode.SharpZipLib.GZip;
 using ICSharpCode.SharpZipLib.Tar;
 using ICSharpCode.SharpZipLib.Zip;
 using Ryujinx.Ava.Common.Locale;
-using Ryujinx.Ava.Common.Models.Github;
 using Ryujinx.Ava.UI.Helpers;
 using Ryujinx.Ava.Utilities;
 using Ryujinx.Common;
 using Ryujinx.Common.Helper;
 using Ryujinx.Common.Logging;
-using Ryujinx.Common.Utilities;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
@@ -35,17 +33,13 @@ namespace Ryujinx.Ava.Systems
         private static readonly string _updateDir = Path.Combine(Path.GetTempPath(), "Ryujinx", "update");
         private static readonly string _updatePublishDir = Path.Combine(_updateDir, "publish");
         private const int ConnectionCount = 4;
-
-        private static string _buildVer;
-        private static string _buildUrl;
+        
         private static long _buildSize;
         private static bool _updateSuccessful;
         private static bool _running;
 
         private static readonly string[] _windowsDependencyDirs = [];
         
-        private static string _changelogUrlFormat = null;
-        
         public static async Task BeginUpdateAsync(bool showVersionUpToDate = false)
         {
             if (_running)
@@ -72,7 +66,7 @@ namespace Ryujinx.Ava.Systems
 
                     if (userResult is UserResult.Ok)
                     {
-                        OpenHelper.OpenUrl(_changelogUrlFormat.Format(currentVersion));
+                        OpenHelper.OpenUrl(_versionResponse.ReleaseUrlFormat.Format(currentVersion));
                     }
                 }
 
@@ -92,7 +86,7 @@ namespace Ryujinx.Ava.Systems
                 // GitLab instance is located in Ukraine. Connection times will vary across the world.
                 buildSizeClient.Timeout = TimeSpan.FromSeconds(10);
 
-                HttpResponseMessage message = await buildSizeClient.GetAsync(new Uri(_buildUrl), HttpCompletionOption.ResponseHeadersRead);
+                HttpResponseMessage message = await buildSizeClient.GetAsync(new Uri(_versionResponse.ArtifactUrl), HttpCompletionOption.ResponseHeadersRead);
 
                 _buildSize = message.Content.Headers.ContentRange.Length.Value;
             }
@@ -122,7 +116,7 @@ namespace Ryujinx.Ava.Systems
                 switch (shouldUpdate)
                 {
                     case UserResult.Yes:
-                        await UpdateRyujinx(_buildUrl);
+                        await UpdateRyujinx(_versionResponse.ArtifactUrl);
                         break;
                     // Secondary button maps to no, which in this case is the show changelog button.
                     case UserResult.No: