feat: set user agent to gtr mod version

Author: wopian

Connectivity/NetworkUserAgent.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Net.Http;
+
+namespace TNRD.Zeepkist.GTR.Connectivity;
+
+internal sealed class NetworkUserAgent
+{
+    public const string HeaderName = "User-Agent";
+
+    public string Value { get; }
+
+    public NetworkUserAgent(string gtrVersion, string zeepSdkVersion)
+    {
+        if (string.IsNullOrWhiteSpace(gtrVersion))
+            throw new ArgumentException("GTR version is required.", nameof(gtrVersion));
+        if (string.IsNullOrWhiteSpace(zeepSdkVersion))
+            throw new ArgumentException("ZeepSDK version is required.", nameof(zeepSdkVersion));
+
+        Value = $"ZeepkistGTR/{gtrVersion} (ZeepSDK {zeepSdkVersion})";
+    }
+
+    public void Apply(HttpClient client)
+    {
+        if (client == null)
+            throw new ArgumentNullException(nameof(client));
+
+        client.DefaultRequestHeaders.UserAgent.Clear();
+        client.DefaultRequestHeaders.UserAgent.ParseAdd(Value);
+    }
+
+    public void Apply(Action<string, string> setHeader)
+    {
+        if (setHeader == null)
+            throw new ArgumentNullException(nameof(setHeader));
+
+        setHeader(HeaderName, Value);
+    }
+}

Plugin.cs

@@ -4,6 +4,7 @@
 using System.Net.WebSockets;
 using System.Threading;
 using BepInEx;
+using BepInEx.Bootstrap;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Serilog;
@@ -83,6 +84,9 @@ private void ConfigureServices(IServiceCollection services)
         services.AddSingleton(Config);
         services.AddSingleton(Logger);
         services.AddSingleton(Info);
+        services.AddSingleton(new NetworkUserAgent(
+            MyPluginInfo.PLUGIN_VERSION,
+            Chainloader.PluginInfos["ZeepSDK"].Metadata.Version.ToString()));
         services.AddSingleton<IHostLifetime, NoopHostLifetime>();
         services.AddMemoryCache();
         services.AddEagerService<SpainRoutingService>();
@@ -153,17 +157,22 @@ private void ConfigureServices(IServiceCollection services)
         services.AddTransient<V7Reader>();
         services.AddSingleton<ApiHttpClient>();
         services.AddHttpClient();
-        services.AddHttpClient(SpainRoutingService.TraceClientKey, client =>
+        services.AddHttpClient(SpainRoutingService.TraceClientKey, (provider, client) =>
         {
+            provider.GetRequiredService<NetworkUserAgent>().Apply(client);
             client.BaseAddress = CloudflareTraceRequest.BaseAddress;
             client.Timeout = CloudflareTraceRequest.Timeout;
         });
-        services.AddHttpClient(AlternativeDomainFallbackHandler.TransportClientKey, client =>
-        {
-            client.Timeout = AlternativeDomainFallbackHandler.RequestTimeout;
-        });
-        services.AddHttpClient(GhostRepository.ClientKey, client =>
+        services.AddHttpClient(
+            AlternativeDomainFallbackHandler.TransportClientKey,
+            (provider, client) =>
+            {
+                provider.GetRequiredService<NetworkUserAgent>().Apply(client);
+                client.Timeout = AlternativeDomainFallbackHandler.RequestTimeout;
+            });
+        services.AddHttpClient(GhostRepository.ClientKey, (provider, client) =>
         {
+            provider.GetRequiredService<NetworkUserAgent>().Apply(client);
             client.Timeout = TimeSpan.FromSeconds(60);
         });
         services.AddSingleton(provider =>
@@ -183,6 +192,7 @@ private void ConfigureServices(IServiceCollection services)
                     routingService.SelectedBackendUrl,
                     "Backend API URL");
                 client.Timeout = Timeout.InfiniteTimeSpan;
+                provider.GetRequiredService<NetworkUserAgent>().Apply(client);
                 AddDefaultHeaders(client);
             })
             .AddHttpMessageHandler(provider => new AlternativeDomainFallbackHandler(
@@ -199,6 +209,7 @@ private void ConfigureServices(IServiceCollection services)
                         routingService.SelectedGraphQLUrl,
                         "GraphQL URL");
                     client.Timeout = Timeout.InfiniteTimeSpan;
+                    provider.GetRequiredService<NetworkUserAgent>().Apply(client);
                     AddDefaultHeaders(client);
                 },
                 clientBuilder => clientBuilder.AddHttpMessageHandler(provider =>
@@ -215,7 +226,11 @@ private void ConfigureServices(IServiceCollection services)
                     "GraphQL URL");
                 client.Uri = GraphqlWebSocketUri.FromHttp(graphQlUri);
                 if (client.Socket is ClientWebSocket socket)
