@tmsfe/tms-core 0.0.48 → 0.0.49

package/package.json

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

package/src/report/formatV2.ts

@@ -9,7 +9,7 @@ import helper from './helper';
  * 获取埋点的基础字段
  */
 function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: number } {
-  const page = helper.getPageInfo() as IPage;
+  const { page, pageDepth } = helper.getPageInfo();
   const { networkType, location } = deviceData;
   const { appVersion, client } = helper.getInitOptions();
   const arr = new Array<string>(helper.dataArrLen);
@@ -54,7 +54,9 @@ function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: num
   arr[23] = page?.route;
   // 24: f24，当前页面的query
   arr[24] = JSON.stringify(page?.options);
-  // 25 ~ 30: 预留字段给后续扩展使用
+  // 25: f25，当前页面深度
+  arr[25] = pageDepth.toString();
+  // 26 ~ 30: 预留字段给后续扩展使用
   // 31 ~ 40: 提供给开发自定义
   // --------------------------字段列表--------------------------
   return { arr, nextIndex: 31 };

package/src/report/helper.ts

@@ -105,15 +105,20 @@ function getNowString(): string {
 /**
  * 获取当前页面信息
  */
-function getPageInfo(): IPage | null {
+function getPageInfo(): { page: IPage, pageDepth: number } {
   const pages = getCurrentPages();
+  let page: IPage;
+  let pageDepth = 1; // 页面深度
   // 首页未渲染
   if (pages.length === 0) {
     const launch = syncApi.getLaunchOptionsSync() as any;
-    return { route: launch.path, options: launch.query };
+    page = { route: launch.path, options: launch.query };
+  } else {
+    pageDepth = pages.length;
+    // 如果最后一个为空，则当前是在插件页，继续找上一个页面
+    page = pages.reverse().find((t: IPage) => t);
   }
-  // 如果最后一个为空，则当前是在插件页，继续找上一个页面
-  return pages.reverse().find((t: IPage) => t);
+  return { page, pageDepth };
 }
 
 let launchOptions: string | null = null;

package/src/report/proxy/clone.ts

@@ -0,0 +1,104 @@
+/**
+ * 负责对象的克隆
+ */
+
+const maxArrLen = 10;
+const maxStrLen = 30;
+const maxFieldLen = 20;
+
+function isBasicsType(obj: any): { 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);
+    return { isBasics: true, value };
+  }
+  if (type === 'function' || type === 'symbol') {
+    return { isBasics: true, value: undefined };
+  }
+  return { isBasics: false, value: obj };
+}
+
+function isArrayType(obj: any): { isArray: boolean, value: any } {
+  if (Array.isArray(obj)) {
+    const arr = obj.slice(0, maxArrLen);
+    return { isArray: true, value: arr };
+  }
+  return { isArray: false, value: obj };
+}
+
+/**
+ * 深表克隆
+ * @param obj
+ * @param depth 当前克隆的深度
+ * @param maxDepth 最大克隆深度
+ */
+function deepClone(obj: any, depth = 0, maxDepth = 5): any {
+  if (depth > maxDepth) {
+    return undefined;
+  }
+  const res1 = isBasicsType(obj);
+  if (res1.isBasics) {
+    return res1.value;
+  }
+  const res2 = isArrayType(obj);
+  if (res2.isArray) {
+    return res2.value.map((t: any) => deepClone(t, depth + 1, maxDepth));
+  }
+  const names = Object.getOwnPropertyNames(obj).slice(0, maxFieldLen);
+  const newObj = {};
+  for (const name of names) {
+    if (name === '__webviewId__') {
+      continue;
+    }
+    const value = obj[name];
+    const res1 = isBasicsType(value);
+    if (res1.isBasics) {
+      // @ts-ignore
+      newObj[name] = res1.value;
+      continue;
+    }
+    const res2 = isArrayType(value);
+    if (res2.isArray) {
+      // @ts-ignore
+      newObj[name] = res2.value.map((t: any) => deepClone(t, depth + 1, maxDepth));
+      continue;
+    }
+    // @ts-ignore
+    newObj[name] = deepClone(value, depth + 1, maxDepth);
+  }
+  return newObj;
+}
+
+/**
+ * 获取触发绑定事件的携带数据
+ * @param event
+ */
+function getEventExtend(event: any): any {
+  if (!event) {
+    return '';
+  }
+  const { currentTarget, mark, detail } = event;
+  const obj = {};
+  // 一般把数据放在dataset或者mark中
+  const dataset = currentTarget?.dataset;
+  if (dataset && Object.keys(dataset).length) {
+    Object.assign(obj, { dataset });
+  }
+  if (mark && Object.keys(mark).length) {
+    Object.assign(obj, { mark });
+  }
+  // 如果以上都没有，那可能就是在detail中
+  if (detail && Object.keys(obj).length === 0) {
+    Object.assign(obj, { detail });
+  }
+  return deepClone(obj);
+}
+
+export default {
+  deepClone,
+  getEventExtend,
+};

package/src/report/proxy/component.ts

@@ -2,7 +2,10 @@
  * 负责组件的全埋点
  */
 
+// / <reference path='./types.ts'/>
+
 import helper from './helper';
+import clone from './clone';
 
 let originalComponent: any = null;
 
@@ -14,11 +17,13 @@ function proxyBindEvent(componentName: string, methods: any, methodName: string)
   }
   // eslint-disable-next-line no-param-reassign
   methods[methodName] = function (...args: any[]): any {
-    const extend = helper.getEventExtend(args[0]) ; // 把触发事件附加数据也带上
+    const extend = clone.getEventExtend(args[0]) ; // 把触发事件附加数据也带上
     // 执行原函数之后再发埋点
     return helper.executeFunc(this, original, args, () => {
-      const data = helper.deepClone(this.data);
-      helper.reportData(`Component_${componentName}`, methodName, data, extend);
+      const data = clone.deepClone(this.data);
+      const eventName = `Component_${componentName}`;
+      helper.setLastBindEvent({ eventName, methodName, data, extend });
+      helper.reportData(eventName, methodName, data, extend);
     });
   };
 }

