Merge pull request #969 from MyPureCloud/stream-1099

[STREAM-1099] - Emit `participantsUpdate` for JWT Video Guests

Author: patrickfeeney03

changelog.md

@@ -4,6 +4,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/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.5.1...HEAD)
+### Added
+* [STREAM-1099](https://inindca.atlassian.net/browse/STREAM-1099) - Emit `participantsUpdate` for JWT Video Guests
 ### Changed
 * [STREAM-1178](https://inindca.atlassian.net/browse/STREAM-1178) - REVERT STREAM-825, removed ability to send multiple tracks when screensharing.
 

react-demo-app/package-lock.json

@@ -4,6 +4,7 @@ import { GenesysCloudWebrtcSdk } from './client';
 import { SessionManager } from './sessions/session-manager';
 import { SubscriptionEvent } from './types/interfaces';
 import { ConversationUpdate } from './conversations/conversation-update';
+import { isAgentVideoJid } from "./utils";
 
 /**
  * Establish the connection with the streaming client.
@@ -91,8 +92,19 @@ export async function setupStreamingClient (this: GenesysCloudWebrtcSdk): Promis
 export async function proxyStreamingClientEvents (this: GenesysCloudWebrtcSdk): Promise<void> {
   this.sessionManager = new SessionManager(this);
 
-  if (this._personDetails && !this.isJwtAuth) {
-    await this._streamingConnection.notifications.subscribe(`v2.users.${this._personDetails.id}.conversations`, handleConversationUpdate.bind(this), true);
+  if (this._personDetails) {
+    if (this.isJwtAuth) {
+      const convId = this._customerData.conversation?.id;
+      const isGuest = !this._personDetails?.id;
+      const roomJid = this._personDetails.chat?.jabberId;
+      if (convId && isGuest && isAgentVideoJid(roomJid)) {
+        this._streamingConnection.on(`notify:v2.guest.conversations.${convId}`, (conversationEvent) => {
+          handleConversationUpdate.call(this, conversationEvent);
+        });
+      }
+    } else {
+      await this._streamingConnection.notifications.subscribe(`v2.users.${this._personDetails.id}.conversations`, handleConversationUpdate.bind(this), true);
+    }
   }
 
   // webrtc events

src/client-private.ts

@@ -694,6 +694,14 @@ export class GenesysCloudWebrtcSdk extends (EventEmitter as { new(): StrictEvent
         }
       };
 
+      this._customerData = {
+        conversation: {
+          id: decoded.data.conversationId,
+        },
+        sourceCommunicationId: decoded.data.sourceCommunicationId,
+        jwt: this._config.jwt
+      }
+
       this._orgDetails = {
         id: decoded.org,
         name: null

src/client.ts

@@ -714,6 +714,8 @@ export interface JWTDetails {
     uid: string; // userId
     jid: string;
     gcbaid: string; // genesys cloud background assistant id
+    conversationId?: string;
+    sourceCommunicationId?: string;
   };
   exp: number; // exp in seconds
   iat: number; // issued at time in seconds,

src/types/interfaces.ts

@@ -1,10 +1,11 @@
 import { GenesysCloudWebrtcSdk } from '../../src/client';
 import { SimpleMockSdk } from '../test-utils';
 import { CommunicationStates } from '../../src/types/enums';
-import { SubscriptionEvent } from '../../src/types/interfaces';
-import { handleConversationUpdate, setupStreamingClient, handleDisconnectedEvent } from '../../src/client-private';
+import { ICustomerData, IPersonDetails, SubscriptionEvent } from '../../src/types/interfaces';
+import { handleConversationUpdate, setupStreamingClient, handleDisconnectedEvent, proxyStreamingClientEvents } from '../../src/client-private';
 import { ConversationUpdate } from '../../src/';
 import StreamingClient from 'genesys-cloud-streaming-client';
+import { NotificationsApi } from "purecloud-platform-client-v2";
 
 jest.mock('genesys-cloud-streaming-client');
 
@@ -90,7 +91,7 @@ describe('setupStreamingClient', () => {
 describe('handleConversationUpdate', () => {
   it('should call sessionManager.handleConversationUpdate with the transformed event', () => {
     mockSdk.sessionManager = { handleConversationUpdateRaw: jest.fn(), handleConversationUpdate: jest.fn() } as any;
-    
+
     const userId = '444kjskdk';
     const participant1 = {
       id: '7b809e10-fb79-4420-9d5f-69d232ddf490',
@@ -219,3 +220,99 @@ describe('handleDisconnectedEvent', () => {
     );
   });
 });
+
+describe('proxyStreamingClientEvents', () => {
+  it('should handle JWT auth path', async () => {
+    const { handleConversationUpdateSpy, mockConversationUpdate } = await createEventDataAndCallProxyFunction();
+
+    expect(handleConversationUpdateSpy).toHaveBeenCalledWith(new ConversationUpdate(mockConversationUpdate.eventBody));
+  });
+
+  it('should handle JWT auth path with no conversation id', async () => {
+    const { handleConversationUpdateSpy, conversationUpdateHandler } = await createEventDataAndCallProxyFunction({ conversationId: undefined });
+
+    expect(conversationUpdateHandler).toBe(undefined);
+    expect(handleConversationUpdateSpy).not.toHaveBeenCalled();
+  });
+
+  it('should handle JWT auth path with non-agent conference', async () => {
+    const { handleConversationUpdateSpy, conversationUpdateHandler } = await createEventDataAndCallProxyFunction({ jabberId: 'adhoc-123@conference.com' });
+
+    expect(conversationUpdateHandler).toBe(undefined);
+    expect(handleConversationUpdateSpy).not.toHaveBeenCalled();
+  });
+
+  it('should handle JWT auth path with missing conference jid', async () => {
+    const { handleConversationUpdateSpy, conversationUpdateHandler } = await createEventDataAndCallProxyFunction({ jabberId: undefined });
+
+    expect(conversationUpdateHandler).toBe(undefined);
+    expect(handleConversationUpdateSpy).not.toHaveBeenCalled();
+  });
+
+  it('should handle JWT auth path with guest with userId', async () => {
+    const { handleConversationUpdateSpy, conversationUpdateHandler } = await createEventDataAndCallProxyFunction({ userId: 'user123'});
+
+    expect(conversationUpdateHandler).toBe(undefined);
+    expect(handleConversationUpdateSpy).not.toHaveBeenCalled();
+  });
+
+  it('should still handle non-JWT auth path', async () => {
+    const { handleConversationUpdateSpy, mockConversationUpdate } = await createEventDataAndCallProxyFunction({
+      userId: 'user123',
+      isJwtAuth: false
+    });
+
+    expect(handleConversationUpdateSpy).toHaveBeenCalledWith(new ConversationUpdate(mockConversationUpdate.eventBody));
+    expect(mockSdk._customerData).toBe(undefined);
+  });
+
+  async function createEventDataAndCallProxyFunction(options = {} as { userId?: string, jabberId?: string, conversationId?: string, isJwtAuth?: boolean }) {
+    const userId = 'userId' in options ? options.userId : undefined;
+    const jabberId = 'jabberId' in options ? options.jabberId : 'agent-123@conference.com';
+    const conversationId = 'conversationId' in options ? options.conversationId : 'conv123';
+    const isJwtAuth = options.isJwtAuth ?? true;
+
+    mockSdk._personDetails = {
+      id: userId,
+      chat: { jabberId: jabberId }
+    } as IPersonDetails;
+
+    if (isJwtAuth) { // we only assign this on jwt path
+      mockSdk._customerData = {
+        conversation: { id: conversationId }
+      } as ICustomerData;
+    }
+
+    Object.defineProperty(mockSdk, 'isJwtAuth', { get: () => isJwtAuth });
+
+    let conversationUpdateHandler;
+
+    mockSdk._streamingConnection = {
+      on: jest.fn((event, handler) => {
+        if (event === `notify:v2.guest.conversations.${conversationId}`) {
+          if (conversationUpdateHandler) throw new Error('handler already assigned');
+          conversationUpdateHandler = handler;
+        }
+      }),
+      webrtcSessions: { on: jest.fn() },
+      notifications: {
+        subscribe: jest.fn((topic, handler) => {
+          if (topic === `v2.users.${userId}.conversations`) {
+            if (conversationUpdateHandler) throw new Error('handler already assigned');
+            conversationUpdateHandler = handler;
+          }
+        })
+      }
+    } as unknown as StreamingClient;
+
+    await proxyStreamingClientEvents.call(mockSdk);
+
+    mockSdk.sessionManager = { handleConversationUpdate: jest.fn(), handleConversationUpdateRaw: jest.fn() } as never;
+    const mockConversationUpdate = { eventBody: {}, metadata: { correlationId: '' }, topicName: '' };
+    if (conversationUpdateHandler) conversationUpdateHandler(mockConversationUpdate);
+
+    const handleConversationUpdateSpy = mockSdk.sessionManager.handleConversationUpdate;
+
+    return { handleConversationUpdateSpy, conversationUpdateHandler, mockConversationUpdate};
+  }
+});