@arms/rum-core 0.0.34 → 0.0.36

package/es/index.d.ts

@@ -0,0 +1,18 @@
+import Client from './model/client';
+import Context from './model/context';
+import Reporter from './model/reporter';
+import Shell from './model/shell';
+export * from './types/client';
+export * from './types/collector';
+export * from './types/processor';
+export * from './types/reporter';
+export * from './types/rum-event';
+export * from './types/shell';
+export * from './utils/base';
+export * from './utils/polyfills';
+export * from './utils/is';
+export * from './utils/number';
+export * from './utils/match';
+export * from './utils/trace';
+export * from './utils/verify';
+export { Client, Context, Reporter, Shell };

package/es/index.js

@@ -0,0 +1,18 @@
+import Client from './model/client';
+import Context from './model/context';
+import Reporter from './model/reporter';
+import Shell from './model/shell';
+export * from './types/client';
+export * from './types/collector';
+export * from './types/processor';
+export * from './types/reporter';
+export * from './types/rum-event';
+export * from './types/shell';
+export * from './utils/base';
+export * from './utils/polyfills';
+export * from './utils/is';
+export * from './utils/number';
+export * from './utils/match';
+export * from './utils/trace';
+export * from './utils/verify';
+export { Client, Context, Reporter, Shell };

package/es/model/client.d.ts

@@ -0,0 +1,21 @@
+import { IClient, IConfiguration, IContext, IRumSession } from '../types/client';
+import { RumEvent } from '../types/rum-event';
+import { IProcessor } from '../types/processor';
+import { ICollector } from '../types/collector';
+import { IReporter } from '../types/reporter';
+declare class Client implements IClient {
+    private emitter;
+    private collectors;
+    private processors;
+    private reporter;
+    private ctx;
+    init(config: IConfiguration, rumSession?: IRumSession): void;
+    sendEvent: (payload: RumEvent) => void;
+    setContext(ctx: IContext): void;
+    getContext(): IContext;
+    useCollectors(collectors: ICollector[]): void;
+    getCollectors(): ICollector[];
+    useProcessors(processors: IProcessor[]): void;
+    useReporter(reporter: IReporter): void;
+}
+export default Client;

package/es/model/client.js

@@ -0,0 +1,76 @@
+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; }
+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.getCollectors = function getCollectors() {
+    return this.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.d.ts

@@ -0,0 +1,18 @@
+import { IConfiguration, IContext, IRumSession } from "../types/client";
+import { RumEvent, IViewData } from "../types/rum-event";
+declare class Context implements IContext {
+    private config;
+    private rumEvent;
+    private views;
+    session: IRumSession;
+    constructor(config: IConfiguration, rumSession?: IRumSession);
+    getConfig(): IConfiguration;
+    setConfig(config: IConfiguration): void;
+    getViews(): IViewData[];
+    addView(view: IViewData): void;
+    removeView(viewId: string): void;
+    getRumEvent(): RumEvent;
+    setRumEvent(rumEvent: RumEvent): void;
+    [key: string]: any;
+}
+export default Context;

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(this);
+    }
+  }
+  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.d.ts

@@ -0,0 +1,31 @@
+import { IContext } from '../types/client';
+import { RumEvent, IViewData, RumEventBundle } from '../types/rum-event';
+export default abstract class Reporter {
+    name: string;
+    /**
+     * 新上报事件优先检测队列是否超过 50 条，如果超过立即 report。
+     * 如果没超过则检测 FlushTime 内有无新上报事件，如果有新事件，重置 timer，无则 report
+     */
+    protected eventQueue: RumEvent[];
+    protected ctx: IContext;
+    private timer;
+    getReportCfg(): {
+        flushTime?: number;
+        maxEventCount?: number;
+    };
+    report(ctx: IContext): void;
+    private pushToQueue;
+    /**
+     * eventQueue 提取最新 View 作为公共 View，event 中不同 View Event 保留 View id
+     */
+    protected flushEventQueue(): void;
+    mergeEvent(ctx: IContext, events: RumEvent[], view: IViewData): void;
+    /**
+     * 接口请求由各平台 sdk reporter 实现
+     */
+    abstract request(ctx: IContext, bundle: RumEventBundle): void;
+    /**
+     * 初始化时
+     */
+    protected init(ctx: IContext): void;
+}

