Feature/chat delay login [don't merge for now]

template/customization-api/utils.ts

@@ -35,3 +35,4 @@ export {default as useLocalAudio} from '../src/utils/useLocalAudio';
 export {default as useLocalVideo} from '../src/utils/useLocalVideo';
 export type {LanguageType} from '../src/subComponents/caption/utils';
 export {default as useSpeechToText} from '../src/utils/useSpeechToText';
+export {default as useChatLogin} from '../src/utils/useChatLogin';

template/src/SDKAppWrapper.tsx

@@ -21,13 +21,13 @@ export interface AppBuilderSdkApiInterface {
   joinRoom: (
     roomDetails: string | meetingData,
     userName?: string,
-    preference?: {disableShareTile: boolean},
+    preference?: {disableShareTile?: boolean; preventChatAutoLogin?: boolean},
   ) => Promise<meetingData>;
   joinPrecall: (
     roomDetails: string | meetingData,
     userName?: string,
     skipPrecall?: boolean,
-    preference?: {disableShareTile: boolean},
+    preference?: {disableShareTile?: boolean; preventChatAutoLogin?: boolean},
   ) => Promise<
     [
       meetingData,
@@ -73,7 +73,7 @@ export const AppBuilderSdkApi: AppBuilderSdkApiInterface = {
     logger.log(LogSource.SDK, 'Event', 'emiting event for joinRoom - join', {
       room: roomDetails,
       userName: userName,
-      preference: preference
+      preference: preference,
     });
     return await SDKMethodEventsManager.emit(
       'join',
@@ -87,7 +87,7 @@ export const AppBuilderSdkApi: AppBuilderSdkApiInterface = {
     logger.log(LogSource.SDK, 'Event', 'emiting event for joinPrecall - join', {
       room: roomDetails,
       userName: userName,
-      preference: preference
+      preference: preference,
     });
     if (!$config.PRECALL) {
       logger.error(

template/src/components/SdkApiContext.tsx

@@ -27,7 +27,10 @@ type SdkApiContextInterface = {
         meetingDetails?: Partial<RoomInfoContextInterface['data']>;
         userName: string;
         skipPrecall: boolean;
-        preference: {disableShareTile: boolean};
+        preference: {
+          disableShareTile?: boolean;
+          preventChatAutoLogin?: boolean;
+        };
         promise: extractPromises<_InternalSDKMethodEventsMap['join']>;
       }
     | {

template/src/components/chat-messages/useChatMessages.tsx

@@ -116,6 +116,7 @@ export interface ChatOption {
     file_name: string;
     file_url: string;
     from_platform?: string;
+    channel?: string;
   };
   url?: string;
 }

template/src/components/chat/chatConfigure.native.tsx

@@ -23,6 +23,11 @@ import {timeNow} from '../../rtm/utils';
 import Share from 'react-native-share';
 import RNFetchBlob from 'rn-fetch-blob';
 import {logger, LogSource} from '../../logger/AppBuilderLogger';
+import LocalEventEmitter, {
+  LocalEventsEnum,
+} from '../../rtm-events-api/LocalEvents';
+import events from '../../rtm-events-api';
+import {EventNames} from '../../rtm-events';
 
 interface ChatMessageAttributes {
   file_ext?: string;
@@ -34,6 +39,7 @@ interface ChatMessageAttributes {
 interface chatConfigureContextInterface {
   open: boolean;
   setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+  allowChatLogin: boolean;
   sendChatSDKMessage: (
     option: ChatOption,
     callback: ChatMessageStatusCallback,
@@ -51,6 +57,7 @@ export const chatConfigureContext =
   createContext<chatConfigureContextInterface>({
     open: false,
     setOpen: () => {},
+    allowChatLogin: false,
     sendChatSDKMessage: () => {},
     deleteChatUser: () => {},
     downloadAttachment: () => {},
@@ -59,16 +66,19 @@ export const chatConfigureContext =
 
 const ChatConfigure = ({children}) => {
   const [open, setOpen] = useState(false);
-  const {data} = useRoomInfo();
+  const {data, roomPreference} = useRoomInfo();
   const connRef = React.useRef(null);
-  const {defaultContent} = useContent();
-  const defaultContentRef = React.useRef(defaultContent);
+
   const chatClient = ChatClient.getInstance();
   const chatManager = chatClient.chatManager;
 
   const localUid = data?.uid?.toString();
   const agoraToken = data?.chat?.user_token;
   const {store} = React.useContext(StorageContext);
+  const [allowChatLogin, setAllowChatLogin] = useState(
+    () => !roomPreference.preventChatAutoLogin,
+  );
+
   const {
     addMessageToPrivateStore,
     showMessageNotification,
@@ -77,29 +87,54 @@ const ChatConfigure = ({children}) => {
     removeMessageFromPrivateStore,
   } = useChatMessages();
 
-  React.useEffect(() => {
-    defaultContentRef.current = defaultContent;
-  }, [defaultContent]);
+  const enableChatLoginCallback = () => {
+    console.warn('allow chat login callback', allowChatLogin);
+    setAllowChatLogin(true);
+  };
+
+  const logout = async () => {
+    try {
+      await chatClient?.logout();
+      console.warn('chat logout success');
+      logger.log(
+        LogSource.Internals,
+        'CHAT',
+        `Logged out User ${localUid} from Agora Chat Server`,
+      );
+    } catch (error) {
+      console.warn('logout failed');
+      logger.log(
+        LogSource.Internals,
+        'CHAT',
+        `Failed Logging  out User ${localUid} from Agora Chat Server`,
+      );
+    }
+  };
+
+  const enableChatLogoutCallback = async () => {
+    console.warn('allow chat logout callback', allowChatLogin);
+    setAllowChatLogin(false);
+    await logout();
+  };
 
   useEffect(() => {
-    const logout = async () => {
-      try {
-        await chatClient.logout();
-        console.warn('logout success');
-        logger.log(
-          LogSource.Internals,
-          'CHAT',
-          `Logged out User ${localUid} from Agora Chat Server`,
-        );
-      } catch (error) {
-        console.warn('logout failed');
-        logger.log(
-          LogSource.Internals,
-          'CHAT',
-          `Failed Logging  out User ${localUid} from Agora Chat Server`,
-        );
-      }
-    };
+    // Handle Chat login for self and other users
+    LocalEventEmitter.on(
+      LocalEventsEnum.ENABLE_CHAT_LOGIN,
+      enableChatLoginCallback,
+    );
+    events.on(EventNames.ENABLE_CHAT_LOGIN, () => {
+      enableChatLoginCallback();
+    });
+
+    LocalEventEmitter.on(
+      LocalEventsEnum.ENABLE_CHAT_LOGOUT,
+      enableChatLogoutCallback,
+    );
+    events.on(EventNames.ENABLE_CHAT_LOGOUT, () => {
+      enableChatLogoutCallback();
+    });
+
     const setupMessageListener = () => {
       const msgListerner: ChatMessageEventListener = {
         onMessagesRecalled: (messages: ChatMessage[]) => {
@@ -322,12 +357,26 @@ const ChatConfigure = ({children}) => {
         console.warn('chat sdk: init error', error);
       }
     };
+    if (allowChatLogin) {
+      initializeChatSDK();
+    } else {
+      console.warn('delay chat login');
+    }
 
-    initializeChatSDK();
     return () => {
       logout();
+      LocalEventEmitter.off(
+        LocalEventsEnum.ENABLE_CHAT_LOGIN,
+        enableChatLoginCallback,
+      );
+      events.off(EventNames.ENABLE_CHAT_LOGIN, enableChatLoginCallback);
+      LocalEventEmitter.off(
+        LocalEventsEnum.ENABLE_CHAT_LOGOUT,
+        enableChatLogoutCallback,
+      );
+      events.off(EventNames.ENABLE_CHAT_LOGOUT, enableChatLogoutCallback);
     };
-  }, []);
+  }, [allowChatLogin]);
 
   const sendChatSDKMessage = (
     option: ChatOption,
@@ -489,6 +538,7 @@ const ChatConfigure = ({children}) => {
       value={{
         open,
         setOpen,
+        allowChatLogin,
         deleteChatUser,
         sendChatSDKMessage,
         downloadAttachment,

template/src/components/chat/chatConfigure.tsx

@@ -2,6 +2,8 @@ import {createHook} from 'customization-implementation';
 import React, {createContext, useState, useEffect} from 'react';
 import AgoraChat from 'agora-chat';
 import {useRoomInfo} from '../room-info/useRoomInfo';
+import events from '../../rtm-events-api';
+import {EventNames} from '../../rtm-events';
 
 import {UidType, useContent} from 'customization-api';
 import {
@@ -18,6 +20,9 @@ import {
   useChatUIControls,
 } from '../../components/chat-ui/useChatUIControls';
 import {logger, LogSource} from '../../logger/AppBuilderLogger';
+import LocalEventEmitter, {
+  LocalEventsEnum,
+} from '../../rtm-events-api/LocalEvents';
 
 export interface FileObj {
   url: string;
@@ -29,6 +34,7 @@ export interface FileObj {
 interface chatConfigureContextInterface {
   open: boolean;
   setOpen: React.Dispatch<React.SetStateAction<boolean>>;
+  allowChatLogin: boolean;
   sendChatSDKMessage: (option: ChatOption, messageStatusCallback?: any) => void;
   deleteChatUser: () => void;
   downloadAttachment: (fileName: string, fileUrl: string) => void;
@@ -44,6 +50,7 @@ export const chatConfigureContext =
   createContext<chatConfigureContextInterface>({
     open: false,
     setOpen: () => {},
+    allowChatLogin: false,
     sendChatSDKMessage: () => {},
     deleteChatUser: () => {},
     downloadAttachment: () => {},
@@ -53,12 +60,20 @@ export const chatConfigureContext =
 
 const ChatConfigure = ({children}) => {
   const [open, setOpen] = useState(false);
-  const {data} = useRoomInfo();
+  const {data, roomPreference} = useRoomInfo();
+  const [allowChatLogin, setAllowChatLogin] = useState(
+    () => !roomPreference.preventChatAutoLogin,
+  );
+
+  // exponse onClick Chat so that this can be set truel
+  //const allowChatLogin = !roomPreference?.preventChatAutoLogin;
+  logger.debug(LogSource.Internals, 'CHAT', `Allow Chat Login`, allowChatLogin);
+
   const connRef = React.useRef(null);
-  const {defaultContent} = useContent();
+
   const {privateChatUser, setUploadStatus, setUploadedFiles, uploadedFiles} =
     useChatUIControls();
-  const defaultContentRef = React.useRef(defaultContent);
+
   const {
     addMessageToPrivateStore,
     showMessageNotification,
@@ -68,13 +83,39 @@ const ChatConfigure = ({children}) => {
   } = useChatMessages();
   const {store} = React.useContext(StorageContext);
 
-  React.useEffect(() => {
-    defaultContentRef.current = defaultContent;
-  }, [defaultContent]);
-
   let newConn = null;
 
+  const enableChatLoginCallback = () => {
+    logger.debug(LogSource.Internals, 'CHAT', `enable chat login callback`);
+    setAllowChatLogin(true);
+  };
+
+  const enableChatLogoutCallback = () => {
+    logger.debug(LogSource.Internals, 'CHAT', `enable chat logout callback`);
+    setAllowChatLogin(false);
+    if (connRef.current) {
+      connRef.current.close();
+    }
+  };
+
   useEffect(() => {
+    // Handle Chat login for self and other users
+    LocalEventEmitter.on(
+      LocalEventsEnum.ENABLE_CHAT_LOGIN,
+      enableChatLoginCallback,
+    );
+    events.on(EventNames.ENABLE_CHAT_LOGIN, () => {
+      enableChatLoginCallback();
+    });
+
+    LocalEventEmitter.on(
+      LocalEventsEnum.ENABLE_CHAT_LOGOUT,
+      enableChatLogoutCallback,
+    );
+    events.on(EventNames.ENABLE_CHAT_LOGOUT, () => {
+      enableChatLogoutCallback();
+    });
+
     const initializeChatSDK = async () => {
       try {
         // disable Chat SDK logs
@@ -307,16 +348,30 @@ const ChatConfigure = ({children}) => {
     };
 
     // initializing chat sdk
-    initializeChatSDK();
+    if (allowChatLogin) {
+      initializeChatSDK();
+    }
     return () => {
-      newConn.close();
-      logger.log(
-        LogSource.Internals,
-        'CHAT',
-        `Logging out User ${data.uid} from Agora Chat Server`,
+      if (newConn) {
+        newConn.close();
+        logger.log(
+          LogSource.Internals,
+          'CHAT',
+          `Logging out User ${data.uid} from Agora Chat Server`,
+        );
+      }
+      LocalEventEmitter.off(
+        LocalEventsEnum.ENABLE_CHAT_LOGIN,
+        enableChatLoginCallback,
+      );
+      events.off(EventNames.ENABLE_CHAT_LOGIN, enableChatLoginCallback);
+      LocalEventEmitter.off(
+        LocalEventsEnum.ENABLE_CHAT_LOGOUT,
+        enableChatLogoutCallback,
       );
+      events.off(EventNames.ENABLE_CHAT_LOGOUT, enableChatLogoutCallback);
     };
-  }, []);
+  }, [allowChatLogin]);
 
   const sendChatSDKMessage = (
     option: ChatOption,
@@ -492,6 +547,7 @@ const ChatConfigure = ({children}) => {
       value={{
         open,
         setOpen,
+        allowChatLogin,
         sendChatSDKMessage,
         deleteChatUser,
         downloadAttachment,

template/src/components/room-info/useRoomInfo.tsx

@@ -116,6 +116,7 @@ export const RoomInfoDefaultValue: RoomInfoContextInterface = {
   },
   roomPreference: {
     disableShareTile: false,
+    preventChatAutoLogin: false,
   },
 };