fcr-core/lib-es/engine/index.js

Core APIs for building online scenes

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, _createMainRoomControlDecs, _createWaitingRoomControlDecs, _createRoomRouterDecs, _createRoomControlAndJoinDecs, _sendPeerMessageDecs, _setParametersDecs;
import "core-js/modules/es.array.push.js";
import "core-js/modules/es.json.stringify.js";
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 { AgoraRteEngine, getSharedDomainHolder, retryAttempt, getPlatform, to, AgoraRtcRegion, AgoraRtmRegion, Mutex, trace, AgoraObservable } from '../imports';
import { FcrCoreServiceApi } from '../service/api';
import { FcrMonitorControlImpl } from '../monitor-control';
import { FcrUserRoleToStringMap } from '../type';
import { FcrDesktopMediaControlImpl } from '../media-control/desktop';
import { FcrPeerSessionControlImpl } from '../peer-session';
import { getCoreIpList, getEasemobChatIpList, getEasemobRestIpList, isEndpointRegionDisabled, getRtcPresetParameters } from '../utilities/parameters';
import { getVersion } from '../imports';
import { FcrErrorModuleCode, FcrError, handleRequestError, ERROR_CODES_NOT_RETRYABLE_WHEN_JOINING_ROOM } from '../utilities/error';
import { CMD_PEER_MESSAGE } from '../utilities/cmd';
import { FcrRoomType } from '../room-control/type';
import { FcrChatConnectionImpl } from '../chat-connection';
import { FcrMainRoomControlImpl } from '../room-control/mainroom-control';
import { FcrWaitingRoomControlImpl } from '../room-control/waitingroom-control';
import { FcrConnectionState } from '..';
import { resetSharedDomainHolder } from 'agora-rte-sdk/lib/core/services/domain-holder';
import { AgoraRestfulClientImpl } from 'agora-rte-sdk';
import { convertStreamTypeToPublishState } from 'agora-rte-sdk/lib/core/scene/helper';
import { FcrMobileMediaControlImpl } from '../media-control/mobile';
import { FcrChatRoomControlImpl } from '../plugins/chatroom';
import { createLogger, generateLogObserver } from '../utilities/logger';
import validateParams from '../utilities/validate-params';
import { booleanSchema, fcrRoomJoinOptionsSchema, stringKeyUnknownValueSchema, stringSchema } from '../schema';
import { AgoraRteError } from 'agora-rte-sdk/lib/core/utilities/error';
import { FcrRoomRouterImpl } from '../room-router';
import { FcrSharedCache } from '../room-control/shared-cache';
import { getDependenciesInfo } from '../utilities/package-info';
export class FcrCoreEngine {
  static {
    [_initProto] = _applyDecs(this, [[trace, 2, "release"], [trace, 2, "login"], [trace, 2, "logout"], [trace, 2, "renewUserToken"], [trace, 2, "getVersion"], [_createMainRoomControlDecs, 2, "createMainRoomControl"], [_createWaitingRoomControlDecs, 2, "createWaitingRoomControl"], [_createRoomRouterDecs, 2, "createRoomRouter"], [_createRoomControlAndJoinDecs, 2, "createRoomControlAndJoin"], [trace, 2, "getDesktopMediaControl"], [trace, 2, "getMobileMediaControl"], [trace, 2, "getMonitorControl"], [trace, 2, "getPeerSessionControl"], [_sendPeerMessageDecs, 2, "sendPeerMessage"], [_setParametersDecs, 2, "setParameters"]], []).e;
  }
  // @internal
  [(_createMainRoomControlDecs = [trace, validateParams(stringSchema)], _createWaitingRoomControlDecs = [trace, validateParams(stringSchema)], _createRoomRouterDecs = [trace, validateParams(stringSchema)], _createRoomControlAndJoinDecs = [trace, validateParams(stringSchema, fcrRoomJoinOptionsSchema)], _sendPeerMessageDecs = [trace, validateParams(stringKeyUnknownValueSchema, booleanSchema, stringSchema)], _setParametersDecs = [trace, validateParams(stringKeyUnknownValueSchema)], "logger")] = (_initProto(this), createLogger({
    prefix: 'FcrCoreEngine'
  }));
  // @internal

  // @internal

  // @internal

  // @internal

  // @internal

  // @internal

  // @internal

  // @internal

  // @internal

