@pluve/mp-logger-sdk 0.0.1

package/dist/esm/core/loggerSDK.js

@@ -0,0 +1,560 @@
+// src/core/loggerSDK.ts
+import { getRegisterApi } from "../config";
+import { TransportAdapter } from "../transport/transportAdapter";
+import { collectEnvironmentTags, getCurrentUrl } from "../utils/environment";
+import { registerWechatErrorCapture, registerWechatUnhandledCapture } from "../capture/wechatError";
+import { getSessionId } from "../utils/session";
+import { flattenStack, hashToProb, logDebug, now, normalizeMessage } from "../utils/tools";
+import { uuid } from "../utils/uuid";
+import { HttpClient } from "./httpClient";
+import { QueueManager } from "./queueManager";
+import { RetryManager } from "./retryManager";
+import { md5 } from "../utils/innerMD5";
+var LoggerSDK = class {
+  constructor() {
+    /** 事件序列编号，用于事件去重 */
+    this.seq = 0;
+    /** 是否已关闭 */
+    this.closed = false;
+    /** 预收集的环境信息 tags（仅用于初始化上报） */
+    this.envTags = {};
+    /** 是否已初始化 */
+    this.initialized = false;
+    /** 是否正在上报 */
+    this.isSending = false;
+    this.collectSwitch = 0;
+    // 采集开关，0：关闭，1：开启
+    this.collectLogLevel = [];
+    // 采集日志等级
+    this.recentAutoEvents = /* @__PURE__ */ new Map();
+    this.sessionId = getSessionId();
+  }
+  static getInstance() {
+    if (!LoggerSDK.instance) {
+      LoggerSDK.instance = new LoggerSDK();
+    }
+    return LoggerSDK.instance;
+  }
+  /**
+   * 初始化：配置参数、收集环境信息与 UA，并生成 sessionId，完成初始上报
+   */
+  init(options) {
+    this.opts = {
+      // endpoint: options.endpoint,
+      appId: `${options.appId}`,
+      // 统一与 zadig 部署应用 APPID 保持一致
+      env: options.env || "develop",
+      /** 日志环境 */
+      logStage: options.logStage,
+      debug: !!options.debug,
+      /** 是否启用 gzip 压缩，默认 true */
+      enableGzip: options.enableGzip !== false,
+      // 默认启用，但仅在批量模式开启情况下有效
+      gzipBatchMinSize: options.gzipBatchMinSize || 2,
+      // 默认 2 条数据开启 gzip 压缩
+      /** 最大像素图 URL 长度，默认 1900 */
+      maxPixelUrlLen: options.maxPixelUrlLen || 8192,
+      // 批量上报配置（默认关闭，需显式开启）
+      enableBatch: options.enableBatch === true,
+      batchSize: options.batchSize || 20,
+      batchInterval: options.batchInterval || 15e3,
+      // 默认 15 秒批量上报一次，在开启批量上报的情况下
+      maxQueueSize: options.maxQueueSize || 100,
+      // 持久化存储配置
+      enableStorage: options.enableBatch === true || options.enableStorage !== false,
+      // 默认启用
+      storagePrefix: options.storagePrefix || "logger_sdk",
+      // 重试配置
+      enableRetry: options.enableRetry !== false,
+      // 默认启用
+      maxRetries: options.maxRetries || 3,
+      retryDelay: options.retryDelay || 1e3,
+      retryBackoff: options.retryBackoff !== false,
+      // 默认启用
+      userId: options.userId,
+      storeCode: options.storeCode,
+      token: options.token,
+      sampleRate: typeof options.sampleRate === "number" ? options.sampleRate : 1,
+      levelSampleRate: options.levelSampleRate || {
+        ERROR: 0.8,
+        WARN: 0.5,
+        INFO: 0.1,
+        FATAL: 1
+      },
+      sourceSampleRate: options.sourceSampleRate || {
+        js: 0.8,
+        promise: 0.5,
+        resource: 0.2,
+        custom: 1
+      },
+      pathSampleRate: options.pathSampleRate || {
+        "/": 1
+      },
+      enableAutoCapture: options.enableAutoCapture !== false,
+      // 默认启用
+      autoCapture: options.autoCapture || {
+        js: true,
+        promise: true,
+        resource: true,
+        wechat: true
+      }
+    };
+    if (this.opts.enableBatch) {
+      this.queueManager = new QueueManager({
+        maxSize: this.opts.maxQueueSize,
+        enableStorage: this.opts.enableStorage,
+        storagePrefix: this.opts.storagePrefix,
+        debug: this.opts.debug
+      });
+    }
+    if (this.opts.enableRetry) {
+      this.retryManager = new RetryManager({
+        maxRetries: this.opts.maxRetries,
+        baseDelay: this.opts.retryDelay,
+        useBackoff: this.opts.retryBackoff,
+        debug: this.opts.debug
+      });
+    }
+    this.transporter = void 0;
+    this.sessionId = getSessionId();
+    this.envTags = collectEnvironmentTags();
+    this.initSDK(this.opts, (data) => {
+      var _a, _b, _c, _d, _e;
+      this.collectSwitch = data.collectSwitch;
+      this.collectLogLevel = data.collectLogLevel;
+      this.opts.sampleRate = data.samplingRate;
+      if ((_a = this.opts) == null ? void 0 : _a.enableBatch) {
+        this.startBatchTimer();
+      }
+      this.initialized = true;
+      const enableAuto = ((_b = this.opts) == null ? void 0 : _b.enableAutoCapture) !== false;
+      const ac = ((_c = this.opts) == null ? void 0 : _c.autoCapture) || {};
+      if (enableAuto && ac.wechat !== false) {
+        this.offWxError = registerWechatErrorCapture(!!((_d = this.opts) == null ? void 0 : _d.debug), this.trackInner.bind(this));
+        this.offWxUnhandled = registerWechatUnhandledCapture(!!((_e = this.opts) == null ? void 0 : _e.debug), this.trackInner.bind(this));
+      }
+    });
+  }
+  /**
+   * 设置 token 信息
+   * @param token token
+   */
+  setToken(token) {
+    var _a;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "setToken", token);
+    if (this.opts) {
+      this.opts.token = token;
+    }
+  }
+  /**
+   * 设置用户信息
+   */
+  identify(userId) {
+    var _a;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "identify", userId);
+    if (this.opts) {
+      this.opts.userId = userId;
+    }
+  }
+  /** 设置店铺编码 */
+  setStoreCode(storeCode) {
+    var _a;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "setStoreCode", storeCode);
+    if (this.opts) {
+      this.opts.storeCode = storeCode;
+    }
+  }
+  /** 设置日志 stage（env） */
+  setStage(stage) {
+    var _a;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "setStage", stage);
+    if (this.opts) {
+      this.opts.env = stage;
+    }
+  }
+  flattenEnvTags() {
+    return Object.entries(this.envTags || {}).map(([k, v]) => `${k}=${v}`).join(",");
+  }
+  async track({ message, error, traceId, logLevel = "INFO" }) {
+    var _a, _b, _c;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "track", { message, error, traceId, logLevel });
+    if (this.closed)
+      return;
+    if (!this.initialized) {
+      logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), "SDK not initialized, skip track");
+      return;
+    }
+    if (!this.shouldSend(logLevel, "custom", getCurrentUrl(), traceId, message)) {
+      logDebug(!!((_c = this.opts) == null ? void 0 : _c.debug), "Event sampled out", { logLevel, traceId, message });
+      return;
+    }
+    this.seq += 1;
+    let errorLocation = "";
+    let throwableStack = "";
+    if (error instanceof Error) {
+      try {
+        const { location, throwable } = await flattenStack(error);
+        errorLocation = location || "";
+        throwableStack = throwable || error.stack || "";
+      } catch {
+        errorLocation = "";
+        throwableStack = error.stack || "";
+      }
+    }
+    const logEvent = {
+      /** 日志 ID */
+      logId: `${this.opts.appId}${uuid()}${now()}`,
+      // UUID
+      seq: this.seq,
+      /** 应用标识 */
+      appId: this.opts.appId || "unknown",
+      /** 环境标识 */
+      stage: this.opts.logStage,
+      /** 日志级别：info/warn/error/fatal */
+      level: logLevel,
+      /** 可选：跟踪 ID（跨服务调用链跟踪） */
+      traceId,
+      /** 会话标识，同 sessionId */
+      frontendId: this.sessionId,
+      // 同 sessionId
+      /** 发生页面 URL */
+      url: getCurrentUrl(),
+      location: errorLocation,
+      /** 异常信息 */
+      message: `[message]: ${message}; [envTags]: ${this.flattenEnvTags()}; [t]: ${now()}`,
+      /** 可选：堆栈信息（长字符串） */
+      throwable: throwableStack,
+      /** 可选：用户 ID（脱敏） */
+      userId: this.opts.userId,
+      /** 可选：店铺编码 */
+      storeCode: this.opts.storeCode
+      /** 可选的结构化额外信息 */
+      // tags: this.envTags,
+    };
+    this.doTrack(logEvent);
+  }
+  trackInner(error) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    if (this.closed)
+      return;
+    if (!this.initialized) {
+      logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "SDK not initialized, skip track");
+      return;
+    }
+    logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), "trackInner", error);
+    const sig = `${error.type}|${normalizeMessage(error.message)}|${String(this.sessionId || "")}`;
+    const ts = now();
+    const last = this.recentAutoEvents.get(sig) || 0;
+    if (ts - last < 3e3) {
+      return;
+    }
+    this.recentAutoEvents.set(sig, ts);
+    if (!this.shouldSend("ERROR", error.type, getCurrentUrl(), void 0, error.message)) {
+      logDebug(!!((_c = this.opts) == null ? void 0 : _c.debug), "Auto-captured event sampled out", error.message);
+      return;
+    }
+    this.seq += 1;
+    let errorLocation = "";
+    const throwableStack = ((_d = error.stack) == null ? void 0 : _d.map((frame) => `${frame.file}:${frame.line}:${frame.column}`).join("\n	")) || "";
+    if (error.stack && error.stack.length > 0) {
+      errorLocation = `${(_e = error.stack) == null ? void 0 : _e[0].file}:${(_f = error.stack) == null ? void 0 : _f[0].line}:${(_g = error.stack) == null ? void 0 : _g[0].column}:${(_h = error.stack) == null ? void 0 : _h[0].function}`;
+    }
+    const logEvent = {
+      /** 日志 ID */
+      logId: `${this.opts.appId}${uuid()}${now()}`,
+      // UUID
+      seq: this.seq,
+      /** 应用标识 */
+      appId: this.opts.appId || "unknown",
+      /** 环境标识 */
+      stage: this.opts.env || "develop",
+      /** 日志级别：info/warn/error/fatal */
+      level: "ERROR",
+      /** 会话标识，同 sessionId */
+      frontendId: this.sessionId,
+      // 同 sessionId
+      /** 发生页面 URL */
+      url: getCurrentUrl(),
+      location: errorLocation,
+      /** 异常信息 */
+      message: `[message]: ${error.message}; [envTags]: ${this.flattenEnvTags()}; [t]: ${now()}`,
+      /** 可选：堆栈信息（长字符串） */
+      throwable: throwableStack,
+      /** 可选：用户 ID（脱敏） */
+      userId: this.opts.userId,
+      /** 可选：店铺编码 */
+      storeCode: this.opts.storeCode
+      /** 可选的结构化额外信息 */
+      // tags: this.envTags,
+    };
+    this.doTrack(logEvent);
+  }
+  /**
+   * 判断是否应该发送事件
+   */
+  shouldSend(level, source, url, traceId, message) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if (level === "FATAL")
+      return true;
+    if (this.collectSwitch === 0) {
+      logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "Collect switch is off, skip track");
+      return false;
+    }
+    if (!this.collectLogLevel.some((l) => l === level)) {
+      logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), `Log level(${level}) not in collect log level, skip track`);
+      return false;
+    }
+    const levelRate = (_d = (_c = this.opts) == null ? void 0 : _c.levelSampleRate) == null ? void 0 : _d[level];
+    const sourceRate = (_f = (_e = this.opts) == null ? void 0 : _e.sourceSampleRate) == null ? void 0 : _f[source];
+    let pathRate;
+    const pathMap = ((_g = this.opts) == null ? void 0 : _g.pathSampleRate) || {};
+    const prefixes = Object.keys(pathMap);
+    if (prefixes.length) {
+      let best = "";
+      for (let i = 0; i < prefixes.length; i += 1) {
+        const p2 = prefixes[i];
+        if (url.startsWith(p2) && p2.length >= best.length)
+          best = p2;
+      }
+      if (best)
+        pathRate = pathMap[best];
+    }
+    const baseRate = (() => {
+      var _a2;
+      if (typeof levelRate === "number")
+        return levelRate;
+      if (typeof sourceRate === "number")
+        return sourceRate;
+      if (typeof pathRate === "number")
+        return pathRate;
+      const sr = (_a2 = this.opts) == null ? void 0 : _a2.sampleRate;
+      return typeof sr === "number" ? sr : 1;
+    })();
+    const rate = Math.max(0, Math.min(1, baseRate));
+    if (rate >= 1)
+      return true;
+    const seed = `${String(traceId || "")}|${String(message || "")}|${String(this.sessionId || "")}|${String(level)}|${String(source)}|${String(url)}`;
+    const p = hashToProb(seed);
+    return p < rate;
+  }
+  /**
+   * 记录事件
+   */
+  async doTrack(logEvent) {
+    var _a, _b, _c;
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "track", logEvent);
+    if (this.opts.enableBatch && this.queueManager) {
+      this.queueManager.enqueue(logEvent);
+      if (this.queueManager.size() >= this.opts.batchSize) {
+        logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), "Queue size reached batch size, flushing immediately");
+        await this.flush();
+      }
+    } else {
+      try {
+        await this.sendEvent(logEvent);
+      } catch (e) {
+        logDebug(!!((_c = this.opts) == null ? void 0 : _c.debug), "track failed", e);
+      }
+    }
+  }
+  /**
+   * 手动刷新队列，立即上报所有待发送日志
+   */
+  async flush() {
+    var _a, _b, _c, _d;
+    if (!this.queueManager || this.queueManager.size() === 0) {
+      return;
+    }
+    if (this.isSending) {
+      logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), "Already sending, skip flush");
+      return;
+    }
+    this.isSending = true;
+    logDebug(!!((_b = this.opts) == null ? void 0 : _b.debug), `Flushing ${this.queueManager.size()} events`);
+    try {
+      const events = this.queueManager.peek(this.queueManager.size());
+      if (events.length === 0) {
+        return;
+      }
+      await this.sendBatch(events);
+      this.queueManager.dequeue(events.length);
+      logDebug(!!((_c = this.opts) == null ? void 0 : _c.debug), `Flushed ${events.length} events successfully`);
+    } catch (error) {
+      logDebug(!!((_d = this.opts) == null ? void 0 : _d.debug), "Flush failed", error);
+    } finally {
+      this.isSending = false;
+    }
+  }
+  /**
+   * 销毁实例
+   */
+  async destroy() {
+    this.closed = true;
+    if (this.batchTimer) {
+      clearInterval(this.batchTimer);
+      this.batchTimer = null;
+    }
+    await this.flush();
+    if (this.queueManager) {
+      this.queueManager.clear();
+    }
+    if (this.retryManager) {
+      this.retryManager.clear();
+    }
+    if (this.offWxError) {
+      this.offWxError();
+      this.offWxError = void 0;
+    }
+    if (this.offWxUnhandled) {
+      this.offWxUnhandled();
+      this.offWxUnhandled = void 0;
+    }
+    this.initialized = false;
+    this.sessionId = void 0;
+    LoggerSDK.instance = void 0;
+  }
+  generateToken() {
+    var _a;
+    return ((_a = this.opts) == null ? void 0 : _a.token) || md5(`${this.opts.appId}${this.opts.logStage}${now()}`);
+  }
+  // ========== 内部方法 ===========
+  /**
+   * 发送单个事件（带重试）
+   */
+  async sendEvent(event) {
+    const sendFn = async () => {
+      const transporter = this.transporter || await TransportAdapter.getInstance(this.opts).getTransporter();
+      this.transporter = transporter;
+      await transporter.send(this.generateToken(), {
+        appId: event.appId,
+        appStage: event.stage,
+        items: [
+          {
+            level: event.level === "FATAL" ? "ERROR" : event.level,
+            traceId: event.traceId,
+            frontendId: event.frontendId,
+            location: event.location,
+            message: event.message,
+            throwable: event.throwable
+          }
+        ]
+      });
+    };
+    if (this.opts.enableRetry && this.retryManager) {
+      await this.retryManager.executeWithRetry(event.logId, sendFn);
+    } else {
+      await sendFn();
+    }
+  }
+  /**
+   * 批量发送事件（带重试）
+   */
+  async sendBatch(events) {
+    var _a;
+    if (events.length === 0)
+      return;
+    const groups = /* @__PURE__ */ new Map();
+    for (let i = 0; i < events.length; i += 1) {
+      const e = events[i];
+      const key = `${e.appId}|${e.stage}`;
+      const arr = groups.get(key);
+      if (arr)
+        arr.push(e);
+      else
+        groups.set(key, [e]);
+    }
+    const batchSize = Math.min(200, ((_a = this.opts) == null ? void 0 : _a.batchSize) || 50);
+    const entries = Array.from(groups.entries());
+    const tasks = [];
+    for (let gi = 0; gi < entries.length; gi += 1) {
+      const [key, group] = entries[gi];
+      group.sort((a, b) => a.seq - b.seq);
+      for (let i = 0; i < group.length; i += batchSize) {
+        const chunk = group.slice(i, i + batchSize);
+        if (chunk.length > 0) {
+          const batchId = `batch_${now()}_${Math.random().toString(36).substring(2, 9)}_${key}_${i}`;
+          const sendFn = async () => {
+            const transporter = this.transporter || await TransportAdapter.getInstance(this.opts).getTransporter();
+            this.transporter = transporter;
+            await transporter.send(this.generateToken(), {
+              appId: chunk[0].appId,
+              appStage: chunk[0].stage,
+              items: chunk.map((event) => ({
+                level: event.level === "FATAL" ? "ERROR" : event.level,
+                traceId: event.traceId,
+                frontendId: event.frontendId,
+                location: event.location,
+                message: event.message,
+                throwable: event.throwable
+              }))
+            });
+          };
+          const task = this.opts.enableRetry && this.retryManager ? this.retryManager.executeWithRetry(batchId, sendFn) : sendFn();
+          tasks.push(task);
+        }
+      }
+    }
+    await Promise.all(tasks);
+  }
+  /**
+   * 启动批量上报定时器
+   */
+  startBatchTimer() {
+    var _a;
+    if (this.batchTimer)
+      return;
+    this.batchTimer = setInterval(() => {
+      var _a2;
+      if (!this.closed && this.queueManager && this.queueManager.size() > 0) {
+        logDebug(!!((_a2 = this.opts) == null ? void 0 : _a2.debug), "Batch timer triggered, flushing queue");
+        this.flush().catch((error) => {
+          var _a3;
+          logDebug(!!((_a3 = this.opts) == null ? void 0 : _a3.debug), "Batch timer flush failed", error);
+        });
+      }
+    }, this.opts.batchInterval);
+    logDebug(!!((_a = this.opts) == null ? void 0 : _a.debug), `Batch timer started with interval ${this.opts.batchInterval}ms`);
+  }
+  /**
+   * 初始化 SDK（注册/初始化）
+   */
+  initSDK(opts, onSuccess) {
+    var _a;
+    HttpClient.post(
+      getRegisterApi(((_a = this.opts) == null ? void 0 : _a.env) || "develop"),
+      {
+        appId: opts.appId,
+        message: "init",
+        appStage: opts.logStage,
+        location: "",
+        userId: opts.userId,
+        storeCode: opts.storeCode
+      },
+      this.generateToken()
+    ).then(async (response) => {
+      var _a2;
+      logDebug(!!((_a2 = this.opts) == null ? void 0 : _a2.debug), "Register success", response);
+      if (!response) {
+        return;
+      }
+      const { type, response: res, error } = response;
+      let isSuccess = false;
+      let data;
+      if (type === "wechat" && (res == null ? void 0 : res.statusCode) === 200) {
+        isSuccess = true;
+        data = res.data.data;
+      }
+      if (isSuccess && data) {
+        onSuccess(data);
+      }
+    }).catch((err) => {
+      var _a2;
+      logDebug(!!((_a2 = this.opts) == null ? void 0 : _a2.debug), "Failed to initialize SDK", err);
+    });
+  }
+};
+var loggerSDK_default = LoggerSDK;
+export {
+  LoggerSDK,
+  loggerSDK_default as default
+};

