@tmsfe/tms-core 0.0.32 → 0.0.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tms-core",
-  "version": "0.0.32",
+  "version": "0.0.35",
   "description": "tms运行时框架",
   "repository": {
     "type": "git",
@@ -10,7 +10,7 @@
     "dev": "rimraf dist &&  rollup -wc --environment TARGET:tms-core,INTER_ENV:public",
     "build": "rimraf dist && rollup -c --environment TARGET:tms-core,INTER_ENV:public"
   },
-  "main": "dist/index",
+  "main": "src/index",
   "miniprogram": "src",
   "buildOptions": {
     "formats": [

package/src/index-proxy.js

@@ -7,7 +7,6 @@
 
 import syncApi from './syncfnmanager';
 import md5 from './md5';
-import CloudReport from './cloudReport';
 import { rpxToPx } from './rpx';
 import { serialize } from './objUtils';
 import * as stringUtils from './stringUtils';
@@ -40,7 +39,6 @@ function invoke(obj, funcName, args) {
 function initProxy(appObj, options) {
   app = appObj;
   initOptions = options;
-  CloudReport.init(options);
 }
 
 function awaitTMS() {
@@ -75,8 +73,7 @@ asyncFuncNames.forEach((funcName) => {
 // 返回对象的函数，并且对象的所有接口都可以以promise的形式返回
 const objFuncs = {};
 const objFuncNames = [
-  'getLogManager', 'getRealtimeLogManager', 'getReporter',
-  'getFastReporter', 'getEventDispatcher',
+  'getLogManager', 'getRealtimeLogManager', 'getReporter', 'getEventDispatcher',
 ];
 objFuncNames.forEach((funcName) => {
   objFuncs[funcName] = function (...args1) {
@@ -203,23 +200,10 @@ function getHomePage() {
   return initOptions.homePage;
 }
 
-function getCloudReport() {
-  if (tms) {
-    return tms.getCloudReport();
-  }
-  return CloudReport;
-}
-
-wx.onAppShow((options) => {
-  // 避免vendor分包加载太慢而错过onAppShow
-  wx.tmsAppShowOptions = options;
-});
-
 const api = {
   isProxy: true, // 方便定位问题时判断是否proxy
   initProxy,
   md5,
-  getCloudReport,
   getCarManager,
   getLocationManager,
   rpxToPx,

package/src/index.js

@@ -1,6 +1,5 @@
 import Request from './request';
-import FastReport from './fastreport';
-import CloudReport from './cloudReport';
+import Reporter from './report/index';
 import { getConfig } from './config';
 import syncApi from './syncfnmanager';
 import nav from './navigator';
@@ -8,7 +7,6 @@ import { getLogManager, getRealtimeLogManager } from './log';
 import { setEnvInfo, getEnvInfo, setAuthInfo, setAppPagePaths, isAppPageExist, getHomePage } from './env';
 import md5 from './md5';
 import { callCloudFunc } from './cloudService';
-import { cache as report, startListenApp } from './report';
 import EventDispatcher from './eventDispatcher';
 import { serialize } from './objUtils';
 import { rpxToPx } from './rpx';
@@ -66,18 +64,7 @@ const createRequest = (config = {}) => new Request(config);
  * @example
  * getReporter().report(reportData, reportNow);
  */
-const getReporter = () => ({ report });
-
-/**
- * @description 埋点上报(快速上报，不依赖用户userId标识)
- * @returns {Class} [FastReporter类](#class-fastreport)
- */
-const getFastReporter = () => FastReport;
-
-/**
- * @description 云函数埋点上报
- */
-const getCloudReport = () => CloudReport;
+const getReporter = () => Reporter;
 
 /**
  * @description 自定义事件机制
@@ -103,7 +90,6 @@ const getLocationBaseClass = () => LocationBase;
  * @returns {undefined} 无返回值.
  */
 const init = (options = {}) => {
-  startListenApp();
   const { appVersion, wxAppId, client, defaultHost, cloudEnvId, appEnv, appPagePaths, homePage } = options;
   const envInfo = {
     wxAppId,
@@ -114,7 +100,7 @@ const init = (options = {}) => {
   };
   setEnvInfo(envInfo);
   setAppPagePaths(appPagePaths, homePage);
-  CloudReport.init(envInfo);
+  Reporter.init(envInfo);
   Request.defaultHost = defaultHost;
   // 初始化云环境
   wx.cloud.init({ env: cloudEnvId });
@@ -140,8 +126,6 @@ const api = {
   getRealtimeLogManager,
   md5,
   getReporter,
-  getCloudReport,
-  getFastReporter,
   getLocationManager,
   getLocationBaseClass,
   getEventDispatcher,

package/src/report/formatV1.ts

@@ -0,0 +1,92 @@
+/**
+ * 格式化旧埋点
+ */
+
+// / <reference path='./types.ts'/>
+import helper from './helper';
+
+/**
+ * 获取埋点的基础字段
+ */
+function getBaseData(deviceData: IDeviceData): DataItem[] {
+  const arr = new Array<string>(helper.dataArrLen);
+  const { networkType, location } = deviceData;
+  const { appVersion, client } = helper.getInitOptions();
+  // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空
+  // ++++++++++++++++++++++++++字段列表++++++++++++++++++++++++++
+  // 0: log_time，日志入库时间
+  // 1: access_time，用户点击时间，服务端统一处理
+  // 2: user_ip，前端无需赋值
+  // 3: qimei，灯塔中的用户ID
+  // 4: imei，Android手机的imei IOS系统中的idfv 车联网中的wecarid
+  // 5: user_id，用户ID
+  // 6: qq_no，登录QQ的openid，
+  // 7: wechat_id，登录微信的openid
+  // 8: phone_no，手机号
+  // 9: platform，客户端请求来源，小程序是2
+  arr[9] = '2';
+  // 10: app_version，客户端|小程序版本号
+  arr[10] = appVersion;
+  // 11: channel，外部推广渠道或车辆所属渠道
+  // 12: net_type，wifi、3G、4G等
+  arr[12] = networkType;
+  // 13: product_id，手图APP、车联网等
+  arr[13] = '2';
+  // 14: busi_type，1: 定位、2: 检索、3: 导航、4: 车主服务、5: 小程序
+  arr[14] = '5';
+  // 15: request_id，请求ID，由接入层填充
+  // 16: session_id，这里表示渠道公共参数
+  arr[16] = helper.getLaunchFrom();
+  // 17: f17，province - 省份
+  arr[17] = location.province;
+  // 18: f18，city - 城市
+  arr[18] = location.cityName;
+  // 19: f19，当前小程序运行的宿主环境
+  arr[19] = helper.getSystemInfo().host;
+  // 28: f28，sinan、mycar等
+  arr[28] = client;
+  // 29: f29，小程序场景值
+  arr[29] = helper.getAppScene();
+  // 33: f33，系统信息
+  arr[33] = helper.getSystemInfoString();
+  // 36: f36，小程序启动时的参数
+  arr[36] = helper.getLaunchOptionsString();
+  // --------------------------字段列表--------------------------
+  return arr;
+}
+
+/**
+ * 拼接埋点数组
+ */
+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]);
+  }
+  return arr;
+}
+
+/**
+ * 格式化普通埋点数据
+ */
+function formatData(data: IOldParams): Promise<DataItem[]> {
+  return new Promise<DataItem[]>((resolve) => {
+    helper.getDeviceData().then((deviceData: IDeviceData) => {
+      const arr = jointData(data, deviceData);
+      resolve(arr);
+    });
+  });
+}
+
+/**
+ * 格式化快速上报埋点数据，不依赖用户位置
+ */
+function formatFastData(data: IOldParams): DataItem[] {
+  return jointData(data, helper.defaultDevice);
+}
+
+export default {
+  formatData,
+  formatFastData,
+};

package/src/report/formatV2.ts

@@ -0,0 +1,101 @@
+/**
+ * 格式化新埋点
+ */
+
+// / <reference path='./types.ts'/>
+import helper from './helper';
+
+/**
+ * 获取埋点的基础字段
+ */
+function getBaseData(deviceData: IDeviceData): { arr: DataItem[], nextIndex: number } {
+  const page = helper.getPageInfo() as IPage;
+  const { networkType, location } = deviceData;
+  const { appVersion, client } = helper.getInitOptions();
+  const arr = new Array<string>(helper.dataArrLen);
+  // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空
+  // ++++++++++++++++++++++++++字段列表++++++++++++++++++++++++++
+  // 0: log_time，日志入库时间
+  // 1: access_time，用户点击时间，服务端统一处理
+  // 2: user_ip，前端无需赋值
+  // 3: qimei，灯塔中的用户ID
+  // 4: imei，Android手机的imei IOS系统中的idfv 车联网中的wecarid
+  // 5: user_id，用户ID
+  // 6: qq_no，登录QQ的openid，
+  // 7: wechat_id，登录微信的openid
+  // 8: phone_no，手机号
+  // 9: platform，客户端请求来源，小程序是2
+  arr[9] = '2';
+  // 10: app_version，客户端|小程序版本号
+  arr[10] = appVersion;
+  // 11: channel，外部推广渠道或车辆所属渠道
+  // 12: net_type，wifi、3G、4G等
+  arr[12] = networkType;
+  // 13: product_id，手图APP、车联网等
+  arr[13] = '2';
+  // 14: busi_type，1: 定位、2: 检索、3: 导航、4: 车主服务、5: 小程序
+  arr[14] = '5';
+  // 15: request_id，请求ID，由接入层填充
+  // 16: session_id，标识用户一次访问过程的ID
+  // 17: f17，province - 省份
+  arr[17] = location.province;
+  // 18: f18，city - 城市
+  arr[18] = location.cityName;
+  // 19: f19，系统信息
+  arr[19] = helper.getSystemInfoString();
+  // 20: f20，sinan、mycar等
+  arr[20] = client;
+  // 21: f21，小程序场景值
+  arr[21] = helper.getAppScene();
+  // 22: f22，小程序启动时的参数
+  arr[22] = helper.getLaunchOptionsString();
+  // 23: f23，当前页面的url
+  arr[23] = page.route;
+  // 24: f24，当前页面的query
+  arr[24] = JSON.stringify(page.options);
+  // 25 ~ 30: 预留字段给后续扩展使用
+  // 31 ~ 40: 提供给开发自定义
+  // --------------------------字段列表--------------------------
+  return { arr, nextIndex: 31 };
+}
+
+/**
+ * 拼接埋点数组
+ */
+function jointData(data: any[], deviceData: IDeviceData): DataItem[] {
+  const { arr, nextIndex } = getBaseData(deviceData);
+  let index = nextIndex;
+  for (const item of data) {
+    if (index >= arr.length) {
+      console.error('埋点参数个数超出上限而被截断', data);
+      break;
+    }
+    arr[index] = helper.convert2String(item);
+    index += 1;
+  }
+  return arr;
+}
+
+/**
+ * 格式化上报埋点数据
+ */
+function formatData(data: any[]): Promise<DataItem[]> {
+  return new Promise<DataItem[]>((resolve) => {
+    helper.getDeviceData().then((deviceData: IDeviceData) => {
+      const arr = jointData(data, deviceData);
+      resolve(arr);
+    });
+  });
+}
+
+/**
+ * 格式化快速上报埋点数据，不依赖用户位置
+ */
+function formatFastData(data: any[]): DataItem[] {
+  return jointData(data, helper.defaultDevice);
+}
+
+export default {
+  formatData,
+  formatFastData,
+};

package/src/report/helper.ts

@@ -0,0 +1,223 @@
+/**
+ * 埋点辅助函数
+ */
+
+// / <reference path='./types.ts'/>
+import syncApi from '../syncfnmanager';
+
+function getTms(): any {
+  // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
+  return getApp()?.tms || wx.tms;
+}
+
+let initOptions: IInitOptions;
+
+/**
+ * 初始化
+ */
+function init(options: IInitOptions): void {
+  if (!initOptions) {
+    initOptions = options;
+  }
+}
+
+/**
+ * 获取初始化时的参数
+ */
+function getInitOptions(): IInitOptions {
+  return initOptions;
+}
+
+let systemInfo: ISystemInfo | null = null;
+
+/**
+ * 获取系统信息
+ */
+function getSystemInfo(): ISystemInfo {
+  if (systemInfo === null) {
+    const system = syncApi.getSystemInfoSync() as any;
+    // eslint-disable-next-line
+    const { model = '', version: wxVersion = '', platform = '', SDKVersion = '', host = '' } = system;
+    systemInfo = { model, wxVersion, platform, SDKVersion, host };
+  }
+  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 {
+  const type = typeof value;
+  if (type === 'string') {
+    return value;
+  }
+  if (type === 'object') {
+    return JSON.stringify(value);
+  }
+  return String(value);
+}
+
+/**
+ * 获取当前页面信息
+ */
+function getPageInfo(): IPage | null {
+  const pages = getCurrentPages();
+  // 首页未渲染
+  if (pages.length === 0) {
+    const launch = syncApi.getLaunchOptionsSync() as any;
+    return { route: launch.path, options: launch.query };
+  }
+  const page = pages.pop();
+  // 插件页
+  if (!page) {
+    return null;
+  }
+  return page;
+}
+
+let launchOptions: string | null = null;
+
+/**
+ * 获取小程序启动参数
+ */
+function getLaunchOptionsString(): string {
+  if (launchOptions === null) {
+    const obj = syncApi.getLaunchOptionsSync() as any;
+    launchOptions = obj.query ? JSON.stringify(obj.query) : '';
+  }
+  return launchOptions;
+}
+
+/**
+ * 获取小程序启动时的from参数
+ */
+function getLaunchFrom(): string {
+  const obj = syncApi.getLaunchOptionsSync() as any;
+  return obj.query?.from as string || '';
+}
+
+/**
+ * 获取小程序启动场景值
+ */
+function getAppScene(): string {
+  const { scene = -1 } = syncApi.getLaunchOptionsSync() as any;
+  return scene.toString();
+}
+
+// 给非空字段都encodeURIComponent一下
+function encodeItems(arr: DataItem[]): DataItem[] {
+  return arr.map(t => t ? encodeURIComponent(t) : t);
+}
+
+// 是否爬虫
+let isCrawler: boolean | null = null;
+
+/**
+ * 判断当前是否需要发埋点（爬虫和插件页不发）
+ */
+function canReport(): boolean {
+  if (isCrawler === null) {
+    const scene = getAppScene();
+    isCrawler = scene === '1129' || scene === '1030';
+  }
+  // 小程序爬虫，不上报
+  if (isCrawler) {
+    return false;
+  }
+  // 插件页不上报埋点
+  return getPageInfo() !== null;
+}
+
+/**
+ * 埋点数组的长度
+ */
+const dataArrLen = 41;
+
+const defaultDevice = {
+  networkType: null,
+  location: {
+    province: null,
+    cityName: null,
+  },
+} as any as IDeviceData;
+
+let networkPromise: Promise<string> | null = null;
+
+function getNetworkType(): Promise<string> {
+  if (networkPromise === null) {
+    networkPromise = new Promise((resolve) => {
+      wx.getNetworkType({
+        success: (res: any) => resolve(res.networkType),
+        fail: () => resolve('unknown'),
+      });
+    });
+  }
+  return networkPromise;
+}
+
+let locPromise: Promise<ILocation> | null = null;
+
+function getLocation(): Promise<ILocation> {
+  if (locPromise === null) {
+    locPromise = new Promise<ILocation>((resolve) => {
+      const LOC = getTms().getLocationManager();
+      LOC.getIpLocation()
+        .then((res: any) => {
+          const ad = res.ad_info;
+          resolve({ province: ad.province, cityName: ad.city });
+        })
+        .catch(() => {
+          resolve({ province: '', cityName: '' });
+        });
+    });
+  }
+  return locPromise;
+}
+
+let devicePromise: Promise<IDeviceData> | null = null;
+
+/**
+ * 获取设备信息(网络状况，位置信息)
+ */
+function getDeviceData(): Promise<IDeviceData> {
+  if (devicePromise === null) {
+    devicePromise = new Promise<IDeviceData>((resolve) => {
+      Promise.all([getNetworkType(), getLocation()]).then((res) => {
+        const [networkType, location] = res;
+        resolve({ networkType, location });
+      });
+    });
+  }
+  return devicePromise;
+}
+
+export default {
+  init,
+  getTms,
+  encodeItems,
+  getInitOptions,
+  getSystemInfo,
+  getSystemInfoString,
+  convert2String,
+  getPageInfo,
+  getLaunchOptionsString,
+  getLaunchFrom,
+  getAppScene,
+  canReport,
+  dataArrLen,
+  defaultDevice,
+  getDeviceData,
+};

package/src/report/index.ts

@@ -0,0 +1,64 @@
+/**
+ * 埋点
+ */
+
+// / <reference path='./types.ts'/>
+import helper from './helper';
+import sender from './sender';
+import formatV1 from './formatV1';
+import formatV2 from './formatV2';
+
+/**
+ * 初始化
+ */
+function init(options: IInitOptions): void {
+  helper.init(options);
+}
+
+/**
+ * 旧埋点
+ * @param data { 27: xxxx, 34: xxx }
+ */
+function report(data: IOldParams = {}): void {
+  if (helper.canReport()) {
+    formatV1.formatData(data).then(arr => sender.queue(arr));
+  }
+}
+
+/**
+ * 旧埋点，快速上报，不依赖用户位置
+ * @param data { 27: xxxx, 34: xxx }
+ */
+function fastReport(data: IOldParams = {}): void {
+  if (helper.canReport()) {
+    const arr = formatV1.formatFastData(data);
+    sender.send(arr);
+  }
+}
+
+/**
+ * 新埋点
+ */
+function report2(...data: any[]): void {
+  if (helper.canReport()) {
+    formatV2.formatData(data).then(arr => sender.queue(arr));
+  }
+}
+
+/**
+ * 新埋点，快速上报，不依赖用户位置
+ */
+function fastReport2(...data: any[]): void {
+  if (helper.canReport()) {
+    const arr = formatV2.formatFastData(data);
+    sender.send(arr);
+  }
+}
+
+export default {
+  init,
+  report,
+  fastReport,
+  report2,
+  fastReport2,
+};

package/src/report/sender.ts

@@ -0,0 +1,98 @@
+/**
+ * 负责发送埋点
+ */
+
+// / <reference path='./types.ts'/>
+import helper from './helper';
+
+// 缓存队列
+const cacheArr = new Array<DataItem[]>();
+const max = 50; // 超过最大限制就马上发送
+const delay = 3000; // 延迟N毫秒再聚合发送
+let timer = 0; // 计时器
+
+// 检查队列埋点，是否超过上限需要马上发送或者启动计时器
+function checkQueue(isSendFail: boolean): void {
+  if (!isSendFail && cacheArr.length >= max) {
+    batchSendData();
+  } else {
+    startTimer();
+  }
+}
+
+// 启动计时器
+function startTimer(): void {
+  if (timer !== 0 || cacheArr.length === 0) {
+    return;
+  }
+  timer = setTimeout(() => {
+    timer = 0;
+    batchSendData();
+  }, delay);
+}
+
+// 停止计时器
+function stopTimer(): void {
+  if (timer !== 0) {
+    clearTimeout(timer);
+    timer = 0;
+  }
+}
+
+// 批量发送埋点
+function batchSendData(): void {
+  if (cacheArr.length === 0) {
+    return;
+  }
+
+  const batch = cacheArr.splice(0, max);
+  const request = helper.getTms().createRequest();
+  request.post('basic/event/upload', { batch })
+    .then((res: any) => {
+      if (res.errCode !== 0) {
+        requestFail(batch);
+      } else {
+        startTimer();
+      }
+    })
+    .catch((e: any) => {
+      console.error(e);
+      requestFail(batch);
+    });
+}
+
+// 发送失败就再加回队列
+function requestFail(batch: DataItem[][]): void {
+  batch.forEach(item => cacheArr.push(item));
+  checkQueue(true);
+}
+
+/**
+ * 立刻发送埋点
+ * @param arr
+ */
+function send(arr: DataItem[]): void {
+  stopTimer();
+  cacheArr.unshift(helper.encodeItems(arr)); // 如果队列中很多，排前面比较稳妥
+  batchSendData();
+}
+
+/**
+ * 添加埋点到队列中，等待聚合发送
+ * @param arr
+ */
+function queue(arr: DataItem[]): void {
+  cacheArr.push(helper.encodeItems(arr));
+  checkQueue(false);
+}
+
+// 小程序关闭时马上发送所有埋点
+wx.onAppHide(() => {
+  stopTimer();
+  batchSendData();
+});
+
+export default {
+  send,
+  queue,
+};