@pluve/logger-sdk 0.0.3 → 0.0.5

package/dist/loggerSDK.js

@@ -11,7 +11,9 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 import { defaultTransport } from "./transportAdapter";
-import { isBrowser, isWeChatMiniProgram, now, getSessionId, getCurrentUrl, getEnvironmentInfo, parseBrowserInfo } from "./utils";
+import { isBrowser, isWeChatMiniProgram, now, getSessionId, getCurrentUrl, getEnvironmentInfo, parseBrowserInfo, generateUUID } from "./utils";
+import { QueueManager } from "./queueManager";
+import { RetryManager } from "./retryManager";
 export var LoggerSDK = /*#__PURE__*/function () {
   function LoggerSDK(options) {
     _classCallCheck(this, LoggerSDK);
@@ -20,18 +22,68 @@ export var LoggerSDK = /*#__PURE__*/function () {
     _defineProperty(this, "closed", false);
     /** 预收集的环境信息 tags */
     _defineProperty(this, "envTags", void 0);
+    /** 队列管理器 */
+    _defineProperty(this, "queueManager", void 0);
+    /** 重试管理器 */
+    _defineProperty(this, "retryManager", void 0);
+    /** 批量上报定时器 */
+    _defineProperty(this, "batchTimer", void 0);
+    /** 是否正在上报 */
+    _defineProperty(this, "isSending", false);
     this.opts = {
       endpoint: options.endpoint,
       appId: options.appId || 'unknown',
       env: options.env || 'dev',
       debug: !!options.debug,
       pixelParam: options.pixelParam || 'data',
-      maxPixelUrlLen: options.maxPixelUrlLen || 1900
+      maxPixelUrlLen: options.maxPixelUrlLen || 1900,
+      enableGzip: !!options.enableGzip,
+      // 批量上报配置
+      enableBatch: options.enableBatch !== false,
+      // 默认启用
+      batchSize: options.batchSize || 10,
+      batchInterval: options.batchInterval || 5000,
+      maxQueueSize: options.maxQueueSize || 100,
+      // 持久化存储配置
+      enableStorage: options.enableStorage !== false,
+      // 默认启用
+      storagePrefix: options.storagePrefix || 'logger_sdk',
+      // 重试配置
+      enableRetry: options.enableRetry !== false,
+      // 默认启用
+      maxRetries: options.maxRetries || 3,
+      retryDelay: options.retryDelay || 1000,
+      retryBackoff: options.retryBackoff !== false // 默认启用
     };
 
     // 初始化时收集环境信息
     this.envTags = this.collectEnvironmentTags();
 
+    // 初始化队列管理器
+    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
+      });
+    }
+
+    // 启动批量上报定时器
+    if (this.opts.enableBatch) {
+      this.startBatchTimer();
+    }
+
     // 监听页面卸载事件
     this.attachUnloadHandlers();
   }
