gio-miniprogram-sdk 4.1.0 → 4.3.0

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

@@ -1,18 +1,11 @@
 import { AppHookLifeCircle } from '@@/types/eventHooks';
 import { GrowingIOType } from '@@/types/growingIO';
-import {
-  isEmpty,
-  isObject,
-  typeOf,
-  keys,
-  forEach,
-  has,
-  isNil
-} from '@@/utils/glodash';
-import { qsStringify } from '@@/utils/tools';
+import { isEmpty, typeOf } from '@@/utils/glodash';
+import { getLaunchQuery, qsStringify } from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 class AppEffects {
+  public enterParams: any = {};
   constructor(public growingIO: GrowingIOType) {}
 
   main = (event: AppHookLifeCircle, args: any) => {
@@ -28,7 +21,6 @@ class AppEffects {
         trackersExecute,
         shareOut,
         lastCloseTime,
-        eventHooks,
         saveStorageInfo,
         setOriginalSource
       }
@@ -48,25 +40,35 @@ class AppEffects {
       params: args[0] ?? {}
     });
     switch (event) {
+      case appListeners.appLaunch:
+        // 在launch先获取一次是防止在此生命周期中发埋点或调用其他api时获取不到path和query
+        this.enterParams = { ...args[0] };
+        break;
       // 快应用是执行onCreate
       case appListeners.appCreate:
       // 各小程序执行onShow
       case appListeners.appShow: {
         // 获取进入小程序的path、query和scene
-        const { path, query } = this.enterParamsParse(args[0]);
+        const { path, query, referralPage } = this.enterParamsParse(args[0]);
         if (!shareOut && vdsConfig.originalSource) {
-          // 保存初始来源信息
-          trackersExecute((trackingId: string) => {
-            setOriginalSource(trackingId, { path, query });
-          });
+          // 个别（说的就是你：淘宝）小程序场景值不一样后台拉起时可能args中会没有path和query
+          if (path) {
+            // 保存初始来源信息
+            trackersExecute((trackingId: string) => {
+              setOriginalSource(trackingId, { path, query, referralPage });
+            });
+          }
         }
         // 以下条件均会被认为是一次新的访问
         // 没有关闭时间说明是新访问
         if (!lastCloseTime) {
-          // 保存进入小程序的参数
-          dataStore.lastVisitEvent = { path, query };
           trackersExecute((trackingId: string) => {
-            this.buildVisitEvent(trackingId, { path, query });
+            dataStore.lastVisitEvent[trackingId] = {
+              path,
+              query,
+              referralPage
+            };
+            this.buildVisitEvent(trackingId, { path, query, referralPage });
           });
         } else if (
           // 两次打开间隔时间超过keepAlive设定(默认5分钟)
@@ -78,10 +80,17 @@ class AppEffects {
           trackersExecute((trackingId: string) => {
             userStore.setSessionId(trackingId);
           });
-          // 需要按自然逻辑发visit时，清掉pagetime，防止取值错误（会在page中重新生成）
-          eventHooks.currentPage.time = undefined;
           trackersExecute((trackingId: string) => {
-            this.buildVisitEvent(trackingId, { path, query });
+            if (!path) {
+              // 个别（说的就是你：淘宝）小程序场景值不一样后台拉起时可能args中会没有path和query，直接取上一个最后发送的page中的值
+              const lastPage = dataStore.lastPageEvent[trackingId];
+              this.buildVisitEvent(trackingId, {
+                path: lastPage.path,
+                query: lastPage.query
+              });
+            } else {
+              this.buildVisitEvent(trackingId, { path, query });
+            }
           });
         }
         break;
@@ -108,16 +117,11 @@ class AppEffects {
   };
 
   // 进入小程序时的相关数据处理
-  enterParamsParse = (args: any) => {
+  enterParamsParse = (args: any = {}) => {
     const { gioPlatform, minipInstance, dataStore } = this.growingIO;
-    let vPath = ''; // 进入小程序时的path
-    let vQuery = ''; // 进入小程序时的参数（启动参数）
-    const assignment = (p: string, q = {}) => {
-      vPath = p;
-      vQuery = keys(q)
-        .map((k) => `${k}=${q[k]}`)
-        .join('&');
-    };
+    let rPath = ''; // 进入小程序时的path
+    let rQuery = ''; // 进入小程序时的参数（启动参数）
+    let rAppId = ''; // scene=1037或1038时来源小程序、公众号或 App 的 appId
     // 支持getEnterOptionsSync
     if (
       gioPlatform !== 'quickapp' &&
@@ -125,35 +129,25 @@ class AppEffects {
     ) {
       const { path, query, scene, referrerInfo } =
         minipInstance.minip.getEnterOptionsSync() || {};
-      const originQuery = args.query || query;
-      assignment(args.path || path, originQuery);
-      dataStore.scene = args.scene || scene;
-      // extraData字段计入query
-      if (!isEmpty(referrerInfo) && isObject(referrerInfo?.extraData)) {
-        let extraQuery = [];
-        forEach(referrerInfo.extraData, (v, k) => {
-          if (
-            // 与原始query中的key冲突时，以原始query为准
-            !has(originQuery, k) &&
-            // 只处理字符串、数字和布尔类型的值
-            ['string', 'number', 'boolean'].includes(typeOf(v))
-          ) {
-            extraQuery.push(`${k}=${v}`);
-          }
-        });
-        const extraQueryString = extraQuery.join('&');
-        vQuery =
-          vQuery && extraQueryString
-            ? `${vQuery}&${extraQueryString}`
-            : vQuery || extraQueryString;
+      rPath = path || args.path;
+      rQuery = query || args.query;
+      rAppId = referrerInfo?.appId || args?.referrerInfo?.appId || '';
+      dataStore.scene = scene || args.scene;
+      // 来源有额外参数时并入页面参数
+      if (!isEmpty(referrerInfo?.extraData)) {
+        rQuery = qsStringify(getLaunchQuery(rQuery, referrerInfo.extraData));
+      } else {
+        rQuery = qsStringify(rQuery);
       }
     } else {
       // 不支持的按老逻辑兜底
-      const { path, query } = args;
-      assignment(path, query);
+      const { path, query, referrerInfo } = args;
+      rPath = path;
+      rQuery = qsStringify(query);
+      rAppId = referrerInfo?.appId || '';
       this.parseScene(args);
     }
-    return { path: vPath, query: vQuery };
+    return { path: rPath, query: rQuery, referralPage: rAppId };
   };
 
   // 获取来源场景值
@@ -188,13 +182,7 @@ class AppEffects {
   // 构建访问事件
   buildVisitEvent = (trackingId: string, props?: any) => {
     const {
-      dataStore: {
-        getOriginalSource,
-        eventContextBuilder,
-        eventInterceptor,
-        eventHooks
-      },
-      minipInstance,
+      dataStore: { getOriginalSource, eventContextBuilder, eventInterceptor },
       vdsConfig
     } = this.growingIO;
     const originalSource = getOriginalSource(trackingId);
@@ -202,22 +190,20 @@ class AppEffects {
     const query = props?.query || '';
     let event = {
       eventType: 'VISIT',
-      ...eventContextBuilder(trackingId, {
-        // params.path是生命周期值或者是已有的值
-        path: props?.path || '',
-        // params.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()
-      })
+      ...eventContextBuilder(trackingId, {})
     };
+    if (!isEmpty(props) && props.path) {
+      // params.path是生命周期值或者是已有的值
+      event.path = props.path || '';
+      // params.query是对象说明是生命周期调用，否则是补发调用
+      event.query = typeOf(query) === 'string' ? query : qsStringify(query);
+      // 如果有来源
+      if (props.referralPage) {
+        event.referralPage = props.referralPage;
+      }
+    }
     // 配置使用初始来源时，visit使用初始来源数据
-    if (vdsConfig.originalSource && !isNil(originalSource)) {
+    if (vdsConfig.originalSource && !isEmpty(originalSource)) {
       event = { ...event, ...originalSource };
     }
     eventInterceptor(event);

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

@@ -118,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;
@@ -299,15 +304,25 @@ class EventHooks implements EventHooksType {
     });
   };
 
-  growingApp = (app: any) => this.originalApp(this.appOverriding(app));
+  growingApp = (app: any) =>
+    isFunction(this.originalApp)
+      ? this.originalApp(this.appOverriding(app))
+      : this.appOverriding(app);
 
-  growingPage = (page: any) => this.originalPage(this.pageOverriding(page));
+  growingPage = (page: any) =>
+    isFunction(this.originalPage)
+      ? this.originalPage(this.pageOverriding(page))
+      : this.pageOverriding(page);
 
   growingComponent = (component: any) =>
-    this.originalComponent(this.componentOverriding(component));
+    isFunction(this.originalComponent)
+      ? this.originalComponent(this.componentOverriding(component))
+      : this.componentOverriding(component);
 
   growingBehavior = (behavior: any) =>
-    this.originalBehavior(this.componentOverriding(behavior));
+    isFunction(this.originalBehavior)
+      ? this.originalBehavior(this.componentOverriding(behavior))
+      : this.componentOverriding(behavior);
 
   nativeGrowing = (
     designated: string[] = ['App', 'Page', 'Component', 'Behavior']
@@ -315,15 +330,12 @@ class EventHooks implements EventHooksType {
     const self = this;
     const { platformConfig } = this.growingIO;
     const platformHooks = platformConfig.hooks;
-    this.setAppEffectCbs();
-    this.setPageEffectCbs();
     if (designated.includes('App')) {
       try {
         // 重写App
         if (platformHooks.App && !this.appHooked) {
-          this.originalApp = App || global.App || function () {};
           App = function (...args) {
-            return self.growingApp(args[0]);
+            return self.originalApp(self.appOverriding(args[0]));
           };
           this.appHooked = true;
         }
@@ -335,9 +347,8 @@ 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]);
+            return self.originalPage(self.pageOverriding(args[0]));
           };
           this.pageHooked = true;
         }
@@ -349,10 +360,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]);
+            return self.originalComponent(self.componentOverriding(args[0]));
           };
           this.componentHooked = true;
         }
@@ -364,9 +373,8 @@ 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]);
+            return self.originalBehavior(self.componentOverriding(args[0]));
           };
           this.behaviorHooked = true;
         }
@@ -376,26 +384,39 @@ class EventHooks implements EventHooksType {
     }
   };
 
