@arms/rum-core 0.1.1 → 0.1.3

package/lib/model/context.d.ts

@@ -1,10 +1,12 @@
 import { IConfiguration, IContext, IRumSession } from "../types/client";
 import { RumEvent, IViewData } from "../types/rum-event";
 import { IConfigManager } from "../types/config";
+import { EventEmitter } from "../utils/events";
 declare class Context implements IContext {
     private config;
     private rumEvent;
     private views;
+    emitter: EventEmitter;
     session: IRumSession;
     configManager: IConfigManager;
     constructor(config: IConfiguration, rumSession?: IRumSession, configManager?: IConfigManager);

package/lib/model/context.js

@@ -2,11 +2,13 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
+var _events = require("../utils/events");
 var Context = /*#__PURE__*/function () {
   function Context(config, rumSession, configManager) {
     this.config = config;
     this.rumEvent = void 0;
     this.views = [];
+    this.emitter = new _events.EventEmitter();
     this.session = void 0;
     this.configManager = void 0;
     if (rumSession) {

package/lib/model/reporter.js

@@ -198,8 +198,8 @@ var Reporter = exports["default"] = /*#__PURE__*/function () {
         _reportConfig$maxRetr,
         _reportConfig$retryDe,
         _this2 = this;
-      var reportConfig, maxRetryCount, retryDelay;
-      return _regenerator["default"].wrap(function _callee$(_context) {
+      var reportConfig, maxRetryCount, retryDelay, _t;
+      return _regenerator["default"].wrap(function (_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             if (retry === void 0) {
@@ -208,26 +208,26 @@ var Reporter = exports["default"] = /*#__PURE__*/function () {
             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;
+            _context.prev = 1;
             bundle._retry = retry;
-            _context.next = 8;
+            _context.next = 2;
             return this.request(this.ctx, bundle);
-          case 8:
-            _context.next = 13;
+          case 2:
+            _context.next = 4;
             break;
-          case 10:
-            _context.prev = 10;
-            _context.t0 = _context["catch"](4);
+          case 3:
+            _context.prev = 3;
+            _t = _context["catch"](1);
             if (retry < maxRetryCount - 1) {
               setTimeout(function () {
                 return _this2.tryRequest(bundle, retry + 1);
               }, retryDelay);
             }
-          case 13:
+          case 4:
           case "end":
             return _context.stop();
         }
-      }, _callee, this, [[4, 10]]);
+      }, _callee, this, [[1, 3]]);
     }));
     function tryRequest(_x, _x2) {
       return _tryRequest.apply(this, arguments);

package/lib/model/shell.js

@@ -7,57 +7,33 @@ 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");
-// import combineConfig, { isRemoteConfigEnable, getRemoteConfigUrl } from "../utils/combineConfig";
 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()
+      // }
     }
   }
 
-  // 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;
+  // private shellReady = () => {
+  //   this.initialized = true;
+  //   this.callbacks.forEach(cb => cb());
   // }
   //
-  // 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);
-  //         }
-  //       });
-  //     });
+  // onReady(callback: Function) {
+  //   if (this.initialized) {
+  //     callback();
   //   }
+  //   this.callbacks.push(callback);
   // }
 
   /**
@@ -79,21 +55,6 @@ var Shell = exports["default"] = /*#__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
    */;

package/lib/types/client.d.ts

@@ -2,8 +2,9 @@ import { ICollector } from './collector';
 import { IProcessor } from './processor';
 import { IReporter } from './reporter';
 import { RumEvent, RumEventBundle, IViewData } from './rum-event';
-import { MatchOption } from "../utils/match";
-import { IConfigManager } from "./config";
+import { MatchOption } from '../utils/match';
+import { IConfigManager } from './config';
+import { EventEmitter } from '../utils/events';
 export declare enum EventType {
     /**
      * 收集数据
@@ -12,6 +13,7 @@ export declare enum EventType {
 }
 export interface IContext {
     session: IRumSession;
+    emitter: EventEmitter;
     /**
      * user config
      */
@@ -90,7 +92,7 @@ export interface IRemoteConfig {
     [key: string]: unknown;
 }
 export interface ICollectorConfig {
-    name: string;
+    name?: string;
     enable?: boolean;
     sampling?: number;
     filters?: MatchOption[];
@@ -218,5 +220,12 @@ export interface IConfiguration {
      * 检测正则匹配内容
      */
     regexp?: string;
+    /**
+     * 检测元素是否包含特定属性或者属性值的元素，支持正则匹配
+     */
+    attributeRules?: Array<{
+        attributeName: string;
+        attributeValue?: Array<string | RegExp> | null;
+    }>;
     [key: string]: unknown;
 }

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

@@ -10,9 +10,11 @@ export declare enum RumEventType {
 export interface BaseObject {
     [key: string]: BaseObjectValue;
 }
-export interface IViewData {
+export type loading_type = 'initial_load' | 'route_change';
+export interface IViewData extends BaseObject {
     id: string;
     name: string;
+    loading_type?: loading_type;
 }
 export type BaseObjectPrimitiveValue = string | number | boolean | null | undefined;
 export type BaseObjectValue = BaseObjectPrimitiveValue | BaseObject | BaseObjectPrimitiveValue[] | IViewData;
@@ -26,27 +28,64 @@ export interface RumBaseEvent extends BaseObject {
     snapshots?: string;
     properties?: BaseObject;
 }
+/** 事件类型：页面浏览、性能指标、Web Vitals、自定义指标、会话回放 */
+export type view_type = 'pv' | 'perf' | 'webvitals' | 'custom' | 'replay' | 'view-stats';
 export interface RumViewEvent extends RumBaseEvent {
-    loading_type?: 'initial_load' | 'route_change';
-    type: 'pv' | 'perf' | 'webvitals' | 'custom';
+    /** 页面加载类型：初始加载或路由切换 */
+    loading_type?: loading_type;
+    type: view_type;
+    /** 最大内容绘制时间 (LCP) - 页面加载过程中最大文本块或图像元素的渲染时间 */
     largest_contentful_paint?: number;
+    /** 首次输入延迟 (FID) - 用户首次与页面交互到浏览器响应该交互的时间 */
     first_input_delay?: number;
+    /** 累积布局偏移 (CLS) - 页面可见元素意外移动的累积分数 */
     cumulative_layout_shift?: number;
+    /** 首次输入时间 (FIT) - 用户首次与页面交互的时间戳 */
     first_input_time?: number;
+    /** 页面加载时间 - 从开始加载到页面完全加载的时间 */
     loading_time?: number;
+    /** 首次绘制时间 (FP) - 浏览器首次渲染任何内容的时间 */
     first_paint?: number;
+    /** 首次内容绘制时间 (FCP) - 浏览器首次渲染DOM内容的时间 */
     first_contentful_paint?: number;
+    /** DOM 交互时间 - DOM 构建完成且脚本开始执行的时间 */
     dom_interactive?: number;
+    /** DOM 内容加载完成时间 - DOM 和所有子资源加载完成的时间 */
     dom_content_loaded?: number;
+    /** DOM 完成时间 - 页面及其所有资源加载完成的时间 */
     dom_complete?: number;
+    /** 加载事件时间 - load 事件触发的时间 */
     load_event?: number;
+    /** 自定义性能指标 T1 */
     t1?: number;
+    /** 自定义性能指标 T2 */
     t2?: number;
+    /** 自定义性能指标 T3 */
     t3?: number;
+    /** 来源页面 URL */
     referrer?: string;
+    /** 当前页面 URL */
     url?: string;
+    /** 性能时序数据 (JSON 字符串格式) */
     timing_data?: string;
 }
+export interface RumReplayEvent extends RumBaseEvent {
+    type: 'replay';
+    /** 当前Records记录的结束时间 */
+    records_end?: number;
+    /** 会话回放片段索引 */
+    records_index?: number;
+    /** 当前会话包含的record数量 */
+    records_count?: number;
+    /** 创建record原因 */
+    records_reason?: string;
+    /** 包含的replay数据大小 */
+    records_size?: number;
+    /** 是否包含完整的Snapshot */
+    has_full_snapshot?: number;
+    /** 上报的录屏数据 */
+    records_data?: string;
+}
 /**
  * 枚举值，表示资源是否加载成功
  */
@@ -96,10 +135,43 @@ export interface RumLongTaskEvent extends RumBaseEvent {
     snapshots: string;
 }
 export interface RumActionEvent extends RumBaseEvent {
+    event_type: RumEventType.ACTION;
+    /** 行为类型 */
     type?: string;
+    /** 行为名称 */
     name?: string;
+    /** 目标元素名称XPath */
     target_name?: string;
+    /** 操作持续时间（毫秒） */
     duration?: number;
+    /**
+     * Heatmap Analysis - 热力图分析
+     * 当 trackUserInteractions 开启时才会采集以下数据
+     * */
+    /** 点击位置信息 */
+    position?: {
+        /** 点击 X 坐标（相对于文档） */
+        x?: number;
+        /** 点击 Y 坐标（相对于文档） */
+        y?: number;
+        /** 元素内相对 X 坐标 */
+        ex?: number;
+        /** 元素内相对 Y 坐标 */
+        ey?: number;
+    };
+    /** 目标元素信息 */
+    target?: {
+        /** 元素的 selector：#root > div > button:nth-child(15) */
+        selector?: string;
+        /** 元素的宽度（像素） */
+        width?: number;
+        /** 元素的高度（像素） */
+        height?: number;
+        /** 是否为可交互元素（0=不可交互, 1=可交互），用于无效点击分析 */
+        reaction?: number;
+        /** 是否可信的交互（0=不可信, 1=可信），用于错误点击分析 */
+        trust?: number;
+    };
 }
 export interface RumCustomEvent extends RumBaseEvent {
     type: string;

package/lib/types/rum-event.js

@@ -12,6 +12,7 @@ var RumEventType = exports.RumEventType = /*#__PURE__*/function (RumEventType) {
   RumEventType["APPLICATION"] = "application";
   return RumEventType;
 }({});
+/** 事件类型：页面浏览、性能指标、Web Vitals、自定义指标、会话回放 */
 /**
  * 枚举值，表示资源是否加载成功
  */

package/lib/utils/base.d.ts

@@ -41,17 +41,6 @@ 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;
 /**
  * 解析正则表达式字符串，支持 /pattern/flags 格式
  * @param str 正则表达式字符串，如 "/a/ig" 或 "a"

package/lib/utils/base.js

@@ -7,15 +7,10 @@ exports.generateEventId = generateEventId;
 exports.generateGUID = generateGUID;
 exports.generateSpanId = generateSpanId;
 exports.generateTraceId = generateTraceId;
-exports.getType = getType;
 exports.interceptFunction = interceptFunction;
 exports.parseRegExpString = parseRegExpString;
 exports.restoreFunction = restoreFunction;
-exports.transStrToReg = transStrToReg;
 var _is = require("./is");
-// 类型匹配正则
-var TYPE_REG = /^\[object ([a-z]*)\]$/;
-
 /**
  * 劫持函数或原型
  */
@@ -163,30 +158,32 @@ function delay(func, wait) {
   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;
-}
-
+// // 类型匹配正则
+// const TYPE_REG = /^\[object ([a-z]*)\]$/;
+// /**
+//  * @desc 需要严格区分object和array
+//  * @param obj 任意对象
+//  */
+// export function getType(obj: any) {
+//   let type = Object.prototype.toString.call(obj);
+//   type = type.toLowerCase() || '';
+//   const arr = type.match(TYPE_REG);
+//   return arr?.[1];
+// }
+//
+// /**
+//  * @desc 将字符串转换成正则表达式
+//  * @param str 任意字符串
+//  * 注意，这里只支持 /xxx/ 这种格式，不支持修饰符，例如 /xxx/ig
+//  */
+// export function transStrToReg(str: string) {
+//   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 配置

package/lib/utils/events.d.ts

@@ -1,4 +1,4 @@
-type EventHandler = (...args: any[]) => void;
+export type EventHandler = (...args: any[]) => void;
 export declare class EventEmitter {
     private events;
     /**
@@ -26,4 +26,3 @@ export declare class EventEmitter {
      */
     once(eventName: string, handler: EventHandler): void;
 }
-export {};

package/package.json

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

package/es/utils/combineConfig.js

@@ -1,89 +0,0 @@
-// 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/lib/utils/combineConfig.js

@@ -1,90 +0,0 @@
-// 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;
-"use strict";