Chat: Updating the downloadAttachment api to not be list (#4071)

JoshuaLai · web-flow · commit 56cc57b73d1d · 2024-01-31T14:45:52.000-05:00
diff --git a/change-beta/@azure-communication-react-7ae677e9-387a-47ba-b013-fe66fe3f63a0.json b/change-beta/@azure-communication-react-7ae677e9-387a-47ba-b013-fe66fe3f63a0.json
@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "improvement",
+  "workstream": "InlineImages",
+  "comment": "Updating the downloadAttachment api to not be list",
+  "packageName": "@azure/communication-react",
+  "email": "9044372+JoshuaLai@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/change/@azure-communication-react-7ae677e9-387a-47ba-b013-fe66fe3f63a0.json b/change/@azure-communication-react-7ae677e9-387a-47ba-b013-fe66fe3f63a0.json
@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "improvement",
+  "workstream": "InlineImages",
+  "comment": "Updating the downloadAttachment api to not be list",
+  "packageName": "@azure/communication-react",
+  "email": "9044372+JoshuaLai@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/communication-react/review/beta/communication-react.api.md b/packages/communication-react/review/beta/communication-react.api.md
@@ -149,7 +149,6 @@ export type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : fa
 
 // @beta
 export interface AttachmentDownloadResult {
-    attachmentId: string;
     blobUrl: string;
 }
 
@@ -993,9 +992,9 @@ export interface CallWithChatAdapterManagement {
     disposeScreenShareStreamView(remoteUserId: string): Promise<void>;
     disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>;
     // (undocumented)
-    downloadAttachments: (options: {
-        attachmentUrls: Record<string, string>;
-    }) => Promise<AttachmentDownloadResult[]>;
+    downloadAttachment: (options: {
+        attachmentUrl: string;
+    }) => Promise<AttachmentDownloadResult>;
     fetchInitialData(): Promise<void>;
     // @beta
     holdCall: () => Promise<void>;
@@ -1607,9 +1606,9 @@ export interface ChatAdapterSubscribers {
 export interface ChatAdapterThreadManagement {
     deleteMessage(messageId: string): Promise<void>;
     // (undocumented)
-    downloadAttachments: (options: {
-        attachmentUrls: Record<string, string>;
-    }) => Promise<AttachmentDownloadResult[]>;
+    downloadAttachment: (options: {
+        attachmentUrl: string;
+    }) => Promise<AttachmentDownloadResult>;
     fetchInitialData(): Promise<void>;
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
     removeParticipant(userId: string): Promise<void>;
diff --git a/packages/react-components/review/beta/react-components.api.md b/packages/react-components/review/beta/react-components.api.md
@@ -68,7 +68,6 @@ export type AnnouncerProps = {
 
 // @beta
 export interface AttachmentDownloadResult {
-    attachmentId: string;
     blobUrl: string;
 }
 
diff --git a/packages/react-components/src/components/FileDownloadCards.tsx b/packages/react-components/src/components/FileDownloadCards.tsx
@@ -94,10 +94,6 @@ export type AttachmentMetadata =
  * @beta
  */
 export interface AttachmentDownloadResult {
-  /**
-   * Unique ID of the attachment.
-   */
-  attachmentId: string;
   /**
    * Blob URL for the attachment.
    */
diff --git a/packages/react-composites/review/beta/react-composites.api.md b/packages/react-composites/review/beta/react-composites.api.md
@@ -692,9 +692,9 @@ export interface CallWithChatAdapterManagement {
     disposeScreenShareStreamView(remoteUserId: string): Promise<void>;
     disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>;
     // (undocumented)
-    downloadAttachments: (options: {
-        attachmentUrls: Record<string, string>;
-    }) => Promise<AttachmentDownloadResult[]>;
+    downloadAttachment: (options: {
+        attachmentUrl: string;
+    }) => Promise<AttachmentDownloadResult>;
     fetchInitialData(): Promise<void>;
     // @beta
     holdCall: () => Promise<void>;
@@ -1121,9 +1121,9 @@ export interface ChatAdapterSubscribers {
 export interface ChatAdapterThreadManagement {
     deleteMessage(messageId: string): Promise<void>;
     // (undocumented)
-    downloadAttachments: (options: {
-        attachmentUrls: Record<string, string>;
-    }) => Promise<AttachmentDownloadResult[]>;
+    downloadAttachment: (options: {
+        attachmentUrl: string;
+    }) => Promise<AttachmentDownloadResult>;
     fetchInitialData(): Promise<void>;
     loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
     removeParticipant(userId: string): Promise<void>;
diff --git a/packages/react-composites/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.ts b/packages/react-composites/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.ts
@@ -232,7 +232,7 @@ export class AzureCommunicationCallWithChatAdapter implements CallWithChatAdapte
     /* @conditional-compile-remove(file-sharing) */
     this.updateFileUploadMetadata = this.updateFileUploadMetadata.bind(this);
     /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-    this.downloadAttachments = this.downloadAttachments.bind(this);
+    this.downloadAttachment = this.downloadAttachment.bind(this);
     /* @conditional-compile-remove(PSTN-calls) */
     this.holdCall.bind(this);
     /* @conditional-compile-remove(PSTN-calls) */
@@ -472,8 +472,8 @@ export class AzureCommunicationCallWithChatAdapter implements CallWithChatAdapte
     this.chatAdapter.updateFileUploadMetadata(id, metadata);
   };
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  async downloadAttachments(options: { attachmentUrls: Record<string, string> }): Promise<AttachmentDownloadResult[]> {
-    return await this.chatAdapter.downloadAttachments(options);
+  async downloadAttachment(options: { attachmentUrl: string }): Promise<AttachmentDownloadResult> {
+    return await this.chatAdapter.downloadAttachment(options);
   }
   /* @conditional-compile-remove(PSTN-calls) */
   public async holdCall(): Promise<void> {
diff --git a/packages/react-composites/src/composites/CallWithChatComposite/adapter/CallWithChatAdapter.ts b/packages/react-composites/src/composites/CallWithChatComposite/adapter/CallWithChatAdapter.ts
@@ -385,7 +385,7 @@ export interface CallWithChatAdapterManagement {
   /** @beta */
   updateFileUploadMetadata: (id: string, metadata: AttachmentMetadata) => void;
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  downloadAttachments: (options: { attachmentUrls: Record<string, string> }) => Promise<AttachmentDownloadResult[]>;
+  downloadAttachment: (options: { attachmentUrl: string }) => Promise<AttachmentDownloadResult>;
   /* @conditional-compile-remove(PSTN-calls) */
   /**
    * Puts the Call in a Localhold.
diff --git a/packages/react-composites/src/composites/CallWithChatComposite/adapter/CallWithChatBackedChatAdapter.ts b/packages/react-composites/src/composites/CallWithChatComposite/adapter/CallWithChatBackedChatAdapter.ts
@@ -130,10 +130,8 @@ export class CallWithChatBackedChatAdapter implements ChatAdapter {
   };
 
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  public async downloadAttachments(options: {
-    attachmentUrls: Record<string, string>;
-  }): Promise<AttachmentDownloadResult[]> {
-    return await this.callWithChatAdapter.downloadAttachments(options);
+  public async downloadAttachment(options: { attachmentUrl: string }): Promise<AttachmentDownloadResult> {
+    return await this.callWithChatAdapter.downloadAttachment(options);
   }
 }
 
diff --git a/packages/react-composites/src/composites/ChatComposite/ChatScreen.tsx b/packages/react-composites/src/composites/ChatComposite/ChatScreen.tsx
@@ -267,9 +267,9 @@ export const ChatScreen = (props: ChatScreenProps): JSX.Element => {
 
       if (attachment.attachmentType === 'inlineImage' && attachment.url) {
         // TBD: Need to begin investigating how to download HQ images.
-        const blob = await adapter.downloadAttachments({ attachmentUrls: { [attachment.id]: attachment.url } });
-        if (blob[0]) {
-          const blobUrl = blob[0].blobUrl;
+        const blob = await adapter.downloadAttachment({ attachmentUrl: attachment.url });
+        if (blob) {
+          const blobUrl = blob.blobUrl;
           setFullSizeAttachments((prev) => ({ ...prev, [attachment.id]: blobUrl }));
           setGalleryImages([
             {
diff --git a/packages/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.test.ts b/packages/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.test.ts
@@ -166,18 +166,18 @@ describe('Error is reflected in state and events', () => {
   });
 
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  it('when downloadAttachments with no access token fails', async () => {
+  it('when downloadAttachment with no access token fails', async () => {
     const threadClient = new StubChatThreadClient();
     const adapter = await createChatAdapterWithStubs(new StubChatClient(threadClient));
     const errorListener = new ErrorListener(adapter);
 
-    await expect(adapter.downloadAttachments({ attachmentUrls: { ['somefakeid']: 'somefakeurl' } })).rejects.toThrow();
+    await expect(adapter.downloadAttachment({ attachmentUrl: 'somefakeurl' })).rejects.toThrow();
     expect(errorListener.errors.length).toBe(1);
     expect(errorListener.errors[0].target).toBe('ChatThreadClient.getMessage');
     expect(errorListener.errors[0].innerError.message).toBe('AccessToken is null');
   });
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  it('when downloadAttachments fails with bad respnse', async () => {
+  it('when downloadAttachment fails with bad respnse', async () => {
     const threadClient = new StubChatThreadClient();
     const fakeToken: CommunicationTokenCredential = {
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -192,9 +192,7 @@ describe('Error is reflected in state and events', () => {
     const adapter = await createChatAdapterWithStubs(new StubChatClient(threadClient), fakeToken);
     const errorListener = new ErrorListener(adapter);
     {
-      await expect(
-        adapter.downloadAttachments({ attachmentUrls: { ['somefakeid']: 'somefakeurl' } })
-      ).rejects.toThrow();
+      await expect(adapter.downloadAttachment({ attachmentUrl: 'somefakeurl' })).rejects.toThrow();
       expect(errorListener.errors.length).toBe(1);
       expect(errorListener.errors[0].target).toBe('ChatThreadClient.getMessage');
       expect(errorListener.errors[0].innerError.message).toBe('fetch is not defined');
diff --git a/packages/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.ts b/packages/react-composites/src/composites/ChatComposite/adapter/AzureCommunicationChatAdapter.ts
@@ -188,7 +188,7 @@ export class AzureCommunicationChatAdapter implements ChatAdapter {
     /* @conditional-compile-remove(file-sharing) */
     this.updateFileUploadMetadata = this.updateFileUploadMetadata.bind(this);
     /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-    this.downloadAttachments = this.downloadAttachments.bind(this);
+    this.downloadAttachment = this.downloadAttachment.bind(this);
   }
 
   dispose(): void {
@@ -332,7 +332,7 @@ export class AzureCommunicationChatAdapter implements ChatAdapter {
   }
 
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  async downloadAttachments(options: { attachmentUrls: Record<string, string> }): Promise<AttachmentDownloadResult[]> {
+  async downloadAttachment(options: { attachmentUrl: string }): Promise<AttachmentDownloadResult> {
     return this.asyncTeeErrorToEventEmitter(async () => {
       if (this.credential === undefined) {
         throw new ChatError('ChatThreadClient.getMessage', new Error('AccessToken is null'));
@@ -348,8 +348,8 @@ export class AzureCommunicationChatAdapter implements ChatAdapter {
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
   private async downloadAuthenticatedFile(
     accessToken: string,
-    options: { attachmentUrls: Record<string, string> }
-  ): Promise<AttachmentDownloadResult[]> {
+    options: { attachmentUrl: string }
+  ): Promise<AttachmentDownloadResult> {
     async function fetchWithAuthentication(url: string, token: string): Promise<Response> {
       const headers = new Headers();
       headers.append('Authorization', `Bearer ${token}`);
@@ -360,14 +360,10 @@ export class AzureCommunicationChatAdapter implements ChatAdapter {
       }
     }
 
-    const attachmentDownloadResults: AttachmentDownloadResult[] = [];
-    for (const id in options.attachmentUrls) {
-      const response = await fetchWithAuthentication(options.attachmentUrls[id], accessToken);
-      const blob = await response.blob();
-      attachmentDownloadResults.push({ attachmentId: id, blobUrl: URL.createObjectURL(blob) });
-    }
+    const response = await fetchWithAuthentication(options.attachmentUrl, accessToken);
+    const blob = await response.blob();
 
-    return attachmentDownloadResults;
+    return { blobUrl: URL.createObjectURL(blob) };
   }
 
   private messageReceivedListener(event: ChatMessageReceivedEvent): void {
diff --git a/packages/react-composites/src/composites/ChatComposite/adapter/ChatAdapter.ts b/packages/react-composites/src/composites/ChatComposite/adapter/ChatAdapter.ts
@@ -110,7 +110,7 @@ export interface ChatAdapterThreadManagement {
    */
   loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>;
   /* @conditional-compile-remove(teams-inline-images-and-file-sharing) */
-  downloadAttachments: (options: { attachmentUrls: Record<string, string> }) => Promise<AttachmentDownloadResult[]>;
+  downloadAttachment: (options: { attachmentUrl: string }) => Promise<AttachmentDownloadResult>;
 }
 
 /**
diff --git a/packages/storybook/stories/Adapters/Adapters.stories.mdx b/packages/storybook/stories/Adapters/Adapters.stories.mdx
diff --git a/packages/storybook/stories/MessageThread/MessageThread.stories.tsx b/packages/storybook/stories/MessageThread/MessageThread.stories.tsx

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,6 @@ export type AnnouncerProps = {`
`68`	`68`
`69`	`69`	`// @beta`
`70`	`70`	`export interface AttachmentDownloadResult {`
`71`		`- attachmentId: string;`
`72`	`71`	`blobUrl: string;`
`73`	`72`	`}`
`74`	`73`
Original file line number	Diff line number	Diff line change
`@@ -130,10 +130,8 @@ export class CallWithChatBackedChatAdapter implements ChatAdapter {`
`130`	`130`	`};`
`131`	`131`
`132`	`132`	`/* @conditional-compile-remove(teams-inline-images-and-file-sharing) */`
`133`		`- public async downloadAttachments(options: {`
`134`		`- attachmentUrls: Record<string, string>;`
`135`		`- }): Promise<AttachmentDownloadResult[]> {`
`136`		`- return await this.callWithChatAdapter.downloadAttachments(options);`
	`133`	`+ public async downloadAttachment(options: { attachmentUrl: string }): Promise<AttachmentDownloadResult> {`
	`134`	`+ return await this.callWithChatAdapter.downloadAttachment(options);`
`137`	`135`	`}`
`138`	`136`	`}`
`139`	`137`