gio-miniprogram-sdk 4.1.0 → 4.2.0

package/src/core/dataStore/index.ts

@@ -25,6 +25,7 @@ import {
   consoleText,
   getGlobal,
   guid,
+  limitObject,
   niceTry
 } from '@@/utils/tools';
 import {
@@ -548,16 +549,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 +579,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 +608,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,58 @@ 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;
+      if (isEmpty(currentPage.pageProps[trackingId])) {
+        currentPage.pageProps[trackingId] = {};
+      }
+      if (isEmpty(currentPage.pageProps[trackingId][currentPage.path])) {
+        currentPage.pageProps[trackingId][currentPage.path] = {};
+      }
+      // 结果合并，动态属性不作处理
+      if (!isEmpty(properties)) {
+        forEach(properties, (v, k) => {
+          if (
+            !isFunction(
+              currentPage.pageProps[trackingId][currentPage.path][k]
+            ) ||
+            isFunction(v)
+          ) {
+            currentPage.pageProps[trackingId][currentPage.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;
+        if (isArray(properties) && !isEmpty(properties)) {
+          properties.forEach((propName: string) => {
+            unset(
+              currentPage.pageProps[trackingId][currentPage.path],
+              propName
+            );
+          });
+        } else {
+          currentPage.pageProps[trackingId][currentPage.path] = {};
+        }
+      }
+    } catch (error) {
+      callError('clearPageAttributes');
+      return false;
     }
   };
 
@@ -261,14 +305,17 @@ 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) {
@@ -321,13 +368,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 +389,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 +405,7 @@ class GrowingIO implements GrowingIOType {
         }
       }
     } catch (error) {
-      callError('setGeneralProps');
+      callError('clearGeneralProps');
       return false;
     }
   };
@@ -360,22 +413,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 +506,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 &&

package/src/platformConfig/base.ts

@@ -1,5 +1,4 @@
 import { PlatformConfigType } from '@@/types/platforms';
-import { niceTry } from '@@/utils/tools';
 
 const Config: PlatformConfigType = {
   scnPrefix: '',

package/src/plugins/gioABTest.ts

@@ -13,11 +13,17 @@ import {
   startsWith,
   toString
 } from '@@/utils/glodash';
-import { consoleText, hashCode, niceCallback } from '@@/utils/tools';
+import {
+  consoleText,
+  hashCode,
+  limitObject,
+  niceCallback
+} from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
 import { ABTEST_DATA_REG, ABTEST_SIGN_REG } from '@@/constants/regex';
 
 class GioABTest {
+  public pluginVersion: string;
   // 请求间隔时长
   public requestInterval: number;
   // 请求超时时长
@@ -27,6 +33,7 @@ class GioABTest {
   // 接口重试计数
   public retryCount: number;
   constructor(public growingIO: GrowingIOType, options: any) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     const {
       abServerUrl = 'https://ab.growingio.com',
       requestInterval,
@@ -276,14 +283,14 @@ class GioABTest {
     let event = {
       eventType: 'CUSTOM',
       eventName: '$exp_hit',
-      attributes: {
-        $exp_layer_id: layerId,
-        $exp_id: experimentId,
-        $exp_strategy_id: strategyId
-      },
-      ...eventContextBuilder(trackingId),
-      customEventType: 0
+      ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      $exp_layer_id: layerId,
+      $exp_id: experimentId,
+      $exp_strategy_id: strategyId
+    });
     eventConverter(event);
   };
 }

package/src/plugins/gioCompress.ts

@@ -5,9 +5,11 @@
 import { GrowingIOType } from '@@/types/growingIO';
 
 class GioCompress {
+  public pluginVersion: string;
   private f;
   private _compress;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     this.f = String.fromCharCode;
     this._compress = function (uncompressed, bitsPerChar, getCharFromInt) {
       if (uncompressed === null) return '';

package/src/plugins/gioEventAutoTracking.ts

@@ -10,8 +10,10 @@ import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioEventAutoTracking {
+  public pluginVersion: string;
   private prevEvent: any;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     ut = this.growingIO.utils;
     this.prevEvent = {};
   }
@@ -88,7 +90,7 @@ class GioEventAutoTracking {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
-        dataStore: { eventContextBuilder, eventInterceptor }
+        dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
       } = this.growingIO;
       const target = e.currentTarget || e.target;
       let idx;
@@ -115,6 +117,11 @@ class GioEventAutoTracking {
         ],
         ...eventContextBuilder(trackingId)
       };
+      // 合并页面属性
+      event.attributes = eventHooks.currentPage.eventSetPageProps(
+        trackingId,
+        event
+      );
       eventInterceptor(event);
     }
   };
@@ -122,7 +129,7 @@ class GioEventAutoTracking {
   // 构建tab菜单点击事件
   buildTabClickEvent = (trackingId: string, tabItem: any) => {
     const {
-      dataStore: { eventContextBuilder, eventInterceptor }
+      dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
     } = this.growingIO;
     const event = {
       eventType: 'VIEW_CLICK',
@@ -136,6 +143,11 @@ class GioEventAutoTracking {
       ],
       ...eventContextBuilder(trackingId)
     };
+    // 合并页面属性
+    event.attributes = eventHooks.currentPage.eventSetPageProps(
+      trackingId,
+      event
+    );
     eventInterceptor(event);
   };
 
@@ -148,7 +160,7 @@ class GioEventAutoTracking {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
-        dataStore: { eventContextBuilder, eventInterceptor }
+        dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
       } = this.growingIO;
       const target = e.currentTarget || e.target;
       const event = {
@@ -163,6 +175,11 @@ class GioEventAutoTracking {
         }
       }
       event.element = [event.element];
+      // 合并页面属性
+      event.attributes = eventHooks.currentPage.eventSetPageProps(
+        trackingId,
+        event
+      );
       eventInterceptor(event);
     }
   };

