Merge pull request #91 from meilisearch/add_user_agent_in_client

Pass firebase client agent to meilisearch-js
meilisearch · Jul 11, 2022 · 8448006 · 8448006
2 parents c871e05 + 1aea6da
commit 8448006
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/functions/__tests__/functions.test.ts b/functions/__tests__/functions.test.ts
@@ -5,6 +5,7 @@ import { mockConsoleLog, mockConsoleInfo } from './__mocks__/console'
 import { MeiliSearch } from 'meilisearch'
 import defaultEnvironment from './data/environment'
 import defaultDocument from './data/document'
+import { version } from '../src/version'
 
 jest.mock('meilisearch')
 
@@ -52,6 +53,7 @@ describe('extension', () => {
     expect(mockedMeilisearch).toHaveBeenCalledWith({
       apiKey: defaultEnvironment.MEILISEARCH_API_KEY,
       host: defaultEnvironment.MEILISEARCH_HOST,
+      clientAgents: [`Meilisearch Firebase (v${version})`],
     })
     expect(mockConsoleLog).toBeCalledWith(
       'Initializing extension with configuration',

diff --git a/functions/src/meilisearch/agents.ts b/functions/src/meilisearch/agents.ts
@@ -0,0 +1,9 @@
+import { version } from '../version'
+
+export const constructClientAgents = (
+  clientAgents: string[] = []
+): string[] => {
+  const firebaseAgent = `Meilisearch Firebase (v${version})`
+
+  return clientAgents.concat(firebaseAgent)
+}
diff --git a/functions/src/meilisearch/create-index.ts b/functions/src/meilisearch/create-index.ts
@@ -1,5 +1,6 @@
 import { MeiliSearch, Index } from 'meilisearch'
 import { MeilisearchConfig } from '../types'
+import { constructClientAgents } from './agents'
 
 /**
  * initMeilisearchIndex
@@ -14,6 +15,7 @@ export function initMeilisearchIndex({
   const client = new MeiliSearch({
     host,
     apiKey,
+    clientAgents: constructClientAgents(),
   })
 
   return client.index(indexUid)