gio-miniprogram-sdk 4.2.0 → 4.3.0

package/src/core/dataStore/index.ts

@@ -13,7 +13,6 @@ import {
   isBoolean,
   isEmpty,
   isFunction,
-  isNil,
   isString,
   keys,
   typeOf,
@@ -94,7 +93,7 @@ class DataStore implements DataStoreType {
       EMIT_MSG.ON_COMMIT_REQUEST,
       ({ eventData: event, trackingId }) => {
         if (event.eventType === 'VISIT') {
-          this.lastVisitEvent = event;
+          this.lastVisitEvent[trackingId] = event;
         }
         if (event.eventType === 'PAGE') {
           this.lastPageEvent[trackingId] = event;
@@ -219,26 +218,25 @@ class DataStore implements DataStoreType {
   };
 
   // 保存初始来源信息
-  setOriginalSource = (trackingId: string, { path, query }) => {
+  setOriginalSource = (trackingId: string, origins: any) => {
     const { minipInstance } = this.growingIO;
-    if (isNil(this.getOriginalSource(trackingId))) {
-      const originalSource = { path, query, title: '' };
-      minipInstance.setStorageSync(
-        this.getStorageKey(trackingId, 'originalSource'),
-        JSON.stringify(originalSource)
-      );
-    }
+    minipInstance.setStorageSync(
+      this.getStorageKey(trackingId, 'originalSource'),
+      JSON.stringify(origins)
+    );
   };
 
   // 获取初始来源信息
   getOriginalSource = (trackingId: string) => {
     const { minipInstance } = this.growingIO;
-    return niceTry(() =>
-      JSON.parse(
-        minipInstance.getStorageSync(
-          this.getStorageKey(trackingId, 'originalSource')
+    return (
+      niceTry(() =>
+        JSON.parse(
+          minipInstance.getStorageSync(
+            this.getStorageKey(trackingId, 'originalSource')
+          )
         )
-      )
+      ) ?? {}
     );
   };
 
@@ -263,12 +261,14 @@ class DataStore implements DataStoreType {
     const { platformConfig, inPlugin, minipInstance, plugins } = this.growingIO;
     const { uniVue, taro } = vdsConfig;
     // 如果是使用全量版本时，当前小程序不是框架的，要允许原生的hook
-    if (!(uniVue || taro)) {
+    if (!(uniVue || taro || minipInstance.platform === 'quickapp')) {
       platformConfig.canHook = true;
     }
     // 初始化核心钩子（重写全局）
     if (!inPlugin || ['tbp', 'jdp'].includes(minipInstance.platform)) {
       this.eventHooks.initEventHooks();
+    } else {
+      this.eventHooks.initOriginalValue();
     }
     /** 第三方框架重写 */
     // uniapp
@@ -365,19 +365,11 @@ class DataStore implements DataStoreType {
       this.updateVdsConfig(trackingId, { ...trakerVds, [k]: v });
       // 从关闭到打开dataCollect时补发visit和page
       if (k === 'dataCollect' && prevConfig.dataCollect !== v && v) {
+        // 更新session
         userStore.setSessionId(trackingId);
-        const { path, query, settedTitle } = this.eventHooks.currentPage;
-        // 重新获取页面title，防止切换配置前修改了title没取到
-        this.eventHooks.currentPage.title =
-          settedTitle[path] ||
-          this.growingIO.minipInstance.getPageTitle(
-            this.growingIO.minipInstance.getCurrentPage()
-          );
-        // visit取当前页面值
-        this.sendVisit(trackingId, { path, query });
-        // 要重设一次页面时间，防止比visit早
-        this.eventHooks.currentPage.time = Date.now();
-        this.sendPage(trackingId, { path, query });
+        // 重发visit/page
+        this.sendVisit(trackingId);
+        this.sendPage(trackingId);
       }
       // 配置项有变更要全局广播
       emitter.emit(EMIT_MSG.OPTION_CHANGE, { optionName: k, optionValue: v });
@@ -431,10 +423,7 @@ class DataStore implements DataStoreType {
 
   // 手动调用visit事件的方法
   sendVisit = (trackingId: string, props?: any) => {
-    (this.eventHooks.appEffects as any).buildVisitEvent(
-      trackingId,
-      props ?? this.lastVisitEvent
-    );
+    (this.eventHooks.appEffects as any).buildVisitEvent(trackingId, props);
   };
 
   // 手动调用page事件的方法
@@ -482,6 +471,26 @@ class DataStore implements DataStoreType {
     }
   };
 
+  // 事件重组
+  eventRefactor = (e: any) => {
+    // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
+    const ne = {
+      ...e,
+      ...this.eventContextBuilder(e.trackingId, {
+        path: e.path,
+        query: e.query,
+        // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
+        timestamp: e.timestamp
+      })
+    };
+    // 防止事件原有的属性被通用属性直接覆盖
+    ne.attributes = {
+      ...(ne.attributes ?? {}),
+      ...(e.attributes ?? {})
+    };
+    return ne;
+  };
+
   // 事件拦截器（有的通用维度字段需要异步获取，为了防止事件在通用维度还没返回之前就发出去）一般只有最开始的个别事件会被拦住
   eventInterceptor = (event: any) => {
     const { systemInfo, network } = this.growingIO.minipInstance;
@@ -491,17 +500,7 @@ class DataStore implements DataStoreType {
     } else if (!isEmpty(this.interceptEvents)) {
       // 有通用维度字段了，且有被拦截的事件，放一起重新添加通用维度字段再提交转换
       [...this.interceptEvents, event].forEach((e: any) => {
-        // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
-        const ne = {
-          ...e,
-          ...this.eventContextBuilder(event.trackingId, {
-            path: e.path,
-            query: e.query,
-            // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
-            timestamp: e.timestamp
-          })
-        };
-        this.eventConverter(ne);
+        this.eventConverter(this.eventRefactor(e));
       });
       this.interceptEvents = [];
     } else {
@@ -517,17 +516,7 @@ class DataStore implements DataStoreType {
     } = this.growingIO;
     if (systemInfo && network && !isEmpty(this.interceptEvents)) {
       [...this.interceptEvents].forEach((e: any) => {
-        // 有的事件的path和query不能再用页面的值，所以直接使用事件中已有的值
-        const ne = {
-          ...e,
-          ...this.eventContextBuilder(e.trackingId, {
-            path: e.path,
-            query: e.query,
-            // page事件需要使用事件中原有的时间戳，其他事件也要用原来的时间戳保证事件的准确性
-            timestamp: e.timestamp
-          })
-        };
-        this.eventConverter(ne);
+        this.eventConverter(this.eventRefactor(e));
       });
       this.interceptEvents = [];
     }

package/src/core/growingIO.ts

@@ -208,22 +208,21 @@ class GrowingIO implements GrowingIOType {
   setPageAttributes = (trackingId: string, properties: any) => {
     if (isObject(properties) && !isEmpty(properties)) {
       const { currentPage } = this.dataStore.eventHooks;
+      const path = currentPage.getPagePath();
       if (isEmpty(currentPage.pageProps[trackingId])) {
         currentPage.pageProps[trackingId] = {};
       }
-      if (isEmpty(currentPage.pageProps[trackingId][currentPage.path])) {
-        currentPage.pageProps[trackingId][currentPage.path] = {};
+      if (isEmpty(currentPage.pageProps[trackingId][path])) {
+        currentPage.pageProps[trackingId][path] = {};
       }
       // 结果合并，动态属性不作处理
       if (!isEmpty(properties)) {
         forEach(properties, (v, k) => {
           if (
-            !isFunction(
-              currentPage.pageProps[trackingId][currentPage.path][k]
-            ) ||
+            !isFunction(currentPage.pageProps[trackingId][path][k]) ||
             isFunction(v)
           ) {
-            currentPage.pageProps[trackingId][currentPage.path][k] = v;
+            currentPage.pageProps[trackingId][path][k] = v;
           }
         });
       }
@@ -244,15 +243,13 @@ class GrowingIO implements GrowingIOType {
         !isEmpty(this.dataStore.eventHooks.currentPage.pageProps[trackingId])
       ) {
         const { currentPage } = this.dataStore.eventHooks;
+        const path = currentPage.getPagePath();
         if (isArray(properties) && !isEmpty(properties)) {
           properties.forEach((propName: string) => {
-            unset(
-              currentPage.pageProps[trackingId][currentPage.path],
-              propName
-            );
+            unset(currentPage.pageProps[trackingId][path], propName);
           });
         } else {
-          currentPage.pageProps[trackingId][currentPage.path] = {};
+          currentPage.pageProps[trackingId][path] = {};
         }
       }
     } catch (error) {
@@ -319,9 +316,9 @@ class GrowingIO implements GrowingIOType {
       // 该方法很可能被放在在app的onShow中的wx.login异步回调中，
       // 此时页面的path和query可能还没取到，就拿visit事件的path和query补上
       if (!event.path) {
-        event.path = lastVisitEvent.path;
-        event.query = lastVisitEvent.query;
-        event.title = lastVisitEvent.title;
+        event.path = lastVisitEvent[trackingId]?.path;
+        event.query = lastVisitEvent[trackingId]?.query;
+        event.title = lastVisitEvent[trackingId]?.title;
       }
       eventInterceptor(event);
     } else {
@@ -348,14 +345,7 @@ class GrowingIO implements GrowingIOType {
       // 切换userId时重置session并补发visit
       if (prevId && prevId !== userId) {
         this.userStore.setSessionId(trackingId);
-        const { path, query, settedTitle } =
-          this.dataStore.eventHooks.currentPage;
-        // 重新获取页面title，防止切换配置前修改了title没取到
-        this.dataStore.eventHooks.currentPage.title =
-          settedTitle[path] ||
-          this.minipInstance.getPageTitle(this.minipInstance.getCurrentPage());
-        // visit取当前页面值
-        this.dataStore.sendVisit(trackingId, { path, query });
+        this.dataStore.sendVisit(trackingId);
       }
     } else {
       callError('setUserId');
@@ -611,7 +601,9 @@ class GrowingIO implements GrowingIOType {
     if (!isEmpty(extraParams)) {
       extraParams.forEach((o) => {
         if (!ignoreFields.includes(o)) {
-          infos[`gio${o}`] = this.dataStore.lastVisitEvent[o];
+          infos[`gio${o}`] = (this.dataStore.lastVisitEvent[trackingId] ?? {})[
+            o
+          ];
         }
       });
     }

package/src/index.ts

@@ -62,16 +62,16 @@ const gdp = function () {
 getGlobal().gdp = gdp;
 getGlobal().gioSDKVersion = gioInstance.sdkVersion;
 
-export const GioApp = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingApp ?? App
-);
-export const GioPage = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingPage ?? Page
-);
-export const GioComponent = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingComponent ?? Component
-);
-export const GioBehavior = niceTry(
-  () => gioInstance.dataStore.eventHooks.growingBehavior ?? Behavior
-);
+const {
+  growingApp,
+  growingPage,
+  growingComponent,
+  growingBehavior,
+  initOriginalValue
+} = gioInstance.dataStore.eventHooks;
+initOriginalValue();
+export const GioApp = niceTry(() => growingApp ?? App);
+export const GioPage = niceTry(() => growingPage ?? Page);
+export const GioComponent = niceTry(() => growingComponent ?? Component);
+export const GioBehavior = niceTry(() => growingBehavior ?? Behavior);
 export default gdp;

package/src/minipInstance/base.ts

@@ -7,7 +7,14 @@ import {
   SystemInfo
 } from '@@/types/minipInstance';
 import { PLATFORMS } from '@@/types/platforms';
-import { isFunction, isObject, isString, last } from '@@/utils/glodash';
+import {
+  isFunction,
+  isObject,
+  isString,
+  last,
+  typeOf,
+  isEmpty
+} from '@@/utils/glodash';
 import EMIT_MSG from '@@/constants/emitMsg';
 import {
   limitString,
@@ -126,38 +133,58 @@ class BaseInstance implements MinipInstanceType {
 
   // 获取页面标题
   getPageTitle = (page) => {
+    const platform = getPlainPlatform();
     let title = '';
-    const instConfig = getPlainConfig(getPlainPlatform());
-    try {
-      // 第一优先级在base中的hook setNavigationBarTitle设置的值
-      // 第二优先级支持客户自己在页面中设置页面title
-      const data = page?.data || page.$data || {};
-      title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
-      // 第三优先级取页面的navigationBarTitleText
-      if (title.length === 0) {
-        const pageInfo =
-          instConfig.page[page.route] || instConfig.page[`${page.route}.html`];
-        if (pageInfo) {
-          title = pageInfo.window.navigationBarTitleText;
-        } else {
-          title = instConfig.global.window.navigationBarTitleText;
-        }
+    let instConfig = getPlainConfig(platform);
+    if (typeOf(instConfig) === 'string') {
+      instConfig = niceTry(() => JSON.parse(instConfig)) ?? {};
+    }
+    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现)
+    // 第二优先级支持客户自己在页面中设置页面title
+    const data = page?.data || page.$data || {};
+    title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
+    if (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);
       }
-      // 第四优先级取tabBar配置
-      if (title.length === 0) {
-        const tabPage = instConfig?.tabBar?.list?.find((p) => {
-          return (
-            p.pagePath === page.route || p.pagePath === `${page.route}.html`
-          );
-        });
-        title = tabPage?.text || '';
+      // 第四优先级取页面的navigationBarTitleText
+      niceTry(() => {
+        if (!title) {
+          const instPage = instConfig.page || {};
+          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;
+          }
+        }
+      });
+      // 第五优先级取tabBar配置
+      if (!title) {
+        title = this._getTitleFromTabbar(instConfig, page.route);
       }
-    } catch (e) {
-      return '';
     }
     return limitString(title);
   };
 
+  private _getTitleFromTabbar = (
+    instConfig: any,
+    pageRoute: string
+  ): string => {
+    const tabPage = instConfig?.tabBar?.list?.find((p) => {
+      return p.pagePath === pageRoute || p.pagePath === `${pageRoute}.html`;
+    });
+    return tabPage?.text || '';
+  };
+
   /**
    * 存储相关
    */

package/src/minipInstance/my.ts

@@ -48,6 +48,11 @@ class Alipay extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Alipay;

package/src/minipInstance/tb.ts

@@ -48,6 +48,11 @@ class Taobao extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Taobao;

package/src/types/eventHooks.ts

@@ -76,16 +76,15 @@ export interface PageShareResult {
 }
 
 export interface MinipPageType {
-  path: string;
-  time: number;
-  query: any;
+  queryOption: any;
   settedTitle: any;
-  title: string;
   pageProps: any;
   lastLifecycle: string;
   currentLifecycle: string;
-  parsePage: (page: any, query: any) => void;
-  getQuery: (query: any) => string;
+  getPagePath: () => string;
+  getPageQeury: () => string;
+  getPageTitle: (trackingId?: string) => string;
+  qsQuery: (query: any) => string;
   getReferralPage: (trackingId: string) => string;
   buildShareQuery: (result: PageShareResult) => [string, string];
   updateAppMessageResult: (result: PageShareResult) => PageShareResult;
@@ -110,8 +109,7 @@ export interface EventHooksType {
   supLifeFcs: (target: any, type: 'app' | 'page') => void;
   // 对象的遍历
   objectTraverse: (target: any, fn: any) => any;
-  // 初始化无埋点
-  initEventHooks: () => void;
+
   // 生命周期方法effects
   lifeFcEffects: (eventName: string, method: any, cType: 'App' | 'Page') => any;
   // 自定义方法effects
@@ -140,4 +138,8 @@ export interface EventHooksType {
   growingBehavior: (behavior: any) => any;
   // 对原生的重写方法
   nativeGrowing: (designated?: string[]) => void;
+  // 初始化原始值
+  initOriginalValue: () => void;
+  // 初始化事件钩子
+  initEventHooks: () => void;
 }

package/src/utils/tools.ts

@@ -16,6 +16,7 @@ import {
   split,
   startsWith,
   toString,
+  typeOf,
   unset
 } from '@@/utils/glodash';
 
@@ -239,11 +240,15 @@ export const getPlainConfig = (platform?: string) => {
       case 'swan':
         return appConfig;
       case 'tt':
-        return __ttConfig;
+        return (
+          niceTry(() => __ttConfig) ||
+          global?.TMAConfig ||
+          globalThis?.TMAConfig
+        ); // 可能会拿不到
       case 'qq':
         return __qqConfig;
       case 'ks':
-        return __ksConfig;
+        return __ksConfig; // 新版快手小程序已经拿不到了
       case 'jd':
         return __jdConfig;
       // 第三方框架下自动获取实例
@@ -296,7 +301,10 @@ export const getAppInst = () => {
 };
 
 export const getGlobal = () => {
-  return niceTry(() => $global) ?? global;
+  return (
+    niceTry(() => niceTry(() => niceTry(() => $global) ?? global) ?? window) ??
+    globalThis
+  );
 };
 
 // Object参数限制
@@ -407,3 +415,14 @@ export const hashCode = (string: string, abs = false) => {
   }
   return abs ? Math.abs(hash) : hash;
 };
+
+// 获取额外的启动参数并合并进query
+export const getLaunchQuery = (originQuery: any = {}, extraData: any = {}) => {
+  const validData = {};
+  keys(extraData).forEach((k: string) => {
+    if (['string', 'number', 'boolean'].includes(typeOf(extraData[k]))) {
+      validData[k] = extraData[k];
+    }
+  });
+  return Object.assign({}, validData, originQuery);
+};