gio-miniprogram-sdk 4.4.2 → 4.5.0

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

@@ -1,468 +0,0 @@
-import { EventHooksType, MinipPageType } from '@@/types/eventHooks';
-import { GrowingIOType } from '@@/types/growingIO';
-import { has, isArray, isEmpty, isFunction, typeOf } from '@@/utils/glodash';
-import { consoleText, getGlobal, niceTry } from '@@/utils/tools';
-
-import AppEffects from './appEffects';
-import MinipPage from './minipPage';
-import PageEffects from './pageEffects';
-import EMIT_MSG from '@@/constants/emitMsg';
-
-class EventHooks implements EventHooksType {
-  private appHooked: boolean;
-  private pageHooked: boolean;
-  private componentHooked: boolean;
-  private behaviorHooked: boolean;
-  public defAppCbs: any;
-  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;
-  public originalComponent: (any: any) => any;
-  public originalBehavior: (any: any) => any;
-  public appEffects: any;
-  public pageEffects: any;
-  public actionEffects: any;
-  public currentPage: MinipPageType;
-
-  constructor(public growingIO: GrowingIOType) {
-    const config = this.growingIO?.platformConfig;
-    this.defAppCbs = {};
-    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);
-    this.currentPage = new MinipPage(this.growingIO);
-  }
-
-  // 判断是否为非构造函数的一个函数
-  isNormalFc = (key: string, method: any) => {
-    return isFunction(method) && key !== 'constructor';
-  };
-
-  // 对象的遍历
-  objectTraverse = (target: any, fn: any) => {
-    Object.getOwnPropertyNames(target).forEach((k: string) => fn(k, target));
-    if (has(target, 'methods')) {
-      Object.getOwnPropertyNames(target.methods).forEach((k: string) => {
-        if (!target[k]) {
-          fn(k, target.methods);
-        }
-      });
-    }
-    if (has(target, 'lifetimes')) {
-      Object.getOwnPropertyNames(target.lifetimes).forEach((k: string) => {
-        if (!target[k]) {
-          fn(k, target.lifetimes);
-        }
-      });
-    }
-    if (has(target, 'pageLifetimes')) {
-      Object.getOwnPropertyNames(target.pageLifetimes).forEach((k: string) => {
-        if (!target[k]) {
-          fn(k, target.pageLifetimes);
-        }
-      });
-    }
-  };
-
-  // 补充生命周期函数
-  supLifeFcs = (target: any, type: 'app' | 'page') => {
-    if (isArray(this[`${type}Handlers`])) {
-      this[`${type}Handlers`].forEach((k: string) => {
-        // 除分享以外
-        if (
-          !isFunction(target[k]) &&
-          !['onShareAppMessage', 'onShareTimeline'].includes(k)
-        ) {
-          target[k] = () => {}; // eslint-disable-line
-        }
-      });
-    }
-  };
-
-  /**
-   * 执行生命周期回调并广播事件
-   */
-  lifeFcEffectsFn = (instance, args, cType, eventName, result = undefined) => {
-    // 创建参数数组副本
-    const argsArray =
-      typeOf(args) === 'array' ? Array.prototype.slice.call(args) : [];
-    // 如果有结果，添加到参数列表
-    if (!isEmpty(result)) {
-      argsArray.push(result);
-    }
-
-    // 执行effects
-    this[`def${cType}Cbs`][eventName].apply(instance, argsArray);
-
-    // 广播生命周期
-    this.growingIO.emitter.emit(EMIT_MSG.MINIP_LIFECYCLE, {
-      event: `${cType} ${eventName}End`,
-      timestamp: Date.now(),
-      params: { instance, arguments: Array.from(argsArray) }
-    });
-
-    return result;
-  };
-
-  /**
-   * 生命周期方法effects
-   */
-  lifeFcEffects = (eventName: string, method: any, cType: 'App' | 'Page') => {
-    const self = this;
-
-    return function (...args) {
-      let result;
-
-      // 分享事件单独处理
-      if (self.shareEventTypes.includes(eventName)) {
-        // 先执行分享的生命周期拿到分享数据
-        const originResult = method.apply(this, args) ?? {};
-
-        // sdk跟踪分享事件时才处理，否则直接返回原结果
-        if (!self.growingIO.vdsConfig.followShare) {
-          return originResult;
-        }
-        const isPromiseResult = typeOf(originResult) === 'promise';
-        const hasPromiseProperty = typeOf(originResult.promise) === 'promise';
-        // 支付宝的promise会被提前处理过，通过以下两个字段判断是否需要自定义promise
-        const isSpecialPromise =
-          has(originResult, '_result') && has(originResult, '_state');
-
-        // 处理异步分享结果
-        if (isPromiseResult || hasPromiseProperty || isSpecialPromise) {
-          // 创建处理Promise结果的通用函数
-          const handlePromiseResult = (promiseResult = {}) => {
-            try {
-              // 合并原始结果和Promise结果
-              const mergedResult = {
-                ...originResult,
-                ...promiseResult
-              };
-
-              // 更新分享内容
-              const updatedResult =
-                self.currentPage.updateShareResult(mergedResult);
-
-              // 执行回调
-              self.lifeFcEffectsFn(this, args, cType, eventName, updatedResult);
-            } catch (error) {
-              consoleText(error, 'error');
-            }
-          };
-
-          // 处理整个返回值是Promise的情况
-          if (isPromiseResult) {
-            // 如果三秒内不resolve结果，分享会使用原默认参数
-            Promise.race([
-              originResult,
-              new Promise((resolve) => {
-                setTimeout(() => {
-                  resolve({});
-                }, 3000);
-              })
-            ])
-              .then(handlePromiseResult)
-              .catch((error) => consoleText(error, 'error'));
-          }
-
-          // 处理返回值中包含promise属性的情况
-          if (hasPromiseProperty) {
-            // 如果三秒内不resolve结果，分享会使用原默认参数
-            Promise.race([
-              originResult.promise,
-              new Promise((resolve) => {
-                setTimeout(() => {
-                  resolve({});
-                }, 3000);
-              })
-            ])
-              .then(handlePromiseResult)
-              .catch((error) => consoleText(error, 'error'));
-          }
-
-          // 处理支付宝特有的promise
-          if (isSpecialPromise) {
-            self.growingIO.minipInstance?.handleSharePromise(
-              originResult,
-              handlePromiseResult
-            );
-          }
-
-          // 直接返回原分享结果继续执行原逻辑
-          result = self.currentPage.updateShareResult(originResult, false);
-        } else {
-          // 没有异步逻辑，直接更新分享内容执行回调
-          result = self.currentPage.updateShareResult(originResult);
-          self.lifeFcEffectsFn(this, args, cType, eventName, result);
-        }
-      } else {
-        // 其他生命周期事件：先执行回调，再执行原方法
-        self.lifeFcEffectsFn(this, args, cType, eventName);
-        result = method.apply(this, args);
-      }
-
-      return result;
-    };
-  };
-
-  /*
-   * 自定义方法effects
-   */
-  customFcEffects = (eventName: string, method: any) => {
-    const self = this;
-    return function (...args) {
-      let result;
-      if (
-        self.growingIO.vdsConfig.autotrack &&
-        self.growingIO.plugins.gioEventAutoTracking
-      ) {
-        try {
-          let event: any = args[0] || {};
-          // 有的框架的点击事件传参时需要在最后一个参数加上原生event才能触发SDK的事件
-          if (
-            !(has(event, 'type') && (event?.currentTarget || event?.target))
-          ) {
-            event = args[args.length - 1];
-          }
-          if (
-            (event?.currentTarget || event?.target) &&
-            self.actionEventTypes.includes(event.type)
-          ) {
-            // 无埋点事件插件未挂载时进行挂载
-            if (!isFunction(self.actionEffects)) {
-              self.actionEffects =
-                self.growingIO.plugins?.gioEventAutoTracking?.main ||
-                function () {}; //eslint-disable-line
-            }
-            self?.actionEffects(event, eventName);
-          }
-        } catch (error) {
-          consoleText(error, 'error');
-        }
-      }
-      // 执行原逻辑
-      result = method.apply(this, args);
-      return result;
-    };
-  };
-
-  // App中方法代理
-  appApplyProxy = (eventName: string, method: any) => {
-    if (this.appHandlers.includes(eventName)) {
-      return this.lifeFcEffects(eventName, method, 'App');
-    } else {
-      return this.customFcEffects(eventName, method);
-    }
-  };
-
-  // Page中方法代理
-  pageApplyProxy = (eventName: string, method: any) => {
-    if (this.pageHandlers.includes(eventName)) {
-      return this.lifeFcEffects(eventName, method, 'Page');
-    } else {
-      return this.customFcEffects(eventName, method);
-    }
-  };
-
-  // App重写遍历
-  appOverriding = (options: any) => {
-    this.setAppEffectCbs();
-    const fn = (k: string, target: any) => {
-      if (this.isNormalFc(k, target[k])) {
-        target[k] = this.appApplyProxy(k, target[k]);
-      }
-    };
-    // 补充未定义的生命周期，防止不触发vst和cls事件(vst依赖onShow、cls依赖onHide)
-    this.supLifeFcs(options, 'app');
-    // 遍历方法，进行重写
-    this.objectTraverse(options, fn);
-    return options;
-  };
-
-  // Page重写遍历
-  pageOverriding = (options: any) => {
-    this.setPageEffectCbs();
-    const fn = (k: string, target: any) => {
-      if (this.isNormalFc(k, target[k])) {
-        target[k] = this.pageApplyProxy(k, target[k]);
-      }
-    };
-    // 补充未定义的生命周期，防止不触发page事件(page依赖onShow)
-    this.supLifeFcs(options, 'page');
-    // 遍历方法，进行重写
-    this.objectTraverse(options, fn);
-    return options;
-  };
-
-  // Component/Behavior重写(重写除构造函数之外的所有方法)
-  componentOverriding = (options: any) => {
-    this.setPageEffectCbs();
-    const fn = (k: string, target: any) => {
-      if (this.isNormalFc(k, target[k])) {
-        target[k] = this.pageApplyProxy(k, target[k]);
-      }
-    };
-    if (!options.methods) {
-      options.methods = {};
-    }
-    // 补充生命周期方法
-    this.supLifeFcs(
-      this.growingIO.inPlugin ? options : options.methods,
-      'page'
-    );
-    // 遍历重写方法
-    this.objectTraverse(
-      this.growingIO.inPlugin ? options : options.methods,
-      fn
-    );
-    return options;
-  };
-
-  // 挂载App生命周期的effect方法
-  setAppEffectCbs = () => {
-    const self = this;
-    this.appHandlers.forEach((handlerName: string) => {
-      this.defAppCbs[handlerName] = function (...args) {
-        self.appEffects.main(handlerName, args);
-      };
-    });
-  };
-
-  // 挂载Page/Component生命周期的effect方法
-  setPageEffectCbs = () => {
-    const self = this;
-    this.pageHandlers.forEach((handlerName: string) => {
-      this.defPageCbs[handlerName] = function (...args) {
-        self.pageEffects.main(this, handlerName, args);
-      };
-    });
-  };
-
-  growingApp = (app: any) =>
-    isFunction(this.originalApp)
-      ? this.originalApp(this.appOverriding(app))
-      : this.appOverriding(app);
-
-  growingPage = (page: any) =>
-    isFunction(this.originalPage)
-      ? this.originalPage(this.pageOverriding(page))
-      : this.pageOverriding(page);
-
-  growingComponent = (component: any) =>
-    isFunction(this.originalComponent)
-      ? this.originalComponent(this.componentOverriding(component))
-      : this.componentOverriding(component);
-
-  growingBehavior = (behavior: any) =>
-    isFunction(this.originalBehavior)
-      ? this.originalBehavior(this.componentOverriding(behavior))
-      : this.componentOverriding(behavior);
-
-  nativeGrowing = (
-    designated: string[] = ['App', 'Page', 'Component', 'Behavior']
-  ) => {
-    const self = this;
-    const { platformConfig } = this.growingIO;
-    const platformHooks = platformConfig.hooks;
-    if (designated.includes('App')) {
-      try {
-        // 重写App
-        if (platformHooks.App && !this.appHooked) {
-          App = function (...args) {
-            return self.originalApp(self.appOverriding(args[0]));
-          };
-          this.appHooked = true;
-        }
-      } catch (error) {
-        // 在插件中可能会不存在App
-      }
-    }
-    if (designated.includes('Page')) {
-      try {
-        // 重写Page
-        if (platformHooks.Page && !this.pageHooked) {
-          Page = function (...args) {
-            return self.originalPage(self.pageOverriding(args[0]));
-          };
-          this.pageHooked = true;
-        }
-      } catch (error) {
-        // 在插件中可能会不存在Page
-      }
-    }
-    if (designated.includes('Component')) {
-      try {
-        // 重写Component
-        if (platformHooks.Component && !this.componentHooked) {
-          Component = function (...args) {
-            return self.originalComponent(self.componentOverriding(args[0]));
-          };
-          this.componentHooked = true;
-        }
-      } catch (error) {
-        //
-      }
-    }
-    if (designated.includes('Behavior')) {
-      try {
-        // 重写Behavior
-        if (platformHooks.Behavior && !this.behaviorHooked) {
-          Behavior = function (...args) {
-            return self.originalBehavior(self.componentOverriding(args[0]));
-          };
-          this.behaviorHooked = true;
-        }
-      } catch (error) {
-        // 部分小程序不存在Behavior
-      }
-    }
-  };
-
-  // 初始化原始值
-  initOriginalValue = () => {
-    this.setAppEffectCbs();
-    this.setPageEffectCbs();
-    this.originalApp = niceTry(() => App || global.App);
-    this.originalPage = niceTry(() => Page || global.Page);
-    this.originalComponent = niceTry(() => Component || global.Component);
-    this.originalBehavior = niceTry(() => Behavior || global.Behavior);
-  };
-
-  // 初始化事件钩子
-  initEventHooks = () => {
-    const self = this;
-    const { platformConfig, gioPlatform } = this.growingIO;
-    this.initOriginalValue();
-    if (platformConfig.canHook) {
-      this.nativeGrowing();
-      getGlobal().GioApp = niceTry(() => App ?? this.originalApp);
-      getGlobal().GioPage = niceTry(() => Page ?? this.originalPage);
-      getGlobal().GioComponent = niceTry(
-        () => Component ?? this.originalComponent
-      );
-      getGlobal().GioBehavior = niceTry(
-        () => Behavior ?? this.originalBehavior
-      );
-    } else if (gioPlatform === 'quickapp') {
-      getGlobal().GioApp = function (...args) {
-        return self.appOverriding(args[0]);
-      };
-      getGlobal().GioPage = function (...args) {
-        return self.pageOverriding(args[0]);
-      };
-      getGlobal().GioComponent = function (...args) {
-        return self.pageOverriding(args[0]);
-      };
-    }
-  };
-}
-
-export default EventHooks;

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

