@be-link/cls-logger 1.0.1-beta.4 → 1.0.1-beta.6

package/dist/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('tencentcloud-cls-sdk-js-web')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'tencentcloud-cls-sdk-js-web'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.BeLinkClsLogger = {}, global.tencentcloudClsSdkJsWeb));
-})(this, (function (exports, tencentcloudClsSdkJsWeb) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+    typeof define === 'function' && define.amd ? define(['exports'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.BeLinkClsLogger = {}));
+})(this, (function (exports) { 'use strict';
 
     function isPlainObject(value) {
         return Object.prototype.toString.call(value) === '[object Object]';
@@ -1909,9 +1909,20 @@
             g.__beLinkClsLoggerSendingCount__ = cur > 0 ? cur - 1 : 0;
         };
     }
-    class ClsLogger {
+    /**
+     * CLS Logger 核心基类
+     * - 负责所有上报、队列、监控逻辑
+     * - 不包含具体的 SDK 加载实现（由子类负责）
+     * - 这样可以把 web/mini 的 SDK 依赖彻底解耦到子入口
+     */
+    class ClsLoggerCore {
         constructor() {
+            this.sdk = null;
+            this.sdkPromise = null;
+            this.sdkOverride = null;
+            this.sdkLoaderOverride = null;
             this.client = null;
+            this.clientPromise = null;
             this.topicId = null;
             this.endpoint = 'ap-shanghai.cls.tencentcs.com';
             this.retryTimes = 10;
@@ -1942,6 +1953,15 @@
             this.behaviorMonitorStarted = false;
             this.behaviorMonitorCleanup = null;
         }
+        /**
+         * 子类可按需重写（默认检测 wx）
+         */
+        detectEnvType() {
+            const wxAny = globalThis.wx;
+            if (wxAny && typeof wxAny.getSystemInfoSync === 'function')
+                return 'miniprogram';
+            return 'browser';
+        }
         init(options) {
             this.initTs = Date.now();
             const topicId = options?.tencentCloud?.topicID ?? options?.topic_id ?? options?.topicID ?? this.topicId ?? null;
@@ -1953,6 +1973,19 @@
                 console.warn('ClsLogger.init 没有传 topicID/topic_id');
                 return;
             }
+            const nextEnvType = options.envType ?? this.detectEnvType();
+            // envType/endpoint/retryTimes 变化时：重置 client（以及可能的 sdk）
+            const envChanged = nextEnvType !== this.envType;
+            const endpointChanged = endpoint !== this.endpoint;
+            const retryChanged = retryTimes !== this.retryTimes;
+            if (envChanged || endpointChanged || retryChanged) {
+                this.client = null;
+                this.clientPromise = null;
+            }
+            if (envChanged) {
+                this.sdk = null;
+                this.sdkPromise = null;
+            }
             this.topicId = topicId;
             this.endpoint = endpoint;
             this.retryTimes = retryTimes;
@@ -1963,7 +1996,10 @@
             this.projectName = options.projectName ?? this.projectName;
             this.appId = options.appId ?? this.appId;
             this.appVersion = options.appVersion ?? this.appVersion;
-            this.envType = options.envType ?? this.detectEnvType();
+            this.envType = nextEnvType;
+            // 可选：外部注入 SDK（优先级：sdkLoader > sdk）
+            this.sdkLoaderOverride = options.sdkLoader ?? this.sdkLoaderOverride;
+            this.sdkOverride = options.sdk ?? this.sdkOverride;
             this.userGenerateBaseFields = options.generateBaseFields ?? this.userGenerateBaseFields;
             this.autoGenerateBaseFields = createAutoDeviceInfoBaseFields(this.envType, options.deviceInfo);
             this.storageKey = options.storageKey ?? this.storageKey;
@@ -1973,8 +2009,10 @@
             this.startupDelayMs = options.batch?.startupDelayMs ?? this.startupDelayMs;
             this.failedCacheKey = options.failedCacheKey ?? this.failedCacheKey;
             this.failedCacheMax = options.failedCacheMax ?? this.failedCacheMax;
-            // 预热 client
-            this.getInstance();
+            // 预热（避免首条日志触发 import/初始化开销）
+            void this.getInstance().catch(() => {
+                // ignore
+            });
             // 启动时尝试发送失败缓存
             this.flushFailed();
             // 初始化后立即启动请求监听
@@ -2078,20 +2116,29 @@
             this.behaviorMonitorCleanup = null;
             this.behaviorMonitorStarted = false;
         }
-        getInstance() {
+        /**
+         * 获取 CLS client（按环境懒加载 SDK）
+         */
+        async getInstance() {
             if (this.client)
                 return this.client;
-            this.client = new tencentcloudClsSdkJsWeb.AsyncClient({
-                endpoint: this.endpoint,
-                retry_times: this.retryTimes,
+            if (this.clientPromise)
+                return this.clientPromise;
+            this.clientPromise = this.loadSdk()
+                .then(({ AsyncClient }) => {
+                const client = new AsyncClient({
+                    endpoint: this.endpoint,
+                    retry_times: this.retryTimes,
+                });
+                this.client = client;
+                return client;
+            })
+                .catch((err) => {
+                // 失败后允许下次重试
+                this.clientPromise = null;
+                throw err;
             });
-            return this.client;
-        }
-        detectEnvType() {
-            const wxAny = globalThis.wx;
-            if (wxAny && typeof wxAny.getSystemInfoSync === 'function')
-                return 'miniprogram';
-            return 'browser';
+            return this.clientPromise;
         }
         /**
          * 直接上报：埋点入参必须是一维（扁平）Object
@@ -2117,22 +2164,33 @@
                 appVersion: this.appVersion || undefined,
                 ...normalizedFields,
             });
-            const client = this.getInstance();
-            const logGroup = new tencentcloudClsSdkJsWeb.LogGroup('127.0.0.1');
+            // 同步 API：内部异步发送，避免把网络异常冒泡到业务（尤其小程序）
+            void this.putAsync(finalFields).catch(() => {
+                // ignore
+            });
+        }
+        async putAsync(finalFields) {
+            if (!this.topicId)
+                return;
+            const sdk = await this.loadSdk();
+            const client = await this.getInstance();
+            const logGroup = new sdk.LogGroup('127.0.0.1');
             logGroup.setSource(this.source);
-            const log = new tencentcloudClsSdkJsWeb.Log(Date.now());
+            const log = new sdk.Log(Date.now());
             for (const key of Object.keys(finalFields)) {
                 log.addContent(key, stringifyLogValue(finalFields[key]));
             }
             logGroup.addLog(log);
-            const request = new tencentcloudClsSdkJsWeb.PutLogsRequest(this.topicId, logGroup);
+            const request = new sdk.PutLogsRequest(this.topicId, logGroup);
             const exit = enterClsSendingGuard();
+            let p;
             try {
-                client.PutLogs(request);
+                p = client.PutLogs(request);
             }
             finally {
                 exit();
             }
+            await p;
         }
         /**
          * 直接上报：把 data 序列化后放入指定 key（默认 “日志内容”）
@@ -2191,11 +2249,19 @@
                 console.warn('ClsLogger.putBatch：未初始化 topic_id');
                 return;
             }
-            const client = this.getInstance();
-            const logGroup = new tencentcloudClsSdkJsWeb.LogGroup('127.0.0.1');
+            void this.putBatchAsync(queue).catch(() => {
+                // ignore
+            });
+        }
+        async putBatchAsync(queue) {
+            if (!this.topicId)
+                return;
+            const sdk = await this.loadSdk();
+            const client = await this.getInstance();
+            const logGroup = new sdk.LogGroup('127.0.0.1');
             logGroup.setSource(this.source);
             for (const item of queue) {
-                const log = new tencentcloudClsSdkJsWeb.Log(item.time);
+                const log = new sdk.Log(item.time);
                 const data = item.data ?? {};
                 for (const key of Object.keys(data)) {
                     log.addContent(key, stringifyLogValue(data[key]));
@@ -2204,14 +2270,16 @@
             }
             if (logGroup.getLogs().length === 0)
                 return;
-            const request = new tencentcloudClsSdkJsWeb.PutLogsRequest(this.topicId, logGroup);
+            const request = new sdk.PutLogsRequest(this.topicId, logGroup);
             const exit = enterClsSendingGuard();
+            let p;
             try {
-                client.PutLogs(request);
+                p = client.PutLogs(request);
             }
             finally {
                 exit();
             }
+            await p;
         }
         /**
          * 参考《一、概述》：统一上报入口（内存队列 + 批量发送）
@@ -2324,12 +2392,13 @@
         async sendReportLogs(logs) {
             if (!this.topicId)
                 return;
-            const client = this.getInstance();
-            const logGroup = new tencentcloudClsSdkJsWeb.LogGroup('127.0.0.1');
+            const sdk = await this.loadSdk();
+            const client = await this.getInstance();
+            const logGroup = new sdk.LogGroup('127.0.0.1');
             logGroup.setSource(this.source);
             for (const item of logs) {
                 const fields = this.buildReportFields(item);
-                const log = new tencentcloudClsSdkJsWeb.Log(fields.timestamp);
+                const log = new sdk.Log(fields.timestamp);
                 for (const key of Object.keys(fields)) {
                     if (key === 'timestamp')
                         continue;
@@ -2337,7 +2406,7 @@
                 }
                 logGroup.addLog(log);
             }
-            const request = new tencentcloudClsSdkJsWeb.PutLogsRequest(this.topicId, logGroup);
+            const request = new sdk.PutLogsRequest(this.topicId, logGroup);
             // 只在“发起网络请求”的同步阶段打标记，避免 requestMonitor 监控 CLS 上报请求导致递归
             const exit = enterClsSendingGuard();
             let p;
@@ -2413,6 +2482,122 @@
         }
     }
 
+    function readGlobal(key) {
+        try {
+            const g = globalThis;
+            return g[key] ?? null;
+        }
+        catch {
+            return null;
+        }
+    }
+    function tryRequire(moduleName) {
+        try {
+            // 说明：
+            // - ESM 构建（exports.import/module）里通常不存在模块作用域的 require
+            // - 一些小程序运行时/构建链路会把 require 挂到 globalThis 上
+            // 因此这里同时探测“模块作用域 require”与 “globalThis.require”
+            // eslint-disable-next-line @typescript-eslint/no-implied-eval
+            const localReq = (typeof require === 'function' ? require : null);
+            const globalReq = readGlobal('require');
+            const candidates = [localReq, globalReq].filter((fn) => typeof fn === 'function');
+            for (const fn of candidates) {
+                try {
+                    return fn(moduleName);
+                }
+                catch {
+                    // continue
+                }
+            }
+            return null;
+        }
+        catch {
+            return null;
+        }
+    }
+
+    /**
+     * 兼容版 ClsLogger（默认入口）
+     * - 保留了自动识别环境 + 动态 import 的逻辑
+     * - 如果业务想瘦身，建议改用 @be-link/cls-logger/web 或 /mini
+     */
+    class ClsLogger extends ClsLoggerCore {
+        async loadSdk() {
+            if (this.sdk)
+                return this.sdk;
+            if (this.sdkPromise)
+                return this.sdkPromise;
+            const normalizeSdk = (m) => {
+                const mod = (m?.default && m.default.AsyncClient ? m.default : m);
+                if (mod?.AsyncClient && mod?.Log && mod?.LogGroup && mod?.PutLogsRequest) {
+                    return {
+                        AsyncClient: mod.AsyncClient,
+                        Log: mod.Log,
+                        LogGroup: mod.LogGroup,
+                        PutLogsRequest: mod.PutLogsRequest,
+                    };
+                }
+                return null;
+            };
+            // 1) 外部注入的 loader（最高优先级）
+            if (this.sdkLoaderOverride) {
+                try {
+                    const loaded = await this.sdkLoaderOverride();
+                    const sdk = normalizeSdk(loaded);
+                    if (sdk) {
+                        this.sdk = sdk;
+                        return sdk;
+                    }
+                }
+                catch {
+                    // ignore and fallback
+                }
+            }
+            // 2) 外部直接注入的 sdk
+            if (this.sdkOverride) {
+                const sdk = normalizeSdk(this.sdkOverride);
+                if (sdk) {
+                    this.sdk = sdk;
+                    return sdk;
+                }
+            }
+            const isMini = this.envType === 'miniprogram';
+            // 静态字面量，方便打包器识别（但在此兼容入口里，仍然可能被一起分析）
+            const WEB_SDK = 'tencentcloud-cls-sdk-js-web';
+            const MINI_SDK = 'tencentcloud-cls-sdk-js-mini';
+            // UMD（浏览器脚本）优先读全局变量
+            if (!isMini) {
+                const g = readGlobal('tencentcloudClsSdkJsWeb');
+                const sdk = normalizeSdk(g);
+                if (sdk) {
+                    this.sdk = sdk;
+                    return sdk;
+                }
+            }
+            // 尽量同步 require
+            const reqMod = tryRequire(isMini ? MINI_SDK : WEB_SDK);
+            const reqSdk = normalizeSdk(reqMod);
+            if (reqSdk) {
+                this.sdk = reqSdk;
+                return reqSdk;
+            }
+            // 动态 import
+            this.sdkPromise = (isMini ? import(MINI_SDK) : import(WEB_SDK))
+                .then((m) => {
+                const sdk = normalizeSdk(m);
+                if (!sdk)
+                    throw new Error(`ClsLogger.loadSdk: invalid sdk module for ${isMini ? MINI_SDK : WEB_SDK}`);
+                this.sdk = sdk;
+                return sdk;
+            })
+                .catch((err) => {
+                this.sdkPromise = null;
+                throw err;
+            });
+            return this.sdkPromise;
+        }
+    }
+
     const clsLogger = new ClsLogger();
 
     exports.ClsLogger = ClsLogger;

package/dist/mini.d.ts

@@ -0,0 +1,6 @@
+import { ClsLoggerMini } from './ClsLoggerMini';
+export * from './types';
+export { ClsLoggerMini as ClsLogger };
+export declare const clsLogger: ClsLoggerMini;
+export default clsLogger;
+//# sourceMappingURL=mini.d.ts.map

package/dist/mini.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mini.d.ts","sourceRoot":"","sources":["../src/mini.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,aAAa,IAAI,SAAS,EAAE,CAAC;AACtC,eAAO,MAAM,SAAS,eAAsB,CAAC;AAC7C,eAAe,SAAS,CAAC"}