Merge pull request #163 from xmtp/client-version

Include client version header with API requests

Author: snormore

package-lock.json

@@ -59,6 +59,7 @@
     ]
   },
   "dependencies": {
+    "@jsbits/get-package-version": "^1.0.3",
     "@noble/secp256k1": "^1.5.2",
     "@stardazed/streams-polyfill": "^2.4.0",
     "@xmtp/proto": "^3.1.0",

package.json

@@ -4,11 +4,14 @@ import { retry, sleep } from './utils'
 import Long from 'long'
 import AuthCache from './authn/AuthCache'
 import { Authenticator } from './authn'
+import getPackageVersion from '@jsbits/get-package-version'
 export const { MessageApi, SortDirection } = messageApi
 
 const RETRY_SLEEP_TIME = 100
 const ERR_CODE_UNAUTHENTICATED = 16
 
+const clientVersionHeaderKey = 'X-Client-Version'
+
 export type GrpcError = Error & { code?: number }
 
 export type QueryParams = {
@@ -77,10 +80,12 @@ export default class ApiClient {
   pathPrefix: string
   maxRetries: number
   private authCache?: AuthCache
+  version: string
 
   constructor(pathPrefix: string, opts?: ApiClientOptions) {
     this.pathPrefix = pathPrefix
     this.maxRetries = opts?.maxRetries || 5
+    this.version = 'xmtp-js/' + getPackageVersion()
   }
 
   // Raw method for querying the API
@@ -89,7 +94,16 @@ export default class ApiClient {
   ): ReturnType<typeof MessageApi.Query> {
     return retry(
       MessageApi.Query,
-      [req, { pathPrefix: this.pathPrefix, mode: 'cors' }],
+      [
+        req,
+        {
+          pathPrefix: this.pathPrefix,
+          mode: 'cors',
+          headers: new Headers({
+            [clientVersionHeaderKey]: this.version,
+          }),
+        },
+      ],
       this.maxRetries,
       RETRY_SLEEP_TIME
     )
@@ -109,7 +123,10 @@ export default class ApiClient {
           {
             pathPrefix: this.pathPrefix,
             mode: 'cors',
-            headers: new Headers({ Authorization: `Bearer ${authToken}` }),
+            headers: new Headers({
+              Authorization: `Bearer ${authToken}`,
+              [clientVersionHeaderKey]: this.version,
+            }),
           },
         ],
         this.maxRetries,
@@ -143,6 +160,9 @@ export default class ApiClient {
         pathPrefix: this.pathPrefix,
         signal: abortController.signal,
         mode: 'cors',
+        headers: new Headers({
+          [clientVersionHeaderKey]: this.version,
+        }),
       }).catch(async (err: GrpcError) => {
         if (isAbortError(err)) {
           return

src/ApiClient.ts

@@ -5,6 +5,7 @@ import Long from 'long'
 import { sleep } from './helpers'
 import { Authenticator } from '../src/authn'
 import { PrivateKey } from '../src'
+import getPackageVersion from '@jsbits/get-package-version'
 const { MessageApi } = messageApi
 
 const PATH_PREFIX = 'http://fake:5050'
@@ -51,6 +52,9 @@ describe('Query', () => {
     expect(apiMock).toHaveBeenCalledWith(expectedReq, {
       pathPrefix: PATH_PREFIX,
       mode: 'cors',
+      headers: new Headers({
+        'X-Client-Version': 'xmtp-js/' + getPackageVersion(),
+      }),
     })
   })
 
@@ -99,6 +103,9 @@ describe('Query', () => {
     expect(apiMock).toHaveBeenCalledWith(expectedReq, {
       pathPrefix: PATH_PREFIX,
       mode: 'cors',
+      headers: new Headers({
+        'X-Client-Version': 'xmtp-js/' + getPackageVersion(),
+      }),
     })
   })
 
@@ -124,6 +131,9 @@ describe('Query', () => {
     expect(apiMock).toHaveBeenLastCalledWith(expectedReq, {
       pathPrefix: PATH_PREFIX,
       mode: 'cors',
+      headers: new Headers({
+        'X-Client-Version': 'xmtp-js/' + getPackageVersion(),
+      }),
     })
   })
 })
@@ -164,7 +174,10 @@ describe('Publish', () => {
     expect(publishMock).toHaveBeenCalledWith(expectedRequest, {
       pathPrefix: PATH_PREFIX,
       mode: 'cors',
-      headers: new Headers({ Authorization: `Bearer ${AUTH_TOKEN}` }),
+      headers: new Headers({
+        Authorization: `Bearer ${AUTH_TOKEN}`,
+        'X-Client-Version': 'xmtp-js/' + getPackageVersion(),
+      }),
     })
   })
 
@@ -237,6 +250,9 @@ describe('Subscribe', () => {
       pathPrefix: PATH_PREFIX,
       signal: expect.anything(),
       mode: 'cors',
+      headers: new Headers({
+        'X-Client-Version': 'xmtp-js/' + getPackageVersion(),
+      }),
     })
   })