[onFetchProfile] Add onFetchProfile for CallWithChat composite (#5729)

* Add onFetchProfile for CallWithChat Composite

* minor

* ARB comments

* Add test

* Change files

Author: prabhjot-msft

change-beta/@azure-communication-react-f46db66c-1ff6-45c5-ab56-f6c6c066261c.json

@@ -0,0 +1,9 @@
+{
+  "type": "minor",
+  "area": "feature",
+  "workstream": "Add onFetchProfile in CallWithChat Composite",
+  "comment": "Add onFetchProfile for CallWithChat Composite",
+  "packageName": "@azure/communication-react",
+  "email": "97124699+prabhjot-msft@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

change/@azure-communication-react-f46db66c-1ff6-45c5-ab56-f6c6c066261c.json

@@ -0,0 +1,9 @@
+{
+  "type": "minor",
+  "area": "feature",
+  "workstream": "Add onFetchProfile in CallWithChat Composite",
+  "comment": "Add onFetchProfile for CallWithChat Composite",
+  "packageName": "@azure/communication-react",
+  "email": "97124699+prabhjot-msft@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

common/config/babel/features.js

@@ -20,7 +20,9 @@ module.exports = {
     // Demo feature. Used in live-documentation of conditional compilation. Do not use in production code.
     "in-progress-beta-feature-demo",
     // Feature for remote UFD
-    "remote-ufd"
+    "remote-ufd",
+    // Feature for on fetch profile
+    "on-fetch-profile"
   ],
   beta: [
     "call-readiness",

packages/communication-react/review/beta/communication-react.api.md

@@ -311,6 +311,7 @@ export type AzureCommunicationChatAdapterArgs = {
     displayName: string;
     credential: CommunicationTokenCredential;
     threadId: string;
+    chatAdapterOptions?: ChatAdapterOptions;
 };
 
 // @public
@@ -2039,6 +2040,11 @@ export interface CaptionsSettingsModalStrings {
 // @public
 export type ChatAdapter = ChatAdapterThreadManagement & AdapterState<ChatAdapterState> & Disposable_2 & ChatAdapterSubscribers;
 
+// @public
+export type ChatAdapterOptions = {
+    onFetchProfile?: OnFetchChatProfileCallback;
+};
+
 // @public
 export type ChatAdapterState = ChatAdapterUiState & ChatCompositeClientState;
 
@@ -2266,6 +2272,11 @@ export type ChatParticipantListSelector = (state: ChatClientState, props: ChatBa
     participants: ParticipantListParticipant[];
 };
 
+// @public
+export type ChatProfile = {
+    displayName?: string;
+};
+
 // @public
 export type ChatReturnProps<Component extends (props: any) => JSX.Element> = GetChatSelector<Component> extends (state: ChatClientState, props: any) => any ? ReturnType<GetChatSelector<Component>> & Common<ChatHandlers, Parameters<Component>[0]> : never;
 
@@ -2821,10 +2832,10 @@ export const createAzureCommunicationCallWithChatAdapter: ({ userId, displayName
 export const createAzureCommunicationCallWithChatAdapterFromClients: ({ callClient, callAgent, callLocator, chatClient, chatThreadClient, callAdapterOptions }: AzureCommunicationCallWithChatAdapterFromClientArgs) => Promise<CallWithChatAdapter>;
 
 // @public
-export const createAzureCommunicationChatAdapter: ({ endpoint: endpointUrl, userId, displayName, credential, threadId }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
+export const createAzureCommunicationChatAdapter: ({ endpoint: endpointUrl, userId, displayName, credential, threadId, chatAdapterOptions }: AzureCommunicationChatAdapterArgs) => Promise<ChatAdapter>;
 
 // @public
-export function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>;
+export function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>;
 
 // @public
 export type CreateDefaultCallingHandlers = (callClient: StatefulCallClient, callAgent: CallAgent | undefined, deviceManager: StatefulDeviceManager | undefined, call: Call | undefined, options?: CallingHandlersOptions) => CallingHandlers;
@@ -4299,6 +4310,9 @@ export type NotificationTarget = 'assignedBreakoutRoomOpened' | 'assignedBreakou
 // @public
 export type NotificationType = keyof NotificationStackStrings;
 
+// @public
+export type OnFetchChatProfileCallback = (userId: string, defaultProfile?: ChatProfile) => Promise<ChatProfile | undefined>;
+
 // @public
 export type OnFetchProfileCallback = (userId: string, defaultProfile?: Profile) => Promise<Profile | undefined>;
 

packages/react-composites/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.ts

@@ -49,6 +49,8 @@ import {
   MessageDeletedListener
 } from '../../ChatComposite';
 import { ResourceDetails } from '../../ChatComposite';
+/* @conditional-compile-remove(on-fetch-profile) */
+import type { ChatAdapterOptions } from '../../ChatComposite';
 import { CallWithChatAdapter, CallWithChatEvent, ChatInitializedListener } from './CallWithChatAdapter';
 import {
   callWithChatAdapterStateFromBackingStates,
@@ -1242,6 +1244,10 @@ export const createAzureCommunicationCallWithChatAdapter = async ({
   });
 
   const chatThreadAdapter = _createChatThreadAdapterInner(locator, callAdapter);
+  /* @conditional-compile-remove(on-fetch-profile) */
+  const chatAdapterOptions: ChatAdapterOptions = {
+    onFetchProfile: callAdapterOptions?.onFetchProfile
+  };
   if (chatThreadAdapter.isCallInfoRequired()) {
     const callWithChatAdapter = new AzureCommunicationCallWithChatAdapter(await callAdapter);
     const chatAdapterPromise = _createLazyAzureCommunicationChatAdapterInner(
@@ -1250,7 +1256,9 @@ export const createAzureCommunicationCallWithChatAdapter = async ({
       displayName,
       credential,
       chatThreadAdapter.getChatThreadPromise(),
-      'CallWithChat' as _TelemetryImplementationHint
+      'CallWithChat' as _TelemetryImplementationHint,
+      /* @conditional-compile-remove(on-fetch-profile) */
+      chatAdapterOptions
     );
     callWithChatAdapter.setChatAdapterPromise(chatAdapterPromise);
     callWithChatAdapter.setCreateChatAdapterCallback((threadId: string) =>
@@ -1260,7 +1268,9 @@ export const createAzureCommunicationCallWithChatAdapter = async ({
         displayName,
         credential,
         threadId,
-        'CallWithChat' as _TelemetryImplementationHint
+        'CallWithChat' as _TelemetryImplementationHint,
+        /* @conditional-compile-remove(on-fetch-profile) */
+        chatAdapterOptions
       )
     );
     return callWithChatAdapter;
@@ -1271,7 +1281,9 @@ export const createAzureCommunicationCallWithChatAdapter = async ({
       displayName,
       credential,
       chatThreadAdapter.getChatThread(),
-      'CallWithChat' as _TelemetryImplementationHint
+      'CallWithChat' as _TelemetryImplementationHint,
+      /* @conditional-compile-remove(on-fetch-profile) */
+      chatAdapterOptions
     );
 
     const callWithChatAdapter = new AzureCommunicationCallWithChatAdapter(await callAdapter, await chatAdapter);
@@ -1282,7 +1294,9 @@ export const createAzureCommunicationCallWithChatAdapter = async ({
         displayName,
         credential,
         threadId,
-        'CallWithChat' as _TelemetryImplementationHint
+        'CallWithChat' as _TelemetryImplementationHint,
+        /* @conditional-compile-remove(on-fetch-profile) */
+        chatAdapterOptions
       )
     );
     return callWithChatAdapter;

packages/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.test.ts

@@ -179,6 +179,44 @@ describe('Error is reflected in state and events', () => {
   });
 });
 
+/* @conditional-compile-remove(on-fetch-profile) */
+describe('Adapter is created with chatAdapterOptions', () => {
+  it('should create adapter with onFetchProfile option', async () => {
+    const token = {
+      getToken: jest.fn(),
+      dispose: jest.fn()
+    };
+
+    ChatClientMock.mockImplementation((): ChatClient => {
+      return new StubChatClient(new StubChatThreadClient()) as unknown as ChatClient;
+    });
+
+    const onFetchProfile = jest.fn();
+    const adapter = await createAzureCommunicationChatAdapter({
+      endpoint: 'stubEndpointUrl',
+      userId: { communicationUserId: 'stubUserId' },
+      displayName: 'stubDisplayName',
+      credential: token,
+      threadId: 'stubThreadId',
+      chatAdapterOptions: { onFetchProfile }
+    });
+
+    expect(adapter).toBeDefined();
+  });
+
+  it('should create adapter with chatAdapterOptions', async () => {
+    const statefulChatClient = createStatefulChatClientMock(new StubChatThreadClient());
+    const threadClient = statefulChatClient.getChatThreadClient('threadId');
+    const onFetchProfile = jest.fn();
+
+    const adapter = await createAzureCommunicationChatAdapterFromClient(statefulChatClient, threadClient, {
+      onFetchProfile
+    });
+
+    expect(adapter).toBeDefined();
+  });
+});
+
 const createChatAdapterWithStubs = async (
   chatClient: StubChatClient,
   fakeToken?: CommunicationTokenCredential