@arms/rum-core 0.0.5 → 0.0.8

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 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';
@@ -13,4 +14,4 @@ export * from './utils/is';
 export * from './utils/number';
 export * from './utils/match';
 export * from './utils/trace';
-export { Client, Context, Reporter };
+export { Client, Context, Reporter, Shell };

package/lib/index.js

@@ -5,7 +5,8 @@ exports.__esModule = true;
 var _exportNames = {
   Client: true,
   Context: true,
-  Reporter: true
+  Reporter: true,
+  Shell: true
 };
 var _client = _interopRequireDefault(require("./model/client"));
 exports.Client = _client["default"];
@@ -13,6 +14,8 @@ var _context = _interopRequireDefault(require("./model/context"));
 exports.Context = _context["default"];
 var _reporter = _interopRequireDefault(require("./model/reporter"));
 exports.Reporter = _reporter["default"];
+var _shell = _interopRequireDefault(require("./model/shell"));
+exports.Shell = _shell["default"];
 var _client2 = require("./types/client");
 Object.keys(_client2).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -48,12 +51,12 @@ Object.keys(_rumEvent).forEach(function (key) {
   if (key in exports && exports[key] === _rumEvent[key]) return;
   exports[key] = _rumEvent[key];
 });
-var _shell = require("./types/shell");
-Object.keys(_shell).forEach(function (key) {
+var _shell2 = require("./types/shell");
+Object.keys(_shell2).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _shell[key]) return;
-  exports[key] = _shell[key];
+  if (key in exports && exports[key] === _shell2[key]) return;
+  exports[key] = _shell2[key];
 });
 var _base = require("./utils/base");
 Object.keys(_base).forEach(function (key) {

package/lib/model/context.d.ts

@@ -1,5 +1,5 @@
-import { IConfiguration, IContext, IViewData } from "../types/client";
-import { RumEvent } from "../types/rum-event";
+import { IConfiguration, IContext } from "../types/client";
+import { RumEvent, IViewData } from "../types/rum-event";
 declare class Context implements IContext {
     private config;
     private rumEvent;

package/lib/model/reporter.d.ts

@@ -1,5 +1,5 @@
-import { IContext, IViewData } from '../types/client';
-import { RumEvent } from '../types/rum-event';
+import { IContext } from '../types/client';
+import { RumEvent, IViewData } from '../types/rum-event';
 export default abstract class Reporter {
     name: string;
     /**

package/lib/model/shell.d.ts

@@ -0,0 +1,25 @@
+import { IClient, IConfiguration } from "../types/client";
+import { RumEvent } 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: RumEvent): void;
+}

package/lib/model/shell.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+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 Shell = exports["default"] = /*#__PURE__*/function () {
+  function Shell(config) {
+    this.client = void 0;
+    this.client = new _rumCore.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 = (0, _extends2["default"])({}, payload, {
+      event_type: _rumEvent.RumEventType.CUSTOM
+    });
+    this.sendEvent(data);
+  };
+  return Shell;
+}();

package/lib/types/client.d.ts

@@ -1,18 +1,13 @@
 import { ICollector } from './collector';
 import { IProcessor } from './processor';
 import { IReporter } from './reporter';
-import { RumEvent, RumEventBundle } from './rum-event';
-import { ITracingOption } from '../utils/trace';
+import { RumEvent, RumEventBundle, IViewData } from './rum-event';
 export declare enum EventType {
     /**
      * 收集数据
      */
     collect = "collect"
 }
-export interface IViewData {
-    id: string;
-    name: string;
-}
 export interface IContext {
     /**
      * user config
@@ -96,9 +91,5 @@ export interface IConfiguration {
      * 各个 collector config
      */
     collectors?: any;
-    /**
-     * tracing 配置 'tracecontext' | 'b3' | 'b3multi' | 'jaeger';
-     */
-    tracing?: boolean | ITracingOption;
     [key: string]: any;
 }

package/lib/types/reporter.d.ts

@@ -1,5 +1,5 @@
-import { IContext, IViewData } from './client';
-import { RumEvent } from './rum-event';
+import { IContext } from './client';
+import { RumEvent, IViewData } from './rum-event';
 export interface IReporter {
     name: string;
     init(ctx: IContext): void;

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

@@ -6,22 +6,22 @@ export declare enum RumEventType {
     ACTION = "action",
     CUSTOM = "custom"
 }
-export type BaseObjectKey = string | number;
-export type BaseObjectPrimitiveValue = string | number | boolean | null | undefined;
-export type BaseObjectValue = BaseObjectPrimitiveValue | BaseObject | BaseObjectPrimitiveValue[];
 export interface BaseObject {
-    [key: BaseObjectKey]: BaseObjectValue;
+    [key: string]: BaseObjectValue;
+}
+export interface IViewData {
+    id: string;
+    name: string;
 }
+export type BaseObjectPrimitiveValue = string | number | boolean | null | undefined;
+export type BaseObjectValue = BaseObjectPrimitiveValue | BaseObject | BaseObjectPrimitiveValue[] | IViewData;
 export interface RumBaseEvent {
-    event_type: RumEventType;
+    event_type?: RumEventType;
     event_id?: string;
     timestamp?: number;
     times?: number;
-    view?: {
-        id: string;
-        name: string;
-    };
-    [key: `$attr.${string}`]: BaseObjectValue;
+    view?: IViewData;
+    [key: string]: BaseObjectValue;
 }
 export interface RumViewEvent extends RumBaseEvent {
     loading_type?: 'initial_load' | 'route_change';
@@ -34,6 +34,7 @@ export interface RumViewEvent extends RumBaseEvent {
     dom_interactive?: number;
     dom_content_loaded?: number;
     dom_complete?: number;
+    load_event?: number;
     referrer?: string;
     url?: string;
     timing_data?: string;
@@ -56,7 +57,7 @@ export interface RumResourceEvent extends RumBaseEvent {
     first_byte_duration?: number;
     download_duration?: number;
     url: string;
-    timing_data?: PerformanceResourceTiming;
+    timing_data?: string;
 }
 export interface RumExceptionEvent extends RumBaseEvent {
     source?: string;
@@ -85,13 +86,14 @@ export interface RumActionEvent extends RumBaseEvent {
     snapshots?: string;
 }
 export interface RumCustomEvent extends RumBaseEvent {
-    id: string;
     type: string;
-    [key: BaseObjectKey]: BaseObjectValue;
+    name: string;
+    group?: string;
+    value: number;
 }
 export type RumEvent = RumViewEvent | RumResourceEvent | RumExceptionEvent | RumActionEvent | RumCustomEvent;
 export declare enum AppType {
-    broswer = "browser",
+    browser = "browser",
     miniapp = "miniapp"
 }
 export interface RumEventBundle {

package/lib/types/rum-event.js

@@ -12,7 +12,7 @@ var RumEventType = exports.RumEventType = /*#__PURE__*/function (RumEventType) {
   return RumEventType;
 }({});
 var AppType = exports.AppType = /*#__PURE__*/function (AppType) {
-  AppType["broswer"] = "browser";
+  AppType["browser"] = "browser";
   AppType["miniapp"] = "miniapp";
   return AppType;
 }({});

package/lib/utils/trace.d.ts

@@ -10,11 +10,12 @@ export interface ITracingOption {
     sample?: number | undefined;
     allowedUrls?: Array<MatchOption | TraceOption> | undefined;
     tracestate?: boolean;
+    baggage?: boolean;
 }
 export declare function generateTraceId(): any;
 export declare function generateSpanId(): any;
 export interface ITracingHeaders {
     [key: string]: string;
 }
-export declare function makeTracingHeaders(traceId: string, spanId: string, sampled: boolean, propagatorTypes: PropagatorType[], tracestate?: string): ITracingHeaders;
+export declare function makeTracingHeaders(traceId: string, spanId: string, sampled: boolean, propagatorTypes: PropagatorType[], tracestate?: string, baggage?: string): ITracingHeaders;
 export declare function parseTracingOptions(tracingOption: boolean | ITracingOption): ITracingOption;

package/lib/utils/trace.js

@@ -12,7 +12,7 @@ var SPAN_ID_BYTES = 8;
 var TRACE_ID_BYTES = 16;
 var SHARED_CHAR_CODES_ARRAY = Array(32);
 function isTraceOption(option) {
-  return option && (0, _match.isMatchOption)(option.match) && Array.isArray(option.propagatorTypes);
+  return option && (0, _match.isMatchOption)(option.match) && (0, _is.isArray)(option.propagatorTypes);
 }
 function generateId(bytes) {
   for (var i = 0; i < bytes * 2; i++) {
@@ -38,20 +38,7 @@ function generateTraceId() {
 function generateSpanId() {
   return generateId(SPAN_ID_BYTES);
 }
-
-// export function getB3Header(traceId: string, spanId: string) {
-//   return `${traceId}-${spanId}-1`
-// }
-//
-// export function getW3CTraceHeader(traceId: string, spanId: string) {
-//   return `00-${traceId}-${spanId}-01`
-// }
-//
-// export function getJaegerTraceHeader(traceId: string, spanId: string) {
-//   return `${traceId}:${spanId}:0:1`
-// }
-
-function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, tracestate) {
+function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, tracestate, baggage) {
   var tracingHeaders = {};
   var sample = sampled ? '1' : '0';
   propagatorTypes.forEach(function (propagatorType) {
@@ -77,6 +64,9 @@ function makeTracingHeaders(traceId, spanId, sampled, propagatorTypes, tracestat
         break;
     }
   });
+  if (baggage) {
+    tracingHeaders['baggage'] = baggage;
+  }
   return tracingHeaders;
 }
 function parseTracingOptions(tracingOption) {
@@ -85,7 +75,8 @@ function parseTracingOptions(tracingOption) {
       enable: !!tracingOption,
       sample: 100,
       allowedUrls: [],
-      tracestate: true
+      tracestate: true,
+      baggage: false
     };
   }
   var _tracingOption$enable = tracingOption.enable,
@@ -95,7 +86,9 @@ function parseTracingOptions(tracingOption) {
     _tracingOption$allowe = tracingOption.allowedUrls,
     allowedUrls = _tracingOption$allowe === void 0 ? [] : _tracingOption$allowe,
     _tracingOption$traces = tracingOption.tracestate,
-    tracestate = _tracingOption$traces === void 0 ? true : _tracingOption$traces;
+    tracestate = _tracingOption$traces === void 0 ? true : _tracingOption$traces,
+    _tracingOption$baggag = tracingOption.baggage,
+    baggage = _tracingOption$baggag === void 0 ? false : _tracingOption$baggag;
   var traceOptions = [];
   if ((0, _is.isArray)(allowedUrls) && allowedUrls.length) {
     allowedUrls.forEach(function (item) {
@@ -113,6 +106,7 @@ function parseTracingOptions(tracingOption) {
     enable: (0, _is.isBoolean)(enable) ? enable : true,
     sample: (0, _is.isNumber)(sample) ? sample : 100,
     allowedUrls: traceOptions,
-    tracestate: tracestate
+    tracestate: tracestate,
+    baggage: baggage
   };
 }

package/package.json

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