gio-miniprogram-sdk 4.3.1 → 4.4.0

package/src/plugins/gioPerformance/network.ts

@@ -0,0 +1,197 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import {
+  compact,
+  forEach,
+  isArray,
+  isEmpty,
+  isNil,
+  isRegExp,
+  isString,
+  unset
+} from '@@/utils/glodash';
+
+export default class Network {
+  private minipInst: any;
+  private excludeRegExp: RegExp | string | any[];
+  private gdpRequestURL: string;
+  private buildNetworkEvent: (attributes: any) => void;
+  constructor(public growingIO: GrowingIOType, public options: any = {}) {
+    this.minipInst = this.growingIO.minipInstance.minip;
+    this.buildNetworkEvent = (attributes: any) => {
+      if (!options.network) {
+        return;
+      }
+      const { duration, url, method, statusCode } = attributes;
+      this.growingIO.plugins.gioPerformance?.buildPerfEvent(
+        'apm_network_request',
+        {
+          response_duration: duration,
+          request_address: url,
+          request_method: method,
+          http_code: statusCode
+        }
+      );
+    };
+
+    if (this.options.network?.exclude) {
+      this.excludeRegExp = this.options.network.exclude;
+    }
+    this.hookRequest();
+    // 重写生成地址的方法，sdk在性能分析时需要拿到主实例的请求地址做判断用
+    const self = this;
+    const originFunc = this.growingIO.uploader.generateURL;
+    this.growingIO.uploader.generateURL = function () {
+      const result = originFunc.apply(this, arguments);
+      const trackingId = arguments[0];
+      if (trackingId === self.growingIO.trackingId) {
+        self.gdpRequestURL = result;
+      }
+      return result;
+    };
+  }
+
+  // 检验url是否符合过滤条件
+  verifyUrl = (url: string) => {
+    // Gio的请求直接过滤
+    if (url.indexOf(this.gdpRequestURL) > -1) {
+      return true;
+    }
+    // 正则或字符串域名数组过滤
+    if (isArray(this.excludeRegExp)) {
+      const verifyResult = compact(
+        (this.excludeRegExp as any[]).map((re: RegExp | string) => {
+          if (isRegExp(re)) {
+            return (re as RegExp).test(url);
+          } else if (isString(re)) {
+            return url.indexOf(re as string) > -1;
+          }
+        })
+      );
+      return !isEmpty(verifyResult);
+    } else if (isString(this.excludeRegExp)) {
+      // 单个字符串过滤校验
+      return url.indexOf(this.excludeRegExp as string) > -1;
+    } else if (isRegExp(this.excludeRegExp)) {
+      // 单个正则过滤校验
+      return (this.excludeRegExp as RegExp).test(url);
+    } else {
+      return false;
+    }
+  };
+
+  // 重写request
+  hookRequest = () => {
+    const self = this;
+    ['request', 'downloadFile', 'uploadFile'].forEach((reqKey: string) => {
+      const originRequest = this.minipInst[reqKey];
+      Object.defineProperty(this.minipInst, reqKey, {
+        writable: true,
+        enumerable: true,
+        configurable: true,
+        value: function (...args: any[]) {
+          const options: any = args[0];
+          const { url } = options;
+          // 如果符合过滤条件就直接发请求不做处理
+          if (self.verifyUrl(url)) {
+            return originRequest.call(this, options);
+          }
+          let cstmRequestInfo: any = {
+            header: options.header || {},
+            url: options.url
+          };
+          switch (reqKey) {
+            case 'request':
+              const { method } = options;
+              cstmRequestInfo = { ...cstmRequestInfo, method };
+              break;
+            case 'downloadFile':
+            case 'uploadFile':
+              const { filePath } = options;
+              cstmRequestInfo = {
+                ...cstmRequestInfo,
+                filePath,
+                method: reqKey === 'downloadFile' ? 'GET' : 'POST'
+              };
+              break;
+            default:
+              break;
+          }
+
+          const originFail = options.fail;
+          const fail = function (result: any) {
+            cstmRequestInfo.endTime = Date.now();
+            self.growingIO.plugins.gioPerformance?.buildPerfEvent('Error', {
+              error_type: result.errMsg,
+              error_content: cstmRequestInfo.url
+            });
+            if (typeof originFail === 'function') {
+              return originFail(result);
+            }
+          };
+
+          const originSuccess = options.success;
+          const success = function (result) {
+            cstmRequestInfo.endTime = Date.now();
+            self.networkPerfBuilder(result, cstmRequestInfo);
+            if (typeof originSuccess === 'function') {
+              return originSuccess(result);
+            }
+          };
+          cstmRequestInfo.startTime = Date.now();
+          return originRequest.call(this, {
+            ...options,
+            success,
+            fail
+          });
+        }
+      });
+    });
+  };
+
+  // 请求性能数据组装
+  networkPerfBuilder = (requestResult: any, cstmRequestInfo: any) => {
+    const { profile = {}, statusCode = 0, errMsg } = requestResult;
+    const { url, filePath, method } = cstmRequestInfo;
+    const {
+      redirectStart,
+      redirectEnd,
+      fetchStart,
+      domainLookUpStart,
+      domainLookUpEnd,
+      connectStart,
+      connectEnd,
+      requestStart,
+      responseStart,
+      responseEnd
+    } = profile;
+    const p = !isEmpty(profile);
+    const networkPerf = {
+      url,
+      filePath,
+      method,
+      statusCode,
+      message: errMsg,
+      // 重定向耗时（重定向没有发生，或者其中一个重定向非同源，则该值为 0）
+      redirect: p ? redirectEnd - redirectStart : 0,
+      // 缓存耗时
+      cache: p ? domainLookUpStart - fetchStart : 0,
+      // dns域名解析耗时
+      dns: p ? domainLookUpEnd - domainLookUpStart : 0,
+      // tcp链接耗时
+      tcp: p ? connectEnd - connectStart : 0,
+      // 在SSL链接建立好后，从客户端发送至服务端首次响应的耗时
+      request: p ? responseStart - requestStart : 0,
+      // 从服务端首次响应至数据完全响应完的耗时
+      response: p ? responseEnd - responseStart : 0,
+      // 请求总耗时
+      duration: p
+        ? responseEnd - fetchStart
+        : cstmRequestInfo.endTime - cstmRequestInfo.startTime
+    };
+    forEach(
+      networkPerf,
+      (v, k) => (v === '' || isNil(v)) && unset(networkPerf, k)
+    );
+    this.buildNetworkEvent(networkPerf);
+  };
+}

