@arms/rum-core 0.0.22 → 0.0.25-beta.11

package/lib/model/reporter.js

@@ -6,7 +6,7 @@ var _rumEvent = require("../types/rum-event");
 var _exception = require("../utils/exception");
 var _is = require("../utils/is");
 var FLUSH_TIME = 3000;
-var MAX_EVENT_COUNT = 50;
+var MAX_EVENT_COUNT = 20;
 var Reporter = exports["default"] = /*#__PURE__*/function () {
   function Reporter() {
     this.name = 'reporter';

package/lib/model/shell.d.ts

@@ -1,5 +1,5 @@
 import { IClient, IConfiguration } from "../types/client";
-import { RumEvent } from "../types/rum-event";
+import { RumCustomEvent, RumEvent, RumExceptionEvent, RumResourceEvent } from "../types/rum-event";
 import { IShell } from "../types/shell";
 export default abstract class Shell implements IShell {
     client: IClient;
@@ -19,7 +19,15 @@ export default abstract class Shell implements IShell {
     abstract setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
     abstract setConfig(value: IConfiguration): void;
     /**
-     * 自定义上传数据
+     * 自定义事件上报
      */
-    sendCustom(payload: RumEvent): void;
+    sendCustom(payload: RumCustomEvent): void;
+    /**
+     * 自定义异常上报
+     */
+    sendException(payload: RumExceptionEvent): void;
+    /**
+     * 自定义资源上报
+     */
+    sendResource(payload: RumResourceEvent): void;
 }

package/lib/model/shell.js

@@ -5,11 +5,12 @@ exports.__esModule = true;
 exports["default"] = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _rumEvent = require("../types/rum-event");
-var _rumCore = require("@arms/rum-core");
+var _client = _interopRequireDefault(require("../model/client"));
+var _is = require("../utils/is");
 var Shell = exports["default"] = /*#__PURE__*/function () {
   function Shell(config) {
     this.client = void 0;
-    this.client = new _rumCore.Client();
+    this.client = new _client["default"]();
     if (config && this.init) {
       this.init(config);
     }
@@ -38,7 +39,7 @@ var Shell = exports["default"] = /*#__PURE__*/function () {
    * set config
    */;
   /**
-   * 自定义上传数据
+   * 自定义事件上报
    */
   _proto.sendCustom = function sendCustom(payload) {
     if (!payload.name || !payload.type) {
@@ -49,5 +50,35 @@ var Shell = exports["default"] = /*#__PURE__*/function () {
     });
     this.sendEvent(data);
   };
+  /**
+   * 自定义异常上报
+   */
+  _proto.sendException = function sendException(payload) {
+    if (!payload.name || !payload.message) {
+      return;
+    }
+    var data = (0, _extends2["default"])({
+      times: 1
+    }, payload, {
+      event_type: _rumEvent.RumEventType.EXCEPTION,
+      type: 'custom',
+      source: 'custom'
+    });
+    this.sendEvent(data);
+  };
+  /**
+   * 自定义资源上报
+   */
+  _proto.sendResource = function sendResource(payload) {
+    if (!payload.name || !payload.type || !(0, _is.isNumber)(payload.duration)) {
+      return;
+    }
+    var data = (0, _extends2["default"])({
+      times: 1
+    }, payload, {
+      event_type: _rumEvent.RumEventType.RESOURCE
+    });
+    this.sendEvent(data);
+  };
   return Shell;
 }();

package/lib/types/client.d.ts

@@ -2,6 +2,7 @@ import { ICollector } from './collector';
 import { IProcessor } from './processor';
 import { IReporter } from './reporter';
 import { RumEvent, RumEventBundle, IViewData } from './rum-event';
+import { MatchOption } from "../utils/match";
 export declare enum EventType {
     /**
      * 收集数据
@@ -97,6 +98,16 @@ export interface IConfiguration {
     /**
      * 各个 collector config
      */
-    collectors?: any;
+    collectors?: {
+        [key: string]: unknown;
+    };
+    /**
+     * 事件过滤器配置
+     */
+    filters?: {
+        view?: MatchOption | MatchOption[];
+        resource?: MatchOption | MatchOption[];
+        exception?: MatchOption | MatchOption[];
+    };
     [key: string]: any;
 }

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

@@ -21,6 +21,7 @@ export interface RumBaseEvent {
     timestamp?: number;
     times?: number;
     view?: IViewData;
+    snapshots?: string;
     [key: string]: BaseObjectValue;
 }
 export interface RumViewEvent extends RumBaseEvent {
@@ -29,7 +30,9 @@ export interface RumViewEvent extends RumBaseEvent {
     largest_contentful_paint?: number;
     first_input_delay?: number;
     cumulative_layout_shift?: number;
+    first_input_time?: number;
     loading_time?: number;
+    first_paint?: number;
     first_contentful_paint?: number;
     dom_interactive?: number;
     dom_content_loaded?: number;
@@ -41,14 +44,13 @@ export interface RumViewEvent extends RumBaseEvent {
 }
 export interface RumResourceEvent extends RumBaseEvent {
     name?: string;
-    type: string;
+    type?: string;
     method?: string;
-    status_code?: number;
+    status_code?: number | string;
     message?: string;
-    success: 0 | 1;
-    provider_type?: string;
+    success?: -1 | 0 | 1;
     trace_id?: string;
-    duration: number;
+    duration?: number;
     size?: number;
     connect_duration?: number;
     ssl_duration?: number;
@@ -56,12 +58,13 @@ export interface RumResourceEvent extends RumBaseEvent {
     redirect_duration?: number;
     first_byte_duration?: number;
     download_duration?: number;
-    url: string;
+    url?: string;
     timing_data?: string;
+    tracing_data?: string;
 }
 export interface RumExceptionEvent extends RumBaseEvent {
     source?: string;
-    type?: 'crash' | 'cutsom' | 'error';
+    type?: 'crash' | 'custom' | 'error' | 'blank';
     name?: string;
     message?: string;
     file?: string;
@@ -83,7 +86,6 @@ export interface RumActionEvent extends RumBaseEvent {
     name?: string;
     target_name?: string;
     duration?: number;
-    snapshots?: string;
 }
 export interface RumCustomEvent extends RumBaseEvent {
     type: string;
@@ -99,9 +101,12 @@ export declare enum AppType {
 export interface RumEventBundle {
     app: {
         id: string;
-        env?: string;
-        version?: string;
         type: AppType;
+        name?: string;
+        version?: string;
+        channel?: string;
+        env?: string;
+        package?: string;
     };
     user: {
         id: string;
@@ -115,8 +120,35 @@ export interface RumEventBundle {
         id: string;
         name: string;
     };
+    device?: {
+        id?: string;
+        type?: string;
+        brand?: string;
+        model?: string;
+        name?: string;
+    };
+    os?: {
+        type?: string;
+        version?: string;
+        container?: string;
+        container_version?: string;
+    };
+    geo?: {
+        country?: string;
+        country_id?: string;
+        province?: string;
+        province_id?: string;
+        city?: string;
+        city_id?: string;
+    };
+    isp?: {
+        id?: string;
+        name?: string;
+    };
     net?: {
-        model: string;
+        model?: string;
+        name?: string;
     };
     events: Array<RumEvent>;
+    _v: string;
 }

package/lib/utils/base.d.ts

@@ -8,8 +8,33 @@ export declare function interceptFunction(target: any, name: string, callback: F
  */
 export declare function generateGUID(): string;
 /**
- * @description: 唯一的字符串 universe unique id
- * @param len {String}
+ * @description: 随机生成 traceId 或 sessionId
  * @return {String}
  */
-export declare function generateUUID(len?: number): string;
+export declare function generateTraceId(): string;
+/**
+ * @description: 随机生成 spanId
+ * @param len {number}
+ * @return {String}
+ */
+export declare function generateSpanId(len?: number): string;
+/**
+ * @description: 随机生成 eventId
+ * @param sessionId {string} sessionId
+ * @param sampled {boolean} 是否命中采样
+ * @param samplingType {string} 采样类型
+ * @return {String}
+ */
+export declare function generateEventId(sessionId: string, sampled?: boolean, samplingType?: string): string;
+/**
+ * @desc 函数防抖
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function debounce(func: Function, wait: number): () => void;
+/**
+ * @desc 函数延迟执行
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function delay(func: Function, wait: number, ...args: any[]): number;

package/lib/utils/base.js

@@ -1,9 +1,14 @@
 "use strict";
 
 exports.__esModule = true;
+exports.debounce = debounce;
+exports.delay = delay;
+exports.generateEventId = generateEventId;
 exports.generateGUID = generateGUID;
-exports.generateUUID = generateUUID;
+exports.generateSpanId = generateSpanId;
+exports.generateTraceId = generateTraceId;
 exports.interceptFunction = interceptFunction;
+var _is = require("./is");
 /**
  * 劫持函数
  */
@@ -13,9 +18,9 @@ function interceptFunction(target, name, callback) {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-    callback.apply(target, args);
+    callback.apply(this, args);
     if (registeredMethod) {
-      return registeredMethod.apply(target, args);
+      return registeredMethod.apply(this, args);
     }
   };
 }
@@ -42,24 +47,92 @@ function generateGUID() {
 }
 
 /**
- * @description: 唯一的字符串 universe unique id
- * @param len {String}
+ * @description: 随机生成 traceId 或 sessionId
  * @return {String}
  */
-function generateUUID(len) {
+function generateTraceId() {
+  var traceId = generateGUID().replace(/-/g, '');
+  // 适配OpenTracing 实现（long long转成16进制最高位不能为0）
+  if (traceId[0] === '0') {
+    traceId = '1' + traceId.substring(1);
+  }
+  if (traceId[16] === '0') {
+    traceId = traceId.substring(0, 16) + '1' + traceId.substring(17);
+  }
+  return traceId;
+}
+
+/**
+ * @description: 随机生成 spanId
+ * @param len {number}
+ * @return {String}
+ */
+function generateSpanId(len) {
   if (len === void 0) {
-    len = 8;
+    len = 16;
   }
-  var str = new Array(len);
-  var d = Date.now().toString(36).split('');
-  var r, c;
-  while (len-- > 0) {
-    r = Math.random() * 36 | 0;
-    c = r.toString(36);
-    str[len] = r % 3 ? c : c.toUpperCase();
+  var list = Array(len);
+  for (var i = 0; i < len; i++) {
+    list[i] = Math.floor(Math.random() * 16) + 48;
+    // valid hex characters in the range 48-57 and 97-102
+    if (list[i] >= 58) {
+      list[i] += 39;
+    }
+  }
+  return String.fromCharCode.apply(null, list);
+}
+
+/**
+ * @description: 随机生成 eventId
+ * @param sessionId {string} sessionId
+ * @param sampled {boolean} 是否命中采样
+ * @param samplingType {string} 采样类型
+ * @return {String}
+ */
+function generateEventId(sessionId, sampled, samplingType) {
+  if (sampled === void 0) {
+    sampled = true;
+  }
+  if (samplingType === void 0) {
+    samplingType = '0';
+  }
+  var spanId = generateSpanId();
+  return "00-" + sessionId + "-" + spanId + "-" + samplingType + (sampled ? '1' : '0');
+}
+
+/**
+ * @desc 函数防抖
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+function debounce(func, wait) {
+  var timer;
+  if (!(0, _is.isFunction)(func)) {
+    return;
+  }
+  return function () {
+    var context = this;
+    var args = arguments;
+    if (timer) {
+      clearTimeout(timer);
+    }
+    timer = setTimeout(function () {
+      func.apply(context, args);
+    }, wait);
+  };
+}
+
+/**
+ * @desc 函数延迟执行
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+function delay(func, wait) {
+  if (!(0, _is.isFunction)(func)) {
+    return;
   }
-  for (var i = 0; i < 8; i++) {
-    str.splice(i * 3 + 2, 0, d[i]);
+  for (var _len2 = arguments.length, args = new Array(_len2 > 2 ? _len2 - 2 : 0), _key2 = 2; _key2 < _len2; _key2++) {
+    args[_key2 - 2] = arguments[_key2];
   }
-  return str.join('');
+  return setTimeout.apply(void 0, [func, +wait || 0].concat(args));
 }

package/lib/utils/number.d.ts

@@ -4,3 +4,11 @@
  */
 export declare function performDraw(threshold: number): boolean;
 export declare function round(num: number, decimals: 0 | 1 | 2 | 3 | 4): number;
+/**
+ * 保留指定位数的小数
+ * @param num 原数据
+ * @param decimal 小数位数
+ * @param min 限制最小值，否则返回undefined
+ * @returns
+ */
+export declare function formatNumber(num: number, decimal?: number, min?: number): number;

package/lib/utils/number.js

@@ -1,6 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
+exports.formatNumber = formatNumber;
 exports.performDraw = performDraw;
 exports.round = round;
 /**
@@ -12,4 +13,32 @@ function performDraw(threshold) {
 }
 function round(num, decimals) {
   return +num.toFixed(decimals);
+}
+
+/**
+ * 保留指定位数的小数
+ * @param num 原数据
+ * @param decimal 小数位数
+ * @param min 限制最小值，否则返回undefined
+ * @returns
+ */
+function formatNumber(num, decimal, min) {
+  if (decimal === void 0) {
+    decimal = 3;
+  }
+  if (min === void 0) {
+    min = 0;
+  }
+  if (!num) {
+    return num;
+  }
+  var str = num.toString();
+  var index = str.indexOf('.');
+  if (index !== -1) {
+    str = str.substring(0, decimal + index + 1);
+  } else {
+    str = str.substring(0);
+  }
+  var result = parseFloat(str);
+  return result >= min ? result : undefined;
 }

package/lib/utils/polyfills.js

@@ -7,9 +7,9 @@ exports.find = find;
 exports.startsWith = startsWith;
 function find(array, predicate) {
   for (var i = 0; i < array.length; i += 1) {
-    var _item = array[i];
-    if (predicate(_item, i)) {
-      return _item;
+    var item = array[i];
+    if (predicate(item, i)) {
+      return item;
     }
   }
   return undefined;

package/lib/utils/trace.d.ts

@@ -13,8 +13,6 @@ export interface ITracingOption {
     tracestate?: boolean;
     baggage?: boolean;
 }
-export declare function generateTraceId(): string;
-export declare function generateSpanId(): any;
 export interface ITracingHeaders {
     [key: string]: string;
 }

package/lib/utils/trace.js

@@ -1,40 +1,15 @@
 "use strict";
 
 exports.__esModule = true;
-exports.generateSpanId = generateSpanId;
-exports.generateTraceId = generateTraceId;
 exports.isTraceOption = isTraceOption;
 exports.makeTracingHeaders = makeTracingHeaders;
 exports.parseTracingOptions = parseTracingOptions;
 var _match = require("./match");
 var _is = require("./is");
-var _base = require("./base");
 var _jsBase = require("js-base64");
 function isTraceOption(option) {
   return option && (0, _match.isMatchOption)(option.match) && (0, _is.isArray)(option.propagatorTypes);
 }
-function generateTraceId() {
-  var traceId = (0, _base.generateGUID)().replace(/-/g, '');
-  // 适配OpenTracing 实现（long long转成16进制最高位不能为0）
-  if (traceId[0] === '0') {
-    traceId = '1' + traceId.substring(1);
-  }
-  if (traceId[16] === '0') {
-    traceId = traceId.substring(0, 16) + '1' + traceId.substring(17);
-  }
-  return traceId;
-}
-function generateSpanId() {
-  var list = Array(16);
-  for (var i = 0; i < 16; i++) {
-    list[i] = Math.floor(Math.random() * 16) + 48;
-    // valid hex characters in the range 48-57 and 97-102
-    if (list[i] >= 58) {
-      list[i] += 39;
-    }
-  }
-  return String.fromCharCode.apply(null, list);
-}
 function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, subOption) {
   if (subOption === void 0) {
     subOption = {};

package/package.json

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