Merge pull request #11339 from daily-co/csdk-2392-add-callClientId-to-events

imp(cm): Rename callFrameId to callClientId

Author: mattieruth

test/.test-utils/event-emitter.ts

@@ -5,25 +5,26 @@ import {
   DailyParticipant,
 } from '@daily-co/daily-js';
 import faker from 'faker';
+import { mockEvent } from './mocks';
 
 export const emitStartedCamera = (callObject: DailyCall) => {
   // @ts-ignore
-  callObject.emit('started-camera', {
+  callObject.emit('started-camera', mockEvent({
     action: 'started-camera',
-  });
+  }));
 };
 
 export const emitActiveSpeakerChange = (
   callObject: DailyCall,
   peerId: string
 ) => {
   // @ts-ignore
-  callObject.emit('active-speaker-change', {
+  callObject.emit('active-speaker-change', mockEvent({
     action: 'active-speaker-change',
     activeSpeaker: {
       peerId,
     },
-  });
+  }));
 };
 
 export const emitTrackStarted = (
@@ -32,69 +33,69 @@ export const emitTrackStarted = (
   track: Partial<MediaStreamTrack>
 ) => {
   // @ts-ignore
-  callObject.emit('track-started', {
+  callObject.emit('track-started', mockEvent({
     action: 'track-started',
     participant,
     track,
-  });
+  }));
 };
 
 export const emitParticipantLeft = (
   callObject: DailyCall,
   participant: Partial<DailyParticipant>
 ) => {
   // @ts-ignore
-  callObject.emit('participant-left', {
+  callObject.emit('participant-left', mockEvent({
     action: 'participant-left',
     participant,
-  });
+  }));
 };
 
 export const emitParticipantUpdated = (
   callObject: DailyCall,
   participant: Partial<DailyParticipant>
 ) => {
   // @ts-ignore
-  callObject.emit('participant-updated', {
+  callObject.emit('participant-updated', mockEvent({
     action: 'participant-updated',
     participant,
-  });
+  }));
 };
 
 export const emitParticipantJoined = (
   callObject: DailyCall,
   participant: Partial<DailyParticipant>
 ) => {
   // @ts-ignore
-  callObject.emit('participant-joined', {
+  callObject.emit('participant-joined', mockEvent({
     action: 'participant-joined',
     participant,
-  });
+  }));
 };
 
 export const emitJoinedMeeting = (
   callObject: DailyCall,
   participants: Record<string, Partial<DailyParticipant>>
 ) => {
   // @ts-ignore
-  callObject.emit('joined-meeting', {
+  callObject.emit('joined-meeting', mockEvent({
     action: 'joined-meeting',
     participants,
-  });
+  }));
 };
 
 export const emitLeftMeeting = (callObject: DailyCall) => {
   // @ts-ignore
-  callObject.emit('left-meeting', {
+  callObject.emit('left-meeting', mockEvent({
     action: 'left-meeting',
-  });
+  }));
 };
 
 export const emitTranscriptionStarted = (
   callObject: DailyCall,
   data: Partial<DailyEventObjectTranscriptionStarted> = {}
 ) => {
-  const payload: DailyEventObjectTranscriptionStarted = {
+  const payload: DailyEventObjectTranscriptionStarted = mockEvent({
     action: 'transcription-started',
     language: 'en',
     model: 'general',
@@ -104,7 +105,7 @@ export const emitTranscriptionStarted = (
     redact: true,
     includeRawResponse: false,
     ...data,
-  };
+  });
   // @ts-ignore
   callObject.emit('transcription-started', payload);
 };
@@ -113,10 +114,10 @@ export const emitTranscriptionStopped = (
   callObject: DailyCall,
   updatedBy: string
 ) => {
-  const payload: DailyEventObjectTranscriptionStopped = {
+  const payload: DailyEventObjectTranscriptionStopped = mockEvent({
     action: 'transcription-stopped',
     updatedBy: updatedBy ?? faker.datatype.uuid(),
-  };
+  });
   // @ts-ignore
   callObject.emit('transcription-stopped', payload);
 };

test/.test-utils/mocks.ts

@@ -1,5 +1,5 @@
 import faker from 'faker';
-import { DailyParticipant, DailyTrackState } from "@daily-co/daily-js";
+import { DailyEventObject, DailyParticipant, DailyTrackState } from "@daily-co/daily-js";
 
 export const mockTrackState = (t: Partial<DailyTrackState> = {}): DailyTrackState => ({
   state: 'off',
@@ -37,3 +37,13 @@ export const mockParticipant = (p: Partial<DailyParticipant> = {}): DailyPartici
     ...p
   };
 }
+
+type EventPayload<T extends DailyEventObject> = Omit<T, 'callClientId'>;
+export function mockEvent<T extends DailyEventObject>(payload: EventPayload<T>): T {
+  const callClientId = 'imjustaclientintheworld';
+
+  return {
+    callClientId,
+    ...payload
+  } as T;
+}

test/hooks/useActiveParticipant.test.tsx

@@ -9,6 +9,7 @@ import React from 'react';
 
 import { DailyProvider } from '../../src/DailyProvider';
 import { useActiveParticipant } from '../../src/hooks/useActiveParticipant';
+import { mockEvent } from '../.test-utils/mocks';
 
 jest.mock('../../src/DailyLiveStreaming', () => ({
   ...jest.requireActual('../../src/DailyLiveStreaming'),
@@ -77,12 +78,12 @@ describe('useActiveParticipant', () => {
         }
       );
       const event: DailyEvent = 'active-speaker-change';
-      const payload: DailyEventObjectActiveSpeakerChange = {
+      const payload: DailyEventObjectActiveSpeakerChange = mockEvent({
         action: event,
         activeSpeaker: {
           peerId: 'local',
         },
-      };
+      });
       act(() => {
         // @ts-ignore
         daily.emit(event, payload);
@@ -117,12 +118,12 @@ describe('useActiveParticipant', () => {
         }
       );
       const event: DailyEvent = 'active-speaker-change';
-      const payload: DailyEventObjectActiveSpeakerChange = {
+      const payload: DailyEventObjectActiveSpeakerChange = mockEvent({
         action: event,
         activeSpeaker: {
           peerId: 'local',
         },
-      };
+      });
       act(() => {
         // @ts-ignore
         daily.emit(event, payload);

test/hooks/useAppMessage.test.tsx

@@ -10,6 +10,7 @@ import React from 'react';
 
 import { DailyProvider } from '../../src/DailyProvider';
 import { useAppMessage } from '../../src/hooks/useAppMessage';
+import { mockEvent } from '../.test-utils/mocks';
 
 jest.mock('../../src/DailyDevices', () => ({
   ...jest.requireActual('../../src/DailyDevices'),
@@ -64,11 +65,11 @@ describe('useAppMessage', () => {
       wrapper: createWrapper(daily),
     });
     const event: DailyEvent = 'app-message';
-    const payload: DailyEventObjectAppMessage = {
+    const payload: DailyEventObjectAppMessage = mockEvent({
       action: 'app-message',
       data: {},
       fromId: 'abcdef',
-    };
+    });
     act(() => {
       // @ts-ignore
       daily.emit(event, payload);

test/hooks/useCPULoad.test.tsx

@@ -10,6 +10,7 @@ import React from 'react';
 
 import { DailyProvider } from '../../src/DailyProvider';
 import { useCPULoad } from '../../src/hooks/useCPULoad';
+import { mockEvent } from '../.test-utils/mocks';
 
 jest.mock('../../src/DailyDevices', () => ({
   ...jest.requireActual('../../src/DailyDevices'),
@@ -74,11 +75,11 @@ describe('useCPULoad', () => {
       wrapper: createWrapper(daily),
     });
     const event: DailyEvent = 'cpu-load-change';
-    const payload: DailyEventObjectCpuLoadEvent = {
+    const payload: DailyEventObjectCpuLoadEvent = mockEvent({
       action: 'cpu-load-change',
       cpuLoadState: 'high',
       cpuLoadStateReason: 'encode',
-    };
+    });
     act(() => {
       // @ts-ignore
       daily.emit(event, payload);