feat(client): Call event reporting

packages/client/src/StreamSfuClient.ts

@@ -40,7 +40,7 @@ import {
 import { withoutConcurrency } from './helpers/concurrency';
 import { getTimers } from './timers';
 import { Tracer, TraceSlice } from './stats';
-import { SfuJoinError } from './errors';
+import { SfuJoinError, SfuTimeoutError } from './errors';
 
 export type StreamSfuClientConstructor = {
   /**
@@ -353,7 +353,7 @@ export class StreamSfuClient {
           timeoutId = setTimeout(() => {
             const message = `SFU WS connection failed to open after ${this.joinResponseTimeout}ms`;
             this.tracer?.trace('signal.timeout', message);
-            reject(new Error(message));
+            reject(new SfuTimeoutError(message));
           }, this.joinResponseTimeout);
         }),
       ]),
@@ -644,7 +644,7 @@ export class StreamSfuClient {
       cleanupJoinSubscriptions();
       const message = `Waiting for "joinResponse" has timed out after ${this.joinResponseTimeout}ms`;
       this.tracer?.trace('joinRequestTimeout', message);
-      current.reject(new Error(message));
+      current.reject(new SfuTimeoutError(message));
     }, this.joinResponseTimeout);
 
     const joinRequest = SfuRequest.create({

packages/client/src/StreamVideoClient.ts

@@ -42,6 +42,7 @@ import { logToConsole, ScopedLogger, videoLoggerSystem } from './logger';
 import { isReactNative } from './helpers/platforms';
 import { withoutConcurrency } from './helpers/concurrency';
 import { enableTimerWorker } from './timers';
+import { ClientEventReporter } from './reporting';
 
 /**
  * A `StreamVideoClient` instance lets you communicate with our API, and authenticate users.
@@ -60,6 +61,7 @@ export class StreamVideoClient {
 
   protected readonly writeableStateStore: StreamVideoWriteableStateStore;
   streamClient: StreamClient;
+  readonly clientEventReporter: ClientEventReporter;
 
   private effectsRegistered = false;
   private eventHandlersToUnregister: Array<() => void> = [];
@@ -97,6 +99,9 @@ export class StreamVideoClient {
     this.rejectCallWhenBusy = clientOptions?.rejectCallWhenBusy ?? false;
 
     this.streamClient = createCoordinatorClient(apiKey, clientOptions);
+    this.clientEventReporter = new ClientEventReporter({
+      streamClient: this.streamClient,
+    });
 
     this.writeableStateStore = new StreamVideoWriteableStateStore();
     this.readOnlyStateStore = new StreamVideoReadOnlyStateStore(
@@ -214,6 +219,7 @@ export class StreamVideoClient {
 
         call = new Call({
           streamClient: this.streamClient,
+          clientEventReporter: this.clientEventReporter,
           type: e.call.type,
           id: e.call.id,
           members: e.members,
@@ -296,6 +302,9 @@ export class StreamVideoClient {
       return this.connectAnonymousUser(user as UserWithId, tokenOrProvider);
     }
 
+    const reporter = this.clientEventReporter;
+    reporter.startCoordinatorConnection(user.id);
+
     const connectUserResponse = await withoutConcurrency(
       this.connectionConcurrencyTag,
       async () => {
@@ -309,13 +318,16 @@ export class StreamVideoClient {
         for (let attempt = 0; attempt < maxConnectUserRetries; attempt++) {
           try {
             this.logger.trace(`Connecting user (${attempt})`, user);
-            return user.type === 'guest'
-              ? await client.connectGuestUser(user)
-              : await client.connectUser(user, tokenOrProvider);
+            return await reporter.trackCoordinatorWs(() =>
+              user.type === 'guest'
+                ? client.connectGuestUser(user)
+                : client.connectUser(user, tokenOrProvider),
+            );
           } catch (err) {
             this.logger.warn(`Failed to connect a user (${attempt})`, err);
             errorQueue.push(err as Error);
             if (attempt === maxConnectUserRetries - 1) {
+              reporter.closeCoordinatorWs();
               onConnectUserError?.(err as Error, errorQueue);
               throw err;
             }
@@ -415,6 +427,7 @@ export class StreamVideoClient {
       call ??
       new Call({
         streamClient: this.streamClient,
+        clientEventReporter: this.clientEventReporter,
         id: id,
         type: type,
         clientStore: this.writeableStateStore,
@@ -448,6 +461,7 @@ export class StreamVideoClient {
     for (const c of response.calls) {
       const call = new Call({
         streamClient: this.streamClient,
+        clientEventReporter: this.clientEventReporter,
         id: c.call.id,
         type: c.call.type,
         members: c.members,
@@ -591,6 +605,7 @@ export class StreamVideoClient {
         const [callType, callId] = call_cid.split(':');
         call = new Call({
           streamClient: this.streamClient,
+          clientEventReporter: this.clientEventReporter,
           type: callType,
           id: callId,
           clientStore: this.writeableStateStore,

packages/client/src/__tests__/Call.autodrop.test.ts

@@ -3,6 +3,7 @@ import '../rtc/__tests__/mocks/webrtc.mocks';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { Call } from '../Call';
 import { StreamClient } from '../coordinator/connection/client';
+import { ClientEventReporter } from '../reporting';
 import { generateUUIDv4 } from '../coordinator/connection/utils';
 import { CallingState, StreamVideoWriteableStateStore } from '../store';
 
@@ -14,10 +15,12 @@ describe('Auto drop ringing calls', () => {
     vi.useFakeTimers();
 
     const clientStore = new StreamVideoWriteableStateStore();
+    const streamClient = new StreamClient('abc');
     call = new Call({
       type: 'test',
       id: generateUUIDv4(),
-      streamClient: new StreamClient('abc'),
+      streamClient,
+      clientEventReporter: new ClientEventReporter({ streamClient }),
       clientStore: clientStore,
     });
 

packages/client/src/__tests__/Call.lifecycle.test.ts

@@ -7,17 +7,20 @@ import '../rtc/__tests__/mocks/webrtc.mocks';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { Call } from '../Call';
 import { StreamClient } from '../coordinator/connection/client';
+import { ClientEventReporter } from '../reporting';
 import { generateUUIDv4 } from '../coordinator/connection/utils';
 import { StreamVideoWriteableStateStore } from '../store';
 
 describe('Call lifecycle wiring', () => {
   let call: Call;
 
   beforeEach(() => {
+    const streamClient = new StreamClient('abc');
     call = new Call({
       type: 'test',
       id: generateUUIDv4(),
-      streamClient: new StreamClient('abc'),
+      streamClient,
+      clientEventReporter: new ClientEventReporter({ streamClient }),
       clientStore: new StreamVideoWriteableStateStore(),
     });
   });

packages/client/src/__tests__/Call.publishing.test.ts

@@ -4,6 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { Call } from '../Call';
 import { Publisher } from '../rtc';
 import { StreamClient } from '../coordinator/connection/client';
+import { ClientEventReporter } from '../reporting';
 import { generateUUIDv4 } from '../coordinator/connection/utils';
 import { PermissionsContext } from '../permissions';
 import { OwnCapability } from '../gen/coordinator';
@@ -15,10 +16,12 @@ describe('Publishing and Unpublishing tracks', () => {
   let call: Call;
 
   beforeEach(async () => {
+    const streamClient = new StreamClient('abc');
     call = new Call({
       type: 'test',
       id: generateUUIDv4(),
-      streamClient: new StreamClient('abc'),
+      streamClient,
+      clientEventReporter: new ClientEventReporter({ streamClient }),
       clientStore: new StreamVideoWriteableStateStore(),
     });
 

packages/client/src/__tests__/Call.test.ts

@@ -300,6 +300,29 @@ describe('muting logic', () => {
   });
 });
 
+describe('client event reporting', () => {
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  it('reports a client-aborted event and unregisters the call on leave', async () => {
+    const call = client.call('default', generateUUIDv4());
+    await call.getOrCreate();
+
+    const reporter = call.clientEventReporter;
+    const abortSpy = vi.spyOn(reporter, 'abort');
+    const unregisterSpy = vi.spyOn(reporter, 'unregisterCall');
+
+    await call.leave();
+
+    expect(abortSpy).toHaveBeenCalledWith(call.cid, {
+      code: 'CLIENT_ABORTED',
+      reason: expect.any(String),
+    });
+    expect(unregisterSpy).toHaveBeenCalledWith(call.cid);
+  });
+});
+
 afterEach(() => {
   client.disconnectUser();
 });

packages/client/src/coordinator/connection/client.ts

@@ -617,6 +617,11 @@ export class StreamClient {
     return await this.wsConnection.connect(this.defaultWSTimeout);
   };
 
+  getSdkVersion = (): string =>
+    this.options.clientAppIdentifier?.sdkVersion ||
+    process.env.PKG_VERSION ||
+    '0.0.0';
+
   getUserAgent = (): string => {
     if (!this.cachedUserAgent) {
       const { clientAppIdentifier = {} } = this.options;

packages/client/src/devices/__tests__/CameraManager.test.ts

@@ -1,5 +1,6 @@
 import { Call } from '../../Call';
 import { StreamClient } from '../../coordinator/connection/client';
+import { ClientEventReporter } from '../../reporting';
 import { CallingState, StreamVideoWriteableStateStore } from '../../store';
 
 import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
@@ -56,6 +57,12 @@ vi.mock('../../Call.ts', () => {
   };
 });
 
+vi.mock('../../reporting/ClientEventReporter', () => ({
+  ClientEventReporter: vi.fn(function () {
+    return {};
+  }),
+}));
+
 vi.mock('../../helpers/compatibility.ts', () => {
   console.log('MOCKING mobile device');
   return {
@@ -76,10 +83,12 @@ describe('CameraManager', () => {
 
   beforeEach(() => {
     const devicePersistence = { enabled: false, storageKey: '' };
+    const streamClient = new StreamClient('abc123', { devicePersistence });
     call = new Call({
       id: '',
       type: '',
-      streamClient: new StreamClient('abc123', { devicePersistence }),
+      streamClient,
+      clientEventReporter: new ClientEventReporter({ streamClient }),
       clientStore: new StreamVideoWriteableStateStore(),
     });
     manager = new CameraManager(call, devicePersistence);

packages/client/src/devices/__tests__/DeviceManager.test.ts

@@ -1,6 +1,7 @@
 /* @vitest-environment happy-dom */
 import { Call } from '../../Call';
 import { StreamClient } from '../../coordinator/connection/client';
+import { ClientEventReporter } from '../../reporting';
 import { CallingState, StreamVideoWriteableStateStore } from '../../store';
 
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
@@ -22,6 +23,12 @@ import { TrackType } from '../../gen/video/sfu/models/models';
 import { PermissionsContext } from '../../permissions';
 import { readPreferences } from '../devicePersistence';
 
+vi.mock('../../reporting/ClientEventReporter', () => ({
+  ClientEventReporter: vi.fn(function () {
+    return {};
+  }),
+}));
+
 vi.mock('../../Call.ts', () => {
   console.log('MOCKING Call');
   return {
@@ -85,11 +92,13 @@ describe('Device Manager', () => {
       configurable: true,
       value: localStorageMock,
     });
+    const streamClient = new StreamClient('abc123');
     manager = new TestInputMediaDeviceManager(
       new Call({
         id: '',
         type: '',
-        streamClient: new StreamClient('abc123'),
+        streamClient,
+        clientEventReporter: new ClientEventReporter({ streamClient }),
         clientStore: new StreamVideoWriteableStateStore(),
       }),
       { enabled: false, storageKey },

packages/client/src/devices/__tests__/DeviceManagerFilters.test.ts

@@ -2,6 +2,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { of } from 'rxjs';
 import { Call } from '../../Call';
 import { StreamClient } from '../../coordinator/connection/client';
+import { ClientEventReporter } from '../../reporting';
 import { StreamVideoWriteableStateStore } from '../../store';
 import { DeviceManagerState } from '../DeviceManagerState';
 import { DeviceManager } from '../DeviceManager';
@@ -45,11 +46,13 @@ describe('MediaStream Filters', () => {
   let manager: TestInputMediaDeviceManager;
 
   beforeEach(() => {
+    const streamClient = new StreamClient('abc123');
     manager = new TestInputMediaDeviceManager(
       new Call({
         id: '',
         type: '',
-        streamClient: new StreamClient('abc123'),
+        streamClient,
+        clientEventReporter: new ClientEventReporter({ streamClient }),
         clientStore: new StreamVideoWriteableStateStore(),
       }),
     );

packages/client/src/devices/__tests__/MicrophoneManager.test.ts

@@ -43,6 +43,7 @@ import {
   readPreferences,
   toPreferenceList,
 } from '../devicePersistence';
+import { ClientEventReporter } from '../../reporting';
 
 vi.mock('../devices.ts', () => {
   console.log('MOCKING devices API');
@@ -82,6 +83,12 @@ vi.mock('../../Call.ts', () => {
   };
 });
 
+vi.mock('../../reporting/ClientEventReporter', () => ({
+  ClientEventReporter: vi.fn(function () {
+    return {};
+  }),
+}));
+
 describe('MicrophoneManager', () => {
   let manager: MicrophoneManager;
   let call: Call;
@@ -92,10 +99,12 @@ describe('MicrophoneManager', () => {
       of('granted'),
     );
 
+    const streamClient = new StreamClient('abc123');
     call = new Call({
       id: '',
       type: '',
-      streamClient: new StreamClient('abc123'),
+      streamClient,
+      clientEventReporter: new ClientEventReporter({ streamClient }),
       clientStore: new StreamVideoWriteableStateStore(),
     });
     const devicePersistence = { enabled: false, storageKey: '' };

packages/client/src/devices/__tests__/MicrophoneManagerRN.test.ts

@@ -13,6 +13,7 @@ import { of } from 'rxjs';
 import '../../rtc/__tests__/mocks/webrtc.mocks';
 import { OwnCapability } from '../../gen/coordinator';
 import { settled, withoutConcurrency } from '../../helpers/concurrency';
+import { ClientEventReporter } from '../../reporting';
 
 let speechActivityCallback:
   | ((state: { isSoundDetected: boolean }) => void)
@@ -82,12 +83,14 @@ describe('MicrophoneManager React Native', () => {
     };
 
     const devicePersistence = { enabled: false, storageKey: '' };
+    const streamClient = new StreamClient('abc123');
     manager = new MicrophoneManager(
       new Call({
         id: '',
         type: '',
-        streamClient: new StreamClient('abc123'),
+        streamClient,
         clientStore: new StreamVideoWriteableStateStore(),
+        clientEventReporter: new ClientEventReporter({ streamClient }),
       }),
       devicePersistence,
     );

packages/client/src/devices/__tests__/ScreenShareManager.test.ts

@@ -2,6 +2,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { ScreenShareManager } from '../ScreenShareManager';
 import { Call } from '../../Call';
 import { StreamClient } from '../../coordinator/connection/client';
+import { ClientEventReporter } from '../../reporting';
 import { CallingState, StreamVideoWriteableStateStore } from '../../store';
 import * as RxUtils from '../../store/rxUtils';
 import { mockCall, mockDeviceIds$, mockScreenShareStream } from './mocks';
@@ -36,11 +37,13 @@ describe('ScreenShareManager', () => {
   let manager: ScreenShareManager;
 
   beforeEach(() => {
+    const streamClient = new StreamClient('abc123');
     manager = new ScreenShareManager(
       new Call({
         id: '',
         type: '',
-        streamClient: new StreamClient('abc123'),
+        streamClient,
+        clientEventReporter: new ClientEventReporter({ streamClient }),
         clientStore: new StreamVideoWriteableStateStore(),
       }),
     );