@tmsfe/tms-core 0.0.123 → 0.0.125

package/package.json

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

package/src/index-proxy.js

@@ -45,7 +45,18 @@ function invoke(obj, funcName, args) {
 function initProxy(appObj, options) {
   app = appObj;
   initOptions = options;
-  AutoReport.init();
+  // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
+  const getTms = () => getApp()?.tms || wx.tms;
+  AutoReport.init({
+    report: (...data) => {
+      const tms = getTms();
+      tms.getReporter().report2(...data);
+    },
+    fastReport: (...data) => {
+      const tms = getTms();
+      tms.getReporter().fastReport2(...data);
+    },
+  });
 }
 
 function awaitTMS() {

package/src/index.js

@@ -120,8 +120,28 @@ const init = (options = {}) => {
   };
   setEnvInfo(envInfo);
   setAppPagePaths(appPagePaths, homePage);
-  Reporter.init(envInfo);
-  AutoReport.init();
+
+  Reporter.init({
+    client,
+    appVersion,
+    logger: wx.getLogManager({}),
+    post: (api, params) => createRequest().post(api, params),
+    getLocation: async () => {
+      try {
+        const res = await getLocationManager().getIpLocation();
+        const ad = res.ad_info;
+        return { province: ad.province, cityName: ad.city };
+      } catch {
+        return null;
+      }
+    },
+  });
+
+  AutoReport.init({
+    report: Reporter.report2,
+    fastReport: Reporter.fastReport2,
+  });
+
   Request.defaultHost = defaultHost;
   Request.defaultSecretKey = secretKey;
   // 初始化云环境

package/src/location/base.ts

@@ -41,6 +41,9 @@ function getWxLocation(type: string = defaultLocationType): Promise<WxPostionTyp
       success: (res: WxPostionType) => {
         logger.log(`wx.getLocation('${type}') 成功:\n`, JSON.stringify(res, null, '  '));
         resolve(res);
+        const reporter = getApp().tms.getReporter();
+        // 首次打开小程序时用户定位信息|用户定位|来源
+        reporter.report2('wxLocationInitInfo', res, 'tms-core');
       },
       fail: (err) => {
         logger.warn(`wx.getLocation('${type}') 失败:\n`, JSON.stringify(err, null, '  '));

package/src/report/formatV1.ts

@@ -3,15 +3,20 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
 import helper from './helper';
+import {
+  DataItem,
+  IOldParams,
+  IDeviceData,
+} from './types';
 
 /**
  * 获取埋点的基础字段
  */
 function getBaseData(deviceData: IDeviceData): DataItem[] {
   const { networkType, location } = deviceData;
-  const { appVersion, client } = helper.getInitOptions();
+  const client = helper.getClientName();
+  const appVersion = helper.getAppVersion();
   const { host } = helper.getSystemInfo();
   const arr = new Array<DataItem>(helper.dataArrLen);
   // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空

package/src/report/formatV2.ts

@@ -3,15 +3,20 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
 import helper from './helper';
+import {
+  IPage,
+  DataItem,
+  IDeviceData,
+} from './types';
 
 /**
  * 获取埋点的基础字段
  */
 function getBaseData(page: IPage, deviceData: IDeviceData): { arr: DataItem[], nextIndex: number } {
   const { networkType, location } = deviceData;
-  const { appVersion, client } = helper.getInitOptions();
+  const client = helper.getClientName();
+  const appVersion = helper.getAppVersion();
   const arr = new Array<DataItem>(helper.dataArrLen);
   // todo: 如何区分新旧埋点？新：f20不为空，旧：f20为空
   // ++++++++++++++++++++++++++字段列表++++++++++++++++++++++++++
@@ -73,7 +78,7 @@ function jointData(page: IPage, data: any[], deviceData: IDeviceData): DataItem[
   let index = nextIndex;
   for (const item of data) {
     if (index >= arr.length) {
-      console.error('埋点参数个数超出上限而被截断', data);
+      console.warn('埋点参数个数超出上限而被截断', data);
       break;
     }
     arr[index] = item;

package/src/report/helper.ts

@@ -3,14 +3,14 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
-import syncApi from '../syncfnmanager';
 import clone from './clone';
-
-function getTms(): any {
-  // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
-  return getApp()?.tms || (wx as any).tms;
-}
+import {
+  IPage,
+  DataItem,
+  IDeviceData,
+  ISystemInfo,
+  IInitOptions,
+} from './types';
 
 let initOptions: IInitOptions;
 
@@ -18,43 +18,31 @@ let initOptions: IInitOptions;
  * 初始化
  */
 function init(options: IInitOptions): void {
-  if (initOptions) {
-    return;
-  }
-
   initOptions = options;
+}
 
-  // 从上次缓存中读取，方便首次Report可以先带上
-  const loc = wx.getStorageSync('home.location_city') || wx.getStorageSync('home.city');
-  deviceData = {
-    networkType: '',
-    location: {
-      province: loc?.province as string,
-      cityName: loc?.cityName as string,
-    },
-  };
-
-  wx.onAppShow((options) => {
-    // 克隆函数内会限制对象字段
-    launchOptions = clone.deepClone(options);
-  });
+/**
+ * 获取小程序名
+ */
+function getClientName(): string {
+  return initOptions.client;
 }
 
 /**
- * 获取初始化时的参数
+ * 获取小程序版本号
  */
-function getInitOptions(): IInitOptions {
-  return initOptions;
+function getAppVersion(): string {
+  return initOptions.appVersion;
 }
 
-let systemInfo: ISystemInfo | null = null;
+let systemInfo: ISystemInfo;
 
 /**
  * 获取系统信息
  */
 function getSystemInfo(): ISystemInfo {
-  if (systemInfo === null) {
-    const system = syncApi.getSystemInfoSync() as any;
+  if (!systemInfo) {
+    const system = wx.getSystemInfoSync() as any;
     // eslint-disable-next-line
     const { model = '', version: wxVersion = '', platform = '', SDKVersion = '', host } = system;
     systemInfo = { model, wxVersion, platform, SDKVersion, host };
@@ -159,14 +147,14 @@ function getPageInfo(): IPage {
   return { route, options, depth };
 }
 
-let launchOptions: any = null;
+let launchOptions: any;
 
 /**
  * 获取小程序启动参数
  */
 function getLaunchOptions(): any {
-  if (launchOptions === null) {
-    launchOptions = syncApi.getLaunchOptionsSync();
+  if (!launchOptions) {
+    launchOptions = wx.getLaunchOptionsSync();
     // 克隆函数内会限制对象字段
     launchOptions = clone.deepClone(launchOptions);
   }
@@ -210,9 +198,15 @@ function canReport(): boolean {
 const dataArrLen = 41;
 
 // 缓存设备等信息，方便FastReport使用
-let deviceData: IDeviceData;
+const deviceData: IDeviceData = {
+  networkType: '',
+  location: {
+    province: '',
+    cityName: '',
+  },
+};
 
-let devicePromise: Promise<IDeviceData> | null = null;
+let devicePromise: Promise<IDeviceData> = null;
 
 /**
  * 获取设备信息(网络状况，位置信息)
@@ -231,16 +225,12 @@ function getDeviceData(): Promise<IDeviceData> {
       });
 
       const locPromise = new Promise<void>((resolve) => {
-        // 首次如果有缓存则先用缓存，请求后再更新给下次用
-        if (deviceData.location.province) {
-          resolve();
-        }
-        const LOC = getTms().getLocationManager();
-        LOC.getIpLocation()
-          .then((res: any) => {
-            const ad = res.ad_info;
-            deviceData.location.province = ad.province;
-            deviceData.location.cityName = ad.city;
+        initOptions.getLocation()
+          .then((loc) => {
+            if (loc) {
+              deviceData.location.province = loc.province;
+              deviceData.location.cityName = loc.cityName;
+            }
             resolve();
           })
           .catch(() => resolve());
@@ -271,10 +261,18 @@ function setSystemField(fieldName: string, value: number | string): void {
   systemInfo[fieldName] = value;
 }
 
+/**
+ * 请求接口
+ */
+function post(api: string, params: any): Promise<{ errCode: number, errMsg: string }> {
+  return initOptions.post(api, params);
+}
+
 export default {
   init,
-  getTms,
-  getInitOptions,
+  post,
+  getClientName,
+  getAppVersion,
   getSystemInfo,
   convert2StringArray,
   getNowString,

package/src/report/index.ts

@@ -3,21 +3,26 @@
  * @module: report
  */
 
-// / <reference path='./types.ts'/>
 import helper from './helper';
 import sender from './sender';
 import formatV1 from './formatV1';
 import formatV2 from './formatV2';
+import { ILogger, IOldParams, IInitOptions } from './types';
 
-const logger = wx.getLogManager({});
-logger.log('report模块代码被装载');
+let logger: ILogger;
+
+let isInit = false;
 
 /**
  * 初始化
  * @private
  */
 function init(options: IInitOptions): void {
-  helper.init(options);
+  if (!isInit) {
+    isInit = true;
+    logger = options.logger;
+    helper.init(options);
+  }
 }
 
 /**
@@ -60,7 +65,7 @@ function fastReport(data: IOldParams = {}): void {
  */
 function report2(...data: any[]): void {
   if (helper.canReport()) {
-    logger.log('新埋点:', data);
+    logger.log('新埋点:', data[0]); // 日志太长了，只输出事件名就好了
     formatV2.formatData(data).then(arr => sender.queue(arr));
   }
 }

package/src/report/proxy/app.ts

@@ -3,8 +3,6 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
-
 import helper from './helper';
 
 // 劫持导航api

package/src/report/proxy/component.ts

@@ -3,8 +3,6 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
-
 import helper from './helper';
 
 // 劫持Component的生命周期

package/src/report/proxy/helper.ts

@@ -3,39 +3,39 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
-
 import clone from '../clone';
+import { IInitOptions, IBindEvent } from './types';
+
+let initOptions: IInitOptions;
 
-function getReporter(): any {
-  // 如果是在app.js的onLaunch中调用，则没有getApp().tms为空
-  const tms = getApp()?.tms || (wx as any).tms;
-  return tms.getReporter();
+/**
+ * 初始化
+ */
+function init(options: IInitOptions): void {
+  initOptions = options;
 }
 
 /**
  * 聚合上报埋点
  */
 function reportData(...args: any[]): any {
-  console.log('自动埋点：', ...args);
-  getReporter().report2(...args);
+  initOptions.report(...args);
 }
 
 /**
  * 立即上报埋点
  */
 function fastReportData(...args: any[]): any {
-  console.log('快速自动埋点：', ...args);
-  getReporter().fastReport2(...args);
+  initOptions.fastReport(...args);
 }
 
-let systemInfo: any = null;
+let systemInfo: WechatMiniprogram.SystemInfo;
 
 /**
  * 获取wx.getSystemInfoSync()
  */
 function getSystemInfo(): any {
-  if (systemInfo === null) {
+  if (!systemInfo) {
     systemInfo = wx.getSystemInfoSync();
   }
   return systemInfo;
@@ -141,6 +141,7 @@ function getEventExtra(event: any): any {
 }
 
 export default {
+  init,
   emptyFunc,
   cloneData,
   reportData,

package/src/report/proxy/index.ts

@@ -3,16 +3,21 @@
  * @private: true
  */
 
+import helper from './helper';
 import proxyApp from './app';
 import proxyPage from './page';
 import proxyComponent from './component';
+import { IInitOptions } from './types';
 
-proxyApp.init();
-proxyPage.init();
-proxyComponent.init();
-
-// 目前没有需要控制初始化时机的场景
-function init(): void {
+function init(options: IInitOptions): void {
+  // 与独立分包共用过全埋点代理，避免重复劫持
+  if (!wx.isTmsReportInit) {
+    wx.isTmsReportInit = true;
+    helper.init(options);
+    proxyApp.init();
+    proxyPage.init();
+    proxyComponent.init();
+  }
 }
 
 export default {

package/src/report/proxy/page.ts

@@ -3,9 +3,8 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
-
 import helper from './helper';
+import { IPageTouchExtra, IPageLifeExtra } from './types';
 
 // 工具为页面根节点插入的触摸事件
 const pageTouchEvent = 'onReportPageTouch';

package/src/report/proxy/types.ts

@@ -1,10 +1,18 @@
-/* eslint-disable */
+/**
+ * 初始化参数对象
+ */
+export interface IInitOptions {
+  // 发送埋点
+  report: (...data: any[]) => void,
+  // 立即发送埋点
+  fastReport: (...data: any[]) => void,
+}
 
 /**
  * 绑定的触发事件埋点
  * @private: true
  */
-interface IBindEvent {
+export interface IBindEvent {
   /**
    * 触发事件的页面url
    */
@@ -30,7 +38,7 @@ interface IBindEvent {
 /**
  * 页面生命周期函数的埋点附加数据
  */
-interface IPageLifeExtra {
+export interface IPageLifeExtra {
   /**
    * 页面生命周期内第几次曝光
    */
@@ -49,7 +57,7 @@ interface IPageLifeExtra {
   touchCount: number,
 }
 
-interface IPageTouchExtra {
+export interface IPageTouchExtra {
   /**
    * 页面生命周期内第几次曝光
    */

package/src/report/sender.ts

@@ -3,8 +3,8 @@
  * @private: true
  */
 
-// / <reference path='./types.ts'/>
 import helper from './helper';
+import { DataItem } from './types';
 
 // 缓存队列
 const cacheArr = new Array<string[]>();
@@ -47,8 +47,7 @@ function batchSendData(): void {
   }
 
   const batch = cacheArr.splice(0, max);
-  const request = helper.getTms().createRequest();
-  request.post('basic/event/upload', { batch })
+  helper.post('basic/event/upload', { batch })
     .then((res: any) => {
       if (res.errCode === 0) {
         startTimer();
@@ -58,7 +57,7 @@ function batchSendData(): void {
       }
     })
     .catch((e: any) => {
-      console.error(e);
+      console.error('发送埋点失败', e);
       requestFail(batch);
     });
 }

package/src/report/types.ts

@@ -1,19 +1,33 @@
-/* eslint-disable */
-
-type DataItem = any;
+export type DataItem = any;
 
 /**
  * 初始化参数对象
  */
-interface IInitOptions {
-  client: string, // sinan、mycar等
+export interface IInitOptions {
+  // 小程序项目名，如：sinan、mycar等
+  client: string,
+  // 小程序版本号
   appVersion: string,
+  // 获取定位信息
+  getLocation: () => Promise<{ province: string, cityName: string } | null>,
+  // 允许自定义日志输出
+  logger: ILogger,
+  // post方法，用于发送埋点
+  post: (api: string, params: any) => Promise<{ errCode: number, errMsg: string }>,
+}
+
+export interface ILogger {
+  log: (...args: any[]) => void,
+  info: (...args: any[]) => void,
+  debug: (...args: any[]) => void,
+  warn: (...args: any[]) => void,
+  // wx.getLogManager跟wx.getRealtimeLogManager是没有error的
 }
 
 /**
  * 页面对象
  */
-interface IPage {
+export interface IPage {
   route: string,
   options: object,
   depth: number,
@@ -22,11 +36,11 @@ interface IPage {
 /**
  * 旧的埋点参数类型
  */
-interface IOldParams {
+export interface IOldParams {
   [key: number]: any,
 }
 
-interface ISystemInfo {
+export interface ISystemInfo {
   model: string,
   wxVersion: string,
   platform: string,
@@ -35,12 +49,12 @@ interface ISystemInfo {
   host: object,
 }
 
-interface ILocation {
+export interface ILocation {
   province: string,
   cityName: string,
 }
 
-interface IDeviceData {
+export interface IDeviceData {
   networkType: string,
   location: ILocation,
 }

package/src/request.js

@@ -357,7 +357,7 @@ export default class Request {
           obj.err = result;
         }
 
-        const str = JSON.stringify(obj, null, '  ').replace(/\\"/ig, '\'');
+        const str = JSON.stringify(obj, null, 2).replace(/\\"/ig, '\'');
         if (isSuccess) {
           logger.log(`接口请求成功：\n${str}`);
         } else {

package/src/runtime/login.ts

@@ -34,34 +34,31 @@ const getCode = () => new Promise((resolve, reject) => {
   wx.login({ success: ({ code }) => resolve(code), fail: reject });
 });
 
-let loginProcessing = false; // 是否有进行中的登录流程
 /**
  * login 方法 获取用户信息
  * @private
  * @return {object} userInfo
  */
 const loginFn = async () => {
-  if (loginProcessing) return;
-  loginProcessing = true;
-
-  let userInfo = {};
-  try {
-    let userData = await login();
-
-    if (userData.errCode === 10 || !userData.resData.userInfo || !userData.resData.userInfo.uid) {
-      userData = await login();
-    }
-
-    if (userData.errCode === 0) {
-      wx.setStorageSync('userInfo', userData.resData.userInfo);
-      userInfo = userData.resData.userInfo;
-    }
-
-    loginProcessing = false;
-  } catch (e) {
-    loginProcessing = false;
+  // 与独立分包共用登录，避免登录互斥
+  if (!wx.tmsLoginPromise) {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    wx.tmsLoginPromise = new Promise(async (resolve) => {
+      let userInfo = {} as any;
+      try {
+        let userData = await login();
+        if (userData.errCode === 10 || !userData.resData.userInfo || !userData.resData.userInfo.uid) {
+          userData = await login();
+        }
+        if (userData.errCode === 0) {
+          userInfo = userData.resData.userInfo;
+        }
+      } catch (e) {}
+      resolve(userInfo);
+    });
   }
-  return userInfo;
+
+  return wx.tmsLoginPromise;
 };
 
 /**