gio-miniprogram-sdk 4.1.0 → 4.3.0

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

@@ -1,16 +1,13 @@
 import { get, isEmpty, isFunction, unset } from '@@/utils/glodash';
 import { GrowingIOType } from '@@/types/growingIO';
-import { niceTry } from '@@/utils/tools';
 import { PageHookLifeCircle } from '@@/types/eventHooks';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 class PageEffects {
   public buildTabClickEvent: (tabItem: any) => void;
   private prevEvent: any;
-  private argQuery: any;
   constructor(public growingIO: GrowingIOType) {
     this.prevEvent = {};
-    this.argQuery = {};
   }
 
   main = (page: any, event: PageHookLifeCircle, args: any) => {
@@ -23,15 +20,15 @@ class PageEffects {
       platformConfig,
       dataStore: {
         getTrackerVds,
+        getOriginalSource,
+        setOriginalSource,
         trackersExecute,
-        shareOut,
         eventHooks,
         toggleShareOut,
         buildAppMessageEvent,
         buildTimelineEvent,
         buildAddFavorites
-      },
-      inPlugin
+      }
     }: GrowingIOType = this.growingIO;
     const { currentPage } = eventHooks;
     if (
@@ -69,43 +66,34 @@ class PageEffects {
     currentPage.currentLifecycle = event;
     switch (event) {
       case pageListeners.pageLoad: {
-        this.argQuery[path] =
+        // 获取一次页面参数存起来，防止类似支付宝小程序只能通过生命周期获取页面参数或页面堆栈拿不到页面参数，做兜底
+        currentPage.queryOption[path] =
           get(page, 'options') ||
           get(page, '__displayReporter.query') ||
           get(page, '$page.query') ||
           get(page, '$wx.__displayReporter.query') ||
+          get(page, '$taroParams') ||
           args[0] ||
           {};
-        unset(this.argQuery[path], '$taroTimestamp');
-        currentPage.parsePage(page, this.argQuery[path]);
+        unset(currentPage.queryOption[path], '$taroTimestamp');
         break;
       }
       case pageListeners.pageShow: {
-        if (inPlugin) {
-          currentPage.parsePage(page, this.argQuery[path]);
-          if (!currentPage.path) {
-            // 插件中没有页面时直接将插件appId作为页面信息
-            currentPage.path = `/插件${vdsConfig.appId}}`;
-            currentPage.title = `/插件${vdsConfig.appId}}`;
+        trackersExecute((trackingId: string) => {
+          // 检查originalSource内容是否已经被消费，如果没有被消费是同一个页面，说明visit还没被发出去，要更新title
+          const originalSource = getOriginalSource(trackingId);
+          if (!isEmpty(originalSource) && originalSource.path === path) {
+            setOriginalSource(trackingId, {
+              ...originalSource,
+              title: currentPage.getPageTitle()
+            });
           }
-          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();
-          trackersExecute((trackingId: string) => {
-            const { trackPage } = getTrackerVds(trackingId);
-            if (trackPage) {
-              this.buildPageEvent(trackingId);
-            }
-          });
-        }
+          // 发page事件
+          const { trackPage } = getTrackerVds(trackingId);
+          if (trackPage) {
+            this.buildPageEvent(trackingId);
+          }
+        });
         // 分享标记置为false
         toggleShareOut(false);
         break;
@@ -157,12 +145,6 @@ class PageEffects {
       default:
         break;
     }
-    // 页面销毁移除当前页面的属性
-    if (event === pageListeners.pageUnload) {
-      trackersExecute((trackingId: string) => {
-        currentPage.pageProps[trackingId] = undefined;
-      });
-    }
   };
 
   // 构建页面访问事件
@@ -172,29 +154,19 @@ class PageEffects {
         eventContextBuilder,
         eventInterceptor,
         eventHooks: { currentPage }
-      },
-      minipInstance
+      }
     } = this.growingIO;
     const event = {
       eventType: 'PAGE',
       referralPage: currentPage.getReferralPage(trackingId),
-      ...eventContextBuilder(trackingId),
-      // page事件要单独设一个title以覆盖eventContextBuilder中的lastPage的title错误值
-      title:
-        currentPage?.title ||
-        minipInstance.getPageTitle(minipInstance.getCurrentPage()),
-      timestamp: currentPage.time
+      ...eventContextBuilder(trackingId)
     };
+    // 合并页面属性
+    event.attributes = currentPage.eventSetPageProps(trackingId, event);
     // 传入参数生成的page事件取值为传入参数
     if (!isEmpty(props) && props.title) {
       event.title = props.title;
     }
-    // 添加页面属性
-    const pageProps = niceTry(() => currentPage.pageProps[trackingId]);
-    if (!isEmpty(pageProps)) {
-      event.attributes = pageProps;
-      currentPage.pageProps[trackingId] = undefined;
-    }
     eventInterceptor(event);
   };
 }

package/src/core/dataStore/index.ts

@@ -13,7 +13,6 @@ import {
   isBoolean,
   isEmpty,
   isFunction,
-  isNil,
   isString,
   keys,
   typeOf,
@@ -25,6 +24,7 @@ import {
   consoleText,
   getGlobal,
   guid,
+  limitObject,
   niceTry
 } from '@@/utils/tools';
 import {
@@ -93,7 +93,7 @@ class DataStore implements DataStoreType {
       EMIT_MSG.ON_COMMIT_REQUEST,
       ({ eventData: event, trackingId }) => {
         if (event.eventType === 'VISIT') {
-          this.lastVisitEvent = event;
+          this.lastVisitEvent[trackingId] = event;
         }
         if (event.eventType === 'PAGE') {
           this.lastPageEvent[trackingId] = event;
@@ -218,26 +218,25 @@ class DataStore implements DataStoreType {
   };
 
   // 保存初始来源信息
-  setOriginalSource = (trackingId: string, { path, query }) => {
+  setOriginalSource = (trackingId: string, origins: any) => {
     const { minipInstance } = this.growingIO;
-    if (isNil(this.getOriginalSource(trackingId))) {
-      const originalSource = { path, query, title: '' };
-      minipInstance.setStorageSync(
-        this.getStorageKey(trackingId, 'originalSource'),
-        JSON.stringify(originalSource)
-      );
-    }
+    minipInstance.setStorageSync(
+      this.getStorageKey(trackingId, 'originalSource'),
+      JSON.stringify(origins)
+    );
   };
 
   // 获取初始来源信息
   getOriginalSource = (trackingId: string) => {
     const { minipInstance } = this.growingIO;
-    return niceTry(() =>
-      JSON.parse(
-        minipInstance.getStorageSync(
-          this.getStorageKey(trackingId, 'originalSource')
+    return (
+      niceTry(() =>
+        JSON.parse(
+          minipInstance.getStorageSync(
+            this.getStorageKey(trackingId, 'originalSource')
+          )
         )
-      )
+      ) ?? {}
     );
   };
 
@@ -262,12 +261,14 @@ class DataStore implements DataStoreType {
     const { platformConfig, inPlugin, minipInstance, plugins } = this.growingIO;
     const { uniVue, taro } = vdsConfig;
     // 如果是使用全量版本时，当前小程序不是框架的，要允许原生的hook
-    if (!(uniVue || taro)) {
+    if (!(uniVue || taro || minipInstance.platform === 'quickapp')) {
       platformConfig.canHook = true;
     }
     // 初始化核心钩子（重写全局）
     if (!inPlugin || ['tbp', 'jdp'].includes(minipInstance.platform)) {
       this.eventHooks.initEventHooks();
+    } else {
+      this.eventHooks.initOriginalValue();
     }
     /** 第三方框架重写 */
     // uniapp
@@ -364,19 +365,11 @@ class DataStore implements DataStoreType {
       this.updateVdsConfig(trackingId, { ...trakerVds, [k]: v });
       // 从关闭到打开dataCollect时补发visit和page
       if (k === 'dataCollect' && prevConfig.dataCollect !== v && v) {
+        // 更新session
         userStore.setSessionId(trackingId);
-        const { path, query, settedTitle } = this.eventHooks.currentPage;
-        // 重新获取页面title，防止切换配置前修改了title没取到
-        this.eventHooks.currentPage.title =
-          settedTitle[path] ||
-          this.growingIO.minipInstance.getPageTitle(
-            this.growingIO.minipInstance.getCurrentPage()
-          );
-        // visit取当前页面值
-        this.sendVisit(trackingId, { path, query });
-        // 要重设一次页面时间，防止比visit早
-        this.eventHooks.currentPage.time = Date.now();
-        this.sendPage(trackingId, { path, query });
+        // 重发visit/page
+        this.sendVisit(trackingId);
+        this.sendPage(trackingId);
       }
       // 配置项有变更要全局广播
       emitter.emit(EMIT_MSG.OPTION_CHANGE, { optionName: k, optionValue: v });
@@ -430,10 +423,7 @@ class DataStore implements DataStoreType {
 
   // 手动调用visit事件的方法
   sendVisit = (trackingId: string, props?: any) => {
-    (this.eventHooks.appEffects as any).buildVisitEvent(
-      trackingId,
-      props ?? this.lastVisitEvent
-    );
+    (this.eventHooks.appEffects as any).buildVisitEvent(trackingId, props);
   };
 
   // 手动调用page事件的方法
@@ -481,6 +471,26 @@ class DataStore implements DataStoreType {
     }
   };
 
+  // 事件重组
+  eventRefactor = (e: any) => {
+    // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
+    const ne = {
+      ...e,
+      ...this.eventContextBuilder(e.trackingId, {
+        path: e.path,
+        query: e.query,
+        // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
+        timestamp: e.timestamp
+      })
+    };
+    // 防止事件原有的属性被通用属性直接覆盖
+    ne.attributes = {
+      ...(ne.attributes ?? {}),
+      ...(e.attributes ?? {})
+    };
+    return ne;
+  };
+
   // 事件拦截器（有的通用维度字段需要异步获取，为了防止事件在通用维度还没返回之前就发出去）一般只有最开始的个别事件会被拦住
   eventInterceptor = (event: any) => {
     const { systemInfo, network } = this.growingIO.minipInstance;
@@ -490,17 +500,7 @@ class DataStore implements DataStoreType {
     } else if (!isEmpty(this.interceptEvents)) {
       // 有通用维度字段了，且有被拦截的事件，放一起重新添加通用维度字段再提交转换
       [...this.interceptEvents, event].forEach((e: any) => {
-        // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
-        const ne = {
-          ...e,
-          ...this.eventContextBuilder(event.trackingId, {
-            path: e.path,
-            query: e.query,
-            // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
-            timestamp: e.timestamp
-          })
-        };
-        this.eventConverter(ne);
+        this.eventConverter(this.eventRefactor(e));
       });
       this.interceptEvents = [];
     } else {
@@ -516,17 +516,7 @@ class DataStore implements DataStoreType {
     } = this.growingIO;
     if (systemInfo && network && !isEmpty(this.interceptEvents)) {
       [...this.interceptEvents].forEach((e: any) => {
-        // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
-        const ne = {
-          ...e,
-          ...this.eventContextBuilder(e.trackingId, {
-            path: e.path,
-            query: e.query,
-            // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
-            timestamp: e.timestamp
-          })
-        };
-        this.eventConverter(ne);
+        this.eventConverter(this.eventRefactor(e));
       });
       this.interceptEvents = [];
     }
@@ -548,16 +538,17 @@ class DataStore implements DataStoreType {
     const event = {
       eventType: 'CUSTOM',
       eventName: '$mp_on_share',
-      attributes: {
-        $from: originResult.from,
-        $target: originResult?.target?.id,
-        $share_title: updateResult?.title,
-        $share_path: head(uri),
-        $share_query: uri[1],
-        ...updateResult?.attributes
-      },
       ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      $from: originResult.from,
+      $target: originResult?.target?.id,
+      $share_title: updateResult?.title,
+      $share_path: head(uri),
+      $share_query: uri[1],
+      ...updateResult?.attributes
+    });
     eventInterceptor(event);
   };
 
@@ -577,15 +568,16 @@ class DataStore implements DataStoreType {
     const event = {
       eventType: 'CUSTOM',
       eventName: '$mp_share_timeline',
-      attributes: {
-        $target: originResult?.target?.id,
-        $share_title: updateResult?.title,
-        $share_path: head(uri),
-        $share_query: uri[1],
-        ...updateResult?.attributes
-      },
       ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      $target: originResult?.target?.id,
+      $share_title: updateResult?.title,
+      $share_path: head(uri),
+      $share_query: uri[1],
+      ...updateResult?.attributes
+    });
     eventInterceptor(event);
   };
 
@@ -605,13 +597,14 @@ class DataStore implements DataStoreType {
     const event = {
       eventType: 'CUSTOM',
       eventName: '$mp_add_favorites',
-      attributes: {
-        $share_title: updateResult?.title,
-        $share_path: head(uri),
-        $share_query: uri[1]
-      },
       ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      $share_title: updateResult?.title,
+      $share_path: head(uri),
+      $share_query: uri[1]
+    });
     eventInterceptor(event);
   };
 

package/src/core/growingIO.ts

@@ -1,4 +1,5 @@
 import {
+  forEach,
   isArray,
   isEmpty,
   isFunction,
@@ -205,15 +206,55 @@ class GrowingIO implements GrowingIOType {
 
   // 设置页面属性
   setPageAttributes = (trackingId: string, properties: any) => {
-    const { currentPage } = this.dataStore.eventHooks;
-    if (isEmpty(currentPage.pageProps[trackingId])) {
-      currentPage.pageProps[trackingId] = {};
+    if (isObject(properties) && !isEmpty(properties)) {
+      const { currentPage } = this.dataStore.eventHooks;
+      const path = currentPage.getPagePath();
+      if (isEmpty(currentPage.pageProps[trackingId])) {
+        currentPage.pageProps[trackingId] = {};
+      }
+      if (isEmpty(currentPage.pageProps[trackingId][path])) {
+        currentPage.pageProps[trackingId][path] = {};
+      }
+      // 结果合并，动态属性不作处理
+      if (!isEmpty(properties)) {
+        forEach(properties, (v, k) => {
+          if (
+            !isFunction(currentPage.pageProps[trackingId][path][k]) ||
+            isFunction(v)
+          ) {
+            currentPage.pageProps[trackingId][path][k] = v;
+          }
+        });
+      }
+      return true;
+    } else {
+      callError('setPageAttributes');
+      return false;
     }
-    if (!isEmpty(properties)) {
-      currentPage.pageProps[trackingId] = {
-        ...currentPage.pageProps[trackingId],
-        ...limitObject(properties)
-      };
+  };
+
+  // 清空已设置的页面属性
+  clearPageAttributes = (
+    trackingId: string,
+    properties: string[] | undefined
+  ) => {
+    try {
+      if (
+        !isEmpty(this.dataStore.eventHooks.currentPage.pageProps[trackingId])
+      ) {
+        const { currentPage } = this.dataStore.eventHooks;
+        const path = currentPage.getPagePath();
+        if (isArray(properties) && !isEmpty(properties)) {
+          properties.forEach((propName: string) => {
+            unset(currentPage.pageProps[trackingId][path], propName);
+          });
+        } else {
+          currentPage.pageProps[trackingId][path] = {};
+        }
+      }
+    } catch (error) {
+      callError('clearPageAttributes');
+      return false;
     }
   };
 
@@ -261,20 +302,23 @@ class GrowingIO implements GrowingIOType {
 
   // 发送用户属性
   setUserAttributes = (trackingId: string, userAttributes: any) => {
-    if (!isEmpty(userAttributes) && isObject(userAttributes)) {
+    if (isObject(userAttributes) && !isEmpty(userAttributes)) {
       const { eventContextBuilder, eventInterceptor, lastVisitEvent } =
         this.dataStore;
       const event = {
         eventType: 'LOGIN_USER_ATTRIBUTES',
-        attributes: limitObject(userAttributes),
         ...eventContextBuilder(trackingId)
       };
+      event.attributes = limitObject({
+        ...(event.attributes ?? {}),
+        ...getDynamicAttributes(userAttributes)
+      });
       // 该方法很可能被放在在app的onShow中的wx.login异步回调中，
       // 此时页面的path和query可能还没取到，就拿visit事件的path和query补上
       if (!event.path) {
-        event.path = lastVisitEvent.path;
-        event.query = lastVisitEvent.query;
-        event.title = lastVisitEvent.title;
+        event.path = lastVisitEvent[trackingId]?.path;
+        event.query = lastVisitEvent[trackingId]?.query;
+        event.title = lastVisitEvent[trackingId]?.title;
       }
       eventInterceptor(event);
     } else {
@@ -301,14 +345,7 @@ class GrowingIO implements GrowingIOType {
       // 切换userId时重置session并补发visit
       if (prevId && prevId !== userId) {
         this.userStore.setSessionId(trackingId);
-        const { path, query, settedTitle } =
-          this.dataStore.eventHooks.currentPage;
-        // 重新获取页面title，防止切换配置前修改了title没取到
-        this.dataStore.eventHooks.currentPage.title =
-          settedTitle[path] ||
-          this.minipInstance.getPageTitle(this.minipInstance.getCurrentPage());
-        // visit取当前页面值
-        this.dataStore.sendVisit(trackingId, { path, query });
+        this.dataStore.sendVisit(trackingId);
       }
     } else {
       callError('setUserId');
@@ -321,13 +358,20 @@ class GrowingIO implements GrowingIOType {
     this.userStore.setUserKey(trackingId, undefined);
   };
 
-  // 设置埋点事件的通用属性（即每个埋点事件都会带上的属性值）
+  // 设置全局通用属性（即每个事件都会带上的属性值）
   setGeneralProps = (trackingId: string, properties: any) => {
-    if (!isEmpty(properties)) {
-      this.dataStore.generalProps[trackingId] = {
-        ...(this.dataStore.generalProps[trackingId] ?? {}),
-        ...properties
-      };
+    if (isObject(properties) && !isEmpty(properties)) {
+      if (isEmpty(this.dataStore.generalProps[trackingId])) {
+        this.dataStore.generalProps[trackingId] = {};
+      }
+      forEach(properties, (v, k) => {
+        if (
+          !isFunction(this.dataStore.generalProps[trackingId][k]) ||
+          isFunction(v)
+        ) {
+          this.dataStore.generalProps[trackingId][k] = v;
+        }
+      });
       return true;
     } else {
       callError('setGeneralProps');
@@ -335,14 +379,13 @@ class GrowingIO implements GrowingIOType {
     }
   };
 
-  // 清空已设置的埋点事件的通用属性
+  // 清空已设置的全局通用属性
   clearGeneralProps = (
     trackingId: string,
     properties: string[] | undefined
   ) => {
     try {
       if (!isEmpty(this.dataStore.generalProps[trackingId])) {
-        // 获取目标tracker的引用
         if (isArray(properties) && !isEmpty(properties)) {
           properties.forEach((propName: string) => {
             unset(this.dataStore.generalProps[trackingId], propName);
@@ -352,7 +395,7 @@ class GrowingIO implements GrowingIOType {
         }
       }
     } catch (error) {
-      callError('setGeneralProps');
+      callError('clearGeneralProps');
       return false;
     }
   };
@@ -360,22 +403,22 @@ class GrowingIO implements GrowingIOType {
   // 自定义埋点事件
   track = (
     trackingId: string,
-    name: string,
+    eventName: string,
     properties: { [key: string]: string | string[] }
   ) => {
-    eventNameValidate(name, () => {
-      const { eventContextBuilder, eventInterceptor, generalProps } =
-        this.dataStore;
-      const mergedProperties = {
-        ...(generalProps[trackingId] ?? {}),
-        ...(isObject(properties) && !isEmpty(properties) ? properties : {})
-      };
+    eventNameValidate(eventName, () => {
+      const { eventContextBuilder, eventInterceptor } = this.dataStore;
       const event = {
         eventType: 'CUSTOM',
-        eventName: name,
-        attributes: limitObject(getDynamicAttributes(mergedProperties)),
+        eventName,
         ...eventContextBuilder(trackingId)
       };
+      event.attributes = limitObject({
+        ...(event.attributes ?? {}),
+        ...getDynamicAttributes({
+          ...(isObject(properties) && !isEmpty(properties) ? properties : {})
+        })
+      });
       // 埋点事件要保留'&&sendTo'字段用于多实例复制发送
       if (
         this.plugins.gioMultipleInstances &&
@@ -453,12 +496,15 @@ class GrowingIO implements GrowingIOType {
         const event = {
           eventType: 'CUSTOM',
           eventName: timer.eventName,
-          attributes: limitObject({
-            ...properties,
-            event_duration: timer.leng > maxEnd ? 0 : timer.leng / 1000
-          }),
           ...eventContextBuilder(trackingId)
         };
+        event.attributes = limitObject({
+          ...(event.attributes ?? {}),
+          ...getDynamicAttributes({
+            ...(isObject(properties) && !isEmpty(properties) ? properties : {}),
+            event_duration: timer.leng > maxEnd ? 0 : timer.leng / 1000
+          })
+        });
         // 埋点事件要保留'&&sendTo'字段用于多实例复制发送
         if (
           this.plugins.gioMultipleInstances &&
@@ -555,7 +601,9 @@ class GrowingIO implements GrowingIOType {
     if (!isEmpty(extraParams)) {
       extraParams.forEach((o) => {
         if (!ignoreFields.includes(o)) {
-          infos[`gio${o}`] = this.dataStore.lastVisitEvent[o];
+          infos[`gio${o}`] = (this.dataStore.lastVisitEvent[trackingId] ?? {})[
+            o
+          ];
         }
       });
     }

package/src/index.ts

@@ -62,16 +62,16 @@ const gdp = function () {
 getGlobal().gdp = gdp;
 getGlobal().gioSDKVersion = gioInstance.sdkVersion;
 
-export const GioApp = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingApp ?? App
-);
-export const GioPage = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingPage ?? Page
-);
-export const GioComponent = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingComponent ?? Component
-);
-export const GioBehavior = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingBehavior ?? Behavior
-);
+const {
+  growingApp,
+  growingPage,
+  growingComponent,
+  growingBehavior,
+  initOriginalValue
+} = gioInstance.dataStore.eventHooks;
+initOriginalValue();
+export const GioApp = niceTry(() => growingApp ?? App);
+export const GioPage = niceTry(() => growingPage ?? Page);
+export const GioComponent = niceTry(() => growingComponent ?? Component);
+export const GioBehavior = niceTry(() => growingBehavior ?? Behavior);
 export default gdp;