@cloudcare/rum-uniapp 1.0.1 → 2.0.1

package/README.md

@@ -2,7 +2,7 @@
 通过引入sdk文件，监控小程序性能指标，错误log，以及资源请求情况数据，上报到DataFlux 平台datakit
 
 ## 使用方法
-### 在uniapp项目入口文件`main.js`文件以如下方式引入代码
+### 在uniapp项目入口文件`main.js`文件头部位置以如下方式引入代码
 ### npm 引入(可参考uniapp官方[npm引入方式](https://uniapp.dcloud.net.cn/frame?id=npm%e6%94%af%e6%8c%81))
 ```javascript
 //#ifndef H5 || APP-PLUS || APP-NVUE || APP-PLUS-NVUE

package/cjs/boot/buildEnv.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.buildEnv = void 0;
 var buildEnv = {
-  sdkVersion: '1.0.1',
+  sdkVersion: '2.0.1',
   sdkName: 'df_uniapp_rum_sdk'
 };
 exports.buildEnv = buildEnv;

package/cjs/boot/rum.entry.js

@@ -9,8 +9,20 @@ var _utils = require("../helper/utils");
 
 var _rum = require("./rum");
 
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 var makeRum = function makeRum(startRumImpl) {
   var isAlreadyInitialized = false;
+  var globalContextManager = (0, _utils.createContextManager)();
+  var user = {};
+
+  function clonedCommonContext() {
+    return (0, _utils.extend2Lev)({}, {
+      context: globalContextManager.get(),
+      user: user
+    });
+  }
+
   var rumGlobal = {
     init: function init(Vue, userConfiguration) {
       if (typeof userConfiguration === 'undefined') {
@@ -23,8 +35,29 @@ 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;
@@ -52,6 +85,28 @@ var makeRum = function makeRum(startRumImpl) {
 
     return true;
   }
+
+  function sanitizeUser(newUser) {
+    if (_typeof(newUser) !== 'object' || !newUser) {
+      return;
+    }
+
+    var result = (0, _utils.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;
+  }
 };
 
 exports.makeRum = makeRum;

package/cjs/boot/rum.js

@@ -35,12 +35,12 @@ var _actionCollection = require("../rumEventsCollection/action/actionCollection"
 
 var _sdk = require("../core/sdk");
 
-var startRum = function startRum(Vue, userConfiguration) {
+var startRum = function startRum(Vue, userConfiguration, getCommonContext) {
   var configuration = (0, _configuration.commonInit)(userConfiguration, _buildEnv.buildEnv);
   var lifeCycle = new _lifeCycle.LifeCycle();
   var parentContexts = (0, _parentContexts.startParentContexts)(lifeCycle);
   var batch = (0, _batch.startRumBatch)(configuration, lifeCycle);
-  (0, _assembly.startRumAssembly)(userConfiguration.applicationId, configuration, lifeCycle, parentContexts);
+  (0, _assembly.startRumAssembly)(userConfiguration.applicationId, configuration, lifeCycle, parentContexts, getCommonContext);
   (0, _appCollection.startAppCollection)(lifeCycle, configuration);
   (0, _resourceCollection.startResourceCollection)(lifeCycle, configuration);
   (0, _viewCollection.startViewCollection)(lifeCycle, configuration, Vue);

package/cjs/core/boundedBuffer.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BoundedBuffer = void 0;
+
+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;
+  }
+};
+var BoundedBuffer = _BoundedBuffer;
+exports.BoundedBuffer = BoundedBuffer;

package/cjs/core/configuration.js

@@ -34,7 +34,11 @@ var DEFAULT_CONFIGURATION = {
    * arbitrary value, byte precision not needed
    */
   requestErrorResponseLengthLimit: 32 * _enums.ONE_KILO_BYTE,
-  trackInteractions: false
+  trackInteractions: false,
+  traceType: _enums.TraceType.DDTRACE,
+  traceId128Bit: false,
+  allowedTracingOrigins: [] // 新增
+
 };
 exports.DEFAULT_CONFIGURATION = DEFAULT_CONFIGURATION;
 
@@ -62,9 +66,26 @@ 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 (0, _utils.extend2Lev)(DEFAULT_CONFIGURATION, transportConfiguration);
 }
 
+function hasTraceType(traceType) {
+  if (traceType && (0, _utils.values)(_enums.TraceType).indexOf(traceType) > -1) return true;
+  return false;
+}
+
 var haveSameOrigin = function haveSameOrigin(url1, url2) {
   var parseUrl1 = (0, _utils.urlParse)(url1).getParse();
   var parseUrl2 = (0, _utils.urlParse)(url2).getParse();

package/cjs/core/dataMap.js

@@ -14,7 +14,9 @@ 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',
@@ -59,6 +61,8 @@ var dataMap = {
   resource: {
     type: _enums.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/cjs/core/transport.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Batch = exports.HttpRequest = void 0;
+exports.Batch = exports.processedMessageByDataMap = exports.HttpRequest = void 0;
 
 var _utils = require("../helper/utils");
 
@@ -13,8 +13,11 @@ var _lifeCycle = require("../core/lifeCycle");
 
 var _dataMap = require("./dataMap");
 
+var _enums = require("../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;
@@ -43,6 +46,124 @@ httpRequest.prototype = {
 var HttpRequest = httpRequest;
 exports.HttpRequest = HttpRequest;
 
+var processedMessageByDataMap = function processedMessageByDataMap(message) {
+  if (!message || !message.type) return {
+    rowStr: '',
+    rowData: undefined
+  };
+  var rowData = {
+    tags: {},
+    fields: {}
+  };
+  var hasFileds = false;
+  var rowStr = '';
+  (0, _utils.each)(_dataMap.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 = (0, _utils.extend)({}, _dataMap.commonTags, value.tags);
+      var filterFileds = ['date', 'type']; // 已经在datamap中定义过的fields和tags
+
+      (0, _utils.each)(tags, function (value_path, _key) {
+        var _value = (0, _utils.findByPath)(message, value_path);
+
+        filterFileds.push(_key);
+
+        if (_value || (0, _utils.isNumber)(_value)) {
+          rowData.tags[_key] = _value;
+          tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
+        }
+      });
+
+      if (message.tags && (0, _utils.isObject)(message.tags) && !(0, _utils.isEmptyObject)(message.tags)) {
+        // 自定义tag
+        var _tagKeys = [];
+        (0, _utils.each)(message.tags, function (_value, _key) {
+          // 如果和之前tag重名，则舍弃
+          if (filterFileds.indexOf(_key) > -1) return;
+          filterFileds.push(_key);
+
+          if (_value || (0, _utils.isNumber)(_value)) {
+            _tagKeys.push(_key);
+
+            rowData.tags[_key] = _value;
+            tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
+          }
+        });
+
+        if (_tagKeys.length) {
+          rowData.tags[CUSTOM_KEYS] = _tagKeys;
+          tagsStr.push((0, _utils.escapeRowData)(CUSTOM_KEYS) + '=' + (0, _utils.escapeRowData)(_tagKeys));
+        }
+      }
+
+      var fieldsStr = [];
+      (0, _utils.each)(value.fields, function (_value, _key) {
+        if ((0, _utils.isArray)(_value) && _value.length === 2) {
+          var type = _value[0],
+              value_path = _value[1];
+
+          var _valueData = (0, _utils.findByPath)(message, value_path);
+
+          filterFileds.push(_key);
+
+          if (_valueData || (0, _utils.isNumber)(_valueData)) {
+            rowData.fields[_key] = _valueData; // 这里不需要转译
+
+            _valueData = type === 'string' ? '"' + _valueData.replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : (0, _utils.escapeRowData)(_valueData);
+            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + _valueData);
+          }
+        } else if ((0, _utils.isString)(_value)) {
+          var _valueData = (0, _utils.findByPath)(message, _value);
+
+          filterFileds.push(_key);
+
+          if (_valueData || (0, _utils.isNumber)(_valueData)) {
+            rowData.fields[_key] = _valueData; // 这里不需要转译
+
+            _valueData = (0, _utils.escapeRowData)(_valueData);
+            fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + _valueData);
+          }
+        }
+      });
+
+      if (message.type === _enums.RumEventType.LOGGER) {
+        // 这里处理日志类型数据自定义字段
+        (0, _utils.each)(message, function (value, key) {
+          if (filterFileds.indexOf(key) === -1 && ((0, _utils.isNumber)(value) || (0, _utils.isString)(value) || (0, _utils.isBoolean)(value))) {
+            tagsStr.push((0, _utils.escapeRowData)(key) + '=' + (0, _utils.escapeRowData)(value));
+          }
+        });
+      }
+
+      if (tagsStr.length) {
+        rowStr += tagsStr.join(',');
+      }
+
+      if (fieldsStr.length) {
+        rowStr += ' ';
+        rowStr += fieldsStr.join(',');
+        hasFileds = true;
+      }
+
+      rowStr = rowStr + ' ' + message.date;
+      rowData.time = (0, _utils.toServerDuration)(message.date); // 这里不需要转译
+    }
+  });
+  return {
+    rowStr: hasFileds ? rowStr : '',
+    rowData: hasFileds ? rowData : undefined
+  };
+};
+
+exports.processedMessageByDataMap = processedMessageByDataMap;
+
 function batch(request, maxSize, bytesLimit, maxMessageSize, flushTimeout, lifeCycle) {
   this.request = request;
   this.maxSize = maxSize;
@@ -76,74 +197,7 @@ batch.prototype = {
     }
   },
   processSendData: function processSendData(message) {
-    // var data = safeJSONParse(message)
-    if (!message || !message.type) return '';
-    var rowStr = '';
-    var hasFileds = false;
-    (0, _utils.each)(_dataMap.dataMap, function (value, key) {
-      if (value.type === message.type) {
-        // 做一下别名处理
-        if (value.alias_key) {
-          rowStr += value.alias_key + ',';
-        } else {
-          rowStr += key + ',';
-        }
-
-        var tagsStr = [];
-        var tags = (0, _utils.extend)({}, _dataMap.commonTags, value.tags);
-        (0, _utils.each)(tags, function (value_path, _key) {
-          var _value = (0, _utils.findByPath)(message, value_path);
-
-          if (_value || (0, _utils.isNumber)(_value)) {
-            tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
-          }
-        });
-
-        if (message.tags.length) {
-          // 自定义tag
-          (0, _utils.each)(message.tags, function (_value, _key) {
-            if (_value || (0, _utils.isNumber)(_value)) {
-              tagsStr.push((0, _utils.escapeRowData)(_key) + '=' + (0, _utils.escapeRowData)(_value));
-            }
-          });
-        }
-
-        var fieldsStr = [];
-        (0, _utils.each)(value.fields, function (_value, _key) {
-          if (Array.isArray(_value) && _value.length === 2) {
-            var type = _value[0],
-                value_path = _value[1];
-
-            var _valueData = (0, _utils.findByPath)(message, value_path);
-
-            if (_valueData || (0, _utils.isNumber)(_valueData)) {
-              _valueData = type === 'string' ? '"' + String(_valueData).replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"' : (0, _utils.escapeRowData)(_valueData);
-              fieldsStr.push((0, _utils.escapeRowData)(_key) + '=' + _valueData);
-            }
-          } else if ((0, _utils.isString)(_value)) {
-            var _valueData = (0, _utils.findByPath)(message, _value);
-
-            if (_valueData || (0, _utils.isNumber)(_valueData)) {
-              _valueData = (0, _utils.escapeRowData)(_valueData);
-              fieldsStr.push((0, _utils.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/cjs/core/xhrProxy.js

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

package/cjs/helper/enums.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.MpHook = exports.ActionType = exports.RequestType = exports.RumEventType = exports.CLIENT_ID_TOKEN = exports.ONE_KILO_BYTE = exports.ONE_HOUR = exports.ONE_MINUTE = exports.ONE_SECOND = void 0;
+exports.TraceType = exports.MpHook = exports.ActionType = exports.RequestType = exports.RumEventType = exports.CLIENT_ID_TOKEN = exports.ONE_KILO_BYTE = exports.ONE_HOUR = exports.ONE_MINUTE = exports.ONE_SECOND = void 0;
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
@@ -52,4 +52,13 @@ var MpHook = {
   onHide: 1,
   onUnload: 1
 };
-exports.MpHook = MpHook;
+exports.MpHook = MpHook;
+var TraceType = {
+  DDTRACE: 'ddtrace',
+  ZIPKIN_MULTI_HEADER: 'zipkin',
+  ZIPKIN_SINGLE_HEADER: 'zipkin_single_header',
+  W3C_TRACEPARENT: 'w3c_traceparent',
+  SKYWALKING_V3: 'skywalking_v3',
+  JAEGER: 'jaeger'
+};
+exports.TraceType = TraceType;