  // @internal
  _isLoggingIn = false;
  // @internal
  _sharedCache = new FcrSharedCache();
  // @internal
  _lock = new Mutex();
  // @internal
  _observable = new AgoraObservable();
  constructor(config) {
    this._config = config;
    resetSharedDomainHolder();
    this.logger.info('Fcr core engine is created, version: ', this.getVersion());
    const parameters = this._presetParameters(config.parameters);
    this._rteEngine = new AgoraRteEngine({
      appId: config.appId,
      userId: config.userId,
      userToken: config.token,
      rteRegion: config.region,
      rtcRegion: AgoraRtcRegion.AREA_GLOBAL,
      rtmRegion: AgoraRtmRegion.AREA_GLOBAL,
      audioConfig: {
        profile: 'default',
        scenario: 'meeting'
      },
      dualCameraVideoStreamConfig: config.dualCameraVideoStreamConfig,
      dualScreenVideoStreamConfig: config.dualScreenVideoStreamConfig,
      parameters: parameters
    });
    this._restfulClient = new AgoraRestfulClientImpl(this._rteEngine.getHttpAuthHeadersProvider(), getSharedDomainHolder(config.region), this._rteEngine.getRequestScheduler());
    this._apiService = new FcrCoreServiceApi(this._restfulClient, config.appId, config.region, !isEndpointRegionDisabled(config.parameters));

    // cannot be lazy loaded, because all the observers should be added before the engine is started
    this._peerSessionControl = new FcrPeerSessionControlImpl(this._rteEngine, this._apiService, this._config.userId);
    this._chatConnection = this._createChatConnection(config.parameters);
    this._monitorControl = new FcrMonitorControlImpl(this._rteEngine, this._config);
    this._desktopMediaControl = new FcrDesktopMediaControlImpl(this._rteEngine.getMediaControl());
    this._mobileMediaControl = new FcrMobileMediaControlImpl(this._rteEngine.getMediaControl());
    this._addLogObserver();
    this._addRteEngineObserver();
    this._setupCoreIpList(config.parameters);
    this._setupChatConnection(config.parameters);
  }

  /**
   * Releases the engine and all its resources.
   */
  release() {
    this._rteEngine.release();
  }

  /**
   * Logins to the RTE service.
   */
  async login() {
    await this._lock.dispatch(async () => {
      if (this._isLoggingIn) {
        return;
      }
      try {
        this._isLoggingIn = true;
        this._chatConnection.login();
        await this._rteEngine.login();
      } finally {
        this._isLoggingIn = false;
        this._rteEngine.getMonitor().uploadLog({
          userUuid: this._config.userId
        });
      }
    });
  }

  /**
   * Logouts from the RTE service.
   */
  async logout() {
    await this._lock.dispatch(async () => {
      this._isLoggingIn = false;
      this._chatConnection.logout();
      await this._rteEngine.logout();
    });
  }
  /**
   * Renews the user token.
   * @param token
   */
  renewUserToken(token) {
    this._rteEngine.renewUserToken(token);
  }

  /**
   * Gets the version of the SDK.
   * @returns The version of the SDK.
   */
  getVersion() {
    return getVersion();
  }
  getDependencyVersions() {
    return {
      ...this._rteEngine.getDependencyVersions(),
      rte: this._rteEngine.getVersion(),
      whiteboard: getDependenciesInfo('@netless/forge-whiteboard'),
      easemob: getDependenciesInfo('easemob-websdk')
    };
  }

  /**
   * Creates a room control.
   * @param roomId
   * @returns The room control.
   */
  createMainRoomControl(roomId) {
    const scene = this._rteEngine.createScene({
      sceneId: roomId
    });
    return new FcrMainRoomControlImpl(this._rteEngine, scene, this._apiService, this._config, this._sharedCache, this._chatConnection, new FcrChatRoomControlImpl(scene, this._chatConnection, this._sharedCache, false));
  }

  /**
   * Creates a waiting room control.
   * @param roomId
   * @returns The room control.
   */
  createWaitingRoomControl(roomId) {
    const scene = this._rteEngine.createScene({
      sceneId: roomId
    });
    return new FcrWaitingRoomControlImpl(this._rteEngine, scene, this._apiService, this._config, this._sharedCache, this._chatConnection, new FcrChatRoomControlImpl(scene, this._chatConnection, this._sharedCache, false));
  }

  /**
   * Creates room router.
   * @param roomId
   * @returns The room router.
   */
  createRoomRouter(roomId) {
    const roomRouter = new FcrRoomRouterImpl(this._rteEngine, this._apiService, this._config, this._chatConnection, this._sharedCache, roomId);
    return roomRouter;
  }

  /**
   * Creates a main room control or a waiting room control.
   * @param roomId
   * @returns The room control.
   */
  async createRoomControlAndJoin(roomId, options) {
    const {
      userId
    } = this._rteEngine.getConfig();
    let roomControl = null;
    let [error] = await to(retryAttempt(async () => {
      const res = await handleRequestError(() => this._apiService.checkIn({
        userName: options.userName,
        userId,
        userRole: FcrUserRoleToStringMap[options.userRole],
        userProperties: options.userProperties,
        roomId,
        platform: getPlatform(),
        streams: options.createStreamConfigs?.map(s => ({
          videoSourceUuid: s.videoSourceId,
          audioSourceUuid: s.audioSourceId,
          streamName: s.streamName,
          ...convertStreamTypeToPublishState(s.streamType),
          videoSourceType: s.videoSourceType,
          audioSourceType: s.audioSourceType,
          audioSourceState: s.audioSourceState,
          videoSourceState: s.videoSourceState
        })),
        version: getVersion(),
        password: options.password,
        avatar: options.avatar
      }), FcrErrorModuleCode.ENGINE);
      const {
        data,
        ts
      } = res;
      if (data.room.roomProperties.roomType === FcrRoomType.Waitingroom) {
        roomControl = this.createWaitingRoomControl(data.room.roomInfo.roomUuid);
      } else {
        roomControl = this.createMainRoomControl(roomId);
      }
      await roomControl.join({
        ...options,
        snapshot: data,
        timestamp: ts,
        createStreamConfigs: data.room.roomProperties.roomType === FcrRoomType.Waitingroom ? [] : options.createStreamConfigs
      });
    }, [], {
      retriesMax: 10
    }).fail(async ({
      error,
      timeFn,
      currentRetry
    }) => {
      if ((error instanceof AgoraRteError || error instanceof FcrError) && ERROR_CODES_NOT_RETRYABLE_WHEN_JOINING_ROOM.includes(error.code)) {
        throw error;
      }
      this.logger.error(`retry to join room, ${error.message}, retry ${currentRetry} times`);
      await timeFn();
      return true;
    }).exec());
    if (error) {
      this.logger.error(`join room failed, ${error.message}-${JSON.stringify(error)}`);
      throw error;
    }
    return roomControl;
  }

