@be-link/cls-logger 1.0.1-beta.16 → 1.0.1-beta.18

package/dist/index.js

@@ -158,9 +158,9 @@ class ClsLoggerCore {
         this.sdkLoaderOverride = null;
         this.client = null;
         this.clientPromise = null;
-        this.topicId = null;
-        this.endpoint = 'ap-shanghai.cls.tencentcs.com';
-        this.retryTimes = 10;
+        this.topicId = '17475bcd-6315-4b20-859c-e7b087fb3683';
+        this.endpoint = 'https://ap-shanghai.cls.tencentcs.com';
+        this.retryTimes = 3;
         this.source = '127.0.0.1';
         this.enabled = true;
         this.projectId = '';
@@ -180,6 +180,9 @@ class ClsLoggerCore {
         this.batchTimerDueAt = null;
         this.initTs = 0;
         this.startupDelayMs = 0;
+        this.useIdleCallback = false;
+        this.idleTimeout = 3000;
+        this.visibilityCleanup = null;
         // 参考文档：失败缓存 + 重试
         this.failedCacheKey = 'cls_failed_logs';
         this.failedCacheMax = 200;
@@ -205,10 +208,10 @@ class ClsLoggerCore {
     }
     init(options) {
         this.initTs = Date.now();
-        const topicId = options?.tencentCloud?.topicID ?? options?.topic_id ?? options?.topicID ?? this.topicId ?? null;
+        const topicId = options?.tencentCloud?.topicID ?? options?.topic_id ?? options?.topicID ?? this.topicId;
         const endpoint = options?.tencentCloud?.endpoint ?? options?.endpoint ?? this.endpoint;
         const retryTimes = options?.tencentCloud?.retry_times ?? options?.retry_times ?? this.retryTimes;
-        const source = options?.tencentCloud?.source ?? options?.source ?? this.source;
+        const source = options?.source ?? this.source;
         if (!topicId) {
             // eslint-disable-next-line no-console
             console.warn('ClsLogger.init 没有传 topicID/topic_id');
@@ -249,6 +252,8 @@ class ClsLoggerCore {
         this.batchMaxSize = options.batch?.maxSize ?? this.batchMaxSize;
         this.batchIntervalMs = options.batch?.intervalMs ?? this.batchIntervalMs;
         this.startupDelayMs = options.batch?.startupDelayMs ?? this.startupDelayMs;
+        this.useIdleCallback = options.batch?.useIdleCallback ?? this.useIdleCallback;
+        this.idleTimeout = options.batch?.idleTimeout ?? this.idleTimeout;
         this.failedCacheKey = options.failedCacheKey ?? this.failedCacheKey;
         this.failedCacheMax = options.failedCacheMax ?? this.failedCacheMax;
         // 预热（避免首条日志触发 import/初始化开销）
@@ -258,6 +263,8 @@ class ClsLoggerCore {
         if (this.enabled) {
             // 启动时尝试发送失败缓存
             this.flushFailed();
+            // 添加页面可见性监听（确保页面关闭时数据不丢失）
+            this.setupVisibilityListener();
             // 初始化后立即启动请求监听
             this.startRequestMonitor(options.requestMonitor);
             // 初始化后立即启动错误监控/性能监控
@@ -294,6 +301,89 @@ class ClsLoggerCore {
             return auto;
         return undefined;
     }
+    /**
+     * 设置页面可见性监听
+     * - visibilitychange: 页面隐藏时使用 sendBeacon 发送队列
+     * - pagehide: 作为移动端 fallback
+     */
+    setupVisibilityListener() {
+        if (typeof document === 'undefined' || typeof window === 'undefined')
+            return;
+        // 避免重复监听
+        if (this.visibilityCleanup)
+            return;
+        const handleVisibilityChange = () => {
+            if (document.visibilityState === 'hidden') {
+                this.flushBatchSync();
+            }
+        };
+        const handlePageHide = () => {
+            this.flushBatchSync();
+        };
+        document.addEventListener('visibilitychange', handleVisibilityChange);
+        window.addEventListener('pagehide', handlePageHide);
+        this.visibilityCleanup = () => {
+            document.removeEventListener('visibilitychange', handleVisibilityChange);
+            window.removeEventListener('pagehide', handlePageHide);
+        };
+    }
+    /**
+     * 同步发送内存队列（使用 sendBeacon）
+     * - 用于页面关闭时确保数据发送
+     * - sendBeacon 不可用时降级为缓存到 localStorage
+     */
+    flushBatchSync() {
+        if (this.memoryQueue.length === 0)
+            return;
+        // 清除定时器
+        if (this.batchTimer) {
+            try {
+                if (this.useIdleCallback && typeof cancelIdleCallback !== 'undefined') {
+                    cancelIdleCallback(this.batchTimer);
+                }
+                else {
+                    clearTimeout(this.batchTimer);
+                }
+            }
+            catch {
+                // ignore
+            }
+            this.batchTimer = null;
+        }
+        this.batchTimerDueAt = null;
+        const logs = [...this.memoryQueue];
+        this.memoryQueue = [];
+        // 优先使用 sendBeacon（页面关闭时可靠发送）
+        if (typeof navigator !== 'undefined' && typeof navigator.sendBeacon === 'function') {
+            try {
+                const payload = this.buildSendBeaconPayload(logs);
+                const blob = new Blob([payload], { type: 'application/json' });
+                const url = `${this.endpoint}/structuredlog?topic_id=${this.topicId}`;
+                const success = navigator.sendBeacon(url, blob);
+                if (!success) {
+                    // sendBeacon 返回 false 时，降级缓存
+                    this.cacheFailedReportLogs(logs);
+                }
+            }
+            catch {
+                this.cacheFailedReportLogs(logs);
+            }
+        }
+        else {
+            // 不支持 sendBeacon，降级缓存到 localStorage
+            this.cacheFailedReportLogs(logs);
+        }
+    }
+    /**
+     * 构建 sendBeacon 的 payload
+     */
+    buildSendBeaconPayload(logs) {
+        const logList = logs.map((log) => this.buildReportFields(log));
+        return JSON.stringify({
+            source: this.source,
+            logs: logList,
+        });
+    }
     startRequestMonitor(requestMonitor) {
         if (this.requestMonitorStarted)
             return;
@@ -548,25 +638,55 @@ class ClsLoggerCore {
         const desiredDelay = Math.max(0, desiredDueAt - now);
         if (!this.batchTimer) {
             this.batchTimerDueAt = desiredDueAt;
-            this.batchTimer = setTimeout(() => {
-                void this.flushBatch();
-            }, desiredDelay);
+            this.scheduleFlush(desiredDelay);
             return;
         }
-        // 启动合并窗口内：如果当前 timer 会“更早”触发，则延后到窗口结束，尽量减少多次发送
+        // 启动合并窗口内：如果当前 timer 会"更早"触发，则延后到窗口结束，尽量减少多次发送
         if (this.batchTimerDueAt !== null && this.batchTimerDueAt < desiredDueAt) {
-            try {
-                clearTimeout(this.batchTimer);
-            }
-            catch {
-                // ignore
-            }
+            this.cancelScheduledFlush();
             this.batchTimerDueAt = desiredDueAt;
+            this.scheduleFlush(desiredDelay);
+        }
+    }
+    /**
+     * 调度批量发送
+     * - 支持 requestIdleCallback（浏览器空闲时执行）
+     * - 降级为 setTimeout
+     */
+    scheduleFlush(desiredDelay) {
+        if (this.useIdleCallback && typeof requestIdleCallback !== 'undefined') {
+            // 使用 requestIdleCallback，设置 timeout 保证最终执行
+            const idleId = requestIdleCallback(() => {
+                void this.flushBatch();
+            }, { timeout: Math.max(desiredDelay, this.idleTimeout) });
+            // 存储 idleId 以便清理（类型兼容处理）
+            this.batchTimer = idleId;
+        }
+        else {
             this.batchTimer = setTimeout(() => {
                 void this.flushBatch();
             }, desiredDelay);
         }
     }
+    /**
+     * 取消已调度的批量发送
+     */
+    cancelScheduledFlush() {
+        if (!this.batchTimer)
+            return;
+        try {
+            if (this.useIdleCallback && typeof cancelIdleCallback !== 'undefined') {
+                cancelIdleCallback(this.batchTimer);
+            }
+            else {
+                clearTimeout(this.batchTimer);
+            }
+        }
+        catch {
+            // ignore
+        }
+        this.batchTimer = null;
+    }
     getDesiredBatchFlushDueAt(nowTs) {
         const start = this.initTs || nowTs;
         const startupDelay = Number.isFinite(this.startupDelayMs) ? Math.max(0, this.startupDelayMs) : 0;
@@ -577,7 +697,7 @@ class ClsLoggerCore {
         }
         return nowTs + this.batchIntervalMs;
     }
-    info(message, data = {}) {
+    info(message, data = {}, options) {
         let msg = '';
         let extra = {};
         if (message instanceof Error) {
@@ -593,9 +713,18 @@ class ClsLoggerCore {
             extra = data;
         }
         const payload = normalizeFlatFields({ message: msg, ...extra }, 'info');
-        this.report({ type: 'info', data: payload, timestamp: Date.now() });
+        const log = { type: 'info', data: payload, timestamp: Date.now() };
+        // info 默认走批量队列，支持 immediate 选项立即发送
+        if (options?.immediate) {
+            void this.sendReportLogs([log]).catch(() => {
+                this.cacheFailedReportLogs([log]);
+            });
+        }
+        else {
+            this.report(log);
+        }
     }
-    warn(message, data = {}) {
+    warn(message, data = {}, options) {
         let msg = '';
         let extra = {};
         if (message instanceof Error) {
@@ -611,9 +740,18 @@ class ClsLoggerCore {
             extra = data;
         }
         const payload = normalizeFlatFields({ message: msg, ...extra }, 'warn');
-        this.report({ type: 'warn', data: payload, timestamp: Date.now() });
+        const log = { type: 'warn', data: payload, timestamp: Date.now() };
+        // warn 默认走批量队列，支持 immediate 选项立即发送
+        if (options?.immediate) {
+            void this.sendReportLogs([log]).catch(() => {
+                this.cacheFailedReportLogs([log]);
+            });
+        }
+        else {
+            this.report(log);
+        }
     }
-    error(message, data = {}) {
+    error(message, data = {}, options) {
         let msg = '';
         let extra = {};
         if (message instanceof Error) {
@@ -629,7 +767,17 @@ class ClsLoggerCore {
             extra = data;
         }
         const payload = normalizeFlatFields({ message: msg, ...extra }, 'error');
-        this.report({ type: 'error', data: payload, timestamp: Date.now() });
+        const log = { type: 'error', data: payload, timestamp: Date.now() };
+        // error 默认即时上报，除非显式指定 immediate: false
+        const immediate = options?.immediate ?? true;
+        if (immediate) {
+            void this.sendReportLogs([log]).catch(() => {
+                this.cacheFailedReportLogs([log]);
+            });
+        }
+        else {
+            this.report(log);
+        }
     }
     track(trackType, data = {}) {
         if (!trackType)
@@ -644,10 +792,7 @@ class ClsLoggerCore {
      * 立即发送内存队列
      */
     async flushBatch() {
-        if (this.batchTimer) {
-            clearTimeout(this.batchTimer);
-            this.batchTimer = null;
-        }
+        this.cancelScheduledFlush();
         this.batchTimerDueAt = null;
         if (this.memoryQueue.length === 0)
             return;

package/dist/index.umd.js

@@ -160,9 +160,9 @@
             this.sdkLoaderOverride = null;
             this.client = null;
             this.clientPromise = null;
-            this.topicId = null;
-            this.endpoint = 'ap-shanghai.cls.tencentcs.com';
-            this.retryTimes = 10;
+            this.topicId = '17475bcd-6315-4b20-859c-e7b087fb3683';
+            this.endpoint = 'https://ap-shanghai.cls.tencentcs.com';
+            this.retryTimes = 3;
             this.source = '127.0.0.1';
             this.enabled = true;
             this.projectId = '';
@@ -182,6 +182,9 @@
             this.batchTimerDueAt = null;
             this.initTs = 0;
             this.startupDelayMs = 0;
+            this.useIdleCallback = false;
+            this.idleTimeout = 3000;
+            this.visibilityCleanup = null;
             // 参考文档：失败缓存 + 重试
             this.failedCacheKey = 'cls_failed_logs';
             this.failedCacheMax = 200;
@@ -207,10 +210,10 @@
         }
         init(options) {
             this.initTs = Date.now();
-            const topicId = options?.tencentCloud?.topicID ?? options?.topic_id ?? options?.topicID ?? this.topicId ?? null;
+            const topicId = options?.tencentCloud?.topicID ?? options?.topic_id ?? options?.topicID ?? this.topicId;
             const endpoint = options?.tencentCloud?.endpoint ?? options?.endpoint ?? this.endpoint;
             const retryTimes = options?.tencentCloud?.retry_times ?? options?.retry_times ?? this.retryTimes;
-            const source = options?.tencentCloud?.source ?? options?.source ?? this.source;
+            const source = options?.source ?? this.source;
             if (!topicId) {
                 // eslint-disable-next-line no-console
                 console.warn('ClsLogger.init 没有传 topicID/topic_id');
@@ -251,6 +254,8 @@
             this.batchMaxSize = options.batch?.maxSize ?? this.batchMaxSize;
             this.batchIntervalMs = options.batch?.intervalMs ?? this.batchIntervalMs;
             this.startupDelayMs = options.batch?.startupDelayMs ?? this.startupDelayMs;
+            this.useIdleCallback = options.batch?.useIdleCallback ?? this.useIdleCallback;
+            this.idleTimeout = options.batch?.idleTimeout ?? this.idleTimeout;
             this.failedCacheKey = options.failedCacheKey ?? this.failedCacheKey;
             this.failedCacheMax = options.failedCacheMax ?? this.failedCacheMax;
             // 预热（避免首条日志触发 import/初始化开销）
@@ -260,6 +265,8 @@
             if (this.enabled) {
                 // 启动时尝试发送失败缓存
                 this.flushFailed();
+                // 添加页面可见性监听（确保页面关闭时数据不丢失）
+                this.setupVisibilityListener();
                 // 初始化后立即启动请求监听
                 this.startRequestMonitor(options.requestMonitor);
                 // 初始化后立即启动错误监控/性能监控
@@ -296,6 +303,89 @@
                 return auto;
             return undefined;
         }
+        /**
+         * 设置页面可见性监听
+         * - visibilitychange: 页面隐藏时使用 sendBeacon 发送队列
+         * - pagehide: 作为移动端 fallback
+         */
+        setupVisibilityListener() {
+            if (typeof document === 'undefined' || typeof window === 'undefined')
+                return;
+            // 避免重复监听
+            if (this.visibilityCleanup)
+                return;
+            const handleVisibilityChange = () => {
+                if (document.visibilityState === 'hidden') {
+                    this.flushBatchSync();
+                }
+            };
+            const handlePageHide = () => {
+                this.flushBatchSync();
+            };
+            document.addEventListener('visibilitychange', handleVisibilityChange);
+            window.addEventListener('pagehide', handlePageHide);
+            this.visibilityCleanup = () => {
+                document.removeEventListener('visibilitychange', handleVisibilityChange);
+                window.removeEventListener('pagehide', handlePageHide);
+            };
+        }
+        /**
+         * 同步发送内存队列（使用 sendBeacon）
+         * - 用于页面关闭时确保数据发送
+         * - sendBeacon 不可用时降级为缓存到 localStorage
+         */
+        flushBatchSync() {
+            if (this.memoryQueue.length === 0)
+                return;
+            // 清除定时器
+            if (this.batchTimer) {
+                try {
+                    if (this.useIdleCallback && typeof cancelIdleCallback !== 'undefined') {
+                        cancelIdleCallback(this.batchTimer);
+                    }
+                    else {
+                        clearTimeout(this.batchTimer);
+                    }
+                }
+                catch {
+                    // ignore
+                }
+                this.batchTimer = null;
+            }
+            this.batchTimerDueAt = null;
+            const logs = [...this.memoryQueue];
+            this.memoryQueue = [];
+            // 优先使用 sendBeacon（页面关闭时可靠发送）
+            if (typeof navigator !== 'undefined' && typeof navigator.sendBeacon === 'function') {
+                try {
+                    const payload = this.buildSendBeaconPayload(logs);
+                    const blob = new Blob([payload], { type: 'application/json' });
+                    const url = `${this.endpoint}/structuredlog?topic_id=${this.topicId}`;
+                    const success = navigator.sendBeacon(url, blob);
+                    if (!success) {
+                        // sendBeacon 返回 false 时，降级缓存
+                        this.cacheFailedReportLogs(logs);
+                    }
+                }
+                catch {
+                    this.cacheFailedReportLogs(logs);
+                }
+            }
+            else {
+                // 不支持 sendBeacon，降级缓存到 localStorage
+                this.cacheFailedReportLogs(logs);
+            }
+        }
+        /**
+         * 构建 sendBeacon 的 payload
+         */
+        buildSendBeaconPayload(logs) {
+            const logList = logs.map((log) => this.buildReportFields(log));
+            return JSON.stringify({
+                source: this.source,
+                logs: logList,
+            });
+        }
         startRequestMonitor(requestMonitor) {
             if (this.requestMonitorStarted)
                 return;
@@ -550,25 +640,55 @@
             const desiredDelay = Math.max(0, desiredDueAt - now);
             if (!this.batchTimer) {
                 this.batchTimerDueAt = desiredDueAt;
-                this.batchTimer = setTimeout(() => {
-                    void this.flushBatch();
-                }, desiredDelay);
+                this.scheduleFlush(desiredDelay);
                 return;
             }
-            // 启动合并窗口内：如果当前 timer 会“更早”触发，则延后到窗口结束，尽量减少多次发送
+            // 启动合并窗口内：如果当前 timer 会"更早"触发，则延后到窗口结束，尽量减少多次发送
             if (this.batchTimerDueAt !== null && this.batchTimerDueAt < desiredDueAt) {
-                try {
-                    clearTimeout(this.batchTimer);
-                }
-                catch {
-                    // ignore
-                }
+                this.cancelScheduledFlush();
                 this.batchTimerDueAt = desiredDueAt;
+                this.scheduleFlush(desiredDelay);
+            }
+        }
+        /**
+         * 调度批量发送
+         * - 支持 requestIdleCallback（浏览器空闲时执行）
+         * - 降级为 setTimeout
+         */
+        scheduleFlush(desiredDelay) {
+            if (this.useIdleCallback && typeof requestIdleCallback !== 'undefined') {
+                // 使用 requestIdleCallback，设置 timeout 保证最终执行
+                const idleId = requestIdleCallback(() => {
+                    void this.flushBatch();
+                }, { timeout: Math.max(desiredDelay, this.idleTimeout) });
+                // 存储 idleId 以便清理（类型兼容处理）
+                this.batchTimer = idleId;
+            }
+            else {
                 this.batchTimer = setTimeout(() => {
                     void this.flushBatch();
                 }, desiredDelay);
             }
         }
+        /**
+         * 取消已调度的批量发送
+         */
+        cancelScheduledFlush() {
+            if (!this.batchTimer)
+                return;
+            try {
+                if (this.useIdleCallback && typeof cancelIdleCallback !== 'undefined') {
+                    cancelIdleCallback(this.batchTimer);
+                }
+                else {
+                    clearTimeout(this.batchTimer);
+                }
+            }
+            catch {
+                // ignore
+            }
+            this.batchTimer = null;
+        }
         getDesiredBatchFlushDueAt(nowTs) {
             const start = this.initTs || nowTs;
             const startupDelay = Number.isFinite(this.startupDelayMs) ? Math.max(0, this.startupDelayMs) : 0;
@@ -579,7 +699,7 @@
             }
             return nowTs + this.batchIntervalMs;
         }
-        info(message, data = {}) {
+        info(message, data = {}, options) {
             let msg = '';
             let extra = {};
             if (message instanceof Error) {
@@ -595,9 +715,18 @@
                 extra = data;
             }
             const payload = normalizeFlatFields({ message: msg, ...extra }, 'info');
-            this.report({ type: 'info', data: payload, timestamp: Date.now() });
+            const log = { type: 'info', data: payload, timestamp: Date.now() };
+            // info 默认走批量队列，支持 immediate 选项立即发送
+            if (options?.immediate) {
+                void this.sendReportLogs([log]).catch(() => {
+                    this.cacheFailedReportLogs([log]);
+                });
+            }
+            else {
+                this.report(log);
+            }
         }
-        warn(message, data = {}) {
+        warn(message, data = {}, options) {
             let msg = '';
             let extra = {};
             if (message instanceof Error) {
@@ -613,9 +742,18 @@
                 extra = data;
             }
             const payload = normalizeFlatFields({ message: msg, ...extra }, 'warn');
-            this.report({ type: 'warn', data: payload, timestamp: Date.now() });
+            const log = { type: 'warn', data: payload, timestamp: Date.now() };
+            // warn 默认走批量队列，支持 immediate 选项立即发送
+            if (options?.immediate) {
+                void this.sendReportLogs([log]).catch(() => {
+                    this.cacheFailedReportLogs([log]);
+                });
+            }
+            else {
+                this.report(log);
+            }
         }
-        error(message, data = {}) {
+        error(message, data = {}, options) {
             let msg = '';
             let extra = {};
             if (message instanceof Error) {
@@ -631,7 +769,17 @@
                 extra = data;
             }
             const payload = normalizeFlatFields({ message: msg, ...extra }, 'error');
-            this.report({ type: 'error', data: payload, timestamp: Date.now() });
+            const log = { type: 'error', data: payload, timestamp: Date.now() };
+            // error 默认即时上报，除非显式指定 immediate: false
+            const immediate = options?.immediate ?? true;
+            if (immediate) {
+                void this.sendReportLogs([log]).catch(() => {
+                    this.cacheFailedReportLogs([log]);
+                });
+            }
+            else {
+                this.report(log);
+            }
         }
         track(trackType, data = {}) {
             if (!trackType)
@@ -646,10 +794,7 @@
          * 立即发送内存队列
          */
         async flushBatch() {
-            if (this.batchTimer) {
-                clearTimeout(this.batchTimer);
-                this.batchTimer = null;
-            }
+            this.cancelScheduledFlush();
             this.batchTimerDueAt = null;
             if (this.memoryQueue.length === 0)
                 return;