gio-miniprogram-sdk 4.0.0

package/rollup.config.js

@@ -0,0 +1,92 @@
+// @ts-nocheck
+import { babel } from '@rollup/plugin-babel';
+import { version } from './package.json';
+import alias from '@rollup/plugin-alias';
+import commonjs from '@rollup/plugin-commonjs';
+import filesize from 'rollup-plugin-filesize';
+import path from 'path';
+import replace from '@rollup/plugin-replace';
+import resolve from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+import typescript from '@rollup/plugin-typescript';
+
+const processENV = process.argv[process.argv.length - 1]
+  .split('-')
+  .filter((o) => o);
+
+const platform = processENV[0];
+const frameName = processENV[1];
+const PLATFORMS = {
+  wx: 'wechat',
+  my: 'alipay',
+  swan: 'baidu',
+  tt: 'bytedance',
+  qq: 'qq',
+  ks: 'kuaishou',
+  tb: 'taobao',
+  jd: 'jingdong',
+  quickapp: 'quickapp'
+};
+
+// 控制台打印当前打包的环境和小程序平台
+console.log(
+  `Packaging ${
+    PLATFORMS[platform]
+      ? 'platform：' + PLATFORMS[platform]
+      : 'framework：' + frameName
+  }`
+);
+
+const fileName = () => {
+  let n = 'dist/';
+  n += PLATFORMS[platform] ?? frameName;
+  n += '.js';
+  return n;
+};
+
+const config = {
+  input: 'src/index.ts',
+  output: {
+    file: fileName(),
+    format: 'es'
+  },
+  plugins: [
+    replace({
+      __SDK_VERSION__: version,
+      __GIO_PLATFORM__: PLATFORMS[platform] ? platform : 'framework',
+      __GIO_FRAMEWORK__: PLATFORMS[platform] ? 'native' : frameName,
+      __GIO_PLATFORM_CONFIG__: `@@/platformConfig/${platform}.ts`,
+      __GIO_PLATFORM_INSTANCE__: `@@/minipInstance/${platform}.ts`
+    }),
+    alias({
+      entries: {
+        '@@': path.resolve(__dirname, 'src')
+      }
+    }),
+    resolve(),
+    commonjs({ extensions: ['.js', '.ts'] }),
+    typescript(),
+    babel({
+      babelHelpers: 'bundled',
+      exclude: 'node_modules/**',
+      extensions: ['.ts', '.js', '.json']
+    }),
+    terser({
+      ecma: 'es6',
+      format: { comments: false },
+      compress: {
+        passes: 2,
+        unsafe: true,
+        unsafe_comps: true,
+        unsafe_proto: true,
+        unsafe_undefined: true
+      }
+    }),
+    filesize({
+      showMinifiedSize: false,
+      showGzippedSize: false
+    })
+  ]
+};
+
+export default config;

package/rollup.plugins.config.js

@@ -0,0 +1,76 @@
+// @ts-nocheck
+import { babel } from '@rollup/plugin-babel';
+import alias from '@rollup/plugin-alias';
+import commonjs from '@rollup/plugin-commonjs';
+import filesize from 'rollup-plugin-filesize';
+import path from 'path';
+import resolve from '@rollup/plugin-node-resolve';
+import terser from '@rollup/plugin-terser';
+import typescript from '@rollup/plugin-typescript';
+
+const fs = require('fs');
+
+const processENV = process.argv[process.argv.length - 1]
+  .split('-')
+  .filter((o) => o);
+// 获取是否打包全量插件
+const folder = processENV[0] ?? 'all';
+
+const expls = [];
+const plgs = fs.readdirSync(`./src/pluginsOut/${folder}`);
+plgs.forEach((plg) => {
+  if (plg && plg.endsWith('.ts') && plg !== 'gioCustomTracking.ts') {
+    const outName = plg.split('.')[0];
+    expls.push({
+      input: `${folder}/${plg}`,
+      output: `${folder === 'ordinary' ? 'plugins/' : folder + '/'
+        }${outName}.js`,
+      name: `${outName}.js`
+    });
+  }
+});
+
+const configs = [];
+const configGenerat = ({ input, output, name }) => ({
+  input: `src/pluginsOut/${input}`,
+  output: {
+    file: `dist/${output}`,
+    format: 'es',
+    name
+  },
+  plugins: [
+    alias({
+      entries: {
+        '@@': path.resolve(__dirname, 'src')
+      }
+    }),
+    resolve(),
+    commonjs({ extensions: ['.js', '.ts'] }),
+    typescript({ target: 'ES5' }),
+    babel({
+      babelHelpers: 'bundled',
+      exclude: 'node_modules/**',
+      extensions: ['.ts']
+    }),
+    terser({
+      ecma: 'es5',
+      format: { comments: false },
+      compress: {
+        passes: 2,
+        unsafe: true,
+        unsafe_comps: true,
+        unsafe_proto: true,
+        unsafe_undefined: true
+      }
+    }),
+    filesize({
+      showMinifiedSize: false,
+      showGzippedSize: false
+    })
+  ]
+});
+expls.forEach((o) => {
+  if (o) configs.push(configGenerat(o));
+});
+
+export default configs;

