@arms/rum-core 0.0.40 → 0.1.1

package/es/index.d.ts

@@ -2,12 +2,14 @@ import Client from './model/client';
 import Context from './model/context';
 import Reporter from './model/reporter';
 import Shell from './model/shell';
+export * from './model/configManager';
 export * from './types/client';
 export * from './types/collector';
 export * from './types/processor';
 export * from './types/reporter';
 export * from './types/rum-event';
 export * from './types/shell';
+export * from './types/config';
 export * from './utils/base';
 export * from './utils/polyfills';
 export * from './utils/is';
@@ -15,4 +17,5 @@ export * from './utils/number';
 export * from './utils/match';
 export * from './utils/trace';
 export * from './utils/verify';
+export * from './utils/url';
 export { Client, Context, Reporter, Shell };

package/es/index.js

@@ -2,12 +2,14 @@ import Client from './model/client';
 import Context from './model/context';
 import Reporter from './model/reporter';
 import Shell from './model/shell';
+export * from './model/configManager';
 export * from './types/client';
 export * from './types/collector';
 export * from './types/processor';
 export * from './types/reporter';
 export * from './types/rum-event';
 export * from './types/shell';
+export * from './types/config';
 export * from './utils/base';
 export * from './utils/polyfills';
 export * from './utils/is';
@@ -15,4 +17,5 @@ export * from './utils/number';
 export * from './utils/match';
 export * from './utils/trace';
 export * from './utils/verify';
+export * from './utils/url';
 export { Client, Context, Reporter, Shell };

package/es/model/client.d.ts

@@ -1,4 +1,5 @@
 import { IClient, IConfiguration, IContext, IRumSession } from '../types/client';
+import { IConfigManager } from "../types/config";
 import { RumEvent } from '../types/rum-event';
 import { IProcessor } from '../types/processor';
 import { ICollector } from '../types/collector';
@@ -9,7 +10,7 @@ declare class Client implements IClient {
     private processors;
     private reporter;
     private ctx;
-    init(config: IConfiguration, rumSession?: IRumSession): void;
+    init(config: IConfiguration, rumSession?: IRumSession, configManager?: IConfigManager): void;
     sendEvent: (payload: RumEvent) => void;
     setContext(ctx: IContext): void;
     getContext(): IContext;

package/es/model/client.js

@@ -18,9 +18,9 @@ var Client = /*#__PURE__*/function () {
     };
   }
   var _proto = Client.prototype;