package/src/plugins/gioPerformance.ts

@@ -0,0 +1,131 @@
+/**
+ * 名称：性能采集插件
+ * 用途：用于采集小程序基本性能信息。
+ */
+import { GrowingIOType } from '@@/types/growingIO';
+import { isEmpty } from '@@/utils/glodash';
+import { limitObject } from '@@/utils/tools';
+import EMIT_MSG from '@@/constants/emitMsg';
+import Exception from './gioPerformance/exception';
+import Monitor from './gioPerformance/monitor';
+import Network from './gioPerformance/network';
+
+let ut;
+class GioPerformance {
+  public pluginVersion: string;
+  public network: any;
+  public exception: any;
+  public monitor: any;
+  // 缓存队列，SDK初始化完成之后再根据性能的配置项发送数据
+  private cacheQueue: any[];
+  constructor(public growingIO: GrowingIOType, public options: any = {}) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
+    ut = this.growingIO.utils;
+    this.options = {
+      monitor: true,
+      exception: true,
+      network: false,
+      ...this.options
+    };
+    this.cacheQueue = [];
+    this.growingIO.emitter.on(EMIT_MSG.SDK_INITIALIZED, (vdsConfig: any) => {
+      if (vdsConfig.trackingId === this.growingIO.trackingId) {
+        // 初始化配置项优先级更高（后续版本考虑把配置项值放在插件options上去配，弱化初始化配置项）
+        const { monitor, exception, network } = vdsConfig.performance;
+        if (monitor !== this.options.monitor) {
+          this.options.monitor = monitor;
+        }
+        if (exception !== this.options.exception) {
+          this.options.exception = exception;
+        }
+        if (network !== this.options.network) {
+          this.options.network = network;
+        }
+        this.init();
+      }
+    });
+    // 采集开关从关闭到打开时要把队列中存的启动和错误都发出去
+    // 采集开关开启必会更新session
+    this.growingIO.emitter?.on(EMIT_MSG.SESSIONID_UPDATE, () => {
+      const { trackingId, getOption } = this.growingIO;
+      if (getOption(trackingId, 'dataCollect')) {
+        this.sendCacheQuene();
+      }
+    });
+  }
+
+  init = () => {
+    const { dataCollect } = this.growingIO.vdsConfig;
+    const { monitor, exception, network } = this.options;
+    if (monitor) {
+      this.monitor = new Monitor(this.growingIO);
+    }
+    if (exception) {
+      this.exception = new Exception(this.growingIO);
+    }
+    if (network) {
+      this.network = new Network(this.growingIO, this.options);
+    }
+    // SDK初始化完成发送缓存队列
+    if (dataCollect) {
+      this.sendCacheQuene();
+    }
+  };
+
+  // 发送缓存队列
+  sendCacheQuene = () => {
+    if (!ut.isEmpty(this.cacheQueue)) {
+      this.cacheQueue.forEach((o: any) => {
+        this.buildPerfEvent(o.eventName, o.attributes, o.extra);
+      });
+      this.cacheQueue = [];
+    }
+  };
+
+  // 构建各种性能事件
+  buildPerfEvent = (eventName: string, attributes: any, extra?: any) => {
+    const {
+      dataStore: { eventContextBuilder, eventConverter },
+      gioSDKInitialized,
+      vdsConfig
+    } = this.growingIO;
+    // SDK没初始化完成或初始化关闭采集开关的事件先存起来，等SDK初始化完成或开启采集开关再发
+    if (!gioSDKInitialized || !vdsConfig.dataCollect) {
+      this.cacheQueue = [
+        ...this.cacheQueue,
+        {
+          eventName,
+          attributes,
+          extra
+        }
+      ];
+      return false;
+    }
+    // 处理过长的小数，保留0位
+    ut.forEach(attributes, (v, k) => {
+      if (Number.isNaN(v) || ut.isNil(v) || Number(v) < 0) {
+        attributes[k] = 0;
+      }
+      attributes[k] = ut.fixed(v, 0);
+    });
+    let event = {
+      eventType: 'CUSTOM',
+      eventName,
+      attributes,
+      ...eventContextBuilder(this.growingIO.trackingId)
+    };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      ...attributes
+    });
+    if (!isEmpty(extra)) {
+      event = { ...event, ...extra };
+    }
+    eventConverter(event);
+  };
+}
+
+export default {
+  name: 'gioPerformance',
+  method: GioPerformance
+};

