@arms/rum-core 0.0.3 → 0.0.5

package/lib/index.d.ts

@@ -8,5 +8,9 @@ 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 };

package/lib/index.js

@@ -62,10 +62,38 @@ Object.keys(_base).forEach(function (key) {
   if (key in exports && exports[key] === _base[key]) return;
   exports[key] = _base[key];
 });
+var _polyfills = require("./utils/polyfills");
+Object.keys(_polyfills).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _polyfills[key]) return;
+  exports[key] = _polyfills[key];
+});
 var _is = require("./utils/is");
 Object.keys(_is).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
   if (key in exports && exports[key] === _is[key]) return;
   exports[key] = _is[key];
+});
+var _number = require("./utils/number");
+Object.keys(_number).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _number[key]) return;
+  exports[key] = _number[key];
+});
+var _match = require("./utils/match");
+Object.keys(_match).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _match[key]) return;
+  exports[key] = _match[key];
+});
+var _trace = require("./utils/trace");
+Object.keys(_trace).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _trace[key]) return;
+  exports[key] = _trace[key];
 });

package/lib/model/client.js

@@ -41,10 +41,11 @@ var Client = /*#__PURE__*/function () {
             return true;
           };
         }
-        ;
         if (processor.match(ctx)) {
           var res = processor.process(ctx);
-          ctx.setRumEvent(res);
+          if (res) {
+            ctx.setRumEvent(res);
+          }
         }
       }
       reporter.report(ctx);

package/lib/types/client.d.ts

@@ -2,6 +2,7 @@ import { ICollector } from './collector';
 import { IProcessor } from './processor';
 import { IReporter } from './reporter';
 import { RumEvent, RumEventBundle } from './rum-event';
+import { ITracingOption } from '../utils/trace';
 export declare enum EventType {
     /**
      * 收集数据
@@ -95,5 +96,9 @@ export interface IConfiguration {
      * 各个 collector config
      */
     collectors?: any;
+    /**
+     * tracing 配置 'tracecontext' | 'b3' | 'b3multi' | 'jaeger';
+     */
+    tracing?: boolean | ITracingOption;
     [key: string]: any;
 }

package/lib/utils/base.d.ts

@@ -3,12 +3,14 @@
  */
 export declare function interceptFunction(options: any, name: string, callback: Function): void;
 /**
- * GUID v4
- * from https://gist.github.com/jed/982883
+ * @description: GUID v4
+ * @from https://gist.github.com/jed/982883
+ * @param placeholder {String}
+ * @return {String}
  */
 export declare function generateGUID(placeholder?: string): string;
 /**
- * 唯一的字符串 universe unique id
+ * @description: 唯一的字符串 universe unique id
  * @param len {String}
  * @return {String}
  */

package/lib/utils/base.js

@@ -21,8 +21,10 @@ function interceptFunction(options, name, callback) {
 }
 
 /**
- * GUID v4
- * from https://gist.github.com/jed/982883
+ * @description: GUID v4
+ * @from https://gist.github.com/jed/982883
+ * @param placeholder {String}
+ * @return {String}
  */
 function generateGUID(placeholder) {
   return placeholder ?
@@ -31,7 +33,7 @@ function generateGUID(placeholder) {
 }
 
 /**
- * 唯一的字符串 universe unique id
+ * @description: 唯一的字符串 universe unique id
  * @param len {String}
  * @return {String}
  */

package/lib/utils/is.d.ts

@@ -2,3 +2,9 @@ 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>;

package/lib/utils/is.js

@@ -1,7 +1,8 @@
 "use strict";
 
 exports.__esModule = true;
-exports.isFunction = void 0;
+exports.isString = exports.isRegExp = exports.isNumber = exports.isFunction = exports.isBoolean = exports.isArray = void 0;
+exports.isToString = isToString;
 exports.isTypeof = isTypeof;
 exports.isUndefined = void 0;
 function isTypeof(value, type) {
@@ -12,4 +13,22 @@ var isFunction = exports.isFunction = function isFunction(func) {
 };
 var isUndefined = exports.isUndefined = function isUndefined(value) {
   return isTypeof(value, 'undefined');
+};
+var isString = exports.isString = function isString(value) {
+  return isTypeof(value, 'string');
+};
+function isToString(value, type) {
+  return Object.prototype.toString.call(value) === "[object " + type + "]";
+}
+var isArray = exports.isArray = function isArray(value) {
+  return isToString(value, 'Array');
+};
+var isRegExp = exports.isRegExp = function isRegExp(value) {
+  return isToString(value, 'RegExp');
+};
+var isBoolean = exports.isBoolean = function isBoolean(value) {
+  return isTypeof(value, 'boolean');
+};
+var isNumber = exports.isNumber = function isNumber(value) {
+  return isTypeof(value, 'number') && !isNaN(value) || isTypeof(value, 'bigint');
 };

package/lib/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/lib/utils/match.js

@@ -0,0 +1,43 @@
+"use strict";
+
+exports.__esModule = true;
+exports.isMatchOption = isMatchOption;
+exports.matchList = matchList;
+exports.urlMatch = urlMatch;
+var _is = require("./is");
+var _polyfills = require("./polyfills");
+function isMatchOption(item) {
+  return (0, _is.isString)(item) || (0, _is.isFunction)(item) || (0, _is.isRegExp)(item);
+}
+
+/**
+ * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
+ */
+function matchList(list, value, useStartsWith) {
+  if (useStartsWith === void 0) {
+    useStartsWith = false;
+  }
+  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 ? (0, _polyfills.startsWith)(value, item) : item === value;
+      }
+    } catch (e) {}
+    return false;
+  });
+}
+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/lib/utils/number.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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;

