@tmsfe/tms-core 0.0.1 → 0.0.5

package/src/report.js

@@ -0,0 +1,434 @@
+import Request from './request';
+import getLocInstance from './location/index.ts';
+import { getAuthInfo } from './env';
+
+const R = new Request();
+const ReportInterval = 3000; // 轮训上报间隔
+const ReportDataQueue = []; // 上报数据队列
+let ReportTaskId = -1; // 轮训上报id
+
+let appShowOptions = null; // 设置小程序onShow参数
+function getAppShowOptions() {
+  if (appShowOptions === null) {
+    try {
+      appShowOptions = wx.getLaunchOptionsSync();
+    } catch (_) {
+      appShowOptions = {};
+    }
+  }
+  return appShowOptions;
+}
+
+function getTMS() {
+  return getApp({ allowDefault: true }).tms;
+}
+
+// 缓存系统信息，避免每次都重新获取系统信息
+let systemPromise = null;
+/**
+ * 获取系统信息
+ * @private
+ * @returns {object} 系统信息
+ */
+const getSystemPromise = () => {
+  if (systemPromise === null) {
+    systemPromise = new Promise((resolve) => {
+      wx.getSystemInfo({
+        success: (systemInfo) => {
+          const { model, version: wxVersion, platform, SDKVersion, host } = systemInfo;
+          resolve({ model, wxVersion, platform, SDKVersion, host });
+        },
+        fail: () => {
+          resolve({});
+        },
+      });
+    });
+  }
+  return systemPromise;
+};
+
+let networkPromise = null;
+/**
+ * 获取网络信息
+ * @private
+ * @returns {string} 网络信息
+ */
+const getNetworkType = () => {
+  if (networkPromise === null) {
+    networkPromise = new Promise((resolve) => {
+      wx.getNetworkType({
+        success: (netInfo) => {
+          resolve(netInfo.networkType);
+        },
+        fail: () => {
+          resolve('unknown');
+        },
+      });
+    });
+  }
+  return networkPromise;
+};
+
+let ProvinceInfoCache = null;
+/**
+ * 获取省市信息
+ * @private
+ */
+const getProvinceInfo = () => {
+  if (!ProvinceInfoCache) {
+    ProvinceInfoCache = new Promise(async (resolve) => {
+      try {
+        const loc = await getLocInstance().getLocationDetailSilent();
+        resolve({
+          cityName: loc.cityName,
+          province: loc.province,
+        });
+      } catch (_) {
+        // 获取位置失败时，尝试获取本地存储的位置信息
+        const loc = getLocInstance().getUserLocation();
+        if (loc?.cityName) {
+          resolve(loc);
+        } else {
+          resolve({ cityName: '', province: '' });
+        }
+      }
+    });
+  }
+  return ProvinceInfoCache;
+};
+
+let ProvinceInfoCacheByIp = null;
+/**
+ * 调接口获取省市信息
+ * @private
+ */
+const getProvinceInfoByIp = () => {
+  if (!ProvinceInfoCacheByIp) {
+    ProvinceInfoCacheByIp = new Promise(async (resolve) => {
+      try {
+        const loc = await R.post('basic/lbs/decodeip');
+        const { city, province } = loc.resData.ad_info;
+        resolve({ cityName: city, province });
+      } catch (_) {
+        resolve({ cityName: '', province: '' });
+      }
+    });
+  }
+  return ProvinceInfoCacheByIp;
+};
+
+// 用于缓存用户唯一标识userId
+let userId = '';
+/**
+ * 获取用户唯一标识userId
+ * @private
+ * @returns {string} userId
+ */
+const getUserId = async () => {
+  if (userId) {
+    return userId;
+  }
+
+  ({ userId } = await getAuthInfo());
+  return userId;
+};
+
+let launchFrom = '';
+/**
+ * 获取用户启动小程序时的渠道来源值
+ * @private
+ * @returns {string} 用户启动小程序时的渠道来源值
+ */
+const getLaunchFrom = () => {
+  if (launchFrom) {
+    return launchFrom;
+  }
+
+  try {
+    const LaunchOptions = wx.getLaunchOptionsSync() || {};
+    const { query = {} } = LaunchOptions;
+    launchFrom = (query.from || '');
+
+    return launchFrom;
+  } catch (_) {
+    return '';
+  }
+};
+
+/**
+ * 将上报的对象类型的数据转换成数组类型
+ * @private
+ * @param {object} reportData 需要上报的数据
+ * @returns {array} 数组格式的上报数据
+ */
+const getReportDataList = (reportData = {}) => {
+  const reportList = [];
+  reportList.length = 40;
+  Object.keys(reportData).forEach((key) => {
+    const reportIndex = Number(key);
+    reportList[reportIndex] = reportData[key];
+  });
+
+  return reportList;
+};
+
+// 小程序版本号
+let verNum = null;
+function getMiniProgramVersion() {
+  if (verNum === null) {
+    const { miniProgram: { version } = {} } = wx.getAccountInfoSync() || {};
+    verNum = version;
+  }
+  return verNum;
+}
+
+/**
+ * 格式化上报数据
+ * @private
+ * @param {object} reportData 需要上报的数据
+ * @param {object} deviceData 设备数据(系统信息，网络状况，位置信息)
+ * @returns {array} 格式化后的上报数据
+ */
+const formatReportData = async (reportData, deviceData) => {
+  const [system, netType, provinceInfo] = deviceData;
+  const param = Array.isArray(reportData.param) ? reportData.param : getReportDataList(reportData);
+  const { client } = await getTMS().getEnvInfo();
+
+  param[5] = await getUserId();
+  param[10] = getMiniProgramVersion(); // 上报小程序版本号
+  param[16] = getLaunchFrom(); // 渠道公共参数
+  param[17] = param[17] || provinceInfo?.province;
+  param[18] = param[18] || provinceInfo?.cityName;
+  param[19] = system?.host; // 上报宿主app信息 { appId, env, version }
+  param[28] = client;
+
+  // 默认上报数据
+  const defaultReportData = {
+    9: '2',
+    12: netType,
+    13: '2',
+    29: getAppShowOptions().scene, // 打开小程序的场景值
+    33: JSON.stringify(system),    // 数据字符串化
+    36: getAppShowOptions(),       // 打开小程序的场景值及参数
+  };
+  // 对部分空数据使用默认数据填充
+  Object.keys(defaultReportData).forEach((key) => {
+    param[key] = (param[key] !== null && JSON.stringify(param[key])) || defaultReportData[key];
+  });
+
+  // 所有上报数据都转换为字符串
+  param.forEach((reportItem, index) => {
+    if (reportItem && typeof reportItem !== 'string') {
+      param[index] = `${JSON.stringify(reportItem)}`;
+    } else {
+      const paramItem = param[index];
+      param[index] = (paramItem || paramItem === 0) ? `${paramItem}` : '';
+    }
+  });
+
+  return param.map(item => (item !== null ? encodeURIComponent(item) : item));
+};
+
+/**
+ * 格式化上报到小程序后台的数据(自定义分析使用)
+ * @private
+ * @param {array} data 埋点数据
+ * @returns {object} 格式化的数据
+ */
+const formatAnalyticsData = async (data) => {
+  const analyticsData = {};
+  const { 10: version, 29: scene } = data;
+  analyticsData[10] = version; // 小程序版本号
+  analyticsData[29] = scene;   // 小程序场景值
+  analyticsData[17] = decodeURIComponent(data[17]); // 用户所在省份
+  analyticsData[18] = decodeURIComponent(data[18]); // 用户所在城市
+
+  // 将30-40位埋点字段补充到上报数据中
+  for (let i = 30; i < 41; i += 1) {
+    analyticsData[i] = decodeURIComponent(data[i] || '');
+    // 如果第33列是设备信息，则忽略
+    if (data[33] && data[33].indexOf('model') > -1) {
+      analyticsData[33] = '';
+    }
+  }
+  const { client } = await getTMS().getEnvInfo();
+
+  return { analyticsData, eventName: `${client}_${data[27]}` };
+};
+
+/**
+ * 上报数据到小程序后台
+ * @private
+ * @param {array} list 需要上报的数据列表
+ * @returns {void}
+ */
+const reportAnalytics = (list = []) => {
+  try {
+    list.forEach((item) => {
+      const { eventName, analyticsData } = formatAnalyticsData(item);
+      wx.reportAnalytics(eventName, analyticsData);
+    });
+  } catch (_) {}
+};
+
+/**
+ * @description report 方法 将上报数据缓存到内存中
+ * @name report
+ * @param {object} reportData 需要上报的数据
+ * @param {boolean} reportNow 是否立即上报
+ * @param {boolean} locPoi 是否通过微信接口获取poi
+ * @returns {Void} 无返回值
+ */
+const cache = (reportData, reportNow, locPoi = true) => {
+  // 如果是微信爬虫 | 自动化测试场景，则不进行数据上报
+  const DO_NOT_NEED_REPORT_SCENES = [1030, 1129];
+  if (DO_NOT_NEED_REPORT_SCENES.includes(getAppShowOptions().scene)) {
+    return Promise.resolve();
+  }
+
+  const task = [getSystemPromise(), getNetworkType()];
+  if (locPoi) {
+    task.push(getProvinceInfo());
+  } else {
+    task.push(getProvinceInfoByIp());
+  }
+  return Promise.all(task)
+    .then(async (deviceData) => {
+      // 先对上报数据进行预处理
+      const result = await formatReportData(reportData, deviceData);
+      // 将需要上报的数据缓存在队列中
+      ReportDataQueue.push(result);
+    })
+    .then(() => {
+      if (reportNow) {
+        return sendData();
+      }
+      return { cache: true };
+    });
+};
+
+/**
+ * 发送数据到服务端
+ * @private
+ * @returns {promise} 发送请求
+ */
+const sendData = async () => {
+  // 没有数据时，不发送上报请求
+  if (ReportDataQueue.length === 0) {
+    return Promise.resolve();
+  }
+
+  const cacheReportData = [...ReportDataQueue];
+  return R.post('basic/event/upload', { userId: await getUserId(), batch: cacheReportData })
+    .then((res = {}) => {
+      const { errCode } = res || {};
+      // 已经发送成功，则将本次发送的数据从数据队列中删除
+      if (errCode === 0) {
+        ReportDataQueue.splice(0, cacheReportData.length);
+        reportAnalytics(cacheReportData); // 将数据上报至小程序后台
+      }
+    });
+};
+
+/**
+ * 开启轮询上报定时器
+ * @private
+ * @param {boolean} clearTimerAfterSend 是发送完数据后否清除定时器标识
+ * @returns {void}
+ */
+const startSendTimer = (clearTimerAfterSend) => {
+  ReportTaskId = setInterval(async () => {
+    sendData();
+    if (clearTimerAfterSend) {
+      clearInterval(ReportTaskId);
+    }
+  }, ReportInterval);
+};
+
+/**
+ * 停止定时器
+ * @private
+ * @returns {void}
+ */
+const stopSendTimer = () => {
+  clearInterval(ReportTaskId);
+};
+
+/**
+ * 发送上报数据到服务端
+ * @private
+ * @param {boolean} reportNow 是否立即上报
+ * @param {boolean} clearTimerAfterSend 是否发送之后清除定时器
+ * @returns {void}
+ */
+const report = (reportNow = false, clearTimerAfterSend = false) => {
+  if (reportNow) {
+    if (ReportDataQueue.length > 0) {
+      sendData();
+    }
+    if (!clearTimerAfterSend) {
+      startSendTimer(clearTimerAfterSend);
+    } else {
+      stopSendTimer();
+    }
+  } else {
+    startSendTimer(clearTimerAfterSend);
+  }
+};
+
+/**
+ * 更新小程序onShow参数
+ * @private
+ * @param {object} options 小程序onShow参数
+ * @returns {void}
+ */
+const setAppShowOptions = (options) => {
+  appShowOptions = options;
+};
+
+/**
+ * init之后再监听
+ */
+const startListenApp = () => {
+  /**
+   * 监听小程序onShow事件
+   * @private
+   */
+  wx.onAppShow((options) => {
+    // 更新onShow参数
+    setAppShowOptions(options);
+    // 上报数据
+    report(true);
+  });
+
+  /**
+   * 监听小程序onHide事件
+   * @private
+   */
+  wx.onAppHide(() => {
+    // onHide时立即上报，并清除定时器
+    report(true, true);
+  });
+
+  /**
+   * 监听小程序路由切换事件
+   */
+  if (!wx.onAppRoute) {
+    return;
+  }
+  wx.onAppRoute((res) => {
+    const { path, query, openType } = res || {};
+    cache({ 26: 'H', 27: 'H100', 38: path, 39: JSON.stringify(query), 40: openType });
+    cache({ 26: 'H', 27: 'H100', 37: 1, 38: path, 39: JSON.stringify(query), 40: openType }, true);
+    wx.reportAnalytics('page_show', {
+      path,
+      query: JSON.stringify(query),
+      opentype: openType,
+    });
+  });
+};
+
+export {
+  cache,
+  startListenApp,
+};