@arms/rum-core 0.0.39 → 0.1.1

package/es/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,10 +131,15 @@ export interface IClient {
     useReporter(reporter: IReporter): void;
 }
 export interface IConfiguration {
+    /**
+     * 是否开启SDK
+     */
+    enable?: boolean;
     /**
      * 项目 id
+     * v0.0.40开始，不强依赖该参数，通过Endpoint获取 service_id 确定应用
      */
-    pid: string;
+    pid?: string;
     /**
      * 应用环境
      */
@@ -125,15 +180,12 @@ export interface IConfiguration {
     /**
      * reporter 发送节奏配置
      */
-    reportConfig?: {
-        flushTime?: number;
-        maxEventCount?: number;
-    };
+    reportConfig?: IReportConfig;
     /**
      *  配置下发
      *  - 运行时动态配置更新，根据端侧特点来做定制化配置
      */
-    remoteConfig?: Boolean;
+    remoteConfig?: IRemoteConfig | Boolean;
     /**
      * session config
      */
@@ -142,7 +194,7 @@ export interface IConfiguration {
      * 各个 collector config
      */
     collectors?: {
-        [key: string]: boolean;
+        [key: string]: boolean | ICollectorConfig;
     };
     /**
      * 事件过滤器配置

package/es/types/client.js

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

package/es/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/es/types/config.js

@@ -0,0 +1 @@
+export {};

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

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

package/es/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;

package/es/utils/base.js

@@ -1,7 +1,5 @@
 import { isFunction } from "./is";
 
-// 插值前缀
-var PRE_SUF_FIX = '__';
 // 类型匹配正则
 var TYPE_REG = /^\[object ([a-z]*)\]$/;
 
@@ -13,8 +11,7 @@ export function interceptFunction(target, name, callback, isPrototype) {
     isPrototype = false;
   }
   var registeredMethod = target[name];
-  target["" + PRE_SUF_FIX + name + PRE_SUF_FIX] = registeredMethod;
-  target[name] = function () {
+  var proxyMethod = function proxyMethod() {
     var ctx = isPrototype ? this : target;
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
@@ -24,17 +21,19 @@ export function interceptFunction(target, name, callback, isPrototype) {
       return registeredMethod.apply(ctx, args);
     }
   };
+  proxyMethod._rum_intercepted = registeredMethod;
+  target[name] = proxyMethod;
 }
 
 /**
  * 还原函数
  */
 export 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];
-  }
+  var proxyMethod = target[name];
+  if (isFunction(proxyMethod)) return;
+  var originalMethod = proxyMethod._rum_intercepted;
+  if (isFunction(originalMethod)) return;
+  target[name] = originalMethod;
 }
 
 /**
@@ -175,42 +174,71 @@ export function transStrToReg(str) {
   return str;
 }
 
+// /**
+//  *
+//  * @param config 配置
+//  * @param keys 需要转换的字段
+//  */
+// export function toRegFormat(config: any, keys: any[]) {
+//   if (getType(keys) === 'string') {
+//     keys = [keys];
+//   }
+//   for (let i = 0, len = keys.length; i < len; i++) {
+//     const paths = keys[i].split('.');
+//     const lastIndex = paths.length - 1;
+//     if (!config) break;
+//     let tmp = config;
+//     for (let j = 0, jlen = paths.length; j < jlen; j++) {
+//       if (paths[j] === '[]') {
+//         if (getType(tmp) === 'array') {
+//           let lastPath = paths.splice(j + 1);
+//           lastPath = lastPath.join('.');
+//           for (let 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 (let j = 0, jlen = tmp.length; j < jlen; j++) {
+//       tmp[j] = transStrToReg(tmp[j]);
+//     }
+//   }
+// }
+
 /**
- *
- * @param config 配置
- * @param keys 需要转换的字段
+ * 解析正则表达式字符串，支持 /pattern/flags 格式
+ * @param str 正则表达式字符串，如 "/a/ig" 或 "a"
+ * @returns RegExp 对象
  */
-export function toRegFormat(config, keys) {
-  if (getType(keys) === 'string') {
-    keys = [keys];
+export function parseRegExpString(str) {
+  if (typeof str !== 'string') {
+    throw new TypeError('input must be a string');
   }
-  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]);
+
+  // 检查是否是 /pattern/flags 格式
+  if (str.length > 2 && str[0] === '/') {
+    // 从后往前找最后一个 /，作为分隔符
+    var lastSlashIndex = str.lastIndexOf('/');
+    if (lastSlashIndex > 0) {
+      // 提取 pattern（第一个 / 和最后一个 / 之间的内容）
+      var pattern = str.substring(1, lastSlashIndex);
+      // 提取 flags（最后一个 / 之后的内容）
+      var flags = str.substring(lastSlashIndex + 1);
+      return new RegExp(pattern, flags);
     }
+    // 如果只有一个 /，当作 /pattern/ 格式处理（无 flags）
+    return new RegExp(str.substring(1, str.length - 1));
   }
+
+  // 如果不是 /pattern/flags 格式，直接作为 pattern 使用
+  return new RegExp(str);
 }

package/es/utils/combineConfig.js