package/src/report/proxy/helper.ts

@@ -2,6 +2,8 @@
  * 自动埋点辅助类
  */
 
+// / <reference path='./types.ts'/>
+
 let reporter: any = null;
 
 function reportData(...args: any[]): any {
@@ -15,6 +17,28 @@ function reportData(...args: any[]): any {
   reporter.report2(...args);
 }
 
+let lastBindEvent: IBindEvent;
+
+/**
+ * 获取最后一个触发绑定事件埋点
+ */
+function getLastBindEvent(): IBindEvent {
+  return lastBindEvent;
+}
+
+/**
+ * 设置最后一个触发绑定事件埋点
+ * @param info
+ */
+function setLastBindEvent(info: IBindEvent): void {
+  // 获取最后一个页面（排除插件页，插件页是null）
+  const pages = getCurrentPages().reverse();
+  const page = pages.find((t: any) => t) || {};
+  // eslint-disable-next-line
+  info.pageUrl = page.route;
+  lastBindEvent = info;
+}
+
 /**
  * 空函数
  */
@@ -26,125 +50,29 @@ function emptyFunc(): void {
  * @param context
  * @param func
  * @param args
- * @param doneCallback
+ * @param callback
  */
-function executeFunc(context: any, func: Function, args: any[], doneCallback: Function): any {
+function executeFunc(context: any, func: Function, args: any[], callback: Function): any {
   const value = func.apply(context, args);
   // 如果不会返回promise
   if (!value || !value.then || typeof value.then !== 'function') {
-    doneCallback();
+    callback();
     return value;
   }
 
   return value.then((res: any) => {
-    doneCallback();
+    callback();
     return res;
   }).catch((err: any) => {
-    doneCallback();
+    callback();
     return Promise.reject(err);
   });
 }
 
-const maxArrLen = 10;
-const maxStrLen = 30;
-const maxFieldLen = 20;
-
-function isBasicsType(obj: any): { 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);
-    return { isBasics: true, value };
-  }
-  if (type === 'function' || type === 'symbol') {
-    return { isBasics: true, value: undefined };
-  }
-  return { isBasics: false, value: obj };
-}
-
-function isArrayType(obj: any): { isArray: boolean, value: any } {
-  if (Array.isArray(obj)) {
-    const arr = obj.slice(0, maxArrLen);
-    return { isArray: true, value: arr };
-  }
-  return { isArray: false, value: obj };
-}
-
-/**
- * 深表克隆
- * @param obj
- * @param depth 当前克隆的深度
- * @param maxDepth 最大克隆深度
- */
-function deepClone(obj: any, depth = 0, maxDepth = 5): any {
-  if (depth > maxDepth) {
-    return undefined;
-  }
-  const res1 = isBasicsType(obj);
-  if (res1.isBasics) {
-    return res1.value;
-  }
-  const res2 = isArrayType(obj);
-  if (res2.isArray) {
-    return res2.value.map((t: any) => deepClone(t, depth + 1, maxDepth));
-  }
-  const names = Object.getOwnPropertyNames(obj).slice(0, maxFieldLen);
-  const newObj = {};
-  for (const name of names) {
-    if (name === '__webviewId__') {
-      continue;
-    }
-    const value = obj[name];
-    const res1 = isBasicsType(value);
-    if (res1.isBasics) {
-      // @ts-ignore
-      newObj[name] = res1.value;
-      continue;
-    }
-    const res2 = isArrayType(value);
-    if (res2.isArray) {
-      // @ts-ignore
-      newObj[name] = res2.value.map((t: any) => deepClone(t, depth + 1, maxDepth));
-      continue;
-    }
-    // @ts-ignore
-    newObj[name] = deepClone(value, depth + 1, maxDepth);
-  }
-  return newObj;
-}
-
-/**
- * 获取触发绑定事件的携带数据
- * @param event
- */
-function getEventExtend(event: any): string {
-  if (!event) {
-    return '';
-  }
-  const { currentTarget, mark, detail } = event;
-  const obj = {};
-  // 一般把数据放在dataset或者mark中
-  const dataset = currentTarget?.dataset;
-  if (dataset && Object.keys(dataset).length) {
-    Object.assign(obj, { dataset });
-  }
-  if (mark && Object.keys(mark).length) {
-    Object.assign(obj, { mark });
-  }
-  // 如果以上都没有，那可能就是在detail中
-  if (detail && Object.keys(obj).length === 0) {
-    Object.assign(obj, { detail });
-  }
-  return deepClone(obj);
-}
-
 export default {
   reportData,
   emptyFunc,
   executeFunc,
-  deepClone,
-  getEventExtend,
+  getLastBindEvent,
+  setLastBindEvent,
 };

package/src/report/proxy/page.ts

@@ -2,7 +2,10 @@
  * 负责页面的全埋点
  */
 
+// / <reference path='./types.ts'/>
+
 import helper from './helper';
+import clone from './clone';
 
 // 必须上报的生命周期函数
 const mustLifeMethods = ['onLoad', 'onShow', 'onReady', 'onHide', 'onUnload'];
@@ -23,28 +26,42 @@ function proxyLifeMethod(pageOptions: any, methodName: string): void {
   const original = pageOptions[methodName] || helper.emptyFunc;
   // eslint-disable-next-line no-param-reassign
   pageOptions[methodName] = function (...args: any[]): any {
-    let exposureTime = 0; // 页面曝光时长
-    let showCount = 0; // 曝光次数
-    if (methodName === 'onShow') {
-      this.tmsPageShowCount = (this.tmsPageShowCount || 0) + 1;
-      this.tmsPageShowTime = Date.now();
-      showCount = this.tmsPageShowCount;
-    } else if (methodName === 'onHide' || methodName === 'onUnload') {
-      exposureTime = Date.now() - this.tmsPageShowTime;
-      this.tmsPageShowTime = 0;
-      showCount = this.tmsPageShowCount;
-    }
-
     // 生命周期函数先发埋点，避免次过程用户退出而丢失埋点
-    const options = helper.deepClone(args[0], 0, 1);
-    const showInfo = showCount ? { showCount, exposureTime } : null;
-    helper.reportData(`Page_${methodName}`, options, showInfo);
+    const options = clone.deepClone(args[0], 0, 1);
+    const extend = getPageLifeExtend(this, methodName);
+    helper.reportData(`Page_${methodName}`, options, extend);
 
     // 执行原函数
     return helper.executeFunc(this, original, args, helper.emptyFunc);
   };
 }
 
+// 获取生命周期函数上报时的附加信息
+function getPageLifeExtend(page: any, methodName: string): IPageLifeExtend {
+  /* eslint-disable */
+  page.tmsPageShowCount = page.tmsPageShowCount || 0;
+  // 页面生命周期内第几次曝光
+  let showCount: number;
+  // 距离onShow的时长，如果是onShow函数则为距离onLoad的时长
+  let lessShowTime: number;
+  if (methodName === 'onShow') {
+    page.tmsPageShowCount += 1;
+    page.tmsPageShowTime = Date.now();
+    showCount = page.tmsPageShowCount;
+    lessShowTime = page.tmsPageShowTime - page.tmsPageLoadTime;
+  } else if (methodName === 'onLoad') {
+    showCount = 1;
+    lessShowTime = 0;
+    page.tmsPageLoadTime = Date.now();
+  } else {
+    showCount = page.tmsPageShowCount;
+    lessShowTime = Date.now() - page.tmsPageShowTime;
+  }
+  /* eslint-enable */
+  const lastBindEvent = helper.getLastBindEvent();
+  return { showCount, lessShowTime, lastBindEvent };
+}
+
 // 劫持绑定事件
 function proxyBindEvent(pageOptions: any, methodName: string): void {
   const original = pageOptions[methodName];
@@ -53,17 +70,19 @@ function proxyBindEvent(pageOptions: any, methodName: string): void {
   }
   // eslint-disable-next-line no-param-reassign
   pageOptions[methodName] = function (...args: any[]): any {
-    const extend = helper.getEventExtend(args[0]) ; // 把触发事件附加数据也带上
+    const extend = clone.getEventExtend(args[0]) ; // 把触发事件附加数据也带上
     // 执行原函数之后再发埋点
     return helper.executeFunc(this, original, args, () => {
-      const data = helper.deepClone(this.data);
-      helper.reportData(`Page_${methodName}`, data, extend);
+      const data = clone.deepClone(this.data);
+      const eventName = `Page_${methodName}`;
+      helper.setLastBindEvent({ eventName, methodName, data, extend });
+      helper.reportData(eventName, data, extend);
     });
   };
 }
 
 // 劫持Page
-function init(): void {
+function proxyPage(): void {
   // @ts-ignore
   originalPage = Page;
   // @ts-ignore
@@ -82,6 +101,33 @@ function init(): void {
   };
 }
 
+// 劫持导航api
+function proxyNavigateApi(api: string): void {
+  // @ts-ignore
+  const owx = wx;
+  const originalApi = owx[api];
+  Object.defineProperty(owx, api, {
+    writable: true,
+    enumerable: true,
+    configurable: true,
+    value(...args: any) {
+      originalApi.apply(this, args);
+
+      const { url = '' } = args[0] || {};
+      const [path, params = ''] = url.split('?');
+      helper.reportData('wx_navigate_before', api, path, params);
+    },
+  });
+}
+
+// 劫持Page
+function init(): void {
+  proxyPage();
+  proxyNavigateApi('navigateTo');
+  proxyNavigateApi('reLaunch');
+  proxyNavigateApi('redirectTo');
+}
+
 export default {
   init,
 };

package/src/report/proxy/types.ts

@@ -0,0 +1,45 @@
+/* eslint-disable */
+
+/**
+ * 绑定的触发事件埋点
+ */
+interface IBindEvent {
+  /**
+   * 触发事件的页面url
+   */
+  pageUrl?: string,
+  /**
+   * 事件名，如 `Page_${methodName}`、`Component_${componentName}`
+   */
+  eventName: string,
+  /**
+   * 触发的函数名
+   */
+  methodName: string,
+  /**
+   * Page或者Component的data
+   */
+  data: object,
+  /**
+   * 触发事件的携带参数
+   */
+  extend: object,
+}
+
+/**
+ * 页面生命周期函数的埋点附加数据
+ */
+interface IPageLifeExtend {
+  /**
+   * 页面生命周期内第几次曝光
+   */
+  showCount: number,
+  /**
+   * 距离onShow的时长，如果是onShow函数则为距离onLoad的时长
+   */
+  lessShowTime?: number,
+  /**
+   * 最后一个触发绑定事件埋点
+   */
+  lastBindEvent: IBindEvent | null,
+}