@cloudcare/rum-uniapp 1.0.1 → 2.0.1

package/cjs/rumEventsCollection/tracing/tracer.js

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

package/cjs/rumEventsCollection/tracing/w3cTraceParentTracer.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.W3cTraceParentTracer = W3cTraceParentTracer;
+
+// === 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  配置信息
+ */
+
+
+function W3cTraceParentTracer(configuration) {
+  var rootSpanId = randomTraceId();
+  this._traceId = randomTraceId() + rootSpanId;
+  this._spanId = rootSpanId;
+}
+
+W3cTraceParentTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    return true;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  getTraceParent: function getTraceParent() {
+    // '{version}-{traceId}-{spanId}-{sampleDecision}'
+    return '00-' + this._traceId + '-' + this._spanId + '-01';
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'traceparent': this.getTraceParent()
+    };
+  }
+};

package/cjs/rumEventsCollection/tracing/zipkinMultiTracer.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ZipkinMultiTracer = ZipkinMultiTracer;
+
+// === 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  配置信息
+ */
+
+
+function ZipkinMultiTracer(configuration) {
+  var rootSpanId = randomTraceId();
+
+  if (configuration.traceId128Bit) {
+    // 128bit生成traceid
+    this._traceId = randomTraceId() + rootSpanId;
+  } else {
+    this._traceId = rootSpanId;
+  }
+
+  this._spanId = rootSpanId;
+}
+
+ZipkinMultiTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    return true;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'X-B3-TraceId': this.getTraceId(),
+      'X-B3-SpanId': this.getSpanId(),
+      //  'X-B3-ParentSpanId': '',
+      'X-B3-Sampled': '1' //  'X-B3-Flags': '0'
+
+    };
+  }
+};

package/cjs/rumEventsCollection/tracing/zipkinSingleTracer.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ZipkinSingleTracer = ZipkinSingleTracer;
+
+// === 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  配置信息
+ */
+
+
+function ZipkinSingleTracer(configuration) {
+  var rootSpanId = randomTraceId();
+  this._traceId = randomTraceId() + rootSpanId;
+  this._spanId = rootSpanId;
+}
+
+ZipkinSingleTracer.prototype = {
+  isTracingSupported: function isTracingSupported() {
+    return true;
+  },
+  getSpanId: function getSpanId() {
+    return this._spanId;
+  },
+  getTraceId: function getTraceId() {
+    return this._traceId;
+  },
+  getB3Str: function getB3Str() {
+    //{TraceId}-{SpanId}-{SamplingState}-{ParentSpanId}
+    return this._traceId + '-' + this._spanId + '-1';
+  },
+  makeTracingHeaders: function makeTracingHeaders() {
+    return {
+      'b3': this.getB3Str()
+    };
+  }
+};

package/esm/boot/buildEnv.js

@@ -1,4 +1,4 @@
 export var buildEnv = {
-  sdkVersion: '1.0.1',
+  sdkVersion: '2.0.1',
   sdkName: 'df_uniapp_rum_sdk'
 };

package/esm/boot/rum.entry.js

