fcr-core 3.8.2 → 3.9.0-alpha

package/lib-es/plugins/chat/chatroom.js

@@ -0,0 +1,409 @@
+import "core-js/modules/es.array.push.js";
+import "core-js/modules/esnext.function.metadata.js";
+import "core-js/modules/esnext.map.delete-all.js";
+import "core-js/modules/esnext.map.emplace.js";
+import "core-js/modules/esnext.map.every.js";
+import "core-js/modules/esnext.map.filter.js";
+import "core-js/modules/esnext.map.find.js";
+import "core-js/modules/esnext.map.find-key.js";
+import "core-js/modules/esnext.map.includes.js";
+import "core-js/modules/esnext.map.key-of.js";
+import "core-js/modules/esnext.map.map-keys.js";
+import "core-js/modules/esnext.map.map-values.js";
+import "core-js/modules/esnext.map.merge.js";
+import "core-js/modules/esnext.map.reduce.js";
+import "core-js/modules/esnext.map.some.js";
+import "core-js/modules/esnext.map.update.js";
+import "core-js/modules/esnext.symbol.metadata.js";
+let _initProto, _sendMessageDecs, _addObserverDecs, _removeObserverDecs;
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.map.js";
+function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function (e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O.static = l, O.private = f, f ? 2 === o ? k = function (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == typeof P && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol.for("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol.for("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function (t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.description) ? "[" + t + "]" : ""); try { Object.defineProperty(e, "name", { configurable: !0, value: n ? n + " " + t : t }); } catch (e) {} return e; }
+function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; }
+import { bound, trace } from 'agora-foundation/lib/decorator';
+import { timeout } from 'agora-foundation/lib/utilities/race-condition';
+import { AgoraObservable } from 'agora-foundation/lib/utilities/observable';
+import EasemobChatSDK from 'easemob-websdk';
+import get from 'lodash/get';
+import { FcrChatConnectionState } from '../../chat-connector/type';
+import { DetailErrorCode, ErrorModuleCode } from '../../imports';
+import { FcrChatRoomConnectionState, FcrChatRoomMessageType } from '../../room-control/chatroom-control/type';
+import { messageSchema, progressSchema } from '../../schema';
+import { FcrReturnCode } from '../../type';
+import { abortableRetry } from '../../utilities/abortable-retry';
+import { FcrErrorCode, FcrErrorModuleCode, generateFcrCoreClientError } from '../../utilities/error';
+import { createLogger, generateLogObserver } from '../../utilities/logger';
+import { convertRteUserToFcrUser } from '../../utilities/user';
+import validateParams from '../../utilities/validate-params';
+const CHATROOM_ID_KEY_PATH = 'widgets.easemobIM.extra.chatRoomId';
+
+/**
+ * @internal
+ */
+export class FcrChatRoomControlImpl {
+  static {
+    [_initProto] = _applyDecs(this, [[trace, 2, "getConnectionState"], [_sendMessageDecs, 2, "sendMessage"], [_addObserverDecs, 2, "addObserver"], [_removeObserverDecs, 2, "removeObserver"], [bound, 2, "_handleJoinSceneSuccess"], [bound, 2, "_handleJoinSceneFailure"], [trace, 2, "leave"], [trace, 2, "join"], [bound, 2, "_handleScenePropertiesUpdated"]], []).e;
+  }
+  [(_sendMessageDecs = [trace(['message', 'progress']), validateParams(messageSchema, progressSchema.optional())], _addObserverDecs = trace(['observer']), _removeObserverDecs = trace(['observer']), "logger")] = (_initProto(this), createLogger({
+    prefix: 'FcrChatRoomControlImpl'
+  }));
+  _observable = new AgoraObservable();
+  _connectionState = FcrChatRoomConnectionState.Disconnected;
+  _joinPromise = null;
+  _joinTimeoutMs = 30000;
+  _joinAttemptId = 0;
+  _abortJoinChatRoom = null;
+  _sceneObserver = {
+    onJoinSceneSuccess: this._handleJoinSceneSuccess,
+    onJoinSceneFailure: this._handleJoinSceneFailure,
+    onScenePropertiesUpdated: this._handleScenePropertiesUpdated
+  };
+  chatRoomConnectionHandler = {
+    onTextMessage: msg => {
+      if (msg.to !== this.chatRoomId) {
+        return;
+      }
+      const message = this._convertAgoraChatMessageToFcrChatRoomReceiveMessage(msg);
+      this._observable.notifyObservers('onTextMessageReceived', this._scene.sceneId, message);
+    }
+  };
+  _chatConnectionObserver = {
+    onConnectionStateUpdated: async connectorState => {
+      const chatRoomConnectionState = this.getConnectionState();
+      if (connectorState === FcrChatConnectionState.DISCONNECTED) {
+        this._setConnectionState(FcrChatRoomConnectionState.Disconnected);
+      } else if (connectorState === FcrChatConnectionState.CONNECTED && chatRoomConnectionState !== FcrChatRoomConnectionState.Connected) {
+        this.logger.info('chat connector connected, try to join chat room');
+        this._tryJoinChatRoom();
+      } else if (connectorState === FcrChatConnectionState.CONNECTED) {
+        this.logger.info('chat connector reconnected, try to rejoin chat room');
+        this._tryJoinChatRoom(true);
+      }
+    }
+  };
+  get conn() {
+    if (!this._chatConnection.getConnectionInstance()) {
+      throw generateFcrCoreClientError(ErrorModuleCode.FCR_ROOM_CHATROOM, DetailErrorCode.UNDEFINED_ERROR, 'chat room connection not initialized, please get chat room token first');
+    }
+    return this._chatConnection.getConnectionInstance();
+  }
+  get chatRoomId() {
+    if (!this._joinSceneSuccess) {
+      return '';
+    }
+    return this._scene.getScenePropertiesByKeyPath(CHATROOM_ID_KEY_PATH);
+  }
+  get connectionEventHandlerKey() {
+    return `chatroom${this._scene.sceneId}`;
+  }
+  constructor(_scene, _chatConnection, sharedCache, joinSceneSuccess) {
+    this._scene = _scene;
+    this._chatConnection = _chatConnection;
+    this._roomCache = sharedCache.getRoomCache(_scene.sceneId);
+    this._joinSceneSuccess = joinSceneSuccess;
+    this._addLogObserver();
+    this._scene.addObserver(this._sceneObserver);
+    if (this._chatConnection.getConnectionInstance() && this._chatConnection.getConnectionState() === FcrChatConnectionState.CONNECTED) {
+      this.logger.info('chat connection already connected, try to join chat room');
+      this._tryJoinChatRoom();
+    }
+  }
+  getConnectionState() {
+    return this._connectionState;
+  }
+  async sendMessage(message, progress) {
+    const msg = this._convertFcrChatRoomSendBaseMessageToAgoraChatMessage(message, progress);
+    const sendMsgRes = await this.conn.send(msg);
+    const localUserInfo = this._scene.getUser(this._scene.getLocalUser().getLocalUserId());
+    const res = {
+      ...(message.type === FcrChatRoomMessageType.Text ? {
+        content: message.content
+      } :
+      // @ts-ignore
+      {
+        url: sendMsgRes.message.url
+      }),
+      from: convertRteUserToFcrUser(localUserInfo, this._roomCache),
+      id: sendMsgRes.serverMsgId,
+      type: message.type,
+      properties: message.properties,
+      timestamp: Date.now(),
+      isPrivate: !!message.to?.length
+    };
+    return res;
+  }
+  addObserver(observer) {
+    this._observable.addObserver(observer);
+    return FcrReturnCode.SUCCESS;
+  }
+  removeObserver(observer) {
+    this._observable.removeObserver(observer);
+    return FcrReturnCode.SUCCESS;
+  }
+  _setConnectionState(state) {
+    if (this._connectionState === state) {
+      return;
+    }
+    this._connectionState = state;
+    this._observable.notifyObservers('onConnectionStateUpdated', this._scene.sceneId, state);
+  }
+  _tryJoinChatRoom(force = false) {
+    if (this._chatConnection.getConnectionState() !== FcrChatConnectionState.CONNECTED) {
+      return;
+    }
+    if (!this.chatRoomId) {
+      return;
+    }
+    if (this._joinPromise) {
+      return;
+    }
+    if (!force && (this._connectionState === FcrChatRoomConnectionState.Connected || this._connectionState === FcrChatRoomConnectionState.Connecting)) {
+      return;
+    }
+    this.join(force);
+  }
+  _addLogObserver() {
+    this.addObserver(generateLogObserver(this.logger, [['onConnectionStateUpdated', ['roomId', 'state']], ['onErrorOccurred', ['roomId', 'error']]
+    // 'onTextMessageReceived'
+    ]));
+  }
+  async getHistoryMessageList(pageSize, startedMessageId) {
+    if (pageSize > 50) {
+      throw generateFcrCoreClientError(ErrorModuleCode.FCR_ROOM_CHATROOM, DetailErrorCode.UNDEFINED_ERROR, 'pageSize should be less than 50');
+    }
+    try {
+      const assembleRet = await this.conn.fetchHistoryMessages({
+        queue: this.chatRoomId,
+        count: pageSize,
+        start: startedMessageId,
+        isGroup: true
+      });
+      return assembleRet.map(msgBody => this._convertAgoraChatHistoryMessageToFcrChatRoomReceiveMessage(msgBody));
+    } catch (error) {
+      throw generateFcrCoreClientError(FcrErrorModuleCode.FCR_ROOM_CHATROOM, FcrErrorCode.UNDEFINED_ERROR, error.message);
+    }
+  }
+  _handleJoinSceneSuccess() {
+    this._joinSceneSuccess = true;
+    this._tryJoinChatRoom();
+  }
+  _handleJoinSceneFailure() {
+    this._joinSceneSuccess = false;
+  }
+  leave() {
+    this._chatConnection.removeObserver(this._chatConnectionObserver);
+    if (this._connectionState === FcrChatRoomConnectionState.Disconnected && !this._abortJoinChatRoom) {
+      return;
+    }
+    if (this._abortJoinChatRoom) {
+      this._abortJoinChatRoom();
+      this._abortJoinChatRoom = null;
+      this._joinPromise = null;
+    }
+    if (!this._chatConnection.getConnectionInstance()) {
+      this._setConnectionState(FcrChatRoomConnectionState.Disconnected);
+      return;
+    }
+    this._removeEventListener();
+    if (this.chatRoomId) {
+      this.conn.leaveChatRoom({
+        roomId: this.chatRoomId,
+        success: () => {
+          this.logger.info(`leave chat room success, room id: ${this.chatRoomId}, scene id: ${this._scene.sceneId}`);
+        },
+        error: e => {
+          this.logger.error('leave chat room failed', e.message);
+        }
+      });
+    }
+    this._setConnectionState(FcrChatRoomConnectionState.Disconnected);
+  }
+  async join(force = false) {
+    this._chatConnection.addObserver(this._chatConnectionObserver);
+    const connectorState = this._chatConnection.getConnectionState();
+    if (connectorState !== FcrChatConnectionState.CONNECTED) {
+      return FcrReturnCode.SUCCESS;
+    }
+    if (!this.chatRoomId) {
+      this.logger.warn(`chat room id is empty, scene id: ${this._scene.sceneId}`);
+      return FcrReturnCode.SUCCESS;
+    }
+    if (!this._chatConnection.getConnectionInstance()) {
+      this.logger.warn(`chat connection instance is null, scene id: ${this._scene.sceneId}`);
+      return FcrReturnCode.SUCCESS;
+    }
+    const chatRoomId = this.chatRoomId;
+    if (this._joinPromise) {
+      return this._joinPromise;
+    }
+    const chatRoomConnectionState = this.getConnectionState();
+    if (!force && (chatRoomConnectionState === FcrChatRoomConnectionState.Connected || chatRoomConnectionState === FcrChatRoomConnectionState.Connecting)) {
+      return FcrReturnCode.SUCCESS;
+    }
+    if (force || chatRoomConnectionState === FcrChatRoomConnectionState.Disconnected) {
+      if (chatRoomConnectionState !== FcrChatRoomConnectionState.Connecting) {
+        this._setConnectionState(FcrChatRoomConnectionState.Connecting);
+      }
+      this.logger.info(`start join chat room, room id: ${chatRoomId}, scene id: ${this._scene.sceneId}`);
+      this._addEventListener();
+      const attemptId = ++this._joinAttemptId;
+      this._joinPromise = (async () => {
+        let error = null;
+        if (force && chatRoomConnectionState === FcrChatRoomConnectionState.Connected) {
+          await this._leaveChatRoomForRejoin(chatRoomId);
+        }
+        const [abort, promise] = abortableRetry(async () => {
+          await this.conn.joinChatRoom({
+            roomId: chatRoomId
+          });
+          this.logger.info(`join chat room success, room id: ${chatRoomId}, scene id: ${this._scene.sceneId}`);
+        }, {
+          retriesMax: Infinity
+        });
+        this._abortJoinChatRoom = abort;
+        try {
+          [error] = await timeout(promise, this._joinTimeoutMs);
+        } catch (joinError) {
+          if (attemptId !== this._joinAttemptId) {
+            return FcrReturnCode.SUCCESS;
+          }
+          if (this._abortJoinChatRoom) {
+            this._abortJoinChatRoom();
+            this._abortJoinChatRoom = null;
+          }
+          this.leave();
+          throw joinError;
+        }
+        this._abortJoinChatRoom = null;
+        if (attemptId !== this._joinAttemptId) {
+          if (!error && this._chatConnection.getConnectionInstance()) {
+            this.conn.leaveChatRoom({
+              roomId: chatRoomId,
+              success: () => {
+                this.logger.info(`leave stale chat room success, room id: ${chatRoomId}, scene id: ${this._scene.sceneId}`);
+              },
+              error: leaveError => {
+                this.logger.error('leave stale chat room failed', leaveError.message);
+              }
+            });
+          }
+          return FcrReturnCode.SUCCESS;
+        }
+        if (error) {
+          this.logger.error(`join chat room failed, room id: ${chatRoomId}, scene id: ${this._scene.sceneId}`, error.message);
+          this._setConnectionState(FcrChatRoomConnectionState.Disconnected);
+          throw generateFcrCoreClientError(FcrErrorModuleCode.FCR_ROOM_CHATROOM, FcrErrorCode.UNDEFINED_ERROR, `join chat room failed: ${error.message}`);
+        } else {
+          this._setConnectionState(FcrChatRoomConnectionState.Connected);
+        }
+        return FcrReturnCode.SUCCESS;
+      })();
+      try {
+        return await this._joinPromise;
+      } finally {
+        this._joinPromise = null;
+      }
+    }
+    return FcrReturnCode.SUCCESS;
+  }
+  _leaveChatRoomForRejoin(chatRoomId) {
+    return new Promise(resolve => {
+      if (!this._chatConnection.getConnectionInstance()) {
+        resolve();
+        return;
+      }
+      this.conn.leaveChatRoom({
+        roomId: chatRoomId,
+        success: () => resolve(),
+        error: () => resolve()
+      });
+    });
+  }
+  _removeEventListener() {
+    const connection = this._chatConnection.getConnectionInstance();
+    if (connection) {
+      this.conn.removeEventHandler(this.connectionEventHandlerKey);
+    }
+  }
+  _addEventListener() {
+    this._removeEventListener();
+    this.conn.addEventHandler(this.connectionEventHandlerKey, this.chatRoomConnectionHandler);
+  }
+  _convertAgoraChatMessageToFcrChatRoomReceiveMessage = msg => {
+    switch (msg.type) {
+      case 'txt':
+        {
+          const message = {
+            id: msg.id,
+            from: msg.ext?.sender,
+            type: FcrChatRoomMessageType.Text,
+            timestamp: parseInt(`${msg.time}`),
+            content: msg.msg,
+            isPrivate: msg.ext?.isPrivate,
+            properties: msg.ext?.properties
+          };
+          return message;
+        }
+    }
+    throw generateFcrCoreClientError(FcrErrorModuleCode.FCR_ROOM_CHATROOM, FcrErrorCode.UNDEFINED_ERROR, 'unknown remote message type');
+  };
+  _convertAgoraChatHistoryMessageToFcrChatRoomReceiveMessage(msg) {
+    //@ts-ignore
+    switch (msg.contentsType) {
+      case 'TEXT':
+        {
+          const message = {
+            id: msg.id,
+            //@ts-ignore
+            from: msg.ext?.sender,
+            type: FcrChatRoomMessageType.Text,
+            //@ts-ignore
+            timestamp: parseInt(`${msg.time}`),
+            //@ts-ignore
+            content: msg.data,
+            //@ts-ignore
+            isPrivate: msg.ext?.isPrivate,
+            //@ts-ignore
+            properties: msg.ext?.properties
+          };
+          return message;
+        }
+    }
+    throw generateFcrCoreClientError(FcrErrorModuleCode.FCR_ROOM_CHATROOM, FcrErrorCode.UNDEFINED_ERROR, 'unknown remote message type');
+  }
+  _convertFcrChatRoomSendBaseMessageToAgoraChatMessage(msg, progress) {
+    switch (msg.type) {
+      case FcrChatRoomMessageType.Text:
+        {
+          const message = msg;
+          const isPrivate = !!message.to?.length;
+          const localUserId = this._scene.getLocalUser().getLocalUserId();
+          const localUserInfo = this._scene.getUser(localUserId);
+          return EasemobChatSDK.message.create({
+            to: this.chatRoomId,
+            msg: message.content,
+            type: 'txt',
+            chatType: 'chatRoom',
+            ext: {
+              sender: convertRteUserToFcrUser(localUserInfo, this._roomCache),
+              roomUuid: this._scene.sceneId,
+              isPrivate,
+              properties: msg.properties
+            },
+            receiverList: message.to
+          });
+        }
+    }
+    throw generateFcrCoreClientError(FcrErrorModuleCode.FCR_ROOM_CHATROOM, FcrErrorCode.UNDEFINED_ERROR, 'unknown local message type');
+  }
+  _handleScenePropertiesUpdated(sceneId, properties) {
+    const chatRoomId = get(properties.changedProperties, CHATROOM_ID_KEY_PATH);
+    if (chatRoomId) {
+      this.logger.info(`received chat room id change, chat room id: ${chatRoomId}, scene id: ${sceneId}`);
+      this.join();
+    }
+  }
+}

package/lib-es/{chat-connection → plugins/chat}/config.js

@@ -95,6 +95,7 @@ const agoraChatConfig = {
    * enable localstorage for history messages. For use in this demo
    */
   enableLocalStorage: true,
-  deviceId: 'webim'
+  deviceId: 'webim',
+  isFixedDeviceId: false
 };
 export { agoraChatConfig };