package/es/model/reporter.js

@@ -0,0 +1,196 @@
+import { RumEventType } from '../types/rum-event';
+import { getErrorID } from '../utils/exception';
+import { isNumber, isObject, isString } from "../utils/is";
+import { verifyProperties } from "../utils/verify";
+var FLUSH_TIME = 3000;
+var MAX_EVENT_COUNT = 20;
+var attrs = ['app', 'user', 'device', 'os', 'geo', 'isp', 'net', 'properties'];
+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.mergeEvent(ctx, eventQueue, curView);
+    this.eventQueue = [];
+  };
+  _proto.mergeEvent = function mergeEvent(ctx, events, view) {
+    var config = ctx.getConfig();
+    var session = ctx.session;
+    var sessionId = session.getSessionId();
+    // events.forEach(event => {
+    //   if (event.session_id === sessionId) {
+    //     delete event.session_id;
+    //   }
+    // });
+    for (var i = 0; i < events.length; i++) {
+      var e = events[i];
+      if (e.session_id === sessionId) {
+        delete e.session_id;
+      } else {
+        events.splice(i, 1);
+        i--;
+      }
+    }
+    if (events.length === 0) return;
+    var bundle = {
+      app: {
+        id: config.pid,
+        env: config.env || 'prod',
+        version: config.version,
+        type: ''
+      },
+      user: {
+        id: session.getUserId()
+      },
+      session: {
+        id: sessionId
+      },
+      net: {},
+      view: view,
+      events: events
+    };
+    attrs.forEach(function (key) {
+      var obj = config[key];
+      isObject(obj) && Object.keys(obj).forEach(function (k) {
+        var val = obj[k];
+        // user 的 id 不能被覆盖
+        if (key === 'user' && k === 'id') return;
+        if (key === 'properties') {
+          bundle[key] = verifyProperties(obj);
+        } else if (isString(val) || isNumber(val)) {
+          if (!(key in bundle)) {
+            bundle[key] = {};
+          }
+          bundle[key][k] = val;
+        }
+      });
+    });
+    if (typeof config.beforeReport === 'function') {
+      bundle = config.beforeReport(bundle);
+      if (!bundle) return;
+    }
+    this.request(ctx, bundle);
+  }
+
+  // /**
+  //  * 接口请求由各平台 sdk reporter 实现
+  //  */
+  // abstract request(ctx: IContext, events: RumEvent[], view: IViewData): void;
+
+  /**
+   * 接口请求由各平台 sdk reporter 实现
+   */;
+  /**
+   * 初始化时
+   */
+  _proto.init = function init(ctx) {};
+  return Reporter;
+}();
+export { Reporter as default };

package/es/model/shell.d.ts

@@ -0,0 +1,51 @@
+import { IClient, IConfiguration } from "../types/client";
+import { RumCustomEvent, RumEvent, RumExceptionEvent, RumResourceEvent, RumViewEvent } from "../types/rum-event";
+import { IShell } from "../types/shell";
+export default abstract class Shell implements IShell {
+    client: IClient;
+    constructor(config?: IConfiguration);
+    getCombinedConfig(config?: IConfiguration): any;
+    updateFromRemoteConfig(config: any, reSetup?: boolean): void;
+    /**
+     * 初始化
+     */
+    abstract init(configuration: IConfiguration): void;
+    sendEvent(payload: RumEvent): void;
+    /**
+     * 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
+     */
+    abstract setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
+    abstract setConfig(value: IConfiguration): void;
+    /**
+     * 自定义事件上报
+     */
+    sendCustom(payload: RumCustomEvent): void;
+    /**
+     * 自定义视图上报
+     */
+    sendView(payload: RumViewEvent): void;
+    /**
+     * 自定义异常上报
+     */
+    sendException(payload: RumExceptionEvent | Error): void;
+    /**
+     * 自定义资源上报
+     */
+    sendResource(payload: RumResourceEvent): void;
+}