-  // 初始化无埋点
+  // 初始化原始值
+  initOriginalValue = () => {
+    this.setAppEffectCbs();
+    this.setPageEffectCbs();
+    this.originalApp = niceTry(() => App || global.App);
+    this.originalPage = niceTry(() => Page || global.Page);
+    this.originalComponent = niceTry(() => Component || global.Component);
+    this.originalBehavior = niceTry(() => Behavior || global.Behavior);
+  };
+
+  // 初始化事件钩子
   initEventHooks = () => {
     const self = this;
     const { platformConfig, gioPlatform } = this.growingIO;
+    this.initOriginalValue();
     if (platformConfig.canHook) {
       this.nativeGrowing();
-      getGlobal().GioApp = niceTry(() => App ?? window.GioApp);
-      getGlobal().GioPage = niceTry(() => Page ?? window.GioPage);
+      getGlobal().GioApp = niceTry(() => App ?? this.originalApp);
+      getGlobal().GioPage = niceTry(() => Page ?? this.originalPage);
       getGlobal().GioComponent = niceTry(
-        () => Component ?? window.GioComponent
+        () => Component ?? this.originalComponent
+      );
+      getGlobal().GioBehavior = niceTry(
+        () => Behavior ?? this.originalBehavior
       );
-      getGlobal().GioBehavior = niceTry(() => Behavior);
     } else if (gioPlatform === 'quickapp') {
-      window.GioApp = function (...args) {
+      getGlobal().GioApp = function (...args) {
         return self.appOverriding(args[0]);
       };
-      window.GioPage = function (...args) {
+      getGlobal().GioPage = function (...args) {
         return self.pageOverriding(args[0]);
       };
-      window.GioComponent = function (...args) {
+      getGlobal().GioComponent = function (...args) {
         return self.pageOverriding(args[0]);
       };
     }

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

@@ -1,14 +1,29 @@
-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,
+  getLaunchQuery
+} from '@@/utils/tools';
+import { EVENT } from '@@/types/base';
 
 class MinipPage implements MinipPageType {
-  public path: string;
-  public time: number;
-  public query: any;
-  // 页面title (优先级：setNavigationBarTitle > data.gioPageTitle[不保证能取到] > config.js中设置的值 > tabBar配置)
-  public title: string;
+  // 根据页面存储的页面参数
+  public queryOption: any;
   // 通过调用wx.setNavigationBarTitle设置的title
   public settedTitle: any;
   // 页面级属性
@@ -19,48 +34,108 @@ class MinipPage implements MinipPageType {
   public currentLifecycle: string;
 
   constructor(public growingIO: GrowingIOType) {
-    this.query = undefined;
+    this.queryOption = {};
     this.settedTitle = {};
     this.pageProps = {};
   }
 
-  // 存储页面参数
-  parsePage = (page: any, query: any) => {
-    // wx/my取route; swan取uri; tt取__route__; qq无值
-    const path =
-      page.route || page.uri || page.__route__ || page?.$page?.fullPath || '';
-    if (!isEmpty(query)) {
-      this.query = this.getQuery(query);
+  // 获取页面地址
+  getPagePath = () => {
+    const { minipInstance, inPlugin, dataStore, trackingId } = this.growingIO;
+    const path = minipInstance.getCurrentPath();
+    if (inPlugin) {
+      const vds = dataStore.getTrackerVds(trackingId);
+      // 插件中没有页面时直接将插件appId作为页面信息
+      return path || `/插件${vds.appId}`;
     } else {
-      this.query = undefined;
+      return (
+        path ||
+        dataStore.eventHooks.appEffects.enterParams?.path ||
+        // 作为页面组件时component created生命周期中的埋点会取不到页面堆栈，所以拿最近的一个page事件中的页面信息做兜底
+        dataStore.lastPageEvent[trackingId]?.path ||
+        // 没有最近的一个page事件说明在app初始化的生命周期中，有些框架可能会有异步处理逻辑导致事件触发比visit晚，则使用visit事件中的页面信息兜底
+        dataStore.lastVisitEvent[trackingId]?.path
+      );
     }
-    if (this.path !== path) {
-      this.time = Date.now();
+  };
+
+  // 获取页面参数
+  getPageQeury = () => {
+    const { minipInstance, dataStore, trackingId } = this.growingIO;
+    const stackPage = minipInstance.getCurrentPage();
+    const stackPath = minipInstance.getCurrentPath();
+    const { enterParams = {} } = dataStore.eventHooks.appEffects;
+    if (stackPath) {
+      const pageParams = stackPage.options ?? stackPage.$taroParams;
+      // 堆栈中有页面信息，则使用堆栈中的页面参数
+      if (!isEmpty(pageParams)) {
+        // 删掉taro框架中自带的字段
+        unset(pageParams, '$taroTimestamp');
+        // 有页面解析的option直接取
+        return this.qsQuery(pageParams);
+      } else if (!isEmpty(this.queryOption[stackPath])) {
+        // 没有option从hook获取的生命周期参数中取
+        return this.qsQuery(this.queryOption[stackPath]);
+      } else if (stackPath === enterParams.path) {
+        // 某些小程序虽然有页面堆栈，但是页面还没加载完，兜底取启动参数
+        return this.qsQuery(
+          getLaunchQuery(
+            enterParams?.query,
+            enterParams?.referrerInfo?.extraData
+          )
+        );
+      }
+    } else if (enterParams.path) {
+      // 堆栈中没有页面信息，但启动参数中有，说明是小程序刚启动还没加载页面，直接取启动参数
+      return this.qsQuery(
+        getLaunchQuery(enterParams?.query, enterParams?.referrerInfo?.extraData)
+      );
+    } else {
+      // 作为页面组件时component created生命周期中的埋点会取不到页面堆栈，所以拿最近的一个page事件中的页面信息做兜底
+      return dataStore.lastPageEvent[trackingId]?.path
+        ? dataStore.lastPageEvent[trackingId]?.query
+        : // 没有最近的一个page事件说明在app初始化的生命周期中，有些框架可能会有异步处理逻辑导致事件触发比visit晚，则使用visit事件中的页面信息兜底
+          dataStore.lastVisitEvent[trackingId]?.query;
     }
-    this.path = path;
-    this.title =
-      // 如果在parse前（onLoad）动态设置了title，则优先获取动态设置的值
-      this.settedTitle[this.path] ||
-      this.growingIO.minipInstance.getPageTitle(
-        page || this.growingIO.minipInstance.getCurrentPage()
+  };
+
+  // 获取页面标题
+  // 页面title (优先级：setNavigationBarTitle > data.gioPageTitle[不保证能取到] > config.js中设置的值 > tabBar配置)
+  getPageTitle = (trackingId?: string) => {
+    const { minipInstance, inPlugin, dataStore } = this.growingIO;
+    const path = minipInstance.getCurrentPath();
+    const title =
+      this.settedTitle[path] ||
+      minipInstance.getPageTitle(minipInstance.getCurrentPage());
+    if (inPlugin) {
+      const vds = dataStore.getTrackerVds(
+        trackingId || this.growingIO.trackingId
       );
+      // 插件中没有页面时直接将插件appId作为页面信息
+      return (
+        title || `/插件${vds.appId}${path ? '_' + last(path.split('/')) : ''}`
+      );
+    } else {
+      return title;
+    }
   };
 
-  // 获取页面参数
-  getQuery = (query: any) => {
+  // 格式化页面参数
+  qsQuery = (query = {}) => {
     const filtQeury = { ...query };
     unset(filtQeury, 'wxShoppingListScene');
     return qsStringify(filtQeury);
   };
 
-  // 获取上一个页面路径
+  // 获取页面来源
   getReferralPage = (trackingId: string) => {
     const {
       minipInstance,
-      dataStore: { lastPageEvent, scene }
+      dataStore: { lastPageEvent, scene, eventHooks }
     } = this.growingIO;
     return (
       lastPageEvent[trackingId]?.path ||
+      eventHooks.appEffects.enterParams?.referrerInfo?.appId ||
       (scene ? `scn:${minipInstance.scnPrefix}${scene}` : null)
     );
   };
@@ -72,7 +147,7 @@ class MinipPage implements MinipPageType {
     // 自定义path的地址参数截取（onShareAppMessage中的页面参数是拼在地址中的）
     const customSplit = splitPath(result.path ?? '');
 
-    let path = this.path;
+    let path = this.getPagePath();
     let parsedQeury: any = {};
     let resultHasPath = has(result, 'path');
     // 优先使用自定义的地址
@@ -84,6 +159,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的问题。
@@ -91,7 +172,9 @@ class MinipPage implements MinipPageType {
     // 自定义query没有值则使用当前页面默认参数
     // 如果path存在，但是不携带参数，此时不使用当前页面的默认参数
     if (!resultHasPath && isEmpty(parsedQeury)) {
-      parsedQeury = qsParse(this.query ?? '') || {};
+      const stackPage = this.growingIO.minipInstance.getCurrentPage();
+      parsedQeury =
+        stackPage.options || this.queryOption[stackPage.route] || {};
     }
 
     return [path, qsStringify(parsedQeury)];
@@ -118,6 +201,22 @@ class MinipPage implements MinipPageType {
     result.query = queryString;
     return result;
   };
+
+  // 给事件合并页面属性
+  eventSetPageProps = (trackingId: string, event: EVENT) => {
+    const pageProps = niceTry(
+      () => this.pageProps[trackingId][this.getPagePath()]
+    );
+    if (!isEmpty(pageProps)) {
+      return limitObject(
+        getDynamicAttributes({
+          ...event.attributes,
+          ...pageProps
+        })
+      );
+    }
+    return event.attributes;
+  };
 }
 
 export default MinipPage;