@@ -1,7 +1,17 @@
-import { isPercentage } from '../helper/utils';
+import { isPercentage, extend2Lev, createContextManager } from '../helper/utils';
 import { startRum } from './rum';
 export var makeRum = function makeRum(startRumImpl) {
   var isAlreadyInitialized = false;
+  var globalContextManager = createContextManager();
+  var user = {};
+
+  function clonedCommonContext() {
+    return extend2Lev({}, {
+      context: globalContextManager.get(),
+      user: user
+    });
+  }
+
   var rumGlobal = {
     init: function init(Vue, userConfiguration) {
       if (typeof userConfiguration === 'undefined') {
@@ -14,8 +24,29 @@ export var makeRum = function makeRum(startRumImpl) {
         return;
       }
 
-      startRumImpl(Vue, userConfiguration);
+      startRumImpl(Vue, userConfiguration, function () {
+        return {
+          user: user,
+          context: globalContextManager.get()
+        };
+      });
       isAlreadyInitialized = true;
+    },
+    addRumGlobalContext: globalContextManager.add,
+    removeRumGlobalContext: globalContextManager.remove,
+    getRumGlobalContext: globalContextManager.get,
+    setRumGlobalContext: globalContextManager.set,
+    setUser: function setUser(newUser) {
+      var sanitizedUser = sanitizeUser(newUser);
+
+      if (sanitizedUser) {
+        user = sanitizedUser;
+      } else {
+        console.error('Unsupported user:', newUser);
+      }
+    },
+    removeUser: function removeUser() {
+      user = {};
     }
   };
   return rumGlobal;
@@ -43,5 +74,27 @@ export var makeRum = function makeRum(startRumImpl) {
 
     return true;
   }
+
+  function sanitizeUser(newUser) {
+    if (typeof newUser !== 'object' || !newUser) {
+      return;
+    }
+
+    var result = extend2Lev({}, newUser);
+
+    if ('id' in result) {
+      result.id = String(result.id);
+    }
+
+    if ('name' in result) {
+      result.name = String(result.name);
+    }
+
+    if ('email' in result) {
+      result.email = String(result.email);
+    }
+
+    return result;
+  }
 };
 export var datafluxRum = makeRum(startRum);

package/esm/boot/rum.js

@@ -13,12 +13,12 @@ import { startPagePerformanceObservable } from '../rumEventsCollection/performan
 import { startSetDataColloction } from '../rumEventsCollection/setDataCollection';
 import { startActionCollection } from '../rumEventsCollection/action/actionCollection';
 import { sdk } from '../core/sdk';
-export var startRum = function startRum(Vue, userConfiguration) {
+export var startRum = function startRum(Vue, userConfiguration, getCommonContext) {
   var configuration = commonInit(userConfiguration, buildEnv);
   var lifeCycle = new LifeCycle();
   var parentContexts = startParentContexts(lifeCycle);
   var batch = startRumBatch(configuration, lifeCycle);
-  startRumAssembly(userConfiguration.applicationId, configuration, lifeCycle, parentContexts);
+  startRumAssembly(userConfiguration.applicationId, configuration, lifeCycle, parentContexts, getCommonContext);
   startAppCollection(lifeCycle, configuration);
   startResourceCollection(lifeCycle, configuration);
   startViewCollection(lifeCycle, configuration, Vue);

package/esm/core/boundedBuffer.js

@@ -0,0 +1,20 @@
+var _BoundedBuffer = function _BoundedBuffer() {
+  this.buffer = [];
+};
+
+_BoundedBuffer.prototype = {
+  add: function add(item) {
+    var length = this.buffer.push(item);
+
+    if (length > this.limit) {
+      this.buffer.splice(0, 1);
+    }
+  },
+  drain: function drain(fn) {
+    this.buffer.forEach(function (item) {
+      fn(item);
+    });
+    this.buffer.length = 0;
+  }
+};
+export var BoundedBuffer = _BoundedBuffer;

package/esm/core/configuration.js

@@ -1,5 +1,5 @@
-import { extend2Lev, urlParse } from '../helper/utils';
-import { ONE_KILO_BYTE, ONE_SECOND } from '../helper/enums';
+import { extend2Lev, urlParse, values } from '../helper/utils';
+import { ONE_KILO_BYTE, ONE_SECOND, TraceType } from '../helper/enums';
 var TRIM_REGIX = /^\s+|\s+$/g;
 export var DEFAULT_CONFIGURATION = {
   sampleRate: 100,
@@ -23,7 +23,11 @@ export var DEFAULT_CONFIGURATION = {
    * arbitrary value, byte precision not needed
    */
   requestErrorResponseLengthLimit: 32 * ONE_KILO_BYTE,
-  trackInteractions: false
+  trackInteractions: false,
+  traceType: TraceType.DDTRACE,
+  traceId128Bit: false,
+  allowedTracingOrigins: [] // 新增
+
 };
 
 function trim(str) {
@@ -50,9 +54,26 @@ export function commonInit(userConfiguration, buildEnv) {
     transportConfiguration.trackInteractions = !!userConfiguration.trackInteractions;
   }
 
+  if ('allowedTracingOrigins' in userConfiguration) {
+    transportConfiguration.allowedTracingOrigins = userConfiguration.allowedTracingOrigins;
+  }
+
+  if ('traceId128Bit' in userConfiguration) {
+    transportConfiguration.traceId128Bit = !!userConfiguration.traceId128Bit;
+  }
+
+  if ('traceType' in userConfiguration && hasTraceType(userConfiguration.traceType)) {
+    transportConfiguration.traceType = userConfiguration.traceType;
+  }
+
   return extend2Lev(DEFAULT_CONFIGURATION, transportConfiguration);
 }
 
+function hasTraceType(traceType) {
+  if (traceType && values(TraceType).indexOf(traceType) > -1) return true;
+  return false;
+}
+
 var haveSameOrigin = function haveSameOrigin(url1, url2) {
   var parseUrl1 = urlParse(url1).getParse();
   var parseUrl2 = urlParse(url2).getParse();

package/esm/core/dataMap.js

@@ -6,7 +6,9 @@ export var commonTags = {
   app_id: 'application.id',
   env: '_dd.env',
   version: '_dd.version',
-  userid: 'user.user_id',
+  userid: 'user.id',
+  user_email: 'user.email',
+  user_name: 'user.name',
   session_id: 'session.id',
   session_type: 'session.type',
   is_signin: 'user.is_signin',
@@ -50,6 +52,8 @@ export var dataMap = {
   resource: {
     type: RumEventType.RESOURCE,
     tags: {
+      trace_id: '_dd.trace_id',
+      span_id: '_dd.span_id',
       resource_type: 'resource.type',
       resource_status: 'resource.status',
       resource_status_group: 'resource.status_group',

package/esm/core/transport.js

@@ -1,9 +1,11 @@
-import { findByPath, escapeRowData, isNumber, each, isString, values, extend } from '../helper/utils';
+import { findByPath, escapeRowData, isNumber, each, isString, values, extend, isObject, isEmptyObject, isArray, isBoolean, toServerDuration } from '../helper/utils';
 import { sdk } from '../core/sdk';
 import { LifeCycleEventType } from '../core/lifeCycle';
-import { commonTags, dataMap } from './dataMap'; // https://en.wikipedia.org/wiki/UTF-8
+import { commonTags, dataMap } from './dataMap';
+import { RumEventType } from '../helper/enums'; // https://en.wikipedia.org/wiki/UTF-8
 
 var HAS_MULTI_BYTES_CHARACTERS = /[^\u0000-\u007F]/;
+var CUSTOM_KEYS = 'custom_keys';
 
 function addBatchPrecision(url) {
   if (!url) return url;
@@ -29,6 +31,121 @@ httpRequest.prototype = {
   }
 };
 export var HttpRequest = httpRequest;
+export var processedMessageByDataMap = function processedMessageByDataMap(message) {
+  if (!message || !message.type) return {
+    rowStr: '',
+    rowData: undefined
+  };
+  var rowData = {
+    tags: {},
+    fields: {}
+  };
+  var hasFileds = false;
+  var rowStr = '';
+  each(dataMap, function (value, key) {
+    if (value.type === message.type) {
+      if (value.alias_key) {
+        rowStr += value.alias_key + ',';
+      } else {
+        rowStr += key + ',';
+      }
+
+      rowData.measurement = key;
+      var tagsStr = [];
+      var tags = extend({}, commonTags, value.tags);
+      var filterFileds = ['date', 'type']; // 已经在datamap中定义过的fields和tags
+
+      each(tags, function (value_path, _key) {
+        var _value = findByPath(message, value_path);
+
+        filterFileds.push(_key);
+
+        if (_value || isNumber(_value)) {
+          rowData.tags[_key] = _value;
+          tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
+        }
+      });
+
+      if (message.tags && isObject(message.tags) && !isEmptyObject(message.tags)) {
+        // 自定义tag
+        var _tagKeys = [];
+        each(message.tags, function (_value, _key) {
+          // 如果和之前tag重名，则舍弃
+          if (filterFileds.indexOf(_key) > -1) return;
+          filterFileds.push(_key);
+
+          if (_value || isNumber(_value)) {
+            _tagKeys.push(_key);
+
+            rowData.tags[_key] = _value;
+            tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
+          }
+        });
+
+        if (_tagKeys.length) {
+          rowData.tags[CUSTOM_KEYS] = _tagKeys;
+          tagsStr.push(escapeRowData(CUSTOM_KEYS) + '=' + escapeRowData(_tagKeys));
+        }
+      }
+
+      var fieldsStr = [];
+      each(value.fields, function (_value, _key) {
+        if (isArray(_value) && _value.length === 2) {
+          var type = _value[0],
+              value_path = _value[1];
+
+          var _valueData = findByPath(message, value_path);
+
+          filterFileds.push(_key);
+
+          if (_valueData || isNumber(_valueData)) {
+            rowData.fields[_key] = _valueData; // 这里不需要转译
+
+            _valueData = type === 'string' ? '"' + _valueData.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : escapeRowData(_valueData);
+            fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
+          }
+        } else if (isString(_value)) {
+          var _valueData = findByPath(message, _value);
+
+          filterFileds.push(_key);
+
+          if (_valueData || isNumber(_valueData)) {
+            rowData.fields[_key] = _valueData; // 这里不需要转译
+
+            _valueData = escapeRowData(_valueData);
+            fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
+          }
+        }
+      });
+
+      if (message.type === RumEventType.LOGGER) {
+        // 这里处理日志类型数据自定义字段
+        each(message, function (value, key) {
+          if (filterFileds.indexOf(key) === -1 && (isNumber(value) || isString(value) || isBoolean(value))) {
+            tagsStr.push(escapeRowData(key) + '=' + escapeRowData(value));
+          }
+        });
+      }
+
+      if (tagsStr.length) {
+        rowStr += tagsStr.join(',');
+      }
+
+      if (fieldsStr.length) {
+        rowStr += ' ';
+        rowStr += fieldsStr.join(',');
+        hasFileds = true;
+      }
+
+      rowStr = rowStr + ' ' + message.date;
+      rowData.time = toServerDuration(message.date); // 这里不需要转译
+    }
+  });
+  return {
+    rowStr: hasFileds ? rowStr : '',
+    rowData: hasFileds ? rowData : undefined
+  };
+};
 
 function batch(request, maxSize, bytesLimit, maxMessageSize, flushTimeout, lifeCycle) {
   this.request = request;
@@ -63,74 +180,7 @@ batch.prototype = {
     }
   },
   processSendData: function processSendData(message) {
-    // var data = safeJSONParse(message)
-    if (!message || !message.type) return '';
-    var rowStr = '';
-    var hasFileds = false;
-    each(dataMap, function (value, key) {
-      if (value.type === message.type) {
-        // 做一下别名处理
-        if (value.alias_key) {
-          rowStr += value.alias_key + ',';
-        } else {
-          rowStr += key + ',';
-        }
-
-        var tagsStr = [];
-        var tags = extend({}, commonTags, value.tags);
-        each(tags, function (value_path, _key) {
-          var _value = findByPath(message, value_path);
-
-          if (_value || isNumber(_value)) {
-            tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
-          }
-        });
-
-        if (message.tags.length) {
-          // 自定义tag
-          each(message.tags, function (_value, _key) {
-            if (_value || isNumber(_value)) {
-              tagsStr.push(escapeRowData(_key) + '=' + escapeRowData(_value));
-            }
-          });
-        }
-
-        var fieldsStr = [];
-        each(value.fields, function (_value, _key) {
-          if (Array.isArray(_value) && _value.length === 2) {
-            var type = _value[0],
-                value_path = _value[1];
-
-            var _valueData = findByPath(message, value_path);
-
-            if (_valueData || isNumber(_valueData)) {
-              _valueData = type === 'string' ? '"' + String(_valueData).replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : escapeRowData(_valueData);
-              fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
-            }
-          } else if (isString(_value)) {
-            var _valueData = findByPath(message, _value);
-
-            if (_valueData || isNumber(_valueData)) {
-              _valueData = escapeRowData(_valueData);
-              fieldsStr.push(escapeRowData(_key) + '=' + _valueData);
-            }
-          }
-        });
-
-        if (tagsStr.length) {
-          rowStr += tagsStr.join(',');
-        }
-
-        if (fieldsStr.length) {
-          rowStr += ' ';
-          rowStr += fieldsStr.join(',');
-          hasFileds = true;
-        }
-
-        rowStr = rowStr + ' ' + message.date;
-      }
-    });
-    return hasFileds ? rowStr : '';
+    return processedMessageByDataMap(message).rowStr;
   },
   sizeInBytes: function sizeInBytes(candidate) {
     // Accurate byte size computations can degrade performances when there is a lot of events to process

package/esm/core/xhrProxy.js

@@ -40,7 +40,8 @@ function proxyXhr() {
       startTime: 0,
       url: arguments[0].url,
       type: RequestType.XHR,
-      responseType: arguments[0].responseType || 'text'
+      responseType: arguments[0].responseType || 'text',
+      option: arguments[0]
     };
     dataflux_xhr.startTime = now();
     var originalSuccess = arguments[0].success;
@@ -84,6 +85,6 @@ function proxyXhr() {
     beforeSendCallbacks.forEach(function (callback) {
       callback(dataflux_xhr);
     });
-    return originalXhrRequest.apply(this, arguments);
+    return originalXhrRequest.call(this, dataflux_xhr.option);
   };
 }