@tmsfe/tms-core 0.0.188 → 0.0.189

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmsfe/tms-core",
-  "version": "0.0.188",
+  "version": "0.0.189",
   "description": "tms运行时框架",
   "repository": {
     "type": "git",

package/src/logger.ts

@@ -0,0 +1,22 @@
+/**
+ * @desc: 日志输出
+ */
+
+const logger = wx.getLogManager({});
+
+// 上报自定义事件
+function reportEvent(eventName, eventData: { ext1?: unknown; ext2?: unknown; ext3?: unknown; } = {}) {
+  // 避免tmsAegisInst内部报错
+  try {
+    wx.tmsAegisInst?.reportEvent({
+      name: eventName,
+      ...eventData,
+    });
+  } catch (e) {}
+}
+
+// eslint-disable-next-line import/no-anonymous-default-export
+export default {
+  ...logger,
+  reportEvent,
+};

package/src/request.js

@@ -13,8 +13,16 @@ import { getEnvInfo, getAuthInfo } from './env';
 import { safeJsonParse } from './objUtils';
 import { encryptObjInit } from './encrypt/index';
 import reporter from './report/index';
+import logger from './logger';
 
-const logger = wx.getLogManager({});
+const RETRY_WX_ERR_NOS = [600001, 600003, 5]; // 微信底层错误重试码 600001-微信cronet组件错误 600003-网络中断 5-接口超时
+
+// 重试api白名单
+const RETRY_API_WHITE_LIST = [
+  'marketing/apollo/config',
+  'user/pubsubscribe/get',
+  'marketing/config',
+];
 
 /**
  * 用于序列化需要签名的参数
@@ -372,15 +380,108 @@ export default class Request {
    * @param {object} header 自定义的请求头
    * @returns {Promise} 接口返回结果
    */
-  async createRequestTask(path, param = {}, method = 'POST', header = {}, hasRetry = false) {
-    // maplbs接口不需要token
+  async createRequestTask(path, param = {}, method = 'POST', header = {}) {
+    try {
+      const res = await this.invokeRequest(path, param, method, header);
+      // format 业务errcode，用于判断是否做重试
+      const { errCode } = formatResErrCode(path, res.data);
+      // 处理token失效情况(errcode=35)
+      const needRetryLogin = errCode === 35 && isPathNeedRetryLogin(path);
+      if (needRetryLogin) {
+        // 调用runtime的login方法刷新token
+        await loginRefresh();
+        // 刷新后重试一次请求
+        return await this.invokeRequest(path, param, method, header);
+      }
+      return res;
+    } catch (err) {
+      // 微信系统errno：在重试码白名单内，重试
+      const isWhiteApi = RETRY_API_WHITE_LIST.includes(path);
+      const canRetry = errno => RETRY_WX_ERR_NOS.includes(errno) && isWhiteApi;
+      if (canRetry(err?.errno) && wx.tmsFlagMap?.retryFlag) {
+        return await this.handleReTry(path, param, method, header, {
+          reportMsg: {
+            errno: err.errno,
+            errMsg: err.errMsg,
+          },
+          // maxRetryCount: 2, // 先立即重试一次，失败再延时重试一次
+          waitTime: 300, // 微信底层错误300ms后重试一次
+          isSuccess: retryRes => !canRetry(retryRes?.errno),
+        });
+      }
+      return Promise.reject(err);
+    }
+  }
+
+  // 执行重试
+  async handleReTry(path, param, method, header, options) {
+    const currentRetryCount = options.currentRetryCount ?? 0;
+    const maxRetry = options.maxRetryCount ?? 1;
+    const genReportParams = (others = {}) => ({
+      ext1: 'home',
+      ext2: path,
+      ext3: JSON.stringify({
+        ...options.reportMsg,
+        retryCount: `${currentRetryCount + 1}/${maxRetry}`,
+        ...others,
+      }),
+    });
+
+    // 执行单次重试
+    const executeRetry = async () => {
+      reporter.reportEvent('接口发起重试', genReportParams());
+      // 如果有等待时间则延迟
+      if (options.waitTime) {
+        await new Promise(resolve => setTimeout(resolve, options.waitTime));
+      }
+      try {
+        const retryRes = await this.invokeRequest(path, param, method, header);
+        const nextReportParams = genReportParams({
+          retryResErrno: retryRes?.errno,
+          retryResErrMsg: retryRes?.errMsg,
+        });
+        // 检查是否成功
+        const isSuccess = options.isSuccess?.(retryRes) ?? true;
+        if (isSuccess) {
+          reporter.reportEvent('接口重试成功', nextReportParams);
+          return retryRes;
+        }
+        reporter.reportEvent('接口重试失败', nextReportParams);
+        throw new Error('业务逻辑判断失败');
+      } catch (error) {
+        reporter.reportEvent('接口重试失败', genReportParams({
+          retryResErrMsg: error.errMsg,
+          retryResType: 'catch',
+        }));
+        throw error;
+      }
+    };
+
+    try {
+      return await executeRetry();
+    } catch (err) {
+    // 检查是否还可以重试
+      if (currentRetryCount < maxRetry - 1) {
+        return await this.handleReTry(path, param, method, header, {
+          ...options,
+          currentRetryCount: currentRetryCount + 1,
+          waitTime: 300, // 后续重试默认300ms间隔
+        });
+      }
+      return Promise.reject(err);
+    }
+  }
+
+  // 执行请求
+  async invokeRequest(path, param = {}, method = 'POST', header = {}) {
+  // maplbs接口不需要token
     const withAuth = path.includes('maplbs/ws') ? false : this.withAuth;
     const requestParam = await composeParam(param, withAuth, this.baseParam);
     const data = sign(requestParam, this.secretKey);
     return new Promise((resolve, reject) => {
       const requestTime = Date.now();
       const printLog = (isSuccess, res) => {
-        // 埋点已经单独打日志了，接口请求数据日志太长影响分析
+      // 埋点已经单独打日志了，接口请求数据日志太长影响分析
         if (path.indexOf('basic/event/upload') !== -1) {
           return;
         }
@@ -416,24 +517,6 @@ export default class Request {
 
       const success = async (res) => {
         printLog(true, res.data);
-        // format 业务errcode，用于判断是否做重试
-        const { errCode } = formatResErrCode(path, res.data);
-        // 处理token失效情况(errcode=35)
-        const needRetryLogin = !hasRetry && errCode === 35 && isPathNeedRetryLogin(path);
-        if (needRetryLogin) {
-          try {
-            // 调用runtime的login方法刷新token
-            await loginRefresh();
-            // 刷新后重试请求
-            const retryRes = await this.createRequestTask(path, param, method, header, true);
-            resolve(retryRes);
-            return;
-          } catch (e) {
-            // 刷新token失败，直接返回原错误
-            resolve(res);
-            return;
-          }
-        }
         resolve(res);
       };
       const fail = (err) => {