-  _proto.init = function init(config, rumSession) {
+  _proto.init = function init(config, rumSession, configManager) {
     var _this2 = this;
-    this.ctx = new Context(config, rumSession);
+    this.ctx = new Context(config, rumSession, configManager);
     var ctx = this.ctx,
       collectors = this.collectors,
       processors = this.processors,

package/es/model/configManager.d.ts

@@ -0,0 +1,58 @@
+import { ICacheConfiguration, IConfigManager } from '../types/config';
+import { IConfiguration } from '../types/client';
+/**
+ * 配置管理器
+ * 提供配置管理的通用实现，各平台可以继承并实现特定方法
+ */
+export declare abstract class ConfigManager implements IConfigManager {
+    protected currentConfig: IConfiguration | null;
+    protected initialized: boolean;
+    /**
+     * 初始化配置管理器
+     * @param config 初始配置
+     */
+    init(config: IConfiguration): Promise<void>;
+    /**
+     * 获取配置
+     * @returns 配置数据
+     */
+    getConfig(): IConfiguration;
+    /**
+     * 更新配置
+     * @param config 新配置
+     */
+    setConfig(config: Partial<IConfiguration>): Promise<void>;
+    /**
+     * 检查缓存是否有效
+     * @param cachedData 缓存数据
+     * @param cacheTimeout 缓存超时时间
+     */
+    protected isCacheValid(cachedData: any, cacheTimeout?: number): boolean;
+    /**
+     * 合并配置
+     * @param remoteCfg 远程配置
+     * @returns 合并后的配置
+     */
+    mergeRemoteCfg(remoteCfg: any): IConfiguration | null;
+    abstract fetchRemoteCfg(config: IConfiguration): Promise<any>;
+    /**
+     * 抽象方法：获取本地存储的配置
+     * 各平台需要实现此方法来适配不同的本地存储方式
+     */
+    abstract getCacheConfig(): Promise<ICacheConfiguration> | ICacheConfiguration | void;
+    /**
+     * 抽象方法：存储配置到本地
+     * 各平台需要实现此方法来适配不同的本地存储方式
+     * @param config 配置数据
+     */
+    abstract setCacheConfig(config: ICacheConfiguration): void;
+    /**
+     * 抽象方法：解析远端配置为本地配置
+     * @param json 远端下发的配置数据
+     */
+    abstract parseConfig(json: any): unknown;
+    /**
+     * 销毁配置管理器
+     */
+    destroy(): void;
+}

package/es/model/configManager.js

@@ -0,0 +1,177 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+function parseRemoteConfig(config) {
+  var remoteConfig = config.remoteConfig || {};
+  return {
+    enable: remoteConfig.enable !== false && !!(remoteConfig.url || remoteConfig.region),
+    url: remoteConfig.url || '',
+    mode: remoteConfig.mode || 'launch-first',
+    cacheTimeout: remoteConfig.cacheTimeout || 3600000
+  };
+}
+
+/**
+ * 配置管理器
+ * 提供配置管理的通用实现，各平台可以继承并实现特定方法
+ */
+export var ConfigManager = /*#__PURE__*/function () {
+  function ConfigManager() {
+    this.currentConfig = null;
+    this.initialized = false;
+  }
+  var _proto = ConfigManager.prototype;
+  /**
+   * 初始化配置管理器
+   * @param config 初始配置
+   */
+  _proto.init =
+  /*#__PURE__*/
+  function () {
+    var _init = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(config) {
+      var _this = this;
+      var remoteConfig, cacheConfig, asyncConfigPromise;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (!this.initialized) {
+              _context.next = 2;
+              break;
+            }
+            return _context.abrupt("return");
+          case 2:
+            this.currentConfig = _extends({}, config);
+            this.initialized = true;
+            remoteConfig = parseRemoteConfig(config);
+            this.currentConfig.remoteConfig = remoteConfig;
+            if (remoteConfig.enable) {
+              _context.next = 8;
+              break;
+            }
+            return _context.abrupt("return");
+          case 8:
+            _context.next = 10;
+            return this.getCacheConfig();
+          case 10:
+            cacheConfig = _context.sent;
+            if (cacheConfig && cacheConfig.content) {
+              this.currentConfig = this.mergeRemoteCfg(cacheConfig.content);
+            }
+            if (!this.isCacheValid(cacheConfig, remoteConfig.cacheTimeout)) {
+              _context.next = 14;
+              break;
+            }
+            return _context.abrupt("return");
+          case 14:
+            asyncConfigPromise = this.fetchRemoteCfg(this.currentConfig).then(function (resp) {
+              if (!resp) return;
+              var asyncRemoteConfig = _this.parseConfig(resp);
+              _this.currentConfig = _this.mergeRemoteCfg(asyncRemoteConfig);
+              _this.setCacheConfig({
+                timestamp: Date.now(),
+                content: resp
+              });
+            });
+            if (!(remoteConfig.mode === 'remote-first')) {
+              _context.next = 18;
+              break;
+            }
+            _context.next = 18;
+            return asyncConfigPromise;
+          case 18:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, this);
+    }));
+    function init(_x) {
+      return _init.apply(this, arguments);
+    }
+    return init;
+  }()
+  /**
+   * 获取配置
+   * @returns 配置数据
+   */
+  ;
+  _proto.getConfig = function getConfig() {
+    if (!this.currentConfig) {
+      throw new Error('Config not initialized');
+    }
+    return this.currentConfig;
+  }
+
+  /**
+   * 更新配置
+   * @param config 新配置
+   */;
+  _proto.setConfig =
+  /*#__PURE__*/
+  function () {
+    var _setConfig = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(config) {
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
+          case 0:
+            if (this.currentConfig) {
+              _context2.next = 2;
+              break;
+            }
+            return _context2.abrupt("return");
+          case 2:
+            this.currentConfig = _extends({}, this.currentConfig, config);
+          case 3:
+          case "end":
+            return _context2.stop();
+        }
+      }, _callee2, this);
+    }));
+    function setConfig(_x2) {
+      return _setConfig.apply(this, arguments);
+    }
+    return setConfig;
+  }()
+  /**
+   * 检查缓存是否有效
+   * @param cachedData 缓存数据
+   * @param cacheTimeout 缓存超时时间
+   */
+  ;
+  _proto.isCacheValid = function isCacheValid(cachedData, cacheTimeout) {
+    if (!cachedData || !cachedData.timestamp) {
+      return false;
+    }
+    var timeout = cacheTimeout || 3600000; // 默认1小时
+    return Date.now() - cachedData.timestamp < timeout;
+  }
+
+  /**
+   * 合并配置
+   * @param remoteCfg 远程配置
+   * @returns 合并后的配置
+   */;
+  _proto.mergeRemoteCfg = function mergeRemoteCfg(remoteCfg) {
+    var _this$currentConfig = this.currentConfig,
+      pid = _this$currentConfig.pid,
+      app = _this$currentConfig.app,
+      endpoint = _this$currentConfig.endpoint,
+      remoteConfig = _this$currentConfig.remoteConfig,
+      beforeReport = _this$currentConfig.beforeReport,
+      properties = _this$currentConfig.properties;
+    return _extends({}, this.currentConfig, remoteCfg, {
+      pid: pid,
+      app: app,
+      endpoint: endpoint,
+      remoteConfig: remoteConfig,
+      beforeReport: beforeReport,
+      properties: properties
+    });
+  };
+  /**
+   * 销毁配置管理器
+   */
+  _proto.destroy = function destroy() {
+    this.currentConfig = null;
+    this.initialized = false;
+  };
+  return ConfigManager;
+}();

