gio-miniprogram-sdk 4.2.0 → 4.3.1

package/src/minipInstance/my.ts

@@ -20,7 +20,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;
           }
@@ -48,6 +48,11 @@ class Alipay extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Alipay;

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;
           }
@@ -48,6 +48,11 @@ class Taobao extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Taobao;

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

@@ -76,16 +76,16 @@ export interface PageShareResult {
 }
 
 export interface MinipPageType {
-  path: string;
-  time: number;
-  query: any;
-  settedTitle: any;
-  title: string;
+  queryOption: any;
+  configuredTitle: any;
   pageProps: any;
   lastLifecycle: string;
   currentLifecycle: string;
-  parsePage: (page: any, query: any) => void;
-  getQuery: (query: any) => string;
+  lifeBeforeShow: boolean;
+  getPagePath: () => string;
+  getPageQuery: () => string;
+  getPageTitle: (trackingId?: string) => string;
+  qsQuery: (query: any) => string;
   getReferralPage: (trackingId: string) => string;
   buildShareQuery: (result: PageShareResult) => [string, string];
   updateAppMessageResult: (result: PageShareResult) => PageShareResult;
@@ -110,8 +110,7 @@ export interface EventHooksType {
   supLifeFcs: (target: any, type: 'app' | 'page') => void;
   // 对象的遍历
   objectTraverse: (target: any, fn: any) => any;
-  // 初始化无埋点
-  initEventHooks: () => void;
+
   // 生命周期方法effects
   lifeFcEffects: (eventName: string, method: any, cType: 'App' | 'Page') => any;
   // 自定义方法effects
@@ -140,4 +139,8 @@ export interface EventHooksType {
   growingBehavior: (behavior: any) => any;
   // 对原生的重写方法
   nativeGrowing: (designated?: string[]) => void;
+  // 初始化原始值
+  initOriginalValue: () => void;
+  // 初始化事件钩子
+  initEventHooks: () => void;
 }

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

package/src/utils/tools.ts

@@ -16,6 +16,7 @@ import {
   split,
   startsWith,
   toString,
+  typeOf,
   unset
 } from '@@/utils/glodash';
 
@@ -239,11 +240,15 @@ export const getPlainConfig = (platform?: string) => {
       case 'swan':
         return appConfig;
       case 'tt':
-        return __ttConfig;
+        return (
+          niceTry(() => __ttConfig) ||
+          global?.TMAConfig ||
+          globalThis?.TMAConfig
+        ); // 可能会拿不到
       case 'qq':
         return __qqConfig;
       case 'ks':
-        return __ksConfig;
+        return __ksConfig; // 新版快手小程序已经拿不到了
       case 'jd':
         return __jdConfig;
       // 第三方框架下自动获取实例
@@ -296,7 +301,10 @@ export const getAppInst = () => {
 };
 
 export const getGlobal = () => {
-  return niceTry(() => $global) ?? global;
+  return (
+    niceTry(() => niceTry(() => niceTry(() => $global) ?? global) ?? window) ??
+    globalThis
+  );
 };
 
 // Object参数限制
@@ -407,3 +415,14 @@ export const hashCode = (string: string, abs = false) => {
   }
   return abs ? Math.abs(hash) : hash;
 };
+
+// 获取额外的启动参数并合并进query
+export const getLaunchQuery = (originQuery: any = {}, extraData: any = {}) => {
+  const validData = {};
+  keys(extraData).forEach((k: string) => {
+    if (['string', 'number', 'boolean'].includes(typeOf(extraData[k]))) {
+      validData[k] = extraData[k];
+    }
+  });
+  return Object.assign({}, validData, originQuery);
+};