package/src/plugins/gioImpressionTracking.ts

@@ -9,14 +9,21 @@ import {
   isArray,
   isEmpty,
   isEqualArray,
+  isObject,
   isString,
   toString
 } from '@@/utils/glodash';
-import { eventNameValidate, hashCode, niceTry } from '@@/utils/tools';
+import {
+  eventNameValidate,
+  hashCode,
+  limitObject,
+  niceTry
+} from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioImpressionTracking {
+  public pluginVersion: string;
   public observerIds: any;
   public rects: any;
   public pageImpObserver: any;
@@ -25,6 +32,7 @@ class GioImpressionTracking {
   public componentQueryTarget: any;
   public sentImps: any;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     ut = this.growingIO.utils;
     this.observerIds = {};
     this.rects = {};
@@ -353,9 +361,12 @@ class GioImpressionTracking {
     const event = {
       eventType: 'CUSTOM',
       eventName,
-      attributes: properties,
       ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      ...(isObject(properties) && !isEmpty(properties) ? properties : {})
+    });
     if (plugins.gioMultipleInstances && !isEmpty(sendTargets)) {
       event['&&sendTo'] = sendTargets;
     }

package/src/plugins/gioMultipleInstances.ts

@@ -11,8 +11,10 @@ import { OriginOptions } from '@@/types/dataStore';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 export class GioMultipleInstances {
+  public pluginVersion: string;
   public subTrackingIds: string[];
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     this.subTrackingIds = [];
     this.growingIO.emitter.on(EMIT_MSG.ON_SDK_INITIALIZE_BEFORE, () => {
       // 自动重写部分代码以实现多实例功能
@@ -153,10 +155,19 @@ export class GioMultipleInstances {
         unset(event, '&&sendTo');
         sendTo.forEach((trackingId: string) => {
           const { eventContextBuilder } = self.growingIO.dataStore;
-          originFunction.call(this, {
+          const newEvent = {
             ...event,
-            ...eventContextBuilder(trackingId)
-          });
+            ...eventContextBuilder(
+              trackingId,
+              undefined,
+              event.trackingId !== trackingId
+            )
+          };
+          newEvent.attributes = {
+            ...newEvent.attributes,
+            ...event.attributes
+          };
+          originFunction.call(this, newEvent);
         });
       } else {
         // 其他事件直接发给指定调用实例

package/src/types/dataStore.ts

@@ -22,7 +22,11 @@ export interface DataStoreType {
   buildAppMessageEvent: (trackingId: string, args: any) => void;
   buildTimelineEvent: (trackingId: string, args: any) => void;
   // 事件通用维度组装
-  eventContextBuilder?: (trackingId: string, params?: any) => any;
+  eventContextBuilder?: (
+    trackingId: string,
+    params?: any,
+    executeAttributes?: boolean
+  ) => any;
   eventConverter?: (event) => void;
   eventHooks: EventHooksType;
   eventInterceptor?: (event: any | void) => void;

package/src/types/eventHooks.ts

@@ -1,3 +1,5 @@
+import { EVENT } from './base';
+
 export type AppHookLifeCircle = 'onShow' | 'onHide' | 'onError';
 export type PageHookLifeCircle =
   | 'onShow'
@@ -89,6 +91,7 @@ export interface MinipPageType {
   updateAppMessageResult: (result: PageShareResult) => PageShareResult;
   updateTimelineResult: (result: PageShareResult) => PageShareResult;
   updateAddFavoritesResult: (result: PageShareResult) => PageShareResult;
+  eventSetPageProps: (trackingId: string, event: EVENT) => any;
 }
 
 export interface EventHooksType {

package/src/types/growingIO.ts

@@ -6,6 +6,15 @@ import { UploaderType } from '@@/types/uploader';
 import { UserStoreType } from '@@/types/userStore';
 
 export interface GrowingIOType {
+  // 工具类
+  utils?: any;
+  // 监听器
+  emitter: {
+    emit?: (msg: string, args?: any) => void;
+    on?: (msg: string, method: (args?: any) => any) => void;
+    once?: (msg: string, method: (args?: any) => any) => void;
+    off?: (msg: string, method: (args?: any) => any) => void;
+  };
   // 小程序平台
   gioPlatform: PLATFORMTYPES;
   // 标记当前小程序是什么框架
@@ -54,63 +63,73 @@ export interface GrowingIOType {
   setOption: (trackingId: string, optionKey: string, value: any) => void;
   // 运行中获取配置
   getOption: (trackingId: string, optionKey?: string) => any;
-  // 创建自定义埋点事件
-  track?: (
+  // 设置页面属性
+  setPageAttributes: (trackingId: string, properties: any) => void;
+  // 清空已设置的页面属性
+  clearPageAttributes: (
     trackingId: string,
-    name: string,
-    properties: { [key: string]: string },
-    items?: { key: string; id: string; attributes?: { [key: string]: string } }
+    properties: string[] | undefined
   ) => void;
-  // 设置登录用户Id
-  setUserId?: (trackingId: string, userId: string, userKey?: string) => void;
-  // 清除登录用户Id
-  clearUserId?: (trackingId: string) => void;
+  // 手动发page
+  sendPage: (trackingId: string, props?: any) => void;
   // 设置openId作为uid
   identify?: (trackingId: string, openId: string) => void;
   // 发送用户变量
   setUserAttributes?: (trackingId: string, userAttributes: any) => void;
-  // 初始化回调
-  initCallback?: () => void;
-  // 错误提示
-  callError?: (fn: string, type?: boolean, msg?: string) => void;
-  // 工具类
-  utils?: any;
-  // 事件转换
-  eventConverter?: (event: any) => void;
-  // 事件拦截器
-  eventInterceptor?: (event: any) => void;
-  // 设置埋点通用属性
+  // 设置登录用户Id
+  setUserId?: (trackingId: string, userId: string, userKey?: string) => void;
+  // 清除登录用户Id
+  clearUserId?: (trackingId: string) => void;
+  // 设置全局通用属性
   setGeneralProps?: (trackingId: string, properties: any) => void;
-  // 清除已设置的埋点通用属性
+  // 清除已设置的全局通用属性
   clearGeneralProps?: (
     trackingId: string,
     properties: string[] | undefined
   ) => void;
-  // 手动更新曝光监听
-  updateImpression?: (collect?: any) => void;
+  // 创建自定义埋点事件
+  track?: (
+    trackingId: string,
+    name: string,
+    properties: { [key: string]: string },
+    items?: { key: string; id: string; attributes?: { [key: string]: string } }
+  ) => void;
+  // 初始化事件计时器
+  trackTimerStart: (trackingId: string, eventName: string) => any;
+  // 暂停事件计时器
+  trackTimerPause: (trackingId: string, timerId: string) => boolean;
+  // 恢复事件计时器
+  trackTimerResume: (trackingId: string, timerId: string) => boolean;
+  // 停止事件计时器并上报事件
+  trackTimerEnd: (
+    trackingId: string,
+    timerId: string,
+    properties: any
+  ) => boolean;
+  // 移除事件计时器
+  removeTimer: (trackingId: string, timerId: string) => boolean;
   // 清除所有事件计时器
-  clearTrackTimer?: (trackingId: string) => void;
+  clearTrackTimer: (trackingId: string) => void;
   // 手动获取位置信息补发visit上报
   setLocation: (
     trackingId: string,
     latitude: number,
     longitude: number
   ) => void;
-  // 获取打通信息
-  getGioInfo: (trackingId: string) => string;
+  // 手动更新曝光监听
+  updateImpression?: (collect?: any) => void;
   // 获取ABTest数据
   getABTest?: (
     trackingId: string,
     layerId: string,
     callback?: (arg: any) => any
   ) => void;
-
-  emitter: {
-    emit?: (msg: string, args?: any) => void;
-    on?: (msg: string, method: (args?: any) => any) => void;
-    once?: (msg: string, method: (args?: any) => any) => void;
-    off?: (msg: string, method: (args?: any) => any) => void;
-  };
+  // 获取打通信息
+  getGioInfo: (trackingId: string) => string;
+  // 初始化回调
+  initCallback?: () => void;
+  // 错误提示
+  callError?: (fn: string, type?: boolean, msg?: string) => void;
   GioApp?: any;
   GioPage?: any;
   GioComponent?: any;

package/src/utils/tools.ts

@@ -3,8 +3,10 @@ import {
   compact,
   find,
   forEach,
+  formatDate,
   head,
   isArray,
+  isDate,
   isEmpty,
   isFunction,
   isNil,
@@ -310,6 +312,8 @@ export const limitObject = (o: any) => {
       } else if (isArray(v)) {
         ob[key] = compact(v.slice(0, 100), true);
         ob[key] = ob[key].join('||').slice(0, 1000);
+      } else if (isDate(v)) {
+        ob[key] = formatDate(v);
       } else {
         ob[key] = !isNil(v) ? toString(v).slice(0, 1000) : '';
       }