@arms/rum-core 0.0.25-beta.14 → 0.0.25-beta.16

package/{lib/index.d.ts → es/index.js}

@@ -14,4 +14,4 @@ export * from './utils/is';
 export * from './utils/number';
 export * from './utils/match';
 export * from './utils/trace';
-export { Client, Context, Reporter, Shell };
+export { Client, Context, Reporter, Shell };

package/es/model/client.js

@@ -0,0 +1,73 @@
+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; }
+import { EventType } from '../types/client';
+import { EventEmitter } from 'events';
+import Context from './context';
+import { isFunction } from "../utils/is";
+var Client = /*#__PURE__*/function () {
+  function Client() {
+    var _this = this;
+    this.emitter = new EventEmitter();
+    this.collectors = void 0;
+    this.processors = void 0;
+    this.reporter = void 0;
+    this.ctx = void 0;
+    this.sendEvent = function (payload) {
+      _this.emitter.emit(EventType.collect, payload);
+    };
+  }
+  var _proto = Client.prototype;
+  _proto.init = function init(config, rumSession) {
+    var _this2 = this;
+    this.ctx = new Context(config, rumSession);
+    var ctx = this.ctx,
+      collectors = this.collectors,
+      processors = this.processors,
+      reporter = this.reporter;
+    processors.forEach(function (processor) {
+      isFunction(processor.setup) && processor.setup(ctx);
+    });
+
+    // collector 收集数据统一 push 到各匹配 processor
+    this.emitter.on(EventType.collect, function (payload) {
+      ctx.setRumEvent(payload);
+      for (var _iterator = _createForOfIteratorHelperLoose(processors), _step; !(_step = _iterator()).done;) {
+        var processor = _step.value;
+        // default match return true
+        if (!processor.match) {
+          processor.match = function () {
+            return true;
+          };
+        }
+        if (processor.match(ctx)) {
+          var res = processor.process(ctx);
+          if (res) {
+            ctx.setRumEvent(res);
+          }
+        }
+      }
+      reporter.report(ctx);
+    });
+    collectors.forEach(function (collector) {
+      collector.setup(ctx, _this2.sendEvent);
+    });
+  };
+  _proto.setContext = function setContext(ctx) {
+    this.ctx = ctx;
+  };
+  _proto.getContext = function getContext() {
+    return this.ctx;
+  };
+  _proto.useCollectors = function useCollectors(collectors) {
+    this.collectors = collectors;
+  };
+  _proto.useProcessors = function useProcessors(processors) {
+    this.processors = processors;
+  };
+  _proto.useReporter = function useReporter(reporter) {
+    this.reporter = reporter;
+  };
+  return Client;
+}();
+export default Client;

package/es/model/context.js

@@ -0,0 +1,38 @@
+var Context = /*#__PURE__*/function () {
+  function Context(config, rumSession) {
+    this.config = config;
+    this.rumEvent = void 0;
+    this.views = [];
+    this.session = void 0;
+    if (rumSession) {
+      this.session = rumSession;
+      this.session.init(config);
+    }
+  }
+  var _proto = Context.prototype;
+  _proto.getConfig = function getConfig() {
+    return this.config;
+  };
+  _proto.setConfig = function setConfig(config) {
+    this.config = config;
+  };
+  _proto.getViews = function getViews() {
+    return this.views;
+  };
+  _proto.addView = function addView(view) {
+    this.views.push(view);
+  };
+  _proto.removeView = function removeView(viewId) {
+    this.views = this.views.filter(function (view) {
+      return view.id !== viewId;
+    });
+  };
+  _proto.getRumEvent = function getRumEvent() {
+    return this.rumEvent;
+  };
+  _proto.setRumEvent = function setRumEvent(rumEvent) {
+    this.rumEvent = rumEvent;
+  };
+  return Context;
+}();
+export default Context;

package/es/model/reporter.js

