@tmsfe/tms-core 0.0.26 → 0.0.30

package/package.json

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

package/src/cloudReport.ts

@@ -0,0 +1,199 @@
+/**
+ * 调用云函数上报埋点
+ */
+
+import syncApi from './syncfnmanager';
+
+type DataType =  string | null;
+
+interface IInitOptions {
+  client: string, // sinan、mycar等
+  appVersion: string,
+  cloudEnvId: string,
+}
+
+interface IPage {
+  route: string,
+  options: object,
+}
+
+const openidIndex = 7; // openId的下标，由云函数填充
+
+let initOptions: IInitOptions;
+
+function init(options: IInitOptions): void {
+  if (!initOptions) {
+    initOptions = options;
+    wx.cloud.init({ env: options.cloudEnvId });
+  }
+}
+
+function getSystemInfoString(): string {
+  const system = syncApi.getSystemInfoSync();
+  // @ts-ignore
+  // eslint-disable-next-line
+  const { model = '', version: wxVersion = '', platform = '', SDKVersion = '', host = '' } = system;
+  const info = { model, wxVersion, platform, SDKVersion, host };
+  return encodeURIComponent(JSON.stringify(info));
+}
+
+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 getSeqInfo(): { timestamp: number, seqId: string } {
+  const timestamp = Date.now();
+  const random = Math.random().toString();
+  const randomStr = random.slice(2, 7);
+  const sourceId = 7; // 6 未知 7 云函数 8 出行 9 我的车
+  const seqId = `${timestamp}${sourceId}${randomStr}`;
+  return { timestamp, seqId };
+}
+
+function getPageInfo(): IPage | null {
+  const pages = getCurrentPages();
+  // 首页未渲染
+  if (pages.length === 0) {
+    const launch = syncApi.getLaunchOptionsSync();
+    return { route: launch.path, options: launch.query };
+  }
+  const page = pages.pop();
+  // 插件页
+  if (!page) {
+    return null;
+  }
+  return page;
+}
+
+/**
+ * 获取埋点的基础字段
+ * @param page
+ * @param seqId 请求ID
+ */
+function getBaseData(page: IPage, seqId: string): { arr: DataType[], nextIndex: number } {
+  const pageQuery = encodeURIComponent(JSON.stringify(page.options));
+  const pageUrl = page.route;
+  const { appVersion, client } = initOptions;
+  const system = getSystemInfoString();
+  // @ts-ignore
+  const { scene = -1 } = syncApi.getLaunchOptionsSync();
+
+  const arr = new Array(41);
+  // 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等
+  // 13: product_id，手图APP、车联网等
+  // 14: busi_type，1: 定位、2: 检索、3: 导航、4: 车主服务、5: 小程序
+  arr[14] = '5';
+  // 15: request_id，请求ID
+  arr[15] = seqId;
+  // 16: session_id，标识用户一次访问过程的ID
+  // 17: f17 - province，省份
+  // 18: f18 - city，城市
+  // 19: f19 - 系统信息
+  arr[19] = system;
+  // 20: f20 - sinan、mycar等
+  arr[20] = client;
+  // 21: f21 - 小程序场景值
+  arr[21] = scene.toString();
+  // 22: f22 - 标记是云函数上报
+  arr[22] = 'cloud';
+  // 23: f23 - 当前页面的url
+  arr[23] = pageUrl;
+  // 24: f24 - 当前页面的query
+  arr[24] = pageQuery;
+  // 25 ~ 30: 预留字典给后续扩展使用
+  // 31 ~ 40: 提供给开发自定义
+  return { arr, nextIndex: 31 };
+}
+
+function formatData(page: IPage, seqId: string, data: any[]): DataType[] {
+  const { arr, nextIndex } = getBaseData(page, seqId);
+  let index = nextIndex;
+  for (const item of data) {
+    if (index >= arr.length) {
+      console.error(data);
+      throw new Error('埋点参数个数超出上限');
+    }
+    arr[index] = convert2String(item);
+    index += 1;
+  }
+  return arr;
+}
+
+function report(...data: any[]): void {
+  console.log('云埋点', data);
+  const page = getPageInfo();
+  if (page === null) {
+    console.log('插件页不上报埋点');
+    return;
+  }
+  // @ts-ignore
+  const { scene = -1 } = syncApi.getLaunchOptionsSync();
+  // 小程序爬虫产生的日志
+  if (scene === 1129 || scene === 1030) {
+    console.warn('小程序爬虫，不上报');
+  } else {
+    const { timestamp, seqId } = getSeqInfo();
+    const arr = formatData(page, seqId, data);
+    doCallCloudFunc(arr, timestamp, seqId, openidIndex);
+  }
+}
+
+function doCallCloudFunc(arr: DataType[], timestamp: number, seqId: string, openidIndex: number): void {
+  const { cloudEnvId, appVersion } = initOptions;
+  const onFail = (err: any) => {
+    console.error('云埋点失败：', arr, err);
+  };
+  wx.cloud.callFunction({
+    name: 'report',
+    data: {
+      openidIndex,
+      params: { seqId, timestamp, appVersion, batch: [arr] },
+    },
+    config: { env: cloudEnvId },
+    success: (res: any) => {
+      const body = JSON.parse(res.result.body);
+      if (body.errCode !== 0) {
+        onFail(res);
+      }
+    },
+    fail: onFail,
+  });
+}
+
+/**
+ * 调用云函数将已经组装完整的埋点数据arr发出去
+ * @param arr
+ */
+function callCloudFunc(arr: string[]): void {
+  const { timestamp, seqId } = getSeqInfo();
+  doCallCloudFunc(arr, timestamp, seqId, openidIndex);
+}
+
+export default {
+  init,
+  report,
+  callCloudFunc,
+  convert2String,
+  getSystemInfoString,
+};