package/src/types/base.ts

@@ -36,7 +36,11 @@ export interface UserOptions {
   // session保活时长（5分钟）
   keepAlive: number;
   // 性能采集配置
-  performance?: { monitor: boolean; exception: boolean };
+  performance?: {
+    monitor: boolean;
+    exception: boolean;
+    network: boolean;
+  };
   // 请求超时时长
   requestTimeout?: number;
   // 数据上报域名

package/src/types/minipInstance.ts

@@ -54,7 +54,7 @@ export interface Location {
 }
 
 export interface MinipInstanceType {
-  // 小程序原生对象 wx/my/tt/swan/qq/ks
+  // 小程序原生对象 wx/my/tt/swan/qq/ks/jd/xhs
   readonly minip: any;
   // 当前平台
   platform: PLATFORMS;
@@ -123,4 +123,6 @@ export interface MinipInstanceType {
   getSystemInfo?: () => Promise<SystemInfo>;
   // 获取小程序设置
   getSetting?: () => any;
+  // 监听网络变更
+  setNetworkStatusListener?: () => any;
 }

package/src/types/platforms.ts

@@ -7,6 +7,7 @@ export type PLATFORMS =
   | 'bytedance'
   | 'kuaishoup'
   | 'jdp'
+  | 'xhsp'
   | 'quickapp';
 export type PLATFORMTYPES =
   | 'wx'
@@ -17,6 +18,7 @@ export type PLATFORMTYPES =
   | 'tt'
   | 'ks'
   | 'jd'
+  | 'xhs'
   | 'quickapp';
 
 export type FRAMEWORKS = 'taro' | 'uniapp' | 'full';
@@ -27,6 +29,7 @@ export interface PlatformConfigType {
   scnPrefix?: string;
   appHandlers?: string[];
   pageHandlers?: string[];
+  shareEventTypes?: string[];
   actionEventTypes?: string[];
   hooks?: {
     App: boolean;

package/src/utils/tools.ts

@@ -126,8 +126,13 @@ export const getOS = (system: any, configName: string) => {
       return `${configName}-Android`;
     } else if (lowsys.indexOf('ios') !== -1) {
       return `${configName}-iOS`;
+    } else if (
+      lowsys.indexOf('harmonyos') !== -1 ||
+      lowsys.indexOf('ohos') !== -1
+    ) {
+      return `${configName}-HarmonyOS`;
     } else {
-      return system;
+      return `${configName}-${system}`;
     }
   }
 };
@@ -214,10 +219,13 @@ export const getPlainMinip = (platform?: string) => {
         return ks;
       case 'jd':
         return jd;
+      case 'xhs':
+        return xhs;
       // 第三方框架下自动获取实例
       // 百度等小程序中可能存在封装过的wx对象，因此wx要放在最后判断
       default: {
         let minip;
+        if (!minip) minip = niceTry(() => xhs);
         if (!minip) minip = niceTry(() => swan);
         if (!minip) minip = niceTry(() => my);
         if (!minip) minip = niceTry(() => tt);
@@ -251,6 +259,8 @@ export const getPlainConfig = (platform?: string) => {
         return __ksConfig; // 新版快手小程序已经拿不到了
       case 'jd':
         return __jdConfig;
+      case 'xhs':
+        return __MP_APP_JSON_MIGRATION__ ?? __MP_APP_JSON__;
       // 第三方框架下自动获取实例
       default:
         // 支付宝和淘宝不存在可获取的全局对象
@@ -259,10 +269,30 @@ export const getPlainConfig = (platform?: string) => {
   });
 };
 
+export const getPlainAppCode = (platform?: string) => {
+  return niceTry(() => {
+    switch (platform) {
+      // 指定平台获取实例
+      case 'wx':
+      case 'qq':
+        return __wxAppCode__;
+      case 'tt':
+        return __allConfig__;
+      case 'ks':
+        return __module__;
+      case 'jd':
+        return __jdAppCode__;
+      default:
+        return undefined;
+    }
+  });
+};
+
 // 在框架下自动获取当前平台值
 export const getPlainPlatform = () => {
   // 百度等小程序中可能存在封装过的wx对象，因此wx要放在最后判断
   let platform;
+  if (!platform && niceTry(() => xhs)) platform = 'xhs';
   if (!platform && niceTry(() => swan)) platform = 'swan';
   if (!platform && niceTry(() => tt)) platform = 'tt';
   if (!platform && niceTry(() => qq)) platform = 'qq';
@@ -416,11 +446,24 @@ export const hashCode = (string: string, abs = false) => {
   return abs ? Math.abs(hash) : hash;
 };
 
+export const getExtraData = (data: any) => {
+  if (isString(data)) {
+    return niceTry(() => JSON.parse(data)) ?? {};
+  } else {
+    return data ?? {};
+  }
+};
+
 // 获取额外的启动参数并合并进query
-export const getLaunchQuery = (originQuery: any = {}, extraData: any = {}) => {
+export const getLaunchQuery = (originQuery: any = {}, data: any = {}) => {
   const validData = {};
+  const extraData = getExtraData(data);
   keys(extraData).forEach((k: string) => {
-    if (['string', 'number', 'boolean'].includes(typeOf(extraData[k]))) {
+    // 排除掉新版圈选用的标记字段
+    if (
+      k !== 'gdpCircleRoomCollectUrl' &&
+      ['string', 'number', 'boolean'].includes(typeOf(extraData[k]))
+    ) {
       validData[k] = extraData[k];
     }
   });

package/src/utils/verifiers.ts

@@ -7,12 +7,13 @@ import { isNumber, isString, toString } from '@@/utils/glodash';
 
 /**
  * 一些id的合法性校验
- * @param id // 只允许数字和字符串，不允许为空字符串、0、负数
+ * @param id // 只允许数字和字符串，不允许为空字符串、0、负数、短横线字符串null,undefined
  */
 
 export const verifyId = (o: string | number) =>
-  (isString(o) && (o as string).length > 0) ||
-  (isNumber(o) && (o as number) > 0);
+  ((isString(o) && (o as string).length > 0) ||
+    (isNumber(o) && (o as number) > 0)) &&
+  !['-', 'null', 'undefined'].includes(o as string);
 
 /**
  * 初始化时的一些合法性校验

package/tsconfig.json

@@ -12,7 +12,7 @@
     "sourceMap": true,
     "strict": false,
     "lib": ["DOM", "ES5", "ES6", "ES2016", "ES2017"],
-    "target": "ES6",
+    "target": "ES5",
     "types": ["node", "webpack-env"],
     "paths": {
       "@@/*": ["src/*"]

package/typings/global.d.ts

@@ -24,14 +24,22 @@ declare var qq: any;
 declare var tt: any;
 declare var ks: any;
 declare var jd: any;
+declare var xhs: any;
 declare var quickapp: any;
+declare var __wxAppCode__: any;
 declare var __wxConfig: any;
 declare var appConfig: any; // swan的全局配置
 declare var __myConfig: any; // my的全局配置
+declare var TMAConfig: any; // tt的全局配置
 declare var __ttConfig: any; // tt的全局配置
+declare var __allConfig__: any;
 declare var __qqConfig: any; // qq的全局配置
 declare var __ksConfig: any; // ks的全局配置
+declare var __module__: any;
 declare var __jdConfig: any; // jd的全局配置
+declare var __jdAppCode__: any; 
+declare var __MP_APP_JSON_MIGRATION__: any; // xhs的全局配置
+declare var __MP_APP_JSON__: any; // xhs的全局配置
 declare var __proto__: any;
 declare var Taro: any
 declare var uni: any

package/bin/build.sh

@@ -1,38 +0,0 @@
-# 清空产物
-rm -r dist/*
-
-# 微信小程序
-npm run build:wx
-
-# 支付宝小程序
-npm run build:my
-
-# 百度小程序
-npm run build:swan
-
-# 字节小程序
-npm run build:tt
-
-# 京东小程序
-npm run build:jd
-
-# QQ小程序
-npm run build:qq
-
-# 淘宝小程序
-npm run build:tb
-
-# 快手小程序
-npm run build:ks
-
-# 快应用
-npm run build:quickapp
-
-# uniapp vue2/vue3
-npm run build:uniapp
-
-# taro2/3 react/vue2/vue3
-npm run build:taro
-
-# 插件
-npm run build:plugins