gio-miniprogram-sdk 4.0.1 → 4.1.0

package/src/plugins/gioMultipleInstances.ts

@@ -0,0 +1,176 @@
+/**
+ * 名称：多实例插件
+ * 用途：用于提供多实例以向指定项目和数据源发数的插件。
+ */
+
+import { EXTEND_EVENT } from '@@/types/base';
+import { GrowingIOType } from '@@/types/growingIO';
+import { isString, unset } from '@@/utils/glodash';
+import { getGlobal, niceTry } from '@@/utils/tools';
+import { OriginOptions } from '@@/types/dataStore';
+import EMIT_MSG from '@@/constants/emitMsg';
+
+export class GioMultipleInstances {
+  public subTrackingIds: string[];
+  constructor(public growingIO: GrowingIOType) {
+    this.subTrackingIds = [];
+    this.growingIO.emitter.on(EMIT_MSG.ON_SDK_INITIALIZE_BEFORE, () => {
+      // 自动重写部分代码以实现多实例功能
+      if (!this.growingIO.trackingId) {
+        this.rewriteDataStore();
+      }
+      // 挂载子实例集合对象
+      if (!this.growingIO.subInstance) {
+        this.growingIO.subInstance = {};
+      }
+    });
+    this.growingIO.emitter.on(EMIT_MSG.OPTION_INITIALIZED, ({ trackingId }) => {
+      // 是子实例
+      if (
+        this.growingIO.trackingId &&
+        this.growingIO.trackingId !== trackingId
+      ) {
+        // 把所有已初始化过的子实例trackingId保存下来方便预定义事件和无埋点事件广播时调用
+        this.subTrackingIds.push(trackingId);
+      }
+    });
+  }
+
+  // 判断当前trackingId实例类型，为主实例还是子实例
+  getTrackerType = (trackingId: string, growingIO: GrowingIOType): number => {
+    return !growingIO.trackingId || growingIO.trackingId === trackingId ? 1 : 0;
+  };
+
+  // 重写dataStore中的部分内容
+  rewriteDataStore = () => {
+    // 获取采集实例
+    this.growingIO.dataStore.getTrackerVds = (trackingId: string) => {
+      if (this.growingIO.trackingId === trackingId) {
+        const vds = { ...this.growingIO.vdsConfig };
+        unset(vds, 'subInstance');
+        if (!this.growingIO.plugins.gioTaobaoAdapter) {
+          unset(vds, 'tbConfig');
+        }
+        return vds;
+      } else {
+        return this.growingIO.subInstance[trackingId]
+          ? { ...this.growingIO.subInstance[trackingId] }
+          : undefined;
+      }
+    };
+
+    // 初始化实例配置的方法
+    this.growingIO.dataStore.initTrackerOptions = (options: OriginOptions) => {
+      const trackerOptions = this.growingIO.dataStore.initOptions(options);
+      const trackerType = this.getTrackerType(
+        options.trackingId,
+        this.growingIO
+      );
+      trackerOptions.trackingId = options.trackingId;
+      if (trackerType) {
+        // 当前初始化主实例时给主实例赋值trackingId
+        this.growingIO.trackingId = options.trackingId;
+        // 主实例的配置直接挂在growingIO上
+        this.growingIO.vdsConfig = trackerOptions;
+        // 把主实例挂到小程序全局对象上
+        getGlobal().vdsConfig = trackerOptions;
+      } else {
+        // 子实例无效的配置项删除
+        unset(trackerOptions, [
+          'autotrack',
+          'debug',
+          'forceLogin',
+          'keepAlive',
+          'originalSource',
+          'performance',
+          'pluginMode',
+          'taro',
+          'taroVue',
+          'tbConfig',
+          'uniVue'
+        ]);
+        // 子实例的配置挂在subInstance下，以trackingId作为key值存储
+        this.growingIO.subInstance[options.trackingId] = trackerOptions;
+        // 把子实例挂到小程序全局对象上
+        if (!getGlobal().vdsConfig?.subInstance) {
+          getGlobal().vdsConfig.subInstance = {};
+        }
+        getGlobal().vdsConfig.subInstance[options.trackingId] = trackerOptions;
+      }
+      return trackerOptions;
+    };
+
+    // 初始化实例的hooker
+    this.growingIO.dataStore.initTrackerHooker = (options: OriginOptions) => {
+      const trackerType = this.getTrackerType(
+        options.trackingId,
+        this.growingIO
+      );
+      if (trackerType) {
+        const { platformConfig, inPlugin, minipInstance, plugins, dataStore } =
+          this.growingIO;
+        const { uniVue, taro } = options;
+        // 如果是使用全量版本时，当前小程序不是框架的，要允许原生的hook
+        if (!(uniVue || taro)) {
+          platformConfig.canHook = true;
+        }
+        // 初始化核心钩子（重写全局）
+        if (!inPlugin || ['tbp', 'jdp'].includes(minipInstance.platform)) {
+          dataStore.eventHooks.initEventHooks();
+        }
+        /** 第三方框架重写 */
+        // uniapp
+        if (uniVue) {
+          plugins?.gioUniAppAdapter?.main();
+        }
+        // taro
+        if (taro) {
+          plugins?.gioTaroAdapter?.main();
+        }
+      }
+    };
+
+    // 多实例时处理复制发送
+    const originFunction = this.growingIO.dataStore.eventConverter;
+    const self = this;
+    this.growingIO.dataStore.eventConverter = function (...args) {
+      const event: EXTEND_EVENT = args[0];
+      // 埋点事件使用合并后的发送目标发送
+      if (event.eventType === 'CUSTOM') {
+        const sendTo = [event.trackingId];
+        niceTry(() => {
+          event['&&sendTo'].forEach((s) => {
+            // 合法且不重复的实例
+            if (
+              isString(s) &&
+              self.growingIO.dataStore.getTrackerVds(s) &&
+              !sendTo.includes(s)
+            ) {
+              sendTo.push(s);
+            }
+          });
+        });
+        unset(event, '&&sendTo');
+        sendTo.forEach((trackingId: string) => {
+          const { eventContextBuilder } = self.growingIO.dataStore;
+          originFunction.call(this, {
+            ...event,
+            ...eventContextBuilder(trackingId)
+          });
+        });
+      } else {
+        // 其他事件直接发给指定调用实例
+        originFunction.call(this, event);
+      }
+    };
+  };
+
+  onSendBefore = ({ eventsQueue, requestData, trackingId }: any) => {
+    // 不是主实例的事件由多实例插件来提交请求
+    if (trackingId !== this.growingIO.trackingId) {
+      this.growingIO.uploader.sendEvent(eventsQueue, requestData);
+    }
+  };
+}
+
+export default { name: 'gioMultipleInstances', method: GioMultipleInstances };

