fix: provide a way for a suffix to be added to wsUrl (#1497)

## CLA

- [ ] I have signed the [Stream
CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform)
(required).
- [ ] Code changes are tested

## Description of the changes, What, Why and How?

## Changelog

-

Author: isekovanic

src/client.ts

@@ -330,6 +330,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
       warmUp: false,
       recoverStateOnReconnect: true,
       disableCache: false,
+      wsUrlSuffix: '',
       ...inputOptions,
     };
 

src/connection.ts

@@ -191,7 +191,7 @@ export class StableWSConnection<StreamChatGenerics extends ExtendableGenerics =
       this.client.key
     }&authorization=${token}&stream-auth-type=${this.client.getAuthType()}&X-Stream-Client=${encodeURIComponent(
       this.client.getUserAgent(),
-    )}`;
+    )}${this.client.options.wsUrlSuffix}`;
   };
 
   /**

src/types.ts

@@ -1241,6 +1241,11 @@ export type StreamChatOptions = AxiosRequestConfig & {
    * not be used in production apps.
    */
   wsConnection?: StableWSConnection;
+  /**
+   * Sets a suffix to the wsUrl when it is being built in `wsConnection`. Is meant to be
+   * used purely in testing suites and should not be used in production apps.
+   */
+  wsUrlSuffix?: string;
 };
 
 export type SyncOptions = {

test/unit/connection.js

@@ -91,6 +91,20 @@ describe('connection', function () {
 			const data = JSON.parse(query.json);
 			expect(data.device).to.deep.undefined;
 		});
+
+		it('should include extra params when building url if provided', function () {
+			const { query: prevQuery } = url.parse(ws._buildUrl(), true);
+			ws.client.options.wsUrlSuffix = '&foo=1&bar=2';
+			const { query } = url.parse(ws._buildUrl(), true);
+
+			// all of the previous query params should remain intact
+			Object.keys(prevQuery).forEach((key) => {
+				expect(prevQuery[key]).to.deep.equal(query[key]);
+			});
+			// only the updated query should contain the new ones
+			expect(query.foo).to.equal('1');
+			expect(query.bar).to.equal('2');
+		});
 	});
 
 	describe('isResolved flag', () => {