package/es/model/context.d.ts

@@ -1,11 +1,13 @@
 import { IConfiguration, IContext, IRumSession } from "../types/client";
 import { RumEvent, IViewData } from "../types/rum-event";
+import { IConfigManager } from "../types/config";
 declare class Context implements IContext {
     private config;
     private rumEvent;
     private views;
     session: IRumSession;
-    constructor(config: IConfiguration, rumSession?: IRumSession);
+    configManager: IConfigManager;
+    constructor(config: IConfiguration, rumSession?: IRumSession, configManager?: IConfigManager);
     getConfig(): IConfiguration;
     setConfig(config: IConfiguration): void;
     getViews(): IViewData[];

package/es/model/context.js

@@ -1,20 +1,31 @@
 var Context = /*#__PURE__*/function () {
-  function Context(config, rumSession) {
+  function Context(config, rumSession, configManager) {
     this.config = config;
     this.rumEvent = void 0;
     this.views = [];
     this.session = void 0;
+    this.configManager = void 0;
     if (rumSession) {
       this.session = rumSession;
       this.session.init(this);
     }
+    if (configManager) {
+      this.configManager = configManager;
+    }
   }
   var _proto = Context.prototype;
   _proto.getConfig = function getConfig() {
+    if (this.configManager) {
+      return this.configManager.getConfig();
+    }
     return this.config;
   };
   _proto.setConfig = function setConfig(config) {
-    this.config = config;
+    if (this.configManager) {
+      this.configManager.setConfig(config);
+    } else {
+      this.config = config;
+    }
   };
   _proto.getViews = function getViews() {
     return this.views;

package/es/model/reporter.d.ts

@@ -10,10 +10,7 @@ export default abstract class Reporter {
     protected ctx: IContext;
     private timer;
     private _init;
-    getReportCfg(): {
-        flushTime?: number;
-        maxEventCount?: number;
-    };
+    getReportCfg(): import("../types/client").IReportConfig;
     report(ctx: IContext): void;
     private pushToQueue;
     /**
@@ -21,6 +18,7 @@ export default abstract class Reporter {
      */
     protected flushEventQueue(): void;
     mergeEvent(ctx: IContext, events: RumEvent[], view: IViewData): void;
+    private tryRequest;
     /**
      * 接口请求由各平台 sdk reporter 实现
      */

package/es/model/reporter.js

@@ -1,4 +1,6 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _extends from "@babel/runtime/helpers/extends";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { RumEventType } from '../types/rum-event';
 import { getErrorID } from '../utils/exception';
 import { isNumber, isObject, isString } from "../utils/is";
@@ -183,17 +185,54 @@ var Reporter = /*#__PURE__*/function () {
       bundle = config.beforeReport(bundle);
       if (!bundle) return;
     }
-    this.request(ctx, bundle);
-  }
-
-  // /**
-  //  * 接口请求由各平台 sdk reporter 实现
-  //  */
-  // abstract request(ctx: IContext, events: RumEvent[], view: IViewData): void;
-
+    this.tryRequest(bundle);
+  };
+  _proto.tryRequest = /*#__PURE__*/function () {
+    var _tryRequest = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(bundle, retry) {
+      var _this$ctx$getConfig,
+        _reportConfig$maxRetr,
+        _reportConfig$retryDe,
+        _this2 = this;
+      var reportConfig, maxRetryCount, retryDelay;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (retry === void 0) {
+              retry = 0;
+            }
+            reportConfig = (_this$ctx$getConfig = this.ctx.getConfig()) === null || _this$ctx$getConfig === void 0 ? void 0 : _this$ctx$getConfig.reportConfig;
+            maxRetryCount = (_reportConfig$maxRetr = reportConfig === null || reportConfig === void 0 ? void 0 : reportConfig.maxRetryCount) !== null && _reportConfig$maxRetr !== void 0 ? _reportConfig$maxRetr : 0;
+            retryDelay = (_reportConfig$retryDe = reportConfig === null || reportConfig === void 0 ? void 0 : reportConfig.retryDelay) !== null && _reportConfig$retryDe !== void 0 ? _reportConfig$retryDe : 3000;
+            _context.prev = 4;
+            bundle._retry = retry;
+            _context.next = 8;
+            return this.request(this.ctx, bundle);
+          case 8:
+            _context.next = 13;
+            break;
+          case 10:
+            _context.prev = 10;
+            _context.t0 = _context["catch"](4);
+            if (retry < maxRetryCount - 1) {
+              setTimeout(function () {
+                return _this2.tryRequest(bundle, retry + 1);
+              }, retryDelay);
+            }
+          case 13:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, this, [[4, 10]]);
+    }));
+    function tryRequest(_x, _x2) {
+      return _tryRequest.apply(this, arguments);
+    }
+    return tryRequest;
+  }()
   /**
    * 接口请求由各平台 sdk reporter 实现
-   */;
+   */
+  ;
   /**
    * 初始化时
    */

