gio-miniprogram-sdk 4.0.1 → 4.2.0

package/src/core/dataStore/eventHooks/appEffects.ts

@@ -10,6 +10,7 @@ import {
   isNil
 } from '@@/utils/glodash';
 import { qsStringify } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 class AppEffects {
   constructor(public growingIO: GrowingIOType) {}
@@ -24,14 +25,15 @@ class AppEffects {
       uploader,
       dataStore,
       dataStore: {
+        trackersExecute,
         shareOut,
-        keepAlive,
         lastCloseTime,
         eventHooks,
-        saveStorageInfo
+        saveStorageInfo,
+        setOriginalSource
       }
     }: GrowingIOType = this.growingIO;
-    emitter.emit('minipLifecycle', {
+    emitter.emit(EMIT_MSG.MINIP_LIFECYCLE, {
       event: `App ${event}`,
       timestamp: eventTime,
       params: args[0] ?? {}
@@ -41,7 +43,7 @@ class AppEffects {
     }
     const appListeners = platformConfig.listeners.app;
     // 向插件广播事件
-    emitter.emit('onComposeBefore', {
+    emitter.emit(EMIT_MSG.ON_COMPOSE_BEFORE, {
       event: `App ${event}`,
       params: args[0] ?? {}
     });
@@ -54,25 +56,33 @@ class AppEffects {
         const { path, query } = this.enterParamsParse(args[0]);
         if (!shareOut && vdsConfig.originalSource) {
           // 保存初始来源信息
-          dataStore.setOriginalSource({ path, query });
+          trackersExecute((trackingId: string) => {
+            setOriginalSource(trackingId, { path, query });
+          });
         }
         // 以下条件均会被认为是一次新的访问
         // 没有关闭时间说明是新访问
         if (!lastCloseTime) {
           // 保存进入小程序的参数
-          this.growingIO.dataStore.lastVisitEvent = { path, query };
-          this.buildVisitEvent({ path, query });
+          dataStore.lastVisitEvent = { path, query };
+          trackersExecute((trackingId: string) => {
+            this.buildVisitEvent(trackingId, { path, query });
+          });
         } else if (
           // 两次打开间隔时间超过keepAlive设定(默认5分钟)
-          Date.now() - lastCloseTime > keepAlive ||
+          Date.now() - lastCloseTime > vdsConfig.keepAlive ||
           // 两次打开时的场景值不一样（即从不同的来源进入小程序）
           (dataStore.lastScene && dataStore.scene !== dataStore.lastScene)
         ) {
           // 重置sessionId
-          userStore.sessionId = '';
+          trackersExecute((trackingId: string) => {
+            userStore.setSessionId(trackingId);
+          });
           // 需要按自然逻辑发visit时，清掉pagetime，防止取值错误（会在page中重新生成）
           eventHooks.currentPage.time = undefined;
-          this.buildVisitEvent({ path, query });
+          trackersExecute((trackingId: string) => {
+            this.buildVisitEvent(trackingId, { path, query });
+          });
         }
         break;
       }
@@ -82,11 +92,14 @@ class AppEffects {
         dataStore.lastCloseTime = Date.now();
         saveStorageInfo();
         userStore.saveUserInfo();
-        this.buildCloseEvent();
-        // forceLogin不生效时强制把请求队列中的事件全部发送
-        if (!vdsConfig.forceLogin) {
-          uploader.initiateRequest(true);
-        }
+        trackersExecute((trackingId: string) => {
+          this.buildCloseEvent(trackingId);
+          // forceLogin不生效时强制把请求队列中的事件全部发送
+          if (!vdsConfig.forceLogin) {
+            uploader.initiateRequest(trackingId, true);
+          }
+        });
+
         break;
       }
       default:
@@ -173,45 +186,51 @@ class AppEffects {
   };
 
   // 构建访问事件
-  buildVisitEvent = (props: any) => {
-    const { dataStore, vdsConfig, minipInstance } = this.growingIO;
+  buildVisitEvent = (trackingId: string, props?: any) => {
     const {
-      originalSourceName,
-      getOriginalSource,
-      eventContextBuilder,
-      eventInterceptor
-    } = dataStore;
-    const originalSource = getOriginalSource();
+      dataStore: {
+        getOriginalSource,
+        eventContextBuilder,
+        eventInterceptor,
+        eventHooks
+      },
+      minipInstance,
+      vdsConfig
+    } = this.growingIO;
+    const originalSource = getOriginalSource(trackingId);
     // 生命周期中调用构建使用参数赋值，补发场景调用构建使用上一次的值
     const query = props?.query || '';
     let event = {
       eventType: 'VISIT',
-      ...eventContextBuilder({
+      ...eventContextBuilder(trackingId, {
         // params.path是生命周期值或者是已有的值
         path: props?.path || '',
         // params.query是对象说明是生命周期调用，否则是补发调用
-        query: typeOf(query) === 'string' ? query : qsStringify(query)
+        query: typeOf(query) === 'string' ? query : qsStringify(query),
+        // visit事件要单独设一次title以覆盖eventContextBuilder中的lastPage的可能的title错误值
+        title:
+          eventHooks.currentPage?.title ||
+          minipInstance.getPageTitle(minipInstance.getCurrentPage()),
+        timestamp: eventHooks.currentPage.time
+          ? eventHooks.currentPage.time - 1
+          : +Date.now()
       })
     };
     // 配置使用初始来源时，visit使用初始来源数据
     if (vdsConfig.originalSource && !isNil(originalSource)) {
       event = { ...event, ...originalSource };
-      // 采集开关开启状态下的第一个visit消费过初始来源信息后删除
-      if (vdsConfig.dataCollect) {
-        minipInstance.removeStorageSync(originalSourceName);
-      }
     }
     eventInterceptor(event);
   };
 
   // 构建关闭事件
-  buildCloseEvent = () => {
+  buildCloseEvent = (trackingId: string) => {
     const {
       dataStore: { eventContextBuilder, eventInterceptor }
     } = this.growingIO;
     const event = {
       eventType: 'APP_CLOSED',
-      ...eventContextBuilder()
+      ...eventContextBuilder(trackingId)
     };
     eventInterceptor(event);
   };

package/src/core/dataStore/eventHooks/index.ts

@@ -6,6 +6,7 @@ import { consoleText, getGlobal, niceTry } from '@@/utils/tools';
 import AppEffects from './appEffects';
 import MinipPage from './minipPage';
 import PageEffects from './pageEffects';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 class EventHooks implements EventHooksType {
   private appHooked: boolean;
@@ -33,10 +34,6 @@ class EventHooks implements EventHooksType {
     this.appHandlers = config.appHandlers;
     this.pageHandlers = config.pageHandlers;
     this.actionEventTypes = config.actionEventTypes;
-    this.originalApp = config.originalApp;
-    this.originalPage = config.originalPage;
-    this.originalComponent = config.originalComponent;
-    this.originalBehavior = config.originalBehavior ?? function () {}; // eslint-disable-line
     this.appEffects = new AppEffects(this.growingIO);
     this.pageEffects = new PageEffects(this.growingIO);
     this.currentPage = new MinipPage(this.growingIO);
@@ -121,7 +118,12 @@ class EventHooks implements EventHooksType {
           if (eventName === 'onShareAppMessage') {
             // 先执行分享的生命周期拿到分享数据
             // 与基础库保持一致，没有返回值时默认使用{}
-            result = (await method.apply(this, args)) ?? {};
+            result = method.apply(this, args) ?? {};
+            // 如果分享事件是个promise函数，需要等待异步结果
+            if (typeOf(result) === 'promise') {
+              result = await result.then((r) => r);
+            }
+            // 如果返回的对象中包含promise，要等待异步结果
             if (typeOf(result.promise) === 'promise') {
               const f = async function () {
                 let sRes = result;
@@ -161,7 +163,7 @@ class EventHooks implements EventHooksType {
         if (eventName !== 'onShareAppMessage') {
           result = method.apply(this, args);
         }
-        self.growingIO.emitter.emit('minipLifecycle', {
+        self.growingIO.emitter.emit(EMIT_MSG.MINIP_LIFECYCLE, {
           event: `${cType} ${eventName}End`,
           timestamp: Date.now(),
           params: { instance: this, arguments: Array.from(args) }
@@ -324,6 +326,7 @@ class EventHooks implements EventHooksType {
       try {
         // 重写App
         if (platformHooks.App && !this.appHooked) {
+          this.originalApp = App || global.App || function () {};
           App = function (...args) {
             return self.growingApp(args[0]);
           };
@@ -337,6 +340,7 @@ class EventHooks implements EventHooksType {
       try {
         // 重写Page
         if (platformHooks.Page && !this.pageHooked) {
+          this.originalPage = Page || global.Page || function () {};
           Page = function (...args) {
             return self.growingPage(args[0]);
           };
@@ -350,6 +354,8 @@ class EventHooks implements EventHooksType {
       try {
         // 重写Component
         if (platformHooks.Component && !this.componentHooked) {
+          this.originalComponent =
+            Component || global.Component || function () {};
           Component = function (...args) {
             return self.growingComponent(args[0]);
           };
@@ -363,6 +369,7 @@ class EventHooks implements EventHooksType {
       try {
         // 重写Behavior
         if (platformHooks.Behavior && !this.behaviorHooked) {
+          this.originalBehavior = Behavior || global.Behavior || function () {};
           Behavior = function (...args) {
             return self.growingBehavior(args[0]);
           };

package/src/core/dataStore/eventHooks/minipPage.ts

@@ -1,7 +1,24 @@
-import { has, head, isEmpty, last, unset } from '@@/utils/glodash';
+import {
+  compact,
+  has,
+  head,
+  isEmpty,
+  keys,
+  last,
+  unset
+} from '@@/utils/glodash';
 import { GrowingIOType } from '@@/types/growingIO';
 import { MinipPageType, PageShareResult } from '@@/types/eventHooks';
-import { qsStringify, normalPath, splitPath, qsParse } from '@@/utils/tools';
+import {
+  qsStringify,
+  normalPath,
+  splitPath,
+  qsParse,
+  niceTry,
+  getDynamicAttributes,
+  limitObject
+} from '@@/utils/tools';
+import { EVENT } from '@@/types/base';
 
 class MinipPage implements MinipPageType {
   public path: string;
@@ -11,8 +28,6 @@ class MinipPage implements MinipPageType {
   public title: string;
   // 通过调用wx.setNavigationBarTitle设置的title
   public settedTitle: any;
-  // 当前页面参数中的分享id
-  public queryShareId: string;
   // 页面级属性
   public pageProps: any;
   // 上一个执行的小程序生命周期
@@ -56,24 +71,17 @@ class MinipPage implements MinipPageType {
   };
 
   // 获取上一个页面路径
-  getReferralPage = () => {
+  getReferralPage = (trackingId: string) => {
     const {
       minipInstance,
       dataStore: { lastPageEvent, scene }
     } = this.growingIO;
     return (
-      lastPageEvent?.path ||
+      lastPageEvent[trackingId]?.path ||
       (scene ? `scn:${minipInstance.scnPrefix}${scene}` : null)
     );
   };
 
-  // 保存分享id（记录是从哪个用户id的分享来的）
-  saveShareId = (query: any) => {
-    if (query?.gioShareId) {
-      this.queryShareId = query.gioShareId;
-    }
-  };
-
   // 处理分享参数
   buildShareQuery(
     result: PageShareResult // 客户自定义的参数
@@ -93,6 +101,12 @@ class MinipPage implements MinipPageType {
     // 自定义path中没有截取到query说明是在onShareAppMessage中没有参数，或是在onShareTimeline中需要取自定义query
     if (isEmpty(parsedQeury)) {
       parsedQeury = qsParse(result.query ?? '') || {};
+      compact(keys(parsedQeury)).forEach((key) => {
+        // 删除从默认页面的query中原有的utm参数，防止带入到下一次分享导致渠道统计错误（如果客户质疑参数被删，让他们自己拼回去或者关followshare）
+        if (key.toLowerCase().startsWith('utm_')) {
+          unset(parsedQeury, key);
+        }
+      });
     }
 
     // 以上两种都是自定义的地址和参数，不做处理直接用，防止出现encode/decode的问题。
@@ -127,6 +141,20 @@ class MinipPage implements MinipPageType {
     result.query = queryString;
     return result;
   };
+
+  // 给事件合并页面属性
+  eventSetPageProps = (trackingId: string, event: EVENT) => {
+    const pageProps = niceTry(() => this.pageProps[trackingId][this.path]);
+    if (!isEmpty(pageProps)) {
+      return limitObject(
+        getDynamicAttributes({
+          ...event.attributes,
+          ...pageProps
+        })
+      );
+    }
+    return event.attributes;
+  };
 }
 
 export default MinipPage;

package/src/core/dataStore/eventHooks/pageEffects.ts

@@ -1,6 +1,7 @@
 import { get, isEmpty, isFunction, unset } from '@@/utils/glodash';
 import { GrowingIOType } from '@@/types/growingIO';
 import { PageHookLifeCircle } from '@@/types/eventHooks';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 class PageEffects {
   public buildTabClickEvent: (tabItem: any) => void;
@@ -20,6 +21,8 @@ class PageEffects {
       vdsConfig,
       platformConfig,
       dataStore: {
+        getTrackerVds,
+        trackersExecute,
         shareOut,
         eventHooks,
         toggleShareOut,
@@ -45,7 +48,7 @@ class PageEffects {
     }
     const path =
       page.route || page.uri || page.__route__ || page?.$page?.fullPath || '';
-    emitter.emit('minipLifecycle', {
+    emitter.emit(EMIT_MSG.MINIP_LIFECYCLE, {
       event: `Page ${event}`,
       timestamp: eventTime,
       params: { page, args: args[0] }
@@ -56,7 +59,7 @@ class PageEffects {
     this.prevEvent[event] = Date.now();
     const pageListeners = platformConfig.listeners.page;
     // 向插件广播事件
-    emitter.emit('onComposeBefore', {
+    emitter.emit(EMIT_MSG.ON_COMPOSE_BEFORE, {
       page,
       event: `Page ${event}`,
       params: { page, args: args[0] }
@@ -84,18 +87,26 @@ class PageEffects {
             currentPage.path = `/插件${vdsConfig.appId}}`;
             currentPage.title = `/插件${vdsConfig.appId}}`;
           }
-          this.buildPageEvent();
+          trackersExecute((trackingId: string) => {
+            const { trackPage } = getTrackerVds(trackingId);
+            if (trackPage) {
+              this.buildPageEvent(trackingId);
+            }
+          });
         } else if (!shareOut || !eventHooks.currentPage.time) {
           // 不是因为分享切出再返回的onshow（视为第一次进入改页面）和切出去以后因为超时或者进入的场景值不一致时（会在appshow清掉页面时间），发page
           currentPage.parsePage(page, this.argQuery[path]);
           // 超时进入页面时前后path一致parsePage方法不会重置页面时间，可能会没有值，所以要补充重设一次
           eventHooks.currentPage.time = Date.now();
-          this.buildPageEvent();
+          trackersExecute((trackingId: string) => {
+            const { trackPage } = getTrackerVds(trackingId);
+            if (trackPage) {
+              this.buildPageEvent(trackingId);
+            }
+          });
         }
         // 分享标记置为false
         toggleShareOut(false);
-        // 保存分享id（记录是从哪个用户id的分享来的）
-        currentPage.saveShareId(this.argQuery[path]);
         break;
       }
       case pageListeners.pageHide:
@@ -104,19 +115,30 @@ class PageEffects {
       }
       case pageListeners.shareApp: {
         toggleShareOut(true);
-        if (vdsConfig.followShare) {
-          buildAppMessageEvent(args);
-        }
+        trackersExecute((trackingId: string) => {
+          const { followShare } = getTrackerVds(trackingId);
+          if (followShare) {
+            buildAppMessageEvent(trackingId, args);
+          }
+        });
         break;
       }
       case pageListeners.shareTime: {
-        if (vdsConfig.followShare) {
-          buildTimelineEvent(args);
-        }
+        trackersExecute((trackingId: string) => {
+          const { followShare } = getTrackerVds(trackingId);
+          if (followShare) {
+            buildTimelineEvent(trackingId, args);
+          }
+        });
         break;
       }
       case pageListeners.addFavorites: {
-        buildAddFavorites(args);
+        trackersExecute((trackingId: string) => {
+          const { followShare } = getTrackerVds(trackingId);
+          if (followShare) {
+            buildAddFavorites(trackingId, args);
+          }
+        });
         break;
       }
       case pageListeners.tabTap: {
@@ -127,39 +149,40 @@ class PageEffects {
           buildTabClickEvent &&
           isFunction(buildTabClickEvent)
         ) {
-          buildTabClickEvent(args[0]);
+          buildTabClickEvent(this.growingIO.trackingId, args[0]);
         }
         break;
       }
       default:
         break;
     }
-    // 页面销毁移除当前页面的属性
-    if (event === pageListeners.pageUnload) {
-      currentPage.pageProps[path] = undefined;
-    }
   };
 
   // 构建页面访问事件
-  buildPageEvent = (props?: any) => {
+  buildPageEvent = (trackingId: string, props?: any) => {
     const {
-      dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
+      dataStore: {
+        eventContextBuilder,
+        eventInterceptor,
+        eventHooks: { currentPage }
+      },
+      minipInstance
     } = this.growingIO;
-    const { currentPage } = eventHooks;
     const event = {
       eventType: 'PAGE',
-      referralPage: currentPage.getReferralPage(),
-      ...eventContextBuilder(),
+      referralPage: currentPage.getReferralPage(trackingId),
+      ...eventContextBuilder(trackingId),
+      // page事件要单独设一个title以覆盖eventContextBuilder中的lastPage的title错误值
+      title:
+        currentPage?.title ||
+        minipInstance.getPageTitle(minipInstance.getCurrentPage()),
       timestamp: currentPage.time
     };
-    // 添加页面属性
-    if (!isEmpty(currentPage.pageProps[event.path])) {
-      event.attributes = currentPage.pageProps[event.path];
-    }
-    if (!isEmpty(props) && props.path) {
-      event.path = props.path;
-      event.query = props.query;
-      event.title = props.title ?? event.title;
+    // 合并页面属性
+    event.attributes = currentPage.eventSetPageProps(trackingId, event);
+    // 传入参数生成的page事件取值为传入参数
+    if (!isEmpty(props) && props.title) {
+      event.title = props.title;
     }
     eventInterceptor(event);
   };