package/src/constants/config.ts

@@ -0,0 +1,136 @@
+// SDK系统的默认配置项
+export const DEFAULT_SETTINGS = {
+  // 是否开启无埋点
+  autotrack: { type: 'boolean', default: true },
+  // 是否开启加密压缩
+  compress: { type: 'boolean', default: true },
+  // 是否开启数据采集
+  dataCollect: { type: 'boolean', default: true },
+  // 是否开启调试模式
+  debug: { type: 'boolean', default: false },
+  // 是否开启
+  idMapping: { type: 'boolean', default: false },
+  enableIdMapping: { type: 'boolean', default: false },
+  // 与内嵌页打通时额外的信息参数
+  extraParams: { type: 'array', default: [] },
+  // 是否开启分享跟踪
+  followShare: { type: 'boolean', default: true },
+  // 是否开启强制登录
+  forceLogin: { type: 'boolean', default: false },
+  // 或略上报字段
+  ignoreFields: { type: 'array', default: [] },
+  // 是否开启强制插件模式
+  pluginMode: { type: 'boolean', default: false },
+  // 是否使用原始来源信息作为访问事件的参数上报
+  originalSource: { type: 'boolean', default: true },
+  // session保活时长（5分钟）
+  keepAlive: { type: 'number', default: 300000 },
+  // 性能采集配置
+  performance: { type: 'object', default: { monitor: true, exception: true } },
+  // 数据上报域名
+  serverUrl: { type: 'string', default: 'https://napi.growingio.com' },
+  // 是否标记为分包
+  subpackage: { type: 'boolean', default: false },
+  // taro框架实例
+  taro: { type: ['object', 'module'], default: false },
+  // taro框架vue实例
+  taroVue: { type: ['object', 'function'], default: false },
+  // 淘宝小程序/小部件配置
+  tbConfig: {
+    type: 'object',
+    default: {
+      cloud: undefined,
+      cloudFuncSend: false,
+      cloudFuncName: 'httpTunnel',
+      cloudFuncHandler: 'main',
+      cloudAppId: undefined,
+      path: undefined
+    }
+  },
+  // uniapp vue实例
+  uniVue: { type: ['object', 'function'], default: false },
+  // 上报间隔（1秒）
+  uploadInterval: { type: 'number', default: 1000 },
+  // 小程序应用版本
+  version: { type: 'string', default: '1.0.0' }
+};
+
+// 通过gdp(xxxx)允许调用的通用方法
+export const HANDLERS = [
+  'clearGeneralProps', // 移除埋点通用属性
+  'clearTrackTimer', // 清除所有事件计时器
+  'clearUserId', // 清除登录用户ID
+  'getDeviceId', // 获取设备ID（匿名用户ID）
+  'getGioInfo', // 内嵌页打通信息
+  'getOption', // 获取当前配置项状态
+  'identify', // 强制登录
+  'init', // 初始化SDK
+  'registerPlugins', // 手动注册插件
+  'removeTimer', // 移除事件计时器
+  'setGeneralProps', // 设置埋点通用属性
+  'setLocation', // 手动设置位置信息（2022/4/29新增api，原getLocation废弃）
+  'setOption', // 动态修改配置项
+  'setPageAttributes', // 设置页面属性
+  'setUserAttributes', // 设置用户属性
+  'setUserId', // 设置登录用户ID
+  'track', // 埋点
+  'trackTimerEnd', // 停止事件计时器并上报事件
+  'trackTimerPause', // 暂停事件计时器
+  'trackTimerResume', // 恢复事件计时器
+  'trackTimerStart', // 初始化事件计时器
+  'updateImpression', // 手动更新曝光监听
+  'getABTest' // 获取ABTest数据
+];
+
+// 允许通过setOption修改的配置项
+export const ALLOWED_MODIFY_OPTIONS = {
+  autotrack: '无埋点',
+  dataCollect: '数据采集',
+  debug: '调试模式',
+  serverUrl: '数据上报服务地址'
+};
+
+// 已废弃方法
+export const DEPRECATED_HANDLERS = [
+  'enableDebug', // 4.0废弃
+  'setAutotrack', // 4.0废弃
+  'setDataCollect', // 4.0废弃
+  'setTrackerHost', // 4.0废弃
+  'setTrackerScheme', // 4.0废弃
+  'setConfig', // 3.8重构时废弃，原因：太多的客户以为是修改配置的接口导致用错
+  'collectImp', // 3.8重构时废弃，原因：重构时在页面onShow/onReady是自动注册
+  'setPlatformProfile', // 3.8重构时废弃，原因：使用setUserAttributes代替
+  'getLocation' // 2022/4/29废弃，原因：https://developers.weixin.qq.com/community/develop/doc/000e8ccb5ac498318cbd26c495bc01 ；https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html
+];
+
+// 允许忽略的上报字段
+export const IGNORE_PARAMS = [
+  'deviceBrand',
+  'deviceModel',
+  'deviceType',
+  'networkState',
+  'screenHeight',
+  'screenWidth',
+  'operatingSystem'
+];
+
+// 额外打通的字段
+export const EXTRA_INFO_PARAMS: string[] = [
+  ...IGNORE_PARAMS,
+  'appChannel',
+  'language',
+  'platformVersion'
+];
+
+// 小程序平台
+export const PLATFORMTYPES = [
+  'wx',
+  'my',
+  'swan',
+  'qq',
+  'tt',
+  'ks',
+  'jd',
+  'xhs',
+  'quickapp'
+];

