gio-miniprogram-sdk 4.3.0 → 4.3.2

package/src/core/growingIO.ts

@@ -163,8 +163,8 @@ class GrowingIO implements GrowingIOType {
   // 需要校验实例的方法执行
   handlerDistribute = (trackingId: string, handler: string, args: any) => {
     const { initializedTrackingIds, getTrackerVds } = this.dataStore;
-    const trakerVds = getTrackerVds(trackingId);
-    if (trakerVds && initializedTrackingIds.includes(trackingId)) {
+    const trackerVds = getTrackerVds(trackingId);
+    if (trackerVds && initializedTrackingIds.includes(trackingId)) {
       return this[handler](trackingId, ...args);
     } else {
       consoleText(`不存在实例：${trackingId}，请检查!`, 'warn');
@@ -342,10 +342,9 @@ class GrowingIO implements GrowingIOType {
       if (idMapping) {
         this.userStore.setUserKey(trackingId, isNil(userKey) ? '' : userKey);
       }
-      // 切换userId时重置session并补发visit
+      // 切换userId时重置session
       if (prevId && prevId !== userId) {
         this.userStore.setSessionId(trackingId);
-        this.dataStore.sendVisit(trackingId);
       }
     } else {
       callError('setUserId');

package/src/core/userStore.ts

@@ -26,12 +26,15 @@ class UserStore implements UserStoreType {
   public _userKey: StringObject;
   // 最后一次登录用户id（持久性存储）
   public _gioId: StringObject;
+  // 设置了session有效期以后判断用的session失效时间
+  public _sessionExpires: number;
   constructor(public growingIO: GrowingIOType) {
     this._uid = undefined;
     this._sessionId = {};
     this._userId = {};
     this._userKey = {};
     this._gioId = {};
+    this._sessionExpires = -1;
   }
 
   // 获取sessionId存储key
@@ -69,9 +72,26 @@ class UserStore implements UserStoreType {
 
   // 获取sessionId
   getSessionId = (trackingId: string) => {
+    // 设置了session时长，就需要检查session是否过期
+    const {
+      vdsConfig: { sessionExpires },
+      dataStore: { trackersExecute }
+    } = this.growingIO;
+    // 不存在sessionId（即新进）要设一个新的sessionId
     if (!this._sessionId[trackingId]) {
       this.setSessionId(trackingId);
     }
+    // 设置了session时长且过期
+    if (sessionExpires > -1) {
+      // 只要有一个session超时，所有实例都要重设sessionId
+      if (Date.now() > this._sessionExpires) {
+        trackersExecute((id: string) => {
+          this.setSessionId(id);
+        });
+      }
+      // 每次获取session后要更新过期时间
+      this._sessionExpires = Date.now() + 1000 * 60 * sessionExpires;
+    }
     return this._sessionId[trackingId];
   };
 
@@ -83,9 +103,15 @@ class UserStore implements UserStoreType {
     }
     // 小程序中sessionId只需要在内存中存储就可以，不需要持久化存储
     this._sessionId[trackingId] = id;
+    // 设置了session时长，就需要更新过期时间
+    const { sessionExpires } = this.growingIO.vdsConfig;
+    if (sessionExpires > -1) {
+      this._sessionExpires = Date.now() + 1000 * 60 * sessionExpires;
+    }
     // 广播通知登录sessionId变更
     if (prevId !== id) {
       this.growingIO.emitter.emit(EMIT_MSG.SESSIONID_UPDATE, {
+        trackingId,
         newSessionId: id,
         oldSessionId: prevId
       });

package/src/minipInstance/base.ts

@@ -64,7 +64,7 @@ class BaseInstance implements MinipInstanceType {
             // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
             const currentPath = self.getCurrentPath();
             const { title } = arguments[0] || {};
-            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+            self.growingIO.dataStore.eventHooks.currentPage.configuredTitle[
               currentPath
             ] = title;
           }
@@ -148,7 +148,7 @@ class BaseInstance implements MinipInstanceType {
       const { enterParams } = this.growingIO.dataStore.eventHooks.appEffects;
       if (!page.route && !isEmpty(enterParams)) {
         page.route = enterParams.path || '';
-        title = this._getTitleFromTabbar(instConfig, page.route);
+        title = this._getTitleFromTabBar(instConfig, page.route);
       }
       // 第四优先级取页面的navigationBarTitleText
       niceTry(() => {
@@ -169,13 +169,13 @@ class BaseInstance implements MinipInstanceType {
       });
       // 第五优先级取tabBar配置
       if (!title) {
-        title = this._getTitleFromTabbar(instConfig, page.route);
+        title = this._getTitleFromTabBar(instConfig, page.route);
       }
     }
     return limitString(title);
   };
 
-  private _getTitleFromTabbar = (
+  private _getTitleFromTabBar = (
     instConfig: any,
     pageRoute: string
   ): string => {
@@ -268,8 +268,6 @@ class BaseInstance implements MinipInstanceType {
       data,
       // 微信小程序和其他小程序里叫header
       header,
-      // 支付宝小程序里叫headers
-      headers: header,
       timeout,
       method,
       success,

package/src/minipInstance/my.ts

@@ -1,4 +1,6 @@
+import { compareVersion } from '@@/utils/tools';
 import { GrowingIOType } from '@@/types/growingIO';
+import { isFunction } from '@@/utils/glodash';
 import BaseImplements from './base';
 
 class Alipay extends BaseImplements {
@@ -20,7 +22,7 @@ class Alipay extends BaseImplements {
             // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
             const currentPath = self.getCurrentPath();
             const { title } = arguments[0] || {};
-            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+            self.growingIO.dataStore.eventHooks.currentPage.configuredTitle[
               currentPath
             ] = title;
           }
@@ -53,6 +55,44 @@ class Alipay extends BaseImplements {
   removeStorageSync = (key: string) => {
     this.minip?.removeStorageSync({ key });
   };
+
+  // 支付宝和mpass单独处理
+  request = ({
+    url,
+    data,
+    header,
+    timeout,
+    method,
+    success,
+    fail,
+    complete
+  }) => {
+    const requestTask = this.minip?.request({
+      url,
+      data,
+      // 支付宝小程序里叫headers
+      headers: header,
+      timeout,
+      method,
+      success,
+      fail,
+      complete
+    });
+    const myVersion = this.minip.SDKVersion;
+    // 支付宝小程序2.0.0版本及以上才超时中断请求
+    // https://github.com/growingio/growingio-sdk-miniprogram-autotracker/issues/3
+    if (compareVersion(myVersion, '2.0.0') >= 0) {
+      // 设置超时中断请求
+      let t = setTimeout(() => {
+        if (requestTask?.abort && isFunction(requestTask?.abort)) {
+          requestTask?.abort();
+        }
+        clearTimeout(t);
+        t = null;
+      }, (timeout || 10000) + 10);
+    }
+    return requestTask;
+  };
 }
 
 export default Alipay;

package/src/minipInstance/quickapp.ts

@@ -1,6 +1,6 @@
 import { GrowingIOType } from '@@/types/growingIO';
 import { isString, last } from '@@/utils/glodash';
-import { limitString } from '@@/utils/tools';
+import { limitString, niceTry } from '@@/utils/tools';
 import { SystemInfo } from '@@/types/minipInstance';
 import app from '@system.app';
 import BaseImplements from './base';
@@ -97,16 +97,22 @@ class QuickApp extends BaseImplements {
    */
   // 获取当前页面栈
   getCurrentPage = () => {
-    if (router?.getPages) {
-      return last(router?.getPages());
-    }
+    niceTry(() => {
+      if (router?.getPages) {
+        return last(router?.getPages()) || {};
+      }
+    });
     return {};
   };
 
   // 获取当前页面路由
   getCurrentPath = () => {
-    const route = router?.getState();
-    return route?.path;
+    niceTry(() => {
+      if (router?.getState) {
+        return router?.getState()?.path || '';
+      }
+    });
+    return '';
   };
 
   // 获取页面标题(除wx以外其他平台)

package/src/minipInstance/tb.ts

@@ -20,7 +20,7 @@ class Taobao extends BaseImplements {
             // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
             const currentPath = self.getCurrentPath();
             const { title } = arguments[0] || {};
-            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+            self.growingIO.dataStore.eventHooks.currentPage.configuredTitle[
               currentPath
             ] = title;
           }

package/src/plugins/gioABTest.ts

@@ -11,7 +11,8 @@ import {
   isString,
   keys,
   startsWith,
-  toString
+  toString,
+  unset
 } from '@@/utils/glodash';
 import {
   consoleText,
@@ -148,15 +149,15 @@ class GioABTest {
         `${this.getHashKey(trackingId, layerId)}_gdp_abt_sign`
       ) || 0;
     // 没有超时尝试取数据
-    const abtData =
+    const expData =
       minipInstance.getStorageSync(
         `${this.getHashKey(trackingId, layerId)}_gdp_abtd`
       ) || {};
     // 没有有效数据或者接口请求标记超时则从调用分流服务获取数据
     if (!abtSign || abtSign < Date.now()) {
-      this.initiateRequest(trackingId, layerId, abtData, callback);
+      this.initiateRequest(trackingId, layerId, expData, callback);
     } else {
-      niceCallback(callback, abtData);
+      niceCallback(callback, expData);
     }
   };
 
@@ -234,49 +235,58 @@ class GioABTest {
     originData: any,
     callback: any
   ) => {
-    const { layerId, strategyId, experimentId, variables } = responseData;
-    const abtDataKey = `${this.getHashKey(trackingId, layerId)}_gdp_abtd`;
-    const abtData = {
+    const {
+      layerId,
+      strategyId,
+      experimentId,
+      layerName,
+      experimentName,
+      strategyName,
+      variables
+    } = responseData;
+    const expDataKey = `${this.getHashKey(trackingId, layerId)}_gdp_abtd`;
+    // 从接口取回来的用于hash比较的数据对象
+    const comparisonData = {
       layerId: toString(layerId),
       strategyId: toString(strategyId),
       experimentId: toString(experimentId),
       variables
     };
-    const comparisonValue = hashCode(JSON.stringify(abtData));
-    const controlValue = hashCode(JSON.stringify(originData));
+    // 从本地存储中取回来的用于hash比较的数据对象
+    const controlData = { ...originData };
+    unset(controlData, ['layerName', 'strategyName', 'experimentName']);
+    const comparisonValue = hashCode(JSON.stringify(comparisonData));
+    const controlValue = hashCode(JSON.stringify(controlData));
+    // 需要传给下一步和存储的数据对象
+    const expData = {
+      ...comparisonData,
+      layerName,
+      strategyName,
+      experimentName
+    };
+    // 存储实验数据(无需经过hash对比判断直接复写存储，防止只改了名称)
+    this.growingIO.minipInstance.setStorageSync(
+      expDataKey,
+      expData,
+      new Date(
+        new Date().getFullYear(),
+        new Date().getMonth(),
+        new Date().getDate() + 1
+      ).getTime()
+    );
     // 本地实验和请求回来的实验直接做整体hash数据对比
     if (comparisonValue !== controlValue) {
-      // 存储实验数据
-      this.growingIO.minipInstance.setStorageSync(
-        abtDataKey,
-        abtData,
-        new Date(
-          new Date().getFullYear(),
-          new Date().getMonth(),
-          new Date().getDate() + 1
-        ).getTime()
-      );
       // 数据不一致重新发命中埋点
       if (strategyId && experimentId) {
-        this.buildExperimentHitEvent(
-          trackingId,
-          toString(layerId),
-          toString(experimentId),
-          toString(strategyId)
-        );
+        this.buildExperimentHitEvent(trackingId, expData);
       }
     }
     // 回调调用
-    niceCallback(callback, abtData);
+    niceCallback(callback, expData);
   };
 
   // 构建实验命中事件
-  buildExperimentHitEvent = (
-    trackingId: string,
-    layerId: string,
-    experimentId: string,
-    strategyId: string
-  ) => {
+  buildExperimentHitEvent = (trackingId: string, expData: any) => {
     const {
       dataStore: { eventContextBuilder, eventConverter }
     } = this.growingIO;
@@ -285,11 +295,22 @@ class GioABTest {
       eventName: '$exp_hit',
       ...eventContextBuilder(trackingId)
     };
+    const {
+      layerId,
+      experimentId,
+      strategyId,
+      layerName,
+      experimentName,
+      strategyName
+    } = expData;
     event.attributes = limitObject({
       ...(event.attributes ?? {}),
       $exp_layer_id: layerId,
       $exp_id: experimentId,
-      $exp_strategy_id: strategyId
+      $exp_strategy_id: strategyId,
+      $exp_layer_name: layerName,
+      $exp_name: experimentName,
+      $exp_strategy_name: strategyName
     });
     eventConverter(event);
   };

package/src/plugins/gioImpressionTracking.ts

@@ -113,7 +113,7 @@ class GioImpressionTracking {
   };
 
   // 获取到可监听节点后校验节点信息
-  rectobserve = (rect, collectTarget, optionKey) => {
+  rectObserve = (rect, collectTarget, optionKey) => {
     const { gioPlatform } = this.growingIO;
     if (
       (gioPlatform === 'tt' && collectTarget.__nodeId__) ||
@@ -146,7 +146,7 @@ class GioImpressionTracking {
         this.rects[page.route] = {};
       }
       this.rects[page.route][nodeId] = rect;
-      this.creatObserver(collectTarget, optionKey);
+      this.createObserver(collectTarget, optionKey);
     }
   };
 
@@ -166,7 +166,7 @@ class GioImpressionTracking {
         .boundingClientRect(([rect = []]) => {
           rect = ut.isArray(rect) ? rect : [rect];
           if (!isEmpty(rect)) {
-            this.rectobserve(rect, collectTarget, optionKey);
+            this.rectObserve(rect, collectTarget, optionKey);
           }
         });
       query.exec();
@@ -174,20 +174,22 @@ class GioImpressionTracking {
       query.selectAll('.growing_collect_imp').boundingClientRect();
       query.exec(([rect]) => {
         if (!isEmpty(rect)) {
-          this.rectobserve(rect, collectTarget, optionKey);
+          this.rectObserve(rect, collectTarget, optionKey);
         }
       });
     }
   };
 
   // 创建监听
-  creatObserver = (
+  createObserver = (
     collectTarget: any,
     optionKey: 'observeAll' | 'selectAll'
   ) => {
-    const { gioPlatform, minipInstance } = this.growingIO;
+    const { gioPlatform, minipInstance, vdsConfig } = this.growingIO;
     // 初始化监听对象
-    const observerOption = { [optionKey]: true };
+    // 数值要大于0，只能无限趋近于0，等于0的时候会导致没出现就会发曝光
+    const threshold = vdsConfig.impressionScale || 0.0000000000001;
+    const observerOption = { thresholds: [threshold], [optionKey]: true };
     if (
       ['tb', 'my'].includes(gioPlatform) &&
       ut.compareVersion(my.SDKVersion, '2.7.0') >= -1
@@ -221,7 +223,7 @@ class GioImpressionTracking {
         )
       : collectTarget.createIntersectionObserver(observerOption);
     observer = observer.relativeToViewport();
-    // 不管原先是否创建过，直接覆盖（obeserverId会更新）
+    // 不管原先是否创建过，直接覆盖（observerId会更新）
     this.observerIds[page.route][nodeId] = observer;
     // 添加监听回调
     this.targetObserve(observer, page);
@@ -229,10 +231,12 @@ class GioImpressionTracking {
 
   // 给目标节点添加监听回调
   targetObserve = (observerTarget: any, collectPage: any) => {
-    const { taro } = this.growingIO.vdsConfig;
+    const { taro, impressionScale } = this.growingIO.vdsConfig;
+    // 数值要大于0，只能无限趋近于0，等于0的时候会导致没出现就会发曝光
+    const threshold = impressionScale || 0.0000000000001;
     // 监听节点变化
     observerTarget.observe('.growing_collect_imp', (result: any) => {
-      if (!ut.isEmpty(result) && result.intersectionRatio > 0) {
+      if (!ut.isEmpty(result) && result.intersectionRatio >= threshold) {
         let dataset: any = result.dataset;
         if (taro && ut.isTaro3(taro)) {
           dataset = this.getTaro3Dataset(collectPage.route, result.id);

package/src/plugins/gioMultipleInstances.ts

@@ -82,10 +82,12 @@ export class GioMultipleInstances {
           'autotrack',
           'debug',
           'forceLogin',
+          'impressionScale',
           'keepAlive',
           'originalSource',
           'performance',
           'pluginMode',
+          'sessionExpires',
           'taro',
           'taroVue',
           'tbConfig',

package/src/types/base.ts

@@ -29,6 +29,8 @@ export interface UserOptions {
   forceLogin: boolean;
   // 或略上报字段
   ignoreFields: string[];
+  // 曝光比例
+  impressionScale: number;
   // 是否使用原始来源信息作为访问事件的参数上报
   originalSource: boolean;
   // session保活时长（5分钟）
@@ -39,6 +41,8 @@ export interface UserOptions {
   requestTimeout?: number;
   // 数据上报域名
   serverUrl?: string;
+  // session超时时长
+  sessionExpires?: number;
   // taro框架实例
   taro?: any;
   // taro框架vue实例

package/src/types/eventHooks.ts

@@ -77,12 +77,13 @@ export interface PageShareResult {
 
 export interface MinipPageType {
   queryOption: any;
-  settedTitle: any;
+  configuredTitle: any;
   pageProps: any;
   lastLifecycle: string;
   currentLifecycle: string;
+  lifeBeforeShow: boolean;
   getPagePath: () => string;
-  getPageQeury: () => string;
+  getPageQuery: () => string;
   getPageTitle: (trackingId?: string) => string;
   qsQuery: (query: any) => string;
   getReferralPage: (trackingId: string) => string;

package/src/types/userStore.ts

@@ -7,6 +7,8 @@ export interface UserStoreType {
   getSessionId: (trackingId: string) => string;
   // 设置sessionId
   setSessionId: (trackingId: string, id?: string) => void;
+  // session超时时刻
+  _sessionExpires: number;
   // 获取userId
   getUserId: (trackingId: string) => string;
   // 设置userId