package/src/types/base.ts

@@ -1,3 +1,7 @@
+export interface StringObject {
+  [key: string]: string;
+}
+
 interface TBConfig {
   cloud: any;
   cloudFuncSend?: boolean;
@@ -35,8 +39,6 @@ export interface UserOptions {
   requestTimeout?: number;
   // 数据上报域名
   serverUrl?: string;
-  // 是否标记为分包
-  subpackage: boolean;
   // taro框架实例
   taro?: any;
   // taro框架vue实例
@@ -76,7 +78,7 @@ export type EventTypes =
   | 'VIEW_CLICK'
   | 'VIEW_CHANGE';
 
-export interface Event {
+export interface EVENT {
   appChannel: string;
   appVersion: string;
   attributes?: any;
@@ -112,6 +114,11 @@ export interface Event {
   xpath?: string;
 }
 
+export interface EXTEND_EVENT extends EVENT {
+  requestId: string;
+  trackingId: string;
+}
+
 export type Actions =
   | 'tap'
   | 'longpress'

package/src/types/dataStore.ts

@@ -1,43 +1,58 @@
 import { UserOptions } from '@@/types/base';
 import { EventHooksType } from '@@/types/eventHooks';
 
+export type StorageKeyType =
+  | 'gsid'
+  | 'originalSource'
+  | 'uid'
+  | 'sessionId'
+  | 'userId'
+  | 'userKey'
+  | 'gioId';
+
 export interface OriginOptions extends UserOptions {
   appId: string;
   dataSourceId?: string;
   projectId: string;
+  trackingId: string;
 }
 
 export interface DataStoreType {
-  buildAddFavorites: (args: any) => void;
-  buildAppMessageEvent: (args: any) => void;
-  buildTimelineEvent: (args: any) => void;
-  eventContextBuilder: (params?: any) => any;
+  buildAddFavorites: (trackingId: string, args: any) => void;
+  buildAppMessageEvent: (trackingId: string, args: any) => void;
+  buildTimelineEvent: (trackingId: string, args: any) => void;
+  // 事件通用维度组装
+  eventContextBuilder?: (trackingId: string, params?: any) => any;
   eventConverter?: (event) => void;
   eventHooks: EventHooksType;
   eventInterceptor?: (event: any | void) => void;
   eventReleaseInspector?: () => void;
   generalProps: any;
-  getOption: (k?: string) => OriginOptions;
-  getOriginalSource: () => any;
-  gsid: number;
-  gsidStorageName: string;
-  initOptions: (userOptions: OriginOptions) => void;
-  initStorageInfo: () => void;
+  getStorageKey: (trackingId: string, name: StorageKeyType) => string;
+  getTrackerVds: (trackingId: string) => any;
+  getOption: (trackingId: string, k?: string) => OriginOptions;
+  getOriginalSource: (trackingId: string) => any;
+  getGsid: (trackingId: string) => number;
+  setGsid: (trackingId: string, value: number) => void;
+  initTrackerOptions: (userOptions: OriginOptions) => any;
+  initTrackerHooker: (trackerOptions: OriginOptions) => void;
+  initOptions: (userOptions: OriginOptions) => OriginOptions;
+  initStorageInfo: (trackingId: string) => void;
   interceptEvents: any[];
-  keepAlive: number;
   lastCloseTime: number;
   lastPageEvent: any;
   lastScene: number | string;
   lastVisitEvent: any;
   locationData: any;
-  originalSourceName: string;
   saveStorageInfo: () => void;
   scene: number | string;
-  sendPage: (props?: any) => void;
-  sendVisit: (props?: any) => void;
-  setOption: (k: string, v: any) => boolean;
-  setOriginalSource: (origins: any) => void;
+  sendPage: (trackingId: string, props?: any) => void;
+  sendVisit: (trackingId: string, props?: any) => void;
+  setOption: (trackingId: string, k: string, v: any) => boolean;
+  setOriginalSource: (trackingId: string, origins: any) => void;
   shareOut: boolean;
   toggleShareOut: (v?: boolean) => void;
   trackTimers?: any;
+  initializedTrackingIds: string[];
+  trackersExecute: (callback: (trackingId: string) => void) => void;
 }

package/src/types/eventHooks.ts

@@ -84,8 +84,7 @@ export interface MinipPageType {
   currentLifecycle: string;
   parsePage: (page: any, query: any) => void;
   getQuery: (query: any) => string;
-  getReferralPage: () => string;
-  saveShareId: (query: string) => void;
+  getReferralPage: (trackingId: string) => string;
   buildShareQuery: (result: PageShareResult) => [string, string];
   updateAppMessageResult: (result: PageShareResult) => PageShareResult;
   updateTimelineResult: (result: PageShareResult) => PageShareResult;
@@ -98,10 +97,6 @@ export interface EventHooksType {
   appHandlers: string[];
   pageHandlers: string[];
   actionEventTypes: string[];
-  originalApp: (any: any) => any;
-  originalPage: (any: any) => any;
-  originalComponent: (any: any) => any;
-  originalBehavior: (any: any) => any;
   appEffects: any;
   pageEffects: any;
   actionEffects: any;
@@ -128,6 +123,10 @@ export interface EventHooksType {
   pageOverriding: (options: any) => any;
   // Component/Behavior重写(重写除构造函数之外的所有方法)
   componentOverriding: (options: any) => any;
+  // 挂载App生命周期的effect方法
+  setAppEffectCbs: () => void;
+  // 挂载Page/Component生命周期的effect方法
+  setPageEffectCbs: () => void;
   // App属性重写复用方法
   growingApp: (app: any) => any;
   // Page属性重写复用方法

package/src/types/growingIO.ts

@@ -40,54 +40,70 @@ export interface GrowingIOType {
   taro3VMs?: any;
   // 分享数据
   shareAppMessage?: any;
+  // 用于放在事件中区别于为其他功能而生成事件的跟踪器Id，默认为g0
+  trackingId: string;
+  // 存储子实例的配置和信息
+  subInstance: {
+    [key: string]: OriginOptions;
+  };
   // 初始化方法
   init: (args: any) => void;
   // 注册插件
   registerPlugins?: (path?: string) => void;
   // 运行中修改配置
-  setOption: (optionKey: string, value: any) => void;
+  setOption: (trackingId: string, optionKey: string, value: any) => void;
   // 运行中获取配置
-  getOption: (optionKey?: string) => any;
+  getOption: (trackingId: string, optionKey?: string) => any;
   // 创建自定义埋点事件
   track?: (
+    trackingId: string,
     name: string,
     properties: { [key: string]: string },
     items?: { key: string; id: string; attributes?: { [key: string]: string } }
   ) => void;
   // 设置登录用户Id
-  setUserId?: (userId: string, userKey?: string) => void;
+  setUserId?: (trackingId: string, userId: string, userKey?: string) => void;
   // 清除登录用户Id
-  clearUserId?: () => void;
+  clearUserId?: (trackingId: string) => void;
   // 设置openId作为uid
-  identify?: (openId: string) => void;
+  identify?: (trackingId: string, openId: string) => void;
   // 发送用户变量
-  setUserAttributes?: (userAttributes: any) => void;
+  setUserAttributes?: (trackingId: string, userAttributes: any) => void;
   // 初始化回调
   initCallback?: () => void;
   // 错误提示
   callError?: (fn: string, type?: boolean, msg?: string) => void;
   // 工具类
   utils?: any;
-  // 事件通用维度组装
-  eventContextBuilder?: (updateTime?: boolean) => any;
   // 事件转换
   eventConverter?: (event: any) => void;
   // 事件拦截器
   eventInterceptor?: (event: any) => void;
   // 设置埋点通用属性
-  setGeneralProps?: (properties: any) => void;
+  setGeneralProps?: (trackingId: string, properties: any) => void;
   // 清除已设置的埋点通用属性
-  clearGeneralProps?: (properties: string[] | undefined) => void;
+  clearGeneralProps?: (
+    trackingId: string,
+    properties: string[] | undefined
+  ) => void;
   // 手动更新曝光监听
   updateImpression?: (collect?: any) => void;
   // 清除所有事件计时器
-  clearTrackTimer?: () => void;
+  clearTrackTimer?: (trackingId: string) => void;
   // 手动获取位置信息补发visit上报
-  setLocation: (latitude: number, longitude: number) => void;
+  setLocation: (
+    trackingId: string,
+    latitude: number,
+    longitude: number
+  ) => void;
   // 获取打通信息
-  getGioInfo: () => string;
+  getGioInfo: (trackingId: string) => string;
   // 获取ABTest数据
-  getABTest?: (layerId: string, callback?: (arg: any) => any) => void;
+  getABTest?: (
+    trackingId: string,
+    layerId: string,
+    callback?: (arg: any) => any
+  ) => void;
 
   emitter: {
     emit?: (msg: string, args?: any) => void;

package/src/types/platforms.ts

@@ -28,10 +28,6 @@ export interface PlatformConfigType {
   appHandlers?: string[];
   pageHandlers?: string[];
   actionEventTypes?: string[];
-  originalPage?: (any) => any;
-  originalApp?: (any) => any;
-  originalComponent?: (any) => any;
-  originalBehavior?: (any) => any;
   hooks?: {
     App: boolean;
     Page: boolean;

package/src/types/plugins.ts

@@ -9,11 +9,11 @@ export interface PluginsType {
   gioCustomTracking?: any;
   gioEventAutoTracking?: any;
   gioImpressionTracking?: any;
-  gioMultiIntegrate?: any;
   gioPerformance?: any;
   gioTaobaoAdapter?: any;
   gioTaroAdapter?: any;
   gioUniAppAdapter?: any;
+  gioMultipleInstances?: any;
   innerPluginInit: () => void;
   outerPluginInit?: (folder?: string) => void;
   install: (pluginName: string, showLog: boolean) => boolean;

package/src/types/uploader.ts

@@ -1,8 +1,10 @@
+import { EVENT, EXTEND_EVENT } from './base';
+
 export interface UploaderType {
   // 因forceLogin配置积压的事件请求队列
-  hoardingQueue: any[];
+  hoardingQueue: any;
   // 请求队列
-  requestQueue: any[];
+  requestQueue: any;
   // 请求限制最大数
   requestLimit: number;
   // 请求重试限制最大数
@@ -11,14 +13,18 @@ export interface UploaderType {
   retryIds: any;
   // 请求中的请求数
   requestingNum: number;
-  // 请求地址
-  requestURL: string;
+  // 获取积压列表
+  getHoardingQueue: (trackingId: string) => EXTEND_EVENT[];
+  // 获取请求列表
+  getRequestQueue: (trackingId: string) => EXTEND_EVENT[];
   // 提交请求至队列
-  commitRequest: (reqData) => void;
-  // 发送请求
-  initiateRequest: (forceSend?: boolean) => void;
+  commitRequest: (commitData: EXTEND_EVENT) => void;
+  // 初始化请求
+  initiateRequest: (trackingId: string, forceSend?: boolean) => void;
+  // 发送事件
+  sendEvent: (eventsQueue: EXTEND_EVENT[], requestData: EVENT[]) => void;
   // 请求错误回调
-  requestFailFn: (data) => void;
-  // 更新/生成新的上报地址方法
-  generateURL?: () => void;
+  requestFailFn: (event: EXTEND_EVENT) => void;
+  // 生成上报地址
+  generateURL: (trackingId: string) => void;
 }

package/src/types/userStore.ts

@@ -1,22 +1,26 @@
 export interface UserStoreType {
-  // 访问用户id在存储中的名称
-  uidStorageName: string;
-  // 登录用户id在存储中的名称
-  userIdStorageName: string;
-  // 最后一次登录用户id在存储中的名称
-  gioIdStorageName: string;
-  // 用户访问会话id
-  sessionId: string;
-  // 访问用户id（系统设置持久性存储）
-  uid: string;
-  // 登录用户id（客户设置持久性存储）
-  userId: string;
-  // idMapping userKey（客户设置持久性存储）
-  userKey: string;
-  // 最后一次登录用户id（持久性存储）
-  gioId: string;
+  // 获取设备Id
+  getUid: () => string;
+  // 设置设备Id
+  setUid: (id: string) => void;
+  // 获取sessionId
+  getSessionId: (trackingId: string) => string;
+  // 设置sessionId
+  setSessionId: (trackingId: string, id?: string) => void;
+  // 获取userId
+  getUserId: (trackingId: string) => string;
+  // 设置userId
+  setUserId: (trackingId: string, id?: string) => void;
+  // 获取userKey
+  getUserKey: (trackingId: string) => string;
+  // 设置userKey
+  setUserKey: (trackingId: string, key?: string) => void;
+  // 获取gioId
+  getGioId: (trackingId: string) => string;
+  // 设置gioId
+  setGioId: (trackingId: string, id?: string) => void;
   // 初始化用户信息
-  initUserInfo: () => void;
+  initUserInfo: (trackingId: string) => void;
   // 退出小程序时在存储中同步用户信息
   saveUserInfo: () => void;
 }

package/src/utils/glodash.ts

@@ -96,7 +96,7 @@ export const dropWhile = (o: any, fn: (currentValue: any) => boolean): any => {
  * @param o array
  * @returns new array
  */
-export const compact = (o: any): any => {
+export const compact = (o: any, ignoreZero = false): any => {
   if (isArray(o)) {
     let resIndex = 0;
     const result: any = [];
@@ -104,6 +104,9 @@ export const compact = (o: any): any => {
       if (value && !isEmpty(value)) {
         result[resIndex++] = value;
       }
+      if (ignoreZero && value === 0) {
+        result[resIndex++] = value;
+      }
     }
     return result;
   } else {
@@ -191,8 +194,12 @@ export const upperFirst = (s: any): string | any => {
  * @param target string
  * @returns boolean
  */
-export const startsWith = (s: string, target: string): boolean =>
-  s.slice(0, target.length) === target;
+export const startsWith = (s: string, target: string): boolean => {
+  if (!isString(s)) {
+    s = toString(s);
+  }
+  return s.slice(0, target.length) === target;
+};
 
 /**
  * 判断字符串是否以指定字符结尾

package/src/utils/tools.ts

@@ -1,4 +1,6 @@
+import { IMP_EVENTNAME_REG } from '@@/constants/regex';
 import {
+  compact,
   find,
   forEach,
   head,
@@ -11,7 +13,8 @@ import {
   keys,
   split,
   startsWith,
-  toString
+  toString,
+  unset
 } from '@@/utils/glodash';
 
 // 控制台打印提示信息，包含错误、警告和信息3种形式
@@ -62,7 +65,7 @@ export const eventNameValidate = (eventName: string, callback: () => void) => {
   if (
     isString(eventName) &&
     !isEmpty(eventName) &&
-    eventName.match(/^[a-zA-Z_][0-9a-zA-Z_]{0,100}$/)
+    eventName.match(IMP_EVENTNAME_REG)
   ) {
     return callback();
   } else {
@@ -74,6 +77,22 @@ export const eventNameValidate = (eventName: string, callback: () => void) => {
   }
 };
 
+// 获取动态属性的值
+export const getDynamicAttributes = (properties: any) => {
+  if (!isNil(properties)) {
+    keys(properties).forEach((k: string) => {
+      if (isFunction(properties[k])) {
+        properties[k] = niceTry(() => properties[k]());
+      } else if (isObject(properties[k])) {
+        unset(properties, k);
+      } else if (!isArray(properties[k])) {
+        properties[k] = toString(properties[k]);
+      }
+    });
+  }
+  return properties;
+};
+
 // 生成uuid
 export const guid = () => {
   return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
@@ -132,7 +151,7 @@ export const compareVersion = (v1 = '', v2 = '') => {
 // 获取vue的主版本号
 export const getVueVersion = (vue) => {
   if (vue) {
-    const mv = Number.parseInt(head(split(vue.version, '.')), 10);
+    const mv = Number(head(split(vue.version, '.')));
     return Number.isNaN(mv) ? 0 : mv;
   } else {
     return 0;
@@ -282,12 +301,14 @@ export const getGlobal = () => {
 export const limitObject = (o: any) => {
   const ob = {};
   if (isObject(o)) {
+    // 移除预置的'&&sendTo'字段
+    unset(o, '&&sendTo');
     forEach(o, (v, k) => {
       const key = toString(k).slice(0, 100);
       if (isObject(v)) {
         ob[key] = limitObject(v);
       } else if (isArray(v)) {
-        ob[key] = v.slice(0, 100);
+        ob[key] = compact(v.slice(0, 100), true);
         ob[key] = ob[key].join('||').slice(0, 1000);
       } else {
         ob[key] = !isNil(v) ? toString(v).slice(0, 1000) : '';
@@ -368,7 +389,7 @@ export const qsParse = (s: string) => {
 };
 
 // 将字符串转为hash
-export const hashCode = (string) => {
+export const hashCode = (string: string, abs = false) => {
   let hash = 0;
   if (isEmpty(string) || typeof string === 'boolean') {
     return hash;
@@ -380,5 +401,5 @@ export const hashCode = (string) => {
     hash = hash & hash; //Convert to 32bit integer
     i++;
   }
-  return hash;
+  return abs ? Math.abs(hash) : hash;
 };