+                {
+                    provider.GetRequiredService<NetworkUserAgent>()
+                        .Apply((name, value) => socket.Options.SetRequestHeader(name, value));
                     AddDefaultHeaders((name, value) => socket.Options.SetRequestHeader(name, value));
+                }
             });
     }
 

Zeepkist.GTR.Mod.Tests/NetworkUserAgentTests.cs

@@ -0,0 +1,47 @@
+using System.Net.Http;
+using TNRD.Zeepkist.GTR.Connectivity;
+using Xunit;
+
+namespace Zeepkist.GTR.Mod.Tests;
+
+public class NetworkUserAgentTests
+{
+    [Fact]
+    public void ValueUsesGtrBuildAndLoadedZeepSdkVersions()
+    {
+        NetworkUserAgent userAgent = new("1.7.0", "2.6.1");
+
+        Assert.Equal("ZeepkistGTR/1.7.0 (ZeepSDK 2.6.1)", userAgent.Value);
+    }
+
+    [Fact]
+    public void ApplyReplacesExistingHttpUserAgent()
+    {
+        using HttpClient client = new();
+        client.DefaultRequestHeaders.UserAgent.ParseAdd("ExistingClient/1.0");
+        NetworkUserAgent userAgent = new("1.7.0", "2.6.1");
+
+        userAgent.Apply(client);
+
+        Assert.Equal(
+            "ZeepkistGTR/1.7.0 (ZeepSDK 2.6.1)",
+            client.DefaultRequestHeaders.UserAgent.ToString());
+    }
+
+    [Fact]
+    public void ApplySetsWebSocketHeader()
+    {
+        string name = null;
+        string value = null;
+        NetworkUserAgent userAgent = new("1.7.0", "2.6.1");
+
+        userAgent.Apply((headerName, headerValue) =>
+        {
+            name = headerName;
+            value = headerValue;
+        });
+
+        Assert.Equal("User-Agent", name);
+        Assert.Equal("ZeepkistGTR/1.7.0 (ZeepSDK 2.6.1)", value);
+    }
+}

Zeepkist.GTR.Mod.Tests/Zeepkist.GTR.Mod.Tests.csproj

@@ -31,6 +31,7 @@
     <Compile Include="..\Connectivity\CloudflareTraceParser.cs" Link="Source\CloudflareTraceParser.cs" />
     <Compile Include="..\Connectivity\CloudflareTraceRequest.cs" Link="Source\CloudflareTraceRequest.cs" />
     <Compile Include="..\Connectivity\ISpainRoutingState.cs" Link="Source\ISpainRoutingState.cs" />
+    <Compile Include="..\Connectivity\NetworkUserAgent.cs" Link="Source\NetworkUserAgent.cs" />
     <Compile Include="..\Connectivity\ServiceEndpoint.cs" Link="Source\ServiceEndpoint.cs" />
     <Compile Include="..\Connectivity\SpainTraceResult.cs" Link="Source\SpainTraceResult.cs" />
     <Compile Include="..\Ghosting\GhostLimits.cs" Link="Source\GhostLimits.cs" />