@@ -88,7 +140,7 @@ export var LoggerSDK = /*#__PURE__*/function () {
   }, {
     key: "track",
     value: (function () {
-      var _track = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(eventType, message, options) {
+      var _track = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(eventType, message, traceId, options) {
         var logEvent;
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
@@ -103,6 +155,9 @@ export var LoggerSDK = /*#__PURE__*/function () {
 
               // 构建标准化日志格式
               logEvent = {
+                logId: "".concat(this.opts.appId).concat(generateUUID()).concat(now()),
+                // UUID
+                traceId: traceId,
                 eventType: eventType,
                 ts: now(),
                 appId: this.opts.appId || 'unknown',
@@ -117,24 +172,43 @@ export var LoggerSDK = /*#__PURE__*/function () {
                 tags: _objectSpread(_objectSpread({}, this.envTags), (options === null || options === void 0 ? void 0 : options.tags) || {})
               };
               this.logDebug('track', logEvent);
-              _context.prev = 5;
-              _context.next = 8;
-              return defaultTransport(logEvent, this.opts);
-            case 8:
-              _context.next = 13;
+
+              // 如果启用批量上报，添加到队列
+              if (!(this.opts.enableBatch && this.queueManager)) {
+                _context.next = 13;
+                break;
+              }
+              this.queueManager.enqueue(logEvent);
+              // 如果队列已满，立即上报
+              if (!(this.queueManager.size() >= this.opts.batchSize)) {
+                _context.next = 11;
+                break;
+              }
+              this.logDebug('Queue size reached batch size, flushing immediately');
+              _context.next = 11;
+              return this.flush();
+            case 11:
+              _context.next = 21;
+              break;
+            case 13:
+              _context.prev = 13;
+              _context.next = 16;
+              return this.sendEvent(logEvent);
+            case 16:
+              _context.next = 21;
               break;
-            case 10:
-              _context.prev = 10;
-              _context.t0 = _context["catch"](5);
+            case 18:
+              _context.prev = 18;
+              _context.t0 = _context["catch"](13);
               this.logDebug('track failed', _context.t0);
               // 静默失败，不影响主流程
-            case 13:
+            case 21:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[5, 10]]);
+        }, _callee, this, [[13, 18]]);
       }));
-      function track(_x, _x2, _x3) {
+      function track(_x, _x2, _x3, _x4) {
         return _track.apply(this, arguments);
       }
       return track;
@@ -150,13 +224,241 @@ export var LoggerSDK = /*#__PURE__*/function () {
       // userId 将在 track 时传入
     }
 
+    /**
+     * 手动刷新队列，立即上报所有待发送日志
+     */
+  }, {
+    key: "flush",
+    value: (function () {
+      var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+        var events;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              if (!(!this.queueManager || this.queueManager.size() === 0)) {
+                _context2.next = 2;
+                break;
+              }
+              return _context2.abrupt("return");
+            case 2:
+              if (!this.isSending) {
+                _context2.next = 5;
+                break;
+              }
+              this.logDebug('Already sending, skip flush');
+              return _context2.abrupt("return");
+            case 5:
+              this.isSending = true;
+              this.logDebug("Flushing ".concat(this.queueManager.size(), " events"));
+              _context2.prev = 7;
+              // 获取所有待发送的日志（不移除）
+              events = this.queueManager.peek(this.queueManager.size());
+              if (!(events.length === 0)) {
+                _context2.next = 11;
+                break;
+              }
+              return _context2.abrupt("return");
+            case 11:
+              _context2.next = 13;
+              return this.sendBatch(events);
+            case 13:
+              // 发送成功后，从队列中移除
+              this.queueManager.dequeue(events.length);
+              this.logDebug("Flushed ".concat(events.length, " events successfully"));
+              _context2.next = 20;
+              break;
+            case 17:
+              _context2.prev = 17;
+              _context2.t0 = _context2["catch"](7);
+              this.logDebug('Flush failed', _context2.t0);
+              // 失败不移除队列，下次继续重试
+            case 20:
+              _context2.prev = 20;
+              this.isSending = false;
+              return _context2.finish(20);
+            case 23:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[7, 17, 20, 23]]);
+      }));
+      function flush() {
+        return _flush.apply(this, arguments);
+      }
+      return flush;
+    }()
     /**
      * 销毁实例
      */
