feat(chat): annotate with algoliaAgent (#6812)

[FX-3592]

Author: Haroenv

packages/instantsearch.js/src/connectors/chat/connectChat.ts

@@ -8,6 +8,7 @@ import {
   checkRendering,
   createDocumentationMessageGenerator,
   createSendEventForHits,
+  getAlgoliaAgent,
   getAppIdAndApiKey,
   noop,
   warning,
@@ -191,6 +192,7 @@ export default (function connectChat<TWidgetParams extends UnknownWidgetParams>(
           headers: {
             'x-algolia-application-id': appId,
             'x-algolia-api-Key': apiKey,
+            'x-algolia-agent': getAlgoliaAgent(instantSearchInstance.client),
           },
         });
       }

packages/instantsearch.js/src/lib/utils/__tests__/getAlgoliaAgent-test.ts

@@ -0,0 +1,25 @@
+import algoliasearchV3 from 'algoliasearch-v3';
+import algoliasearchV4 from 'algoliasearch-v4';
+import { algoliasearch as algoliasearchV5 } from 'algoliasearch-v5';
+
+import { getAlgoliaAgent } from '../getAlgoliaAgent';
+
+describe('getAlgoliaAgent', () => {
+  it('should return the user agent for v5 clients', () => {
+    expect(getAlgoliaAgent(algoliasearchV5('appId', 'apiKey'))).toMatch(
+      /Algolia for JavaScript \(5\.\d+\.\d+(?:-[^)]+)?\)/
+    );
+  });
+
+  it('should return the user agent for v4 clients', () => {
+    expect(getAlgoliaAgent(algoliasearchV4('appId', 'apiKey'))).toMatch(
+      /Algolia for JavaScript \(4\.\d+\.\d+(?:-[^)]+)?\)/
+    );
+  });
+
+  it('should return the user agent for v3 clients', () => {
+    expect(getAlgoliaAgent(algoliasearchV3('appId', 'apiKey'))).toMatch(
+      /Algolia for JavaScript \(3\.\d+\.\d+(?:-[^)]+)?\)/
+    );
+  });
+});

packages/instantsearch.js/src/lib/utils/getAlgoliaAgent.ts

@@ -0,0 +1,10 @@
+type v4 = { transporter?: { userAgent: { value: string } } };
+type v3 = { _ua: string };
+type AnySearchClient = v4 & v3;
+
+export function getAlgoliaAgent(client: unknown): string {
+  const clientTyped = client as AnySearchClient;
+  return clientTyped.transporter && clientTyped.transporter.userAgent
+    ? clientTyped.transporter.userAgent.value
+    : clientTyped._ua;
+}

packages/instantsearch.js/src/lib/utils/index.ts

@@ -18,6 +18,7 @@ export * from './escapeFacetValue';
 export * from './find';
 export * from './findIndex';
 export * from './geo-search';
+export * from './getAlgoliaAgent';
 export * from './getAppIdAndApiKey';
 export * from './getContainerNode';
 export * from './getHighlightedParts';

packages/instantsearch.js/src/middlewares/createMetadataMiddleware.ts

@@ -1,4 +1,8 @@
-import { createInitArgs, safelyRunOnBrowser } from '../lib/utils';
+import {
+  createInitArgs,
+  getAlgoliaAgent,
+  safelyRunOnBrowser,
+} from '../lib/utils';
 
 import type {
   InstantSearch,
@@ -103,11 +107,7 @@ export function createMetadataMiddleware({
       subscribe() {
         // using setTimeout here to delay extraction until widgets have been added in a tick (e.g. Vue)
         setTimeout(() => {
-          const client = instantSearchInstance.client as any;
-          payload.ua =
-            client.transporter && client.transporter.userAgent
-              ? client.transporter.userAgent.value
-              : client._ua;
+          payload.ua = getAlgoliaAgent(instantSearchInstance.client);
 
           extractWidgetPayload(
             instantSearchInstance.mainIndex.getWidgets(),