gio-miniprogram-sdk 4.3.1 → 4.4.0

package/rollup.config.js

@@ -19,7 +19,8 @@ const platform = processENV[0];
 // 框架平台
 const frameName = processENV[1];
 // 插件实例的入口名
-const pluginInstanceName = frameName || platform === 'tb' ? frameName || platform : 'base';
+const pluginInstanceName =
+  frameName || platform === 'tb' ? frameName || platform : 'base';
 // 小程序平台文件名枚举
 const PLATFORMS = {
   wx: 'wechat',
@@ -30,20 +31,22 @@ const PLATFORMS = {
   ks: 'kuaishou',
   tb: 'taobao',
   jd: 'jingdong',
-  quickapp: 'quickapp'
+  quickapp: 'quickapp',
+  xhs: 'xiaohongshu'
 };
 
 // 控制台打印当前打包的环境和小程序平台
 console.log(
-  `Packaging ${PLATFORMS[platform]
-    ? 'platform：' + PLATFORMS[platform]
-    : 'framework：' + frameName
+  `Packaging ${
+    PLATFORMS[platform]
+      ? 'platform：' + PLATFORMS[platform]
+      : 'framework：' + frameName
   }`
 );
 
 const fileName = () => {
   let n = 'dist/';
-  n += (PLATFORMS[platform] || frameName);
+  n += PLATFORMS[platform] ? PLATFORMS[platform] : frameName;
   n += '.js';
   return n;
 };

package/rollup.plugins.config.js

@@ -16,7 +16,7 @@ const processENV = process.argv[process.argv.length - 1]
   .split('-')
   .filter((o) => o);
 // 获取是否打包全量插件
-const folder = processENV[0] || 'plugins';
+const folder = processENV[0] ? processENV[0] : 'plugins';
 
 // 获取外置插件的目录
 const plugInFolder = fs

package/src/constants/emitMsg.ts

@@ -9,6 +9,7 @@ export default {
   ON_SDK_INITIALIZE_BEFORE: 'ON_SDK_INITIALIZE_BEFORE', // SDK开始初始化之前
   ON_SEND_AFTER: 'ON_SEND_AFTER', // 插件生命周期：发送事件后
   ON_SEND_BEFORE: 'ON_SEND_BEFORE', // 插件生命周期：发送事件前
+  ON_SEND_ERROR: 'ON_SEND_ERROR', // 插件生命周期：发送事件错误
   OPTION_CHANGE: 'OPTION_CHANGE', // 设置变更事件
   OPTION_INITIALIZED: 'OPTION_INITIALIZED', // 配置项初始化完成
   SCENE_UPDATE: 'SCENE_UPDATE', // scene变更事件

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

@@ -17,6 +17,7 @@ class AppEffects {
       platformConfig,
       uploader,
       dataStore,
+      minipInstance,
       dataStore: {
         trackersExecute,
         shareOut,
@@ -81,6 +82,8 @@ class AppEffects {
             userStore.setSessionId(trackingId);
           });
         }
+        // 添加网络状态变更监听
+        minipInstance.setNetworkStatusListener();
         break;
       }
       case appListeners.appClose: {

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

@@ -17,6 +17,7 @@ class EventHooks implements EventHooksType {
   public defPageCbs: any;
   public appHandlers: string[];
   public pageHandlers: string[];
+  public shareEventTypes: string[];
   public actionEventTypes: string[];
   public originalApp: (any: any) => any;
   public originalPage: (any: any) => any;
@@ -33,6 +34,7 @@ class EventHooks implements EventHooksType {
     this.defPageCbs = {};
     this.appHandlers = config.appHandlers;
     this.pageHandlers = config.pageHandlers;
+    this.shareEventTypes = config.shareEventTypes;
     this.actionEventTypes = config.actionEventTypes;
     this.appEffects = new AppEffects(this.growingIO);
     this.pageEffects = new PageEffects(this.growingIO);
@@ -115,7 +117,7 @@ class EventHooks implements EventHooksType {
         let result;
         try {
           // 分享处理
-          if (eventName === 'onShareAppMessage') {
+          if (self.shareEventTypes.includes(eventName)) {
             // 先执行分享的生命周期拿到分享数据
             // 与基础库保持一致，没有返回值时默认使用{}
             result = method.apply(this, args) ?? {};
@@ -160,7 +162,7 @@ class EventHooks implements EventHooksType {
           consoleText(error, 'error');
         }
         // 执行分享之外的生命周期函数
-        if (eventName !== 'onShareAppMessage') {
+        if (!self.shareEventTypes.includes(eventName)) {
           result = method.apply(this, args);
         }
         self.growingIO.emitter.emit(EMIT_MSG.MINIP_LIFECYCLE, {

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

@@ -102,6 +102,7 @@ class PageEffects {
       case pageListeners.pageUnload: {
         break;
       }
+      case pageListeners.shareChat: // 小红书特有事件
       case pageListeners.shareApp: {
         toggleShareOut(true);
         trackersExecute((trackingId: string) => {

package/src/core/growingIO.ts

@@ -18,7 +18,8 @@ import {
   getPlainPlatform,
   guid,
   limitObject,
-  niceCallback
+  niceCallback,
+  qsParse
 } from '@@/utils/tools';
 import { ALLOW_SET_OPTIONS, DEFAULT_SETTINGS } from '@@/constants/config';
 import { DataStoreType, OriginOptions } from '@@/types/dataStore';
@@ -65,6 +66,7 @@ class GrowingIO implements GrowingIOType {
   // 当前主SDK的trackingId，用于区分事件归属。
   public trackingId: string;
   public subInstance: any;
+  private _identified: boolean;
   constructor() {
     this.utils = { ...glodash, ...tools, qs };
     this.emitter = mitt();
@@ -288,6 +290,8 @@ class GrowingIO implements GrowingIOType {
       this.userStore.setUid(asId);
       // 修改forceLogin配置项
       this.dataStore.setOption(this.trackingId, 'forceLogin', false);
+      // 标记当前已被identify过
+      this._identified = true;
       // 为已积压的请求使用assignmentId全部赋值deviceId
       this.dataStore.trackersExecute((tid: string) => {
         const hq = this.uploader.getHoardingQueue(tid);
@@ -295,6 +299,8 @@ class GrowingIO implements GrowingIOType {
         // 发送积压队列中的请求
         this.uploader.initiateRequest(tid, true);
       });
+    } else if (this._identified) {
+      callError('identify', !1, '请勿重复调用');
     } else {
       callError('identify', !1, 'forceLogin未开启');
     }
@@ -338,9 +344,14 @@ class GrowingIO implements GrowingIOType {
       userId = toString(userId).slice(0, 1000);
       userKey = toString(userKey).slice(0, 1000);
       this.userStore.setUserId(trackingId, userId);
+      const processedUserKey =
+        !isNil(userKey) && toString(userKey).length > 0
+          ? toString(userKey).slice(0, 1000)
+          : '';
+      this.userStore.setUserKey(trackingId, processedUserKey);
       const { idMapping } = this.dataStore.getTrackerVds(trackingId);
-      if (idMapping) {
-        this.userStore.setUserKey(trackingId, isNil(userKey) ? '' : userKey);
+      if (!idMapping && processedUserKey) {
+        consoleText('您设置了 userKey ，请初始化开启 idMapping!', 'warn');
       }
       // 切换userId时重置session
       if (prevId && prevId !== userId) {
@@ -606,6 +617,19 @@ class GrowingIO implements GrowingIOType {
         }
       });
     }
+    // 只有主实例有可能会带圈选的字段
+    if (trackingId === this.trackingId) {
+      // 小程序处于圈选状态时，把圈选上报地址带给web
+      const { circleServerUrl, circleOpen } =
+        this.plugins?.gioEventAutoTracking ?? {};
+      if (circleServerUrl && circleOpen) {
+        // infos.giocircleserverurl = encodeURIComponent(circleServerUrl);
+        const circleParam: any = qsParse(circleServerUrl.split('?')[1]);
+        if (circleParam.roomId) {
+          infos.giocircleroomid = circleParam.roomId;
+        }
+      }
+    }
     return qs.stringify(infos);
   };
 }

package/src/core/uploader.ts

@@ -33,10 +33,10 @@ class Uploader implements UploaderType {
     this.retryLimit = 2;
     this.retryIds = {};
     this.requestingNum = 0;
-    const { emitter, vdsConfig, plugins } = this.growingIO;
-    emitter.on(
+    this.growingIO.emitter.on(
       EMIT_MSG.ON_SEND_BEFORE,
       ({ eventsQueue, requestData, trackingId }) => {
+        const { vdsConfig, plugins } = this.growingIO;
         // 核心逻辑中只发送主实例的事件
         if (trackingId === this.growingIO.trackingId) {
           if (vdsConfig?.tbConfig?.cloudAppId) {
@@ -223,11 +223,20 @@ class Uploader implements UploaderType {
             this.requestFailFn(o);
           });
           consoleText(`请求失败!${JSON.stringify(result)}`, 'error');
+          emitter.emit(EMIT_MSG.ON_SEND_ERROR, {
+            eventsQueue,
+            requestData,
+            trackingId
+          });
         }
       },
       complete: (args: any) => {
         this.requestingNum -= 1;
-        emitter.emit(EMIT_MSG.ON_SEND_AFTER, { result: args, requestData });
+        emitter.emit(EMIT_MSG.ON_SEND_AFTER, {
+          result: args,
+          requestData,
+          trackingId
+        });
         this.initiateRequest(trackingId);
       }
     });

package/src/core/userStore.ts

@@ -50,8 +50,7 @@ class UserStore implements UserStoreType {
     }
     // 存储中拿不到尝试设新值
     if (!this._uid) {
-      this._uid = guid();
-      minipInstance.setStorage(this._getUidKey(), this._uid);
+      this.setUid(guid());
     }
     return this._uid;
   };

package/src/minipInstance/base.ts

@@ -13,7 +13,8 @@ import {
   isString,
   last,
   typeOf,
-  isEmpty
+  isEmpty,
+  isArray
 } from '@@/utils/glodash';
 import EMIT_MSG from '@@/constants/emitMsg';
 import {
@@ -21,7 +22,8 @@ import {
   niceTry,
   getPlainMinip,
   getPlainPlatform,
-  getPlainConfig
+  getPlainConfig,
+  getPlainAppCode
 } from '@@/utils/tools';
 
 // 此基础实现类仅包含所有小程序，快应用所有方法全部单独实现
@@ -139,39 +141,67 @@ class BaseInstance implements MinipInstanceType {
     if (typeOf(instConfig) === 'string') {
       instConfig = niceTry(() => JSON.parse(instConfig)) ?? {};
     }
-    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现)
-    // 第二优先级支持客户自己在页面中设置页面title
+    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现，准确率最高)
+    // 第二优先级支持客户自己在页面中设置页面title（保持3.8的向下兼容，不准确但优先级高）
     const data = page?.data || page.$data || {};
     title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
-    if (instConfig) {
-      // 第三优先级app生命周期中拿不到page对象，拿生命周期的参数来匹配
+
+    let instPage;
+    // 第三优先级取页面的配置json的navigationBarTitleText（仅部分支持）
+    if (!title) {
+      // 存在__[wx]AppCode__时尝试从__[wx]AppCode__中匹配
+      niceTry(() => {
+        const instAppCode = getPlainAppCode(platform);
+        if (instAppCode) {
+          instPage = instAppCode[`${page.route}.json`] || {};
+          title =
+            instPage?.navigationBarTitleText || // wx/qq/jd
+            instPage?.mod?.exports?.navigationBarTitleText; // ks
+        }
+      });
+    }
+    if (!title && instConfig) {
+      // 第四优先级在app生命周期中拿不到page对象，拿生命周期的参数来匹配
       const { enterParams } = this.growingIO.dataStore.eventHooks.appEffects;
       if (!page.route && !isEmpty(enterParams)) {
         page.route = enterParams.path || '';
-        title = this._getTitleFromTabBar(instConfig, page.route);
+        title = page.route
+          ? this._getTitleFromTabBar(instConfig, page.route)
+          : '';
       }
-      // 第四优先级取页面的navigationBarTitleText
-      niceTry(() => {
-        if (!title) {
-          const instPage = instConfig.page || {};
+
+      // 第五优先级存在pages数组或page对象时尝试从page中匹配（大概率匹配不到，跟框架有关）
+      if (!title) {
+        if (isArray(instConfig.pages)) {
+          instPage = instConfig.pages.find((o) => o.path === page.route) ?? {};
+        } else {
+          instPage = instConfig.page || {};
+        }
+        if (instPage) {
           const pageInfo =
-            instPage[page.route] || instPage[`${page.route}.html`];
-          if (pageInfo) {
-            title = pageInfo?.window?.navigationBarTitleText;
-          } else if (['wx', 'tt'].includes(platform)) {
-            title = (instConfig || global || $global)?.global?.window
-              ?.navigationBarTitleText;
-          } else {
-            title = (instConfig || global || $global)?.window
-              ?.navigationBarTitleText;
-          }
+            instPage[page.route] || instPage[`${page.route}.html`] || instPage;
+          title =
+            pageInfo?.navigationBarTitleText ||
+            pageInfo?.window?.navigationBarTitleText;
         }
-      });
-      // 第五优先级取tabBar配置
+      }
+
+      // 第六优先级取tabBar配置匹配（只有tabbar的4个页面有机会）
       if (!title) {
         title = this._getTitleFromTabBar(instConfig, page.route);
       }
     }
+
+    // 第七优先级兜底取全局window的navigationBarTitleText
+    if (!title) {
+      if (['wx', 'tt'].includes(platform)) {
+        title = (instConfig || global || $global)?.global?.window
+          ?.navigationBarTitleText;
+      } else {
+        title = (instConfig || global || $global)?.window
+          ?.navigationBarTitleText;
+      }
+    }
     return limitString(title);
   };
 
@@ -268,8 +298,6 @@ class BaseInstance implements MinipInstanceType {
       data,
       // 微信小程序和其他小程序里叫header
       header,
-      // 支付宝小程序里叫headers
-      headers: header,
       timeout,
       method,
       success,
@@ -310,6 +338,15 @@ class BaseInstance implements MinipInstanceType {
       this.minip?.getSetting({ success: resolve, fail: resolve });
     });
   };
+
+  // 监听网络变更
+  setNetworkStatusListener = () => {
+    this.minip?.onNetworkStatusChange(({ networkType }) => {
+      if (networkType) {
+        this.network.networkType = networkType;
+      }
+    });
+  };
 }
 
 export default BaseInstance;

package/src/minipInstance/framework.ts

@@ -1,5 +1,6 @@
 import { getPlainPlatform } from '@@/utils/tools';
 
+import XiaoHongShu from './xhs';
 import JingDong from './jd';
 import KuaiShou from './ks';
 import Alipay from './my';
@@ -16,7 +17,8 @@ const INST = {
   qq: QQ,
   tt: Bytedance,
   ks: KuaiShou,
-  jd: JingDong
+  jd: JingDong,
+  xhs: XiaoHongShu
 };
 
 export default INST[plainPlatform];

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 {
@@ -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以外其他平台)
@@ -211,6 +217,17 @@ class QuickApp extends BaseImplements {
       });
     });
   };
+
+  // 监听网络变更
+  setNetworkStatusListener = () => {
+    network.subscribe({
+      callback: (data) => {
+        if (data.type) {
+          this.network.networkType = data.type;
+        }
+      }
+    });
+  };
 }
 
 export default QuickApp;

package/src/minipInstance/wx.ts

@@ -1,4 +1,5 @@
 import { GrowingIOType } from '@@/types/growingIO';
+import { SystemInfo } from '@@/types/minipInstance';
 
 import BaseImplements from './base';
 
@@ -7,6 +8,20 @@ class Weixin extends BaseImplements {
     super(growingIO);
     this.hookSetTitle();
   }
+
+  // 获取小程序系统信息
+  getSystemInfo = (): Promise<SystemInfo> => {
+    const self = this;
+    return new Promise((resolve) => {
+      const systemInfo = {
+        ...this.minip?.getDeviceInfo(),
+        ...this.minip?.getWindowInfo(),
+        ...this.minip?.getAppBaseInfo()
+      };
+      self.systemInfo = systemInfo;
+      resolve(systemInfo);
+    });
+  };
 }
 
 export default Weixin;

package/src/minipInstance/xhs.ts

@@ -0,0 +1,20 @@
+import { GrowingIOType } from '@@/types/growingIO';
+
+import BaseImplements from './base';
+
+class XiaoHongShu extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+
+  // 采集曝光事件
+  initImpression = (collectPage: any) => {
+    this.growingIO.plugins?.gioImpressionTracking?.main(
+      collectPage,
+      'selectAll'
+    );
+  };
+}
+
+export default XiaoHongShu;

package/src/platformConfig/base.ts

@@ -23,6 +23,7 @@ const Config: PlatformConfigType = {
     'onReachBottom', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
     'onResize' // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
   ],
+  shareEventTypes: ['onShareAppMessage'],
   actionEventTypes: [
     'onclick',
     'tap',

package/src/platformConfig/xhs.ts

@@ -0,0 +1,20 @@
+import BaseConfig from './base';
+
+const XHSConfig = {
+  ...BaseConfig,
+  pageHandlers: [...BaseConfig.pageHandlers, 'onShareChat', 'onCopyUrl'],
+  shareEventTypes: ['onShareAppMessage', 'onShareChat'],
+  listeners: {
+    ...BaseConfig.listeners,
+    page: {
+      ...BaseConfig.listeners.page,
+      shareChat: 'onShareChat',
+      copyUrl: 'onCopyUrl'
+    }
+  },
+  name: 'XiaoHongShu',
+  platform: 'xhsp',
+  scnPrefix: 'xhs_'
+};
+
+export default XHSConfig;

package/src/plugins/gioABTest.ts

@@ -33,6 +33,10 @@ class GioABTest {
   public url: any;
   // 接口重试计数
   public retryCount: number;
+  // 标记当前是否为新访问设备
+  public newDevice: boolean;
+  // 各个实例新设备进入时的sessionId；小程序没有刷新页面保持session的问题，所以存在内存里就可以
+  public visitSids: any;
   constructor(public growingIO: GrowingIOType, options: any) {
     this.pluginVersion = '__PLUGIN_VERSION__';
     const {
@@ -41,8 +45,9 @@ class GioABTest {
       requestTimeout
     } = options ?? {};
     this.timeoutCheck(requestInterval, requestTimeout);
-    const { emitter } = this.growingIO;
+    const { emitter, userStore } = this.growingIO;
     this.growingIO.getABTest = this.getABTest;
+    this.visitSids = {};
     emitter.on(EMIT_MSG.OPTION_INITIALIZED, () => {
       if (!isEmpty(abServerUrl)) {
         this.abtStorageCheck();
@@ -61,6 +66,21 @@ class GioABTest {
         );
       }
     });
+    emitter.on(EMIT_MSG.UID_UPDATE, ({ newUId, oldUId }) => {
+      // 没有旧deviceId说明是第一次进入的新设备
+      if (!oldUId && newUId) {
+        if (isString(abServerUrl)) {
+          const trackingId = this.growingIO.trackingId;
+          const sId = userStore.getSessionId(trackingId);
+          this.visitSids[trackingId] = sId;
+        } else if (isObject(abServerUrl)) {
+          keys(abServerUrl).forEach((trackingId: string) => {
+            const sId = userStore.getSessionId(trackingId);
+            this.visitSids[trackingId] = sId;
+          });
+        }
+      }
+    });
     this.retryCount = 0;
   }
 
@@ -121,6 +141,14 @@ class GioABTest {
 
   // 生成数据接口地址
   generateUrl = (trackingId: string, abServerUrl: string) => {
+    // 如果是延迟初始化的实例，当前又是首次进入设备，要补充把session存起来
+    if (this.newDevice && !this.visitSids[trackingId]) {
+      // 这里要用userStore中的getSessionId，调用这个方法的时候实例肯定已经初始化了
+      // 如果是新初始化可以通过getSessionId准确获取sessionExpires来生成准确的session值;
+      // 如果是旧实例则直接用存储中的sessionId
+      this.visitSids[trackingId] =
+        this.growingIO.userStore.getSessionId(trackingId);
+    }
     if (!startsWith(abServerUrl, 'http')) {
       this.url[
         trackingId
@@ -169,7 +197,7 @@ class GioABTest {
     callback: any
   ) => {
     const {
-      userStore: { getUid },
+      userStore: { getUid, getSessionId },
       dataStore,
       minipInstance
     } = this.growingIO;
@@ -182,7 +210,8 @@ class GioABTest {
         accountId: projectId,
         datasourceId: dataSourceId,
         distinctId: getUid(),
-        layerId
+        layerId,
+        newDevice: this.visitSids[trackingId] === getSessionId(trackingId)
       },
       timeout: this.requestTimeout,
       success: ({ data }: any) => {