package/es/model/shell.d.ts

@@ -4,29 +4,15 @@ import { IShell } from "../types/shell";
 export default abstract class Shell implements IShell {
     client: IClient;
     constructor(config?: IConfiguration);
-    getCombinedConfig(config?: IConfiguration): any;
-    updateFromRemoteConfig(config: any, reSetup?: boolean): void;
     /**
      * 初始化
      */
-    abstract init(configuration: IConfiguration): void;
+    abstract init(configuration: IConfiguration): Promise<Shell> | Shell;
     sendEvent(payload: RumEvent): void;
     /**
      * get config
      */
     getConfig(): IConfiguration;
-    /**
-     * 获取远程配置
-     */
-    abstract getRemoteConfig(url: string, config: any): object;
-    /**
-     * 存储远程配置到本地
-     */
-    abstract storeRemoteConfig(config: any, pid: string): boolean;
-    /**
-     * 提取本地存储的配置
-     */
-    abstract getLocalConfig(duration: number, pid: string): any;
     /**
      * set config
      */

package/es/model/shell.js

@@ -1,8 +1,8 @@
 import _extends from "@babel/runtime/helpers/extends";
 import { RumEventType } from "../types/rum-event";
 import Client from '../model/client';
-import { isNumber, isFunction, isObject } from "../utils/is";
-import combineConfig, { isRemoteConfigEnable, getRemoteConfigUrl } from "../utils/combineConfig";
+import { isNumber, isObject } from "../utils/is";
+// import combineConfig, { isRemoteConfigEnable, getRemoteConfigUrl } from "../utils/combineConfig";
 var Shell = /*#__PURE__*/function () {
   function Shell(config) {
     this.client = void 0;
@@ -10,60 +10,55 @@ var Shell = /*#__PURE__*/function () {
     if (config && this.init) {
       this.init(config);
     }
-    // if (config && this.init) {
-    //   this.init(this.getCombinedConfig(config));
-
-    //   // 拉取远程配置进行更新
-    //   this.updateFromRemoteConfig(config);
-    // }
   }
-  var _proto = Shell.prototype;
-  _proto.getCombinedConfig = function getCombinedConfig(config) {
-    var combinedConf;
-    if (isRemoteConfigEnable(config) && isFunction(this.getLocalConfig)) {
-      var localConfig = this.getLocalConfig(0, config.pid);
-      combinedConf = combineConfig(config, localConfig);
-    }
-    return combinedConf || config;
-  };
-  _proto.updateFromRemoteConfig = function updateFromRemoteConfig(config, reSetup) {
-    if (reSetup === void 0) {
-      reSetup = true;
-    }
-    // 请求动态配置
-    if (config.pid && isRemoteConfigEnable(config) && isFunction(this.getRemoteConfig)) {
-      var that = this;
-      var proms = this.getRemoteConfig(getRemoteConfigUrl(config), config);
-      proms === null || proms === void 0 ? void 0 : proms.then(function (remoteConfig) {
-        if (!remoteConfig || remoteConfig.errorStatus !== undefined) return;
-        var combinedConf = combineConfig(config, remoteConfig);
-
-        // 无有效的新配置，无需更新
-        if (!combinedConf) return;
 
-        // 存储到本地
-        if (isFunction(that.storeRemoteConfig)) {
-          that.storeRemoteConfig(remoteConfig, config.pid);
-        }
-        if (reSetup === false || config.remoteConfig.reSetup === false) return;
-        var context = that.client.getContext();
-        // 更新配置
-        context.setConfig(combinedConf);
-        // 逐个更新collector
-        var collectors = that.client.getCollectors();
-        collectors.forEach(function (collector) {
-          if (isFunction(collector.destroy)) {
-            collector.destroy();
-            collector.setup(context, that.client.sendEvent);
-          }
-        });
-      });
-    }
-  }
+  // getCombinedConfig(config?: IConfiguration) {
+  //   let combinedConf;
+  //   if(isRemoteConfigEnable(config) && isFunction(this.getLocalConfig)) {
+  //     const localConfig = this.getLocalConfig(0, config.pid);
+  //     combinedConf = combineConfig(config, localConfig);
+  //   }
+  //   return combinedConf || config;
+  // }
+  //
+  // updateFromRemoteConfig(config: any, reSetup: boolean = true) {
+  //   // 请求动态配置
+  //   if( config.pid && isRemoteConfigEnable(config) && isFunction(this.getRemoteConfig) ){
+  //     const that = this;
+  //     const proms = this.getRemoteConfig(getRemoteConfigUrl(config), config);
+  //     proms?.then(remoteConfig => {
+  //       if(!remoteConfig || remoteConfig.errorStatus !== undefined) return;
+  //       const combinedConf = combineConfig(config, remoteConfig);
+  //
+  //       // 无有效的新配置，无需更新
+  //       if(!combinedConf) return;
+  //
+  //       // 存储到本地
+  //       if(isFunction(that.storeRemoteConfig)) {
+  //         that.storeRemoteConfig(remoteConfig, config.pid);
+  //       }
+  //
+  //       if(reSetup === false || config.remoteConfig.reSetup === false) return;
+  //
+  //       const context = that.client.getContext();
+  //       // 更新配置
+  //       context.setConfig(combinedConf);
+  //       // 逐个更新collector
+  //       const collectors = that.client.getCollectors();
+  //       collectors.forEach(collector => {
+  //         if(isFunction(collector.destroy)) {
+  //           collector.destroy();
+  //           collector.setup(context, that.client.sendEvent);
+  //         }
+  //       });
+  //     });
+  //   }
+  // }
 
   /**
    * 初始化
-   */;
+   */
+  var _proto = Shell.prototype;
   _proto.sendEvent = function sendEvent(payload) {
     if (this.client) {
       this.client.sendEvent(payload);
@@ -79,8 +74,23 @@ var Shell = /*#__PURE__*/function () {
     }
   }
 
+  // /**
+  //  * 获取远程配置
+  //  */
+  // abstract getRemoteConfig(url: string, config: any): object;
+  //
+  // /**
+  //  * 存储远程配置到本地
+  //  */
+  // abstract storeRemoteConfig(config: any, pid: string): boolean;
+  //
+  // /**
+  //  * 提取本地存储的配置
+  //  */
+  // abstract getLocalConfig(duration: number, pid: string): any;
+
   /**
-   * 获取远程配置
+   * set config
    */;
   /**
    * 自定义事件上报