sobey-monitor-sdk 1.1.2 → 1.1.4

package/dist/index.umd.js

@@ -51,27 +51,14 @@
         }
         /**
          * 初始化配置
-         * @param skipValidation 是否跳过必填校验（用于远程配置已获取 appId/dsn 的场景）
          */
         init(userConfig, skipValidation = false) {
             if (!skipValidation) {
-                // 如果没有 configUrl，则 appId 和 dsn 是必填的
-                if (!userConfig.configUrl) {
-                    if (!userConfig.appId) {
-                        throw new Error('[Monitor] appId is required when configUrl is not provided');
-                    }
-                    if (!userConfig.dsn) {
-                        throw new Error('[Monitor] dsn is required when configUrl is not provided');
-                    }
-                }
-            }
-            else {
-                // 远程配置模式下，校验合并后的配置
                 if (!userConfig.appId) {
-                    throw new Error('[Monitor] appId is required (not found in remote config)');
+                    throw new Error('[Monitor] appId is required');
                 }
                 if (!userConfig.dsn) {
-                    throw new Error('[Monitor] dsn is required (not found in remote config)');
+                    throw new Error('[Monitor] dsn is required');
                 }
             }
             this.config = this.mergeConfig(DEFAULT_CONFIG, userConfig);
@@ -295,6 +282,13 @@
         doSend(data) {
             const cfg = config.get();
             const dsn = cfg.dsn;
+            // dsn 未配置，跳过发送
+            if (!dsn) {
+                if (cfg.debug) {
+                    console.warn('[Monitor] dsn not configured, skip sending');
+                }
+                return;
+            }
             const payload = JSON.stringify(data);
             // 优先使用 sendBeacon（更可靠、异步、不阻塞页面）
             if (supportsSendBeacon()) {
@@ -393,13 +387,63 @@
      * 上报器类
      */
     class Reporter {
+        constructor() {
+            /** SDK 是否就绪 */
+            this.ready = false;
+            /** 早期数据缓存队列（SDK 未就绪时缓存） */
+            this.earlyBuffer = [];
+            /** 最大缓存数量 */
+            this.maxEarlyBufferSize = 50;
+        }
+        /**
+         * 设置 SDK 就绪状态
+         */
+        setReady(ready) {
+            this.ready = ready;
+            // 就绪后发送缓存的早期数据
+            if (ready && this.earlyBuffer.length > 0) {
+                console.log(`[Monitor] Flushing ${this.earlyBuffer.length} early buffered items`);
+                this.flushEarlyBuffer();
+            }
+        }
+        /**
+         * 发送早期缓存的数据
+         */
+        flushEarlyBuffer() {
+            while (this.earlyBuffer.length > 0) {
+                const item = this.earlyBuffer.shift();
+                if (!item)
+                    continue;
+                switch (item.type) {
+                    case 'error':
+                        this.reportError(item.data);
+                        break;
+                    case 'performance':
+                        this.reportPerformance(item.data);
+                        break;
+                    case 'behavior':
+                        this.reportBehavior(item.data);
+                        break;
+                }
+            }
+        }
+        /**
+         * 缓存早期数据
+         */
+        bufferEarly(type, data) {
+            if (this.earlyBuffer.length >= this.maxEarlyBufferSize) {
+                // 缓存已满，丢弃最早的数据
+                this.earlyBuffer.shift();
+            }
+            this.earlyBuffer.push({ type, data });
+        }
         /**
          * 构建基础数据
          */
         buildBaseData() {
             const cfg = config.get();
             return {
-                appId: cfg.appId,
+                appId: cfg.appId || '',
                 userId: cfg.user?.userId,
                 sessionId: context.getSessionId(),
                 pageUrl: getPageUrl(),
@@ -420,6 +464,11 @@
          * 上报错误
          */
         reportError(data) {
+            // SDK 未就绪时缓存数据
+            if (!this.ready) {
+                this.bufferEarly('error', data);
+                return;
+            }
             if (!this.shouldSample('error'))
                 return;
             const cfg = config.get();
@@ -441,6 +490,11 @@
          * 上报性能
          */
         reportPerformance(data) {
+            // SDK 未就绪时缓存数据
+            if (!this.ready) {
+                this.bufferEarly('performance', data);
+                return;
+            }
             if (!this.shouldSample('performance'))
                 return;
             const reportData = {
@@ -453,6 +507,11 @@
          * 上报行为
          */
         reportBehavior(data) {
+            // SDK 未就绪时缓存数据
+            if (!this.ready) {
+                this.bufferEarly('behavior', data);
+                return;
+            }
             if (!this.shouldSample('behavior'))
                 return;
             const reportData = {
@@ -494,11 +553,14 @@
      * 安装 JS 错误监听
      */
     function installJsErrorHandler() {
-        const cfg = config.get();
-        if (!cfg.error?.enabled || !cfg.error?.jsError) {
-            return;
-        }
         window.addEventListener('error', (event) => {
+            // 延迟检查配置（SDK 可能还在加载配置）
+            if (config.isInitialized()) {
+                const cfg = config.get();
+                if (!cfg.error?.enabled || !cfg.error?.jsError) {
+                    return;
+                }
+            }
             // 过滤资源加载错误（由 resourceError 处理）
             if (event.target !== window) {
                 return;
@@ -523,9 +585,6 @@
             });
             reporter.reportError(errorData);
         }, true);
-        if (cfg.debug) {
-            console.log('[Monitor] JS error handler installed');
-        }
     }
 
     /**
@@ -535,11 +594,14 @@
      * 安装 Promise 错误监听
      */
     function installPromiseErrorHandler() {
-        const cfg = config.get();
-        if (!cfg.error?.enabled || !cfg.error?.promiseError) {
-            return;
-        }
         window.addEventListener('unhandledrejection', (event) => {
+            // 延迟检查配置（SDK 可能还在加载配置）
+            if (config.isInitialized()) {
+                const cfg = config.get();
+                if (!cfg.error?.enabled || !cfg.error?.promiseError) {
+                    return;
+                }
+            }
             let message = 'Unhandled Promise rejection';
             let stack;
             const reason = event.reason;
@@ -568,9 +630,6 @@
             });
             reporter.reportError(errorData);
         });
-        if (cfg.debug) {
-            console.log('[Monitor] Promise error handler installed');
-        }
     }
 
     /**
@@ -580,11 +639,14 @@
      * 安装资源错误监听
      */
     function installResourceErrorHandler() {
-        const cfg = config.get();
-        if (!cfg.error?.enabled || !cfg.error?.resourceError) {
-            return;
-        }
         window.addEventListener('error', (event) => {
+            // 延迟检查配置（SDK 可能还在加载配置）
+            if (config.isInitialized()) {
+                const cfg = config.get();
+                if (!cfg.error?.enabled || !cfg.error?.resourceError) {
+                    return;
+                }
+            }
             const target = event.target;
             // 只处理资源加载错误（target 不是 window）
             if (!target || target === window || !(target instanceof HTMLElement)) {
@@ -618,9 +680,6 @@
             });
             reporter.reportError(errorData);
         }, true); // 使用捕获阶段
-        if (cfg.debug) {
-            console.log('[Monitor] Resource error handler installed');
-        }
     }
 
     /**
@@ -635,28 +694,32 @@
      * 安装 HTTP 错误拦截
      */
     function installHttpErrorHandler() {
-        const cfg = config.get();
-        if (!cfg.error?.enabled || !cfg.error?.httpError) {
-            return;
-        }
         interceptXHR();
         interceptFetch();
-        if (cfg.debug) {
-            console.log('[Monitor] HTTP error handler installed');
-        }
     }
-    /**
-     * 拦截 XMLHttpRequest
-     */
     /**
      * 检查是否是 SDK 自身的请求
      */
     function isSdkRequest(url) {
+        if (!config.isInitialized())
+            return false;
         const cfg = config.get();
         if (!cfg.dsn)
             return false;
         return url.includes(cfg.dsn);
     }
+    /**
+     * 检查 HTTP 错误监控是否启用
+     */
+    function isHttpErrorEnabled() {
+        if (!config.isInitialized())
+            return true; // 配置未就绪时默认启用，数据会被缓存
+        const cfg = config.get();
+        return cfg.error?.enabled !== false && cfg.error?.httpError !== false;
+    }
+    /**
+     * 拦截 XMLHttpRequest
+     */
     function interceptXHR() {
         XMLHttpRequest.prototype.open = function (method, url, async = true, username, password) {
             const urlStr = url.toString();
@@ -686,11 +749,16 @@
             this.addEventListener('loadend', function () {
                 if (!monitorData)
                     return;
+                if (!isHttpErrorEnabled())
+                    return;
                 const duration = Date.now() - monitorData.startTime;
                 const status = this.status;
                 // 根据配置决定是否添加到面包屑
-                const cfg = config.get();
-                const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                let recordMode = 'error';
+                if (config.isInitialized()) {
+                    const cfg = config.get();
+                    recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                }
                 // 重定向(3xx)始终记录，不受配置控制
                 const isRedirect = status >= 300 && status < 400;
                 // 其他异常情况（0-网络错误、4xx-客户端错误、5xx-服务端错误）根据配置控制
@@ -737,11 +805,17 @@
             const requestBody = typeof init?.body === 'string' ? init.body : undefined;
             try {
                 const response = await originalFetch.call(window, input, init);
+                if (!isHttpErrorEnabled()) {
+                    return response;
+                }
                 const duration = Date.now() - startTime;
                 const status = response.status;
                 // 根据配置决定是否添加到面包屑
-                const cfg = config.get();
-                const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                let recordMode = 'error';
+                if (config.isInitialized()) {
+                    const cfg = config.get();
+                    recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                }
                 // 重定向(3xx)始终记录，不受配置控制
                 const isRedirect = status >= 300 && status < 400;
                 // 其他异常情况根据配置控制
@@ -780,10 +854,16 @@
                 return response;
             }
             catch (error) {
+                if (!isHttpErrorEnabled()) {
+                    throw error;
+                }
                 const duration = Date.now() - startTime;
                 // 网络错误时根据配置决定是否添加到面包屑
-                const cfg = config.get();
-                const recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                let recordMode = 'error';
+                if (config.isInitialized()) {
+                    const cfg = config.get();
+                    recordMode = cfg.behavior?.recordRequestBreadcrumb || 'error';
+                }
                 // 网络错误属于 error，当模式为 'all' 或 'error' 时都记录
                 if (recordMode !== 'none') {
                     context.addBreadcrumb({
@@ -839,10 +919,6 @@
      * 安装白屏检测
      */
     function installWhiteScreenDetector() {
-        const cfg = config.get();
-        if (!cfg.error?.enabled) {
-            return;
-        }
         // 在页面加载完成后检测
         if (document.readyState === 'complete') {
             scheduleDetection();
@@ -852,9 +928,6 @@
                 scheduleDetection();
             });
         }
-        if (cfg.debug) {
-            console.log('[Monitor] White screen detector installed');
-        }
     }
     /**
      * 调度检测（延迟执行，给页面渲染时间）
@@ -862,6 +935,13 @@
     function scheduleDetection() {
         // 延迟 1 秒检测
         setTimeout(() => {
+            // 检测时才检查配置
+            if (config.isInitialized()) {
+                const cfg = config.get();
+                if (!cfg.error?.enabled) {
+                    return;
+                }
+            }
             const isWhiteScreen = detectWhiteScreen();
             if (isWhiteScreen) {
                 reportWhiteScreen();
@@ -1441,13 +1521,8 @@
      * ```
      */
     const VueMonitorPlugin = {
-        install(app, options) {
-            // 支持 configUrl 模式或传统 appId/dsn 模式
-            if (!options || (!options.configUrl && (!options.appId || !options.dsn))) {
-                console.warn('[Monitor] VueMonitorPlugin requires either configUrl or (appId and dsn) in options');
-                return;
-            }
-            // 初始化 SDK（如果尚未初始化）
+        install(app, options = {}) {
+            // 初始化 SDK（支持空配置，后续通过 updateConfig 激活）
             try {
                 monitor.init(options);
             }
@@ -1543,18 +1618,8 @@
      * );
      * ```
      */
-    function createReactErrorBoundary(React, config) {
-        // 支持 configUrl 模式或传统 appId/dsn 模式
-        if (!config || (!config.configUrl && (!config.appId || !config.dsn))) {
-            console.warn('[Monitor] createReactErrorBoundary requires either configUrl or (appId and dsn) in config');
-            // 返回一个空的组件
-            return class EmptyBoundary extends React.Component {
-                render() {
-                    return this.props.children;
-                }
-            };
-        }
-        // 初始化 SDK（如果尚未初始化）
+    function createReactErrorBoundary(React, config = {}) {
+        // 初始化 SDK（支持空配置，后续通过 updateConfig 激活）
         try {
             monitor.init(config);
         }
@@ -1650,64 +1715,131 @@
      */
     class MonitorSDK {
         constructor() {
+            /** SDK 是否已初始化（基础初始化，可能还没有完整配置） */
             this.initialized = false;
-            this.initializing = false;
+            /** SDK 是否已就绪（配置完整，可以上报数据） */
+            this.ready = false;
+            /** 是否正在加载远程配置 */
+            this.loading = false;
+            /** 监控模块是否已安装 */
+            this.monitorsInstalled = false;
         }
         /**
          * 初始化 SDK
-         * 如果配置了 configUrl，将先从远程获取配置（仅获取一次）
-         * 无需 await，SDK 内部会自动处理异步逻辑
+         * 支持空配置初始化，后续通过 updateConfig 传入 configUrl 完成配置
          */
-        init(userConfig) {
-            if (this.initialized || this.initializing) {
-                if (this.initialized) {
-                    console.warn('[Monitor] SDK already initialized');
-                }
+        init(userConfig = {}) {
+            if (this.initialized) {
+                console.warn('[Monitor] SDK already initialized');
                 return;
             }
-            // 如果配置了 configUrl，异步获取远程配置后再初始化
+            // 如果配置了 configUrl，异步获取远程配置
             if (userConfig.configUrl) {
-                this.initializing = true;
+                this.loading = true;
+                this.initBasic(userConfig);
                 this.fetchRemoteConfig(userConfig.configUrl)
                     .then((remoteConfig) => {
-                    // 远程配置作为基础，用户本地配置覆盖远程配置
                     const finalConfig = this.mergeUserConfig(remoteConfig, userConfig);
                     if (userConfig.debug) {
                         console.log('[Monitor] Remote config loaded:', remoteConfig);
                     }
-                    this.doInit(finalConfig, true);
+                    this.activate(finalConfig);
                 })
                     .catch((error) => {
-                    this.initializing = false;
+                    this.loading = false;
                     console.error('[Monitor] Failed to fetch remote config:', error);
                 });
             }
+            else if (userConfig.appId && userConfig.dsn) {
+                // 有完整配置，直接激活
+                this.initBasic(userConfig);
+                this.activate(userConfig);
+            }
             else {
-                // 没有 configUrl，直接同步初始化
-                this.doInit(userConfig, false);
+                // 空配置或不完整配置，只做基础初始化，等待后续 updateConfig
+                this.initBasic(userConfig);
+                console.log('[Monitor] SDK initialized in pending mode. Call updateConfig({configUrl}) to activate.');
             }
         }
         /**
-         * 执行实际的初始化逻辑
+         * 基础初始化（安装监控模块，但不开始上报）
          */
-        doInit(finalConfig, isRemoteConfig) {
-            // 初始化配置
-            config.init({
-                ...finalConfig,
-                version: finalConfig.version || SDK_VERSION,
-            }, isRemoteConfig);
+        initBasic(userConfig) {
             // 初始化上下文
-            const maxBreadcrumbs = config.get().behavior?.maxBreadcrumbs || 20;
+            const maxBreadcrumbs = userConfig.behavior?.maxBreadcrumbs || 20;
             context.init(maxBreadcrumbs);
+            // 安装监控模块（早期捕获的数据会被缓存）
+            if (!this.monitorsInstalled) {
+                installErrorHandlers();
+                installPerformanceMonitor();
+                installBehaviorMonitor();
+                this.monitorsInstalled = true;
+            }
             this.initialized = true;
-            this.initializing = false;
+            if (userConfig.debug) {
+                console.log('[Monitor] SDK basic initialized (monitors installed, waiting for config)');
+            }
+        }
+        /**
+         * 激活 SDK（配置完整后调用）
+         */
+        activate(finalConfig) {
+            // 初始化配置管理器
+            config.init({
+                ...finalConfig,
+                version: finalConfig.version || SDK_VERSION,
+            }, true);
+            this.ready = true;
+            this.loading = false;
+            // 通知 reporter 可以开始上报（会自动发送缓存的早期数据）
+            reporter.setReady(true);
             if (config.get().debug) {
-                console.log('[Monitor] SDK initialized', config.get());
+                console.log('[Monitor] SDK activated with config:', config.get());
+            }
+        }
+        /**
+         * 动态更新配置
+         * 如果传入 configUrl，会从远程获取配置并激活 SDK
+         */
+        updateConfig(partialConfig) {
+            // 如果传入了 configUrl，从远程获取配置
+            if (partialConfig.configUrl) {
+                console.log('[Monitor] Fetching remote config from:', partialConfig.configUrl);
+                this.loading = true;
+                this.fetchRemoteConfig(partialConfig.configUrl)
+                    .then((remoteConfig) => {
+                    const mergedConfig = this.mergeUserConfig(remoteConfig, partialConfig);
+                    // 移除 configUrl
+                    delete mergedConfig.configUrl;
+                    if (this.ready) {
+                        // 已就绪，更新配置
+                        config.update(mergedConfig);
+                        this.loading = false;
+                        if (config.get().debug) {
+                            console.log('[Monitor] Config updated from remote:', mergedConfig);
+                        }
+                    }
+                    else {
+                        // 未就绪，激活 SDK
+                        this.activate(mergedConfig);
+                    }
+                })
+                    .catch((error) => {
+                    this.loading = false;
+                    console.error('[Monitor] Failed to fetch remote config:', error);
+                });
+            }
+            else {
+                // 普通配置更新
+                if (!this.ready) {
+                    console.warn('[Monitor] SDK not ready. Please provide configUrl or (appId + dsn) first.');
+                    return;
+                }
+                config.update(partialConfig);
+                if (config.get().debug) {
+                    console.log('[Monitor] Config updated', partialConfig);
+                }
             }
-            // 安装监控模块
-            installErrorHandlers();
-            installPerformanceMonitor();
-            installBehaviorMonitor();
         }
         /**
          * 从远程获取配置
@@ -1733,7 +1865,7 @@
                 if (Object.prototype.hasOwnProperty.call(local, key)) {
                     const localValue = local[key];
                     const remoteValue = remote[key];
-                    // 跳过 configUrl，不需要传递给最终配置
+                    // 跳过 configUrl
                     if (key === 'configUrl')
                         continue;
                     if (localValue !== null &&
@@ -1754,55 +1886,33 @@
             return result;
         }
         /**
-         * 设置用户信息
+         * 检查 SDK 是否就绪
          */
-        setUser(user) {
-            this.checkInit();
-            config.setUser(user);
+        isReady() {
+            return this.ready;
         }
         /**
-         * 动态更新配置
-         * @description 可以在运行时更新 SDK 配置，如 debug、sampling、report 等
-         * 如果传入 configUrl，会从远程获取配置并合并
+         * 设置用户信息
          */
-        updateConfig(partialConfig) {
-            this.checkInit();
-            // 如果传入了 configUrl，从远程获取配置并更新
-            if (partialConfig.configUrl) {
-                this.fetchRemoteConfig(partialConfig.configUrl)
-                    .then((remoteConfig) => {
-                    // 远程配置作为基础，传入的其他本地配置覆盖远程配置
-                    const mergedConfig = this.mergeUserConfig(remoteConfig, partialConfig);
-                    // 移除 configUrl，不需要存到配置里
-                    delete mergedConfig.configUrl;
-                    config.update(mergedConfig);
-                    if (config.get().debug) {
-                        console.log('[Monitor] Config updated from remote:', mergedConfig);
-                    }
-                })
-                    .catch((error) => {
-                    console.error('[Monitor] Failed to fetch remote config:', error);
-                });
-            }
-            else {
-                config.update(partialConfig);
-                if (config.get().debug) {
-                    console.log('[Monitor] Config updated', partialConfig);
-                }
-            }
+        setUser(user) {
+            if (!this.ready)
+                return;
+            config.setUser(user);
         }
         /**
          * 获取当前配置
          */
         getConfig() {
-            this.checkInit();
+            if (!this.ready)
+                return null;
             return config.get();
         }
         /**
          * 手动上报错误
          */
         captureError(error, extra) {
-            this.checkInit();
+            if (!this.ready)
+                return;
             const errorData = {
                 type: 'js_error',
                 message: typeof error === 'string' ? error : error.message,
@@ -1815,7 +1925,8 @@
          * 手动上报性能数据
          */
         capturePerformance(metrics) {
-            this.checkInit();
+            if (!this.ready)
+                return;
             reporter.reportPerformance({
                 type: 'performance',
                 metrics,
@@ -1825,7 +1936,8 @@
          * 手动上报行为数据
          */
         captureBehavior(action, data) {
-            this.checkInit();
+            if (!this.ready)
+                return;
             reporter.reportBehavior({
                 type: 'behavior',
                 action,
@@ -1836,14 +1948,16 @@
          * 添加面包屑
          */
         addBreadcrumb(crumb) {
-            this.checkInit();
+            if (!this.initialized)
+                return;
             context.addBreadcrumb(crumb);
         }
         /**
          * 立即发送缓冲区数据
          */
         flush() {
-            this.checkInit();
+            if (!this.ready)
+                return;
             reporter.flush();
         }
         /**
@@ -1852,14 +1966,6 @@
         getVersion() {
             return SDK_VERSION;
         }
-        /**
-         * 检查是否已初始化
-         */
-        checkInit() {
-            if (!this.initialized) {
-                throw new Error('[Monitor] SDK not initialized. Please call init() first.');
-            }
-        }
     }
     // 导出单例
     const monitor = new MonitorSDK();