Configure user agent.

powersync-ja · Sep 2, 2024 · 5968662 · 5968662
1 parent 8bc5391
commit 5968662
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/packages/common/src/client/sync/stream/AbstractRemote.ts b/packages/common/src/client/sync/stream/AbstractRemote.ts
@@ -10,6 +10,8 @@ import type { BSON } from 'bson';
 import { AbortOperation } from '../../../utils/AbortOperation';
 import { Buffer } from 'buffer';
 
+import { version as POWERSYNC_JS_VERSION } from '../../../../package.json';
+
 export type BSONImplementation = typeof BSON;
 
 export type RemoteConnector = {
@@ -109,6 +111,10 @@ export abstract class AbstractRemote {
     return this.credentials;
   }
 
+  getUserAgent() {
+    return `powersync-js/${POWERSYNC_JS_VERSION}`;
+  }
+
   protected async buildRequest(path: string) {
     const credentials = await this.getCredentials();
     if (credentials != null && (credentials.endpoint == null || credentials.endpoint == '')) {
@@ -119,11 +125,14 @@ export abstract class AbstractRemote {
       throw error;
     }
 
+    const userAgent = this.getUserAgent();
+
     return {
       url: credentials.endpoint + path,
       headers: {
         'content-type': 'application/json',
-        Authorization: `Token ${credentials.token}`
+        Authorization: `Token ${credentials.token}`,
+        'x-user-agent': userAgent
       }
     };
   }
@@ -207,6 +216,11 @@ export abstract class AbstractRemote {
 
     const bson = await this.getBSON();
 
+    // Add the user agent in the setup payload - we can't set custom
+    // headers with websockets. The browser userAgent is however added
+    // automatically as a header.
+    const userAgent = this.getUserAgent();
+
     const connector = new RSocketConnector({
       transport: new WebsocketClientTransport({
         url: this.options.socketUrlTransformer(request.url)
@@ -220,7 +234,8 @@ export abstract class AbstractRemote {
           data: null,
           metadata: Buffer.from(
             bson.serialize({
-              token: request.headers.Authorization
+              token: request.headers.Authorization,
+              user_agent: userAgent
             })
           )
         }

diff --git a/packages/react-native/src/sync/stream/ReactNativeRemote.ts b/packages/react-native/src/sync/stream/ReactNativeRemote.ts
@@ -18,6 +18,8 @@ import { BSON } from 'bson';
 
 import { fetch } from 'react-native-fetch-api';
 
+import { version as POWERSYNC_RN_VERSION } from '../../../package.json';
+
 export const STREAMING_POST_TIMEOUT_MS = 30_000;
 
 /**
@@ -43,6 +45,10 @@ export class ReactNativeRemote extends AbstractRemote {
     });
   }
 
+  getUserAgent(): string {
+    return `${super.getUserAgent()} (react-native/${POWERSYNC_RN_VERSION})`;
+  }
+
   async getBSON(): Promise<BSONImplementation> {
     return BSON;
   }

diff --git a/packages/web/src/db/sync/WebRemote.ts b/packages/web/src/db/sync/WebRemote.ts
@@ -10,6 +10,8 @@ import {
   RemoteConnector
 } from '@powersync/common';
 
+import { version as POWERSYNC_WEB_VERSION } from '../../../package.json';
+
 /*
  * Depends on browser's implementation of global fetch.
  */
@@ -33,6 +35,10 @@ export class WebRemote extends AbstractRemote {
     });
   }
 
+  getUserAgent(): string {
+    return `${super.getUserAgent()} (web/${POWERSYNC_WEB_VERSION})`;
+  }
+
   async getBSON(): Promise<BSONImplementation> {
     if (this._bson) {
       return this._bson;

diff --git a/packages/web/tsconfig.json b/packages/web/tsconfig.json
@@ -20,5 +20,5 @@
       "path": "../common"
     }
   ],
-  "include": ["src/**/*", "tests/**/*"]
+  "include": ["src/**/*", "tests/**/*", "package.json"]
 }