package/src/fastreport.js

@@ -3,28 +3,14 @@
  * @author Fenggang.Sun <fenggangsun@tencent.com>
  * @file 快速上报数据，不处理过多逻辑，保证快速上报
  */
-import Request from './request';
-import { getEnvInfo } from './env';
-import Sync from './syncfnmanager';
-
-let simulatedUserIdCache; // 模拟用户id在内存里的缓存
-
-const getSystemInfo = () => {
-  const system = Sync.getSystemInfoSync();
-  const { model = '', version: wxVersion = '', platform = '', SDKVersion = '', host = '' } = system;
-
-  return { model, wxVersion, platform, SDKVersion, host };
-};
+import { getEnvInfo, getAuthInfo } from './env';
+import CloudReport from './cloudReport';
 
 const handleParamOfDifferentType = (param) => {
   const data = new Array(41);
   Object.keys(param).forEach((key) => {
-    const valType = typeof param[key];
-    if (valType === 'string') data[key] = param[key];
-    else if (valType === 'object') data[key] = JSON.stringify(param[key]);
-    else data[key] = String(param[key]);
+    data[key] = CloudReport.convert2String(param[key]);
   });
-
   return data;
 };
 
@@ -39,52 +25,27 @@ export default class FastReport {
    * @memberof FastReport
    * @description 快速上报
    * @param {Object} param 埋点数据
-   * @param {Boolean} simulatedUserId 是否上报模拟用户Id
-   * @param {Number} simulatedUserIdIndex 上报模拟用户ID时放在哪个字段
-   * @param {Boolean} reportShowScene 是否上报小程序onShow场景值
-   * @param {Boolean} appVer 是否上报小程序版本
-   * @returns {Promsie} 返回上报结果
    */
-  static report(param = {}, simulatedUserId = true, simulatedUserIdIndex = 40, reportShowScene = true, appVer = true) {
-    if (!param[27]) return Promise.reject('invalid report param');
+  static report(param = {}) {
+    if (!param[27]) {
+      return Promise.reject('invalid report param');
+    }
     const env = getEnvInfo();
     const data = handleParamOfDifferentType(param);
     data[9] = '2';
-    data[33] = encodeURIComponent(JSON.stringify(getSystemInfo()));
-    if (appVer) {
-      data[10] = defAssign(data[10], env.appVersion);
-    }
+    data[10] = defAssign(data[10], env.appVersion);
     data[26] = defAssign(data[26], data[27]?.[0]);
     data[28] = env.client;
-    if (reportShowScene && !data[29]) {
+    if (!data[29]) {
       const appShowScene = wx.getStorageSync('appShowScene');
-      if (appShowScene) data[29] = String(appShowScene);
+      if (appShowScene) {
+        data[29] = String(appShowScene);
+      }
     }
-    if (simulatedUserId && !data[simulatedUserIdIndex]) {
-      data[simulatedUserIdIndex] = FastReport.getSimulatedUserId();
-    }
-
-    return new Request().post('basic/event/upload', { batch: [data] })
-      .catch(() => null);
-  }
-
-  /**
-   * @memberof FastReport
-   * @description 获取模拟的用户身份标识
-   * @returns {String} 用户的临时标识
-   */
-  static getSimulatedUserId() {
-    // 优先使用内存级缓存
-    if (simulatedUserIdCache) return simulatedUserIdCache;
-    const key = 'SimulatedUserKey';
-    // 读取本地缓存记录的值
-    simulatedUserIdCache = wx.getStorageSync(key);
-    if (simulatedUserIdCache) return simulatedUserIdCache;
-    // 生成新的值
-    const nonce = Math.random().toString(36)
-      .substr(2, 10);
-    simulatedUserIdCache = `${Date.now()}_${nonce}`;
-    wx.setStorage({ key, data: simulatedUserIdCache });
-    return simulatedUserIdCache;
+    data[33] = CloudReport.getSystemInfoString();
+    getAuthInfo().then((user) => {
+      data[5] = user.uid;
+      CloudReport.callCloudFunc(data);
+    });
   }
 };

package/src/index-proxy.js

@@ -7,6 +7,7 @@
 
 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';
@@ -39,6 +40,7 @@ function invoke(obj, funcName, args) {
 function initProxy(appObj, options) {
   app = appObj;
   initOptions = options;
+  CloudReport.init(options);
 }
 
 function awaitTMS() {
@@ -201,10 +203,18 @@ function getHomePage() {
   return initOptions.homePage;
 }
 
+function getCloudReport() {
+  if (tms) {
+    return tms.getCloudReport();
+  }
+  return CloudReport;
+}
+
 const api = {
   isProxy: true, // 方便定位问题时判断是否proxy
   initProxy,
   md5,
+  getCloudReport,
   getCarManager,
   getLocationManager,
   rpxToPx,

package/src/index.js

@@ -1,5 +1,6 @@
 import Request from './request';
 import FastReport from './fastreport';
+import CloudReport from './cloudReport';
 import { getConfig } from './config';
 import syncApi from './syncfnmanager';
 import nav from './navigator';
@@ -11,7 +12,6 @@ import { cache as report, startListenApp } from './report';
 import EventDispatcher from './eventDispatcher';
 import { serialize } from './objUtils';
 import { rpxToPx } from './rpx';
-import { distanceBetweenPoints } from './distanceBetweenPoints';
 import {
   formatPlate,
   subStr,
@@ -74,6 +74,11 @@ const getReporter = () => ({ report });
  */
 const getFastReporter = () => FastReport;
 
+/**
+ * @description 云函数埋点上报
+ */
+const getCloudReport = () => CloudReport;
+
 /**
  * @description 自定义事件机制
  * @returns {Object} [EventDispatcher实例](#class-eventdispatcher)
@@ -100,14 +105,16 @@ const getLocationBaseClass = () => LocationBase;
 const init = (options = {}) => {
   startListenApp();
   const { appVersion, wxAppId, client, defaultHost, cloudEnvId, appEnv, appPagePaths, homePage } = options;
-  setEnvInfo({
+  const envInfo = {
     wxAppId,
     appVersion,
     appEnv,
     client,
     cloudEnvId,
-  });
+  };
+  setEnvInfo(envInfo);
   setAppPagePaths(appPagePaths, homePage);
+  CloudReport.init(envInfo);
   Request.defaultHost = defaultHost;
   // 初始化云环境
   wx.cloud.init({ env: cloudEnvId });
@@ -133,6 +140,7 @@ const api = {
   getRealtimeLogManager,
   md5,
   getReporter,
+  getCloudReport,
   getFastReporter,
   getLocationManager,
   getLocationBaseClass,
@@ -181,7 +189,6 @@ const api = {
 
   /** rpx转px */
   rpxToPx,
-  distanceBetweenPoints,
 
   storage,
 

package/src/distanceBetweenPoints.js

@@ -1,73 +0,0 @@
-
-// 墨卡托坐标转经纬度
-function mercator2LonLat(p) {
-  const r = p.y / 111319.49077777778;
-  const n =    Math.atan(Math.exp(0.017453292519943295 * r)) / 0.008726646259971648 - 90;
-  return {
-    x: p.x / 111319.49077777778,
-    y: n,
-  };
-}
-
-
-// 角度转弧度
-function angle2Rad(t) {
-  return (t * Math.PI) / 180;
-}
-
-
-function client2ServerX(t) {
-  return t - 20037508;
-}
-
-function client2ServerY(t) {
-  return t - 30240971;
-}
-
-function longitude2ClientX(t) {
-  return Number(111319.49077777778 * Number(t) + 20037508).toFixed(0);
-}
-
-function latitude2ClientY(t) {
-  const n =    Math.log(Math.tan(0.008726646259971648 * (90 + Number(t)))) / 0.017453292519943295;
-  return Number(111319.49077777778 * n + 30240971).toFixed(0);
-}
-
-function geoPointToServerPoint(t) {
-  let n = {};
-  if (t) {
-    n = {
-      x: client2ServerX(longitude2ClientX(t.longitude)),
-      y: client2ServerY(latitude2ClientY(t.latitude)),
-    };
-  }
-  return n;
-}
-
-
-/**
- * 两个经纬度间地理距离（单位:米）
- * @param {*} start {longitude, latitude}
- * @param {*} end {longitude, latitude}
- * @returns
- */
-function distanceBetweenPoints(start, end) {
-  let s = geoPointToServerPoint(start);
-  let t = geoPointToServerPoint(end);
-  s = mercator2LonLat(s); // eslint-disable-line
-  t = mercator2LonLat(t); // eslint-disable-line
-  const deltaY = angle2Rad(s.y) - angle2Rad(t.y);
-  const deltaX = angle2Rad(s.x) - angle2Rad(t.x);
-  let res =    2
-    * Math.asin(Math.sqrt(Math.pow(Math.sin(deltaY / 2), 2) // eslint-disable-line
-          + Math.cos(angle2Rad(s.y))
-            * Math.cos(angle2Rad(t.y))
-            * Math.pow(Math.sin(deltaX / 2), 2))); // eslint-disable-line
-  res *= 6378137;
-  res = Math.floor(res * 10000 + 0.5) / 10000;
-  return res;
-}
-
-export {
-  distanceBetweenPoints,
-};