refactor(service-providers): add agoraAppId config in join room (#2151

)

packages/flat-server-api/src/room.ts

@@ -103,6 +103,7 @@ export interface JoinRoomResult {
     rtmToken: string;
     showGuide: boolean;
     region: Region;
+    agoraAppId?: string;
     billing?: {
         /** minutes */
         limit: number;

packages/flat-services/src/services/text-chat/text-chat.ts

@@ -14,6 +14,7 @@ export interface IServiceTextChatJoinRoomConfig {
     ownerUUID: string;
     uid: string;
     token?: string | null;
+    agoraAppId?: string | null;
 }
 
 export abstract class IServiceTextChat implements IService {

packages/flat-services/src/services/video-chat/video-chat.ts

@@ -30,6 +30,7 @@ export interface IServiceVideoChatJoinRoomConfig {
     shareScreenUID: IServiceVideoChatUID;
     shareScreenToken: string;
     mirror?: boolean;
+    agoraAppId?: string | null;
 }
 
 export abstract class IServiceVideoChat implements IService {

packages/flat-stores/src/classroom-store/index.ts

@@ -376,6 +376,7 @@ export class ClassroomStore {
             ownerUUID: this.ownerUUID,
             uid: this.userUUID,
             token: globalStore.rtmToken,
+            agoraAppId: globalStore.agoraAppId,
         });
 
         const fastboard = await this.whiteboardStore.joinWhiteboardRoom();
@@ -1508,6 +1509,7 @@ export class ClassroomStore {
                 shareScreenUID: String(globalStore.rtcShareScreen?.uid || -1),
                 shareScreenToken: globalStore.rtcShareScreen?.token || "",
                 mirror: preferencesStore.mirrorMode,
+                agoraAppId: globalStore.agoraAppId,
             });
 
             if (preferencesStore.cameraId) {

packages/flat-stores/src/global-store.ts

@@ -67,6 +67,7 @@ export class GlobalStore {
      * Room's region, services (currently only whiteboard) must use this value to join the room.
      */
     public region: Region | null = null;
+    public agoraAppId: string | null = null;
     public rtcToken: string | null = null;
     public rtcUID: number | null = null;
     public rtcShareScreen: {
@@ -219,6 +220,7 @@ export class GlobalStore {
                 | "rtcUID"
                 | "rtcShareScreen"
                 | "region"
+                | "agoraAppId"
             >
         >,
     ): void => {
@@ -230,6 +232,7 @@ export class GlobalStore {
             "rtcUID",
             "rtcShareScreen",
             "region",
+            "agoraAppId",
         ] as const;
         for (const key of keys) {
             const value = config[key];

packages/flat-stores/src/room-store.ts

@@ -57,6 +57,7 @@ export interface RoomItem {
         expireAt: number;
         vipLevel: 0 | 1;
     };
+    agoraAppId?: string;
 }
 
 // Only keep sub-room ids. sub-room info are stored in ordinaryRooms.
@@ -144,6 +145,7 @@ export class RoomStore {
             ownerUUID: data.ownerUUID,
             roomType: data.roomType,
             billing: data.billing,
+            agoraAppId: data.agoraAppId,
         });
         return data;
     }

service-providers/agora-rtc/agora-rtc-electron/src/agora-rtc-electron.ts

@@ -32,11 +32,12 @@ export class AgoraRTCElectron extends IServiceVideoChat {
     public readonly isMac: boolean;
     public readonly shareScreen = new AgoraRTCElectronShareScreen({ rtc: this });
 
-    public readonly APP_ID: string;
     public readonly rtcEngine: AgoraSdk;
 
     private readonly _roomSideEffect = new SideEffectManager();
 
+    public APP_ID: string;
+
     private _cameraID?: string;
     private _micID?: string;
     private _speakerID?: string;
@@ -203,6 +204,12 @@ export class AgoraRTCElectron extends IServiceVideoChat {
             }
             this.leaveRoom();
         }
+
+        if (config.agoraAppId && config.agoraAppId !== this.APP_ID) {
+            this.rtcEngine.release(true);
+            this.rtcEngine.initialize((this.APP_ID = config.agoraAppId));
+        }
+
         return this._join(config);
     }
 

service-providers/agora-rtc/agora-rtc-web/src/agora-rtc-web.ts

@@ -42,8 +42,6 @@ export interface AgoraRTCWebConfig {
 }
 
 export class AgoraRTCWeb extends IServiceVideoChat {
-    public readonly APP_ID: string;
-
     public readonly shareScreen: AgoraRTCWebShareScreen;
 
     private readonly _roomSideEffect = new SideEffectManager();
@@ -52,6 +50,7 @@ export class AgoraRTCWeb extends IServiceVideoChat {
     private _pLeavingRoom?: Promise<unknown>;
     private _testingAudio?: HTMLAudioElement;
 
+    public APP_ID: string;
     public client?: IAgoraRTCClient;
     public mode?: IServiceVideoChatMode;
 
@@ -358,6 +357,7 @@ export class AgoraRTCWeb extends IServiceVideoChat {
         shareScreenUID,
         shareScreenToken,
         mirror,
+        agoraAppId,
     }: IServiceVideoChatJoinRoomConfig): Promise<void> {
         this._roomSideEffect.flushAll();
 
@@ -494,6 +494,10 @@ export class AgoraRTCWeb extends IServiceVideoChat {
             }),
         );
 
+        if (agoraAppId && agoraAppId !== this.APP_ID) {
+            this.APP_ID = agoraAppId;
+        }
+
         await client.join(
             this.APP_ID,
             roomUUID,

service-providers/agora-rtm/src/rtm.ts

@@ -24,14 +24,14 @@ export class AgoraRTM extends IServiceTextChat {
     private _pJoiningRoom?: Promise<unknown>;
     private _pLeavingRoom?: Promise<unknown>;
 
-    public readonly client: RtmClient;
+    public client: RtmClient;
     public channel?: RtmChannel;
 
     private roomUUID?: string;
     private userUUID?: string;
     private token?: string;
 
-    public constructor(APP_ID: string) {
+    public constructor(public APP_ID: string) {
         super();
         if (!APP_ID) {
             throw new Error("APP_ID is not set");
@@ -185,13 +185,21 @@ export class AgoraRTM extends IServiceTextChat {
         token,
         roomUUID,
         ownerUUID,
+        agoraAppId,
     }: IServiceTextChatJoinRoomConfig): Promise<void> {
         this.token = token || (await generateRTMToken());
 
         if (!this.token) {
             throw new Error("Missing Agora RTM token");
         }
 
+        if (agoraAppId && agoraAppId !== this.APP_ID) {
+            this.APP_ID = agoraAppId;
+            this.client = RtmEngine.createInstance(this.APP_ID, {
+                logFilter: RtmEngine.LOG_FILTER_WARNING,
+            });
+        }
+
         this._roomSideEffect.add(() => {
             const handler = async (): Promise<void> => {
                 this.token = await generateRTMToken();

service-providers/agora-rtm2/src/rtm2.ts

@@ -28,7 +28,7 @@ export class AgoraRTM2 extends IServiceTextChat {
     private userUUID?: string;
     private token?: string;
 
-    public constructor(private readonly APP_ID: string) {
+    public constructor(public APP_ID: string) {
         super();
         if (!APP_ID) {
             throw new Error("APP_ID is not set");
@@ -162,13 +162,18 @@ export class AgoraRTM2 extends IServiceTextChat {
         token,
         roomUUID,
         ownerUUID,
+        agoraAppId,
     }: IServiceTextChatJoinRoomConfig): Promise<void> {
         this.token = token || (await generateRTMToken());
 
         if (!this.token) {
             throw new Error("Missing Agora RTM token");
         }
 
+        if (agoraAppId && agoraAppId !== this.APP_ID) {
+            this.APP_ID = agoraAppId;
+        }
+
         const client = (this.client = new RTM(this.APP_ID, uid, {
             logLevel: "warn",
             logUpload: !process.env.DEV,