package/es/model/shell.js

@@ -0,0 +1,160 @@
+import _extends from "@babel/runtime/helpers/extends";
+import { RumEventType } from "../types/rum-event";
+import Client from '../model/client';
+import { isNumber, isFunction, isObject } from "../utils/is";
+import combineConfig, { isRemoteConfigEnable, getRemoteConfigUrl } from "../utils/combineConfig";
+var Shell = /*#__PURE__*/function () {
+  function Shell(config) {
+    this.client = void 0;
+    this.client = new Client();
+    if (config && this.init) {
+      this.init(config);
+    }
+    // if (config && this.init) {
+    //   this.init(this.getCombinedConfig(config));
+
+    //   // 拉取远程配置进行更新
+    //   this.updateFromRemoteConfig(config);
+    // }
+  }
+  var _proto = Shell.prototype;
+  _proto.getCombinedConfig = function getCombinedConfig(config) {
+    var combinedConf;
+    if (isRemoteConfigEnable(config) && isFunction(this.getLocalConfig)) {
+      var localConfig = this.getLocalConfig(0, config.pid);
+      combinedConf = combineConfig(config, localConfig);
+    }
+    return combinedConf || config;
+  };
+  _proto.updateFromRemoteConfig = function updateFromRemoteConfig(config, reSetup) {
+    if (reSetup === void 0) {
+      reSetup = true;
+    }
+    // 请求动态配置
+    if (config.pid && isRemoteConfigEnable(config) && isFunction(this.getRemoteConfig)) {
+      var that = this;
+      var proms = this.getRemoteConfig(getRemoteConfigUrl(config), config);
+      proms === null || proms === void 0 ? void 0 : proms.then(function (remoteConfig) {
+        if (!remoteConfig || remoteConfig.errorStatus !== undefined) return;
+        var combinedConf = combineConfig(config, remoteConfig);
+
+        // 无有效的新配置，无需更新
+        if (!combinedConf) return;
+
+        // 存储到本地
+        if (isFunction(that.storeRemoteConfig)) {
+          that.storeRemoteConfig(remoteConfig, config.pid);
+        }
+        if (reSetup === false || config.remoteConfig.reSetup === false) return;
+        var context = that.client.getContext();
+        // 更新配置
+        context.setConfig(combinedConf);
+        // 逐个更新collector
+        var collectors = that.client.getCollectors();
+        collectors.forEach(function (collector) {
+          if (isFunction(collector.destroy)) {
+            collector.destroy();
+            collector.setup(context, that.client.sendEvent);
+          }
+        });
+      });
+    }
+  }
+
+  /**
+   * 初始化
+   */;
+  _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();
+    }
+  }
+
+  /**
+   * 获取远程配置
+   */;
+  /**
+   * 自定义事件上报
+   */
+  _proto.sendCustom = function sendCustom(payload) {
+    if (!payload.name || !payload.type) {
+      return;
+    }
+    var data = _extends({}, payload, {
+      event_type: RumEventType.CUSTOM
+    });
+    this.sendEvent(data);
+  };
+  /**
+   * 自定义视图上报
+   */
+  _proto.sendView = function sendView(payload) {
+    if (!isObject(payload)) {
+      return;
+    }
+    if (!payload.type) {
+      payload.type = 'custom';
+    }
+    if (payload.type === 'custom') {
+      var n = 0;
+      ['t1', 't2', 't3'].forEach(function (key) {
+        if (!isNumber(payload[key])) {
+          delete payload[key];
+        }
+        key in payload && n++;
+      });
+      if (n === 0) return;
+    }
+    var data = _extends({}, payload, {
+      event_type: RumEventType.VIEW
+    });
+    this.sendEvent(data);
+  };
+  /**
+   * 自定义异常上报
+   */
+  _proto.sendException = function sendException(payload) {
+    if (!payload.name || !payload.message) {
+      return;
+    }
+    var name = payload.name,
+      message = payload.message,
+      stack = payload.stack;
+    var data = _extends({
+      times: 1,
+      name: name,
+      message: message,
+      stack: stack
+    }, 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