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

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

@@ -0,0 +1,163 @@
+export declare enum RumEventType {
+    VIEW = "view",
+    RESOURCE = "resource",
+    EXCEPTION = "exception",
+    LONG_TASK = "longtask",
+    ACTION = "action",
+    CUSTOM = "custom"
+}
+export interface BaseObject {
+    [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_id?: string;
+    timestamp?: number;
+    times?: number;
+    view?: IViewData;
+    snapshots?: string;
+    [key: string]: BaseObjectValue;
+}
+export interface RumViewEvent extends RumBaseEvent {
+    loading_type?: 'initial_load' | 'route_change';
+    type: 'pv' | 'perf' | 'webvitals';
+    largest_contentful_paint?: number;
+    first_input_delay?: number;
+    cumulative_layout_shift?: number;
+    first_input_time?: number;
+    loading_time?: number;
+    first_paint?: number;
+    first_contentful_paint?: number;
+    dom_interactive?: number;
+    dom_content_loaded?: number;
+    dom_complete?: number;
+    load_event?: number;
+    referrer?: string;
+    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 | ResourceStatus;
+    trace_id?: string;
+    duration?: number;
+    size?: number;
+    connect_duration?: number;
+    ssl_duration?: number;
+    dns_duration?: number;
+    redirect_duration?: number;
+    first_byte_duration?: number;
+    download_duration?: number;
+    url?: string;
+    timing_data?: string;
+    tracing_data?: string;
+}
+export interface RumExceptionEvent extends RumBaseEvent {
+    source?: string;
+    type?: 'crash' | 'custom' | 'error' | 'blank';
+    name?: string;
+    message?: string;
+    file?: string;
+    stack?: string;
+    line?: number;
+    column?: number;
+}
+export interface RumLongTaskEvent extends RumBaseEvent {
+    view_name: string;
+    source?: string;
+    type?: string;
+    message?: string;
+    count: number;
+    stack?: string;
+    caused_by?: string;
+}
+export interface RumActionEvent extends RumBaseEvent {
+    type?: string;
+    name?: string;
+    target_name?: string;
+    duration?: number;
+}
+export interface RumCustomEvent extends RumBaseEvent {
+    type: string;
+    name: string;
+    group?: string;
+    value: number;
+}
+export type RumEvent = RumViewEvent | RumResourceEvent | RumExceptionEvent | RumActionEvent | RumCustomEvent;
+export declare enum AppType {
+    browser = "browser",
+    miniapp = "miniapp",
+    uniapp = "uniapp"
+}
+export interface RumEventBundle {
+    app: {
+        id: string;
+        type: AppType;
+        name?: string;
+        version?: string;
+        channel?: string;
+        env?: string;
+        package?: string;
+    };
+    user: {
+        id: string;
+        name?: string;
+        tags?: string;
+    };
+    session: {
+        id: string;
+    };
+    view: {
+        id: string;
+        name: string;
+    };
+    device?: {
+        id?: string;
+        type?: string;
+        brand?: string;
+        model?: string;
+        name?: string;
+    };
+    os?: {
+        type?: string;
+        version?: string;
+        container?: string;
+        container_version?: string;
+    };
+    geo?: {
+        country?: string;
+        country_id?: string;
+        province?: string;
+        province_id?: string;
+        city?: string;
+        city_id?: string;
+    };
+    isp?: {
+        id?: string;
+        name?: string;
+    };
+    net?: {
+        model?: string;
+        name?: string;
+    };
+    events: Array<RumEvent>;
+    _v: string;
+}

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

@@ -0,0 +1,28 @@
+import { IConfiguration } from "./client";
+import { RumEvent } from "./rum-event";
+/**
+ * 每个 sdk shell 导出固定需要实现的基础 api
+ * 对外导出 shell 层, 所有 shell 层模型的 API 设计约定：
+ * 1. API 命名空间按照 variables / functions / events 来组织
+ * 2. 事件（events）的命名格式为：on[Will|Did]VerbNoun?，参考 https://code.visualstudio.com/api/references/vscode-api#events
+ * 3. 基于 Disposable 模式，对于事件的绑定、快捷键的绑定函数，返回值则是解绑函数
+ */
+export interface IShell {
+    /**
+     * 初始化
+     */
+    init(configuration: IConfiguration): void;
+    /**
+     * 自定义上传数据
+     */
+    sendEvent(payload: RumEvent): void;
+    /**
+     * get config
+     */
+    getConfig(): IConfiguration;
+    /**
+     * set config
+     */
+    setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
+    setConfig(value: IConfiguration): void;
+}

package/es/types/shell.js

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

package/es/utils/base.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 劫持函数
+ */
+export declare function interceptFunction(target: any, name: string, callback: Function): void;
+/**
+ * @description: GUID v4
+ * @return {String}
+ */
+export declare function generateGUID(): string;
+/**
+ * @description: 随机生成 traceId 或 sessionId
+ * @return {String}
+ */
+export declare function generateTraceId(): string;
+/**
+ * @description: 随机生成 spanId
+ * @param len {number}
+ * @param radix {number}
+ * @return {String}
+ */
+export declare function generateSpanId(len?: number, radix?: number): string;
+/**
+ * @description: 随机生成 eventId
+ * @param sessionId {string} sessionId
+ * @return {String}
+ */
+export declare function generateEventId(sessionId: string): string;
+/**
+ * @desc 函数防抖
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function debounce(func: Function, wait: number): () => void;
+/**
+ * @desc 函数延迟执行
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function delay(func: Function, wait: number, ...args: any[]): number;

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

@@ -0,0 +1,7 @@
+/**
+ * 获取错误对象唯一标识
+ */
+export declare const getErrorID: (error: {
+    message?: string;
+    stack?: string;
+}) => string;

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

@@ -0,0 +1,12 @@
+export type IsFnHelper<T = unknown> = (value: unknown) => value is T;
+export declare function isTypeof<T = unknown>(value: unknown, type: string): value is T;
+export declare const isFunction: (func: any) => boolean;
+export declare const isUndefined: IsFnHelper<undefined>;
+export declare const isString: IsFnHelper<string>;
+export declare function isToString<T = unknown>(value: unknown, type: string): value is T;
+export declare const isArray: IsFnHelper<unknown[]>;
+export declare const isRegExp: IsFnHelper<string>;
+export declare const isBoolean: IsFnHelper<boolean>;
+export declare const isNumber: IsFnHelper<number | bigint>;
+export declare const isNull: IsFnHelper<null>;
+export declare const isObject: IsFnHelper<object>;

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

@@ -0,0 +1,7 @@
+export type MatchOption = string | RegExp | ((value: string) => boolean);
+export declare function isMatchOption(item: unknown): item is MatchOption;
+/**
+ * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
+ */
+export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean): boolean;
+export declare function urlMatch(url: string, list?: MatchOption[]): boolean;

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