@@ -1,221 +0,0 @@
-import { compact, has, isEmpty, keys, last, unset } from '@@/utils/glodash';
-import { GrowingIOType } from '@@/types/growingIO';
-import { MinipPageType, PageShareResult } from '@@/types/eventHooks';
-import {
-  qsStringify,
-  normalPath,
-  splitPath,
-  qsParse,
-  niceTry,
-  getDynamicAttributes,
-  limitObject,
-  getPureParams
-} from '@@/utils/tools';
-import { EVENT } from '@@/types/base';
-
-class MinipPage implements MinipPageType {
-  // 根据页面存储的页面参数
-  public queryOptions: any;
-  // 通过调用wx.setNavigationBarTitle设置的title
-  public configuredTitle: any;
-  // 页面级属性
-  public pageProps: any;
-  // 上一个执行的小程序生命周期
-  public lastLifecycle: string;
-  // 当前执行的小程序生命周期
-  public currentLifecycle: string;
-  // 当前生命周期是否在页面显示前
-  public lifeBeforeShow = true;
-
-  constructor(public growingIO: GrowingIOType) {
-    this.queryOptions = {};
-    this.configuredTitle = {};
-    this.pageProps = {};
-  }
-
-  /**
-   * 获取当前页面路径
-   * 优先级：页面堆栈路径 > 启动参数路径 > 最近 page 事件路径 > 最近 visit 事件路径
-   * 插件环境下无页面时返回插件 appId
-   */
-  getPagePath = () => {
-    const { minipInstance, inPlugin, dataStore, trackingId } = this.growingIO;
-    const path = minipInstance.getCurrentPath();
-    if (inPlugin) {
-      const vds = dataStore.getTrackerVds(trackingId);
-      // 插件中没有页面时直接将插件appId作为页面信息
-      return path || `/插件${vds.appId}`;
-    } else {
-      return (
-        path ||
-        dataStore.eventHooks.appEffects.enterParams?.path ||
-        // 作为页面组件时component created生命周期中的埋点会取不到页面堆栈，所以拿最近的一个page事件中的页面信息做兜底
-        dataStore.lastPageEvent[trackingId]?.path ||
-        // 没有最近的一个page事件说明在app初始化的生命周期中，有些框架可能会有异步处理逻辑导致事件触发比visit晚，则使用visit事件中的页面信息兜底
-        dataStore.lastVisitEvent[trackingId]?.path
-      );
-    }
-  };
-
-  /**
-   * 获取当前页面参数（query）
-   * 优先级：页面堆栈参数 > 生命周期参数 > 启动参数 > 最近 page 事件参数 > 最近 visit 事件参数
-   */
-  getPageQuery = () => {
-    const { minipInstance, dataStore, trackingId } = this.growingIO;
-    const stackPage = minipInstance.getCurrentPage();
-    const stackPath = minipInstance.getCurrentPath();
-    const { enterParams = {} } = dataStore.eventHooks.appEffects;
-    if (stackPath) {
-      const pageParams = stackPage.options ?? stackPage.$taroParams;
-      // 堆栈中有页面信息，则使用堆栈中的页面参数
-      if (!isEmpty(pageParams)) {
-        // 有页面解析的 option 直接取
-        return qsStringify(getPureParams(pageParams));
-      } else if (!isEmpty(this.queryOptions[stackPath])) {
-        // 没有 option 从 hook 获取的生命周期参数中取
-        return qsStringify(getPureParams(this.queryOptions[stackPath]));
-      } else if (stackPath === enterParams.path) {
-        // 某些小程序虽然有页面堆栈，但是页面还没加载完，兜底取启动参数
-        return qsStringify(
-          getPureParams(
-            enterParams?.query,
-            enterParams?.referrerInfo?.extraData
-          )
-        );
-      }
-    } else if (enterParams.path) {
-      // 堆栈中没有页面信息，但启动参数中有，说明是小程序刚启动还没加载页面，直接取启动参数
-      return qsStringify(
-        getPureParams(enterParams?.query, enterParams?.referrerInfo?.extraData)
-      );
-    } else {
-      // 作为页面组件时 component created 生命周期中的埋点会取不到页面堆栈，所以拿最近的一个 page 事件中的页面信息做兜底
-      return dataStore.lastPageEvent[trackingId]?.path
-        ? dataStore.lastPageEvent[trackingId]?.query
-        : // 没有最近的一个 page 事件说明在 app 初始化的生命周期中，有些框架可能会有异步处理逻辑导致事件触发比 visit 晚，则使用 visit 事件中的页面信息兜底
-          dataStore.lastVisitEvent[trackingId]?.query;
-    }
-  };
-
-  /**
-   * 获取页面标题
-   * 优先级：setNavigationBarTitle > data.gioPageTitle > config.js 中设置的值 > tabBar 配置
-   * 插件环境下无页面时返回插件 appId
-   * @param trackingId 可选，追踪 id
-   */
-  getPageTitle = (trackingId?: string) => {
-    const { minipInstance, inPlugin, dataStore } = this.growingIO;
-    const path = minipInstance.getCurrentPath();
-    const title =
-      this.configuredTitle[path] ||
-      minipInstance.getPageTitle(minipInstance.getCurrentPage());
-    if (inPlugin) {
-      const vds = dataStore.getTrackerVds(
-        trackingId || this.growingIO.trackingId
-      );
-      // 插件中没有页面时直接将插件appId作为页面信息
-      return (
-        title || `/插件${vds.appId}${path ? '_' + last(path.split('/')) : ''}`
-      );
-    } else {
-      return title;
-    }
-  };
-
-  /**
-   * 获取页面来源（referrer）
-   * 优先级：最近 page 事件路径 > 启动参数 referrerInfo.appId > scene 场景值
-   * @param trackingId 追踪 id
-   */
-  getReferralPage = (trackingId: string) => {
-    const {
-      minipInstance,
-      dataStore: { lastPageEvent, scene, eventHooks }
-    } = this.growingIO;
-    return (
-      lastPageEvent[trackingId]?.path ||
-      eventHooks.appEffects.enterParams?.referrerInfo?.appId ||
-      (scene ? `scn:${minipInstance.scnPrefix}${scene}` : null)
-    );
-  };
-
-  /**
-   * 处理分享参数，生成分享用的 path 和 query
-   * 优先级：result.query > result.path > 当前页面参数（去除 utm_ 开头参数）
-   * @param result PageShareResult 客户自定义的参数
-   * @returns [path, queryString]
-   */
-  buildShareQuery(result: PageShareResult): [string, string] {
-    // 自定义 path 的地址参数截取（onShareAppMessage 中的页面参数是拼在地址中的）
-    const customSplit = splitPath(result.path ?? '');
-
-    let path = result.path || this.getPagePath();
-    let parsedQuery: any = {};
-    let resultHasPath = has(result, 'path');
-    let resultHasQuery = has(result, 'query');
-    // 如果定义了 query 字段则优先取 query 参数
-    if (resultHasQuery) {
-      parsedQuery = qsParse(result.query ?? '') || {};
-    } else if (resultHasPath) {
-      // 没有定义 query 字段则尝试取 path 中的参数
-      parsedQuery = qsParse(last(customSplit)) || {};
-    } else {
-      // 只有在没有自定义 path 和 query 的情况下，才使用页面堆栈中的默认参数并删除 utm 参数
-      const stackPage = this.growingIO.minipInstance.getCurrentPage();
-      // 这里不要直接用对象赋值，下面的 unset 会修改原对象，导致触发一次分享以后当前页面事件中的 utm 参数就会被删除掉
-      parsedQuery = {
-        ...(stackPage.options || this.queryOptions[stackPage.route] || {})
-      };
-
-      // 删除 utm_ 参数
-      compact(keys(parsedQuery)).forEach((key) => {
-        if (key.toLowerCase().startsWith('utm_')) {
-          unset(parsedQuery, key);
-        }
-      });
-    }
-
-    return [path, qsStringify(parsedQuery)];
-  }
-
-  /**
-   * 更新分享结果，补全参数
-   * @param result PageShareResult 分享参数对象
-   * @param fillParams 是否补全参数，默认 true
-   * @returns 更新后的 result
-   */
-  updateShareResult = (result: PageShareResult, fillParams = true) => {
-    const [path, queryString] = this.buildShareQuery(result);
-    if (fillParams || has(result, 'path')) {
-      result.path = normalPath(path + (queryString ? `?${queryString}` : ''));
-    }
-    if (fillParams || has(result, 'query')) {
-      result.query = queryString;
-    }
-    return result;
-  };
-
-  /**
-   * 给事件合并页面属性
-   * @param trackingId 追踪 id
-   * @param event 事件对象
-   * @returns 合并后的属性对象
-   */
-  eventSetPageProps = (trackingId: string, event: EVENT) => {
-    const pageProps = niceTry(
-      () => this.pageProps[trackingId][this.getPagePath()]
-    );
-    if (!isEmpty(pageProps)) {
-      return limitObject(
-        getDynamicAttributes({
-          ...event.attributes,
-          ...pageProps
-        })
-      );
-    }
-    return event.attributes;
-  };
-}
-
-export default MinipPage;