merge: đồng bộ origin/gamma/refactor (R01/R03/R04 — routing unification,

conversation application service, AtomicJsonFile fix) vào sau khi tách 6 widget UI Co4E (N3) Đã kiểm trước khi merge: ui/co4e_tab.py và ui/routing_toggle.py đều bị 2 bên cùng đụng, nhưng ở vùng dòng khác nhau hoàn toàn (bên kia sửa _apply_co4e_routing/RoutingToggle cho R03-T05, N3 chỉ đụng phần dựng sidebar/canvas/chat) — không có xung đột logic thật. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-25 18:43:56 +09:00
parent 0631abf85f 9d6a7be31b
commit c890a20f45
99 changed files with 8342 additions and 236 deletions
@@ -0,0 +1,103 @@
+# ADR-001: 4-Tier Clean Architecture for Desktop Local Application
+
+* **Status**: ACCEPTED / ENFORCED
+* **Date**: 2026-08-21
+* **Deciders**: Team Duy (Tech Lead & AI Runtime), Team Nam (Governance & Automation), Team Hoa (Workspace & Scheduling)
+* **Target Project**: Cowork Local (Cowork-Local BamBOO)
+
+---
+
+## 1. Context and Problem Statement
+
+Cowork Local is a desktop application written in Python using PySide6 (Qt) and designed for local-first execution.
+Historically, the codebase suffered from architectural coupling across layers:
+1. **God-Widget Problem**: Monolithic UI widgets (e.g., `ui/chat_panel.py` >1,800 LOC, `ui/co4e_tab.py` >1,400 LOC) mixed UI rendering, network I/O, business rules, filesystem operations, and background worker lifecycle.
+2. **Untestable Business Logic**: Core algorithms (model routing, conversation turn management, schedule calculation) were tightly coupled to `PySide6` widgets or `QTimer`, making unit testing in headless CI environments impossible without a graphical display server.
+3. **Circular Dependencies & Global State Leaks**: Uncontrolled module imports (`model_pricing.py` ↔ `usage_tracker.py`, `agent_security.py` ↔ `agent_security_alert.py`) and mutable global state (`state.py::AppContext.active_project_id`) caused race conditions in background task runs.
+
+---
+
+## 2. Decision: 4-Tier Clean Architecture
+
+We enforce a strict **4-Tier Clean Architecture** based on the Dependency Inversion Principle:
+
+```text
+┌─────────────────────────────────────────────────────────────┐
+│                      PRESENTATION                           │
+│  (PySide6 Widgets, Dialogs, Qt Signals/Slots, View Models)   │
+└──────────────────────────────┬──────────────────────────────┘
+                               │ depends on
+                               ▼
+┌─────────────────────────────────────────────────────────────┐
+│                      APPLICATION                            │
+│  (Use Case Services, Turn Orchestrators, Route Dispatchers) │
+│             *** STRICTLY PURE PYTHON (0 Qt) ***             │
+└──────────────────────────────┬──────────────────────────────┘
+                               │ depends on
+                               ▼
+┌─────────────────────────────────────────────────────────────┐
+│                   DOMAIN & RUNTIME CORE                     │
+│  (Entities, Value Objects, Domain Events, Tool Descriptors)  │
+│             *** STRICTLY PURE PYTHON (0 Qt) ***             │
+└──────────────────────────────▲──────────────────────────────┘
+                               │ implemented by
+┌──────────────────────────────┴──────────────────────────────┐
+│                     INFRASTRUCTURE                          │
+│  (LLM Providers, Keyring Secrets, Atomic Persistence, MCP)  │
+└─────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## 3. Layer Definitions and Responsibilities
+
+### Tier 1: Presentation Layer (`presentation/`)
+* **Responsibilities**: UI component layout, user event capture, progress display, visual animations, confirmation dialog triggers.
+* **Allowed Imports**: `PySide6.*`, `application.*`, `domain.*`.
+* **Forbidden**: Direct database queries, raw LLM API calls, disk writes outside UI cache, executing tool commands directly.
+* **Constraints**: Every widget file must strictly be **under 400 lines of code (LOC)**.
+
+### Tier 2: Application Layer (`application/`)
+* **Responsibilities**: Orchestrate single use cases (e.g. `ConversationApplicationService`, `RoutingApplicationService`, `TaskApplicationService`). Convert UI requests into domain requests, coordinate domain services with infrastructure adapters.
+* **Allowed Imports**: `domain.*`, `infrastructure.*` interfaces/contracts, standard Python libraries.
+* **Forbidden**: `PySide6`, `PyQt5`, `PyQt6`, `ui.*`, `app.*`.
+* **Nature**: **100% Pure Python**. Must be executable and testable in headless CI environments without a display driver.
+
+### Tier 3: Domain Layer (`domain/`)
+* **Responsibilities**: Core domain models, frozen DTO snapshots (`ConversationExecutionRequest`), typed event streams (`AgentEvent`), descriptors (`ToolDescriptor`, `ProviderDescriptor`), deterministic calculation algorithms (`ScheduleCalculator`).
+* **Allowed Imports**: Standard Python library only (`dataclasses`, `typing`, `enum`, `datetime`, `pathlib`, `abc`).
+* **Forbidden**: `PySide6`, `PyQt*`, `requests`, `sqlalchemy`, filesystem mutations, OS network calls.
+* **Nature**: Completely isolated and zero-dependency core.
+
+### Tier 4: Infrastructure Layer (`infrastructure/`)
+* **Responsibilities**: Adapters for external systems (OpenAI/Anthropic/Ollama/FPT providers, OS Keyring via `SecretStore`, `AtomicJsonFile` persistence, MCP child processes, filesystem tools).
+* **Allowed Imports**: Third-party SDKs, OS libraries, `domain.*`.
+* **Forbidden**: `presentation.*`, `PySide6.QtWidgets`.
+
+---
+
+## 4. Architectural Rules and Non-Negotiable Invariants
+
+1. **Zero Qt in Business Logic**:
+   - `domain/` and `application/` must never import `PySide6` or `PyQt*`.
+   - Verified via AST parser script `scripts/check_imports.py`.
+2. **Immutable Request Snapshots**:
+   - Turns are initiated using immutable frozen dataclasses (`ConversationExecutionRequest`) to decouple runtime state from mutable UI state.
+3. **Thread Safety and Signal Decoupling**:
+   - AI generation and tool calls run asynchronously in worker threads.
+   - UI updates occur strictly on the Qt main thread by consuming `AgentEvent` streams through Qt Signal bridges.
+4. **Single Responsibility and Modularity**:
+   - Production files must stay within **400 LOC**.
+5. **English In-Code Comments**:
+   - Every modified or created line/block must include concise English comments explaining design decisions and processing logic.
+
+---
+
+## 5. Consequences and Compliance
+
+* **Positive**:
+  - Full testability: Unit tests run in milliseconds without GUI or network mocks.
+  - Zero circular dependencies: Clear top-down data flow.
+  - Resilience: UI crashes do not corrupt background tasks or files.
+* **Verification**:
+  - Automated CI gate: `python scripts/check_imports.py` and `python scripts/check_loc.py`.
@@ -0,0 +1,39 @@
+# Danh Mục & Kế Hoạch Cô Lập Mã Nguồn Dormant / Dead Code (Dormant Code Catalog)
+
+* **Tài liệu**: `docs/architecture/dormant-code.md`
+* **Thuộc EPIC**: `R01: Architecture Foundation & Characterization`
+* **Team phụ trách**: 🔵 **Team Duy (Tech Lead)**
+
+---
+
+## 1. Mục Đích & Nguyên Tắc Quản Trị
+
+Trong quá trình phát triển nhanh, một số module, hàm hoặc script đã trở thành mã nguồn không hoạt động (**dormant**), mã nguồn thử nghiệm cũ (**legacy prototypes**), hoặc mã nguồn không còn được sử dụng (**dead code**).
+
+> [!IMPORTANT]
+> ### 🛡️ NGUYÊN TẮC CÔ LẬP MÃ NGUỒN CŨ:
+> 1. **Tuyệt đối không import vào các tầng mới**: Các tầng `domain/`, `application/`, `infrastructure/` mới được xây dựng **cấm tuyệt đối import bất kỳ module dormant nào**.
+> 2. **Không xóa vội vàng khi chưa có test bảo vệ**: Giữ nguyên mã nguồn cũ trong giai đoạn tái cấu trúc R01–R08; chỉ dọn dẹp hoặc xóa sau khi bộ kiểm thử khói E2E (EPIC R10) chạy pass 100%.
+> 3. **Phân loại rõ ràng trạng thái**: Mỗi module dormant phải được gắn nhãn (DEPRECATED / ISOLATED / PENDING_DELETION).
+
+---
+
+## 2. Bảng Danh Mục Mã Nguồn Dormant / Dead Code Đã Rà Soát
+
+| STT | File / Module / Ký Hiệu | Trạng Thái Hiện Tại | Lý Do Phân Loại & Phân Tích Kỹ Thuật | Kế Hoạch Xử Lý & Thời Điểm Gỡ Bỏ |
+| :---: | :--- | :---: | :--- | :--- |
+| **1** | `requirements (cloud copy).txt` | `PENDING_DELETION` | File sao chép dự phòng tạm thời trong quá khứ, không được tham chiếu bởi bất kỳ quy trình setup nào. | Gỡ bỏ trong EPIC R10 (Packaging & Clean-up). |
+| **2** | `preview-desktop` | `ISOLATED` | Script shell rỗng/phác thảo cho môi trường dev container cũ. | Cô lập, không liên kết vào build workflow. |
+| **3** | `scripts/bootstrap_gitea_repo.py` | `ISOLATED` | Script tiện ích bootstrap kho lưu trữ Gitea nội bộ; không thuộc runtime ứng dụng chính. | Di chuyển vào `docs/gitea/` làm tài liệu tham khảo ops. |
+| **4** | Hàm routing sao chép tại `ui/chat_panel.py#L638` | `DEPRECATED` | Đoạn code logic chọn model lặp lại từ `core/routing/` nằm trực tiếp trong UI widget. | Thay thế hoàn toàn bằng `RoutingApplicationService` trong EPIC R03. |
+| **5** | Biến toàn cục `state.py::active_project_id` | `DEPRECATED` | Biến global mutable gây race condition khi chạy background task song song. | Thay thế bằng `WorkspaceSession` trong EPIC R06. |
+| **6** | Các hàm xử lý UI đồng bộ trong `core/tools.py` | `DEPRECATED` | `core/tools.py` chứa mã monolithic vừa xử lý file vừa gọi dialog xác thực trực tiếp. | Phân rã thành `file_tools.py`, `command_tools.py` và `ToolPolicyGateway` trong EPIC R05. |
+
+---
+
+## 3. Quy Trình Cô Lập & Kiểm Soát
+
+1. **Kiểm tra tự động qua AST Guard**:
+   - Bộ script `scripts/check_imports.py` tự động quét để đảm bảo không có bất kỳ import mới nào trỏ tới các thành phần đã đánh dấu deprecated.
+2. **Kế hoạch dọn dẹp cuối cùng (Release Phase - 31/08/2026)**:
+   - Sau khi hoàn thành EPIC R10 và pass toàn bộ bài test E2E (`tests/e2e/test_smoke.py`), các file đánh dấu `PENDING_DELETION` sẽ được gỡ bỏ khỏi nhánh `main`.