Adjust bundle.mjs, add CLIENT_BUNDLE for reporting

Author: arnautov-anton

scripts/bundle.mjs

@@ -28,6 +28,14 @@ const commonBuildOptions = {
   },
 };
 
+/**
+ * process.env.CLIENT_BUNDLE values:
+ *
+ * - index.js - browser-esm
+ * - index.browser.cjs - browser-cjs
+ * - index.node.cjs - node-cjs
+ */
+
 // We build two CJS bundles: for browser and for node. The latter one can be
 // used e.g. during SSR (although it makes little sence to SSR chat, but still
 // nice for import not to break on server).
@@ -43,7 +51,7 @@ const bundles = [
     platform,
     define: {
       ...commonBuildOptions.define,
-      'process.env.BUILD': JSON.stringify(`${platform}-cjs`),
+      'process.env.CLIENT_BUNDLE': JSON.stringify(`${platform}-cjs`),
     },
   })),
   // ESM (browser only)
@@ -55,7 +63,7 @@ const bundles = [
     platform: 'browser',
     define: {
       ...commonBuildOptions.define,
-      'process.env.BUILD': JSON.stringify(`browser-esm`),
+      'process.env.CLIENT_BUNDLE': JSON.stringify('browser-esm'),
     },
   },
 ]

src/client.ts

@@ -2923,12 +2923,23 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     if (this.userAgent) {
       return this.userAgent;
     }
+
     const version = process.env.PKG_VERSION;
+    const clientBundle = process.env.CLIENT_BUNDLE;
+
+    let userAgentString = '';
     if (this.sdkIdentifier) {
-      return `stream-chat-${this.sdkIdentifier.name}-v${this.sdkIdentifier.version}-llc-v${version}`;
+      userAgentString = `stream-chat-${this.sdkIdentifier.name}-v${this.sdkIdentifier.version}-llc-v${version}`;
     } else {
-      return `stream-chat-js-v${version}-${this.node ? 'node' : 'browser'}`;
+      userAgentString = `stream-chat-js-v${version}-${this.node ? 'node' : 'browser'}`;
     }
+
+    const additionalOptions = ([
+      // reports which bundle is being picked from the exports
+      ['client_bundle', clientBundle],
+    ] as const).map(([key, value]) => `${key}=${value ?? ''}`);
+
+    return [userAgentString, ...additionalOptions].join('|');
   }
 
   /**

test/unit/client.js

@@ -644,6 +644,7 @@ describe('StreamChat.queryChannels', async () => {
 
 describe('X-Stream-Client header', () => {
 	process.env.PKG_VERSION = '1.2.3';
+	process.env.CLIENT_BUNDLE = 'browser-esm';
 	let client;
 
 	beforeEach(async () => {
@@ -653,21 +654,21 @@ describe('X-Stream-Client header', () => {
 	it('server-side integration', () => {
 		const userAgent = client.getUserAgent();
 
-		expect(userAgent).to.be.equal('stream-chat-js-v1.2.3-node');
+		expect(userAgent).to.be.equal('stream-chat-js-v1.2.3-node|client_bundle=browser-esm');
 	});
 
 	it('client-side integration', () => {
 		client.node = false;
 		const userAgent = client.getUserAgent();
 
-		expect(userAgent).to.be.equal('stream-chat-js-v1.2.3-browser');
+		expect(userAgent).to.be.equal('stream-chat-js-v1.2.3-browser|client_bundle=browser-esm');
 	});
 
 	it('SDK integration', () => {
 		client.sdkIdentifier = { name: 'react', version: '2.3.4' };
 		const userAgent = client.getUserAgent();
 
-		expect(userAgent).to.be.equal('stream-chat-react-v2.3.4-llc-v1.2.3');
+		expect(userAgent).to.be.equal('stream-chat-react-v2.3.4-llc-v1.2.3|client_bundle=browser-esm');
 	});
 
 	it('setUserAgent is now deprecated', () => {