@tmsfe/tms-core 0.0.89 → 0.0.92

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tms-core",
-  "version": "0.0.89",
+  "version": "0.0.92",
   "description": "tms运行时框架",
   "repository": {
     "type": "git",

package/src/report/{proxy/clone.ts → clone.ts}

@@ -3,17 +3,28 @@
  */
 
 const maxArrLen = 10;
-const maxStrLen = 30;
+const maxStrLen = 200;
 const maxFieldLen = 20;
 
-function isBasicsType(obj: any): { isBasics: boolean, value: any } {
+// 字符串字段白名单，白名单内的字段不截断
+const fieldWhiteList = [
+  'tmapExtra', // 手图跳过来时附加的加密数据，用于分析用户操作路径，奉刚要求字段不能截断
+];
+
+function isBasicsType(obj: any, isConstraintLen = true): { isBasics: boolean, value: any } {
   const type = typeof obj;
   if (obj === null || obj === undefined
     || type === 'number' || type === 'boolean' || type === 'bigint') {
     return { isBasics: true, value: obj };
   }
   if (type === 'string') {
-    const value = obj.substr(0, maxStrLen);
+    // 简单判断是否encodeURIComponent字段，如果时的话则抛弃掉
+    // 因为在后端会被decode导致反序列化时语法错误
+    if (obj.match(/%/g)?.length >= 2) {
+      return { isBasics: true, value: '' };
+    }
+
+    const value = isConstraintLen ? obj.substring(0, maxStrLen) : obj;
     return { isBasics: true, value };
   }
   if (type === 'function' || type === 'symbol') {
@@ -55,7 +66,11 @@ function deepClone(obj: any, depth = 0, maxDepth = 5): any {
       continue;
     }
     const value = obj[name];
-    const res1 = isBasicsType(value);
+    const isConstraintLen = !fieldWhiteList.includes(name);
+    if (!isConstraintLen) {
+      debugger
+    }
+    const res1 = isBasicsType(value, isConstraintLen);
     if (res1.isBasics) {
       // @ts-ignore
       newObj[name] = res1.value;

package/src/report/helper.ts

@@ -4,6 +4,7 @@
 
 // / <reference path='./types.ts'/>
 import syncApi from '../syncfnmanager';
+import clone from './clone';
 
 function getTms(): any {
   // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
@@ -33,7 +34,8 @@ function init(options: IInitOptions): void {
   };
 
   wx.onAppShow((options) => {
-    launchOptions = options;
+    // 克隆函数内会限制对象字段
+    launchOptions = clone.deepClone(options);
   });
 }
 
@@ -145,6 +147,10 @@ function getPageInfo(): IPage {
     options = page?.options;
     depth = pages.length;
   }
+
+  // 克隆函数内会限制对象字段
+  options = clone.deepClone(options);
+
   // wx_navigate_before埋点上报时可能route是一个很大的对象而不是字符串，原因不详
   if (typeof route as any !== 'string') {
     route = '';
@@ -160,6 +166,8 @@ let launchOptions: any = null;
 function getLaunchOptions(): any {
   if (launchOptions === null) {
     launchOptions = syncApi.getLaunchOptionsSync();
+    // 克隆函数内会限制对象字段
+    launchOptions = clone.deepClone(launchOptions);
   }
   return launchOptions;
 }

package/src/report/proxy/app.ts

@@ -0,0 +1,103 @@
+/**
+ * 负责小程序级的全埋点
+ */
+
+// / <reference path='./types.ts'/>
+
+import helper from './helper';
+
+// 劫持导航api
+function proxyNavigateApi(api: string): void {
+  // @ts-ignore
+  const originalApi = wx[api];
+  Object.defineProperty(wx, api, {
+    writable: true,
+    enumerable: true,
+    configurable: true,
+    value(...args: any) {
+      const { url = '' } = args[0] || {};
+      const [path, params = ''] = url.split('?');
+      const data = {};
+      params.split('&').forEach((str: string) => {
+        const [key, val] = str.split('=');
+        let value = val || '';
+        // 简单判断是否encodeURIComponent字段，如果时的话则抛弃掉
+        // 因为在后端会被decode导致反序列化时语法错误
+        if (value.indexOf('%') !== -1) {
+          value = '';
+        }
+        // @ts-ignore
+        data[key] = value;
+      });
+      helper.reportData(`wx_${api}_before`, path, data);
+
+      originalApi.apply(this, args);
+    },
+  });
+}
+
+// 劫持消息订阅接口
+function proxySubscribeMessage(): void {
+  const originalApi = wx.requestSubscribeMessage;
+  Object.defineProperty(wx, 'requestSubscribeMessage', {
+    writable: true,
+    enumerable: true,
+    configurable: true,
+    value(options: any) {
+      const { tmplIds } = options;
+      const originalSuccess = options.success || helper.emptyFunc;
+      const originalFail = options.fail || helper.emptyFunc;
+      // eslint-disable-next-line
+      options.success = function(res: any) {
+        for (const tmplId of tmplIds) {
+          const result = res[tmplId];
+          if (result) {
+            helper.reportData('wx_requestSubscribeMessage_result', tmplId, result);
+          }
+        }
+        originalSuccess.call(this, res);
+      };
+      // eslint-disable-next-line
+      options.fail = function(err: any) {
+        helper.reportData('wx_requestSubscribeMessage_fail', tmplIds, err.errMsg);
+        originalFail.call(this, err);
+      };
+      originalApi.call(this, options);
+    },
+  });
+}
+
+// 监听onAppShow跟onAppHide
+function listenerAppVisible(): void {
+  let showCount = 0; // 小程序切到前台次数(onAppShow)
+  let hideCount = 0; // 小程序切到后台次数(onAppHide)
+  let showTime = 0;  // 触发onAppShow的时间
+  let hideTime = 0;  // 触发onAppHide的时间
+  wx.onAppShow(() => {
+    showCount += 1;
+    showTime = Date.now();
+    // 距离onAppHide触发的时长
+    const lessHideTime = hideCount === 0 ? 0 : showTime - hideTime;
+    helper.reportData('App_onAppShow', { showCount, hideCount, lessHideTime });
+  });
+  wx.onAppHide(() => {
+    hideCount += 1;
+    hideTime = Date.now();
+    // 距离onAppShow触发的时长
+    const lessShowTime = hideTime - showTime;
+    helper.fastReportData('App_onAppHide', { showCount, hideCount, lessShowTime });
+  });
+}
+
+// 劫持App接口
+function init(): void {
+  listenerAppVisible();
+  proxySubscribeMessage();
+  proxyNavigateApi('navigateTo');
+  proxyNavigateApi('redirectTo');
+  proxyNavigateApi('reLaunch');
+}
+
+export default {
+  init,
+};

package/src/report/proxy/component.ts

@@ -4,8 +4,8 @@
 
 // / <reference path='./types.ts'/>
 
+import clone from '../clone';
 import helper from './helper';
-import clone from './clone';
 
 let originalComponent: any = null;
 

package/src/report/proxy/helper.ts

@@ -4,17 +4,26 @@
 
 // / <reference path='./types.ts'/>
 
-let reporter: any = null;
+function getReporter(): any {
+  // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
+  const tms = getApp()?.tms || wx.tms;
+  return tms.getReporter();
+}
 
+/**
+ * 聚合上报埋点
+ */
 function reportData(...args: any[]): any {
-  if (reporter === null) {
-    // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
-    // @ts-ignore
-    const tms = getApp()?.tms || wx.tms;
-    reporter = tms.getReporter();
-  }
   console.log('自动埋点：', ...args);
-  reporter.report2(...args);
+  getReporter().report2(...args);
+}
+
+/**
+ * 立即上报埋点
+ */
+function fastReportData(...args: any[]): any {
+  console.log('快速自动埋点：', ...args);
+  getReporter().fastReport2(...args);
 }
 
 let systemInfo: any = null;
@@ -90,6 +99,7 @@ function executeFunc(context: any, func: Function, args: any[], callback: Functi
 export default {
   emptyFunc,
   reportData,
+  fastReportData,
   executeFunc,
   getSystemInfo,
   getLastBindEvent,

package/src/report/proxy/index.ts

@@ -2,17 +2,16 @@
  * 负责页面和组件的全埋点
  */
 
+import proxyApp from './app';
 import proxyPage from './page';
 import proxyComponent from './component';
 
-let isInit = false;
+proxyApp.init();
+proxyPage.init();
+proxyComponent.init();
 
+// 目前没有需要控制初始化时机的场景
 function init(): void {
-  if (!isInit) {
-    isInit = true;
-    proxyPage.init();
-    proxyComponent.init();
-  }
 }
 
 export default {

package/src/report/proxy/page.ts

@@ -4,8 +4,8 @@
 
 // / <reference path='./types.ts'/>
 
+import clone from '../clone';
 import helper from './helper';
-import clone from './clone';
 
 // 工具为页面根节点插入的触摸事件
 const pageTouchEvent = 'onReportPageTouch';
@@ -122,62 +122,9 @@ function proxyPage(): void {
   };
 }
 
-// 劫持导航api
-function proxyNavigateApi(api: string): void {
-  // @ts-ignore
-  const originalApi = wx[api];
-  Object.defineProperty(wx, api, {
-    writable: true,
-    enumerable: true,
-    configurable: true,
-    value(...args: any) {
-      const { url = '' } = args[0] || {};
-      const [path, params = ''] = url.split('?');
-      helper.reportData(`wx_${api}_before`, path, params);
-
-      originalApi.apply(this, args);
-    },
-  });
-}
-
-// 劫持消息订阅接口
-function proxySubscribeMessage(): void {
-  const originalApi = wx.requestSubscribeMessage;
-  Object.defineProperty(wx, 'requestSubscribeMessage', {
-    writable: true,
-    enumerable: true,
-    configurable: true,
-    value(options: any) {
-      const { tmplIds } = options;
-      const originalSuccess = options.success || helper.emptyFunc;
-      const originalFail = options.fail || helper.emptyFunc;
-      // eslint-disable-next-line
-      options.success = function(res: any) {
-        for (const tmplId of tmplIds) {
-          const result = res[tmplId];
-          if (result) {
-            helper.reportData('wx_requestSubscribeMessage_result', tmplId, result);
-          }
-        }
-        originalSuccess.call(this, res);
-      };
-      // eslint-disable-next-line
-      options.fail = function(err: any) {
-        helper.reportData('wx_requestSubscribeMessage_fail', tmplIds, err.errMsg);
-        originalFail.call(this, err);
-      };
-      originalApi.call(this, options);
-    },
-  });
-}
-
 // 劫持Page
 function init(): void {
   proxyPage();
-  proxySubscribeMessage();
-  proxyNavigateApi('navigateTo');
-  proxyNavigateApi('redirectTo');
-  proxyNavigateApi('reLaunch');
 }
 
 export default {