package/src/constants/regex.ts

@@ -0,0 +1,4 @@
+export const IPReg =
+  /^((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}/i;
+export const URLReg =
+  /^(https?:\/\/)|(([a-zA-Z0-9_-])+(\.)?)*(:\d+)?(\/((\.)?(\?)?=?&?[a-zA-Z0-9_-](\?)?)*)*$/i;

package/src/core/dataStore/eventContextBuilder.ts

@@ -0,0 +1,70 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import { getOS, getScreenHeight, getScreenWidth } from '@@/utils/tools';
+import { isEmpty, unset } from '@@/utils/glodash';
+
+class EventContextBuilder {
+  constructor(public growingIO: GrowingIOType) {}
+
+  // 通用字段组装
+  main = (params?: any) => {
+    const {
+      sdkVersion,
+      vdsConfig,
+      platformConfig,
+      minipInstance,
+      userStore,
+      dataStore: { scene, eventHooks, locationData, lastVisitEvent }
+    } = this.growingIO;
+    const { systemInfo = {}, network = {} } = minipInstance;
+    const { brand, model, platform, language, version } = systemInfo;
+    // 事件主要内容组装
+    const context: any = {
+      appChannel: `scn:${scene || 'NA'}`,
+      appVersion: vdsConfig.version,
+      dataSourceId: vdsConfig.dataSourceId,
+      deviceBrand: brand,
+      deviceId: userStore.uid,
+      deviceModel: model,
+      deviceType: getOS(platform, platformConfig.name),
+      domain: vdsConfig.appId,
+      language: language,
+      latitude: locationData?.latitude,
+      longitude: locationData?.longitude,
+      networkState: network?.networkType || network?.type || network?.subtype,
+      operatingSystem: getOS(platform, platformConfig.name),
+      path: eventHooks.currentPage?.path
+        ? eventHooks.currentPage?.path
+        : lastVisitEvent.path, // 如果页面中的path取不到，说明页面没初始化，还在app的生命周期中（appOnLoad/appOnShow），需要拿visit的path补上
+      platform: platformConfig.platform,
+      platformVersion: platformConfig.name + (version ? ` ${version}` : ''),
+      query: eventHooks.currentPage?.path
+        ? eventHooks.currentPage?.query
+        : lastVisitEvent.query, // 如果页面中的path取不到，说明页面没初始化，还在app的生命周期中（appOnLoad/appOnShow），需要拿visit的query补上
+      screenHeight: getScreenHeight(systemInfo),
+      screenWidth: getScreenWidth(systemInfo),
+      sdkVersion,
+      sessionId: userStore.sessionId,
+      title:
+        eventHooks.currentPage?.title ||
+        minipInstance.getPageTitle(minipInstance.getCurrentPage()),
+      timestamp: Date.now(),
+      timezoneOffset: new Date().getTimezoneOffset(),
+      userId: userStore.userId
+    };
+    if (vdsConfig.idMapping) {
+      context.userKey = userStore.userKey;
+    }
+    if (!isEmpty(vdsConfig.ignoreFields)) {
+      vdsConfig.ignoreFields.forEach((o) => {
+        unset(context, o);
+      });
+    }
+    // 此时可能存在数据为空的字段，在数据组装完成后由转换方法移除空值字段
+    if (!isEmpty(params)) {
+      return { ...context, ...params };
+    }
+    return context;
+  };
+}
+
+export default EventContextBuilder;

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

@@ -0,0 +1,220 @@
+import { AppHookLifeCircle } from '@@/types/eventHooks';
+import { GrowingIOType } from '@@/types/growingIO';
+import {
+  isEmpty,
+  isObject,
+  typeOf,
+  keys,
+  forEach,
+  has,
+  isNil
+} from '@@/utils/glodash';
+import { qsStringify } from '@@/utils/tools';
+
+class AppEffects {
+  constructor(public growingIO: GrowingIOType) {}
+
+  main = (event: AppHookLifeCircle, args: any) => {
+    const eventTime = Date.now();
+    const {
+      emitter,
+      userStore,
+      vdsConfig,
+      platformConfig,
+      uploader,
+      dataStore,
+      dataStore: {
+        shareOut,
+        keepAlive,
+        lastCloseTime,
+        eventHooks,
+        saveStorageInfo
+      }
+    }: GrowingIOType = this.growingIO;
+    emitter.emit('minipLifecycle', {
+      event: `App ${event}`,
+      timestamp: eventTime,
+      params: args[0] ?? {}
+    });
+    if (vdsConfig.debug) {
+      console.log('App:', event, eventTime);
+    }
+    const appListeners = platformConfig.listeners.app;
+    // 向插件广播事件
+    emitter.emit('onComposeBefore', {
+      event: `App ${event}`,
+      params: args[0] ?? {}
+    });
+    switch (event) {
+      // 快应用是执行onCreate
+      case appListeners.appCreate:
+      // 各小程序执行onShow
+      case appListeners.appShow: {
+        // 获取进入小程序的path、query和scene
+        const { path, query } = this.enterParamsParse(args[0]);
+        if (!shareOut && vdsConfig.originalSource) {
+          // 保存初始来源信息
+          dataStore.setOriginalSource({ path, query });
+        }
+        // 以下条件均会被认为是一次新的访问
+        // 没有关闭时间说明是新访问
+        if (!lastCloseTime) {
+          // 保存进入小程序的参数
+          this.growingIO.dataStore.lastVisitEvent = { path, query };
+          this.buildVisitEvent({ path, query });
+        } else if (
+          // 两次打开间隔时间超过keepAlive设定(默认5分钟)
+          Date.now() - lastCloseTime > keepAlive ||
+          // 两次打开时的场景值不一样（即从不同的来源进入小程序）
+          (dataStore.lastScene && dataStore.scene !== dataStore.lastScene)
+        ) {
+          // 重置sessionId
+          userStore.sessionId = '';
+          // 需要按自然逻辑发visit时，清掉pagetime，防止取值错误（会在page中重新生成）
+          eventHooks.currentPage.time = undefined;
+          this.buildVisitEvent({ path, query });
+        }
+        break;
+      }
+      case appListeners.appClose: {
+        // 同步信息
+        dataStore.lastScene = dataStore.scene;
+        dataStore.lastCloseTime = Date.now();
+        saveStorageInfo();
+        userStore.saveUserInfo();
+        this.buildCloseEvent();
+        // forceLogin不生效时强制把请求队列中的事件全部发送
+        if (!vdsConfig.forceLogin) {
+          uploader.initiateRequest(true);
+        }
+        break;
+      }
+      default:
+        break;
+    }
+  };
+
+  // 进入小程序时的相关数据处理
+  enterParamsParse = (args: any) => {
+    const { gioPlatform, minipInstance, dataStore } = this.growingIO;
+    let vPath = ''; // 进入小程序时的path
+    let vQuery = ''; // 进入小程序时的参数（启动参数）
+    const assignment = (p: string, q = {}) => {
+      vPath = p;
+      vQuery = keys(q)
+        .map((k) => `${k}=${q[k]}`)
+        .join('&');
+    };
+    // 支持getEnterOptionsSync
+    if (
+      gioPlatform !== 'quickapp' &&
+      minipInstance.minip.canIUse('getEnterOptionsSync')
+    ) {
+      const { path, query, scene, referrerInfo } =
+        minipInstance.minip.getEnterOptionsSync() || {};
+      const originQuery = args.query || query;
+      assignment(args.path || path, originQuery);
+      dataStore.scene = args.scene || scene;
+      // extraData字段计入query
+      if (!isEmpty(referrerInfo) && isObject(referrerInfo?.extraData)) {
+        let extraQuery = [];
+        forEach(referrerInfo.extraData, (v, k) => {
+          if (
+            // 与原始query中的key冲突时，以原始query为准
+            !has(originQuery, k) &&
+            // 只处理字符串、数字和布尔类型的值
+            ['string', 'number', 'boolean'].includes(typeOf(v))
+          ) {
+            extraQuery.push(`${k}=${v}`);
+          }
+        });
+        const extraQueryString = extraQuery.join('&');
+        vQuery =
+          vQuery && extraQueryString
+            ? `${vQuery}&${extraQueryString}`
+            : vQuery || extraQueryString;
+      }
+    } else {
+      // 不支持的按老逻辑兜底
+      const { path, query } = args;
+      assignment(path, query);
+      this.parseScene(args);
+    }
+    return { path: vPath, query: vQuery };
+  };
+
+  // 获取来源场景值
+  /**
+   * wx：https://developers.weixin.qq.com/miniprogram/dev/reference/scene-list.html
+   * alipay：https://opendocs.alipay.com/mini/framework/scene
+   * swan：https://smartprogram.baidu.com/docs/data/host_scene/
+   * tt：https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/framework/scene-value/
+   * qq：https://q.qq.com/wiki/develop/game/frame/scene/
+   * quickapp：https://doc.quickapp.cn/features/system/app.html?h=%E6%9D%A5%E6%BA%90
+   */
+
+  parseScene = (args) => {
+    const { minipInstance, gioPlatform, dataStore } = this.growingIO;
+    let newScene;
+    // 快应用处理逻辑
+    if (gioPlatform === 'quickapp') {
+      const { extra, type } = minipInstance.getAppSource();
+      newScene = extra?.scene || type;
+    } else if (!isEmpty(args)) {
+      if (args?.query?.wxShoppingListScene) {
+        newScene = args.query.wxShoppingListScene;
+      } else if (args?.scene) {
+        newScene = args.scene;
+      } else {
+        dataStore.scene = 'NA';
+      }
+    }
+    dataStore.scene = newScene;
+  };
+
+  // 构建访问事件
+  buildVisitEvent = (props: any) => {
+    const { dataStore, vdsConfig, minipInstance } = this.growingIO;
+    const {
+      originalSourceName,
+      getOriginalSource,
+      eventContextBuilder,
+      eventInterceptor
+    } = dataStore;
+    const originalSource = getOriginalSource();
+    // 生命周期中调用构建使用参数赋值，补发场景调用构建使用上一次的值
+    const query = props?.query || '';
+    let event = {
+      eventType: 'VISIT',
+      ...eventContextBuilder({
+        // params.path是生命周期值或者是已有的值
+        path: props?.path || '',
+        // params.query是对象说明是生命周期调用，否则是补发调用
+        query: typeOf(query) === 'string' ? query : qsStringify(query)
+      })
+    };
+    // 配置使用初始来源时，visit使用初始来源数据
+    if (vdsConfig.originalSource && !isNil(originalSource)) {
+      event = { ...event, ...originalSource };
+      // 采集开关开启状态下的第一个visit消费过初始来源信息后删除
+      if (vdsConfig.dataCollect) {
+        minipInstance.removeStorageSync(originalSourceName);
+      }
+    }
+    eventInterceptor(event);
+  };
+
+  // 构建关闭事件
+  buildCloseEvent = () => {
+    const {
+      dataStore: { eventContextBuilder, eventInterceptor }
+    } = this.growingIO;
+    const event = {
+      eventType: 'APP_CLOSED',
+      ...eventContextBuilder()
+    };
+    eventInterceptor(event);
+  };
+}
+
+export default AppEffects;