chore: update READMEs and robustness improvement

rookiestar28 · rookiestar28 · commit 5d8d8b78fac8 · 2026-01-30T22:45:19.000+08:00
diff --git a/README.md b/README.md
@@ -886,13 +886,16 @@ Acknowledge/ignore/resolve an issue.
 All logs are stored in:
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 Filename format: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
 
 The system automatically retains the 10 most recent log files (configurable via `config.json`).
 
+> Tip: You can check the resolved data directory via `GET /doctor/health` → `health.storage.data_dir`.
+> Legacy installs may still have logs under `ComfyUI/custom_nodes/ComfyUI-Doctor/logs/` (migrated when possible).
+
 ---
 
 ## Configuration
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -678,10 +678,20 @@ graph TD
   - **Foundation for**: CI/CD integration, UI regression detection
 - [ ] **T13**: Desktop-style Failure Injection Tests (Flush/OSError + Corrupt JSON) - 🟡 Medium
   - **Goal**: Prevent Desktop-only regressions (log storms, broken history) without requiring a real ComfyUI Desktop runtime in CI.
+  - **Status (2026-01-23)**: Guardrails exist (R18), but failure-injection coverage is still missing; schedule implementation later.
   - **Scope**:
     - Simulate stream flush failures (e.g. `OSError: [Errno 22] Invalid argument`) and assert rate-limit + aggregation behavior
     - Corrupt JSON recovery tests for history stores (`error_history.json`, diagnostics history)
     - Fixture corpus derived from `docs/reference/desktop/` (sanitized, no secrets)
