Clean up

Author: compulim

packages/acs-chat-adapter/src/ACSChatAdapter.tsx

@@ -170,7 +170,6 @@ ACSChatAdapter.defaultProps = {
   userProfiles: {}
 };
 
-// TODO: Since ACS do not provide profile data, we should have a mapProfile function to convert userId -> (avatar image, initials, name).
 ACSChatAdapter.propTypes = {
   children: PropTypes.func.isRequired,
   endpointURL: PropTypes.string.isRequired,

packages/acs-chat-adapter/src/composers/ACSChatMessagesComposer.tsx

@@ -9,7 +9,6 @@ import createDebug from '../utils/debug';
 import styleConsole from '../utils/styleConsole';
 import useACSChatThreadSelector from '../hooks/useACSChatThreadSelector';
 import useACSClients from '../hooks/useACSClients';
-import useDebounced from '../hooks/useDebounced';
 import usePrevious from '../hooks/usePrevious';
 import warn from '../utils/warn';
 
@@ -76,24 +75,12 @@ const ACSChatMessageComposer: FC = ({ children }) => {
     }
   }
 
-  // const context = useMemo(
-  //   () => ({
-  //     chatMessages,
-  //     connectivityStatus
-  //   }),
-  //   [chatMessages, connectivityStatus]
-  // );
-
-  // TODO: Remove useDebounced.
-  // eslint-disable-next-line no-magic-numbers
-  const debouncedChatMessages = useDebounced(chatMessages, 1000);
-
   const context = useMemo(
     () => ({
-      chatMessages: debouncedChatMessages,
+      chatMessages,
       connectivityStatus
     }),
-    [connectivityStatus, debouncedChatMessages]
+    [chatMessages, connectivityStatus]
   );
 
   return <ACSChatMessagesContext.Provider value={context}>{children}</ACSChatMessagesContext.Provider>;

packages/acs-chat-adapter/src/composers/ACSClientsComposer.tsx