@@ -0,0 +1,131 @@
+import { RumEventType } from '../types/rum-event';
+import { getErrorID } from '../utils/exception';
+import { isObject } from "../utils/is";
+var FLUSH_TIME = 3000;
+var MAX_EVENT_COUNT = 20;
+var Reporter = /*#__PURE__*/function () {
+  function Reporter() {
+    this.name = 'reporter';
+    /**
+     * 新上报事件优先检测队列是否超过 50 条，如果超过立即 report。
+     * 如果没超过则检测 FlushTime 内有无新上报事件，如果有新事件，重置 timer，无则 report
+     */
+    this.eventQueue = [];
+    this.ctx = void 0;
+    this.timer = void 0;
+  }
+  var _proto = Reporter.prototype;
+  _proto.getReportCfg = function getReportCfg() {
+    var cfg = this.ctx.getConfig().reportConfig;
+    if (!isObject(cfg)) {
+      cfg = {};
+    }
+    if (!cfg.flushTime || cfg.flushTime < 0 || cfg.flushTime > 10000) {
+      cfg.flushTime = FLUSH_TIME;
+    }
+    if (!cfg.maxEventCount || cfg.maxEventCount < 1 || cfg.maxEventCount > 100) {
+      cfg.maxEventCount = MAX_EVENT_COUNT;
+    }
+    return cfg;
+  };
+  _proto.report = function report(ctx) {
+    var _this = this;
+    this.ctx = ctx;
+    this.init(ctx);
+    clearTimeout(this.timer);
+    this.pushToQueue();
+    var reportConfig = this.getReportCfg();
+    // 超过 MaxCount 直接 flush，否则延迟发送
+    if (this.eventQueue.length >= reportConfig.maxEventCount) {
+      this.flushEventQueue();
+    } else {
+      this.timer = setTimeout(function () {
+        _this.flushEventQueue();
+      }, reportConfig.flushTime);
+    }
+  };
+  _proto.pushToQueue = function pushToQueue() {
+    var ctx = this.ctx,
+      eventQueue = this.eventQueue;
+    var event = ctx.getRumEvent();
+
+    // 针对相同 event，做 times 合并
+    // todo，支持其他类型 event 合并
+    if (event.event_type === RumEventType.EXCEPTION) {
+      var _ref = event,
+        message = _ref.message,
+        stack = _ref.stack;
+      var curErrorId = getErrorID({
+        message: message,
+        stack: stack
+      });
+      var targetEvent = this.eventQueue.find(function (cacheEvent) {
+        if (cacheEvent.event_type === RumEventType.EXCEPTION) {
+          var _ref2 = cacheEvent,
+            _message = _ref2.message,
+            _stack = _ref2.stack;
+          return getErrorID({
+            message: _message,
+            stack: _stack
+          }) === curErrorId;
+        }
+      });
+      if (targetEvent) {
+        targetEvent.times++;
+        return;
+      }
+    }
+    if (event.event_type === RumEventType.ACTION) {
+      var _ref3 = event,
+        target_name = _ref3.target_name;
+      var _targetEvent = this.eventQueue.find(function (cacheEvent) {
+        if (cacheEvent.event_type === RumEventType.ACTION) {
+          return target_name === cacheEvent.target_name;
+        }
+      });
+      if (_targetEvent) {
+        _targetEvent.times++;
+        return;
+      }
+    }
+    eventQueue.push(event);
+  }
+
+  /**
+   * eventQueue 提取最新 View 作为公共 View，event 中不同 View Event 保留 View id
+   */;
+  _proto.flushEventQueue = function flushEventQueue() {
+    var ctx = this.ctx,
+      eventQueue = this.eventQueue;
+    if (!eventQueue.length) {
+      return;
+    }
+    var views = ctx.getViews();
+    var curView = views[views.length - 1];
+    views.forEach(function (view) {
+      if (view.id === curView.id) {
+        var _events = eventQueue.filter(function (event) {
+          var _event$view;
+          return ((_event$view = event.view) === null || _event$view === void 0 ? void 0 : _event$view.id) === view.id;
+        });
+        _events.forEach(function (event) {
+          delete event.view;
+        });
+      }
+    });
+    var session = ctx.session;
+    var sampled = session ? session.getSampled() : true;
+    sampled && this.request(ctx, eventQueue, curView);
+    this.eventQueue = [];
+  }
+
+  /**
+   * 接口请求由各平台 sdk reporter 实现
+   */;
+  /**
+   * 初始化时
+   */
+  _proto.init = function init(ctx) {};
+  return Reporter;
+}();
+export { Reporter as default };

