@arms/rum-core 0.0.33 → 0.0.34

package/lib/model/client.d.ts

@@ -14,6 +14,7 @@ declare class Client implements IClient {
     setContext(ctx: IContext): void;
     getContext(): IContext;
     useCollectors(collectors: ICollector[]): void;
+    getCollectors(): ICollector[];
     useProcessors(processors: IProcessor[]): void;
     useReporter(reporter: IReporter): void;
 }

package/lib/model/client.js

@@ -7,9 +7,9 @@ var _client = require("../types/client");
 var _events = require("events");
 var _context = _interopRequireDefault(require("./context"));
 var _is = require("../utils/is");
-function _createForOfIteratorHelperLoose(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (it) return (it = it.call(o)).next.bind(it); if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; return function () { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _createForOfIteratorHelperLoose(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (t) return (t = t.call(r)).next.bind(t); if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var o = 0; return function () { return o >= r.length ? { done: !0 } : { done: !1, value: r[o++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+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; }
 var Client = /*#__PURE__*/function () {
   function Client() {
     var _this = this;
@@ -67,6 +67,9 @@ var Client = /*#__PURE__*/function () {
   _proto.useCollectors = function useCollectors(collectors) {
     this.collectors = collectors;
   };
+  _proto.getCollectors = function getCollectors() {
+    return this.collectors;
+  };
   _proto.useProcessors = function useProcessors(processors) {
     this.processors = processors;
   };

package/lib/model/shell.d.ts

@@ -4,6 +4,7 @@ import { IShell } from "../types/shell";
 export default abstract class Shell implements IShell {
     client: IClient;
     constructor(config?: IConfiguration);
+    updateFromRemoteConfig(config: any): void;
     /**
      * 初始化
      */
@@ -13,6 +14,18 @@ export default abstract class Shell implements IShell {
      * 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,19 +7,64 @@ 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) {
     this.client = void 0;
     this.client = new _client["default"]();
     if (config && this.init) {
-      this.init(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);
+      }
+      this.init(combinedConf || config);
+
+      // 拉取远程配置进行更新
+      this.updateFromRemoteConfig(config);
+    }
+  }
+  var _proto = Shell.prototype;
+  _proto.updateFromRemoteConfig = function updateFromRemoteConfig(config) {
+    // 请求动态配置
+    if (config.pid && (0, _combineConfig.isRemoteConfigEnable)(config) && (0, _is.isFunction)(this.getRemoteConfig)) {
+      var that = this;
+      this.getRemoteConfig((0, _combineConfig.getRemoteConfigUrl)(config), config).then(function (remoteConfig) {
+        if (!remoteConfig || remoteConfig.errorStatus !== undefined) return;
+        var combinedConf = (0, _combineConfig["default"])(config, remoteConfig);
+
+        // 无有效的新配置，无需更新
+        if (!combinedConf) return;
+        if ((0, _is.isObject)(console) && (0, _is.isFunction)(console.log)) {
+          console.log("合并后动态配置后的新配置:\n", combinedConf);
+        }
+        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);
+          }
+        });
+
+        // 存储到本地
+        if ((0, _is.isFunction)(that.storeRemoteConfig)) {
+          that.storeRemoteConfig(remoteConfig, config.pid);
+        }
+      });
     }
   }
 
   /**
    * 初始化
-   */
-  var _proto = Shell.prototype;
+   */;
   _proto.sendEvent = function sendEvent(payload) {
     if (this.client) {
       this.client.sendEvent(payload);
@@ -36,7 +81,7 @@ var Shell = exports["default"] = /*#__PURE__*/function () {
   }
 
   /**
-   * set config
+   * 获取远程配置
    */;
   /**
    * 自定义事件上报

package/lib/types/client.d.ts

@@ -67,6 +67,10 @@ export interface IClient {
      * 装载 client 需要的 Collector
      */
     useCollectors(collectors: ICollector[]): void;
+    /**
+     * 返回装载的collector
+     */
+    getCollectors(): ICollector[];
     /**
      * 装载 client 需要的 processor
      */

package/lib/types/client.js

@@ -3,6 +3,9 @@
 exports.__esModule = true;
 exports.EventType = void 0;
 var EventType = exports.EventType = /*#__PURE__*/function (EventType) {
+  /**
+   * 收集数据
+   */
   EventType["collect"] = "collect";
   return EventType;
 }({});

package/lib/utils/base.d.ts

@@ -2,6 +2,10 @@
  * 劫持函数
  */
 export declare function interceptFunction(target: any, name: string, callback: Function): void;
+/**
+ * 还原函数
+ */
+export declare function restoreFunction(target: any, name: string): void;
 /**
  * @description: GUID v4
  * @return {String}
@@ -37,3 +41,20 @@ export declare function debounce(func: Function, wait: number): () => void;
  * @param wait 延迟执行毫秒数
  */
 export declare function delay(func: Function, wait: number, ...args: any[]): number;
+/**
+ * @desc 需要严格区分object和array
+ * @param obj 任意对象
+ */
+export declare function getType(obj: any): any;
+/**
+ * @desc 将字符串转换成正则表达式
+ * @param str 任意字符串
+ * 注意，这里只支持 /xxx/ 这种格式，不支持修饰符，例如 /xxx/ig
+ */
+export declare function transStrToReg(str: string): string | RegExp;
+/**
+ *
+ * @param config 配置
+ * @param keys 需要转换的字段
+ */
+export declare function toRegFormat(config: any, keys: any[]): void;

package/lib/utils/base.js

@@ -7,13 +7,23 @@ exports.generateEventId = generateEventId;
 exports.generateGUID = generateGUID;
 exports.generateSpanId = generateSpanId;
 exports.generateTraceId = generateTraceId;
+exports.getType = getType;
 exports.interceptFunction = interceptFunction;
+exports.restoreFunction = restoreFunction;
+exports.toRegFormat = toRegFormat;
+exports.transStrToReg = transStrToReg;
 var _is = require("./is");
+// 插值前缀
+var PRE_SUF_FIX = '__';
+// 类型匹配正则
+var TYPE_REG = /^\[object ([a-z]*)\]$/;
+
 /**
  * 劫持函数
  */
 function interceptFunction(target, name, callback) {
   var registeredMethod = target[name];
+  target["" + PRE_SUF_FIX + name + PRE_SUF_FIX] = registeredMethod;
   target[name] = function () {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
@@ -25,6 +35,17 @@ function interceptFunction(target, name, callback) {
   };
 }
 
+/**
+ * 还原函数
+ */
+function restoreFunction(target, name) {
+  var key = "" + PRE_SUF_FIX + name + PRE_SUF_FIX;
+  if (typeof target[key] == 'function') {
+    target[name] = target[key];
+    delete target[key];
+  }
+}
+
 /**
  * @description: GUID v4
  * @return {String}
@@ -137,4 +158,68 @@ function delay(func, wait) {
     args[_key2 - 2] = arguments[_key2];
   }
   return setTimeout.apply(void 0, [func, +wait || 0].concat(args));
+}
+
+/**
+ * @desc 需要严格区分object和array
+ * @param obj 任意对象
+ */
+function getType(obj) {
+  var type = Object.prototype.toString.call(obj);
+  type = type.toLowerCase() || '';
+  var arr = type.match(TYPE_REG);
+  return arr === null || arr === void 0 ? void 0 : arr[1];
+}
+
+/**
+ * @desc 将字符串转换成正则表达式
+ * @param str 任意字符串
+ * 注意，这里只支持 /xxx/ 这种格式，不支持修饰符，例如 /xxx/ig
+ */
+function transStrToReg(str) {
+  if (getType(str) !== 'string') return str;
+  if (str.length > 2 && str[0] === '/' && str[str.length - 1] === '/') {
+    return new RegExp(str.substr(1, str.length - 2));
+  }
+  return str;
+}
+
+/**
+ * 
+ * @param config 配置
+ * @param keys 需要转换的字段
+ */
+function toRegFormat(config, keys) {
+  if (getType(keys) === 'string') {
+    keys = [keys];
+  }
+  for (var i = 0, len = keys.length; i < len; i++) {
+    var paths = keys[i].split('.');
+    var lastIndex = paths.length - 1;
+    if (!config) break;
+    var tmp = config;
+    for (var j = 0, jlen = paths.length; j < jlen; j++) {
+      if (paths[j] === '[]') {
+        if (getType(tmp) === 'array') {
+          var lastPath = paths.splice(j + 1);
+          lastPath = lastPath.join('.');
+          for (var x = 0, xlen = tmp.length; x < xlen; x++) {
+            toRegFormat(tmp[x], lastPath);
+          }
+        }
+        break;
+      }
+      // 最后一层了，需要往前一层才能修改对象
+      if (lastIndex === j && getType(tmp[paths[j]]) === 'string') {
+        tmp[paths[j]] = transStrToReg(tmp[paths[j]]);
+        break;
+      }
+      tmp = tmp[paths[j]];
+      if (!tmp) break;
+    }
+    if (!tmp || getType(tmp) !== 'array') continue;
+    for (var _j = 0, _jlen = tmp.length; _j < _jlen; _j++) {
+      tmp[_j] = transStrToReg(tmp[_j]);
+    }
+  }
 }

package/lib/utils/combineConfig.d.ts

@@ -0,0 +1,15 @@
+export declare function isRemoteConfigEnable(config: any): boolean;
+/**
+ *
+ * @param config
+ * @returns
+ */
+export declare function getRemoteConfigUrl(config: any): any;
+/**
+ *
+ * @param oldConfig
+ * @param remoteConfig
+ * @returns config
+ */
+declare function combineConfig(oldConfig?: {}, remoteConfig?: any): {};
+export default combineConfig;

package/lib/utils/combineConfig.js

@@ -0,0 +1,107 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports["default"] = void 0;
+exports.getRemoteConfigUrl = getRemoteConfigUrl;
+exports.isRemoteConfigEnable = isRemoteConfigEnable;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _base = require("./base");
+// 需要检查是否需要字符串格式化为正则的配置路径
+var REG_FORMAT_PATHS = ['filters.exception', 'filters.resource', 'tracing.allowedUrls.[].match'];
+function isRemoteConfigEnable(config) {
+  return config.remoteConfig === true || config.remoteConfig && config.remoteConfig.enable !== false;
+}
+
+/**
+ * 
+ * @param config 
+ * @returns 
+ */
+function getRemoteConfigUrl(config) {
+  if (config.remoteConfig && config.remoteConfig.url) {
+    return config.remoteConfig.url;
+  }
+  var sereis = config.pid.split('@');
+  if (!sereis || sereis.length < 2) return;
+  var timestamp = Date.now();
+  return "//" + sereis[0] + "-sdk.rum.aliyuncs.com/config/" + (config.remoteConfig.region || 'cn-hangzhou') + "/" + sereis[1] + "?t=" + timestamp;
+}
+
+/**
+ * 
+ * @param oldConfig 
+ * @param remoteConfig 
+ */
+function doCover(oldConfig, remoteConfig) {
+  if (oldConfig === void 0) {
+    oldConfig = {};
+  }
+  if (remoteConfig === void 0) {
+    remoteConfig = {};
+  }
+  for (var key in oldConfig) {
+    var _remoteConfig, _remoteConfig2;
+    if (key === 'pid' || key === 'endpoint') continue;
+    if (((_remoteConfig = remoteConfig) === null || _remoteConfig === void 0 ? void 0 : _remoteConfig[key]) === undefined) continue;
+    var oldV = oldConfig[key];
+    var newV = (_remoteConfig2 = remoteConfig) === null || _remoteConfig2 === void 0 ? void 0 : _remoteConfig2[key];
+    if ((0, _base.getType)(oldV) === 'object' && (0, _base.getType)(newV) === 'object') {
+      doCover(oldV, newV);
+    } else {
+      oldConfig[key] = newV;
+    }
+  }
+}
+
+/**
+ * 
+ * @param oldConfig 
+ * @param remoteConfig 
+ */
+function doSupplement(oldConfig, remoteConfig) {
+  if (oldConfig === void 0) {
+    oldConfig = {};
+  }
+  if (remoteConfig === void 0) {
+    remoteConfig = {};
+  }
+  for (var key in remoteConfig) {
+    var _oldConfig;
+    if (((_oldConfig = oldConfig) === null || _oldConfig === void 0 ? void 0 : _oldConfig[key]) === undefined) {
+      oldConfig[key] = remoteConfig[key];
+    } else {
+      var oldV = oldConfig[key];
+      var newV = remoteConfig[key];
+      if ((0, _base.getType)(oldV) === 'object' && (0, _base.getType)(newV) === 'object') {
+        doSupplement(oldV, newV);
+      }
+    }
+  }
+}
+
+/**
+ * 
+ * @param oldConfig 
+ * @param remoteConfig 
+ * @returns config
+ */
+function combineConfig(oldConfig, remoteConfig) {
+  if (oldConfig === void 0) {
+    oldConfig = {};
+  }
+  if (remoteConfig === void 0) {
+    remoteConfig = null;
+  }
+  if (!remoteConfig) return null;
+  if ((0, _base.getType)(oldConfig) !== 'object' || (0, _base.getType)(remoteConfig) !== 'object') return null;
+  var config = (0, _extends2["default"])({}, oldConfig);
+  // 先检查远程配置的，是否有需要将字符串格式化为正则的
+  (0, _base.toRegFormat)(remoteConfig, REG_FORMAT_PATHS);
+  // 执行覆盖
+  doCover(config, remoteConfig);
+  // 执行补充
+  doSupplement(config, remoteConfig);
+  return config;
+}
+var _default = exports["default"] = combineConfig;

package/lib/utils/match.d.ts

@@ -1,7 +1,7 @@
-export type MatchOption = string | RegExp | ((value: string) => boolean);
+export type MatchOption = string | RegExp | ((value: string, option?: unknown) => boolean);
 export declare function isMatchOption(item: unknown): item is MatchOption;
 /**
  * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
  */
-export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean): boolean;
+export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean, options?: unknown): boolean;
 export declare function urlMatch(url: string, list?: MatchOption | MatchOption[]): boolean;

package/lib/utils/match.js

@@ -13,14 +13,14 @@ function isMatchOption(item) {
 /**
  * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
  */
-function matchList(list, value, useStartsWith) {
+function matchList(list, value, useStartsWith, options) {
   if (useStartsWith === void 0) {
     useStartsWith = true;
   }
   return list.some(function (item) {
     try {
       if (typeof item === 'function') {
-        return item(value);
+        return item(value, options);
       } else if (item instanceof RegExp) {
         return item.test(value);
       } else if (typeof item === 'string') {

package/lib/utils/trace.js

@@ -19,6 +19,9 @@ function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, subOption
   if (propagatorTypes.includes('sw8')) {
     propagatorTypes = ['sw8'];
   }
+  if (!(0, _is.isArray)(propagatorTypes)) {
+    propagatorTypes = [propagatorTypes];
+  }
   propagatorTypes.forEach(function (propagatorType) {
     switch (propagatorType) {
       case 'jaeger':

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arms/rum-core",
-  "version": "0.0.33",
+  "version": "0.0.34",
   "description": "arms rum javascript sdk core",
   "author": "guangli.fj <guangli.fj@alibaba-inc.com>",
   "license": "ISC",