@arms/rum-core 0.0.25-beta.13 → 0.0.25-beta.15

package/es/index.d.ts

@@ -0,0 +1,17 @@
+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 { Client, Context, Reporter, Shell };

package/es/index.js

@@ -0,0 +1,17 @@
+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 { Client, Context, Reporter, Shell };

package/es/model/client.d.ts

@@ -0,0 +1,20 @@
+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;
+    useProcessors(processors: IProcessor[]): void;
+    useReporter(reporter: IReporter): void;
+}
+export default Client;

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.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(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.d.ts

@@ -0,0 +1,30 @@
+import { IContext } from '../types/client';
+import { RumEvent, IViewData } 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;
+    /**
+     * 接口请求由各平台 sdk reporter 实现
+     */
+    abstract request(ctx: IContext, events: RumEvent[], view: IViewData): void;
+    /**
+     * 初始化时
+     */
+    protected init(ctx: IContext): void;
+}

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.d.ts

@@ -0,0 +1,33 @@
+import { IClient, IConfiguration } from "../types/client";
+import { RumCustomEvent, RumEvent, RumExceptionEvent, RumResourceEvent } from "../types/rum-event";
+import { IShell } from "../types/shell";
+export default abstract class Shell implements IShell {
+    client: IClient;
+    constructor(config?: IConfiguration);
+    /**
+     * 初始化
+     */
+    abstract init(configuration: IConfiguration): void;
+    sendEvent(payload: RumEvent): void;
+    /**
+     * get config
+     */
+    getConfig(): IConfiguration;
+    /**
+     * set config
+     */
+    abstract setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
+    abstract setConfig(value: IConfiguration): void;
+    /**
+     * 自定义事件上报
+     */
+    sendCustom(payload: RumCustomEvent): void;
+    /**
+     * 自定义异常上报
+     */
+    sendException(payload: RumExceptionEvent): void;
+    /**
+     * 自定义资源上报
+     */
+    sendResource(payload: RumResourceEvent): void;
+}

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.d.ts

@@ -0,0 +1,133 @@
+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 {
+    /**
+     * 收集数据
+     */
+    collect = "collect"
+}
+export interface IContext {
+    session: IRumSession;
+    /**
+     * user config
+     */
+    getConfig(): IConfiguration;
+    setConfig(config: IConfiguration): void;
+    /**
+     * view
+     */
+    getViews(): IViewData[];
+    addView(view: IViewData): void;
+    removeView(viewId: string): void;
+    /**
+     * event
+     */
+    getRumEvent(): RumEvent;
+    setRumEvent(rumEvent: RumEvent): void;
+    [key: string]: any;
+}
+export interface SessionConfig {
+    sampleRate?: number;
+    maxDuration?: number;
+    overtime?: number;
+}
+export interface IRumSession {
+    init(config: IConfiguration): void;
+    sessionConfig: SessionConfig;
+    getSessionId: () => string;
+    getSampled: () => boolean;
+    updateSession: () => void;
+    getEventId: () => string;
+    getViewId: () => string;
+    getUserId: () => string;
+}
+export interface IClient {
+    /**
+     * 初始化
+     */
+    init: (configuration: IConfiguration, rumSession?: IRumSession) => void;
+    /**
+     * 业务自定义上传数据
+     */
+    sendEvent(payload: RumEvent): void;
+    /**
+     * 修改运行时上下文
+     */
+    setContext(ctx: IContext): void;
+    /**
+     * 获取运行时上下文
+     */
+    getContext(): IContext;
+    /**
+     * 装载 client 需要的 Collector
+     */
+    useCollectors(collectors: ICollector[]): void;
+    /**
+     * 装载 client 需要的 processor
+     */
+    useProcessors(processors: IProcessor[]): void;
+    /**
+     * 装载 client 需要的 report
+     */
+    useReporter(reporter: IReporter): void;
+}
+export interface IConfiguration {
+    /**
+     * 项目 id
+     */
+    pid: string;
+    /**
+     * 应用环境
+     */
+    env?: 'prod' | 'gray' | 'pre' | 'daily' | 'local';
+    /**
+     * 应用版本
+     */
+    version?: string;
+    /**
+     * 用户配置
+     */
+    user?: {
+        id?: string;
+        tags?: string;
+        name?: string;
+        [key: string]: any;
+    };
+    /**
+     * 上报地址
+     */
+    endpoint: string;
+    /**
+     * reporter 发送事件之前
+     */
+    beforeReport?(bundle: RumEventBundle): any;
+    /**
+     * reporter 发送节奏配置
+     */
+    reportConfig?: {
+        flushTime?: number;
+        maxEventCount?: number;
+    };
+    /**
+     * session config
+     */
+    sessionConfig?: SessionConfig;
+    /**
+     * 各个 collector config
+     */
+    collectors?: {
+        [key: string]: unknown;
+    };
+    /**
+     * 事件过滤器配置
+     */
+    filters?: {
+        view?: MatchOption | MatchOption[];
+        resource?: MatchOption | MatchOption[];
+        exception?: MatchOption | MatchOption[];
+    };
+    [key: string]: any;
+}

package/es/types/client.js

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

package/es/types/collector.d.ts

@@ -0,0 +1,7 @@
+import { IContext } from './client';
+import { RumEvent } from './rum-event';
+export interface ICollector {
+    name: string;
+    setup(ctx: IContext, sendEvent: (payload: RumEvent) => void): void;
+    destroy?(): void;
+}

package/es/types/collector.js

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

package/es/types/processor.d.ts

@@ -0,0 +1,8 @@
+import { IContext } from './client';
+import { RumEvent } from './rum-event';
+export interface IProcessor {
+    name: string;
+    setup?(ctx: IContext): void;
+    process(ctx: IContext): RumEvent;
+    match?(ctx: IContext): boolean;
+}

package/es/types/processor.js

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

package/es/types/reporter.d.ts

@@ -0,0 +1,8 @@
+import { IContext } from './client';
+import { RumEvent, IViewData } from './rum-event';
+export interface IReporter {
+    name: string;
+    init(ctx: IContext): void;
+    request(ctx: IContext, events: RumEvent[], view: IViewData): void;
+    report(ctx: IContext): void;
+}

package/es/types/reporter.js

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