+    )
   }, {
     key: "destroy",
-    value: function destroy() {
-      this.closed = true;
+    value: (function () {
+      var _destroy = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              this.closed = true;
+
+              // 停止批量上报定时器
+              if (this.batchTimer) {
+                clearInterval(this.batchTimer);
+                this.batchTimer = null;
+              }
+
+              // 刷新队列
+              _context3.next = 4;
+              return this.flush();
+            case 4:
+              // 清理资源
+              if (this.queueManager) {
+                this.queueManager.clear();
+              }
+              if (this.retryManager) {
+                this.retryManager.clear();
+              }
+            case 6:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function destroy() {
+        return _destroy.apply(this, arguments);
+      }
+      return destroy;
+    }() // ========== 内部方法 ===========
+    /**
+     * 发送单个事件（带重试）
+     */
+    )
+  }, {
+    key: "sendEvent",
+    value: function () {
+      var _sendEvent = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(event) {
+        var _this = this;
+        var sendFn;
+        return _regeneratorRuntime().wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
+            case 0:
+              sendFn = /*#__PURE__*/function () {
+                var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4() {
+                  return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+                    while (1) switch (_context4.prev = _context4.next) {
+                      case 0:
+                        _context4.next = 2;
+                        return defaultTransport(event, _this.opts);
+                      case 2:
+                      case "end":
+                        return _context4.stop();
+                    }
+                  }, _callee4);
+                }));
+                return function sendFn() {
+                  return _ref.apply(this, arguments);
+                };
+              }(); // 如果启用重试
+              if (!(this.opts.enableRetry && this.retryManager)) {
+                _context5.next = 6;
+                break;
+              }
+              _context5.next = 4;
+              return this.retryManager.executeWithRetry(event.logId, sendFn);
+            case 4:
+              _context5.next = 8;
+              break;
+            case 6:
+              _context5.next = 8;
+              return sendFn();
+            case 8:
+            case "end":
+              return _context5.stop();
+          }
+        }, _callee5, this);
+      }));
+      function sendEvent(_x5) {
+        return _sendEvent.apply(this, arguments);
+      }
+      return sendEvent;
+    }()
+    /**
+     * 批量发送事件（带重试）
+     */
+  }, {
+    key: "sendBatch",
+    value: (function () {
+      var _sendBatch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(events) {
+        var _this2 = this;
+        var batchId, sendFn;
+        return _regeneratorRuntime().wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
+            case 0:
+              if (!(events.length === 0)) {
+                _context7.next = 2;
+                break;
+              }
+              return _context7.abrupt("return");
+            case 2:
+              // 生成批次 ID
+              batchId = "batch_".concat(now(), "_").concat(Math.random().toString(36).substring(2, 9));
+              sendFn = /*#__PURE__*/function () {
+                var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee6() {
+                  return _regeneratorRuntime().wrap(function _callee6$(_context6) {
+                    while (1) switch (_context6.prev = _context6.next) {
+                      case 0:
+                        _context6.next = 2;
+                        return defaultTransport(events, _this2.opts);
+                      case 2:
+                      case "end":
+                        return _context6.stop();
+                    }
+                  }, _callee6);
+                }));
+                return function sendFn() {
+                  return _ref2.apply(this, arguments);
+                };
+              }(); // 如果启用重试
+              if (!(this.opts.enableRetry && this.retryManager)) {
+                _context7.next = 9;
+                break;
+              }
+              _context7.next = 7;
+              return this.retryManager.executeWithRetry(batchId, sendFn);
+            case 7:
+              _context7.next = 11;
+              break;
+            case 9:
+              _context7.next = 11;
+              return sendFn();
+            case 11:
+            case "end":
+              return _context7.stop();
+          }
+        }, _callee7, this);
+      }));
+      function sendBatch(_x6) {
+        return _sendBatch.apply(this, arguments);
+      }
+      return sendBatch;
+    }()
+    /**
+     * 启动批量上报定时器
+     */
+    )
+  }, {
+    key: "startBatchTimer",
+    value: function startBatchTimer() {
+      var _this3 = this;
+      if (this.batchTimer) return;
+      this.batchTimer = setInterval(function () {
+        if (!_this3.closed && _this3.queueManager && _this3.queueManager.size() > 0) {
+          _this3.logDebug('Batch timer triggered, flushing queue');
+          _this3.flush().catch(function (error) {
+            _this3.logDebug('Batch timer flush failed', error);
+          });
+        }
+      }, this.opts.batchInterval);
+      this.logDebug("Batch timer started with interval ".concat(this.opts.batchInterval, "ms"));
     }
 
     // ========== 自动采集 ===========
@@ -167,6 +469,7 @@ export var LoggerSDK = /*#__PURE__*/function () {
   }, {
     key: "attachUnloadHandlers",
     value: function attachUnloadHandlers() {
+      var _this4 = this;
       // 微信小程序环境
       if (isWeChatMiniProgram()) {
         // 微信小程序使用 App 生命周期
@@ -183,11 +486,11 @@ export var LoggerSDK = /*#__PURE__*/function () {
       document.addEventListener && document.addEventListener('visibilitychange', function () {
         try {
           if (document.visibilityState === 'hidden') {
-            // this.track('pageview', 'Page hidden', {
-            //   level: 'info',
-            //   tags: { action: 'page_hidden' },
-            // });
-            console.log('Page hidden');
+            // 页面隐藏时刷新队列
+            _this4.flush().catch(function () {
+              // 忽略错误
+            });
+            console.log('Page hidden, flushed queue');
           }
         } catch (_unused) {
           //
@@ -197,11 +500,11 @@ export var LoggerSDK = /*#__PURE__*/function () {
       // 页面隐藏
       win.addEventListener && win.addEventListener('pagehide', function () {
         try {
-          // this.track('pageview', 'Page hide', {
-          //   level: 'info',
-          //   tags: { action: 'page_hide' },
-          // });
-          console.log('Page hide');
+          // 页面隐藏时刷新队列（同步）
+          _this4.flush().catch(function () {
+            // 忽略错误
+          });
+          console.log('Page hide, flushed queue');
         } catch (_unused2) {
           //
         }
@@ -210,11 +513,11 @@ export var LoggerSDK = /*#__PURE__*/function () {
       // 页面卸载前
       win.addEventListener && win.addEventListener('beforeunload', function () {
         try {
-          // this.track('pageview', 'Page unload', {
-          //   level: 'info',
-          //   tags: { action: 'page_unload' },
-          // });
-          console.log('Page unload');
+          // 页面卸载前刷新队列（同步）
+          _this4.flush().catch(function () {
+            // 忽略错误
+          });
+          console.log('Page unload, flushed queue');
         } catch (_unused3) {
           //
         }

package/dist/queueManager.d.ts

@@ -0,0 +1,59 @@
+import { LogEvent } from './types';
+/** 队列配置选项 */
+export interface QueueOptions {
+    /** 队列最大长度 */
+    maxSize: number;
+    /** 是否启用持久化存储 */
+    enableStorage: boolean;
+    /** 存储 key 前缀 */
+    storagePrefix: string;
+    /** 调试模式 */
+    debug?: boolean;
+}
+/**
+ * 队列管理器
+ * - 内存队列：快速访问
+ * - 持久化存储：防止页面刷新/关闭时数据丢失
+ */
+export declare class QueueManager {
+    private queue;
+    private opts;
+    private storageKey;
+    constructor(options: QueueOptions);
+    /**
+     * 添加日志到队列
+     */
+    enqueue(event: LogEvent): boolean;
+    /**
+     * 批量获取日志（不移除）
+     */
+    peek(count: number): LogEvent[];
+    /**
+     * 批量移除日志
+     */
+    dequeue(count: number): LogEvent[];
+    /**
+     * 获取队列长度
+     */
+    size(): number;
+    /**
+     * 清空队列
+     */
+    clear(): void;
+    /**
+     * 从持久化存储加载队列
+     */
+    private loadFromStorage;
+    /**
+     * 保存队列到持久化存储
+     */
+    private saveToStorage;
+    /**
+     * 从持久化存储移除队列
+     */
+    private removeFromStorage;
+    /**
+     * 调试日志
+     */
+    private logDebug;
+}