package/es/model/shell.js

@@ -0,0 +1,80 @@
+import _extends from "@babel/runtime/helpers/extends";
+import { RumEventType } from "../types/rum-event";
+import Client from '../model/client';
+import { isNumber } from "../utils/is";
+var Shell = /*#__PURE__*/function () {
+  function Shell(config) {
+    this.client = void 0;
+    this.client = new Client();
+    if (config && this.init) {
+      this.init(config);
+    }
+  }
+
+  /**
+   * 初始化
+   */
+  var _proto = Shell.prototype;
+  _proto.sendEvent = function sendEvent(payload) {
+    if (this.client) {
+      this.client.sendEvent(payload);
+    }
+  }
+
+  /**
+   * get config
+   */;
+  _proto.getConfig = function getConfig() {
+    if (this.client) {
+      return this.client.getContext().getConfig();
+    }
+  }
+
+  /**
+   * set config
+   */;
+  /**
+   * 自定义事件上报
+   */
+  _proto.sendCustom = function sendCustom(payload) {
+    if (!payload.name || !payload.type) {
+      return;
+    }
+    var data = _extends({}, payload, {
+      event_type: RumEventType.CUSTOM
+    });
+    this.sendEvent(data);
+  };
+  /**
+   * 自定义异常上报
+   */
+  _proto.sendException = function sendException(payload) {
+    if (!payload.name || !payload.message) {
+      return;
+    }
+    var data = _extends({
+      times: 1
+    }, payload, {
+      event_type: RumEventType.EXCEPTION,
+      type: 'custom',
+      source: 'custom'
+    });
+    this.sendEvent(data);
+  };
+  /**
+   * 自定义资源上报
+   */
+  _proto.sendResource = function sendResource(payload) {
+    if (!payload.name || !payload.type || !isNumber(payload.duration)) {
+      return;
+    }
+    var data = _extends({
+      times: 1
+    }, payload, {
+      event_type: RumEventType.RESOURCE
+    });
+    this.sendEvent(data);
+  };
+  return Shell;
+}();
+export { Shell as default };

package/es/style.js

@@ -0,0 +1 @@
+//empty file

package/es/types/client.js

@@ -0,0 +1,4 @@
+export var EventType = /*#__PURE__*/function (EventType) {
+  EventType["collect"] = "collect";
+  return EventType;
+}({});

package/es/types/collector.js

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

package/es/types/processor.js

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

package/es/types/reporter.js

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

package/es/types/rum-event.js

@@ -0,0 +1,24 @@
+export var RumEventType = /*#__PURE__*/function (RumEventType) {
+  RumEventType["VIEW"] = "view";
+  RumEventType["RESOURCE"] = "resource";
+  RumEventType["EXCEPTION"] = "exception";
+  RumEventType["LONG_TASK"] = "longtask";
+  RumEventType["ACTION"] = "action";
+  RumEventType["CUSTOM"] = "custom";
+  return RumEventType;
+}({});
+/**
+ * 枚举值，表示资源是否加载成功
+ */
+export var ResourceStatus = /*#__PURE__*/function (ResourceStatus) {
+  ResourceStatus[ResourceStatus["Unknown"] = -1] = "Unknown";
+  ResourceStatus[ResourceStatus["Failed"] = 0] = "Failed";
+  ResourceStatus[ResourceStatus["Success"] = 1] = "Success";
+  return ResourceStatus;
+}({});
+export var AppType = /*#__PURE__*/function (AppType) {
+  AppType["browser"] = "browser";
+  AppType["miniapp"] = "miniapp";
+  AppType["uniapp"] = "uniapp";
+  return AppType;
+}({});