+  - **Missing coverage (to add)**:
+    - Prestartup path/permission failures: log dir cannot be created / log file cannot be opened must not break startup (`prestartup_script.py`)
+    - Desktop flush exception storms: ensure `FlushSafeProxy` + Desktop flush-ignore filter prevents recursive exception spam and history bloat (`logger.py`)
+    - Store corruption self-heal: verify corrupt files are rotated aside and a clean store is recreated (`history_store.py`, `services/diagnostics/store.py`)
+    - Migration invariants: legacy history is migrated and legacy file is renamed with `.migrated-<ts>` (R18 migration path)
+  - **Implementation notes (when scheduled)**:
+    - Prefer stdlib `unittest` (so tests don't depend on pytest being installed locally), but keep compatible with pytest discovery in CI.
+    - Add a small fixture set under `tests/fixtures/desktop/` derived from `docs/reference/desktop/` (sanitized; no secrets).
+    - Focus assertions on: bounded growth (aggregation window), no infinite recursion, and successful recovery after corruption.
 - [ ] **T9**: External Environment Test Coverage Expansion (Non-ComfyUI) - 🟡 Medium
   - **Goal**: Cover pipeline integration, SSE/REST contracts, and UI contracts without a live ComfyUI runtime
   - **Phases**:
diff --git a/config.py b/config.py
@@ -5,6 +5,7 @@
 
 import os
 import json
+import tempfile
 from dataclasses import dataclass, asdict, field
 from typing import Optional, List
 
@@ -24,6 +25,9 @@ def _get_config_path_candidates() -> List[str]:
 
     # Legacy location (extension root)
     candidates.append(os.path.join(os.path.dirname(__file__), "config.json"))
+
+    # OS temp fallback (last resort; avoids writing under Desktop resources)
+    candidates.append(os.path.join(tempfile.gettempdir(), "ComfyUI-Doctor", "config.json"))
     return candidates
 
 
@@ -120,20 +124,32 @@ def load_config() -> DiagnosticsConfig:
 
 def save_config(config: DiagnosticsConfig) -> bool:
     """Save current configuration to config.json."""
-    config_path = _get_primary_config_path()
-    try:
-        with open(config_path, "w", encoding="utf-8") as f:
-            json.dump(config.to_dict(), f, indent=2, ensure_ascii=False)
-        return True
-    except Exception:
-        # Fallback to legacy location if canonical dir is not writable.
+    payload = json.dumps(config.to_dict(), indent=2, ensure_ascii=False)
+    for config_path in _get_config_path_candidates():
         try:
-            legacy_path = os.path.join(os.path.dirname(__file__), "config.json")
-            with open(legacy_path, "w", encoding="utf-8") as f:
-                json.dump(config.to_dict(), f, indent=2, ensure_ascii=False)
+            dir_path = os.path.dirname(config_path)
+            if dir_path:
+                os.makedirs(dir_path, exist_ok=True)
+
+            tmp_path = f"{config_path}.tmp"
+            with open(tmp_path, "w", encoding="utf-8") as f:
+                f.write(payload)
+                f.flush()
+                try:
+                    os.fsync(f.fileno())
+                except Exception:
+                    pass
+            os.replace(tmp_path, config_path)
             return True
         except Exception:
-            return False
+            try:
+                tmp_path = f"{config_path}.tmp"
+                if os.path.exists(tmp_path):
+                    os.remove(tmp_path)
+            except Exception:
+                pass
+            continue
+    return False
 
 
 # Global config instance
diff --git a/docs/readme/README.de.md b/docs/readme/README.de.md
@@ -823,7 +823,7 @@ Verfügbare Modelle vom konfigurierten LLM-Anbieter auflisten.
 Alle Logs werden gespeichert in:
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 Dateinamenformat: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.es.md b/docs/readme/README.es.md
@@ -823,7 +823,7 @@ Listar modelos disponibles del proveedor LLM configurado.
 Todos los registros se almacenan en:
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 Formato de nombre de archivo: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.fr.md b/docs/readme/README.fr.md
@@ -823,7 +823,7 @@ Lister les modèles disponibles du fournisseur LLM configuré.
 Tous les journaux sont stockés dans :
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 Format du nom de fichier : `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.it.md b/docs/readme/README.it.md
@@ -823,7 +823,7 @@ Elenca i modelli disponibili dal provider LLM configurato.
 Tutti i log sono memorizzati in:
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 Formato nome file: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.ja.md b/docs/readme/README.ja.md
@@ -823,7 +823,7 @@ LLMプロバイダーへの接続をテストしてAPIキーの有効性を検
 すべてのログは以下に保存されます:
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 ファイル名形式: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.ko.md b/docs/readme/README.ko.md
@@ -824,7 +824,7 @@ LLM 공급자에 대한 연결을 테스트하여 API 키 유효성을 확인합
 모든 로그는 다음에 저장됩니다.
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 파일 이름 형식: `comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
diff --git a/docs/readme/README.zh-CN.md b/docs/readme/README.zh-CN.md
@@ -824,13 +824,16 @@ curl http://localhost:8188/debugger/history
 所有日志存放于：
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 文件名格式为：`comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
 
 系统会自动保留最新的 10 个日志文件（可透过 `config.json` 调整）。
 
+> 提示：可用 `GET /doctor/health` → `health.storage.data_dir` 查看实际解析到的数据目录。
+> 旧版可能仍存在 `ComfyUI/custom_nodes/ComfyUI-Doctor/logs/`（可用时会自动迁移）。
+
 ---
 
 ## 配置参数
diff --git a/docs/readme/README.zh-TW.md b/docs/readme/README.zh-TW.md
@@ -872,13 +872,16 @@ curl "http://localhost:8188/doctor/health_history?limit=50&offset=0"
 所有日誌存放於：
 
 ```text
-ComfyUI/custom_nodes/ComfyUI-Doctor/logs/
+<ComfyUI user directory>/ComfyUI-Doctor/logs/
 ```
 
 檔名格式為：`comfyui_debug_YYYY-MM-DD_HH-MM-SS.log`
 
 系統會自動保留最新的 10 個日誌檔案（可透過 `config.json` 調整）。
 
+> 提示：可用 `GET /doctor/health` → `health.storage.data_dir` 檢視實際解析到的資料目錄。
+> 舊版可能仍存在 `ComfyUI/custom_nodes/ComfyUI-Doctor/logs/`（可用時會自動遷移）。
+
 ---
 
 ## 配置參數
diff --git a/logger.py b/logger.py
@@ -110,15 +110,16 @@ def _migrate_legacy_data():
     if os.path.exists(legacy_path) and not os.path.exists(target_path):
         try:
             os.makedirs(os.path.dirname(target_path), exist_ok=True)
+            import shutil
+            # Copy into canonical location first, then rename legacy to a backup marker.
+            # This preserves a forensic trail while preventing repeated migrations.
+            shutil.copy2(legacy_path, target_path)
             try:
-                os.replace(legacy_path, target_path)
+                ts = datetime.datetime.utcnow().strftime("%Y%m%d-%H%M%S")
+                os.rename(legacy_path, f"{legacy_path}.migrated-{ts}")
             except Exception:
-                import shutil
-                shutil.copy2(legacy_path, target_path)
-                try:
-                    os.remove(legacy_path)
-                except Exception:
-                    pass
+                # If rename fails (permissions/locks), leave legacy in place; migration is best-effort.
+                pass
         except Exception as e:
             logging.error(f"[ComfyUI-Doctor] Migration failed: {e}")
 
diff --git a/prestartup_script.py b/prestartup_script.py
@@ -7,6 +7,7 @@
 import sys
 import os
 import datetime
+import tempfile
 
 # R18: Prefer canonical Doctor data dir for persisted logs (Desktop-safe)
 try:
@@ -16,20 +17,38 @@
 
 # Get the directory of this script (ComfyUI-Doctor folder)
 DOCTOR_DIR = os.path.dirname(os.path.abspath(__file__))
-if _get_doctor_data_dir:
-    try:
-        LOG_DIR = os.path.join(_get_doctor_data_dir(), "logs")
-    except Exception:
-        LOG_DIR = os.path.join(DOCTOR_DIR, "logs")
-else:
-    LOG_DIR = os.path.join(DOCTOR_DIR, "logs")
+_FALLBACK_LOG_DIR = os.path.join(tempfile.gettempdir(), "ComfyUI-Doctor", "logs")
+
+def _resolve_log_dir() -> str:
+    """
+    Resolve a writable log directory for the earliest capture phase.
+
+    IMPORTANT:
+    - Never assume the extension folder is writable (ComfyUI Desktop resources may be read-only).
+    - Never raise here; prestartup must not break ComfyUI startup.
+    """
+    if _get_doctor_data_dir:
+        try:
+            return os.path.join(_get_doctor_data_dir(), "logs")
+        except Exception:
+            pass
+    return _FALLBACK_LOG_DIR
+
+LOG_DIR = _resolve_log_dir()
 
 # Ensure logs directory exists
-os.makedirs(LOG_DIR, exist_ok=True)
+try:
+    os.makedirs(LOG_DIR, exist_ok=True)
+except Exception:
+    LOG_DIR = _FALLBACK_LOG_DIR
+    try:
+        os.makedirs(LOG_DIR, exist_ok=True)
+    except Exception:
+        LOG_DIR = ""
 
 # Generate log filename
 timestamp = datetime.datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
-LOG_PATH = os.path.join(LOG_DIR, f"comfyui_debug_{timestamp}.log")
+LOG_PATH = os.path.join(LOG_DIR, f"comfyui_debug_{timestamp}.log") if LOG_DIR else ""
 
 # ============================================================
 # Minimal Logger (Prestartup Phase)
@@ -54,7 +73,12 @@ def install(cls, log_path):
         
         cls._original_stdout = sys.stdout
         cls._original_stderr = sys.stderr
-        cls._log_file = open(log_path, "a", encoding="utf-8")
+        cls._log_file = None
+        if log_path:
+            try:
+                cls._log_file = open(log_path, "a", encoding="utf-8")
+            except Exception:
+                cls._log_file = None
         
         sys.stdout = cls(cls._original_stdout)
         sys.stderr = cls(cls._original_stderr)
@@ -126,14 +150,21 @@ def isatty(self):
         return getattr(self.stream, 'isatty', lambda: False)()
 
     def fileno(self):
-        return self.stream.fileno()
+        try:
+            return self.stream.fileno()
+        except Exception:
+            return -1
 
 
 # Install minimal logger IMMEDIATELY
 PrestartupLogger.install(LOG_PATH)
 
 print(f"\n[ComfyUI-Doctor] 🏥 Prestartup hook activated (EARLY CAPTURE)")
-print(f"[ComfyUI-Doctor] 📄 Log file: {LOG_PATH}")
+if LOG_PATH:
+    print(f"[ComfyUI-Doctor] 📄 Log file: {LOG_PATH}")
+else:
+    print("[ComfyUI-Doctor] ⚠️ Log file: unavailable (fallback disabled)")
 
 # Store log path for __init__.py to retrieve
-os.environ["COMFYUI_DOCTOR_LOG_PATH"] = LOG_PATH
+if LOG_PATH:
+    os.environ["COMFYUI_DOCTOR_LOG_PATH"] = LOG_PATH
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
 name = "comfyui-doctor"
-description = "A real-time runtime diagnostics suite for ComfyUI, featuring interactive debugging chat, and 50+ fix patterns. Automatically intercepts terminal output from startup, and delivers prioritized fix suggestions with node-level context extraction. Now supports JSON-based pattern management with hot-reload and full i18n support for 9 languages."
-version = "1.6.0"
+description = "A real-time debugging assistant for ComfyUI, featuring interactive debugging chat, and 50+ fix patterns. Automatically intercepts terminal output from startup, and delivers prioritized fix suggestions with node-level context extraction. Now supports JSON-based pattern management with hot-reload and full i18n support for 9 languages."
+version = "1.6.1"
 license = {text = "MIT"}
 readme = "README.md"
 requires-python = ">=3.10"
diff --git a/telemetry.py b/telemetry.py
@@ -16,6 +16,7 @@
 import re
 import threading
 import time
+import tempfile
 import uuid
 from dataclasses import dataclass, field, asdict
 from datetime import datetime, timedelta
@@ -253,17 +254,19 @@ def get_doctor_data_dir() -> str:
     Get the Doctor data directory (cross-platform).
 
     R18: Prefer the shared canonical resolver (Desktop/portable safe).
-    Fallback (legacy): `<extension_root>/data`.
+    Fallback: OS temp dir (never write under Desktop resources).
     """
     if _get_canonical_doctor_data_dir:
         try:
             return _get_canonical_doctor_data_dir()
         except Exception:
             pass
 
-    extension_root = os.path.dirname(os.path.abspath(__file__))
-    data_dir = os.path.join(extension_root, "data")
-    os.makedirs(data_dir, exist_ok=True)
+    data_dir = os.path.join(tempfile.gettempdir(), "ComfyUI-Doctor")
+    try:
+        os.makedirs(data_dir, exist_ok=True)
+    except Exception:
+        pass
     return data_dir
 
 
diff --git a/web/doctor.js b/web/doctor.js
