Add SDK/version as User-Agent in HTTPClients (#204)

* Add SDK+version as user-agent in HttpClients for C#/JS/Python/Rust

Format and modify tests accordingly

* Address comments

Capitalize AssemblyVersion, use cs instead of C#

* Lowercase SDK

* Update version

* Rm outdated

Author: bmehta001

sdk/cs/samples/TestApp/Program.cs

@@ -15,7 +15,7 @@ public class TestApp
 {
     public static async Task Main(string[] args)
     {
-        var app = new TestApp(); // Create an instance of TestApp  
+        var app = new TestApp(); // Create an instance of TestApp
 
         Console.WriteLine(new string('=', 80)); // Separator for clarity
         Console.WriteLine("Testing catalog integration...");
@@ -84,7 +84,7 @@ private async Task TestService()
     }
 
     private async Task TestCatalog()
-    // First test catalog listing  
+    // First test catalog listing
     {
         using var manager = new FoundryLocalManager();
         foreach (var m in await manager.ListCatalogModelsAsync())

sdk/cs/src/FoundryLocalManager.cs

@@ -13,6 +13,7 @@ namespace Microsoft.AI.Foundry.Local;
 using System.Linq;
 using System.Net.Http.Json;
 using System.Net.Mime;
+using System.Reflection;
 using System.Runtime.InteropServices;
 using System.Text;
 using System.Text.Json;
@@ -47,6 +48,7 @@ public partial class FoundryLocalManager : IDisposable, IAsyncDisposable
     private List<ModelInfo>? _catalogModels;
     private Dictionary<string, ModelInfo>? _catalogDictionary;
     private readonly Dictionary<ExecutionProvider, int> _priorityMap;
+    private static readonly string AssemblyVersion = typeof(FoundryLocalManager).Assembly.GetName().Version?.ToString() ?? "unknown";
 
     // Gets the service URI
     public Uri ServiceUri => _serviceUri ?? throw new InvalidOperationException("Service URI is not set. Call StartServiceAsync() first.");
@@ -111,6 +113,8 @@ public async Task StartServiceAsync(CancellationToken ct = default)
                 // set the timeout to 2 hours (for downloading large models)
                 Timeout = TimeSpan.FromSeconds(7200)
             };
+
+            _serviceClient.DefaultRequestHeaders.UserAgent.ParseAdd($"foundry-local-cs-sdk/{AssemblyVersion}");
         }
     }
 

sdk/js/package-lock.json

@@ -12,7 +12,7 @@
   "types": "dist/index.d.ts",
   "license": "MIT",
   "scripts": {
-    "build": "unbuild",
+    "build": "npx genversion -e src/version.ts && unbuild",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "lint": "eslint ./src/*",
@@ -42,6 +42,7 @@
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jsdoc": "^46.8.2",
+    "genversion": "^3.2.0",
     "prettier": "^3.2.4",
     "typescript": "^5.2.2",
     "unbuild": "^3.5.0",

sdk/js/package.json

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import type { Fetch } from './types.js'
+import { version } from './version.js'
 
 /**
  * Handles fetch requests with error handling.
@@ -71,7 +72,7 @@ export const postWithProgress = async (
   // Sending a POST request and getting a streamable response
   const response = await fetchWithErrorHandling(fetch, host, {
     method: 'POST',
-    headers: { 'Content-Type': 'application/json' },
+    headers: { 'Content-Type': 'application/json', 'User-Agent': `foundry-local-js-sdk/${version}` },
     body: body ? JSON.stringify(body) : undefined,
   })
 

sdk/js/src/client.ts

@@ -0,0 +1,2 @@
+// Generated by genversion.
+export const version = '0.4.0'

sdk/js/src/version.ts

@@ -4,6 +4,7 @@
 import { describe, expect, it, vi, beforeEach } from 'vitest'
 import * as client from '../src/client'
 import type { Fetch } from '../src/types'
+import { version } from '../src/version'
 
 describe('Client', () => {
   const mockFetch = vi.fn() as unknown as Fetch
@@ -60,7 +61,10 @@ describe('Client', () => {
       expect(result).toEqual({ ok: true })
       expect(mockFetch).toHaveBeenCalledWith('http://example.com', {
         method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
+        headers: {
+            'Content-Type': 'application/json',
+            'User-Agent': `foundry-local-js-sdk/${version}`,
+        },
         body: JSON.stringify(body),
       })
     })

sdk/js/test/client.test.ts

@@ -19,5 +19,3 @@
 _logger.propagate = False
 
 __all__ = ["FoundryLocalManager"]
-
-__version__ = "0.4.0"

sdk/python/foundry_local/__init__.py

@@ -11,6 +11,8 @@
 import httpx
 from tqdm import tqdm
 
+from foundry_local.version import __version__ as sdk_version
+
 logger = logging.getLogger(__name__)
 
 
@@ -34,7 +36,8 @@ def __init__(self, host: str, timeout: float | httpx.Timeout | None = None) -> N
             host (str): Base URL of the host.
             timeout (float | httpx.Timeout | None): Timeout for the HTTP client.
         """
-        self._client = httpx.Client(base_url=host, timeout=timeout)
+        headers = {"user-agent": f"foundry-local-python-sdk/{sdk_version}"}
+        self._client = httpx.Client(base_url=host, timeout=timeout, headers=headers)
 
     def _request(self, *args, **kwargs) -> httpx.Response:
         """

sdk/python/foundry_local/client.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"