package/lib/utils/number.js

@@ -0,0 +1,15 @@
+"use strict";
+
+exports.__esModule = true;
+exports.performDraw = performDraw;
+exports.round = round;
+/**
+ * Return true if the draw is successful
+ * @param threshold between 0 and 100
+ */
+function performDraw(threshold) {
+  return threshold !== 0 && Math.random() * 100 <= threshold;
+}
+function round(num, decimals) {
+  return +num.toFixed(decimals);
+}

package/lib/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/lib/utils/polyfills.js

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.__esModule = true;
+exports.assign = assign;
+exports.endsWith = endsWith;
+exports.find = find;
+exports.startsWith = startsWith;
+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;
+}
+function startsWith(candidate, search) {
+  return candidate.slice(0, search.length) === search;
+}
+function endsWith(candidate, search) {
+  return candidate.slice(-search.length) === search;
+}
+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/lib/utils/trace.d.ts

@@ -0,0 +1,20 @@
+import { MatchOption } from "./match";
+export type PropagatorType = 'tracecontext' | 'b3' | 'b3multi' | 'jaeger';
+export type TraceOption = {
+    match: MatchOption;
+    propagatorTypes: PropagatorType[];
+};
+export declare function isTraceOption(option: any): option is TraceOption;
+export interface ITracingOption {
+    enable?: boolean;
+    sample?: number | undefined;
+    allowedUrls?: Array<MatchOption | TraceOption> | undefined;
+    tracestate?: 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 parseTracingOptions(tracingOption: boolean | ITracingOption): ITracingOption;

package/lib/utils/trace.js

@@ -0,0 +1,118 @@
+"use strict";
+
+exports.__esModule = true;
+exports.generateSpanId = generateSpanId;
+exports.generateTraceId = generateTraceId;
+exports.isTraceOption = isTraceOption;
+exports.makeTracingHeaders = makeTracingHeaders;
+exports.parseTracingOptions = parseTracingOptions;
+var _match = require("./match");
+var _is = require("./is");
+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);
+}
+function generateId(bytes) {
+  for (var i = 0; i < bytes * 2; i++) {
+    SHARED_CHAR_CODES_ARRAY[i] = Math.floor(Math.random() * 16) + 48;
+    // valid hex characters in the range 48-57 and 97-102
+    if (SHARED_CHAR_CODES_ARRAY[i] >= 58) {
+      SHARED_CHAR_CODES_ARRAY[i] += 39;
+    }
+  }
+  return String.fromCharCode.apply(null, SHARED_CHAR_CODES_ARRAY.slice(0, bytes * 2));
+}
+function generateTraceId() {
+  var traceId = generateId(TRACE_ID_BYTES);
+  // 适配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;
+}
+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) {
+  var tracingHeaders = {};
+  var sample = sampled ? '1' : '0';
+  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 'tracecontext': // https://www.w3.org/TR/trace-context/
+      default:
+        tracingHeaders['traceparent'] = "00-" + traceId + "-" + spanId + "-0" + sample;
+        if (tracestate) {
+          tracingHeaders['tracestate'] = tracestate;
+        }
+        break;
+    }
+  });
+  return tracingHeaders;
+}
+function parseTracingOptions(tracingOption) {
+  if ((0, _is.isBoolean)(tracingOption) || !tracingOption) {
+    return {
+      enable: !!tracingOption,
+      sample: 100,
+      allowedUrls: [],
+      tracestate: true
+    };
+  }
+  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$allowe = tracingOption.allowedUrls,
+    allowedUrls = _tracingOption$allowe === void 0 ? [] : _tracingOption$allowe,
+    _tracingOption$traces = tracingOption.tracestate,
+    tracestate = _tracingOption$traces === void 0 ? true : _tracingOption$traces;
+  var traceOptions = [];
+  if ((0, _is.isArray)(allowedUrls) && allowedUrls.length) {
+    allowedUrls.forEach(function (item) {
+      if ((0, _match.isMatchOption)(item)) {
+        traceOptions.push({
+          match: item,
+          propagatorTypes: ['tracecontext']
+        });
+      } else if (isTraceOption(item)) {
+        traceOptions.push(item);
+      }
+    });
+  }
+  return {
+    enable: (0, _is.isBoolean)(enable) ? enable : true,
+    sample: (0, _is.isNumber)(sample) ? sample : 100,
+    allowedUrls: traceOptions,
+    tracestate: tracestate
+  };
+}

package/package.json

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