@tmsfe/tms-core 0.0.52 → 0.0.55

package/package.json

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

package/src/report/formatV1.ts

@@ -12,7 +12,7 @@ function getBaseData(deviceData: IDeviceData): DataItem[] {
   const { networkType, location } = deviceData;
   const { appVersion, client } = helper.getInitOptions();
   const { host } = helper.getSystemInfo();
-  const arr = new Array<string>(helper.dataArrLen);
+  const arr = new Array<DataItem>(helper.dataArrLen);
   // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空
   // ++++++++++++++++++++++++++字段列表++++++++++++++++++++++++++
   // 0: log_time，日志入库时间
@@ -44,15 +44,15 @@ function getBaseData(deviceData: IDeviceData): DataItem[] {
   // 18: f18，city - 城市
   arr[18] = location.cityName;
   // 19: f19，当前小程序运行的宿主环境
-  arr[19] = helper.convert2String(host);
+  arr[19] = host;
   // 28: f28，sinan、mycar等
   arr[28] = client;
   // 29: f29，小程序场景值
   arr[29] = helper.getAppScene();
   // 33: f33，系统信息
-  arr[33] = helper.getSystemInfoString();
+  arr[33] = helper.getSystemInfo();
   // 36: f36，小程序启动时的url和参数
-  arr[36] = helper.getLaunchOptionsString();
+  arr[36] = helper.getLaunchOptions();
   // --------------------------字段列表--------------------------
   return arr;
 }
@@ -64,7 +64,7 @@ function jointData(data: IOldParams, deviceData: IDeviceData): DataItem[] {
   const arr = getBaseData(deviceData);
   const keys = Object.keys(data) as any as number[];
   for (const key of keys) {
-    arr[key] = helper.convert2String(data[key]);
+    arr[key] = data[key];
   }
   return arr;
 }

package/src/report/formatV2.ts

@@ -8,11 +8,10 @@ import helper from './helper';
 /**
  * 获取埋点的基础字段
  */
-function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: number } {
-  const { page, pageDepth } = helper.getPageInfo();
+function getBaseData(page: IPage, deviceData: IDeviceData): { arr: DataItem[], nextIndex: number } {
   const { networkType, location } = deviceData;
   const { appVersion, client } = helper.getInitOptions();
-  const arr = new Array<string>(helper.dataArrLen);
+  const arr = new Array<DataItem>(helper.dataArrLen);
   // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空
   // ++++++++++++++++++++++++++字段列表++++++++++++++++++++++++++
   // 0: log_time，日志入库时间
@@ -43,20 +42,22 @@ function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: num
   // 18: f18，city - 城市
   arr[18] = location.cityName;
   // 19: f19，系统信息
-  arr[19] = helper.getSystemInfoString();
+  arr[19] = helper.getSystemInfo();
   // 20: f20，sinan、mycar等
   arr[20] = client;
   // 21: f21，小程序场景值
   arr[21] = helper.getAppScene();
   // 22: f22，小程序启动时的url和参数
-  arr[22] = helper.getLaunchOptionsString();
+  arr[22] = helper.getLaunchOptions();
   // 23: f23，当前页面的url
-  arr[23] = page?.route;
+  arr[23] = page.route;
   // 24: f24，当前页面的query
-  arr[24] = JSON.stringify(page?.options);
+  arr[24] = page.options;
   // 25: f25，当前页面深度
-  arr[25] = pageDepth.toString();
-  // 26 ~ 30: 预留字段给后续扩展使用
+  arr[25] = page.depth;
+  // 26: f26，一次小程序生命周期中的埋点统一标记
+  arr[26] = helper.getLifeReportKey();
+  // 27 ~ 30: 预留字段给后续扩展使用
   // 31 ~ 40: 提供给开发自定义
   // --------------------------字段列表--------------------------
   return { arr, nextIndex: 31 };
@@ -65,15 +66,15 @@ function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: num
 /**
  * 拼接埋点数组
  */
-function jointData(data: any[], deviceData: IDeviceData): DataItem[] {
-  const { arr, nextIndex } = getBaseData(deviceData);
+function jointData(page: IPage, data: any[], deviceData: IDeviceData): DataItem[] {
+  const { arr, nextIndex } = getBaseData(page, deviceData);
   let index = nextIndex;
   for (const item of data) {
     if (index >= arr.length) {
       console.error('埋点参数个数超出上限而被截断', data);
       break;
     }
-    arr[index] = helper.convert2String(item);
+    arr[index] = item;
     index += 1;
   }
   return arr;
@@ -83,9 +84,11 @@ function jointData(data: any[], deviceData: IDeviceData): DataItem[] {
  * 格式化上报埋点数据
  */
 function formatData(data: any[]): Promise<DataItem[]> {
+  // getDeviceData可能会太慢导致页面已跳转完，所以先获取page比较准确
+  const page = helper.getPageInfo();
   return new Promise<DataItem[]>((resolve) => {
     helper.getDeviceData().then((deviceData: IDeviceData) => {
-      const arr = jointData(data, deviceData);
+      const arr = jointData(page, data, deviceData);
       resolve(arr);
     });
   });
@@ -95,7 +98,9 @@ function formatData(data: any[]): Promise<DataItem[]> {
  * 格式化快速上报埋点数据，不依赖用户位置
  */
 function formatFastData(data: any[]): DataItem[] {
-  return jointData(data, helper.getCacheDeviceData());
+  const page = helper.getPageInfo();
+  const deviceData = helper.getCacheDeviceData();
+  return jointData(page, data, deviceData);
 }
 
 export default {

package/src/report/helper.ts

@@ -53,25 +53,13 @@ function getSystemInfo(): ISystemInfo {
   return systemInfo;
 }
 
-let systemString: string | null = null;
-
 /**
- * 获取系统信息并格式化成字符串
- */
-function getSystemInfoString(): string {
-  if (systemString === null) {
-    systemString = JSON.stringify(getSystemInfo());
-  }
-  return systemString;
-}
-
-/**
- * 把值/对象转成字符串
+ * 把值或对象转成字符串
  * @param value
  */
-function convert2String(value: any): string {
+function convert2String(value: any): string | null {
   if (value === null || value === undefined) {
-    return '';
+    return null;
   }
   const type = typeof value;
   if (type === 'string') {
@@ -83,6 +71,17 @@ function convert2String(value: any): string {
   return String(value);
 }
 
+/**
+ * 转成字符串数据
+ * @param arr
+ */
+function convert2StringArray(arr: DataItem[]) {
+  for (let i = 0; i < arr.length; i++) {
+    // eslint-disable-next-line no-param-reassign
+    arr[i] = convert2String(arr[i]);
+  }
+}
+
 function num2Str(num: number, maxLength = 2): string {
   return num.toString().padStart(maxLength, '0');
 }
@@ -92,7 +91,7 @@ function num2Str(num: number, maxLength = 2): string {
  */
 function getNowString(): string {
   const date = new Date();
-  const year = date.getFullYear().toString();
+  const year = date.getFullYear();
   const month = num2Str(date.getMonth() + 1);
   const day = num2Str(date.getDate());
   const hours = num2Str(date.getHours());
@@ -102,34 +101,50 @@ function getNowString(): string {
   return `${year}${month}${day}${hours}${minutes}${seconds}${ms}`;
 }
 
+let lifeReportKey = '';
+
+/**
+ * 一次小程序生命周期中的埋点统一标记
+ */
+function getLifeReportKey(): string {
+  if (lifeReportKey === '') {
+    lifeReportKey = getNowString();
+  }
+  return lifeReportKey;
+}
+
 /**
  * 获取当前页面信息
  */
-function getPageInfo(): { page: IPage, pageDepth: number } {
+function getPageInfo(): IPage {
   const pages = getCurrentPages();
-  let page: IPage;
-  let pageDepth = 1; // 页面深度
-  // 首页未渲染
+  let route: string;
+  let options: object;
+  let depth: number; // 页面深度
+  // 刚启动时首页未渲染
   if (pages.length === 0) {
     const launch = syncApi.getLaunchOptionsSync() as any;
-    page = { route: launch.path, options: launch.query };
+    route = launch.path;
+    options = launch.qurey;
+    depth = 1;
   } else {
-    pageDepth = pages.length;
     // 如果最后一个为空，则当前是在插件页，继续找上一个页面
-    page = pages.reverse().find((t: IPage) => t);
+    const page = pages.reverse().find((t: any) => t);
+    route = page?.route;
+    options = page?.options;
+    depth = pages.length;
   }
-  return { page, pageDepth };
+  return { route, options, depth };
 }
 
-let launchOptions: string | null = null;
+let launchOptions: object | null = null;
 
 /**
  * 获取小程序启动参数
  */
-function getLaunchOptionsString(): string {
+function getLaunchOptions(): object {
   if (launchOptions === null) {
-    const obj = syncApi.getLaunchOptionsSync();
-    launchOptions = JSON.stringify(obj);
+    launchOptions = syncApi.getLaunchOptionsSync();
   }
   return launchOptions;
 }
@@ -145,9 +160,9 @@ function getLaunchFrom(): string {
 /**
  * 获取小程序启动场景值
  */
-function getAppScene(): string {
+function getAppScene(): number {
   const { scene = -1 } = syncApi.getLaunchOptionsSync() as any;
-  return scene.toString();
+  return scene;
 }
 
 // 是否爬虫
@@ -159,7 +174,7 @@ let isCrawler: boolean | null = null;
 function canReport(): boolean {
   if (isCrawler === null) {
     const scene = getAppScene();
-    isCrawler = scene === '1129' || scene === '1030';
+    isCrawler = scene === 1129 || scene === 1030;
   }
   // 小程序爬虫，不上报
   return !isCrawler;
@@ -225,11 +240,11 @@ export default {
   getTms,
   getInitOptions,
   getSystemInfo,
-  getSystemInfoString,
-  convert2String,
+  convert2StringArray,
   getNowString,
+  getLifeReportKey,
   getPageInfo,
-  getLaunchOptionsString,
+  getLaunchOptions,
   getLaunchFrom,
   getAppScene,
   canReport,

package/src/report/sender.ts

@@ -6,7 +6,7 @@
 import helper from './helper';
 
 // 缓存队列
-const cacheArr = new Array<DataItem[]>();
+const cacheArr = new Array<string[]>();
 const max = 50; // 超过最大限制就马上发送
 const delay = 3000; // 延迟N毫秒再聚合发送
 let timer = 0; // 计时器
@@ -73,6 +73,7 @@ function requestFail(batch: DataItem[][]): void {
  */
 function send(arr: DataItem[]): void {
   stopTimer();
+  helper.convert2StringArray(arr);
   cacheArr.unshift(arr); // 如果队列中很多，排前面比较稳妥
   batchSendData();
 }
@@ -82,6 +83,7 @@ function send(arr: DataItem[]): void {
  * @param arr
  */
 function queue(arr: DataItem[]): void {
+  helper.convert2StringArray(arr);
   cacheArr.push(arr);
   checkQueue(false);
 }

package/src/report/types.ts

@@ -1,6 +1,6 @@
 /* eslint-disable */
 
-type DataItem = string | null | undefined;
+type DataItem = any;
 
 /**
  * 初始化参数对象
@@ -16,6 +16,7 @@ interface IInitOptions {
 interface IPage {
   route: string,
   options: object,
+  depth: number,
 }
 
 /**