gio-miniprogram-sdk 4.0.0

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

@@ -0,0 +1,403 @@
+import { EventHooksType, MinipPageType } from '@@/types/eventHooks';
+import { GrowingIOType } from '@@/types/growingIO';
+import { has, isArray, isFunction, typeOf, unset } from '@@/utils/glodash';
+import { consoleText, getGlobal, niceTry } from '@@/utils/tools';
+
+import AppEffects from './appEffects';
+import MinipPage from './minipPage';
+import PageEffects from './pageEffects';
+
+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 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.actionEventTypes = config.actionEventTypes;
+    this.originalApp = config.originalApp;
+    this.originalPage = config.originalPage;
+    this.originalComponent = config.originalComponent;
+    this.originalBehavior = config.originalBehavior ?? function () {}; // eslint-disable-line
+    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
+        }
+      });
+    }
+  };
+
+  // 生命周期方法effects
+  lifeFcEffects = (eventName: string, method: any, cType: 'App' | 'Page') => {
+    const self = this;
+    if (['onShareTimeline', 'onAddToFavorites'].includes(eventName)) {
+      // onShareTimeline和onAddToFavorites不能异步执行，单独处理
+      return function (...args) {
+        let result = method.apply(this, args);
+        if (
+          eventName === 'onShareTimeline' &&
+          self.growingIO.vdsConfig.followShare
+        ) {
+          result = self.currentPage.updateTimelineResult(result ?? {});
+        }
+        if (eventName === 'onAddToFavorites') {
+          result = self.currentPage.updateAddFavoritesResult(result ?? {});
+        }
+        const argsArray = Array.prototype.slice.call(args);
+        if (result) {
+          argsArray.push(result);
+        }
+        // 执行effects
+        self[`def${cType}Cbs`][eventName].apply(this, argsArray);
+        return result;
+      };
+    } else {
+      // 其他生命周期可以异步执行
+      return async function (...args) {
+        let result;
+        try {
+          // 分享处理
+          if (eventName === 'onShareAppMessage') {
+            // 先执行分享的生命周期拿到分享数据
+            // 与基础库保持一致，没有返回值时默认使用{}
+            result = (await method.apply(this, args)) ?? {};
+            if (typeOf(result.promise) === 'promise') {
+              const f = async function () {
+                let sRes = result;
+                return new Promise((resolve) => {
+                  // 如果3秒后result.promise没有返回结果，则返回的是默认的result值
+                  // https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareAppMessage-Object-object
+                  let t = setTimeout(() => {
+                    resolve({ ...sRes });
+                    clearTimeout(t);
+                    t = undefined;
+                  }, 3000);
+                  result.promise.then((res) => {
+                    sRes = res;
+                    resolve({ ...sRes });
+                    clearTimeout(t);
+                    t = undefined;
+                  });
+                });
+              };
+              result = { ...result, ...((await f()) as any) };
+              unset(result, 'promise');
+            }
+            if (self.growingIO.vdsConfig.followShare) {
+              result = self.currentPage.updateAppMessageResult(result ?? {});
+            }
+          }
+          const argsArray = Array.prototype.slice.call(args);
+          if (result) {
+            argsArray.push(result);
+          }
+          // 执行effects
+          self[`def${cType}Cbs`][eventName].apply(this, argsArray);
+        } catch (error) {
+          consoleText(error, 'error');
+        }
+        // 执行分享之外的生命周期函数
+        if (eventName !== 'onShareAppMessage') {
+          result = method.apply(this, args);
+        }
+        self.growingIO.emitter.emit('minipLifecycle', {
+          event: `${cType} ${eventName}End`,
+          timestamp: Date.now(),
+          params: { instance: this, arguments: Array.from(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) => this.originalApp(this.appOverriding(app));
+
+  growingPage = (page: any) => this.originalPage(this.pageOverriding(page));
+
+  growingComponent = (component: any) =>
+    this.originalComponent(this.componentOverriding(component));
+
+  growingBehavior = (behavior: any) =>
+    this.originalBehavior(this.componentOverriding(behavior));
+
+  nativeGrowing = (
+    designated: string[] = ['App', 'Page', 'Component', 'Behavior']
+  ) => {
+    const self = this;
+    const { platformConfig } = this.growingIO;
+    const platformHooks = platformConfig.hooks;
+    this.setAppEffectCbs();
+    this.setPageEffectCbs();
+    if (designated.includes('App')) {
+      try {
+        // 重写App
+        if (platformHooks.App && !this.appHooked) {
+          App = function (...args) {
+            return self.growingApp(args[0]);
+          };
+          this.appHooked = true;
+        }
+      } catch (error) {
+        // 在插件中可能会不存在App
+      }
+    }
+    if (designated.includes('Page')) {
+      try {
+        // 重写Page
+        if (platformHooks.Page && !this.pageHooked) {
+          Page = function (...args) {
+            return self.growingPage(args[0]);
+          };
+          this.pageHooked = true;
+        }
+      } catch (error) {
+        // 在插件中可能会不存在Page
+      }
+    }
+    if (designated.includes('Component')) {
+      try {
+        // 重写Component
+        if (platformHooks.Component && !this.componentHooked) {
+          Component = function (...args) {
+            return self.growingComponent(args[0]);
+          };
+          this.componentHooked = true;
+        }
+      } catch (error) {
+        //
+      }
+    }
+    if (designated.includes('Behavior')) {
+      try {
+        // 重写Behavior
+        if (platformHooks.Behavior && !this.behaviorHooked) {
+          Behavior = function (...args) {
+            return self.growingBehavior(args[0]);
+          };
+          this.behaviorHooked = true;
+        }
+      } catch (error) {
+        // 部分小程序不存在Behavior
+      }
+    }
+  };
+
+  // 初始化无埋点
+  initEventHooks = () => {
+    const self = this;
+    const { platformConfig, gioPlatform } = this.growingIO;
+    if (platformConfig.canHook) {
+      this.nativeGrowing();
+      getGlobal().GioApp = niceTry(() => App ?? window.GioApp);
+      getGlobal().GioPage = niceTry(() => Page ?? window.GioPage);
+      getGlobal().GioComponent = niceTry(
+        () => Component ?? window.GioComponent
+      );
+      getGlobal().GioBehavior = niceTry(() => Behavior);
+    } else if (gioPlatform === 'quickapp') {
+      window.GioApp = function (...args) {
+        return self.appOverriding(args[0]);
+      };
+      window.GioPage = function (...args) {
+        return self.pageOverriding(args[0]);
+      };
+      window.GioComponent = function (...args) {
+        return self.pageOverriding(args[0]);
+      };
+    }
+  };
+}
+
+export default EventHooks;

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

@@ -0,0 +1,132 @@
+import { has, head, isEmpty, last, unset } from '@@/utils/glodash';
+import { GrowingIOType } from '@@/types/growingIO';
+import { MinipPageType, PageShareResult } from '@@/types/eventHooks';
+import { qsStringify, normalPath, splitPath, qsParse } from '@@/utils/tools';
+
+class MinipPage implements MinipPageType {
+  public path: string;
+  public time: number;
+  public query: any;
+  // 页面title (优先级：setNavigationBarTitle > data.gioPageTitle[不保证能取到] > config.js中设置的值 > tabBar配置)
+  public title: string;
+  // 通过调用wx.setNavigationBarTitle设置的title
+  public settedTitle: any;
+  // 当前页面参数中的分享id
+  public queryShareId: string;
+  // 页面级属性
+  public pageProps: any;
+  // 上一个执行的小程序生命周期
+  public lastLifecycle: string;
+  // 当前执行的小程序生命周期
+  public currentLifecycle: string;
+
+  constructor(public growingIO: GrowingIOType) {
+    this.query = undefined;
+    this.settedTitle = {};
+    this.pageProps = {};
+  }
+
+  // 存储页面参数
+  parsePage = (page: any, query: any) => {
+    // wx/my取route; swan取uri; tt取__route__; qq无值
+    const path =
+      page.route || page.uri || page.__route__ || page?.$page?.fullPath || '';
+    if (!isEmpty(query)) {
+      this.query = this.getQuery(query);
+    } else {
+      this.query = undefined;
+    }
+    if (this.path !== path) {
+      this.time = Date.now();
+    }
+    this.path = path;
+    this.title =
+      // 如果在parse前（onLoad）动态设置了title，则优先获取动态设置的值
+      this.settedTitle[this.path] ||
+      this.growingIO.minipInstance.getPageTitle(
+        page || this.growingIO.minipInstance.getCurrentPage()
+      );
+  };
+
+  // 获取页面参数
+  getQuery = (query: any) => {
+    const filtQeury = { ...query };
+    unset(filtQeury, 'wxShoppingListScene');
+    return qsStringify(filtQeury);
+  };
+
+  // 获取上一个页面路径
+  getReferralPage = () => {
+    const {
+      minipInstance,
+      dataStore: { lastPageEvent, scene }
+    } = this.growingIO;
+    return (
+      lastPageEvent?.path ||
+      (scene ? `scn:${minipInstance.scnPrefix}${scene}` : null)
+    );
+  };
+
+  // 保存分享id（记录是从哪个用户id的分享来的）
+  saveShareId = (query: any) => {
+    if (query?.gioShareId) {
+      this.queryShareId = query.gioShareId;
+    }
+  };
+
+  // 处理分享参数
+  buildShareQuery(
+    result: PageShareResult // 客户自定义的参数
+  ): [string, string] {
+    // 自定义path的地址参数截取（onShareAppMessage中的页面参数是拼在地址中的）
+    const customSplit = splitPath(result.path ?? '');
+
+    let path = this.path;
+    let parsedQeury: any = {};
+    let resultHasPath = has(result, 'path');
+    // 优先使用自定义的地址
+    if (resultHasPath) {
+      path = head(customSplit);
+      parsedQeury = qsParse(last(customSplit)) || {};
+    }
+
+    // 自定义path中没有截取到query说明是在onShareAppMessage中没有参数，或是在onShareTimeline中需要取自定义query
+    if (isEmpty(parsedQeury)) {
+      parsedQeury = qsParse(result.query ?? '') || {};
+    }
+
+    // 以上两种都是自定义的地址和参数，不做处理直接用，防止出现encode/decode的问题。
+
+    // 自定义query没有值则使用当前页面默认参数
+    // 如果path存在，但是不携带参数，此时不使用当前页面的默认参数
+    if (!resultHasPath && isEmpty(parsedQeury)) {
+      parsedQeury = qsParse(this.query ?? '') || {};
+    }
+
+    return [path, qsStringify(parsedQeury)];
+  }
+
+  // 更新分享结果
+  updateShareResult = (result: PageShareResult) => {
+    const [path, queryString] = this.buildShareQuery(result);
+    result.path = normalPath(path + (queryString ? `?${queryString}` : ''));
+    result.query = queryString;
+    return result;
+  };
+
+  // 更新分享转发事件的结果
+  updateAppMessageResult = this.updateShareResult;
+
+  // 更新分享朋友圈结果
+  updateTimelineResult = this.updateShareResult;
+
+  // 更新收藏结果
+  updateAddFavoritesResult = (result: PageShareResult) => {
+    const [path, queryString] = this.buildShareQuery(result);
+    result.path = normalPath(path + (queryString ? `?${queryString}` : ''));
+    result.query = queryString;
+    return result;
+  };
+}
+
+export default MinipPage;

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

@@ -0,0 +1,168 @@
+import { get, isEmpty, isFunction, unset } from '@@/utils/glodash';
+import { GrowingIOType } from '@@/types/growingIO';
+import { PageHookLifeCircle } from '@@/types/eventHooks';
+
+class PageEffects {
+  public buildTabClickEvent: (tabItem: any) => void;
+  private prevEvent: any;
+  private argQuery: any;
+  constructor(public growingIO: GrowingIOType) {
+    this.prevEvent = {};
+    this.argQuery = {};
+  }
+
+  main = (page: any, event: PageHookLifeCircle, args: any) => {
+    const eventTime = Date.now();
+    const {
+      emitter,
+      minipInstance,
+      plugins,
+      vdsConfig,
+      platformConfig,
+      dataStore: {
+        shareOut,
+        eventHooks,
+        toggleShareOut,
+        buildAppMessageEvent,
+        buildTimelineEvent,
+        buildAddFavorites
+      },
+      inPlugin
+    }: GrowingIOType = this.growingIO;
+    const { currentPage } = eventHooks;
+    if (
+      // 防止重写页面后可能出现重复的事件
+      this.prevEvent[event] &&
+      Date.now() - Number(this.prevEvent[event]) < 50
+    ) {
+      return;
+    }
+    if (!page) {
+      page = minipInstance.getCurrentPage();
+    }
+    if (!page.route) {
+      page.route = minipInstance.getCurrentPath(page);
+    }
+    const path =
+      page.route || page.uri || page.__route__ || page?.$page?.fullPath || '';
+    emitter.emit('minipLifecycle', {
+      event: `Page ${event}`,
+      timestamp: eventTime,
+      params: { page, args: args[0] }
+    });
+    if (vdsConfig.debug) {
+      console.log('Page:', path, '#', event, eventTime);
+    }
+    this.prevEvent[event] = Date.now();
+    const pageListeners = platformConfig.listeners.page;
+    // 向插件广播事件
+    emitter.emit('onComposeBefore', {
+      page,
+      event: `Page ${event}`,
+      params: { page, args: args[0] }
+    });
+    currentPage.lastLifecycle = currentPage.currentLifecycle;
+    currentPage.currentLifecycle = event;
+    switch (event) {
+      case pageListeners.pageLoad: {
+        this.argQuery[path] =
+          get(page, 'options') ||
+          get(page, '__displayReporter.query') ||
+          get(page, '$page.query') ||
+          get(page, '$wx.__displayReporter.query') ||
+          args[0] ||
+          {};
+        unset(this.argQuery[path], '$taroTimestamp');
+        currentPage.parsePage(page, this.argQuery[path]);
+        break;
+      }
+      case pageListeners.pageShow: {
+        if (inPlugin) {
+          currentPage.parsePage(page, this.argQuery[path]);
+          if (!currentPage.path) {
+            // 插件中没有页面时直接将插件appId作为页面信息
+            currentPage.path = `/插件${vdsConfig.appId}}`;
+            currentPage.title = `/插件${vdsConfig.appId}}`;
+          }
+          this.buildPageEvent();
+        } else if (!shareOut || !eventHooks.currentPage.time) {
+          // 不是因为分享切出再返回的onshow（视为第一次进入改页面）和切出去以后因为超时或者进入的场景值不一致时（会在appshow清掉页面时间），发page
+          currentPage.parsePage(page, this.argQuery[path]);
+          // 超时进入页面时前后path一致parsePage方法不会重置页面时间，可能会没有值，所以要补充重设一次
+          eventHooks.currentPage.time = Date.now();
+          this.buildPageEvent();
+        }
+        // 分享标记置为false
+        toggleShareOut(false);
+        // 保存分享id（记录是从哪个用户id的分享来的）
+        currentPage.saveShareId(this.argQuery[path]);
+        break;
+      }
+      case pageListeners.pageHide:
+      case pageListeners.pageUnload: {
+        break;
+      }
+      case pageListeners.shareApp: {
+        toggleShareOut(true);
+        if (vdsConfig.followShare) {
+          buildAppMessageEvent(args);
+        }
+        break;
+      }
+      case pageListeners.shareTime: {
+        if (vdsConfig.followShare) {
+          buildTimelineEvent(args);
+        }
+        break;
+      }
+      case pageListeners.addFavorites: {
+        buildAddFavorites(args);
+        break;
+      }
+      case pageListeners.tabTap: {
+        const buildTabClickEvent =
+          plugins?.gioEventAutoTracking?.buildTabClickEvent;
+        if (
+          vdsConfig.autotrack &&
+          buildTabClickEvent &&
+          isFunction(buildTabClickEvent)
+        ) {
+          buildTabClickEvent(args[0]);
+        }
+        break;
+      }
+      default:
+        break;
+    }
+    // 页面销毁移除当前页面的属性
+    if (event === pageListeners.pageUnload) {
+      currentPage.pageProps[path] = undefined;
+    }
+  };
+
+  // 构建页面访问事件
+  buildPageEvent = (props?: any) => {
+    const {
+      dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
+    } = this.growingIO;
+    const { currentPage } = eventHooks;
+    const event = {
+      eventType: 'PAGE',
+      referralPage: currentPage.getReferralPage(),
+      ...eventContextBuilder(),
+      timestamp: currentPage.time
+    };
+    // 添加页面属性
+    if (!isEmpty(currentPage.pageProps[event.path])) {
+      event.attributes = currentPage.pageProps[event.path];
+    }
+    if (!isEmpty(props) && props.path) {
+      event.path = props.path;
+      event.query = props.query;
+      event.title = props.title ?? event.title;
+    }
+    eventInterceptor(event);
+  };
+}
+
+export default PageEffects;