@cloudcare/rum-uniapp 1.0.1 → 2.0.1

package/esm/helper/enums.js

@@ -33,4 +33,12 @@ export var MpHook = {
   onResize: 1,
   onHide: 1,
   onUnload: 1
+};
+export var TraceType = {
+  DDTRACE: 'ddtrace',
+  ZIPKIN_MULTI_HEADER: 'zipkin',
+  ZIPKIN_SINGLE_HEADER: 'zipkin_single_header',
+  W3C_TRACEPARENT: 'w3c_traceparent',
+  SKYWALKING_V3: 'skywalking_v3',
+  JAEGER: 'jaeger'
 };

package/esm/helper/utils.js

@@ -6,6 +6,7 @@ var hasOwnProperty = ObjProto.hasOwnProperty;
 var slice = ArrayProto.slice;
 var toString = ObjProto.toString;
 var nativeForEach = ArrayProto.forEach;
+var nativeIsArray = Array.isArray;
 var breaker = false;
 export var isArguments = function isArguments(obj) {
   return !!(obj && hasOwnProperty.call(obj, 'callee'));
@@ -46,6 +47,13 @@ export var values = function values(obj) {
 export function round(num, decimals) {
   return +num.toFixed(decimals);
 }
+export function toServerDuration(duration) {
+  if (!isNumber(duration)) {
+    return duration;
+  }
+
+  return round(duration * 1e6, 0);
+}
 export function msToNs(duration) {
   if (typeof duration !== 'number') {
     return duration;
@@ -68,6 +76,9 @@ export var isBoolean = function isBoolean(obj) {
 export var isNumber = function isNumber(obj) {
   return toString.call(obj) === '[object Number]' && /[\d\.]+/.test(String(obj));
 };
+export var isArray = nativeIsArray || function (obj) {
+  return toString.call(obj) === '[object Array]';
+};
 export var toArray = function toArray(iterable) {
   if (!iterable) return [];
 
@@ -149,6 +160,92 @@ export function jsonStringify(value, replacer, space) {
 
   return result;
 }
+export var utf8Encode = function utf8Encode(string) {
+  string = (string + '').replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+  var utftext = '',
+      start,
+      end;
+  var stringl = 0,
+      n;
+  start = end = 0;
+  stringl = string.length;
+
+  for (n = 0; n < stringl; n++) {
+    var c1 = string.charCodeAt(n);
+    var enc = null;
+
+    if (c1 < 128) {
+      end++;
+    } else if (c1 > 127 && c1 < 2048) {
+      enc = String.fromCharCode(c1 >> 6 | 192, c1 & 63 | 128);
+    } else {
+      enc = String.fromCharCode(c1 >> 12 | 224, c1 >> 6 & 63 | 128, c1 & 63 | 128);
+    }
+
+    if (enc !== null) {
+      if (end > start) {
+        utftext += string.substring(start, end);
+      }
+
+      utftext += enc;
+      start = end = n + 1;
+    }
+  }
+
+  if (end > start) {
+    utftext += string.substring(start, string.length);
+  }
+
+  return utftext;
+};
+export var base64Encode = function base64Encode(data) {
+  data = String(data);
+  var b64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+  var o1,
+      o2,
+      o3,
+      h1,
+      h2,
+      h3,
+      h4,
+      bits,
+      i = 0,
+      ac = 0,
+      enc = '',
+      tmp_arr = [];
+
+  if (!data) {
+    return data;
+  }
+
+  data = utf8Encode(data);
+
+  do {
+    o1 = data.charCodeAt(i++);
+    o2 = data.charCodeAt(i++);
+    o3 = data.charCodeAt(i++);
+    bits = o1 << 16 | o2 << 8 | o3;
+    h1 = bits >> 18 & 0x3f;
+    h2 = bits >> 12 & 0x3f;
+    h3 = bits >> 6 & 0x3f;
+    h4 = bits & 0x3f;
+    tmp_arr[ac++] = b64.charAt(h1) + b64.charAt(h2) + b64.charAt(h3) + b64.charAt(h4);
+  } while (i < data.length);
+
+  enc = tmp_arr.join('');
+
+  switch (data.length % 3) {
+    case 1:
+      enc = enc.slice(0, -2) + '==';
+      break;
+
+    case 2:
+      enc = enc.slice(0, -1) + '=';
+      break;
+  }
+
+  return enc;
+};
 
 function hasToJSON(value) {
   return typeof value === 'object' && value !== null && value.hasOwnProperty('toJSON');
@@ -191,6 +288,29 @@ export var getQueryParamsFromUrl = function getQueryParamsFromUrl(url) {
 
   return result;
 };
+export var getURLSearchParams = function getURLSearchParams(queryString) {
+  queryString = queryString || '';
+
+  var decodeParam = function decodeParam(str) {
+    return decodeURIComponent(str);
+  };
+
+  var args = {};
+  var query = queryString.substring(1);
+  var pairs = query.split('&');
+
+  for (var i = 0; i < pairs.length; i++) {
+    var pos = pairs[i].indexOf('=');
+    if (pos === -1) continue;
+    var name = pairs[i].substring(0, pos);
+    var value = pairs[i].substring(pos + 1);
+    name = decodeParam(name);
+    value = decodeParam(value);
+    args[name] = value;
+  }
+
+  return args;
+};
 export function isPercentage(value) {
   return isNumber(value) && value >= 0 && value <= 100;
 }
@@ -353,7 +473,12 @@ export function toSnakeCase(word) {
   }).replace(/-/g, '_');
 }
 export function escapeRowData(str) {
-  if (!isString(str)) return str;
+  if (typeof str === 'object' && str) {
+    str = jsonStringify(str);
+  } else if (!isString(str)) {
+    return str;
+  }
+
   var reg = /[\s=,"]/g;
   return String(str).replace(reg, function (word) {
     return '\\' + word;
@@ -423,8 +548,8 @@ export var urlParse = function urlParse(para) {
 
   URLParser.prototype.getUrl = function () {
     var url = '';
-    url += this._values.Origin;
-    url += this._values.Port ? ':' + this._values.Port : '';
+    url += this._values.Origin; // url += this._values.Port ? ':' + this._values.Port : ''
+
     url += this._values.Path;
     url += this._values.QueryString ? '?' + this._values.QueryString : '';
     return url;
@@ -445,8 +570,9 @@ export var urlParse = function urlParse(para) {
       }
     }
 
+    this._values['Path'] = this._values['Path'] || '/';
     this._values['Hostname'] = this._values['Host'].replace(/:\d+$/, '');
-    this._values['Origin'] = this._values['Protocol'] + '://' + this._values['Hostname'];
+    this._values['Origin'] = this._values['Protocol'] + '://' + this._values['Hostname'] + (this._values.Port ? ':' + this._values.Port : '');
   };
 
   return new URLParser(para);
@@ -502,4 +628,41 @@ export var deepMixObject = function deepMixObject(targetObj) {
   }
 
   return targetObj;
-};
+};
+export function getOrigin(url) {
+  return urlParse(url).getParse().Origin;
+}
+export function createContextManager() {
+  var context = {};
+  return {
+    get: function get() {
+      return context;
+    },
+    add: function add(key, value) {
+      if (isString(key)) {
+        context[key] = value;
+      } else {
+        console.error('key 需要传递字符串类型');
+      }
+    },
+    remove: function remove(key) {
+      delete context[key];
+    },
+    set: function set(newContext) {
+      if (isObject(newContext)) {
+        context = newContext;
+      } else {
+        console.error('content 需要传递对象类型数据');
+      }
+    }
+  };
+}
+export function getActivePage() {
+  var curPages = typeof getCurrentPages === 'function' ? getCurrentPages() : [];
+
+  if (curPages.length) {
+    return curPages[curPages.length - 1];
+  }
+
+  return {};
+}

package/esm/rumEventsCollection/assembly.js

@@ -1,4 +1,4 @@
-import { extend2Lev, withSnakeCaseKeys, performDraw } from '../helper/utils';
+import { extend2Lev, withSnakeCaseKeys, performDraw, isEmptyObject } from '../helper/utils';
 import { LifeCycleEventType } from '../core/lifeCycle';
 import { RumEventType } from '../helper/enums';
 import baseInfo from '../core/baseInfo';
@@ -11,17 +11,20 @@ var SessionType = {
   SYNTHETICS: 'synthetics',
   USER: 'user'
 };
-export function startRumAssembly(applicationId, configuration, lifeCycle, parentContexts) {
+export function startRumAssembly(applicationId, configuration, lifeCycle, parentContexts, getCommonContext) {
   lifeCycle.subscribe(LifeCycleEventType.RAW_RUM_EVENT_COLLECTED, function (data) {
     var startTime = data.startTime;
     var rawRumEvent = data.rawRumEvent;
     var viewContext = parentContexts.findView(startTime);
+    var savedCommonContext = data.savedGlobalContext;
+    var customerContext = data.customerContext;
     var deviceContext = {
       device: baseInfo.deviceInfo
     };
 
     if (isTracked(configuration) && (viewContext || rawRumEvent.type === RumEventType.APP)) {
       var actionContext = parentContexts.findAction(startTime);
+      var commonContext = savedCommonContext || getCommonContext();
       var rumContext = {
         _dd: {
           sdkName: configuration.sdkName,
@@ -40,12 +43,26 @@ export function startRumAssembly(applicationId, configuration, lifeCycle, parent
           type: SessionType.USER
         },
         user: {
-          user_id: configuration.user_id || baseInfo.getClientID(),
+          id: configuration.user_id || baseInfo.getClientID(),
           is_signin: configuration.user_id ? 'T' : 'F'
         }
       };
       var rumEvent = extend2Lev(rumContext, deviceContext, viewContext, actionContext, rawRumEvent);
       var serverRumEvent = withSnakeCaseKeys(rumEvent);
+      var context = extend2Lev(commonContext.context, customerContext);
+
+      if (!isEmptyObject(context)) {
+        serverRumEvent.tags = context;
+      }
+
+      if (!isEmptyObject(commonContext.user)) {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        serverRumEvent.user = extend2Lev({
+          id: baseInfo.getClientID(),
+          is_signin: 'T'
+        }, commonContext.user);
+      }
+
       lifeCycle.notify(LifeCycleEventType.RUM_EVENT_COLLECTED, serverRumEvent);
     }
   });

package/esm/rumEventsCollection/page/index.js

@@ -1,4 +1,4 @@
-import { extend, now, throttle, UUID, isNumber } from '../../helper/utils';
+import { extend, now, throttle, UUID, isNumber, getActivePage } from '../../helper/utils';
 import { trackEventCounts } from '../trackEventCounts';
 import { LifeCycleEventType } from '../../core/lifeCycle';
 import { sdk } from '../../core/sdk'; // 劫持原小程序App方法
@@ -213,14 +213,4 @@ function trackSetDataTime(lifeCycle, callback) {
   return {
     stop: subscribe.unsubscribe
   };
-}
-
-function getActivePage() {
-  var curPages = getCurrentPages();
-
-  if (curPages.length) {
-    return curPages[curPages.length - 1];
-  }
-
-  return {};
 }

package/esm/rumEventsCollection/requestCollection.js

@@ -3,9 +3,11 @@ import { startDownloadProxy } from '../core/downloadProxy';
 import { LifeCycleEventType } from '../core/lifeCycle';
 import { isObject } from '../helper/utils';
 import { isAllowedRequestUrl } from '../rumEventsCollection/resource/resourceUtils';
+import { startTracer } from '../rumEventsCollection/tracing/tracer';
 var nextRequestIndex = 1;
 export function startRequestCollection(lifeCycle, configuration) {
-  trackXhr(lifeCycle, configuration);
+  var tracer = startTracer(configuration);
+  trackXhr(lifeCycle, configuration, tracer);
   trackDownload(lifeCycle, configuration);
 }
 
@@ -28,10 +30,11 @@ function getHeaderString(header) {
   return headerStr;
 }
 
-export function trackXhr(lifeCycle, configuration) {
+export function trackXhr(lifeCycle, configuration, tracer) {
   var xhrProxy = startXhrProxy();
   xhrProxy.beforeSend(function (context) {
     if (isAllowedRequestUrl(configuration, context.url)) {
+      tracer.traceXhr(context);
       context.requestIndex = getNextRequestIndex();
       lifeCycle.notify(LifeCycleEventType.REQUEST_STARTED, {
         requestIndex: context.requestIndex
@@ -40,6 +43,7 @@ export function trackXhr(lifeCycle, configuration) {
   });
   xhrProxy.onRequestComplete(function (context) {
     if (isAllowedRequestUrl(configuration, context.url)) {
+      tracer.clearTracingIfCancelled(context);
       lifeCycle.notify(LifeCycleEventType.REQUEST_COMPLETED, {
         duration: context.duration,
         method: context.method,
@@ -48,6 +52,8 @@ export function trackXhr(lifeCycle, configuration) {
         response: context.response,
         startTime: context.startTime,
         status: context.status,
+        traceId: context.traceId,
+        spanId: context.spanId,
         type: context.type,
         url: context.url
       });

package/esm/rumEventsCollection/resource/resourceCollection.js

@@ -1,6 +1,6 @@
 import { computePerformanceResourceDuration, computePerformanceResourceDetails, computeSize } from './resourceUtils';
 import { LifeCycleEventType } from '../../core/lifeCycle';
-import { msToNs, extend2Lev, urlParse, getQueryParamsFromUrl, replaceNumberCharByPath, jsonStringify, getStatusGroup } from '../../helper/utils';
+import { msToNs, extend2Lev, urlParse, getQueryParamsFromUrl, replaceNumberCharByPath, jsonStringify, UUID, getStatusGroup } from '../../helper/utils';
 import { RumEventType } from '../../helper/enums';
 export function startResourceCollection(lifeCycle, configuration) {
   lifeCycle.subscribe(LifeCycleEventType.REQUEST_COMPLETED, function (request) {
@@ -12,8 +12,10 @@ function processRequest(request) {
   var type = request.type;
   var timing = request.performance;
   var correspondingTimingOverrides = timing ? computePerformanceEntryMetrics(timing) : undefined;
+  var tracingInfo = computeRequestTracingInfo(request);
   var urlObj = urlParse(request.url).getParse();
   var startTime = request.startTime;
+  console.log(request, 'request=========');
   var resourceEvent = extend2Lev({
     date: startTime,
     resource: {
@@ -29,13 +31,31 @@ function processRequest(request) {
       urlQuery: jsonStringify(getQueryParamsFromUrl(request.url))
     },
     type: RumEventType.RESOURCE
-  }, correspondingTimingOverrides);
+  }, tracingInfo, correspondingTimingOverrides);
   return {
     startTime: startTime,
     rawRumEvent: resourceEvent
   };
 }
 
+function computeRequestTracingInfo(request) {
+  var hasBeenTraced = request.traceId && request.spanId;
+
+  if (!hasBeenTraced) {
+    return undefined;
+  }
+
+  return {
+    _dd: {
+      spanId: request.spanId,
+      traceId: request.traceId
+    },
+    resource: {
+      id: UUID()
+    }
+  };
+}
+
 function computePerformanceEntryMetrics(timing) {
   return {
     resource: extend2Lev({}, {

package/esm/rumEventsCollection/tracing/ddtraceTracer.js

@@ -0,0 +1,42 @@
+// === Generate a random 64-bit number in fixed-length hex format
+function randomTraceId() {
+  var digits = '0123456789abcdef';
+  var n = '';
+
+  for (var i = 0; i < 19; i += 1) {
+    var rand = Math.floor(Math.random() * 10);
+    n += digits[rand];
+  }
+
+  return n;
+}
+/**
+ * 
+ * @param {*} configuration  配置信息
+ */
+
+
+export function DDtraceTracer(configuration) {
+  this._spanId = randomTraceId();
+  this._traceId = randomTraceId();
+}
+DDtraceTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    return true;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'x-datadog-origin': 'rum',
+      // 'x-datadog-parent-id': spanId.toDecimalString(),
+      'x-datadog-sampled': '1',
+      'x-datadog-sampling-priority': '1',
+      'x-datadog-trace-id': this.getTraceId()
+    };
+  }
+};

package/esm/rumEventsCollection/tracing/jaegerTracer.js

@@ -0,0 +1,50 @@
+// === Generate a random 64-bit number in fixed-length hex format
+function randomTraceId() {
+  var digits = '0123456789abcdef';
+  var n = '';
+
+  for (var i = 0; i < 16; i += 1) {
+    var rand = Math.floor(Math.random() * 16);
+    n += digits[rand];
+  }
+
+  return n;
+}
+/**
+ * 
+ * @param {*} configuration  配置信息
+ */
+
+
+export function JaegerTracer(configuration) {
+  var rootSpanId = randomTraceId(); // this._traceId = randomTraceId() + rootSpanId // 默认用128bit,兼容其他配置
+
+  if (configuration.traceId128Bit) {
+    // 128bit生成traceid
+    this._traceId = randomTraceId() + rootSpanId;
+  } else {
+    this._traceId = rootSpanId;
+  }
+
+  this._spanId = rootSpanId;
+}
+JaegerTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    return true;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  getUberTraceId: function getUberTraceId() {
+    //{trace-id}:{span-id}:{parent-span-id}:{flags}
+    return this._traceId + ':' + this._spanId + ':' + '0' + ':' + '1';
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'uber-trace-id': this.getUberTraceId()
+    };
+  }
+};

package/esm/rumEventsCollection/tracing/skywalkingTracer.js

@@ -0,0 +1,66 @@
+import { base64Encode, urlParse, getActivePage } from '../../helper/utils'; // start SkyWalking
+
+function uuid() {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
+    /* tslint:disable */
+    var r = Math.random() * 16 | 0;
+    /* tslint:disable */
+
+    var v = c === 'x' ? r : r & 0x3 | 0x8;
+    return v.toString(16);
+  });
+}
+/**
+ * 
+ * @param {*} configuration  配置信息
+ * @param {*} requestUrl 请求的url
+ */
+
+
+export function SkyWalkingTracer(configuration, requestUrl) {
+  this._spanId = uuid();
+  this._traceId = uuid();
+  this._applicationId = configuration.applicationId;
+  this._env = configuration.env;
+  this._version = configuration.version;
+  this._urlParse = urlParse(requestUrl).getParse();
+}
+SkyWalkingTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    if (this._env && this._version && this._urlParse) return true;
+    return false;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  getSkyWalkingSw8: function getSkyWalkingSw8() {
+    try {
+      var traceIdStr = String(base64Encode(this._traceId));
+      var segmentId = String(base64Encode(this._spanId));
+      var service = String(base64Encode(this._applicationId + '_rum_' + this.env));
+      var instance = String(base64Encode(this._version));
+      var activePage = getActivePage();
+      var endpointPage = '';
+
+      if (activePage && activePage.route) {
+        endpointPage = activePage.route;
+      }
+
+      var endpoint = String(base64Encode(endpointPage));
+      var peer = String(base64Encode(this._urlParse.Host));
+      var index = '0'; // var values = `${1}-${traceIdStr}-${segmentId}-${index}-${service}-${instance}-${endpoint}-${peer}`;
+
+      return '1-' + traceIdStr + '-' + segmentId + '-' + index + '-' + service + '-' + instance + '-' + endpoint + '-' + peer;
+    } catch (err) {
+      return '';
+    }
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'sw8': this.getSkyWalkingSw8()
+    };
+  }
+};

package/esm/rumEventsCollection/tracing/tracer.js

@@ -0,0 +1,90 @@
+import { each, extend, getOrigin } from '../../helper/utils';
+import { TraceType } from '../../helper/enums';
+import { DDtraceTracer } from './ddtraceTracer';
+import { SkyWalkingTracer } from './skywalkingTracer';
+import { JaegerTracer } from './jaegerTracer';
+import { ZipkinSingleTracer } from './zipkinSingleTracer';
+import { ZipkinMultiTracer } from './zipkinMultiTracer';
+import { W3cTraceParentTracer } from './w3cTraceParentTracer';
+export function clearTracingIfCancelled(context) {
+  if (context.status === 0) {
+    context.traceId = undefined;
+    context.spanId = undefined;
+  }
+}
+export function startTracer(configuration) {
+  return {
+    clearTracingIfCancelled: clearTracingIfCancelled,
+    traceXhr: function traceXhr(context) {
+      return injectHeadersIfTracingAllowed(configuration, context, function (tracingHeaders) {
+        context.option = extend({}, context.option);
+        var header = {};
+
+        if (context.option.header) {
+          each(context.option.header, function (value, key) {
+            header[key] = value;
+          });
+        }
+
+        context.option.header = extend(header, tracingHeaders);
+      });
+    }
+  };
+}
+
+function isAllowedUrl(configuration, requestUrl) {
+  var requestOrigin = getOrigin(requestUrl);
+  var flag = false;
+  each(configuration.allowedTracingOrigins, function (allowedOrigin) {
+    if (requestOrigin === allowedOrigin || allowedOrigin instanceof RegExp && allowedOrigin.test(requestOrigin)) {
+      flag = true;
+      return false;
+    }
+  });
+  return flag;
+}
+
+export function injectHeadersIfTracingAllowed(configuration, context, inject) {
+  if (!isAllowedUrl(configuration, context.url) || !configuration.traceType) {
+    return;
+  }
+
+  var tracer;
+
+  switch (configuration.traceType) {
+    case TraceType.DDTRACE:
+      tracer = new DDtraceTracer();
+      break;
+
+    case TraceType.SKYWALKING_V3:
+      tracer = new SkyWalkingTracer(configuration, context.url);
+      break;
+
+    case TraceType.ZIPKIN_MULTI_HEADER:
+      tracer = new ZipkinMultiTracer(configuration);
+      break;
+
+    case TraceType.JAEGER:
+      tracer = new JaegerTracer(configuration);
+      break;
+
+    case TraceType.W3C_TRACEPARENT:
+      tracer = new W3cTraceParentTracer(configuration);
+      break;
+
+    case TraceType.ZIPKIN_SINGLE_HEADER:
+      tracer = new ZipkinSingleTracer(configuration);
+      break;
+
+    default:
+      break;
+  }
+
+  if (!tracer || !tracer.isTracingSupported()) {
+    return;
+  }
+
+  context.traceId = tracer.getTraceId();
+  context.spanId = tracer.getSpanId();
+  inject(tracer.makeTracingHeaders());
+}