package/dist/esm/core/queueManager.js

@@ -0,0 +1,101 @@
+// src/core/queueManager.ts
+import { logDebug, safeStringify } from "../utils/tools";
+var QueueManager = class {
+  constructor(options) {
+    this.queue = [];
+    this.opts = options;
+    this.storageKey = `${options.storagePrefix}_queue`;
+    if (this.opts.enableStorage) {
+      this.loadFromStorage();
+    }
+  }
+  /**
+   * 添加日志到队列
+   */
+  enqueue(event) {
+    if (this.queue.length >= this.opts.maxSize) {
+      this.queue.shift();
+      logDebug(!!this.opts.debug, "Queue full, dropped oldest event");
+    }
+    this.queue.push(event);
+    logDebug(!!this.opts.debug, "Enqueued event", event);
+    if (this.opts.enableStorage) {
+      this.saveToStorage();
+    }
+    return true;
+  }
+  /**
+   * 批量获取日志（不移除）
+   */
+  peek(count) {
+    return this.queue.slice(0, count);
+  }
+  /**
+   * 批量移除日志
+   */
+  dequeue(count) {
+    const items = this.queue.splice(0, count);
+    logDebug(!!this.opts.debug, `Dequeued ${items.length} events`);
+    if (this.opts.enableStorage) {
+      this.saveToStorage();
+    }
+    return items;
+  }
+  /**
+   * 获取队列长度
+   */
+  size() {
+    return this.queue.length;
+  }
+  /**
+   * 清空队列
+   */
+  clear() {
+    this.queue = [];
+    logDebug(!!this.opts.debug, "Queue cleared");
+    if (this.opts.enableStorage) {
+      this.removeFromStorage();
+    }
+  }
+  /**
+   * 从持久化存储加载队列
+   */
+  loadFromStorage() {
+    try {
+      const stored = wx.getStorageSync(this.storageKey);
+      if (stored) {
+        const parsed = JSON.parse(stored);
+        if (Array.isArray(parsed)) {
+          this.queue = parsed.slice(0, this.opts.maxSize);
+          logDebug(!!this.opts.debug, `Loaded ${this.queue.length} events from storage`);
+        }
+      }
+    } catch (error) {
+      logDebug(!!this.opts.debug, "Failed to load queue from storage", error);
+    }
+  }
+  /**
+   * 保存队列到持久化存储
+   */
+  saveToStorage() {
+    try {
+      const data = safeStringify(this.queue);
+      wx.setStorageSync(this.storageKey, data);
+    } catch (error) {
+      logDebug(!!this.opts.debug, "Failed to save queue to storage", error);
+    }
+  }
+  /**
+   * 从持久化存储移除队列
+   */
+  removeFromStorage() {
+    try {
+      wx.removeStorageSync(this.storageKey);
+    } catch (error) {
+      logDebug(!!this.opts.debug, "Failed to remove queue from storage", error);
+    }
+  }
+};
+export {
+  QueueManager
+};