package/es/types/shell.js

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

package/es/utils/base.js

@@ -0,0 +1,131 @@
+import { isFunction } from "./is";
+
+/**
+ * 劫持函数
+ */
+export function interceptFunction(target, name, callback) {
+  var registeredMethod = target[name];
+  target[name] = function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    callback.apply(this, args);
+    if (registeredMethod) {
+      return registeredMethod.apply(this, args);
+    }
+  };
+}
+
+/**
+ * @description: GUID v4
+ * @return {String}
+ */
+export function generateGUID() {
+  var guid = '';
+  try {
+    if (crypto && crypto.randomUUID) {
+      guid = crypto.randomUUID();
+    } else if (crypto && crypto.getRandomValues) {
+      var buf = new Uint8Array(16);
+      crypto.getRandomValues(buf);
+      buf[6] = buf[6] & 0x0f | 0x40; // version 4 UUID
+      buf[8] = buf[8] & 0x3f | 0x80; // variant 10xxxxxx
+      guid = buf.reduce(function (str, _byte) {
+        return str + _byte.toString(16).padStart(2, '0');
+      }, '').replace(/^(.{8})(.{4})(.{4})(.{4})(.{12})$/, '\$1-\$2-\$3-\$4-\$5');
+    }
+  } catch (e) {
+    //
+  }
+  if (!guid) {
+    guid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = Math.random() * 16 | 0,
+        v = c == 'x' ? r : r & 0x3 | 0x8;
+      return v.toString(16);
+    });
+  }
+  return guid;
+}
+
+/**
+ * @description: 随机生成 traceId 或 sessionId
+ * @return {String}
+ */
+export 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}
+ * @param radix {number}
+ * @return {String}
+ */
+export function generateSpanId(len, radix) {
+  if (len === void 0) {
+    len = 16;
+  }
+  if (radix === void 0) {
+    radix = 16;
+  }
+  var result = '';
+  for (var i = 0; i < len; i++) {
+    result += Math.floor(Math.random() * radix).toString(radix);
+  }
+  return result;
+}
+
+/**
+ * @description: 随机生成 eventId
+ * @param sessionId {string} sessionId
+ * @return {String}
+ */
+export function generateEventId(sessionId) {
+  var spanId = generateSpanId();
+  return "00-" + sessionId + "-" + spanId;
+}
+
+/**
+ * @desc 函数防抖
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export function debounce(func, wait) {
+  var timer;
+  if (!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 延迟执行毫秒数
+ */
+export function delay(func, wait) {
+  if (!isFunction(func)) {
+    return;
+  }
+  for (var _len2 = arguments.length, args = new Array(_len2 > 2 ? _len2 - 2 : 0), _key2 = 2; _key2 < _len2; _key2++) {
+    args[_key2 - 2] = arguments[_key2];
+  }
+  return setTimeout.apply(void 0, [func, +wait || 0].concat(args));
+}

package/es/utils/exception.js

@@ -0,0 +1,10 @@
+/**
+ * 获取错误对象唯一标识
+ */
+export var getErrorID = function getErrorID(error) {
+  var _error$message = error.message,
+    message = _error$message === void 0 ? '' : _error$message,
+    _error$stack = error.stack,
+    stack = _error$stack === void 0 ? '' : _error$stack;
+  return message + stack;
+};

package/es/utils/is.js