@@ -53,10 +53,8 @@ const ACSDeclarativesComposer: FC<{ children: any; endpointURL: string; threadId
   const chatClient = useMemo(() => new ChatClient(endpointURL, credentials), [credentials, endpointURL]);
 
   const declarativeChatClient = useMemo(
-    // TODO: Type ChatClient from @azure/communication-chat is not compatible with @azure/acs-chat-declarative.
     // TODO: What to do with "displayName" and "userId"?
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    () => chatClientDeclaratify(chatClient as any, { displayName: '', userId: '' }),
+    () => chatClientDeclaratify(chatClient, { displayName: '', userId: '' }),
     [chatClient]
   );
 
@@ -71,9 +69,7 @@ const ACSDeclarativesComposer: FC<{ children: any; endpointURL: string; threadId
     (async function () {
       const declarativeChatThreadClient = await declarativeChatClient.getChatThreadClient(threadId);
 
-      // TODO: Fix the typing. Declarative SDK should export the type DeclarativeChatThreadClient.
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      abortController.signal.aborted || setDeclarativeChatThreadClient(declarativeChatThreadClient as any);
+      abortController.signal.aborted || setDeclarativeChatThreadClient(declarativeChatThreadClient);
     })();
 
     return () => abortController.abort();

packages/acs-chat-adapter/src/composers/ActivitiesComposer.tsx

@@ -1,7 +1,7 @@
 /* eslint no-magic-numbers: ["error", { "ignore": [-1, 0, 1] }] */
 /* eslint complexity: "off" */
 
-import { ReadBy, updateMetadata } from 'botframework-webchat-core';
+import { ReadBy } from 'botframework-webchat-core';
 import PropTypes from 'prop-types';
 import React, { FC, useCallback, useMemo, useRef } from 'react';
 import updateIn from 'simple-update-in';
@@ -134,7 +134,7 @@ const ActivitiesComposer2: FC<{ children: any; userProfiles: UserProfiles }> = (
   const activities = useMemoAll<Activity, Activity[]>(
     useCallback(
       (key, chatMessage, readBy, trackingNumber) =>
-        updateMetadata(convert(chatMessage), {
+        convert(chatMessage, {
           key,
           readBy,
           trackingNumber

packages/acs-chat-adapter/src/converters/createACSMessageToWebChatActivityConverter.ts

@@ -1,20 +1,14 @@
 /* eslint complexity: ["error", 30] */
 
-import { EventActivity, MessageActivity, updateMetadata } from 'botframework-webchat-core';
+import { EventActivity, MessageActivity, ReadBy, updateMetadata } from 'botframework-webchat-core';
 
 import ACSChatMessage from '../types/ACSChatMessage';
 import Activity from '../types/Activity';
 import createDebug from '../utils/debug';
-import styleConsole from '../utils/styleConsole';
 import UserProfiles from '../types/UserProfiles';
 
 let debug;
 
-// TODO: Verify this logic with ACS team to see if this is correct.
-// function isOthersUserId(userId: string) {
-//   return userId.startsWith('8:');
-// }
-
 // "threadId" is undefined for messages from others, so we prefer to use the "threadId" from setup.
 export default function createACSMessageToWebChatActivityConverter({
   threadId,
@@ -24,39 +18,32 @@ export default function createACSMessageToWebChatActivityConverter({
   threadId: string;
   userId: string;
   userProfiles: UserProfiles;
-}): (chatMessage: ACSChatMessage) => Activity {
+}): (acsChatMessage: ACSChatMessage, metadata: { key: string; readBy: ReadBy; trackingNumber: string }) => Activity {
   debug ||
     (debug = createDebug('util:acsMessageToWebChatActivity', {
       backgroundColor: 'lightgray',
       color: 'black'
     }));
 
-  return acsChatMessage => {
+  return (
+    acsChatMessage: ACSChatMessage,
+    metadata: { key: string; readBy: ReadBy; trackingNumber: string }
+  ): Activity => {
     const now = new Date();
     const { clientMessageId, content, createdOn, id, sender, senderDisplayName, status, type } = acsChatMessage;
 
     // TODO: Checks with ACS team to see if this is a good strategy to find out "user.kind".
-    const who: 'others' | 'self' | 'service' = sender
-      ? sender.communicationUserId && sender.communicationUserId !== userId
-        ? 'others'
-        : 'self'
-      : 'service';
+    const who: 'others' | 'self' | 'service' = !sender
+      ? 'service'
+      : sender.communicationUserId && sender.communicationUserId !== userId
+      ? 'others'
+      : 'self';
 
     const communicationUserId = who === 'self' ? userId : who === 'service' ? undefined : sender.communicationUserId;
 
-    const userProfile = who === 'others' || who === 'self' ? userProfiles[communicationUserId || userId] : undefined;
+    const userProfile = who === 'others' || who === 'self' ? userProfiles[communicationUserId] : undefined;
 
-    // TODO: Assert data if it met our expectation.
-    if (who === 'self') {
-      // Assertion: to work properly, every activity must contains an ID during their lifetime, and this ID must not be changed during any moment of its life.
-      if (!clientMessageId && !id) {
-        // TODO: Check if conversation history contains "clientMessageId".
-        // TODO: After the message is sent and echoed back from ACS, the "clientMessageId" is gone.
-        //       This is crucial for the operation of Web Chat, because, if we can't reference the same message, we will be creating new DOM elements.
-        //       Creating new DOM elements will hurt accessibility (ARIA live region).
-        debug('🔥🔥🔥 %cFor all self messages, "clientMessageId" and/or "id" must be set.%c', ...styleConsole('red'));
-      }
-    }
+    // TODO: Add assertions here to make sure the data met our expectation.
 
     const senderName = (userProfile || {}).name || senderDisplayName;
 
@@ -83,8 +70,10 @@ export default function createACSMessageToWebChatActivityConverter({
       } as any,
       {
         avatarInitials: (userProfile || {}).initials,
-        key: clientMessageId || id,
+        key: metadata.key,
+        readBy: metadata.readBy,
         senderName,
+        trackingNumber: metadata.trackingNumber,
         who
       }
     );
@@ -117,9 +106,6 @@ export default function createACSMessageToWebChatActivityConverter({
           ...activityContent
         },
         {
-          // deliveryStatus: createdOn ? undefined : 'sending' // If it contains "createdOn", it's sent.
-
-          // 'delivered' | 'sending' | 'seen' | 'failed'
           deliveryStatus: status === 'failed' ? 'error' : status === 'sending' ? status : undefined
         }
       );