agora-appbuilder-core 4.0.7 → 4.0.8

package/template/src/components/RTMConfigure.tsx

@@ -47,6 +47,7 @@ import LocalEventEmitter, {
 } from '../rtm-events-api/LocalEvents';
 import {PSTNUserLabel} from '../language/default-labels/videoCallScreenLabels';
 import {controlMessageEnum} from '../components/ChatContext';
+import {LogSource, logger} from '../logger/AppBuilderLogger';
 import {RECORDING_BOT_UID} from '../utils/constants';
 
 export enum UserType {
@@ -139,14 +140,19 @@ const RtmConfigure = (props: any) => {
 
   const doLoginAndSetupRTM = async () => {
     try {
+      logger.log(LogSource.AgoraSDK, 'API', 'RTM login starts');
       await engine.current.login({
         uid: localUid.toString(),
         token: rtcProps.rtm,
       });
+      logger.log(LogSource.AgoraSDK, 'API', 'RTM login done');
       RTMEngine.getInstance().setLocalUID(localUid.toString());
+      logger.log(LogSource.AgoraSDK, 'API', 'RTM local Uid set');
       timerValueRef.current = 5;
       await setAttribute();
+      logger.log(LogSource.AgoraSDK, 'Log', 'RTM setting attribute done');
     } catch (error) {
+      logger.error(LogSource.AgoraSDK, 'Log', 'RTM login failed..Trying again');
       setTimeout(async () => {
         timerValueRef.current = timerValueRef.current + timerValueRef.current;
         doLoginAndSetupRTM();
@@ -160,11 +166,35 @@ const RtmConfigure = (props: any) => {
     ];
     try {
       await engine.current.setLocalUserAttributes(rtmAttributes);
+      logger.log(
+        LogSource.AgoraSDK,
+        'API',
+        'RTM setting local user attributes',
+        {
+          attr: rtmAttributes,
+        },
+      );
       timerValueRef.current = 5;
       await joinChannel();
+      logger.log(LogSource.AgoraSDK, 'Log', 'RTM join channel done', {
+        data: rtmAttributes,
+      });
       setHasUserJoinedRTM(true);
       await runQueuedEvents();
+      logger.log(
+        LogSource.AgoraSDK,
+        'Log',
+        'RTM queued events finished running',
+        {
+          attr: rtmAttributes,
+        },
+      );
     } catch (error) {
+      logger.error(
+        LogSource.AgoraSDK,
+        'Log',
+        'RTM setAttribute failed..Trying again',
+      );
       setTimeout(async () => {
         timerValueRef.current = timerValueRef.current + timerValueRef.current;
         setAttribute();
@@ -176,15 +206,40 @@ const RtmConfigure = (props: any) => {
     try {
       if (RTMEngine.getInstance().channelUid !== rtcProps.channel) {
         await engine.current.joinChannel(rtcProps.channel);
+        logger.log(LogSource.AgoraSDK, 'API', 'RTM joinChannel', {
+          data: rtcProps.channel,
+        });
         RTMEngine.getInstance().setChannelId(rtcProps.channel);
-        console.log('Emitting rtm joined');
+        logger.log(
+          LogSource.AgoraSDK,
+          'API',
+          'RTM setChannelId',
+          rtcProps.channel,
+        );
+        logger.debug(
+          LogSource.SDK,
+          'Event',
+          'Emitting rtm joined',
+          rtcProps.channel,
+        );
         SDKEvents.emit('_rtm-joined', rtcProps.channel);
       } else {
-        console.log('RTM already joined channel skipping');
+        logger.debug(
+          LogSource.AgoraSDK,
+          'Log',
+          'RTM already joined channel skipping',
+          rtcProps.channel,
+        );
       }
       timerValueRef.current = 5;
       await getMembers();
+      logger.log(LogSource.AgoraSDK, 'Log', 'RTM getMembers done');
     } catch (error) {
+      logger.error(
+        LogSource.AgoraSDK,
+        'Log',
+        'RTM joinChannel failed..Trying again',
+      );
       setTimeout(async () => {
         timerValueRef.current = timerValueRef.current + timerValueRef.current;
         joinChannel();
@@ -201,19 +256,48 @@ const RtmConfigure = (props: any) => {
 
   const getMembers = async () => {
     try {
+      logger.log(
+        LogSource.AgoraSDK,
+        'API',
+        'RTM getChannelMembersByID(getMembers) start',
+      );
       await engine.current
         .getChannelMembersBychannelId(rtcProps.channel)
         .then(async data => {
+          logger.log(
+            LogSource.AgoraSDK,
+            'API',
+            'RTM getChannelMembersByID data received',
+            data,
+          );
           await Promise.all(
             data.members.map(async (member: any) => {
               const backoffAttributes = backOff(
                 async () => {
+                  logger.log(
+                    LogSource.AgoraSDK,
+                    'API',
+                    `RTM fetching getUserAttributesByUid for member ${member.uid}`,
+                  );
                   const attr = await engine.current.getUserAttributesByUid(
                     member.uid,
                   );
                   if (!attr || !attr.attributes) {
+                    logger.log(
+                      LogSource.AgoraSDK,
+                      'API',
+                      'RTM attributes for member not found',
+                    );
                     throw attr;
                   }
+                  logger.log(
+                    LogSource.AgoraSDK,
+                    'API',
+                    `RTM getUserAttributesByUid for member ${member.uid} received`,
+                    {
+                      attr,
+                    },
+                  );
                   for (const key in attr.attributes) {
                     if (
                       attr.attributes.hasOwnProperty(key) &&
@@ -227,7 +311,9 @@ const RtmConfigure = (props: any) => {
                 },
                 {
                   retry: (e, idx) => {
-                    console.log(
+                    logger.debug(
+                      LogSource.AgoraSDK,
+                      'Log',
                       `[retrying] Attempt ${idx}. Fetching ${member.uid}'s name`,
                       e,
                     );
@@ -279,12 +365,20 @@ const RtmConfigure = (props: any) => {
                   }
                 }
               } catch (e) {
-                console.error(`Could not retrieve name of ${member.uid}`, e);
+                logger.error(
+                  LogSource.AgoraSDK,
+                  'Log',
+                  `Could not retrieve name of ${member.uid}`,
+                  e,
+                );
               }
             }),
           );
-
-          console.log('RTM init done');
+          logger.debug(
+            LogSource.AgoraSDK,
+            'Log',
+            'RTM fetched all data and user attr...RTM init done',
+          );
         });
       timerValueRef.current = 5;
     } catch (error) {
@@ -296,8 +390,10 @@ const RtmConfigure = (props: any) => {
   };
 
   const init = async () => {
+    logger.log(LogSource.AgoraSDK, 'Log', 'RTM creating engine...');
     engine.current = RTMEngine.getInstance().engine;
     RTMEngine.getInstance();
+    logger.log(LogSource.AgoraSDK, 'Log', 'RTM engine creation done');
 
     engine.current.on('connectionStateChanged', (evt: any) => {
       //console.log(evt);
@@ -306,12 +402,31 @@ const RtmConfigure = (props: any) => {
       // console.log(evt);
     });
     engine.current.on('channelMemberJoined', (data: any) => {
+      logger.log(LogSource.AgoraSDK, 'Event', 'channelMemberJoined', data);
       const backoffAttributes = backOff(
         async () => {
+          logger.log(
+            LogSource.AgoraSDK,
+            'API',
+            `RTM fetching getUserAttributesByUid for member ${data.uid}`,
+          );
           const attr = await engine.current.getUserAttributesByUid(data.uid);
           if (!attr || !attr.attributes) {
+            logger.log(
+              LogSource.AgoraSDK,
+              'API',
+              'RTM attributes for member not found',
+            );
             throw attr;
           }
+          logger.log(
+            LogSource.AgoraSDK,
+            'API',
+            `RTM getUserAttributesByUid for member ${data.uid} received`,
+            {
+              attr,
+            },
+          );
           for (const key in attr.attributes) {
             if (attr.attributes.hasOwnProperty(key) && attr.attributes[key]) {
               return attr;
@@ -322,7 +437,9 @@ const RtmConfigure = (props: any) => {
         },
         {
           retry: (e, idx) => {
-            console.log(
+            logger.debug(
+              LogSource.AgoraSDK,
+              'Log',
               `[retrying] Attempt ${idx}. Fetching ${data.uid}'s name`,
               e,
             );
@@ -356,14 +473,19 @@ const RtmConfigure = (props: any) => {
           updateRenderListState(screenUid, screenShareUser);
           //end - updating screenshare data in rtc
         } catch (e) {
-          console.error(`Could not retrieve name of ${data.uid}`, e);
+          logger.error(
+            LogSource.AgoraSDK,
+            'Event',
+            `Failed to retrive name of ${data.uid}`,
+            e,
+          );
         }
       }
       getname();
     });
 
     engine.current.on('channelMemberLeft', (data: any) => {
-      console.log('user left', data);
+      logger.debug(LogSource.AgoraSDK, 'Event', 'channelMemberLeft', data);
       // Chat of left user becomes undefined. So don't cleanup
       const uid = data?.uid ? parseInt(data?.uid) : undefined;
       if (!uid) return;
@@ -374,12 +496,15 @@ const RtmConfigure = (props: any) => {
     });
 
     engine.current.on('messageReceived', (evt: any) => {
-      console.log('CUSTOM_EVENT_API messageReceived: ', evt);
+      logger.debug(LogSource.Events, 'CUSTOM_EVENTS', 'messageReceived', evt);
       const {peerId, ts, text} = evt;
       const [err, msg] = safeJsonParse(text);
       if (err) {
-        console.log(
-          'CUSTOM_EVENT_API: JSON payload incorrect, Error while parsing the payload',
+        logger.error(
+          LogSource.Events,
+          'CUSTOM_EVENTS',
+          'JSON payload incorrect, Error while parsing the payload',
+          err,
         );
       }
 
@@ -390,22 +515,36 @@ const RtmConfigure = (props: any) => {
       try {
         eventDispatcher(msg, sender, timestamp);
       } catch (error) {
-        console.log('error while dispacthing', error);
+        logger.error(
+          LogSource.Events,
+          'CUSTOM_EVENTS',
+          'error while dispatching through eventDispatcher',
+          err,
+        );
       }
     });
 
     engine.current.on('channelMessageReceived', evt => {
-      console.log('CUSTOM_EVENT_API channelMessageReceived: ', evt);
+      logger.debug(
+        LogSource.Events,
+        'CUSTOM_EVENTS',
+        'channelMessageReceived',
+        evt,
+      );
 
       const {uid, channelId, text, ts} = evt;
       //whiteboard upload
       if (uid == 1010101) {
         const [err, res] = safeJsonParse(text);
         if (err) {
-          console.log(
-            'CUSTOM_EVENT_API: JSON payload incorrect, Error while parsing the payload',
+          logger.error(
+            LogSource.Events,
+            'CUSTOM_EVENTS',
+            'JSON payload incorrect, Error while parsing the payload',
+            err,
           );
         }
+
         if (res?.data?.data?.images) {
           LocalEventEmitter.emit(
             LocalEventsEnum.WHITEBOARD_FILE_UPLOAD,
@@ -415,8 +554,11 @@ const RtmConfigure = (props: any) => {
       } else {
         const [err, msg] = safeJsonParse(text);
         if (err) {
-          console.log(
-            'CUSTOM_EVENT_API: JSON payload incorrect, Error while parsing the payload',
+          logger.error(
+            LogSource.Events,
+            'CUSTOM_EVENTS',
+            'JSON payload incorrect, Error while parsing the payload',
+            err,
           );
         }
 
@@ -428,7 +570,12 @@ const RtmConfigure = (props: any) => {
           try {
             eventDispatcher(msg, sender, timestamp);
           } catch (error) {
-            console.log('error while dispacthing', error);
+            logger.error(
+              LogSource.Events,
+              'CUSTOM_EVENTS',
+              'error while dispatching through eventDispatcher',
+              error,
+            );
           }
         }
       }
@@ -443,7 +590,12 @@ const RtmConfigure = (props: any) => {
         await eventDispatcher(currEvt.data, currEvt.uid, currEvt.ts);
       }
     } catch (error) {
-      console.log('CUSTOM_EVENT_API:  error while running queue events', error);
+      logger.error(
+        LogSource.Events,
+        'CUSTOM_EVENTS',
+        'error while running queue events',
+        error,
+      );
     }
   };
 
@@ -455,7 +607,13 @@ const RtmConfigure = (props: any) => {
     sender: string,
     ts: number,
   ) => {
-    console.log('CUSTOM_EVENT_API: inside eventDispatcher ', data);
+    logger.debug(
+      LogSource.Events,
+      'CUSTOM_EVENTS',
+      'inside eventDispatcher ',
+      data,
+    );
+
     let evt = '',
       value = {};
 
@@ -521,7 +679,7 @@ const RtmConfigure = (props: any) => {
         await engine.current.addOrUpdateLocalUserAttributes([rtmAttribute]);
       }
       // Step 2: Emit the event
-      console.log('CUSTOM_EVENT_API:  emiting event..: ');
+      logger.debug(LogSource.Events, 'CUSTOM_EVENTS', 'emiting event..: ');
       EventUtils.emitEvent(evt, source, {payload, persistLevel, sender, ts});
       // Because async gets evaluated in a different order when in an sdk
       if (evt === 'name') {
@@ -535,7 +693,12 @@ const RtmConfigure = (props: any) => {
         }, 200);
       }
     } catch (error) {
-      console.log('CUSTOM_EVENT_API: error while emiting event: ', error);
+      logger.error(
+        LogSource.Events,
+        'CUSTOM_EVENTS',
+        'error while emiting event:',
+        error,
+      );
     }
   };
 
@@ -544,11 +707,12 @@ const RtmConfigure = (props: any) => {
       return;
     }
     await RTMEngine.getInstance().destroy();
+    logger.log(LogSource.AgoraSDK, 'API', 'RTM destroy done');
     if (isIOS() || isAndroid()) {
       EventUtils.clear();
     }
     setHasUserJoinedRTM(false);
-    console.log('RTM cleanup done');
+    logger.debug(LogSource.AgoraSDK, 'Log', 'RTM cleanup done');
   };
 
   useAsyncEffect(async () => {

package/template/src/components/SettingsView.tsx

@@ -53,6 +53,7 @@ import {
   settingPanelNameCantbeChangedInfo,
   settingPanelNameInputLabel,
 } from '../../src/language/default-labels/videoCallScreenLabels';
+import {LogSource, logger} from '../logger/AppBuilderLogger';
 
 interface EditNameProps {}
 const EditName: React.FC = (props?: EditNameProps) => {
@@ -100,6 +101,7 @@ const EditName: React.FC = (props?: EditNameProps) => {
         setSaved(false);
       }, 2000);
       setEditable(false);
+      logger.log(LogSource.Internals, 'NAME', `Name changed ${newName}`);
       saveName(trimmedText ? trimmedText : username);
     } else {
       setEditable(true);

package/template/src/components/Share.tsx

@@ -51,6 +51,7 @@ import {
   shareRoomPSTNSubText,
   shareRoomStartBtnText,
 } from '../language/default-labels/shareLinkScreenLabels';
+import {LogSource, logger} from '../logger/AppBuilderLogger';
 
 export interface CopyMeetingInfoProps {
   showSubLabel?: boolean;
@@ -342,7 +343,17 @@ const Share = () => {
   const copyInviteButton = useString(shareRoomCopyBtnText)();
   const history = useHistory();
   const enterMeeting = () => {
+    logger.log(
+      LogSource.Internals,
+      'ENTER_MEETING_ROOM',
+      'user clicked on button - Start meeting',
+    );
     if (roomId?.host) {
+      logger.log(
+        LogSource.Internals,
+        'ENTER_MEETING_ROOM',
+        'user is being navigated to meeting room',
+      );
       history.push(roomId.host);
     }
   };

package/template/src/components/StorageContext.tsx

@@ -13,6 +13,7 @@ import React, {createContext, ReactChildren, useEffect, useState} from 'react';
 import AsyncStorage from '@react-native-async-storage/async-storage';
 import useMount from './useMount';
 import {ENABLE_AUTH} from '../auth/config';
+import {logger, LogSource} from '../logger/AppBuilderLogger';
 
 type rememberedDevicesListEntries = Record<
   string,
@@ -74,9 +75,16 @@ export const StorageProvider = (props: {children: React.ReactNode}) => {
   useMount(() => {
     const hydrateStore = async () => {
       try {
+        logger.log(LogSource.Internals, 'STORE', 'hydrating store');
         const storeString = await AsyncStorage.getItem('store');
         if (storeString === null) {
           await AsyncStorage.setItem('store', JSON.stringify(initStoreValue));
+          logger.log(
+            LogSource.Internals,
+            'STORE',
+            'hydrating store from initial values done',
+            initStoreValue,
+          );
           setReady(true);
         } else {
           const storeFromStorage = JSON.parse(storeString);
@@ -91,11 +99,22 @@ export const StorageProvider = (props: {children: React.ReactNode}) => {
           }
           storeFromStorage['whiteboardNativeInfoToast'] = false;
           setStore(storeFromStorage);
+          logger.log(
+            LogSource.Internals,
+            'STORE',
+            'hydrating store from already stored values done',
+            storeFromStorage,
+          );
           setReady(true);
         }
         setReady(true);
       } catch (e) {
-        console.error('problem hydrating store', e);
+        logger.error(
+          LogSource.Internals,
+          'STORE',
+          'problem hydrating store',
+          e,
+        );
       }
     };
     hydrateStore();
@@ -115,8 +134,19 @@ export const StorageProvider = (props: {children: React.ReactNode}) => {
           tempStore['token'] = null;
         }
         await AsyncStorage.setItem('store', JSON.stringify(tempStore));
+        logger.log(
+          LogSource.Internals,
+          'STORE',
+          'syncing storage done',
+          tempStore,
+        );
       } catch (e) {
-        console.log('problem syncing the store', e);
+        logger.error(
+          LogSource.Internals,
+          'STORE',
+          'problem syncing the store',
+          e,
+        );
       }
     };
     ready && syncStore();

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

@@ -38,6 +38,7 @@ import {
   multiplePublicAndPrivateChatToastSubHeading,
   multiplePublicChatToastSubHeading,
 } from '../../language/default-labels/videoCallScreenLabels';
+import {LogSource, logger} from '../../logger/AppBuilderLogger';
 
 enum ChatMessageActionEnum {
   Create = 'Create_Chat_Message',
@@ -463,7 +464,12 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
                 lastMessageTimeStamp: new Date().getTime(),
               });
             } catch (error) {
-              console.log("ERROR : couldn't update the last message timestamp");
+              logger.error(
+                LogSource.Internals,
+                'CHAT',
+                'ERROR : couldnt update the last message timestamp',
+                error,
+              );
             }
             showMessageNotification(messageData.msg, `${data.sender}`, true);
             addMessageToPrivateStore(
@@ -605,6 +611,13 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
 
   const sendChatMessage = (msg: string, toUid?: UidType) => {
     if (typeof msg == 'string' && msg.trim() === '') return;
+    logger.log(
+      LogSource.Internals,
+      'CHAT',
+      `sending ${toUid ? 'private' : 'public'} chat message -> ${msg} ${
+        toUid ? toUid : ''
+      }`,
+    );
     if (toUid) {
       const messageData = {
         msg,
@@ -643,6 +656,15 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
 
   const editChatMessage = (msgId: string, msg: string, toUid?: UidType) => {
     if (typeof msg == 'string' && msg.trim() === '') return;
+    logger.log(
+      LogSource.Internals,
+      'CHAT',
+      `editing ${toUid ? 'private' : 'public'} chat message..`,
+      {
+        msgId,
+        msg,
+      },
+    );
     if (toUid) {
       const checkData = privateMessageStore[toUid].filter(
         item => item.msgId === msgId && item.uid === localUid,
@@ -671,7 +693,15 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
           return newState;
         });
       } else {
-        console.log("You don't have permission to edit");
+        logger.debug(
+          LogSource.Internals,
+          'CHAT',
+          "You don't have permission to edit",
+          {
+            msgId,
+            msg,
+          },
+        );
       }
     } else {
       //check if user has permission to edit
@@ -699,12 +729,28 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
           return newState;
         });
       } else {
-        console.log("You don't have permission to edit");
+        logger.debug(
+          LogSource.Internals,
+          'CHAT',
+          "You don't have permission to edit",
+          {
+            msgId,
+            msg,
+          },
+        );
       }
     }
   };
 
   const deleteChatMessage = (msgId: string, toUid?: UidType) => {
+    logger.log(
+      LogSource.Internals,
+      'CHAT',
+      `deleting ${toUid ? 'private' : 'public'} chat message..`,
+      {
+        msgId,
+      },
+    );
     if (toUid) {
       const checkData = privateMessageStore[toUid].filter(
         item => item.msgId === msgId && item.uid === localUid,
@@ -733,7 +779,14 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
           return newState;
         });
       } else {
-        console.log("You don't have permission to delete");
+        logger.debug(
+          LogSource.Internals,
+          'CHAT',
+          "You don't have permission to delete",
+          {
+            msgId,
+          },
+        );
       }
     } else {
       //check if user has permission to delete
@@ -761,7 +814,14 @@ const ChatMessagesProvider = (props: ChatMessagesProviderProps) => {
           return newState;
         });
       } else {
-        console.log("You don't have permission to delete");
+        logger.debug(
+          LogSource.Internals,
+          'CHAT',
+          "You don't have permission to delete",
+          {
+            msgId,
+          },
+        );
       }
     }
   };

package/template/src/components/contexts/WaitingRoomContext.tsx

@@ -4,6 +4,7 @@ import {UidType} from '../../../agora-rn-uikit';
 import {useContent} from 'customization-api';
 import {createHook} from 'customization-implementation';
 import {filterObject} from '../../utils';
+import {LogSource, logger} from '../../logger/AppBuilderLogger';
 
 export interface WaitingRoomContextInterface {
   waitingRoomUids: UidType[];
@@ -29,7 +30,10 @@ const WaitingRoomProvider = ({children}) => {
           v?.type === 'rtc' && !v.offline && v?.isInWaitingRoom === true,
       ),
     ).map(Number);
-    console.log('in waiting - de', uids, defaultContent);
+    logger.debug(LogSource.Internals, 'WAITING_ROOM', 'users in waiting room', {
+      uids,
+      defaultContent,
+    });
 
     setwaitingRoomUids(uids);
   }, [defaultContent]);

package/template/src/components/precall/joinCallBtn.tsx

@@ -26,6 +26,7 @@ import isMobileOrTablet from '../../utils/isMobileOrTablet';
 import {isWebInternal} from '../../utils/common';
 import useSetName from '../../utils/useSetName';
 import {useUserPreference} from '../useUserPreference';
+import {LogSource, logger} from '../../logger/AppBuilderLogger';
 
 const audio = new Audio(
   'https://dl.dropboxusercontent.com/s/1cdwpm3gca9mlo0/kick.mp3',
@@ -59,6 +60,11 @@ const JoinCallBtn = (props: PreCallJoinCallBtnProps) => {
   );
 
   const onSubmit = () => {
+    logger.log(
+      LogSource.Internals,
+      'PRECALL_SCREEN',
+      'User clicked on join call button. setting call active to true',
+    );
     setUsername(username.trim());
     setCallActive(true);
     //updating name in the backend