csharp: Mark BaseUrl as deprecated in favor of ServerUrl on SvixOptions (#1917)

Author: svix-mman

ChangeLog.md

@@ -4,6 +4,7 @@
 * Libs/Python: Bring back the (deprecated) sync `dashboard_access` method, which was accidentally
   removed in v1.64.1
 * Libs/Csharp: The `options` argument to the `SvixClient` initializer is now optional.
+* Libs/Csharp: The `SvixOptions.BaseUrl` field is deprecated in favor of `SvixOptions.ServerUrl`
 
 ## Version 1.64.1
 * Libs/JavaScript: Add `HTTPValidationError`, `HttpErrorOut`, `ValidationError` and `ApiException` to the top level exports.

csharp/Svix/SvixClient.cs

@@ -81,12 +81,14 @@ public SvixClient(
         )
         {
             Logger = logger;
+            var opts = options ?? new SvixOptions(Utils.DefaultServerUrlFromToken(token));
             SvixHttpClient =
                 svixHttpClient
                 ?? new SvixHttpClient(
                     token,
-                    options ?? new SvixOptions(Utils.DefaultServerUrlFromToken(token)),
-                    $"svix-libs/{Version.version}/csharp"
+                    opts.RetryScheduleMilliseconds,
+                    $"svix-libs/{Version.version}/csharp",
+                    opts.ServerUrl ?? Utils.DEFAULT_SERVER_URL
                 );
         }
     }

csharp/Svix/SvixHttpClient.cs

@@ -1,14 +1,21 @@
-using System.Net;
+using System.Collections.Generic;
+using System.Net;
 using System.Net.Http.Headers;
 using System.Text;
 using Newtonsoft.Json;
 
 namespace Svix
 {
-    public class SvixHttpClient(string token, SvixOptions options, string userAgent)
+    public class SvixHttpClient(
+        string token,
+        List<int> retryScheduleMilliseconds,
+        string userAgent,
+        string serverUrl
+    )
     {
-        readonly SvixOptions _options = options;
-        readonly HttpClient _httpClient = new();
+        private readonly List<int> retryScheduleMilliseconds = retryScheduleMilliseconds;
+        private readonly string serverUrl = serverUrl;
+        private readonly HttpClient _httpClient = new();
         private readonly string _token = token;
         private readonly JsonSerializerSettings patchJsonOptions = new();
         private readonly JsonSerializerSettings JsonOptions = new()
@@ -63,13 +70,13 @@ public async Task<ApiResponse<T>> SendRequestAsync<T>(
                 content
             );
             var response = await _httpClient.SendAsync(request, cancellationToken);
-            for (var index = 0; index < _options.RetryScheduleMilliseconds.Count; index++)
+            for (var index = 0; index < retryScheduleMilliseconds.Count; index++)
             {
                 if ((int)response.StatusCode < 500)
                 {
                     break;
                 }
-                Thread.Sleep(_options.RetryScheduleMilliseconds[index]);
+                Thread.Sleep(retryScheduleMilliseconds[index]);
                 HttpRequestMessage retryRequest = BuildRequest(
                     method,
                     path,
@@ -131,7 +138,7 @@ HttpRequestMessage BuildRequest(
             object? content = null
         )
         {
-            var url = _options.BaseUrl;
+            var url = serverUrl;
 
             // Apply path parameters if provided
             if (pathParams != null)

csharp/Svix/SvixOptions.cs

@@ -2,17 +2,26 @@ namespace Svix
 {
     public class SvixOptions
     {
-        public string BaseUrl { get; }
+        [Obsolete("BaseUrl is deprecated, please use ServerUrl instead.")]
+        public string? BaseUrl
+        {
+            get => ServerUrl;
+        }
+        public string? ServerUrl { get; }
         public List<int> RetryScheduleMilliseconds { get; } = [50, 100, 200];
         public int TimeoutMilliseconds { get; } = 15000;
 
+        /// <param name="serverUrl">The server URL to connect to.</param>
+        /// <param name="baseUrl">[Deprecated] Please use serverUrl parameter instead.</param>
+#pragma warning disable CS0618
         public SvixOptions(
-            string baseUrl,
+            string? serverUrl = null,
             int timeoutMilliseconds = 15000,
-            List<int>? retryScheduleMilliseconds = null
+            List<int>? retryScheduleMilliseconds = null,
+            string? baseUrl = null
         )
         {
-            BaseUrl = baseUrl;
+            ServerUrl = serverUrl ?? baseUrl;
             TimeoutMilliseconds = timeoutMilliseconds;
             retryScheduleMilliseconds ??= [50, 100, 200];
             if (retryScheduleMilliseconds.Count > 5)
@@ -21,5 +30,6 @@ public SvixOptions(
             }
             RetryScheduleMilliseconds = retryScheduleMilliseconds;
         }
+#pragma warning restore CS0618
     }
 }

csharp/Svix/Utils.cs

@@ -51,8 +51,10 @@ internal static string DefaultServerUrlFromToken(string token)
             }
             else
             {
-                return "https://api.svix.com";
+                return DEFAULT_SERVER_URL;
             }
         }
+
+        internal static string DEFAULT_SERVER_URL = "https://api.svix.com";
     }
 }