gio-miniprogram-sdk 4.0.1 → 4.2.0

package/src/core/userStore.ts

@@ -1,6 +1,9 @@
+import { batchGetStorageSync, batchSetStorageSync, guid } from '@@/utils/tools';
 import { GrowingIOType } from '@@/types/growingIO';
+import { isNil } from '@@/utils/glodash';
+import { StringObject } from '@@/types/base';
 import { UserStoreType } from '@@/types/userStore';
-import { batchGetStorageSync, batchSetStorageSync, guid } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
 
 /**
  * 代码中与3.0测量协议字段对应关系
@@ -13,190 +16,226 @@ import { batchGetStorageSync, batchSetStorageSync, guid } from '@@/utils/tools';
  */
 
 class UserStore implements UserStoreType {
-  // 访问用户id在存储中的名称
-  public uidStorageName: string;
-  // 登录用户id在存储中的名称
-  public userIdStorageName: string;
-  // 登录用户key在存储中的名称
-  public userKeyStorageName: string;
-  // 最后一次登录用户id在存储中的名称
-  public gioIdStorageName: string;
-  // 用户访问会话id
-  public _sessionId: string;
-  // 访问用户id（系统设置持久性存储）
+  // 访问用户id/设备id（系统设置持久性存储）
   public _uid: string;
+  // 用户访问会话id
+  public _sessionId: StringObject;
   // 登录用户id（客户设置持久性存储）
-  public _userId: string;
+  public _userId: StringObject;
   // 登录用户key（客户设置持久性存储）
-  public _userKey: string;
+  public _userKey: StringObject;
   // 最后一次登录用户id（持久性存储）
-  public _gioId: string;
+  public _gioId: StringObject;
   constructor(public growingIO: GrowingIOType) {
-    const { inPlugin } = this.growingIO;
-    this.uidStorageName = inPlugin ? '_growing_plugin_uid_' : '_growing_uid_';
-    this.userIdStorageName = inPlugin
-      ? '_growing_plugin_userId_'
-      : '_growing_userId_';
-    this.userKeyStorageName = inPlugin
-      ? '_growing_plugin_userKey_'
-      : '_growing_userKey_';
-    this.gioIdStorageName = inPlugin
-      ? '_growing_plugin_gioId_'
-      : '_growing_gioId_';
-    this._sessionId = guid();
     this._uid = undefined;
-    this._userId = undefined;
-    this._userKey = undefined;
-    this._gioId = undefined;
-    if (this.growingIO?.gioPlatform !== 'quickapp') {
-      this.initUserInfo();
-    }
+    this._sessionId = {};
+    this._userId = {};
+    this._userKey = {};
+    this._gioId = {};
   }
 
-  // @ts-ignore
-  get sessionId() {
-    if (!this._sessionId) {
-      this._sessionId = guid();
-    }
-    return this._sessionId;
-  }
+  // 获取sessionId存储key
+  _getUidKey = () =>
+    this.growingIO.inPlugin ? '_growing_plugin_uid_' : '_growing_uid_';
 
-  // @ts-ignore
-  set sessionId(id: string) {
-    const prevId = this._sessionId;
-    if (!id) {
-      this._sessionId = guid();
-    } else {
-      this._sessionId = id;
+  // 获取设备Id
+  getUid = () => {
+    const { minipInstance } = this.growingIO;
+    // 内存中拿不到尝试从存储中拿
+    if (!this._uid) {
+      this._uid = minipInstance.getStorageSync(this._getUidKey());
     }
-    // 广播通知登录sessionId变更
-    if (prevId !== this._sessionId) {
-      this.growingIO.emitter.emit('SESSIONID_UPDATE', {
-        newSessionId: this._sessionId,
-        oldSessionId: prevId
-      });
+    // 存储中拿不到尝试设新值
+    if (!this._uid) {
+      this._uid = guid();
+      minipInstance.setStorage(this._getUidKey(), this._uid);
     }
-  }
-
-  // @ts-ignore
-  get uid() {
     return this._uid;
-  }
+  };
 
-  // @ts-ignore
-  set uid(id: string) {
+  // 设置设备Id
+  setUid = (id: string) => {
     const prevId = this._uid;
     this._uid = id;
     if (prevId !== this._uid) {
-      this.growingIO.minipInstance.setStorage(this.uidStorageName, this._uid);
+      this.growingIO.minipInstance.setStorage(this._getUidKey(), this._uid);
       // 广播通知访问用户Id变更
-      this.growingIO.emitter.emit('UID_UPDATE', {
+      this.growingIO.emitter.emit(EMIT_MSG.UID_UPDATE, {
         newUId: id,
         oldUId: prevId
       });
     }
-  }
+  };
 
-  // @ts-ignore
-  get userId() {
-    return this._userId;
-  }
+  // 获取sessionId
+  getSessionId = (trackingId: string) => {
+    if (!this._sessionId[trackingId]) {
+      this.setSessionId(trackingId);
+    }
+    return this._sessionId[trackingId];
+  };
 
-  // @ts-ignore
-  set userId(id: string) {
-    const prevId = this._userId;
-    this._userId = id;
-    if (prevId !== this._userId) {
+  // 设置sessionId
+  setSessionId = (trackingId: string, id?: string) => {
+    const prevId = this._sessionId[trackingId];
+    if (!id) {
+      id = guid();
+    }
+    // 小程序中sessionId只需要在内存中存储就可以，不需要持久化存储
+    this._sessionId[trackingId] = id;
+    // 广播通知登录sessionId变更
+    if (prevId !== id) {
+      this.growingIO.emitter.emit(EMIT_MSG.SESSIONID_UPDATE, {
+        newSessionId: id,
+        oldSessionId: prevId
+      });
+    }
+  };
+
+  // 获取userId存储key
+  _getUserIdKey = (trackingId: string) =>
+    this.growingIO.dataStore.getStorageKey(trackingId, 'userId');
+
+  // 获取userId
+  getUserId = (trackingId: string) => {
+    const { minipInstance } = this.growingIO;
+    // 内存中拿不到尝试从存储中拿
+    if (!this._userId[trackingId]) {
+      this._userId[trackingId] = minipInstance.getStorageSync(
+        this._getUserIdKey(trackingId)
+      );
+    }
+    return this._userId[trackingId];
+  };
+
+  // 设置userId
+  setUserId = (trackingId: string, id: string) => {
+    const prevId = this._userId[trackingId];
+    this._userId[trackingId] = isNil(id) ? '' : id;
+    if (prevId !== this._userId[trackingId]) {
       this.growingIO.minipInstance.setStorage(
-        this.userIdStorageName,
-        this._userId
+        this._getUserIdKey(trackingId),
+        this._userId[trackingId]
       );
       // 广播通知登录用户Id变更
-      this.growingIO.emitter.emit('USERID_UPDATE', {
+      this.growingIO.emitter.emit(EMIT_MSG.USERID_UPDATE, {
         newUserId: id,
         oldUserId: prevId
       });
     }
-    if (id) this.gioId = id;
-  }
+    if (id) this.setGioId(trackingId, id);
+  };
 
-  // @ts-ignore
-  get userKey() {
-    return this._userKey;
-  }
+  // 获取userKey存储key
+  _getUserKeyKey = (trackingId: string) =>
+    this.growingIO.dataStore.getStorageKey(trackingId, 'userKey');
 
-  // @ts-ignore
-  set userKey(key: string) {
-    const prevKey = this._userKey;
-    this._userKey = key;
-    if (prevKey !== this._userKey) {
+  // 获取userKey
+  getUserKey = (trackingId: string) => {
+    const { minipInstance } = this.growingIO;
+    // 内存中拿不到尝试从存储中拿
+    if (!this._userKey[trackingId]) {
+      this._userKey[trackingId] = minipInstance.getStorageSync(
+        this._getUserKeyKey(trackingId)
+      );
+    }
+    return this._userKey[trackingId];
+  };
+
+  // 设置userKey
+  setUserKey = (trackingId: string, key: string) => {
+    const prevKey = this._userKey[trackingId];
+    this._userKey[trackingId] = isNil(key) ? '' : key;
+    if (prevKey !== this._userKey[trackingId]) {
       this.growingIO.minipInstance.setStorage(
-        this.userKeyStorageName,
-        this._userKey
+        this._getUserKeyKey(trackingId),
+        this._userKey[trackingId]
       );
       // 广播通知登录用户key变更
-      this.growingIO.emitter.emit('USERKEY_UPDATE', {
+      this.growingIO.emitter.emit(EMIT_MSG.USERKEY_UPDATE, {
         newUserKey: key,
         oldUserKey: prevKey
       });
     }
-  }
+  };
 
-  // @ts-ignore
-  get gioId() {
-    return this._gioId;
-  }
+  // 获取gioId存储key
+  _getGioIdKey = (trackingId: string) =>
+    this.growingIO.dataStore.getStorageKey(trackingId, 'gioId');
 
-  // @ts-ignore
-  set gioId(gioId: string) {
-    const prevId = this._gioId;
-    this._gioId = gioId;
-    if (prevId !== this._gioId) {
+  // 获取gioId
+  getGioId = (trackingId: string) => {
+    const { minipInstance } = this.growingIO;
+    // 内存中拿不到尝试从存储中拿
+    if (!this._gioId[trackingId]) {
+      this._gioId[trackingId] = minipInstance.getStorageSync(
+        this._getGioIdKey(trackingId)
+      );
+    }
+    return this._gioId[trackingId];
+  };
+
+  // 设置gioId
+  setGioId = (trackingId: string, gioId: string) => {
+    const prevId = this._gioId[trackingId];
+    this._gioId[trackingId] = isNil(gioId) ? '' : gioId;
+    if (prevId !== this._gioId[trackingId]) {
       this.growingIO.minipInstance.setStorage(
-        this.gioIdStorageName,
-        this._gioId
+        this._getGioIdKey(trackingId),
+        this._gioId[trackingId]
       );
       // 广播通知登录用户Id变更
-      this.growingIO.emitter.emit('GIOID_UPDATE', {
+      this.growingIO.emitter.emit(EMIT_MSG.GIOID_UPDATE, {
         newGioId: gioId,
         oldGioId: prevId
       });
     }
-  }
+  };
 
   // 初始化用户信息
-  initUserInfo = () => {
+  initUserInfo = (trackingId: string) => {
     const { minipInstance } = this.growingIO;
     const storeKeys = [
-      this.uidStorageName,
-      this.userIdStorageName,
-      this.userKeyStorageName,
-      this.gioIdStorageName
+      this._getUidKey(),
+      this._getUserIdKey(trackingId),
+      this._getUserKeyKey(trackingId),
+      this._getGioIdKey(trackingId)
     ];
     const memoryKeys = ['_uid', '_userId', '_userKey', '_gioId'];
     // 批量获取的存储数据
     const values = batchGetStorageSync(minipInstance, storeKeys) ?? [];
     // 往存储中重设的key
     memoryKeys.forEach((key: string, index: number) => {
-      // 往内存中赋值
-      this[key] = values[index];
-      // 如果uid没有值，则自动生成并赋值（这种情况是用户第一次进或者清了缓存）
-      if (key === '_uid' && !this[key]) {
-        // this.uid会自动给内存和存储都赋值
-        this.uid = guid();
+      if (key === '_uid') {
+        // 调用一次往内存里存一份
+        this.getUid();
+      } else {
+        // 往内存中赋值
+        this[key][trackingId] = values[index];
       }
     });
   };
 
   // 退出小程序时在存储中同步用户信息
   saveUserInfo = () => {
-    const { minipInstance } = this.growingIO;
-    batchSetStorageSync(minipInstance, [
-      { key: this.uidStorageName, value: this.uid },
-      { key: this.userIdStorageName, value: this.userId },
-      { key: this.userKeyStorageName, value: this.userKey },
-      { key: this.gioIdStorageName, value: this.gioId }
-    ]);
+    const {
+      minipInstance,
+      dataStore: { trackersExecute }
+    } = this.growingIO;
+    trackersExecute((trackingId: string) => {
+      batchSetStorageSync(minipInstance, [
+        { key: this._getUidKey(), value: this._uid },
+        {
+          key: this._getUserIdKey(trackingId),
+          value: this._userId[trackingId]
+        },
+        {
+          key: this._getUserKeyKey(trackingId),
+          value: this._userKey[trackingId]
+        },
+        { key: this._getGioIdKey(trackingId), value: this._gioId[trackingId] }
+      ]);
+    });
   };
 }
 

package/src/index.ts

@@ -1,52 +1,61 @@
-import {
-  initPreCheck,
-  paramExtraCheck,
-  paramsBaseCheck,
-  paramsEmptyCheck
-} from '@@/utils/verifiers';
+import { initialCheck } from '@@/utils/verifiers';
 import { consoleText, getGlobal, niceTry } from '@@/utils/tools';
 import { drop, isString, toString } from '@@/utils/glodash';
-import { HANDLERS, DEPRECATED_HANDLERS } from '@@/constants/config';
+import {
+  HANDLERS,
+  DEPRECATED_HANDLERS,
+  INSTANCE_HANDLERS
+} from '@@/constants/config';
 import GrowingIO from './core/growingIO';
 
 const gioInstance: any = new GrowingIO();
 
 const gdp = function () {
-  const actionName = arguments[0];
+  const handlerName = arguments[0];
+  let trackingId = 'g0';
+  let handler = handlerName;
+  if (handlerName.indexOf('.') > -1) {
+    trackingId = handlerName.split('.')[0] ?? 'g0'; // 没有指定trackingId，默认为g0
+    handler = handlerName.split('.')[1];
+  }
   // 判断指令为字符串且配置项中允许调用且实例中存在的方法
-  if (
-    isString(actionName) &&
-    HANDLERS.includes(actionName) &&
-    gioInstance[actionName]
-  ) {
+  if (isString(handler) && HANDLERS.includes(handler) && gioInstance[handler]) {
     const args = drop(Array.from(arguments));
     // 初始化方法单独处理
-    if (actionName === 'init') {
-      const preCheckRes = initPreCheck(gioInstance);
-      const emptyCheckRes = paramsEmptyCheck(args);
-      const baseCheckRes = paramsBaseCheck(args);
-      const extraCheckRes = paramExtraCheck(args);
-      if (preCheckRes && emptyCheckRes && baseCheckRes && extraCheckRes) {
-        const { projectId } = baseCheckRes;
-        const { dataSourceId, appId, options } = extraCheckRes;
+    if (handler === 'init') {
+      const initialCheckRes: any = initialCheck(gioInstance, args);
+      if (initialCheckRes) {
+        const { projectId, dataSourceId, appId, userOptions } = initialCheckRes;
+        // 返回初始化结果
         return gioInstance.init({
-          ...options,
+          ...userOptions,
           projectId,
           dataSourceId,
-          appId
+          appId,
+          trackingId
         });
+      } else {
+        return false;
       }
-    } else if (actionName === 'registerPlugins') {
+    } else if (handler === 'registerPlugins') {
       gioInstance.registerPlugins(args[0]);
     } else if (gioInstance.gioSDKInitialized && gioInstance.vdsConfig) {
-      return gioInstance[actionName](...args);
+      if (INSTANCE_HANDLERS.includes(handler)) {
+        return niceTry(() =>
+          gioInstance.handlerDistribute(trackingId, handler, args)
+        );
+      } else {
+        return niceTry(() => gioInstance[handler](...args));
+      }
     } else {
       consoleText('SDK未初始化!', 'error');
     }
-  } else if (DEPRECATED_HANDLERS.includes(actionName)) {
-    consoleText(`方法 ${toString(actionName)} 已被弃用!`, 'warn');
+  } else if (DEPRECATED_HANDLERS.includes(handler)) {
+    consoleText(`方法 ${toString(handler)} 已被弃用，请移除!`, 'warn');
+  } else if (handler === 'canIUse') {
+    return HANDLERS.includes(arguments[1]) && !!gioInstance[arguments[1]];
   } else {
-    consoleText(`不存在名为 ${toString(actionName)} 的方法调用!`, 'error');
+    consoleText(`不存在名为 ${toString(handler)} 的方法调用!`, 'error');
   }
 };
 

package/src/minipInstance/base.ts

@@ -8,6 +8,7 @@ import {
 } from '@@/types/minipInstance';
 import { PLATFORMS } from '@@/types/platforms';
 import { isFunction, isObject, isString, last } from '@@/utils/glodash';
+import EMIT_MSG from '@@/constants/emitMsg';
 import {
   limitString,
   niceTry,
@@ -32,7 +33,7 @@ class BaseInstance implements MinipInstanceType {
     } = this.growingIO;
     this.platform = platform;
     this.scnPrefix = scnPrefix;
-    this.growingIO.emitter.on('OPTION_INITIALIZED', () => {
+    this.growingIO.emitter.on(EMIT_MSG.OPTION_INITIALIZED, () => {
       this.getNetworkType().then(() =>
         this.growingIO.dataStore?.eventReleaseInspector()
       );

package/src/minipInstance/quickapp.ts

@@ -1,9 +1,11 @@
 import { GrowingIOType } from '@@/types/growingIO';
-import { SystemInfo } from '@@/types/minipInstance';
 import { isString, last } from '@@/utils/glodash';
 import { limitString } from '@@/utils/tools';
+import { SystemInfo } from '@@/types/minipInstance';
 import app from '@system.app';
+import BaseImplements from './base';
 import device from '@system.device';
+import EMIT_MSG from '@@/constants/emitMsg';
 import fetch from '@system.fetch';
 import image from '@system.image';
 import network from '@system.network';
@@ -11,12 +13,10 @@ import router from '@system.router';
 import share from '@system.share';
 import storage from '@system.storage';
 
-import BaseImplements from './base';
-
 class QuickApp extends BaseImplements {
   constructor(public growingIO: GrowingIOType) {
     super(growingIO);
-    this.growingIO.emitter.on('minipLifecycle', ({ event }) => {
+    this.growingIO.emitter.on(EMIT_MSG.MINIP_LIFECYCLE, ({ event }) => {
       switch (event) {
         case 'App onCreate':
           {
@@ -76,24 +76,10 @@ class QuickApp extends BaseImplements {
 
   // 初始化分享
   initShareAppMessage = (growingIO: GrowingIOType) => {
-    const { vdsConfig, platformConfig } = growingIO;
+    const { platformConfig } = growingIO;
     try {
       this.growingIO.shareAppMessage = function () {
         const params = arguments[0];
-        if (
-          params &&
-          params.type &&
-          !/^text.*/.test(params.type) &&
-          params.data
-        ) {
-          if (vdsConfig.followShare) {
-            if (params.data.indexOf('?') === -1) {
-              params.data = params.data + '?suid=' + growingIO.userStore.uid;
-            } else {
-              params.data = params.data + '&suid=' + growingIO.userStore.uid;
-            }
-          }
-        }
         share?.share(params);
         growingIO?.eventTracking?.pageEffects(
           this,

package/src/platformConfig/base.ts

@@ -1,5 +1,4 @@
 import { PlatformConfigType } from '@@/types/platforms';
-import { niceTry } from '@@/utils/tools';
 
 const Config: PlatformConfigType = {
   scnPrefix: '',
@@ -40,10 +39,6 @@ const Config: PlatformConfigType = {
     'contact',
     'mouseup'
   ],
-  originalApp: niceTry(() => App),
-  originalPage: niceTry(() => Page),
-  originalComponent: niceTry(() => Component),
-  originalBehavior: niceTry(() => Behavior),
   canHook: true,
   hooks: {
     App: true,