@be-link/cls-logger 1.0.1-beta.17 → 1.0.1-beta.19

package/dist/index.umd.js

@@ -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;
@@ -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;
@@ -1294,6 +1439,13 @@
     const DEFAULT_MAX_TEXT$1 = 4000;
     const DEFAULT_DEDUPE_WINDOW_MS$1 = 3000;
     const DEFAULT_DEDUPE_MAX_KEYS$1 = 200;
+    /** 默认忽略的无意义错误信息 */
+    const DEFAULT_IGNORE_MESSAGES$1 = [
+        'Script error.',
+        'Script error',
+        /^ResizeObserver loop/,
+        'Permission was denied',
+    ];
     function truncate$3(s, maxLen) {
         if (!s)
             return s;
@@ -1306,6 +1458,17 @@
             return false;
         return Math.random() < sampleRate;
     }
+    /** 检查消息是否应该被忽略 */
+    function shouldIgnoreMessage$1(message, ignorePatterns) {
+        if (!message || ignorePatterns.length === 0)
+            return false;
+        return ignorePatterns.some((pattern) => {
+            if (typeof pattern === 'string') {
+                return message === pattern || message.includes(pattern);
+            }
+            return pattern.test(message);
+        });
+    }
     function getPagePath$1() {
         try {
             if (typeof window === 'undefined')
@@ -1401,6 +1564,9 @@
                 };
                 if (event && typeof event === 'object' && 'message' in event) {
                     payload.message = truncate$3(String(event.message ?? ''), options.maxTextLength);
+                    // 检查是否应该忽略此错误
+                    if (shouldIgnoreMessage$1(String(event.message ?? ''), options.ignoreMessages))
+                        return;
                     payload.filename = truncate$3(String(event.filename ?? ''), 500);
                     payload.lineno = typeof event.lineno === 'number' ? event.lineno : undefined;
                     payload.colno = typeof event.colno === 'number' ? event.colno : undefined;
@@ -1439,6 +1605,9 @@
                     return;
                 const reason = event?.reason;
                 const e = normalizeErrorLike$1(reason, options.maxTextLength);
+                // 检查是否应该忽略此错误
+                if (shouldIgnoreMessage$1(e.message, options.ignoreMessages))
+                    return;
                 const payload = {
                     pagePath: getPagePath$1(),
                     source: 'unhandledrejection',
@@ -1468,6 +1637,7 @@
             maxTextLength: raw.maxTextLength ?? DEFAULT_MAX_TEXT$1,
             dedupeWindowMs: raw.dedupeWindowMs ?? DEFAULT_DEDUPE_WINDOW_MS$1,
             dedupeMaxKeys: raw.dedupeMaxKeys ?? DEFAULT_DEDUPE_MAX_KEYS$1,
+            ignoreMessages: raw.ignoreMessages ?? DEFAULT_IGNORE_MESSAGES$1,
         };
         installBrowserErrorMonitor(report, options);
     }
@@ -1475,6 +1645,13 @@
     const DEFAULT_MAX_TEXT = 4000;
     const DEFAULT_DEDUPE_WINDOW_MS = 3000;
     const DEFAULT_DEDUPE_MAX_KEYS = 200;
+    /** 默认忽略的无意义错误信息 */
+    const DEFAULT_IGNORE_MESSAGES = [
+        'Script error.',
+        'Script error',
+        /^ResizeObserver loop/,
+        'Permission was denied',
+    ];
     function truncate$2(s, maxLen) {
         if (!s)
             return s;
@@ -1487,6 +1664,17 @@
             return false;
         return Math.random() < sampleRate;
     }
+    /** 检查消息是否应该被忽略 */
+    function shouldIgnoreMessage(message, ignorePatterns) {
+        if (!message || ignorePatterns.length === 0)
+            return false;
+        return ignorePatterns.some((pattern) => {
+            if (typeof pattern === 'string') {
+                return message === pattern || message.includes(pattern);
+            }
+            return pattern.test(message);
+        });
+    }
     function getMpPagePath() {
         try {
             const pages = globalThis.getCurrentPages?.();
@@ -1581,6 +1769,9 @@
                         if (!sampleHit$2(options.sampleRate))
                             return;
                         const e = normalizeErrorLike(msg, options.maxTextLength);
+                        // 检查是否应该忽略此错误
+                        if (shouldIgnoreMessage(e.message, options.ignoreMessages))
+                            return;
                         const payload = {
                             pagePath: getMpPagePath(),
                             source: 'wx.onError',
@@ -1608,6 +1799,9 @@
                         if (!sampleHit$2(options.sampleRate))
                             return;
                         const e = normalizeErrorLike(res?.reason, options.maxTextLength);
+                        // 检查是否应该忽略此错误
+                        if (shouldIgnoreMessage(e.message, options.ignoreMessages))
+                            return;
                         const payload = {
                             pagePath: getMpPagePath(),
                             source: 'wx.onUnhandledRejection',
@@ -1639,15 +1833,18 @@
                         try {
                             if (sampleHit$2(options.sampleRate)) {
                                 const e = normalizeErrorLike(args?.[0], options.maxTextLength);
-                                const payload = {
-                                    pagePath: getMpPagePath(),
-                                    source: 'App.onError',
-                                    message: e.message,
-                                    errorName: e.name,
-                                    stack: e.stack,
-                                };
-                                if (shouldReport(buildErrorKey(options.reportType, payload)))
-                                    report(options.reportType, payload);
+                                // 检查是否应该忽略此错误
+                                if (!shouldIgnoreMessage(e.message, options.ignoreMessages)) {
+                                    const payload = {
+                                        pagePath: getMpPagePath(),
+                                        source: 'App.onError',
+                                        message: e.message,
+                                        errorName: e.name,
+                                        stack: e.stack,
+                                    };
+                                    if (shouldReport(buildErrorKey(options.reportType, payload)))
+                                        report(options.reportType, payload);
+                                }
                             }
                         }
                         catch {
@@ -1663,15 +1860,18 @@
                             if (sampleHit$2(options.sampleRate)) {
                                 const reason = args?.[0]?.reason ?? args?.[0];
                                 const e = normalizeErrorLike(reason, options.maxTextLength);
-                                const payload = {
-                                    pagePath: getMpPagePath(),
-                                    source: 'App.onUnhandledRejection',
-                                    message: e.message,
-                                    errorName: e.name,
-                                    stack: e.stack,
-                                };
-                                if (shouldReport(buildErrorKey(options.reportType, payload)))
-                                    report(options.reportType, payload);
+                                // 检查是否应该忽略此错误
+                                if (!shouldIgnoreMessage(e.message, options.ignoreMessages)) {
+                                    const payload = {
+                                        pagePath: getMpPagePath(),
+                                        source: 'App.onUnhandledRejection',
+                                        message: e.message,
+                                        errorName: e.name,
+                                        stack: e.stack,
+                                    };
+                                    if (shouldReport(buildErrorKey(options.reportType, payload)))
+                                        report(options.reportType, payload);
+                                }
                             }
                         }
                         catch {
@@ -1702,6 +1902,7 @@
             maxTextLength: raw.maxTextLength ?? DEFAULT_MAX_TEXT,
             dedupeWindowMs: raw.dedupeWindowMs ?? DEFAULT_DEDUPE_WINDOW_MS,
             dedupeMaxKeys: raw.dedupeMaxKeys ?? DEFAULT_DEDUPE_MAX_KEYS,
+            ignoreMessages: raw.ignoreMessages ?? DEFAULT_IGNORE_MESSAGES,
         };
         installMiniProgramErrorMonitor(report, options);
     }

package/dist/mini/errorMonitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorMonitor.d.ts","sourceRoot":"","sources":["../../src/mini/errorMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGhE,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;AAoNzD,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAE,OAAO,GAAG,mBAAmB,GAAG,SAAc,GAAG,IAAI,CAgBpH"}
+{"version":3,"file":"errorMonitor.d.ts","sourceRoot":"","sources":["../../src/mini/errorMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGhE,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;AAuPzD,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAE,OAAO,GAAG,mBAAmB,GAAG,SAAc,GAAG,IAAI,CAiBpH"}