  /**
   * Gets the media control.
   * @returns The media control.
   */
  getDesktopMediaControl() {
    return this._desktopMediaControl;
  }

  /**
   * Gets the mobile media control.
   * @returns The mobile media control.
   */
  getMobileMediaControl() {
    return this._mobileMediaControl;
  }

  /**
   * Gets the monitor control.
   * @returns The monitor control.
   */
  getMonitorControl() {
    return this._monitorControl;
  }

  /**
   * Gets the peer session control.
   * @returns The peer session control.
   */
  getPeerSessionControl() {
    return this._peerSessionControl;
  }

  /**
   * Sends a peer message.
   * @param payload
   * @param guaranteedDelivery
   * @param receiverId
   */
  async sendPeerMessage(payload, guaranteedDelivery, receiverId) {
    await this._rteEngine.sendPeerMessage(payload, `${CMD_PEER_MESSAGE}`, guaranteedDelivery, receiverId);
  }

  /**
   * Sets the parameters.
   * @param parameters
   */
  setParameters(parameters) {
    try {
      this._setupCoreIpList(parameters);
      this._setupChatConnection(parameters);
      const {
        rte,
        rtc,
        rtm
      } = parameters;
      this._rteEngine.setParameters({
        rtc,
        rtm,
        rte
      });
    } catch (e) {
      this.logger.warn('setParameters failed', e);
    }
  }

  /**
   * Adds an observer.
   * @param observer
   */
  addObserver(observer) {
    this._rteEngine.addObserver(observer);
  }

  /**
   * Removes an observer.
   * @param observer
   */
  removeObserver(observer) {
    this._rteEngine.removeObserver(observer);
  }
  _addRteEngineObserver() {
    this._rteEngine.addObserver({
      onConnectionStateUpdated: state => {
        if (state === FcrConnectionState.ABORTED) {
          this.logout();
        }
      },
      onUserTokenWillExpire: () => {
        this._observable.notifyObservers('onUserTokenWillExpire');
      }
    });
  }
  _addLogObserver() {
    this.addObserver(generateLogObserver(this.logger, ['onConnectionStateUpdated', 'onPeerMessageReceived', 'onUserTokenWillExpire']));
  }
  _setupCoreIpList(parameters) {
    const coreIpList = getCoreIpList(parameters);
    if (coreIpList) {
      this.logger.info(`setup fixed service domain list: ${JSON.stringify(coreIpList)}`);
      resetSharedDomainHolder();
      getSharedDomainHolder(this._config.region).setFixedDomainList(coreIpList);
      this._restfulClient = new AgoraRestfulClientImpl(this._rteEngine.getHttpAuthHeadersProvider(), getSharedDomainHolder(this._config.region), this._rteEngine.getRequestScheduler());
      this._apiService.setRestfulClient(this._restfulClient);
    }
  }
  _setupChatConnection(parameters) {
    const chatIpList = getEasemobChatIpList(parameters);
    const restIpList = getEasemobRestIpList(parameters);
    if (chatIpList && restIpList) {
      this.logger.info(`setup chat ip list: ${JSON.stringify(chatIpList)}, rest ip list: ${JSON.stringify(restIpList)}`);
      this._chatConnection = this._createChatConnection(parameters);
    }
  }
  _createChatConnection(parameters) {
    const chatIpList = getEasemobChatIpList(parameters);
    const restIpList = getEasemobRestIpList(parameters);
    return new FcrChatConnectionImpl(this._config.userId, this._apiService, chatIpList, restIpList);
  }
  _presetParameters(parameters) {
    if (!parameters) {
      parameters = {
        rtc: getRtcPresetParameters()
      };
    } else if (!parameters.rtc) {
      parameters.rtc = getRtcPresetParameters();
    } else {
      parameters.rtc = this._mergeRtcPresetParameters(parameters.rtc);
    }
    return parameters;
  }
  _mergeRtcPresetParameters(parametersList) {
    const rtcPresetParameters = getRtcPresetParameters();
    parametersList.push(...rtcPresetParameters);
    return parametersList;
  }
}