agora-foundation 3.3.0 → 3.4.0

package/lib/decorator/log/index.js

@@ -18,13 +18,17 @@ var _trace = function _trace(originalMethod, context) {
   var methodName = String(context.name);
   if (context.kind === 'method') {
     context.addInitializer(function () {
-      var handler = (0, _handler.createLogHandler)((0, _logger.getLogger)('default'));
+      var handler = (0, _handler.createLogHandler)((0, _logger.getLogger)({
+        label: 'default'
+      }));
       this[context.name] = (0, _proxy.proxyMethod)(this[context.name], this, methodName, handler);
     });
   }
 };
 _trace.to = function (label) {
-  var logger = (0, _logger.getLogger)(label);
+  var logger = (0, _logger.getLogger)({
+    label: label
+  });
   return function (originalMethod, context) {
     var methodName = String(context.name);
     if (context.kind === 'method') {

package/lib/logger/index.d.ts

@@ -1,8 +1,14 @@
-import { LogLevel, Logger, LogManager } from "./type";
-export declare const getLogger: (label?: string) => Logger;
+import { LogLevel, Logger, LogManager } from './type';
+export declare const getLogger: (opts?: {
+    label?: string;
+}) => Logger;
+export declare const createLogger: (opts?: {
+    label?: string;
+    prefix?: string;
+}) => Logger;
 export declare const getLogManager: () => LogManager;
 export declare const setLogLevel: (_logLevel: LogLevel) => void;
-export { LogLevel } from "./type";
-export type { LogManager, Logger } from "./type";
-export { restoreConsoleHijack, setupConsoleHijack } from "./hijack";
-export { logLevelMap } from "./constants";
+export { LogLevel } from './type';
+export type { LogManager, Logger } from './type';
+export { restoreConsoleHijack, setupConsoleHijack } from './hijack';
+export { logLevelMap } from './constants';

package/lib/logger/index.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "LogLevel", {
     return _type.LogLevel;
   }
 });
-exports.getLogger = exports.getLogManager = void 0;
+exports.getLogger = exports.getLogManager = exports.createLogger = void 0;
 Object.defineProperty(exports, "logLevelMap", {
   enumerable: true,
   get: function get() {
@@ -63,15 +63,24 @@ var _constants = require("./constants");
 var loggerRegistrar = new Map();
 var logLevel = _type.LogLevel.DEBUG;
 var getLogger = exports.getLogger = function getLogger() {
-  var label = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "default";
+  var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var label = opts.label || 'default';
   if (!loggerRegistrar.has(label)) {
-    loggerRegistrar.set(label, new _loggerImpl.LoggerImpl(label, {
+    loggerRegistrar.set(label, new _loggerImpl.LoggerImpl(label, {}, {
       console: true,
       database: true
     }, logLevel, (0, _worker.getWorkerSingleton)()));
   }
   return loggerRegistrar.get(label);
 };
+var createLogger = exports.createLogger = function createLogger() {
+  var opts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var label = opts.label || 'default';
+  return new _loggerImpl.LoggerImpl(label, opts, {
+    console: true,
+    database: true
+  }, logLevel, (0, _worker.getWorkerSingleton)());
+};
 var logManager;
 var getLogManager = exports.getLogManager = function getLogManager() {
   if (!logManager) {

package/lib/logger/logger-impl.d.ts

@@ -1,10 +1,13 @@
 import { LogLevel, Logger, LogWorkerInteractor } from './type';
 export declare class LoggerImpl implements Logger {
     private _label;
+    private _opts;
     private _dest;
     private _logLevel;
     private _logWorkerInteractor;
-    constructor(_label: string, _dest: {
+    constructor(_label: string, _opts: {
+        prefix?: string;
+    }, _dest: {
         console: boolean;
         database: boolean;
     }, _logLevel: LogLevel, _logWorkerInteractor: LogWorkerInteractor);

package/lib/logger/logger-impl.js

@@ -19,9 +19,10 @@ var _type = require("./type");
 var _hijack = require("./hijack");
 var _padEnd = _interopRequireDefault(require("lodash/padEnd"));
 var LoggerImpl = exports.LoggerImpl = /*#__PURE__*/function () {
-  function LoggerImpl(_label, _dest, _logLevel, _logWorkerInteractor) {
+  function LoggerImpl(_label, _opts, _dest, _logLevel, _logWorkerInteractor) {
     (0, _classCallCheck2["default"])(this, LoggerImpl);
     this._label = _label;
+    this._opts = _opts;
     this._dest = _dest;
     this._logLevel = _logLevel;
     this._logWorkerInteractor = _logWorkerInteractor;
@@ -69,10 +70,15 @@ var LoggerImpl = exports.LoggerImpl = /*#__PURE__*/function () {
       if (logLevel > this._logLevel) {
         return;
       }
-      // prepend log level to second position of the log message
+
+      // prepend prefix to the log message if it exists
       for (var _len5 = arguments.length, args = new Array(_len5 > 1 ? _len5 - 1 : 0), _key5 = 1; _key5 < _len5; _key5++) {
         args[_key5 - 1] = arguments[_key5];
       }
+      if (this._opts.prefix) {
+        args.unshift("[".concat(this._opts.prefix, "]"));
+      }
+      // prepend log level to second position of the log message
       args.unshift((0, _padEnd["default"])((0, _upperCase["default"])(_constants.logLevelMap[logLevel] || 'unknown'), 5, ' '));
       // prepend log level to first position of the log message
       args.unshift((0, _dayjs["default"])().format('YYYY-MM-DD HH:mm:ss'));

package/lib/utilities/observable.d.ts

@@ -7,5 +7,6 @@ export declare class AgoraObservable<T> {
     removeObserver(observer: T): void;
     notifyObservers<K extends keyof T>(eventName: K, ...args: EventParameters<T[K]>): void;
     countOfObservers(): number;
+    removeAllObservers(): void;
 }
 export {};

package/lib/utilities/observable.js

@@ -95,5 +95,11 @@ var AgoraObservable = exports.AgoraObservable = /*#__PURE__*/function () {
     value: function countOfObservers() {
       return this._observers;
     }
+  }, {
+    key: "removeAllObservers",
+    value: function removeAllObservers() {
+      this._observers = 0;
+      this._observerSet.clear();
+    }
   }]);
 }();

package/lib/utilities/zip.js

@@ -136,7 +136,11 @@ var isFile = /*#__PURE__*/function () {
           return _context2.abrupt("return", new Promise(function (resolve, reject) {
             fs.stat(filePath, function (err, stats) {
               if (err) reject(err);
-              resolve(stats.isFile());
+              if (!stats) {
+                resolve(false);
+              } else {
+                resolve(stats.isFile());
+              }
             });
           }));
         case 2:

package/lib/worker/constants.d.ts

@@ -7,5 +7,6 @@ export declare enum WorkerDirectives {
     UNPERSIST_BUFFER = "unpersistBuffer",
     GET_BUFFER = "getBuffer",
     CLEAR_TEMP_LOGS = "clearTempLogs",
-    COLLECT_LOGS_ON_FS = "collectLogsOnFs"
+    COLLECT_LOGS_ON_FS = "collectLogsOnFs",
+    INIT_LOG_PATH = "initLogPath"
 }

package/lib/worker/constants.js

@@ -15,5 +15,6 @@ var WorkerDirectives = exports.WorkerDirectives = /*#__PURE__*/function (WorkerD
   WorkerDirectives["GET_BUFFER"] = "getBuffer";
   WorkerDirectives["CLEAR_TEMP_LOGS"] = "clearTempLogs";
   WorkerDirectives["COLLECT_LOGS_ON_FS"] = "collectLogsOnFs";
+  WorkerDirectives["INIT_LOG_PATH"] = "initLogPath";
   return WorkerDirectives;
 }({});

package/lib/worker/handler/log.d.ts

@@ -9,4 +9,6 @@ export declare const writeLog: (self: WorkerContext, callId: number, log: Log) =
 export declare const collectLogs: (self: WorkerContext, callId: number, labels: string[]) => Promise<void>;
 export declare const deleteLogs: (self: WorkerContext, callId: number, labels: string[], lastId: number) => Promise<void>;
 export declare const setMaxRecords: (self: WorkerContext, callId: number, max: number) => void;
+export declare const initLogPath: (logPath: string) => void;
+export declare const writingToDisk: (log: string) => void;
 export {};

package/lib/worker/handler/log.js

@@ -10,7 +10,6 @@ require("core-js/modules/es.array.is-array.js");
 require("core-js/modules/es.array.slice.js");
 require("core-js/modules/es.function.name.js");
 require("core-js/modules/es.object.define-property.js");
-require("core-js/modules/es.object.to-string.js");
 require("core-js/modules/es.regexp.exec.js");
 require("core-js/modules/es.regexp.test.js");
 require("core-js/modules/es.regexp.to-string.js");
@@ -18,15 +17,21 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.writeLog = exports.setMaxRecords = exports.deleteLogs = exports.collectLogs = void 0;
+exports.writingToDisk = exports.writeLog = exports.setMaxRecords = exports.initLogPath = exports.deleteLogs = exports.collectLogs = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.array.for-each.js");
 require("core-js/modules/es.array.iterator.js");
 require("core-js/modules/es.array.push.js");
 require("core-js/modules/es.array.reverse.js");
 require("core-js/modules/es.date.to-string.js");
+require("core-js/modules/es.object.to-string.js");
 require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/esnext.async-iterator.for-each.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/web.dom-collections.for-each.js");
 require("core-js/modules/web.dom-collections.iterator.js");
 var _debounce = _interopRequireDefault(require("lodash/debounce"));
 var _db = require("./db");
@@ -35,6 +40,7 @@ var _constants = require("../constants");
 var _reply = require("./reply");
 var _raceCondition = require("../../utilities/race-condition");
 var _jszip = _interopRequireDefault(require("jszip"));
+var _env = require("../../utilities/env");
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
@@ -42,12 +48,14 @@ var MAX_WAIT_TIME = 3000;
 var mutex = new _mutex.Mutex();
 var maxRecords = 50000;
 var logsCount = 0;
+var winstonLogger;
 var logs = [];
 var writeLog = exports.writeLog = function writeLog(self, callId, log) {
   logsCount++;
   log.content = "[".concat(logsCount, "]").concat(log.content);
   logs.push(log);
   debouncedWriting();
+
   // reply(self, callId, WorkerDirectives.WRITE_LOG, { isSuccess: true });
 };
 var debouncedWriting = (0, _debounce["default"])(function () {
@@ -60,50 +68,60 @@ var debouncedWriting = (0, _debounce["default"])(function () {
             time1 = new Date().getTime();
             logscopy = logs;
             logs = [];
-            _context.prev = 3;
-            _context.next = 6;
+            if (!(0, _env.isElectron)()) {
+              _context.next = 7;
+              break;
+            }
+            logscopy.forEach(function (log) {
+              writingToDisk(log.content);
+            });
+            _context.next = 36;
+            break;
+          case 7:
+            _context.prev = 7;
+            _context.next = 10;
             return _db.db.logs.count();
-          case 6:
+          case 10:
             count = _context.sent;
             exceedNo = logscopy.length + count - maxRecords;
             if (!(exceedNo > 0)) {
-              _context.next = 15;
+              _context.next = 19;
               break;
             }
             console.log("[worker] the count of stored logs exceeded limit of ".concat(maxRecords, " for ").concat(exceedNo, "."));
             console.log("[worker] start deleting records. exceeded: ".concat(exceedNo));
-            _context.next = 13;
+            _context.next = 17;
             return _db.db.logs.orderBy(':id').reverse().limit(exceedNo)["delete"]();
-          case 13:
+          case 17:
             total = _context.sent;
             console.log("[worker] done deleting records. total: ".concat(total));
-          case 15:
-            _context.next = 20;
+          case 19:
+            _context.next = 24;
             break;
-          case 17:
-            _context.prev = 17;
-            _context.t0 = _context["catch"](3);
+          case 21:
+            _context.prev = 21;
+            _context.t0 = _context["catch"](7);
             console.error("[worker] clear db failed.", _context.t0);
-          case 20:
-            _context.prev = 20;
+          case 24:
+            _context.prev = 24;
             console.log("[worker] start writing logs. total: ".concat(logscopy.length));
-            _context.next = 24;
+            _context.next = 28;
             return _db.db.logs.bulkPut(logscopy);
-          case 24:
+          case 28:
             pk = _context.sent;
             time2 = new Date().getTime();
             console.log("[worker] done writing logs in ".concat(time2 - time1, "ms. total: ").concat(logscopy.length, ", lastId: ").concat(pk));
-            _context.next = 32;
+            _context.next = 36;
             break;
-          case 29:
-            _context.prev = 29;
-            _context.t1 = _context["catch"](20);
+          case 33:
+            _context.prev = 33;
+            _context.t1 = _context["catch"](24);
             console.error("[worker] bulkPut ".concat(logscopy.length, " failed."), _context.t1);
-          case 32:
+          case 36:
           case "end":
             return _context.stop();
         }
-      }, _callee, null, [[3, 17], [20, 29]]);
+      }, _callee, null, [[7, 21], [24, 33]]);
     }))(), MAX_WAIT_TIME);
   })["catch"](function (e) {
     console.log('[worker] an error during dispatching writeLog', e);
@@ -243,4 +261,41 @@ var setMaxRecords = exports.setMaxRecords = function setMaxRecords(self, callId,
   (0, _reply.reply)(self, callId, _constants.WorkerDirectives.SET_MAX_RECORDS, {
     isSuccess: true
   });
+};
+var initFsLogger = /*#__PURE__*/function () {
+  var _ref4 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee4(logPath) {
+    var winston;
+    return _regenerator["default"].wrap(function _callee4$(_context5) {
+      while (1) switch (_context5.prev = _context5.next) {
+        case 0:
+          winston = eval('require("winston")');
+          winstonLogger = winston.createLogger({
+            format: winston.format.printf(function (_ref5) {
+              var message = _ref5.message;
+              return "".concat(message);
+            }),
+            transports: [new winston.transports.File({
+              filename: logPath,
+              maxFiles: 5,
+              maxsize: 1048576 //1MB,
+            })]
+          });
+        case 2:
+        case "end":
+          return _context5.stop();
+      }
+    }, _callee4);
+  }));
+  return function initFsLogger(_x8) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+var initLogPath = exports.initLogPath = function initLogPath(logPath) {
+  console.log("[worker] log path is set to ".concat(logPath));
+  initFsLogger(logPath);
+};
+var writingToDisk = exports.writingToDisk = function writingToDisk(log) {
+  if (winstonLogger) {
+    winstonLogger.info(log);
+  }
 };

package/lib/worker/interactor.d.ts

@@ -13,7 +13,7 @@ export declare class WorkerInteractor implements LogWorkerInteractor {
     deleteLogs(labels: string[], lastId: number): Promise<void>;
     persistBinary(id: number, buffer: Buffer): Promise<void>;
     unpersistBinary(id: number): Promise<void>;
-    getBinary(id: number): Promise<Buffer | null>;
+    getBinary(id: number): Promise<Buffer<ArrayBufferLike> | null>;
     collectLogsOnFs(logDirPath: string): Promise<File>;
     private _handleMessageCallback;
     private _handleErrorCallback;

package/lib/worker/interactor.js

@@ -24,6 +24,7 @@ var _constants = require("./constants");
 var _dayjs = _interopRequireDefault(require("dayjs"));
 var _events = require("../utilities/events");
 var _raceCondition = require("../utilities/race-condition");
+var _env = require("../utilities/env");
 var _excluded = ["isSuccess"];
 var MAX_WAIT_TIME = 10000;
 var WorkerInteractor = exports.WorkerInteractor = /*#__PURE__*/function () {
@@ -335,6 +336,16 @@ var WorkerInteractor = exports.WorkerInteractor = /*#__PURE__*/function () {
     value: function _spawnNewWorker() {
       console.info('[WorkerInteractor] spawned a new log worker');
       var logWorker = (0, _workerFactory.createWorkerInstance)();
+      if ((0, _env.isElectron)()) {
+        var path = window.require('path');
+        var _window$require = window.require('@electron/remote'),
+          app = _window$require.app;
+        var logPath = path.resolve(app.getPath('logs'), 'logs', 'meeting-runtime.log');
+        logWorker.postMessage({
+          type: _constants.WorkerDirectives.INIT_LOG_PATH,
+          data: logPath
+        });
+      }
       return logWorker;
     }
   }, {

package/lib/worker/worker-installer.d.ts

@@ -1,2 +1,2 @@
-import { WorkerContext } from "./type";
+import { WorkerContext } from './type';
 export declare const installHandler: (self: WorkerContext) => void;

package/lib/worker/worker-installer.js

@@ -14,7 +14,7 @@ var _constants = require("./constants");
 var _reply = require("./handler/reply");
 var installHandler = exports.installHandler = function installHandler(self) {
   console.log("[worker] worker initialzied.");
-  self.addEventListener("message", function (evt) {
+  self.addEventListener('message', function (evt) {
     if (evt.data) {
       var _evt$data = evt.data,
         type = _evt$data.type,
@@ -30,6 +30,8 @@ var installHandler = exports.installHandler = function installHandler(self) {
           created_at: +Date.now(),
           timestamp: "".concat(now)
         });
+      } else if (type === _constants.WorkerDirectives.INIT_LOG_PATH) {
+        (0, _log.initLogPath)(evt.data.data);
       } else if (type === _constants.WorkerDirectives.SET_MAX_RECORDS) {
         (0, _log.setMaxRecords)(self, callId, evt.data.data.maxRecords || 50000);
       } else if (type === _constants.WorkerDirectives.COLLECT_LOGS) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-foundation",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "license": "MIT",
   "scripts": {
     "build": "agora-tc-transpile",
@@ -21,7 +21,8 @@
     "@types/lodash": "^4.14.168",
     "@types/node": "^20.11.30",
     "tslib": "^2.6.2",
-    "agora-toolchain": "^3.3.0"
+    "agora-toolchain": "^3.4.0",
+    "winston": "^3.16.0"
   },
   "dependencies": {
     "async-await-retry": "^2.0.1",
@@ -30,4 +31,4 @@
     "jszip": "^3.10.1",
     "lodash": "^4.17.21"
   }
-}
+}