Merge pull request #335 from purecloudlabs/STREAM-949

[STREAM-949] - Catch and emit error in `handleStanzaDisconnectedEvent`

Author: patrickfeeney03

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 # [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v19.5.0...HEAD)
+### Added
+* [STREAM-949](https://inindca.atlassian.net/browse/STREAM-949) - Catch errors and emit them as a `disconnected` event and include error.
 
 # [v19.5.0](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v19.4.1...v19.5.0)
 ### Added

index.html

@@ -29,6 +29,7 @@
     // loadScript('test/scripts/happy-path.js');
     // loadScript('test/scripts/duplicate-channel-connection.js');
     // loadScript('test/scripts/send-message.js');
+    // loadScript('test/scripts/token-becoming-invalid.js');
     // loadScript('test/scripts/401.js');
     // loadScript('test/scripts/custom-logger.js');
     // loadScript('test/scripts/connect-with-retry.js');
@@ -39,4 +40,4 @@
 
 </body>
 
-</html>
+</html>

package-lock.json

@@ -259,7 +259,18 @@ export class Client extends EventEmitter {
     this.emit('disconnected', { reconnecting: this.autoReconnect });
 
     if (this.autoReconnect) {
-      return this.connect({ keepTryingOnFailure: true });
+      return this.connect({ keepTryingOnFailure: true })
+        .catch(error => {
+          this.logger.error('Failed to auto reconnect', {
+            keepTryingOnFailure: true,
+            stanzaInstanceId: disconnectedInstance.id,
+            channelId: disconnectedInstance.channelId
+          });
+          this.emit('disconnected', {
+            error,
+            reconnecting: false
+          });
+        });
     }
   }
 

src/client.ts

@@ -0,0 +1,81 @@
+let client;
+
+const button = document.createElement('button');
+button.onclick = () => {
+  console.log('button clicked, going to send message');
+  const barejid = client.activeStanzaInstance?.jid?.match(/(.+\.com)/)?.[1];
+  const message = {
+    to: barejid,
+    from: client.activeStanzaInstance?.jid,
+    mediaMessage: { id: '123', method: 'headsetControlsRequest', params: { requestType: 'mediaHelper' }}
+  }
+  client.activeStanzaInstance?.sendMessage(message);
+};
+button.textContent = 'Send message';
+document.body.appendChild(button);
+
+const button2 = document.createElement('button');
+button2.textContent = 'Invalidate token';
+button2.onclick = async () => {
+  console.log('button clicked, invalidating auth token');
+  client.setAccessToken('');
+  await client.disconnect();
+  client.connect({ keepTryingOnFailure: true });
+}
+document.body.appendChild(button2);
+
+
+const authButon = document.createElement('button');
+authButon.textContent = 'Set auth token';
+authButon.onclick = () => {
+  const input = document.querySelector('input');
+  const token = input?.value;
+  console.log('auth token', token);
+  window.scConfig = {
+    authToken: token,
+    host: 'wss://streaming.inindca.com',
+    optOutOfWebrtcStatsTelemetry: true
+  };
+  client = new window.GenesysCloudStreamingClient(window.scConfig);
+  console.log('client');
+  window.client = client;
+  client.connect({ keepTryingOnFailure: true })
+    .then(() => {
+      console.log('Client connected 1');
+    });
+
+  client.on('error', (error) => {
+    console.log('RECEIVED Streaming Client Error!!!!', error);
+  });
+
+  client.on('disconnected', (e) => {
+    console.log('Client disconnected');
+    console.log(e);
+  })
+}
+document.body.appendChild(authButon);
+
+const authInput = document.createElement('input');
+authInput.type = 'text';
+document.body.appendChild(authInput);
+
+const clearAccessTokenBtn = document.createElement('button');
+clearAccessTokenBtn.textContent = 'Clear access token';
+clearAccessTokenBtn.onclick = () => {
+  window.client.setAccessToken('');
+}
+document.body.appendChild(clearAccessTokenBtn);
+
+
+const disconnect = document.createElement('button');
+disconnect.textContent = 'Disconnect';
+disconnect.onclick = () => {
+  window.client.disconnect();
+}
+document.body.appendChild(disconnect);
+
+
+//
+
+
+

test/scripts/token-becoming-invalid.js

@@ -1361,6 +1361,22 @@ describe('handleStanzaDisconnectedEvent', () => {
     expect(connectSpy).toHaveBeenCalled();
   });
 
+  it('should catch reconnection errors and emit them', async () => {
+    client['autoReconnect'] = true;
+
+    const err = {message: 'AXIOS 401 for example'}
+    const errorForThrowing = new StreamingClientError(StreamingClientErrorTypes.invalid_token, 'the error', err);
+
+    connectSpy = client.connect = jest.fn().mockRejectedValue(errorForThrowing);
+    const emitSpy = jest.spyOn(client, 'emit');
+
+    await client['handleStanzaDisconnectedEvent'](fakeStanza);
+
+    expect(client.connected).toBeFalsy();
+    expect(emitSpy).toHaveBeenCalledTimes(2);
+    expect(emitSpy).toHaveBeenNthCalledWith(2, 'disconnected', { error: errorForThrowing, reconnecting: false });
+  });
+
   it('should unproxy events', async () => {
     client['autoReconnect'] = false;