gio-miniprogram-sdk 4.0.0 → 4.1.0

package/src/{pluginsOut/ordinary → plugins}/gioABTest.ts

@@ -7,10 +7,15 @@ import {
   isEmpty,
   isNaN,
   isNumber,
+  isObject,
+  isString,
+  keys,
   startsWith,
   toString
 } from '@@/utils/glodash';
 import { consoleText, hashCode, niceCallback } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
+import { ABTEST_DATA_REG, ABTEST_SIGN_REG } from '@@/constants/regex';
 
 class GioABTest {
   // 请求间隔时长
@@ -18,18 +23,29 @@ class GioABTest {
   // 请求超时时长
   public requestTimeout: number;
   // 分流服务请求地址
-  public url: string;
+  public url: any;
   // 接口重试计数
   public retryCount: number;
   constructor(public growingIO: GrowingIOType, options: any) {
-    const { abServerUrl, requestInterval, requestTimeout } = options ?? {};
+    const {
+      abServerUrl = 'https://ab.growingio.com',
+      requestInterval,
+      requestTimeout
+    } = options ?? {};
     this.timeoutCheck(requestInterval, requestTimeout);
     const { emitter } = this.growingIO;
     this.growingIO.getABTest = this.getABTest;
-    emitter.on('OPTION_INITIALIZED', () => {
-      if (abServerUrl) {
+    emitter.on(EMIT_MSG.OPTION_INITIALIZED, () => {
+      if (!isEmpty(abServerUrl)) {
         this.abtStorageCheck();
-        this.generateUrl(abServerUrl);
+        this.url = {};
+        if (isString(abServerUrl)) {
+          this.generateUrl(this.growingIO.trackingId, abServerUrl);
+        } else if (isObject(abServerUrl)) {
+          keys(abServerUrl).forEach((trackingId: string) => {
+            this.generateUrl(trackingId, abServerUrl[trackingId]);
+          });
+        }
       } else {
         consoleText(
           '如果您需要使用ABTest功能，请配置服务地址 abServerUrl!',
@@ -47,16 +63,16 @@ class GioABTest {
   ) => {
     this.requestInterval =
       isNumber(Number(requestInterval)) &&
-      !isNaN(Number.parseInt(requestInterval as string, 10))
-        ? Number.parseInt(requestInterval as string, 10)
+      !isNaN(Number(requestInterval as string))
+        ? Number(requestInterval as string)
         : 5;
     if (this.requestInterval > 60 * 24 || this.requestInterval < 0) {
       this.requestInterval = 5;
     }
     this.requestTimeout =
       isNumber(Number(requestTimeout)) &&
-      !isNaN(Number.parseInt(requestTimeout as string, 10))
-        ? Number.parseInt(requestTimeout as string, 10)
+      !isNaN(Number(requestTimeout as string))
+        ? Number(requestTimeout as string)
         : 1000;
     if (this.requestTimeout > 5000 || this.requestTimeout < 100) {
       this.requestTimeout = 1000;
@@ -68,7 +84,7 @@ class GioABTest {
     const { minipInstance }: any = this.growingIO;
     const storageKeys = minipInstance.minip?.getStorageInfoSync().keys || [];
     // 请求标记
-    const abtsKeys = storageKeys.filter((k) => /^\d+_gdp_abt_sign$/.test(k));
+    const abtsKeys = storageKeys.filter((k) => ABTEST_SIGN_REG.test(k));
     abtsKeys.forEach((k) => {
       // 移除过期的数据，防止存储超限
       const sign = minipInstance.getStorageSync(k);
@@ -77,7 +93,7 @@ class GioABTest {
       }
     });
     // abtest数据
-    const abtdKeys = storageKeys.filter((k) => /^\d+_gdp_abtd$/.test(k));
+    const abtdKeys = storageKeys.filter((k) => ABTEST_DATA_REG.test(k));
     abtdKeys.forEach((k) => {
       // 移除过期的数据，防止存储超限
       if (isEmpty(minipInstance.getStorageSync(k))) {
@@ -87,28 +103,31 @@ class GioABTest {
   };
 
   // 生成存储的hash key
-  getHashKey = (layerId: string | number) => {
+  getHashKey = (trackingId: string, layerId: string | number) => {
     const {
-      userStore: { uid },
+      userStore: { getUid },
       vdsConfig: { projectId }
     } = this.growingIO;
-    return Math.abs(hashCode(`${projectId}#${uid}#${layerId}`));
+    return hashCode(`${trackingId}#${projectId}#${getUid()}#${layerId}`, true);
   };
 
   // 生成数据接口地址
-  generateUrl = (abServerUrl: string) => {
+  generateUrl = (trackingId: string, abServerUrl: string) => {
     if (!startsWith(abServerUrl, 'http')) {
-      this.url = `https://${abServerUrl}/diversion/specified-layer-variables`;
+      this.url[
+        trackingId
+      ] = `https://${abServerUrl}/diversion/specified-layer-variables`;
     } else {
-      this.url = `${abServerUrl}/diversion/specified-layer-variables`;
+      this.url[
+        trackingId
+      ] = `${abServerUrl}/diversion/specified-layer-variables`;
     }
   };
 
   // 获取实验调用
-  getABTest = (layerId: string | number, callback: any) => {
-    if (!this.url) {
-      niceCallback(callback, {});
-      return;
+  getABTest = (trackingId: string, layerId: string | number, callback: any) => {
+    if (isEmpty(this.url[trackingId])) {
+      this.generateUrl(trackingId, 'https://ab.growingio.com');
     }
     if (!layerId) {
       consoleText('获取ABTest数据失败! 实验层Id不合法!', 'error');
@@ -119,15 +138,16 @@ class GioABTest {
     // 接口调用的超时时间
     const abtSign =
       minipInstance.getStorageSync(
-        `${this.getHashKey(layerId)}_gdp_abt_sign`
+        `${this.getHashKey(trackingId, layerId)}_gdp_abt_sign`
       ) || 0;
     // 没有超时尝试取数据
     const abtData =
-      minipInstance.getStorageSync(`${this.getHashKey(layerId)}_gdp_abtd`) ||
-      {};
+      minipInstance.getStorageSync(
+        `${this.getHashKey(trackingId, layerId)}_gdp_abtd`
+      ) || {};
     // 没有有效数据或者接口请求标记超时则从调用分流服务获取数据
     if (!abtSign || abtSign < Date.now()) {
-      this.initiateRequest(layerId, abtData, callback);
+      this.initiateRequest(trackingId, layerId, abtData, callback);
     } else {
       niceCallback(callback, abtData);
     }
@@ -135,30 +155,36 @@ class GioABTest {
 
   // 发起请求
   initiateRequest = (
+    trackingId: string,
     layerId: string | number,
     originData: any,
     callback: any
   ) => {
     const {
-      userStore: { uid },
-      vdsConfig: { projectId, dataSourceId },
+      userStore: { getUid },
+      dataStore,
       minipInstance
     } = this.growingIO;
-
+    const { projectId, dataSourceId } = dataStore.getTrackerVds(trackingId);
     minipInstance.request({
-      url: this.url,
+      url: this.url[trackingId],
       header: { 'Content-Type': 'application/x-www-form-urlencoded' },
       method: 'POST',
       data: {
         accountId: projectId,
         datasourceId: dataSourceId,
-        distinctId: uid,
+        distinctId: getUid(),
         layerId
       },
       timeout: this.requestTimeout,
       success: ({ data }: any) => {
         if (data.code === 0) {
-          this.experimentVerify({ ...data, layerId }, originData, callback);
+          this.experimentVerify(
+            trackingId,
+            { ...data, layerId },
+            originData,
+            callback
+          );
         } else {
           consoleText(`获取ABTest数据失败! ${data.errorMsg}!`, 'error');
           // 接口业务失败返回false信息
@@ -166,7 +192,7 @@ class GioABTest {
         }
         // 接口调用返回后刷新接口调用标记
         minipInstance.setStorageSync(
-          `${this.getHashKey(layerId)}_gdp_abt_sign`,
+          `${this.getHashKey(trackingId, layerId)}_gdp_abt_sign`,
           Date.now() + 1000 * 60 * this.requestInterval
         );
       },
@@ -179,7 +205,7 @@ class GioABTest {
         } else {
           // 其他失败情况重试
           if (this.retryCount < 2) {
-            this.initiateRequest(layerId, originData, callback);
+            this.initiateRequest(trackingId, layerId, originData, callback);
             this.retryCount += 1;
           } else {
             consoleText(
@@ -195,9 +221,14 @@ class GioABTest {
   };
 
   // 实验校验（决定是否上报命中事件）
-  experimentVerify = (responseData: any, originData: any, callback: any) => {
+  experimentVerify = (
+    trackingId: string,
+    responseData: any,
+    originData: any,
+    callback: any
+  ) => {
     const { layerId, strategyId, experimentId, variables } = responseData;
-    const abtDataKey = `${this.getHashKey(layerId)}_gdp_abtd`;
+    const abtDataKey = `${this.getHashKey(trackingId, layerId)}_gdp_abtd`;
     const abtData = {
       layerId: toString(layerId),
       strategyId: toString(strategyId),
@@ -221,6 +252,7 @@ class GioABTest {
       // 数据不一致重新发命中埋点
       if (strategyId && experimentId) {
         this.buildExperimentHitEvent(
+          trackingId,
           toString(layerId),
           toString(experimentId),
           toString(strategyId)
@@ -232,7 +264,12 @@ class GioABTest {
   };
 
   // 构建实验命中事件
-  buildExperimentHitEvent = (layerId, experimentId, strategyId) => {
+  buildExperimentHitEvent = (
+    trackingId: string,
+    layerId: string,
+    experimentId: string,
+    strategyId: string
+  ) => {
     const {
       dataStore: { eventContextBuilder, eventConverter }
     } = this.growingIO;
@@ -244,7 +281,7 @@ class GioABTest {
         $exp_id: experimentId,
         $exp_strategy_id: strategyId
       },
-      ...eventContextBuilder(),
+      ...eventContextBuilder(trackingId),
       customEventType: 0
     };
     eventConverter(event);

package/src/{pluginsOut/ordinary → plugins}/gioEventAutoTracking.ts

@@ -2,9 +2,11 @@
  * 名称：无埋点插件
  * 用途：用于提供无埋点的事件构建方法。
  */
+import { ID_REG, SWAN_XID_REG, TARO_XID_REG } from '@@/constants/regex';
 import { EventTarget } from '@@/types/eventHooks';
 import { GrowingIOType } from '@@/types/growingIO';
 import { consoleText, isTaro3 } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioEventAutoTracking {
@@ -15,8 +17,13 @@ class GioEventAutoTracking {
   }
 
   main = (e: EventTarget, eventName: string) => {
-    const { vdsConfig, platformConfig, plugins, emitter }: GrowingIOType =
-      this.growingIO;
+    const {
+      vdsConfig,
+      platformConfig,
+      plugins,
+      emitter,
+      trackingId
+    }: GrowingIOType = this.growingIO;
     if (
       // 无埋点事件拦截
       !vdsConfig.autotrack ||
@@ -49,15 +56,15 @@ class GioEventAutoTracking {
       console.log('Action：', e.type, Date.now());
     }
     // 向其他插件广播事件
-    emitter.emit('onComposeBefore', {
+    emitter.emit(EMIT_MSG.ON_COMPOSE_BEFORE, {
       event: eventName,
       params: e ?? {}
     });
     const actionListeners = platformConfig.listeners.actions;
     if (actionListeners.click.includes(e.type)) {
-      this.buildClickEvent(e, eventName);
+      this.buildClickEvent(trackingId, e, eventName);
     } else if (actionListeners.change.includes(e.type)) {
-      this.buildChangeEvent(e, eventName);
+      this.buildChangeEvent(trackingId, e, eventName);
     }
   };
 
@@ -68,8 +75,8 @@ class GioEventAutoTracking {
     let id = target.id;
     if (
       !id ||
-      (gioPlatform === 'swan' && /^_[0-9a-f]+/.test(id)) ||
-      (isTaro3(vdsConfig.taro) && /^_n_[0-9]+$/.test(id))
+      (gioPlatform === 'swan' && SWAN_XID_REG.test(id)) ||
+      (isTaro3(vdsConfig.taro) && TARO_XID_REG.test(id))
     ) {
       id = '';
     }
@@ -77,7 +84,7 @@ class GioEventAutoTracking {
   };
 
   // 构建点击事件
-  buildClickEvent = (e: EventTarget, eventName: string) => {
+  buildClickEvent = (trackingId: string, e: EventTarget, eventName: string) => {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
@@ -87,11 +94,7 @@ class GioEventAutoTracking {
       let idx;
       if (ut.has(target?.dataset, 'index') && target?.dataset?.index !== '') {
         const index: any = ut.toString(target.dataset.index);
-        if (
-          /^\d{1,10}$/.test(index) &&
-          index - 0 > 0 &&
-          index - 0 < 2147483647
-        ) {
+        if (ID_REG.test(index) && index - 0 > 0 && index - 0 < 2147483647) {
           idx = +index;
         } else {
           consoleText(
@@ -110,14 +113,14 @@ class GioEventAutoTracking {
             hyperlink: target?.dataset?.src
           }
         ],
-        ...eventContextBuilder()
+        ...eventContextBuilder(trackingId)
       };
       eventInterceptor(event);
     }
   };
 
   // 构建tab菜单点击事件
-  buildTabClickEvent = (tabItem: any) => {
+  buildTabClickEvent = (trackingId: string, tabItem: any) => {
     const {
       dataStore: { eventContextBuilder, eventInterceptor }
     } = this.growingIO;
@@ -131,13 +134,17 @@ class GioEventAutoTracking {
           hyperlink: ut.toString(tabItem.pagePath)
         }
       ],
-      ...eventContextBuilder()
+      ...eventContextBuilder(trackingId)
     };
     eventInterceptor(event);
   };
 
   // 构建表单变化事件
-  buildChangeEvent = (e: EventTarget, eventName: string) => {
+  buildChangeEvent = (
+    trackingId: string,
+    e: EventTarget,
+    eventName: string
+  ) => {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
@@ -147,7 +154,7 @@ class GioEventAutoTracking {
       const event = {
         eventType: 'VIEW_CHANGE',
         element: { xpath },
-        ...eventContextBuilder()
+        ...eventContextBuilder(trackingId)
       };
       const ev = ut.get(e, 'detail.value') || ut.get(e, 'target.attr.value');
       if (target?.dataset?.growingTrack || target?.dataset?.growingtrack) {

package/src/{pluginsOut/ordinary → plugins}/gioImpressionTracking.ts

@@ -2,9 +2,18 @@
  * 名称：半自动浏览埋点插件
  * 用途：用于提供半自动浏览埋点事件的自动注册、参数检验构建和创建事件方法。
  */
+import { IMP_DATA_REG } from '@@/constants/regex';
 import { GrowingIOType } from '@@/types/growingIO';
-import { isEqualArray } from '@@/utils/glodash';
-import { hashCode } from '@@/utils/tools';
+import {
+  compact,
+  isArray,
+  isEmpty,
+  isEqualArray,
+  isString,
+  toString
+} from '@@/utils/glodash';
+import { eventNameValidate, hashCode, niceTry } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioImpressionTracking {
@@ -27,7 +36,7 @@ class GioImpressionTracking {
       }
       minipInstance.initImpression(collect);
     };
-    emitter.on('minipLifecycle', ({ event, params }) => {
+    emitter.on(EMIT_MSG.MINIP_LIFECYCLE, ({ event, params }) => {
       const { minipInstance } = this.growingIO;
       if (event === 'Page onShowEnd') {
         const page = minipInstance.getCurrentPage();
@@ -68,13 +77,48 @@ class GioImpressionTracking {
     return isEqualArray(controlGroup, comparisonGroup);
   };
 
+  // 获取nodeId
+  getNodeId = (collectTarget: any) => {
+    const { gioPlatform } = this.growingIO;
+    switch (gioPlatform) {
+      case 'wx':
+      case 'qq':
+      case 'ks':
+      case 'jd':
+        return collectTarget.__wxExparserNodeId__; // wx page/component
+      case 'my':
+      case 'tb':
+        return collectTarget.$page
+          ? `${collectTarget.$page.$id}-${collectTarget.$id}` //my component
+          : collectTarget.$id; // my page
+      case 'swan':
+        return collectTarget.route
+          ? toString(hashCode(collectTarget.route)) // swan page
+          : collectTarget.nodeId; // swan component
+      case 'tt':
+        return collectTarget.route
+          ? toString(hashCode(collectTarget.route)) // swan page
+          : collectTarget.__nodeId__; // swan component
+      default:
+        break;
+    }
+  };
+
   // 获取到可监听节点后校验节点信息
   rectobserve = (rect, collectTarget, optionKey) => {
-    const nodeId = collectTarget.__wxExparserNodeId__;
+    const { gioPlatform } = this.growingIO;
+    if (
+      (gioPlatform === 'tt' && collectTarget.__nodeId__) ||
+      (gioPlatform === 'ks' && collectTarget.is)
+    ) {
+      // 字节和快手小程序页面监听时可以拿到自定义组件一次性完成监听，所以组件的节点实例不再处理
+      return false;
+    }
+    const nodeId = this.getNodeId(collectTarget);
     const page = collectTarget.route
       ? collectTarget
       : this.growingIO.minipInstance.getCurrentPage();
-    // 监听的节点和上一次的不一致，或者监听的组件或页面的监听已经被注销时，可以继续生成新的监听
+    // 监听的目标页面和上一次的不一致，或者监听的组件或页面的监听已经被注销时，可以继续生成新的监听
     let observerNeedNew = false;
     if (page.route) {
       const isEqualRects = this.isEqualRects(rect, page.route, nodeId);
@@ -109,15 +153,21 @@ class GioImpressionTracking {
           ?.createSelectorQuery()
           .in(collectTarget);
     if (['ks', 'qq'].includes(gioPlatform)) {
-      query.selectAll('.growing_collect_imp').boundingClientRect(([rect]) => {
-        rect = ut.isNil(rect) || ut.isArray(rect) ? rect : [rect];
-        this.rectobserve(rect, collectTarget, optionKey);
-      });
+      query
+        .selectAll('.growing_collect_imp')
+        .boundingClientRect(([rect = []]) => {
+          rect = ut.isArray(rect) ? rect : [rect];
+          if (!isEmpty(rect)) {
+            this.rectobserve(rect, collectTarget, optionKey);
+          }
+        });
       query.exec();
     } else {
       query.selectAll('.growing_collect_imp').boundingClientRect();
       query.exec(([rect]) => {
-        this.rectobserve(rect, collectTarget, optionKey);
+        if (!isEmpty(rect)) {
+          this.rectobserve(rect, collectTarget, optionKey);
+        }
       });
     }
   };
@@ -136,8 +186,7 @@ class GioImpressionTracking {
     ) {
       observerOption.dataset = true;
     }
-
-    const nodeId = collectTarget.__wxExparserNodeId__;
+    const nodeId = this.getNodeId(collectTarget);
     let page = collectTarget;
     // uniapp是组件和页面一体，所以要分两次尝试监听；原生是组件和页面互相独立，按类型监听
     // 自定义组件是不能直接在页面上被拿到，所以直接监听页面不会监听到自定义组件
@@ -148,7 +197,6 @@ class GioImpressionTracking {
     ) {
       page = minipInstance.getCurrentPage();
     }
-
     if (!this.observerIds[page.route]) {
       this.observerIds[page.route] = {};
     }
@@ -158,13 +206,12 @@ class GioImpressionTracking {
       originObserver.disconnect();
     }
     // 创建一个新的监听
-    let observer =
-      gioPlatform === 'jd'
-        ? minipInstance.minip?.createIntersectionObserver(
-            collectTarget,
-            observerOption
-          )
-        : collectTarget.createIntersectionObserver(observerOption);
+    let observer = ['swan', 'jd'].includes(gioPlatform)
+      ? minipInstance.minip?.createIntersectionObserver(
+          collectTarget,
+          observerOption
+        )
+      : collectTarget.createIntersectionObserver(observerOption);
     observer = observer.relativeToViewport();
     // 不管原先是否创建过，直接覆盖（obeserverId会更新）
     this.observerIds[page.route][nodeId] = observer;
@@ -192,9 +239,28 @@ class GioImpressionTracking {
             this.sentImps[sentId] = dataProperties;
           }
         }
-        if (dataProperties.eventId) {
-          // 要直接构建custom事件，不要去调用埋点插件的方法，万一插件没有加载就发不出去了
-          this.buildImpEvent(dataProperties);
+        if (dataProperties.eventName) {
+          let sendTargets = [];
+          if (dataset.gioImpSendto) {
+            // 先尝试处理成数组
+            sendTargets = compact(
+              isArray(dataset.gioImpSendto)
+                ? dataset.gioImpSendto
+                : niceTry(() => JSON.parse(dataset.gioImpSendto)) || []
+            );
+            // 在尝试处理字符串
+            if (isEmpty(sendTargets)) {
+              niceTry(() =>
+                dataset.gioImpSendto.split(',').forEach((s: string) => {
+                  s = isString(s) && s.trim().replace('[', '').replace(']', '');
+                  if (s) {
+                    sendTargets.push(s);
+                  }
+                })
+              );
+            }
+          }
+          this.buildImpEvent(dataProperties, sendTargets);
         } else {
           ut.consoleText(
             '曝光事件格式不正确，事件名只能包含数字、字母和下划线，且不以数字开头!',
@@ -208,13 +274,13 @@ class GioImpressionTracking {
   // 曝光参数获取
   getImpressionProperties = (dataSet: any) => {
     let data: any = {
-      eventId: undefined,
+      eventName: undefined,
       properties: {}
     };
     if (!dataSet?.gioImpTrack) {
       return data;
     } else {
-      data.eventId = dataSet.gioImpTrack;
+      data.eventName = dataSet.gioImpTrack;
     }
     if (ut.has(dataSet, 'gioImpAttrs')) {
       // imp写法二
@@ -225,10 +291,9 @@ class GioImpressionTracking {
       );
     } else {
       // imp写法一
-      const propReg = /^gioTrack(.+)/;
       for (const key in dataSet) {
         let normKey;
-        const matchArr = key.match(propReg);
+        const matchArr = key.match(IMP_DATA_REG);
         if (matchArr) {
           normKey = ut.lowerFirst(matchArr[1]);
           if (normKey !== 'track') {
@@ -239,13 +304,12 @@ class GioImpressionTracking {
     }
     // 对参数对象进行限制
     data.properties = ut.limitObject(data.properties);
-    // 校验eventId
-    const eventIdReg = /^\w+$/;
-    if (
-      !eventIdReg.test(data.eventId) ||
-      Number.isInteger(Number.parseInt(ut.head(data.eventId.split('')), 10))
-    ) {
-      data.eventId = null;
+    // 校验eventName
+    const validate = eventNameValidate(data.eventName, () => {
+      return data;
+    });
+    if (!validate) {
+      data.eventName = null;
       data = {};
     }
     return data;
@@ -279,19 +343,23 @@ class GioImpressionTracking {
   };
 
   // 创建半自动曝光事件
-  buildImpEvent = (dataProperties: any) => {
-    const { eventId, properties } = dataProperties;
+  buildImpEvent = (dataProperties: any, sendTargets: string[]) => {
+    const { eventName, properties } = dataProperties;
     const {
-      dataStore: { eventContextBuilder, eventInterceptor }
+      trackingId,
+      dataStore: { eventContextBuilder, eventConverter },
+      plugins
     } = this.growingIO;
     const event = {
       eventType: 'CUSTOM',
-      eventName: eventId,
+      eventName,
       attributes: properties,
-      ...eventContextBuilder(),
-      customEventType: 0
+      ...eventContextBuilder(trackingId)
     };
-    eventInterceptor(event);
+    if (plugins.gioMultipleInstances && !isEmpty(sendTargets)) {
+      event['&&sendTo'] = sendTargets;
+    }
+    eventConverter(event);
   };
 }