keeson-web-report-sdk 1.1.5 → 1.1.6

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "keeson-web-report-sdk",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "for web/h5",
-  "main": "src/index.js",
-  "module": "src/index.js",
+  "main": "bundle.min.js",
+  "module": "bundle.esm.js",
   "exports": {
     ".": {
-      "require": "./src/index.js",
-      "import": "./src/index.js",
-      "browser": "./src/index.js"
+      "require": "./bundle.cjs.js",
+      "import": "./bundle.esm.js",
+      "browser": "./bundle.min.js"
     }
   },
   "scripts": {

package/README.md

@@ -1,37 +0,0 @@
-```javascript
-export const REPORT_TYPE = {
-  ERROR: "error",
-  PERFORMANCE: "performance",
-  REQUEST: "request",
-  USER: "user",
-};
-
-export const ERROR_TYPE = {
-  MAIN: "main",
-  RESOURCE_ERROR: "resourceError",
-  PROMISE_REJECTION: "PromiseRejection",
-  VUE_ERROR: "VueError",
-};
-
-export const REQUEST_ERROR_TYPE = {
-  ERROR: "error",
-};
-
-export const PERFORMANCE_TYPE = {
-  LOADED: "loaded",
-  FP: "paint",
-  FCP: "first-contentful-paint",
-  LCP: "largest-contentful-paint",
-  CLS: "layout-shift",
-  FID: "first-input",
-  LONGTASK: "longTask",
-  RESOURCE: "resource",
-  PAGE_RESOURCE: "pageResource",
-};
-
-export const USER_TYPE = {
-  LOCATION_CHANGE: "LocationChange",
-  ROUTE_CHANGE: "RouteChange",
-};
-
-```

package/src/index.js

@@ -1,323 +0,0 @@
-import * as reportError from "./report-error";
-import * as reportPerformance from "./report-performance";
-import * as reportRequest from "./report-request";
-import * as reportUser from "./report-user";
-import {
-  REPORT_TYPE,
-  ERROR_TYPE,
-  REQUEST_ERROR_TYPE,
-  USER_TYPE,
-} from "./consts";
-function formatDate(date) {
-  const year = date.getFullYear();
-  const month = date.getMonth() + 1;
-  const day = date.getDate();
-  return `${year}-${month}-${day}`;
-}
-const defaultOptions = {
-  reportUrl: "", // 上报请求地址
-
-  // app基本信息
-  appId: "", // appId
-  appVersion: "",
-  appUrl: window.location.origin, // 站点地址, 对应应用配置网站站点地址
-  appEnv: "prod",
-  userAgent: window.navigator.userAgent,
-
-  reportPath: "", // 上报页面路径
-
-  // 上报记录
-  reportError: true,
-  reportPromiseReject: true,
-  reportVueError: true,
-  vueInstance: null,
-
-  reportPerformance: true, // 是否上报性能数据
-  listenPerformance: true, // 是否监听性能数据
-
-  longTimeRequestThreshold: 2000, // 长请求时间阈值，单位毫秒
-  reportErrorReqest: true, // 是否上报报错请求
-  errorRequestFunc: null, // 错误请求过滤函数
-  //  response => {
-  //   return response.data.code !== 0
-  // },
-
-  reportUserNavigate: true, // 是否上报用户导航行为
-
-  // repeatRequestTime: 2000, // todo: 2s调用同一接口，同一参数，上报
-  appSecretKey: "", // 应用密钥
-  // 级别：错误、性能信息、用户导航行为、重复请求
-};
-
-class Report {
-  records = [];
-  timer = null;
-  options = {};
-  constructor(options) {
-    this.options = { ...defaultOptions, ...options };
-  }
-  init() {
-    const storeDate = localStorage.getItem("report-store-date");
-
-    const today = formatDate(new Date());
-    if (storeDate !== today) {
-      localStorage.setItem("report-store-date", today);
-      localStorage.setItem("report-store-list", "[]");
-    }
-
-    const reportStoreList = JSON.parse(localStorage.getItem("report-store-list"));
-
-    // type	 类型 (string) Required
-    // errorType	 错误类型 (string)
-    // performanceType	 性能上报指标 (string)
-    // requestType	 请求上报指标 (string)
-    // navigationType	 导航上报指标 (string)
-    // message	 上报信息 (string)
-    // extra	 额外信息 (string)
-    // originData	 原始数据 (string)
-
-    // todo: 重复的上报太多，需要过滤
-
-    // listen and callback
-    if (this.options.reportError) {
-      // 错误上报
-      // 包含：资源加载错误，全局代码错误
-      reportError.globalErrorHandler((res) => {
-        if(reportStoreList.includes(res.message)) {
-          return;
-        }
-        this.addReportRecord({
-          reportType: REPORT_TYPE.ERROR,
-          ...res,
-        });
-        reportStoreList.push(res.message);
-        localStorage.setItem("report-store-list", JSON.stringify(reportStoreList));
-      });
-    }
-    if (this.options.reportPromiseReject) {
-      // 未处理的 Promise 错误上报
-      reportError.promiseErrorHandler((event) => {
-        if(reportStoreList.includes(event.reason?.stack)) {
-          return;
-        }
-        this.addReportRecord({
-          reportType: REPORT_TYPE.ERROR,
-          type: ERROR_TYPE.PROMISE_REJECTION,
-          message: event.reason?.stack,
-        });
-        reportStoreList.push(event.reason?.stack);
-        localStorage.setItem("report-store-list", JSON.stringify(reportStoreList));
-      });
-    }
-    if (this.options.reportVueError && this.options.vueInstance) {
-      // vue错误上报
-      reportError.vueErrorHandler(this.options.vueInstance, ({ err }) => {
-        if(reportStoreList.includes(err.message)) {
-          return;
-        }
-        this.addReportRecord({
-          reportType: REPORT_TYPE.ERROR,
-          type: ERROR_TYPE.VUE_ERROR,
-          message: err.message,
-        });
-        reportStoreList.push(err.message);
-        localStorage.setItem("report-store-list", JSON.stringify(reportStoreList));
-      });
-    }
-
-    // if (this.options.reportPerformance) {
-    //   // 性能上报
-    //   reportPerformance.reportPerformance(options, (performanceList) => {
-    //     this.addReportRecord({
-    //       reportType: REPORT_TYPE.PERFORMANCE,
-    //       type: "performance",
-    //       message: "",
-    //       extra: JSON.stringify(performanceList),
-    //     });
-    //   });
-    // }
-
-    if (this.options.listenPerformance) {
-      console.log("加载性能：fp, fcp, lcp, tbt, cls,等");
-      console.log("资源加载性能：dns, tcp, ssl, firstByte, download,等");
-      console.log("接口调用时间，需要剔除上报接口！");
-
-      // reportPerformance.loadedTimestamp((item) => {
-      //   this.addReportRecord({
-      //     reportType: REPORT_TYPE.PERFORMANCE,
-      //     ...item,
-      //   });
-      // });
-
-      // console.log(this.options,)
-      reportPerformance.listenPerformance(this.options, (performanceList) => {
-        // 加载性能：fp, fcp, lcp, tbt, cls,等
-        // 资源加载性能：dns, tcp, ssl, firstByte, download,等
-        // console.log('=============["performanceList"]:',performanceList)
-        performanceList.forEach((item) => {
-          if (item.extra.resourceName !== this.options.reportUrl) {
-            this.addReportRecord({
-              reportType: REPORT_TYPE.PERFORMANCE,
-              ...item,
-            });
-          }
-        });
-        // this.addReportRecord({
-        //   reportType: REPORT_TYPE.PERFORMANCE,
-        //   type: "performance",
-        //   message: "",
-        //   extra: JSON.stringify(performanceList),
-        // });
-      });
-    }
-
-    if (this.options.reportErrorReqest) {
-      // 请求性能上报
-      reportRequest.xhrReportHandle(
-        null,
-        // (res) => {
-        //   if (
-        //     !!this.options.longTimeRequestThreshold &&
-        //     res.duration > this.options.longTimeRequestThreshold
-        //   ) {
-        //     const { duration, url, method } = res;
-        //     this.addReportRecord({
-        //       reportType: REPORT_TYPE.REQUEST,
-        //       type: REQUEST_ERROR_TYPE.LONG,
-        //       message: `长请求时间接口：${url}，方法：${method}，耗时：${duration}ms`,
-        //       extra: JSON.stringify({ duration }),
-        //     });
-        //   }
-        // },
-        (error) => {
-          const { status, url, method, statusText } = error;
-          const message = `请求报错接口：${url}，方法：${method}，状态码：${status}，状态信息：${statusText}`
-          if(reportStoreList.includes(message)) {
-            return;
-          }
-          this.addReportRecord({
-            reportType: REPORT_TYPE.ERROR,
-            type: REQUEST_ERROR_TYPE.ERROR,
-            message: message,
-          });
-          reportStoreList.push(message);
-          localStorage.setItem("report-store-list", JSON.stringify(reportStoreList));
-        },
-        this.options,
-      );
-      reportRequest.fetchReportHandle(
-        // (res) => {
-        //   if (
-        //     !!this.options.longTimeRequestThreshold &&
-        //     res.duration > this.options.longTimeRequestThreshold
-        //   ) {
-        //     const { duration, url, method } = res;
-        //     this.addReportRecord({
-        //       reportType: REPORT_TYPE.REQUEST,
-        //       type: REQUEST_ERROR_TYPE.LONG,
-        //       message: `长请求时间接口：${url}，方法：${method}，耗时：${duration}ms`,
-        //       extra: JSON.stringify({ duration }),
-        //     });
-        //   }
-        // },
-        null,
-        (error) => {
-          const { url, method, statusText } = error;
-          const message = `请求报错接口：${url}，方法：${method}，状态信息：${statusText}`
-          if(reportStoreList.includes(message)) {
-            return;
-          }
-          this.addReportRecord({
-            reportType: REPORT_TYPE.ERROR,
-            type: REQUEST_ERROR_TYPE.ERROR,
-            message: message,
-          });
-          reportStoreList.push(message);
-          localStorage.setItem("report-store-list", JSON.stringify(reportStoreList)); 
-        },
-        this.options,
-      );
-    }
-
-    if (this.options.reportUserNavigate) {
-      const href = window.location.href;
-      this.addReportRecord({
-        reportType: REPORT_TYPE.USER,
-        type: USER_TYPE.LOCATION_CHANGE,
-        message: `请求地址：${href}`,
-        extra: JSON.stringify({
-          url: href,
-        }),
-      });
-      reportUser.initRouteListener((record) => {
-        this.addReportRecord({
-          reportType: REPORT_TYPE.USER,
-          type: USER_TYPE.ROUTE_CHANGE,
-          message: `路由变化：${record.to}`,
-          extra: JSON.stringify({
-            route: record.to,
-          }),
-        });
-      });
-    }
-  }
-  addReportRecord(record) {
-    this.timer && clearTimeout(this.timer);
-    this.timer = setTimeout(() => {
-      try {
-        this.sendReport(JSON.parse(JSON.stringify(this.records)));
-        this.records = [];
-      } catch (error) {
-        console.log(error);
-      }
-    }, 1000);
-
-    this.records.push({
-      appId: this.options.appId,
-      appUrl: this.options.appUrl,
-      reportPath: window.location.pathname,
-      userAgent: window.navigator.userAgent,
-      ...record,
-      extra:
-        record.extra && typeof record.extra === "object"
-          ? JSON.stringify(record.extra)
-          : undefined,
-    });
-  }
-  sendReport(records) {
-    const analyticsData = {
-      appSecretKey: this.options.appSecretKey,
-      appId: this.options.appId,
-      data: records,
-    };
-    const blob = new Blob(
-      [JSON.stringify(analyticsData)], // 将JavaScript对象转换为JSON字符串
-      { type: "application/json; charset=UTF-8" }, // 在这里设置Content-Type
-    );
-    const success = navigator.sendBeacon(this.options.reportUrl, blob);
-    if (success) {
-      console.log("数据已成功加入发送队列。");
-      console.log(analyticsData);
-    } else {
-      console.log("数据入队失败，需要降级方案。");
-    }
-  }
-}
-
-let report;
-export function init(options = {}) {
-  if (!report) report = new Report(options);
-  report.init();
-}
-
-// // 导出所有模块
-// export {
-//   reportError,
-//   reportPerformance,
-//   reportRequest,
-//   reportUser,
-//   init
-// };
-export default {
-  init,
-};