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

package/es/utils/trace.js

@@ -0,0 +1,101 @@
+import { isMatchOption } from "./match";
+import { isArray, isBoolean, isNumber } from "./is";
+import { encode } from "js-base64";
+export function isTraceOption(option) {
+  return option && isMatchOption(option.match) && isArray(option.propagatorTypes);
+}
+export function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, subOption) {
+  if (subOption === void 0) {
+    subOption = {};
+  }
+  var tracingHeaders = {};
+  var sample = sampled ? '1' : '0';
+  // skywalking 标准具备排他性，如果包含sw8，则只使用sw8
+  if (propagatorTypes.includes('sw8')) {
+    propagatorTypes = ['sw8'];
+  }
+  propagatorTypes.forEach(function (propagatorType) {
+    switch (propagatorType) {
+      case 'jaeger':
+        tracingHeaders['uber-trace-id'] = traceId + ":" + spanId + ":0:" + sample;
+        break;
+      case 'b3':
+        // https://github.com/openzipkin/b3-propagation
+        tracingHeaders['b3'] = traceId + "-" + spanId + "-" + sample;
+        break;
+      case 'b3multi':
+        tracingHeaders['X-B3-TraceId'] = traceId;
+        tracingHeaders['X-B3-SpanId'] = spanId;
+        tracingHeaders['X-B3-Sampled'] = sample;
+        break;
+      case 'sw8':
+        // https://github.com/apache/skywalking-client-js
+        var traceIdStr = String(encode(traceId));
+        var segmentId = String(encode(spanId));
+        var service = String(encode(subOption.appId));
+        var instance = String(encode(subOption.appVersion));
+        var endpoint = String(encode(subOption.viewName));
+        var peer = String(encode(subOption.host));
+        tracingHeaders['sw8'] = sample + "-" + traceIdStr + "-" + segmentId + "-" + 0 + "-" + service + "-" + instance + "-" + endpoint + "-" + peer;
+        break;
+      case 'tracecontext':
+      default:
+        // https://www.w3.org/TR/trace-context/
+        tracingHeaders['traceparent'] = "00-" + traceId + "-" + spanId + "-0" + sample;
+        if (subOption.tracestate) {
+          tracingHeaders['tracestate'] = subOption.tracestate;
+        }
+        break;
+    }
+  });
+  if (subOption.baggage) {
+    tracingHeaders['baggage'] = subOption.baggage;
+  }
+  return tracingHeaders;
+}
+export function parseTracingOptions(tracingOption) {
+  var defPropagatorTypes = ['tracecontext'];
+  if (isBoolean(tracingOption) || !tracingOption) {
+    return {
+      enable: !!tracingOption,
+      sample: 100,
+      propagatorTypes: defPropagatorTypes,
+      allowedUrls: [],
+      tracestate: true,
+      baggage: false
+    };
+  }
+  var _tracingOption$enable = tracingOption.enable,
+    enable = _tracingOption$enable === void 0 ? true : _tracingOption$enable,
+    _tracingOption$sample = tracingOption.sample,
+    sample = _tracingOption$sample === void 0 ? 100 : _tracingOption$sample,
+    _tracingOption$propag = tracingOption.propagatorTypes,
+    propagatorTypes = _tracingOption$propag === void 0 ? defPropagatorTypes : _tracingOption$propag,
+    _tracingOption$allowe = tracingOption.allowedUrls,
+    allowedUrls = _tracingOption$allowe === void 0 ? [] : _tracingOption$allowe,
+    _tracingOption$traces = tracingOption.tracestate,
+    tracestate = _tracingOption$traces === void 0 ? true : _tracingOption$traces,
+    _tracingOption$baggag = tracingOption.baggage,
+    baggage = _tracingOption$baggag === void 0 ? false : _tracingOption$baggag;
+  var traceOptions = [];
+  if (isArray(allowedUrls) && allowedUrls.length) {
+    allowedUrls.forEach(function (item) {
+      if (isMatchOption(item)) {
+        traceOptions.push({
+          match: item,
+          propagatorTypes: propagatorTypes
+        });
+      } else if (isTraceOption(item)) {
+        traceOptions.push(item);
+      }
+    });
+  }
+  return {
+    enable: isBoolean(enable) ? enable : true,
+    sample: isNumber(sample) ? sample : 100,
+    propagatorTypes: propagatorTypes,
+    allowedUrls: traceOptions,
+    tracestate: tracestate,
+    baggage: baggage
+  };
+}