@@ -0,0 +1,17 @@
+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;
+/**
+ * 保留指定位数的小数
+ * @param num 原数据
+ * @param decimal 小数位数
+ * @param min 限制最小值，否则返回undefined
+ * @returns
+ */
+export declare function formatNumber(num: number, decimal?: number, min?: number): number;

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

@@ -0,0 +1,7 @@
+export declare function find<T, S extends T>(array: ArrayLike<T>, predicate: (item: T, index: number) => item is S): S | undefined;
+export declare function find<T>(array: ArrayLike<T>, predicate: (item: T, index: number) => boolean): T | undefined;
+export declare function startsWith(candidate: string, search: string): boolean;
+export declare function endsWith(candidate: string, search: string): boolean;
+export declare function assign<T, U>(target: T, source: U): T & U;
+export declare function assign<T, U, V>(target: T, source1: U, source2: V): T & U & V;
+export declare function assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;

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;
+}

package/es/utils/trace.d.ts

@@ -0,0 +1,28 @@
+import { MatchOption } from "./match";
+export type PropagatorType = 'tracecontext' | 'b3' | 'b3multi' | 'jaeger' | 'sw8';
+export type TraceOption = {
+    match: MatchOption;
+    propagatorTypes: PropagatorType[];
+};
+export declare function isTraceOption(option: any): option is TraceOption;
+export interface ITracingOption {
+    enable?: boolean;
+    sample?: number | undefined;
+    propagatorTypes?: PropagatorType[];
+    allowedUrls?: Array<MatchOption | TraceOption> | undefined;
+    tracestate?: boolean;
+    baggage?: boolean;
+}
+export interface ITracingHeaders {
+    [key: string]: string;
+}
+export interface TraceSubOption {
+    tracestate?: string;
+    baggage?: string;
+    appId?: string;
+    appVersion?: string;
+    viewName?: string;
+    host?: string;
+}
+export declare function makeTracingHeaders(traceId: string, spanId: string, sampled: boolean, propagatorTypes: PropagatorType[], subOption?: TraceSubOption): ITracingHeaders;
+export declare function parseTracingOptions(tracingOption: boolean | ITracingOption): ITracingOption;