@pluve/logger-sdk 0.0.1 → 0.0.2

package/dist/cjs/loggerSDK.js

@@ -1,8 +1,6 @@
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -16,14 +14,6 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/loggerSDK.ts
@@ -33,391 +23,133 @@ __export(loggerSDK_exports, {
   default: () => loggerSDK_default
 });
 module.exports = __toCommonJS(loggerSDK_exports);
-var import_dbQueue = __toESM(require("./dbQueue"));
 var import_transportAdapter = require("./transportAdapter");
 var import_utils = require("./utils");
-var import_storeAdapter = require("./storeAdapter");
 var LoggerSDK = class {
   constructor(options) {
-    this.inMemoryQueue = [];
     this.seq = 0;
-    this.timerId = null;
-    this.storage = null;
     this.closed = false;
-    this.idbQueue = null;
-    this.flushing = false;
-    const defaults = {
-      endpoints: options.endpoints || {},
-      appId: options.appId || "",
-      env: options.env || (() => {
-        if ((0, import_utils.isWeChatMiniProgram)())
-          return "wechat";
-        if ((0, import_utils.isBrowser)())
-          return "h5";
-        return "unknown";
-      })(),
-      batchSize: options.batchSize || 10,
-      flushInterval: options.flushInterval || 5e3,
-      retryCount: options.retryCount || 3,
-      retryBase: options.retryBase || 300,
-      storageKey: options.storageKey || "logger_sdk_cache_v2",
-      maxCacheSize: options.maxCacheSize || 2e3,
-      timeout: options.timeout || 1e4,
+    this.opts = {
+      endpoint: options.endpoint,
+      appId: options.appId || "unknown",
+      env: options.env || "dev",
       debug: !!options.debug,
-      transport: options.transport || import_transportAdapter.defaultTransport,
-      globalHeaders: options.globalHeaders || {},
-      enableAutoPV: options.enableAutoPV !== false,
-      enablePerf: options.enablePerf !== false,
-      usePixel: options.usePixel || false,
       pixelParam: options.pixelParam || "data",
       maxPixelUrlLen: options.maxPixelUrlLen || 1900
     };
-    this.opts = Object.assign(defaults, options);
-    this.env = this.opts.env;
-    if (this.env === "wechat")
-      this.storage = (0, import_storeAdapter.wechatStorage)(this.opts.storageKey);
-    else if (this.env === "h5")
-      this.storage = (0, import_storeAdapter.browserStorage)(this.opts.storageKey);
-    else
-      this.storage = null;
-    if ((0, import_utils.isBrowser)() && (0, import_utils.isIndexedDBAvailable)()) {
-      this.idbQueue = new import_dbQueue.default("logger_sdk_db", "queue");
-      this.idbQueue.open().catch(() => {
-        this.idbQueue = null;
-      });
-    }
-    this.loadFromStorage().then(() => {
-      if (this.opts.flushInterval > 0)
-        this.startTimer();
-    });
-    this.attachGlobalHandlers();
-    if (this.opts.enableAutoPV && this.env === "h5")
-      this.installAutoPV();
-    if (this.opts.enablePerf && this.env === "h5") {
-      if (document.readyState === "complete")
-        this.collectPerf();
-      else
-        window.addEventListener("load", () => this.collectPerf());
-    }
+    this.envTags = this.collectEnvironmentTags();
+    this.attachUnloadHandlers();
   }
   logDebug(...args) {
     if (this.opts.debug)
       console.debug("[LoggerSDK]", ...args);
   }
-  async loadFromStorage() {
-    if (!this.storage)
-      return;
-    try {
-      const raw = await this.storage.get();
-      if (raw) {
-        const arr = JSON.parse(raw);
-        this.inMemoryQueue = arr.concat(this.inMemoryQueue).slice(-this.opts.maxCacheSize);
-        this.logDebug("loaded persisted queue", this.inMemoryQueue.length);
-      }
-    } catch (e) {
-      this.logDebug("load persisted fail", e);
-    }
-  }
-  async persistToStorage() {
-    if (!this.storage)
-      return;
-    try {
-      await this.storage.set((0, import_utils.safeStringify)(this.inMemoryQueue));
-      this.logDebug("persisted queue", this.inMemoryQueue.length);
-    } catch (e) {
-      this.logDebug("persist fail", e);
+  /**
+   * 收集环境信息并生成 tags（仅在初始化时执行一次）
+   */
+  collectEnvironmentTags() {
+    const envInfo = (0, import_utils.getEnvironmentInfo)();
+    const tags = {
+      platform: envInfo.platform
+    };
+    if (envInfo.platform === "browser" && envInfo.userAgent) {
+      const browserInfo = (0, import_utils.parseBrowserInfo)(envInfo.userAgent);
+      tags.browser = browserInfo.browser;
+      tags.browserVersion = browserInfo.browserVersion;
+      tags.os = browserInfo.os;
+      tags.osVersion = browserInfo.osVersion;
+      tags.screenWidth = envInfo.screenWidth;
+      tags.screenHeight = envInfo.screenHeight;
+      tags.language = envInfo.language;
+    } else if (envInfo.platform === "wechat" && envInfo.systemInfo) {
+      tags.brand = envInfo.systemInfo.brand;
+      tags.model = envInfo.systemInfo.model;
+      tags.system = envInfo.systemInfo.system;
+      tags.wechatVersion = envInfo.systemInfo.version;
+      tags.SDKVersion = envInfo.systemInfo.SDKVersion;
+      tags.screenWidth = envInfo.screenWidth;
+      tags.screenHeight = envInfo.screenHeight;
+      tags.language = envInfo.language;
     }
+    this.logDebug("Environment tags collected:", tags);
+    return tags;
   }
-  startTimer() {
-    if (this.timerId)
-      return;
-    this.timerId = setInterval(() => this.flush().catch(() => {
-    }), this.opts.flushInterval);
-  }
-  stopTimer() {
-    if (!this.timerId)
-      return;
-    clearInterval(this.timerId);
-    this.timerId = null;
-  }
-  // 将事件入队（先到内存，再持久化）
-  async track(event, headers) {
+  /**
+   * 记录事件
+   */
+  async track(eventType, message, options) {
     if (this.closed)
       return;
     this.seq += 1;
-    const e = {
-      type: event.type || "custom",
-      time: event.time || (0, import_utils.now)(),
-      user: event.user || void 0,
-      ctx: event.ctx || {},
-      level: event.level || "info",
-      seq: this.seq
-    };
-    this.inMemoryQueue.push(e);
-    this.logDebug("enqueue", e);
-    await this.persistToStorage();
-    if (this.idbQueue) {
-      try {
-        await this.idbQueue.add(e);
-      } catch (err) {
-        this.logDebug("idb add fail", err);
+    const logEvent = {
+      eventType,
+      ts: (0, import_utils.now)(),
+      appId: this.opts.appId || "unknown",
+      env: this.opts.env || "dev",
+      level: (options == null ? void 0 : options.level) || "info",
+      message,
+      stack: options == null ? void 0 : options.stack,
+      url: (0, import_utils.getCurrentUrl)(),
+      userId: options == null ? void 0 : options.userId,
+      sessionId: (0, import_utils.getSessionId)(),
+      // 合并预收集的环境 tags 和用户自定义 tags
+      tags: {
+        ...this.envTags,
+        ...(options == null ? void 0 : options.tags) || {}
       }
-    }
-    if (this.inMemoryQueue.length >= this.opts.batchSize) {
-      await this.flush(headers).catch(() => {
-      });
-    }
-  }
-  // flush：从队列中取一批发送（按 level 分 endpoint，支持部分成功剔除）
-  async flush(extraHeaders) {
-    if (this.closed)
-      return;
-    if (this.inMemoryQueue.length === 0)
-      return;
-    if (this.flushing)
-      return;
-    this.flushing = true;
+    };
+    this.logDebug("track", logEvent);
     try {
-      const batch = this.inMemoryQueue.slice(0, this.opts.batchSize);
-      const groups = {};
-      batch.forEach((ev) => {
-        const level = ev.level || "info";
-        (groups[level] = groups[level] || []).push(ev);
-      });
-      const delay = (ms) => new Promise((r) => setTimeout(r, ms));
-      const sendGroup = (level, events) => {
-        const endpoint = this.opts.endpoints[level] || this.opts.endpoints.default;
-        const payload = { appId: this.opts.appId, env: this.env, ts: (0, import_utils.now)(), level, events };
-        const maxTry = this.opts.retryCount;
-        const attemptOnce = (attempt) => {
-          const transportOpts = { ...this.opts, endpoint, headers: { ...this.opts.globalHeaders || {}, ...extraHeaders || {} } };
-          return this.opts.transport(payload, transportOpts).then(() => true).catch(async (err) => {
-            const next = attempt + 1;
-            this.logDebug("send fail", level, next, err);
-            if (next > maxTry)
-              return false;
-            const wait = (this.opts.retryBase || 300) * 2 ** (next - 1);
-            await delay(wait);
-            return attemptOnce(next);
-          });
-        };
-        return attemptOnce(0).then((ok) => ({ ok, level, events }));
-      };
-      const results = await Promise.all(Object.keys(groups).map((level) => sendGroup(level, groups[level])));
-      const successLevels = new Set(results.filter((r) => r.ok).map((r) => r.level));
-      const allOk = results.length > 0 && results.every((r) => r.ok);
-      if (!allOk && successLevels.size === 0) {
-        this.logDebug("batch send failed, keep batch in queue");
-        return;
-      }
-      const removeSeq = new Set(batch.filter((e) => successLevels.has(e.level || "info")).map((e) => e.seq));
-      this.inMemoryQueue = this.inMemoryQueue.filter((x) => !removeSeq.has(x.seq));
-      await this.persistToStorage();
-      if (allOk && this.idbQueue) {
-        try {
-          await this.idbQueue.clear();
-        } catch (e) {
-          this.logDebug("idb clear fail", e);
-        }
-      }
-    } finally {
-      this.flushing = false;
+      await (0, import_transportAdapter.defaultTransport)(logEvent, this.opts);
+    } catch (error) {
+      this.logDebug("track failed", error);
     }
   }
-  // 将队列尽力全部发送（分批轮询 + 安全阈值）
-  async flushAll() {
-    let safety = 0;
-    return new Promise((resolve) => {
-      const tick = async () => {
-        safety += 1;
-        if (this.inMemoryQueue.length === 0 || safety >= 200)
-          return resolve();
-        if (!this.flushing) {
-          try {
-            await this.flush();
-          } catch {
-          }
-        }
-        setTimeout(tick, 50);
-      };
-      tick();
-    });
-  }
-  async identify(user) {
-    this.opts.appId = user && user.appId || this.opts.appId;
-    this.logDebug("identify", user);
-  }
-  async setCommon(params) {
-    Object.assign(this.opts, params);
-    this.logDebug("setCommon", params);
+  /**
+   * 设置用户信息
+   */
+  identify(userId) {
+    this.logDebug("identify", userId);
   }
+  /**
+   * 销毁实例
+   */
   destroy() {
-    this.stopTimer();
     this.closed = true;
   }
-  // ========== 自动采集与错误处理 ===========
-  attachGlobalHandlers() {
-    if (this.env === "h5" && typeof window !== "undefined") {
-      const win = window;
-      win.addEventListener && win.addEventListener("error", (ev) => {
-        try {
-          this.track({ type: "error", level: "error", ctx: { message: ev.message, filename: ev.filename, lineno: ev.lineno, colno: ev.colno, stack: ev.error && ev.error.stack } });
-        } catch {
-        }
-      });
-      win.addEventListener && win.addEventListener("unhandledrejection", (ev) => {
-        try {
-          this.track({ type: "error", level: "error", ctx: { reason: ev.reason && (ev.reason.stack || ev.reason) } });
-        } catch {
-        }
-      });
-      win.addEventListener && win.addEventListener(
-        "error",
-        (ev) => {
-          if (ev.target && (ev.target.src || ev.target.href)) {
-            try {
-              this.track({ type: "error", level: "warn", ctx: { resource: ev.target.src || ev.target.href, tag: ev.target.tagName } });
-            } catch {
-            }
-          }
-        },
-        true
-      );
-      document.addEventListener && document.addEventListener("visibilitychange", () => {
-        try {
-          if (document.visibilityState === "hidden")
-            this.flushBeacon();
-        } catch {
-        }
-      });
-      win.addEventListener && win.addEventListener("pagehide", () => {
-        try {
-          this.flushBeacon();
-        } catch {
-        }
-      });
-      win.addEventListener && win.addEventListener("beforeunload", () => {
-        try {
-          this.flushBeacon();
-        } catch {
-        }
-      });
+  // ========== 自动采集 ===========
+  /**
+   * 监听页面卸载事件
+   */
+  attachUnloadHandlers() {
+    if ((0, import_utils.isWeChatMiniProgram)()) {
+      this.logDebug("WeChat MiniProgram environment detected");
+      return;
     }
-  }
-  // 自动 PV（single-page 支持简单的 history 池监听）
-  installAutoPV() {
     if (!(0, import_utils.isBrowser)())
       return;
-    const { history, location } = window;
-    const { pushState } = history;
-    const { replaceState } = history;
-    const onUrlChange = () => {
+    const win = window;
+    document.addEventListener && document.addEventListener("visibilitychange", () => {
       try {
-        this.track({ type: "pageview", level: "info", ctx: { path: location.pathname + location.search, title: document.title } });
+        if (document.visibilityState === "hidden") {
+          console.log("Page hidden");
+        }
       } catch {
       }
-    };
-    history.pushState = function(...args) {
-      pushState.apply(this, args);
-      window.dispatchEvent(new Event("locationchange"));
-    };
-    history.replaceState = function(...args) {
-      replaceState.apply(this, args);
-      window.dispatchEvent(new Event("locationchange"));
-    };
-    window.addEventListener("popstate", () => window.dispatchEvent(new Event("locationchange")));
-    window.addEventListener("locationchange", onUrlChange);
-    onUrlChange();
-  }
-  // 性能采集（Navigation timing + Paint）
-  collectPerf() {
-    if (!(0, import_utils.isBrowser)() || !("performance" in window))
-      return;
-    try {
-      const perf = window.performance;
-      const nav = perf.getEntriesByType && perf.getEntriesByType("navigation") && perf.getEntriesByType("navigation")[0];
-      const paints = perf.getEntriesByType ? perf.getEntriesByType("paint") : [];
-      const data = {};
-      if (nav) {
-        data.ttfb = nav.responseStart - nav.requestStart;
-        data.domContentLoaded = nav.domContentLoadedEventEnd - nav.startTime;
-        data.load = nav.loadEventEnd - nav.startTime;
-      } else if (perf.timing) {
-        const t = perf.timing;
-        data.ttfb = t.responseStart - t.requestStart;
-        data.domContentLoaded = t.domContentLoadedEventEnd - t.navigationStart;
-        data.load = t.loadEventEnd - t.navigationStart;
-      }
-      if (paints && paints.length) {
-        paints.forEach((p) => {
-          data[p.name] = p.startTime;
-        });
+    });
+    win.addEventListener && win.addEventListener("pagehide", () => {
+      try {
+        console.log("Page hide");
+      } catch {
       }
-      this.track({ type: "perf", level: "info", ctx: data });
-    } catch (e) {
-      this.logDebug("collect perf fail", e);
-    }
-  }
-  flushBeacon() {
-    if (!(0, import_utils.isBrowser)())
-      return;
-    if (this.inMemoryQueue.length === 0)
-      return;
-    const groups = {};
-    this.inMemoryQueue.forEach((ev) => {
-      const level = ev.level || "info";
-      (groups[level] = groups[level] || []).push(ev);
     });
-    Object.keys(groups).forEach((level) => {
-      const events = groups[level];
-      const endpoint = this.opts.endpoints[level] || this.opts.endpoints.default;
-      const payload = { appId: this.opts.appId, env: this.env, ts: (0, import_utils.now)(), level, events };
-      const transportOpts = {
-        ...this.opts,
-        endpoint,
-        headers: { ...this.opts.globalHeaders || {} },
-        useBeacon: true,
-        usePixel: this.opts.usePixel,
-        pixelParam: this.opts.pixelParam,
-        maxPixelUrlLen: this.opts.maxPixelUrlLen
-      };
+    win.addEventListener && win.addEventListener("beforeunload", () => {
       try {
-        this.opts.transport(payload, transportOpts);
+        console.log("Page unload");
       } catch {
       }
     });
   }
-  // 生成简单 Demo 页面（HTML 字符串），方便生成 demo 文档站点
-  //   public generateDemoHtml(opts?: { scriptUrl?: string }) {
-  //     const scriptUrl = (opts && opts.scriptUrl) || 'dist/index.umd.js';
-  //     const html = ```
-  //     <!doctype html>
-  // <html>
-  // <head>
-  // <meta charset="utf-8" />
-  // <title>LoggerSDK Demo</title>
-  // </head>
-  // <body>
-  // <h1>LoggerSDK Demo</h1>
-  // <script src="${scriptUrl}"></script>
-  // <script>
-  // // 通过 UMD 全局 MyLogger 使用
-  // const sdk = new MyLogger.LoggerSDK({
-  //   endpoints: { default: '/api/collect', info: '/api/collect/info', error: '/api/collect/error' },
-  //   appId: 'demo-app',
-  //   debug: true,
-  //   enableAutoPV: true,
-  //   enablePerf: true
-  // });
-  // // 手动埋点
-  // sdk.track({ type: 'custom', level: 'info', ctx: { action: 'click_demo' } });
-  // // 模拟错误
-  // setTimeout(() => { throw new Error('demo error'); }, 2000);
-  // </script>
-  // </body>
-  // </html>```;
-  //     return html;
-  //   }
 };
 var loggerSDK_default = LoggerSDK;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/transportAdapter.d.ts

@@ -1,5 +1,51 @@
-import { SDKOptions } from "./types";
-export declare function defaultTransport(payload: any, opts?: SDKOptions & {
-    endpoint?: string;
-    headers?: Record<string, string>;
-}): Promise<void>;
+import { SDKOptions } from './types';
+/** 传输选项接口 */
+export interface TransportOptions extends Omit<SDKOptions, 'endpoint'> {
+    endpoint: string;
+}
+/** 传输适配器接口 */
+export interface TransportAdapter {
+    /** 适配器名称 */
+    name: string;
+    /** 是否支持当前环境 */
+    isSupported(opts?: TransportOptions): boolean;
+    /** 发送数据 */
+    send(payload: any, opts?: TransportOptions): Promise<void>;
+}
+/**
+ * Beacon 传输适配器
+ * - 兼容性：现代浏览器（Chrome 39+, Firefox 31+, Edge 14+）
+ * - 健壮性：页面卸载时可靠传输、不阻塞页面卸载
+ * - 适用场景：页面关闭、visibilitychange、pagehide、beforeunload 事件
+ * - 限制：无法获取响应、队列有大小限制（通常 64KB）
+ */
+export declare const beaconTransport: TransportAdapter;
+/**
+ * 微信小程序传输适配器
+ * - 兼容性：微信小程序环境
+ * - 健壮性：支持超时控制、完善的错误处理
+ * - 适用场景：微信小程序环境下的日志上报
+ */
+export declare const wechatTransport: TransportAdapter;
+/**
+ * Image 像素上报适配器
+ * - 兼容性：所有浏览器
+ * - 健壮性：轻量级、无跨域限制、支持超时控制
+ * - 适用场景：数据量小的快速上报、跨域场景、降级方案
+ * - 限制：URL 长度限制（默认 1900 字符）
+ */
+export declare const imageTransport: TransportAdapter;
+/**
+ * 默认传输函数 - 按环境选择最佳传输方式
+ * 浏览器策略：Beacon（可靠） > Image（兼容）
+ * 微信小程序策略：WeChat Request
+ */
+export declare function defaultTransport(payload: any, opts?: TransportOptions): Promise<void>;
+/**
+ * 导出所有适配器，方便自定义使用
+ */
+export declare const TransportAdapters: {
+    beacon: TransportAdapter;
+    wechat: TransportAdapter;
+    image: TransportAdapter;
+};