@@ -0,0 +1,33 @@
+export function isTypeof(value, type) {
+  return typeof value === type;
+}
+export var isFunction = function isFunction(func) {
+  return typeof func === 'function';
+};
+export var isUndefined = function isUndefined(value) {
+  return isTypeof(value, 'undefined');
+};
+export var isString = function isString(value) {
+  return isTypeof(value, 'string');
+};
+export function isToString(value, type) {
+  return Object.prototype.toString.call(value) === "[object " + type + "]";
+}
+export var isArray = function isArray(value) {
+  return isToString(value, 'Array');
+};
+export var isRegExp = function isRegExp(value) {
+  return isToString(value, 'RegExp');
+};
+export var isBoolean = function isBoolean(value) {
+  return isTypeof(value, 'boolean');
+};
+export var isNumber = function isNumber(value) {
+  return isTypeof(value, 'number') && !isNaN(value) || isTypeof(value, 'bigint');
+};
+export var isNull = function isNull(value) {
+  return isTypeof(value, 'null');
+};
+export var isObject = function isObject(value) {
+  return !isNull(value) && isTypeof(value, 'object');
+};

package/es/utils/match.js

@@ -0,0 +1,37 @@
+import { isFunction, isRegExp, isString } from "./is";
+import { startsWith } from "./polyfills";
+export function isMatchOption(item) {
+  return isString(item) || isFunction(item) || isRegExp(item);
+}
+
+/**
+ * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
+ */
+export function matchList(list, value, useStartsWith) {
+  if (useStartsWith === void 0) {
+    useStartsWith = true;
+  }
+  return list.some(function (item) {
+    try {
+      if (typeof item === 'function') {
+        return item(value);
+      } else if (item instanceof RegExp) {
+        return item.test(value);
+      } else if (typeof item === 'string') {
+        return useStartsWith ? startsWith(value, item) : item === value;
+      }
+    } catch (e) {}
+    return false;
+  });
+}
+export function urlMatch(url, list) {
+  if (list === void 0) {
+    list = [];
+  }
+  try {
+    var rules = [/https?:\/\/.*rum|retcode\.aliyuncs\.com/, /https?:\/\/.*log-global\.aliyuncs\.com/, /https?:\/\/.*\.mmstat\.com/].concat(list);
+    return matchList(rules, url);
+  } catch (e) {
+    return false;
+  }
+}

package/es/utils/number.js

@@ -0,0 +1,40 @@
+export var ONE_SECOND = 1e3;
+export var ONE_MINUTE = 60 * ONE_SECOND;
+export var ONE_HOUR = 60 * ONE_MINUTE;
+export var ONE_DAY = 24 * ONE_HOUR;
+
+/**
+ * Return true if the draw is successful
+ * @param threshold between 0 and 100
+ */
+export function performDraw(threshold) {
+  return threshold !== 0 && Math.random() * 100 <= threshold;
+}
+
+/**
+ * 保留指定位数的小数
+ * @param num 原数据
+ * @param decimal 小数位数
+ * @param min 限制最小值，否则返回undefined
+ * @returns
+ */
+export 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/es/utils/polyfills.js

@@ -0,0 +1,28 @@
+export function find(array, predicate) {
+  for (var i = 0; i < array.length; i += 1) {
+    var item = array[i];
+    if (predicate(item, i)) {
+      return item;
+    }
+  }
+  return undefined;
+}
+export function startsWith(candidate, search) {
+  return candidate.slice(0, search.length) === search;
+}
+export function endsWith(candidate, search) {
+  return candidate.slice(-search.length) === search;
+}
+export function assign(target) {
+  for (var _len = arguments.length, toAssign = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+    toAssign[_key - 1] = arguments[_key];
+  }
+  toAssign.forEach(function (source) {
+    for (var _key2 in source) {
+      if (Object.prototype.hasOwnProperty.call(source, _key2)) {
+        target[_key2] = source[_key2];
+      }
+    }
+  });
+  return target;
+}