@@ -1,101 +1,89 @@
-import _extends from "@babel/runtime/helpers/extends";
-import { getType, toRegFormat } from './base';
-
-// 需要检查是否需要字符串格式化为正则的配置路径
-var REG_FORMAT_PATHS = ['filters.exception', 'filters.resource', 'tracing.allowedUrls.[].match'];
-export function isRemoteConfigEnable(config) {
-  return config.remoteConfig === true || config.remoteConfig && config.remoteConfig.enable !== false;
-}
-
-/**
- * 
- * @param config 
- * @returns 
- */
-export 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 (getType(oldV) === 'object' && 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 (getType(oldV) === 'object' && 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 (getType(oldConfig) !== 'object' || getType(remoteConfig) !== 'object') return null;
-  var config = _extends({}, oldConfig);
-  // 先检查远程配置的，是否有需要将字符串格式化为正则的
-  toRegFormat(remoteConfig, REG_FORMAT_PATHS);
-  // 执行覆盖
-  doCover(config, remoteConfig);
-  // 执行补充
-  doSupplement(config, remoteConfig);
-  return config;
-}
-export default combineConfig;
+// import{ getType, toRegFormat} from './base';
+//
+//
+// // 需要检查是否需要字符串格式化为正则的配置路径
+// const REG_FORMAT_PATHS = [
+//   'filters.exception',
+//   'filters.resource',
+//   'tracing.allowedUrls.[].match'
+// ];
+//
+// export function isRemoteConfigEnable(config: any) {
+//   return config.remoteConfig === true ||
+//   (config.remoteConfig && config.remoteConfig.enable !== false);
+// }
+//
+// /**
+//  *
+//  * @param config
+//  * @returns
+//  */
+// export function getRemoteConfigUrl(config: any){
+//   if(config.remoteConfig && config.remoteConfig.url) {
+//     return config.remoteConfig.url;
+//   }
+//   const sereis = config.pid.split('@');
+//   if(!sereis || sereis.length<2) return;
+//   const 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: any ={}, remoteConfig: any ={}){
+//   for(const key in oldConfig) {
+//     if(key === 'pid' || key === 'endpoint') continue;
+//     if(remoteConfig?.[key] === undefined) continue;
+//     const oldV = oldConfig[key];
+//     const newV = remoteConfig?.[key];
+//     if(getType(oldV) === 'object' && getType(newV) === 'object') {
+//       doCover(oldV, newV);
+//     } else {
+//       oldConfig[key] = newV;
+//     }
+//   }
+// }
+//
+// /**
+//  *
+//  * @param oldConfig
+//  * @param remoteConfig
+//  */
+// function doSupplement(oldConfig: any ={}, remoteConfig: any ={}) {
+//   for(const key in remoteConfig) {
+//     if(oldConfig?.[key] === undefined) {
+//       oldConfig[key] = remoteConfig[key];
+//     } else {
+//       const oldV = oldConfig[key];
+//       const newV = remoteConfig[key];
+//       if(getType(oldV) === 'object' && getType(newV) === 'object') {
+//         doSupplement(oldV, newV);
+//       }
+//     }
+//   }
+// }
+//
+// /**
+//  *
+//  * @param oldConfig
+//  * @param remoteConfig
+//  * @returns config
+//  */
+// function combineConfig(oldConfig={}, remoteConfig=null) {
+//   if(!remoteConfig) return null;
+//   if(getType(oldConfig) !== 'object' || getType(remoteConfig) !== 'object') return null;
+//   const config = {...oldConfig};
+//   // 先检查远程配置的，是否有需要将字符串格式化为正则的
+//   toRegFormat(remoteConfig, REG_FORMAT_PATHS);
+//   // 执行覆盖
+//   doCover(config, remoteConfig);
+//   // 执行补充
+//   doSupplement(config, remoteConfig);
+//   return config;
+// }
+//
+//
+// export default combineConfig;

package/es/utils/match.d.ts

@@ -5,3 +5,9 @@ export declare function isMatchOption(item: unknown): item is MatchOption;
  */
 export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean, options?: unknown): boolean;
 export declare function urlMatch(url: string, list?: MatchOption | MatchOption[]): boolean;
+export interface IRule {
+    match: string;
+    match_exp: string;
+    [key: string]: unknown;
+}
+export declare function parseRule2Match(rule: IRule | MatchOption): MatchOption;

package/es/utils/match.js

@@ -1,5 +1,6 @@
 import { isArray, isFunction, isRegExp, isString } from "./is";
 import { startsWith } from "./polyfills";
+import { parseRegExpString } from "./base";
 export function isMatchOption(item) {
   return isString(item) || isFunction(item) || isRegExp(item);
 }
@@ -37,4 +38,37 @@ export function urlMatch(url, list) {
   } catch (e) {
     return false;
   }
+}
+export function parseRule2Match(rule) {
+  if (isMatchOption(rule)) {
+    return rule;
+  }
+  var match;
+  switch (rule.match_exp) {
+    case 'equals':
+      match = function match(value) {
+        return value === rule.match;
+      };
+      break;
+    case 'not_equals':
+      match = function match(value) {
+        return value !== rule.match;
+      };
+      break;
+    case 'regex':
+      match = parseRegExpString(rule.match);
+      break;
+    case 'includes':
+      match = function match(value) {
+        return value.includes(rule.match);
+      };
+      break;
+    case 'starts_with':
+    default:
+      match = function match(value) {
+        return startsWith(value, rule.match);
+      };
+      break;
+  }
+  return match;
 }

package/es/utils/trace.d.ts

@@ -1,8 +1,12 @@
 import { MatchOption } from "./match";
 export type PropagatorType = 'tracecontext' | 'b3' | 'b3multi' | 'jaeger' | 'sw8';
 export type TraceOption = {
+    enable?: boolean;
+    sampling?: number;
     match: MatchOption;
-    propagatorTypes: PropagatorType[];
+    propagatorTypes?: PropagatorType[];
+    baggage?: boolean;
+    tracestate?: boolean;
 };
 export declare function isTraceOption(option: any): option is TraceOption;
 export interface ITracingOption {

package/es/utils/url.d.ts

@@ -0,0 +1,2 @@
+export type UrlParams = Record<string, string | string[]>;
+export declare function getUrlParams(input: string): UrlParams;