Adding custom User-Agent to spice.js (#213)

* Adding custom user-agent to spice.js * Fixing User-Agent header
spiceai · Nov 21, 2024 · 232d046 · 232d046
1 parent 968f00c
commit 232d046
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/src/client.ts b/src/client.ts
@@ -60,8 +60,9 @@ class SpiceClient {
       this._apiKey = params;
       this._httpUrl = 'https://data.spiceai.io';
       this._flightUrl = 'flight.spiceai.io:443';
+      this._userAgent = getUserAgent();
     } else {
-      const { apiKey, httpUrl, flightUrl, flightTlsEnabled } = params;
+      const { apiKey, httpUrl, flightUrl, flightTlsEnabled, userAgent } = params;
 
       this._apiKey = apiKey;
       this._httpUrl = httpUrl || 'http://127.0.0.1:8090';
@@ -72,9 +73,8 @@ class SpiceClient {
           : this._flightUrl.includes('127.0.0.1')
             ? false
             : true;
+      this._userAgent = userAgent || getUserAgent();
     }
-
-    this._userAgent = getUserAgent();
   }
 
   private createClient(meta: any): any {
@@ -105,7 +105,7 @@ class SpiceClient {
     const meta = new grpc.Metadata();
     const client: FlightClient = this.createClient(meta);
     meta.set('authorization', 'Bearer ' + this._apiKey);
-    meta.set('x-spice-user-agent', this._userAgent);
+    meta.set('User-Agent', this._userAgent);
 
     let queryBuff = Buffer.from(queryText, 'utf8');
 
@@ -231,7 +231,7 @@ class SpiceClient {
     const headers = [
       ['Content-Type', 'application/json'],
       ['Accept-Encoding', 'br, gzip, deflate'],
-      ['X-Spice-User-Agent', this._userAgent]
+      ['User-Agent', this._userAgent]
     ];
 
     if (this._apiKey) {

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -34,6 +34,7 @@ export interface SpiceClientConfig {
   httpUrl?: string;
   flightUrl?: string;
   flightTlsEnabled?: boolean;
+  userAgent?: string;
 }
 
 export interface RefreshOverrides {

diff --git a/src/user-agent.ts b/src/user-agent.ts
@@ -5,5 +5,5 @@ export function getUserAgent(): string {
     const osType = os.type();
     const osRelease = os.release();
     const osArch = os.machine();
-    return `spice.js ${VERSION} (${osType}/${osRelease} ${osArch})`;
+    return `spice.js/${VERSION} (${osType}/${osRelease} ${osArch})`;
 }
diff --git a/test/user-agent.test.ts b/test/user-agent.test.ts
@@ -1,7 +1,7 @@
 import { getUserAgent } from "../src/user-agent";
 
 describe("user-agent", () => {
-    const matching_regex = /spice.js \d+\.\d+\.\d+ \((Linux|Windows|Darwin)\/[\d\w\.\-\_]+ (x86_64|aarch64|i386|arm64)\)/;
+    const matching_regex = /spice.js\/\d+\.\d+\.\d+ \((Linux|Windows|Darwin)\/[\d\w\.\-\_]+ (x86_64|aarch64|i386|arm64)\)/;
 
     it("should match the user-agent regex", async () => {
         const ua = getUserAgent();