@arms/rum-core 0.0.40 → 0.1.2

package/lib/model/configManager.js

@@ -0,0 +1,183 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.ConfigManager = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+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,
+    region: remoteConfig.region
+  };
+}
+
+/**
+ * 配置管理器
+ * 提供配置管理的通用实现，各平台可以继承并实现特定方法
+ */
+var ConfigManager = exports.ConfigManager = /*#__PURE__*/function () {
+  function ConfigManager() {
+    this.currentConfig = null;
+    this.initialized = false;
+  }
+  var _proto = ConfigManager.prototype;
+  /**
+   * 初始化配置管理器
+   * @param config 初始配置
+   */
+  _proto.init =
+  /*#__PURE__*/
+  function () {
+    var _init = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee(config) {
+      var _this = this;
+      var remoteConfig, cacheConfig, asyncConfigPromise;
+      return _regenerator["default"].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 = (0, _extends2["default"])({}, 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 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee2(config) {
+      return _regenerator["default"].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 = (0, _extends2["default"])({}, 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 (0, _extends2["default"])({}, 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/lib/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/lib/model/context.js

@@ -3,22 +3,33 @@
 exports.__esModule = true;
 exports["default"] = void 0;
 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/lib/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/lib/model/reporter.js

@@ -3,6 +3,8 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports["default"] = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _rumEvent = require("../types/rum-event");
 var _exception = require("../utils/exception");
@@ -188,17 +190,54 @@ var Reporter = exports["default"] = /*#__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 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee(bundle, retry) {
+      var _this$ctx$getConfig,
+        _reportConfig$maxRetr,
+        _reportConfig$retryDe,
+        _this2 = this;
+      var reportConfig, maxRetryCount, retryDelay;
+      return _regenerator["default"].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/lib/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/lib/model/shell.js

@@ -7,70 +7,39 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var _rumEvent = require("../types/rum-event");
 var _client = _interopRequireDefault(require("../model/client"));
 var _is = require("../utils/is");
-var _combineConfig = _interopRequireWildcard(require("../utils/combineConfig"));
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
 var Shell = exports["default"] = /*#__PURE__*/function () {
   function Shell(config) {
+    // private callbacks: Function[] = [];
+    // private initialized = false;
     this.client = void 0;
     this.client = new _client["default"]();
     if (config && this.init) {
       this.init(config);
+      // const p = this.init(config) as Promise<Shell>;
+      // if(isFunction(p?.then)){
+      //   p.then(this.shellReady);
+      // } else {
+      //   this.shellReady()
+      // }
     }
-    // if (config && this.init) {
-    //   this.init(this.getCombinedConfig(config));
-
-    //   // 拉取远程配置进行更新
-    //   this.updateFromRemoteConfig(config);
-    // }
   }
-  var _proto = Shell.prototype;
-  _proto.getCombinedConfig = function getCombinedConfig(config) {
-    var combinedConf;
-    if ((0, _combineConfig.isRemoteConfigEnable)(config) && (0, _is.isFunction)(this.getLocalConfig)) {
-      var localConfig = this.getLocalConfig(0, config.pid);
-      combinedConf = (0, _combineConfig["default"])(config, localConfig);
-    }
-    return combinedConf || config;
-  };
-  _proto.updateFromRemoteConfig = function updateFromRemoteConfig(config, reSetup) {
-    if (reSetup === void 0) {
-      reSetup = true;
-    }
-    // 请求动态配置
-    if (config.pid && (0, _combineConfig.isRemoteConfigEnable)(config) && (0, _is.isFunction)(this.getRemoteConfig)) {
-      var that = this;
-      var proms = this.getRemoteConfig((0, _combineConfig.getRemoteConfigUrl)(config), config);
-      proms === null || proms === void 0 ? void 0 : proms.then(function (remoteConfig) {
-        if (!remoteConfig || remoteConfig.errorStatus !== undefined) return;
-        var combinedConf = (0, _combineConfig["default"])(config, remoteConfig);
 
-        // 无有效的新配置，无需更新
-        if (!combinedConf) return;
-
-        // 存储到本地
-        if ((0, _is.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 ((0, _is.isFunction)(collector.destroy)) {
-            collector.destroy();
-            collector.setup(context, that.client.sendEvent);
-          }
-        });
-      });
-    }
-  }
+  // private shellReady = () => {
+  //   this.initialized = true;
+  //   this.callbacks.forEach(cb => cb());
+  // }
+  //
+  // onReady(callback: Function) {
+  //   if (this.initialized) {
+  //     callback();
+  //   }
+  //   this.callbacks.push(callback);
+  // }
 
   /**
    * 初始化
-   */;
+   */
+  var _proto = Shell.prototype;
   _proto.sendEvent = function sendEvent(payload) {
     if (this.client) {
       this.client.sendEvent(payload);
@@ -87,7 +56,7 @@ var Shell = exports["default"] = /*#__PURE__*/function () {
   }
 
   /**
-   * 获取远程配置
+   * set config
    */;
   /**
    * 自定义事件上报

package/lib/types/client.d.ts

@@ -3,6 +3,7 @@ import { IProcessor } from './processor';
 import { IReporter } from './reporter';
 import { RumEvent, RumEventBundle, IViewData } from './rum-event';
 import { MatchOption } from "../utils/match";
+import { IConfigManager } from "./config";
 export declare enum EventType {
     /**
      * 收集数据
@@ -35,6 +36,12 @@ export interface SessionConfig {
     overtime?: number;
     storage?: string;
 }
+export interface IReportConfig {
+    flushTime?: number;
+    maxEventCount?: number;
+    maxRetryCount?: number;
+    retryDelay?: number;
+}
 export interface IRumSession {
     init(ctx: IContext): void;
     sessionConfig: SessionConfig;
@@ -46,11 +53,54 @@ export interface IRumSession {
     getUserId: () => string;
     getBaseEvent: () => any;
 }
+/**
+ * 远端监控配置接口
+ * @remarks 用于控制RUM数据采集的远程配置策略
+ */
+export interface IRemoteConfig {
+    /**
+     * 是否启用远端配置 (default: false)
+     * @example true - 开启云端配置动态管控
+     */
+    enable?: boolean;
+    /**
+     * 配置服务器URL (required when enable=true)
+     * @format URL
+     */
+    url?: string;
+    /**
+     * 配置获取策略模式 (default: 'launch-first')
+     * @enum
+     *   - 'launch-first': 启动优先模式，先使用本地配置快速启动，异步获取最新配置
+     *   - 'remote-first': 云端优先模式，阻塞等待云端配置，超时后降级到本地
+     */
+    mode?: 'launch-first' | 'remote-first';
+    /**
+     * 配置缓存有效期（单位：毫秒，默认：3600000/1小时）
+     * @remarks 控制本地配置缓存刷新频率，超时后重新请求云端配置
+     * @example 1800000 - 30分钟更新一次配置
+     */
+    cacheTimeout?: number;
+    /**
+     * 配置远程配置拉取Region，兼容 0.0.x 版本远端配置
+     * @remarks 拉取远端配置地域
+     * @example cn-hangzhou 国内主要地区
+     */
+    region?: string;
+    [key: string]: unknown;
+}
+export interface ICollectorConfig {
+    name: string;
+    enable?: boolean;
+    sampling?: number;
+    filters?: MatchOption[];
+    [key: string]: unknown;
+}
 export interface IClient {
     /**
      * 初始化
      */
-    init: (configuration: IConfiguration, rumSession?: IRumSession) => void;
+    init: (configuration: IConfiguration, rumSession?: IRumSession, configManager?: IConfigManager) => void;
     /**
      * 业务自定义上传数据
      */
@@ -81,6 +131,10 @@ export interface IClient {
     useReporter(reporter: IReporter): void;
 }
 export interface IConfiguration {
+    /**
+     * 是否开启SDK
+     */
+    enable?: boolean;
     /**
      * 项目 id
      * v0.0.40开始，不强依赖该参数，通过Endpoint获取 service_id 确定应用
@@ -126,15 +180,12 @@ export interface IConfiguration {
     /**
      * reporter 发送节奏配置
      */
-    reportConfig?: {
-        flushTime?: number;
-        maxEventCount?: number;
-    };
+    reportConfig?: IReportConfig;
     /**
      *  配置下发
      *  - 运行时动态配置更新，根据端侧特点来做定制化配置
      */
-    remoteConfig?: Boolean;
+    remoteConfig?: IRemoteConfig | Boolean;
     /**
      * session config
      */
@@ -143,7 +194,7 @@ export interface IConfiguration {
      * 各个 collector config
      */
     collectors?: {
-        [key: string]: boolean;
+        [key: string]: boolean | ICollectorConfig;
     };
     /**
      * 事件过滤器配置

package/lib/types/client.js

@@ -8,4 +8,8 @@ var EventType = exports.EventType = /*#__PURE__*/function (EventType) {
    */
   EventType["collect"] = "collect";
   return EventType;
-}({});
+}({});
+/**
+ * 远端监控配置接口
+ * @remarks 用于控制RUM数据采集的远程配置策略
+ */

package/lib/types/config.d.ts

@@ -0,0 +1,49 @@
+import { IConfiguration } from './client';
+export interface ICacheConfiguration {
+    /**
+     * 时间戳
+     */
+    timestamp: number;
+    /**
+     * 内容
+     */
+    content: any;
+}
+/**
+ * 配置管理器接口
+ * 统一管理配置的获取、存储、合并等操作
+ */
+export interface IConfigManager {
+    /**
+     * 初始化配置管理器
+     * @param config 初始配置
+     */
+    init(config: IConfiguration): Promise<void> | void;
+    /**
+     * 获取配置
+     * @returns 配置数据
+     */
+    getConfig(): Promise<IConfiguration> | any;
+    /**
+     * 更新配置
+     * @param config 新配置
+     */
+    setConfig(config: Partial<IConfiguration>): Promise<void> | void;
+    /**
+     * 抽象方法：获取远程配置
+     * 各平台需要实现此方法来适配不同的网络请求方式
+     * @param config 当前配置
+     */
+    fetchRemoteCfg(config: IConfiguration): Promise<any>;
+    /**
+     * 合并配置
+     * @param baseConfig 基础配置
+     * @param remoteConfig 远程配置
+     * @returns 合并后的配置
+     */
+    mergeRemoteCfg(baseConfig: IConfiguration, remoteConfig: any): IConfiguration | null;
+    /**
+     * 销毁配置管理器
+     */
+    destroy(): void;
+}

package/lib/types/config.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/lib/types/rum-event.d.ts

@@ -176,5 +176,6 @@ export interface RumEventBundle {
     events: Array<RumEvent>;
     properties?: BaseObject;
     _v?: string;
+    _retry?: number;
     [key: string]: unknown;
 }

package/lib/utils/base.d.ts

@@ -53,8 +53,8 @@ export declare function getType(obj: any): any;
  */
 export declare function transStrToReg(str: string): string | RegExp;
 /**
- *
- * @param config 配置
- * @param keys 需要转换的字段
+ * 解析正则表达式字符串，支持 /pattern/flags 格式
+ * @param str 正则表达式字符串，如 "/a/ig" 或 "a"
+ * @returns RegExp 对象
  */
-export declare function toRegFormat(config: any, keys: any[]): void;
+export declare function parseRegExpString(str: string): RegExp;