package/lib/model/client.d.ts

@@ -1,4 +1,4 @@
-import { IClient, IConfiguration, IContext } from '../types/client';
+import { IClient, IConfiguration, IContext, IRumSession } from '../types/client';
 import { RumEvent } from '../types/rum-event';
 import { IProcessor } from '../types/processor';
 import { ICollector } from '../types/collector';
@@ -9,7 +9,7 @@ declare class Client implements IClient {
     private processors;
     private reporter;
     private ctx;
-    init(config: IConfiguration): void;
+    init(config: IConfiguration, rumSession?: IRumSession): void;
     sendEvent: (payload: RumEvent) => void;
     setContext(ctx: IContext): void;
     getContext(): IContext;

package/lib/model/client.js

@@ -6,6 +6,7 @@ exports["default"] = void 0;
 var _client = require("../types/client");
 var _events = require("events");
 var _context = _interopRequireDefault(require("./context"));
+var _is = require("../utils/is");
 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; }
@@ -22,13 +23,16 @@ var Client = /*#__PURE__*/function () {
     };
   }
   var _proto = Client.prototype;
-  _proto.init = function init(config) {
+  _proto.init = function init(config, rumSession) {
     var _this2 = this;
-    this.ctx = new _context["default"](config);
+    this.ctx = new _context["default"](config, rumSession);
     var ctx = this.ctx,
       collectors = this.collectors,
       processors = this.processors,
       reporter = this.reporter;
+    processors.forEach(function (processor) {
+      (0, _is.isFunction)(processor.setup) && processor.setup(ctx);
+    });
 
     // collector 收集数据统一 push 到各匹配 processor
     this.emitter.on(_client.EventType.collect, function (payload) {

package/lib/model/context.d.ts

@@ -1,10 +1,11 @@
-import { IConfiguration, IContext } from "../types/client";
+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;
-    constructor(config: IConfiguration);
+    session: IRumSession;
+    constructor(config: IConfiguration, rumSession?: IRumSession);
     getConfig(): IConfiguration;
     setConfig(config: IConfiguration): void;
     getViews(): IViewData[];

package/lib/model/context.js

@@ -3,10 +3,15 @@
 exports.__esModule = true;
 exports["default"] = void 0;
 var Context = /*#__PURE__*/function () {
-  function Context(config) {
+  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() {

package/lib/model/reporter.js

@@ -117,7 +117,9 @@ var Reporter = exports["default"] = /*#__PURE__*/function () {
         });
       }
     });
-    this.request(ctx, eventQueue, curView);
+    var session = ctx.session;
+    var sampled = session ? session.getSampled() : true;
+    sampled && this.request(ctx, eventQueue, curView);
     this.eventQueue = [];
   }
 

package/lib/types/client.d.ts

@@ -10,6 +10,7 @@ export declare enum EventType {
     collect = "collect"
 }
 export interface IContext {
+    session: IRumSession;
     /**
      * user config
      */
@@ -28,11 +29,26 @@ export interface IContext {
     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) => void;
+    init: (configuration: IConfiguration, rumSession?: IRumSession) => void;
     /**
      * 业务自定义上传数据
      */
@@ -95,6 +111,10 @@ export interface IConfiguration {
         flushTime?: number;
         maxEventCount?: number;
     };
+    /**
+     * session config
+     */
+    sessionConfig?: SessionConfig;
     /**
      * 各个 collector config
      */

package/lib/types/processor.d.ts

@@ -2,6 +2,7 @@ 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/lib/types/rum-event.d.ts

@@ -42,13 +42,21 @@ export interface RumViewEvent extends RumBaseEvent {
     url?: string;
     timing_data?: string;
 }
+/**
+ * 枚举值，表示资源是否加载成功
+ */
+export declare enum ResourceStatus {
+    Unknown = -1,
+    Failed = 0,
+    Success = 1
+}
 export interface RumResourceEvent extends RumBaseEvent {
     name?: string;
     type?: string;
     method?: string;
     status_code?: number | string;
     message?: string;
-    success?: -1 | 0 | 1;
+    success?: -1 | 0 | 1 | ResourceStatus;
     trace_id?: string;
     duration?: number;
     size?: number;
@@ -96,7 +104,8 @@ export interface RumCustomEvent extends RumBaseEvent {
 export type RumEvent = RumViewEvent | RumResourceEvent | RumExceptionEvent | RumActionEvent | RumCustomEvent;
 export declare enum AppType {
     browser = "browser",
-    miniapp = "miniapp"
+    miniapp = "miniapp",
+    uniapp = "uniapp"
 }
 export interface RumEventBundle {
     app: {

package/lib/types/rum-event.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.RumEventType = exports.AppType = void 0;
+exports.RumEventType = exports.ResourceStatus = exports.AppType = void 0;
 var RumEventType = exports.RumEventType = /*#__PURE__*/function (RumEventType) {
   RumEventType["VIEW"] = "view";
   RumEventType["RESOURCE"] = "resource";
@@ -11,8 +11,18 @@ var RumEventType = exports.RumEventType = /*#__PURE__*/function (RumEventType) {
   RumEventType["CUSTOM"] = "custom";
   return RumEventType;
 }({});
+/**
+ * 枚举值，表示资源是否加载成功
+ */
+var ResourceStatus = exports.ResourceStatus = /*#__PURE__*/function (ResourceStatus) {
+  ResourceStatus[ResourceStatus["Unknown"] = -1] = "Unknown";
+  ResourceStatus[ResourceStatus["Failed"] = 0] = "Failed";
+  ResourceStatus[ResourceStatus["Success"] = 1] = "Success";
+  return ResourceStatus;
+}({});
 var AppType = exports.AppType = /*#__PURE__*/function (AppType) {
   AppType["browser"] = "browser";
   AppType["miniapp"] = "miniapp";
+  AppType["uniapp"] = "uniapp";
   return AppType;
 }({});

package/lib/utils/base.d.ts

@@ -22,11 +22,9 @@ export declare function generateSpanId(len?: number, radix?: 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;
+export declare function generateEventId(sessionId: string): string;
 /**
  * @desc 函数防抖
  * @param func 回调函数

package/lib/utils/base.js

@@ -95,19 +95,11 @@ function generateSpanId(len, radix) {
 /**
  * @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';
-  }
+function generateEventId(sessionId) {
   var spanId = generateSpanId();
-  return "00-" + sessionId + "-" + spanId + "-" + samplingType + (sampled ? '1' : '0');
+  return "00-" + sessionId + "-" + spanId;
 }
 
 /**

package/lib/utils/number.d.ts

@@ -1,9 +1,12 @@
+export declare const ONE_SECOND = 1000;
+export declare const ONE_MINUTE: number;
+export declare const ONE_HOUR: number;
+export declare const ONE_DAY: number;
 /**
  * Return true if the draw is successful
  * @param threshold between 0 and 100
  */
 export declare function performDraw(threshold: number): boolean;
-export declare function round(num: number, decimals: 0 | 1 | 2 | 3 | 4): number;
 /**
  * 保留指定位数的小数
  * @param num 原数据

package/lib/utils/number.js

@@ -1,9 +1,14 @@
 "use strict";
 
 exports.__esModule = true;
+exports.ONE_SECOND = exports.ONE_MINUTE = exports.ONE_HOUR = exports.ONE_DAY = void 0;
 exports.formatNumber = formatNumber;
 exports.performDraw = performDraw;
-exports.round = round;
+var ONE_SECOND = exports.ONE_SECOND = 1e3;
+var ONE_MINUTE = exports.ONE_MINUTE = 60 * ONE_SECOND;
+var ONE_HOUR = exports.ONE_HOUR = 60 * ONE_MINUTE;
+var ONE_DAY = exports.ONE_DAY = 24 * ONE_HOUR;
+
 /**
  * Return true if the draw is successful
  * @param threshold between 0 and 100
@@ -11,9 +16,6 @@ exports.round = round;
 function performDraw(threshold) {
   return threshold !== 0 && Math.random() * 100 <= threshold;
 }
-function round(num, decimals) {
-  return +num.toFixed(decimals);
-}
 
 /**
  * 保留指定位数的小数

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@arms/rum-core",
-  "version": "0.0.25-beta.13",
+  "version": "0.0.25-beta.15",
   "description": "arms rum javascript sdk core",
   "author": "guangli.fj <guangli.fj@alibaba-inc.com>",
   "license": "ISC",
   "main": "lib/index.js",
+  "module": "es/index.js",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
   },
   "files": [
-    "lib"
+    "lib",
+    "es"
   ],
   "publishConfig": {
     "access": "public"
@@ -18,7 +20,6 @@
   "scripts": {
     "start": "build-scripts build --watch",
     "build": "build-scripts build --skip-demo",
-    "prepublishOnly": "npm run build",
     "test": "node ./__tests__/@arms/core.test.js"
   },
   "dependencies": {