Compare commits
32
Commits
@@ -12,36 +12,19 @@ jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
defaults:
|
||||
run:
|
||||
working-directory: cowork_local
|
||||
env:
|
||||
# Tiến trình con của test import `cowork_local` qua đường này.
|
||||
PYTHONPATH: ${{ github.workspace }}
|
||||
steps:
|
||||
# Checkout PHẢI nằm trong thư mục tên đúng `cowork_local`.
|
||||
# Nhiều test characterization sinh tiến trình con chạy
|
||||
# `python -c "from cowork_local... import ..."`; tiến trình con đó chỉ
|
||||
# import được khi trên sys.path có một thư mục mang đúng tên gói. Checkout
|
||||
# vào thư mục tên khác làm 73 test đỏ vì lý do không liên quan tới mã.
|
||||
- name: Check out source
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
path: cowork_local
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.11"
|
||||
cache: pip
|
||||
cache-dependency-path: cowork_local/requirements.txt
|
||||
cache-dependency-path: requirements-test.txt
|
||||
|
||||
# Mot file duy nhat: requirements-test.txt cu chi co pytest, nhung
|
||||
# 64/108 file test dung widget that (20 file import PySide6 thang o dau
|
||||
# file, khong co bao ve) nen no van phai keo ve gan nhu ca danh sach
|
||||
# runtime. Cai rieng file kia thi pytest chet ngay luc thu thap test.
|
||||
- name: Install dependencies
|
||||
run: python -m pip install --disable-pip-version-check -r requirements.txt
|
||||
- name: Install test dependencies
|
||||
run: python -m pip install --disable-pip-version-check -r requirements-test.txt
|
||||
|
||||
- name: Check Python syntax
|
||||
run: |
|
||||
@@ -85,10 +68,3 @@ jobs:
|
||||
else
|
||||
echo "scripts/check_imports.py chưa có — Team Duy viết, hạn 30/08. Bỏ qua."
|
||||
fi
|
||||
|
||||
# Cổng O bổ sung sau đợt đối chiếu AS-IS/TO-BE: ba check trên đều không
|
||||
# bắt được mã chết (file không ai import vẫn đúng chiều phụ thuộc, vẫn
|
||||
# sạch credential, vẫn dưới 400 dòng). Đợt đó tìm ra 1.400 dòng mã trùng
|
||||
# lặp chết lọt qua đúng theo cách này.
|
||||
- name: "CASAN Check O — module production phải có nơi import"
|
||||
run: python scripts/check_orphan_modules.py
|
||||
|
||||
@@ -1,82 +0,0 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project
|
||||
|
||||
Cowork Local (user-facing brand "Cowork-Local BamBOO") is a local-first PySide6 desktop app: multi-turn AI agents, per-project workspaces with GraphRAG, scheduled agent tasks (Kanban), MCP connectors, a sandbox security layer, model routing, and a monitoring dashboard. User config lives in `~/.cowork_local`. The internal name `cowork_local` / `APP_NAME` must not be rebranded. Only `DISPLAY_NAME` is the brand.
|
||||
|
||||
## The package-name quirk (read first)
|
||||
|
||||
The repository root **is** the `cowork_local` package: `__init__.py` and `__main__.py` sit at the root, and code imports itself as `cowork_local.*` or through relative imports. This checkout's folder is not named `cowork_local`, so:
|
||||
|
||||
- **Running the app:** `python -m cowork_local` works only from the parent of a folder literally named `cowork_local`. On Windows, `install.bat` (once; add `--dev` for test deps, `--system` to skip the venv) builds a venv under `%LOCALAPPDATA%\CoworkLocal` and creates a junction `%LOCALAPPDATA%\CoworkLocal\launcher\<key>\cowork_local` pointing at this checkout. After that, use `run.bat`. The MS365 MCP server is spawned as `python -m cowork_local.mcp_servers.ms365_server`, so the junction is needed for subprocesses too.
|
||||
- **Never create a `.venv` inside the repo.** The quality gates walk the whole tree.
|
||||
- **Tests:** the root `conftest.py` and `tests/conftest.py` bind `sys.modules["cowork_local"]` to this checkout, so pytest works whatever the folder is named. Tests use both import styles: top-level (`from providers.base import ...`) and qualified (`from cowork_local.core... import ...`). Characterization tests that spawn `python -c "from cowork_local..."` subprocesses still need a real `cowork_local` directory on `PYTHONPATH`. CI checks out into `cowork_local/` for this reason.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
python -m pip install -r requirements.txt # single requirements file (includes pytest)
|
||||
python -m pytest tests -q # full suite (what CI runs)
|
||||
python -m pytest tests/unit/test_schedule_calculator.py -q # one file
|
||||
python -m pytest tests/unit/test_schedule_calculator.py -k name -q # one test
|
||||
python -m pytest tests/e2e/test_smoke.py -v # release smoke test
|
||||
|
||||
python scripts/run_quality_gate.py # all CASAN gates + pytest
|
||||
python scripts/run_quality_gate.py --skip-tests # static gates only
|
||||
python scripts/check_imports.py # domain/ + application/ must not import PySide6/PyQt/ui/app
|
||||
python scripts/audit_security.py # no plaintext credentials (CI also runs --self-test)
|
||||
python scripts/check_loc.py # <= 400 lines per production file
|
||||
python scripts/check_orphan_modules.py # every production module must be reachable by import
|
||||
```
|
||||
|
||||
Widget tests run headless with `QT_QPA_PLATFORM=offscreen`. `tools/check_*.py` are standalone offscreen smoke checkers against a real `MainWindow` built on a copy of `~/.cowork_local` (for example `python tools/check_nav.py`). Some of them still import private names re-exported from `app.py`, so keep those re-exports. Set `COWORK_PERF_TRACE=1` to log timing spans from `performance.py`.
|
||||
|
||||
## Architecture
|
||||
|
||||
Target design is 4-tier Clean Architecture (`docs/architecture/ADR-001-layered-architecture.md`):
|
||||
|
||||
- `domain/`: pure stdlib entities, frozen request snapshots (`ConversationExecutionRequest`), `AgentEvent`, tool/provider descriptors, `ScheduleCalculator`.
|
||||
- `application/`: pure-Python use-case services (conversations, model_routing, scheduling, workspaces, monitoring, workflows). **No Qt.** Must run headless.
|
||||
- `infrastructure/`: adapters: config (`JsonConfigRepository` over `AtomicJsonFile`), OS-keyring `SecretStore`, providers, MCP (`McpToolSourceManager`), sandbox, filesystem, telemetry, and Qt bridges (`infrastructure/qt`).
|
||||
- `presentation/`: PySide6 widgets by feature (`shell`, `chat`, `co4e`, `dashboard`, `scheduling`, `workspace`, `monitoring`, `graph`, `settings`, ...). Widgets call `application/` services. They don't touch persistence or run LLM calls on the GUI thread. Agent work runs in worker threads and reaches the UI as `AgentEvent`s through Qt signal bridges.
|
||||
|
||||
The refactor is **incomplete**. Legacy top-level packages are still live and imported by the app:
|
||||
- `ui/`: older tabs such as `cowork_tab`, `workspace_tab`, `monitoring_tab`, `settings_dialog`, `chat_panel`, and `co4e_*`.
|
||||
- `core/`: agents, the Co4E flow runner, task scheduler, skills, tools, audit/usage tracking, routing.
|
||||
- `providers/`: `base`, `anthropic`, `openai_compat`, `factory`.
|
||||
- `security/`: validators, command risk classifier.
|
||||
- Root modules: `config.py`, `state.py`.
|
||||
|
||||
`docs/architecture/dormant-code.md` lists deprecated pieces, such as `state.py::active_project_id` and the monolithic `core/tools.py`. New layers must not import dormant code.
|
||||
|
||||
Wiring:
|
||||
- `__main__.py` → `app.run()`.
|
||||
- `presentation/shell/bootstrap.py` is the **Composition Root**. It builds `AppContext` (`state.py`) around `JsonConfigRepository` plus `KeyringAdapter`, falling back to the config file when no keyring exists.
|
||||
- `run()` then seeds the built-in skills (`skill_library/*.skill`) and the Co4E flows, applies the theme, and opens `presentation/shell/main_window.MainWindow`.
|
||||
- Pages are registered in `presentation/shell/page_registry.py`.
|
||||
|
||||
Other cross-cutting pieces:
|
||||
- `i18n/`: `tr(key, **kw)` with en/ja/vi (default `vi`). Long-lived widgets must use `bind_text(...)` or `on_language_changed(...)` so a language switch re-applies their text. Transient dialogs just call `tr()` at construction.
|
||||
- `theme/`: palettes and QSS. Use theme tokens, not hard-coded colors.
|
||||
- `mcp_servers/`: bundled MCP servers (MS365, project_context).
|
||||
- `agent/`: a markdown instruction library for UI/UX bug-fix agents, not runtime code.
|
||||
|
||||
Step-by-step recipes for adding a provider, a tool or MCP server, or a screen are in `docs/governance/contributor-recipes.md`.
|
||||
|
||||
## Rules enforced by gates and review
|
||||
|
||||
- **400-line limit** for every production file. This covers `domain`, `application`, `infrastructure`, `presentation`, `ui`, `core`, `providers`, `security`, `mcp_servers`, `i18n`, `theme`, and root `.py` files. Legacy oversized files have per-file caps in `scripts/check_loc.py` that may only go down. Split files; never raise a cap.
|
||||
- **No orphan modules.** `check_orphan_modules.py` has an `ALLOWLIST` that may only shrink. Wire up or delete a module instead of allowlisting it.
|
||||
- **Secrets** belong in the OS keyring, never in `config.json` or the code. `.env.example` is not auto-loaded. Tests never use live provider credentials (use `tests/fakes/`: `FakeProvider`, `FakeToolExecutor`, `FakeToolPolicyGateway`, `FakeConfigRepository`/`FakeSecretStore`, `FakeClock`, ...).
|
||||
- **Test layout:** `tests/unit` (fast, no I/O), `tests/contracts`, `tests/integration` (Qt offscreen), `tests/characterization` (pinned legacy behavior during refactors), `tests/e2e`, `tests/ui`, plus flat `tests/test_*.py`.
|
||||
- **Startup housekeeping** (seeding, pruning) is wrapped in `try/except` and must never block app launch.
|
||||
- **Comments:** the ADR asks for English comments. Existing code mixes English and Vietnamese docstrings and comments, so match the surrounding file.
|
||||
|
||||
## Git workflow
|
||||
|
||||
- Branches: `feat/`, `fix/`, `test/`, `docs/`, `perf/`, `refactor/<short-desc>`. Core AI work uses `core-ai/<task-id>-<name>`.
|
||||
- Commits use Conventional Commit prefixes (`feat:`, `fix:`, `test:`, `docs:`, `refactor:`, `perf:`, `chore:`).
|
||||
- One logical change per PR, using `.gitea/PULL_REQUEST_TEMPLATE.md`. The remote is a Gitea instance, and CI (`.gitea/workflows/ci.yaml`, Python 3.11) runs on PRs to `main`.
|
||||
- Critical areas listed in `SECURITY.md` get extra review.
|
||||
+1
-1
@@ -48,7 +48,7 @@ Prefer the existing lightweight Conventional Commit prefixes: `feat:`, `fix:`, `
|
||||
Run the application from the parent directory with `python -m cowork_local`. The current reliable test command is:
|
||||
|
||||
```bash
|
||||
python -m pip install -r requirements.txt
|
||||
python -m pip install -r requirements-test.txt
|
||||
python -m pytest tests -q
|
||||
```
|
||||
|
||||
|
||||
@@ -1,101 +1,30 @@
|
||||
# Cowork Local
|
||||
|
||||
Cowork Local is the internal AI cowork desktop platform. It provides a local-first desktop runtime, multi-turn conversational agents, workspace isolation, task scheduling, MCP connectors, security guardrails, and model routing.
|
||||
Cowork Local is the internal AI cowork desktop platform owned by the Cowork Team. It provides the Cowork runtime, workspace and agent experiences, MCP/connectors, security controls, and model routing foundation.
|
||||
|
||||
---
|
||||
The Cowork Team owns this product and its stable branch. The FSG AI Core Team contributes selected reusable capabilities through branches and Pull Requests; it is not the owner or final merger of this repository.
|
||||
|
||||
## 🏛️ 4-Tier Clean Architecture
|
||||
## Quick start
|
||||
|
||||
The codebase strictly adheres to **Clean Architecture** with unidirectional inward dependencies:
|
||||
|
||||
```text
|
||||
presentation/ (PySide6 UI, Shell, NavRail, Chat, Scheduling, Settings, Dashboard)
|
||||
│
|
||||
▼
|
||||
application/ (Pure Python Orchestration: Conversations, Scheduling, Workspaces, Monitoring, Routing)
|
||||
│
|
||||
▼
|
||||
domain/ (Pure Python: Entities, Immutable Execution Requests, Agent Events, Descriptors)
|
||||
▲
|
||||
│
|
||||
infrastructure/ (Adapters, LLM Providers, Atomic Persistence, Keyring SecretStore, MCP)
|
||||
```
|
||||
|
||||
- **Domain & Application Layers**: 100% Pure Python (zero Qt/UI imports).
|
||||
- **Single Responsibility**: Every production module is strictly `<= 400 LOC`.
|
||||
- **Security & Durability**: API keys stored in OS Keyring; atomic JSON disk persistence.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### 1. Windows — two double-clicks
|
||||
|
||||
```
|
||||
install.bat once, to install the Python dependencies
|
||||
run.bat every time, to start the app
|
||||
```
|
||||
|
||||
`install.bat` builds an isolated virtualenv under `%LOCALAPPDATA%\CoworkLocal`
|
||||
(deliberately **outside** the repo — the quality gates walk the whole directory
|
||||
tree, so a `.venv` in here would turn every vendored module into a Gate O
|
||||
violation). Add `--dev` to also install the test dependencies, or `--system` to
|
||||
skip the virtualenv and install into the Python already on `PATH`.
|
||||
|
||||
Both scripts also make the source importable under its package name. That step
|
||||
is not optional: `python -m cowork_local` only resolves when the checkout
|
||||
directory is literally named `cowork_local`, and the MS365 MCP server is
|
||||
launched as a subprocess with `python -m cowork_local.mcp_servers.ms365_server`,
|
||||
so a differently-named checkout breaks the app *and* its subprocesses. The
|
||||
scripts create a junction instead of forcing anyone to rename their folder.
|
||||
|
||||
### 2. Any platform — run from source
|
||||
|
||||
From the **parent** of a checkout directory named `cowork_local`:
|
||||
The imported application is a Python/PySide6 package. Run it from the directory that contains `cowork_local`:
|
||||
|
||||
```bash
|
||||
python -m cowork_local
|
||||
```
|
||||
|
||||
### 3. Run Automated Tests
|
||||
```bash
|
||||
python -m pip install -r requirements.txt
|
||||
pytest -q
|
||||
```
|
||||
|
||||
There is one requirements file, not a runtime/test pair. A separate test file
|
||||
would hold only `pytest`: 64 of the 108 test modules build real widgets, and 20
|
||||
of them import PySide6 unguarded at module scope, so it would have to pull in
|
||||
almost the whole runtime list anyway — two files for one near-identical list is
|
||||
just a second place for the pins to drift.
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ CASAN Quality Gate & Verification
|
||||
|
||||
Before submitting any Pull Request, run the unified CASAN Quality Gate:
|
||||
The source snapshot does not include a complete runtime dependency manifest. Use the Cowork Team's supported runtime environment until that packaging contract is documented. The reliable automated test surface currently checked by CI is:
|
||||
|
||||
```bash
|
||||
# Run all 4 quality gates (Clean Arch, Secrets, LOC, and Pytest Suite)
|
||||
python scripts/run_quality_gate.py
|
||||
|
||||
# Run static and architectural guards only (fast check)
|
||||
python scripts/run_quality_gate.py --skip-tests
|
||||
python -m pip install -r cowork_local/requirements-test.txt
|
||||
python -m pytest cowork_local/tests -q
|
||||
```
|
||||
|
||||
Individual guard scripts:
|
||||
- **Clean Architecture Import Guard**: `python scripts/check_imports.py`
|
||||
- **Secrets & Plaintext Audit**: `python scripts/audit_security.py`
|
||||
- **Single Responsibility LOC Guard**: `python scripts/check_loc.py --max-lines 400`
|
||||
- **Release E2E Smoke Test**: `pytest tests/e2e/test_smoke.py -v`
|
||||
When already inside this repository, run `python -m pytest tests -q`.
|
||||
|
||||
---
|
||||
Configuration and runtime data live under `~/.cowork_local/`. Provider keys and local unlock codes must be supplied through environment variables or an approved secret manager; see `.env.example`.
|
||||
|
||||
## 🤝 Contributing & Recipes
|
||||
## Contributing
|
||||
|
||||
- **Quick Start Guide**: See [START_CONTRIBUTING.md](START_CONTRIBUTING.md).
|
||||
- **Contributor Recipes**: See [docs/governance/contributor-recipes.md](docs/governance/contributor-recipes.md) for step-by-step recipes to:
|
||||
1. Add a new AI Model Provider.
|
||||
2. Add a new Built-in Tool / MCP Server.
|
||||
3. Add a new Screen / Tab / Widget.
|
||||
- **Security Policy**: See [SECURITY.md](SECURITY.md).
|
||||
Start with [START_CONTRIBUTING.md](START_CONTRIBUTING.md), then read [CONTRIBUTING.md](CONTRIBUTING.md). Core AI task execution remains in [fsg-ai-core-assets](http://34.143.229.138/gitea-admin/fsg-ai-core-assets); source changes are reviewed as Pull Requests in this repository.
|
||||
|
||||
Security concerns should follow [SECURITY.md](SECURITY.md). Ownership and completion rules are documented under `docs/governance/`.
|
||||
|
||||
+22
-46
@@ -1,64 +1,40 @@
|
||||
# Start Contributing
|
||||
|
||||
Welcome to the **Cowork Local** contributor guide!
|
||||
## What is this repository?
|
||||
|
||||
---
|
||||
Cowork Local is the Cowork Team's product/platform repository: desktop runtime, UI/UX, workspaces, agents, MCP/connectors, security, and reusable platform foundations.
|
||||
|
||||
## 🏛️ Architecture & Ground Rules
|
||||
The Cowork Team owns architecture, product behavior, releases, the stable branch, final review, and merge. The FSG AI Core Team is a contributor for selected generic capabilities such as MCP integration, agent capabilities, orchestration/model-routing tests, evaluation/security integration, and reusable platform improvements.
|
||||
|
||||
1. **4-Tier Clean Architecture**:
|
||||
- `domain/`: Business entities and immutable data structures (Pure Python).
|
||||
- `application/`: Application services and orchestration (Pure Python).
|
||||
- `infrastructure/`: External integrations, adapters, persistence, and secrets.
|
||||
- `presentation/`: Desktop UI widgets, PySide6 components, and Qt signals.
|
||||
- **Rule**: `domain/` and `application/` must NEVER import `PySide6` or any UI framework.
|
||||
## Where are Core AI tasks?
|
||||
|
||||
2. **File Size Limit (LOC)**:
|
||||
- Every file in `domain/`, `application/`, `infrastructure/`, and `presentation/` must be `<= 400 LOC`.
|
||||
Use [fsg-ai-core-assets Issues/Project](http://34.143.229.138/gitea-admin/fsg-ai-core-assets) as the Core AI task source of truth. Pick and assign a contribution task there, then move it to `In Progress`.
|
||||
|
||||
3. **In-Code Comments**:
|
||||
- All code logic, error handling, and design rationales must be documented with clear **English comments**.
|
||||
Do not copy the Core AI backlog, golden datasets, CASAN assets, agent catalog, or evaluation repository into Cowork Local. Only source/artifacts required by an agreed Cowork runtime contract belong here.
|
||||
|
||||
---
|
||||
## Make the change
|
||||
|
||||
## 🚀 Development Workflow
|
||||
|
||||
### 1. Create a Topic Branch
|
||||
```bash
|
||||
git switch -c feat/my-new-feature
|
||||
```
|
||||
|
||||
### 2. Implement Using Contributor Recipes
|
||||
Follow the standardized recipes in [`docs/governance/contributor-recipes.md`](docs/governance/contributor-recipes.md):
|
||||
- **Recipe 1**: Adding a new AI Model Provider.
|
||||
- **Recipe 2**: Adding a new Tool or MCP Server.
|
||||
- **Recipe 3**: Adding a new UI Screen or Widget.
|
||||
|
||||
### 3. Run CASAN Quality Gate Locally
|
||||
Before committing and pushing your branch, ensure all quality gates pass:
|
||||
Create a focused branch:
|
||||
|
||||
```bash
|
||||
python scripts/run_quality_gate.py
|
||||
git switch -c core-ai/TL-xxx-short-name
|
||||
```
|
||||
|
||||
---
|
||||
For Cowork-native work use `feat/`, `fix/`, `test/`, `docs/`, `perf/`, or `refactor/`. Keep one logical change in one Pull Request.
|
||||
|
||||
## 🧪 Testing Pyramid
|
||||
Run the application from the parent directory with `python -m cowork_local`. Run the current automated test suite from this repository with:
|
||||
|
||||
We maintain a strict multi-tier test pyramid:
|
||||
- `tests/unit/`: Fast unit tests (no I/O, < 0.05s).
|
||||
- `tests/contracts/`: Contract tests for Provider and Tool interfaces.
|
||||
- `tests/integration/`: Component integration tests (Qt offscreen).
|
||||
- `tests/e2e/`: End-to-End release smoke tests (`pytest tests/e2e/test_smoke.py`).
|
||||
- `tests/fakes/`: Reusable in-memory test doubles (`FakeProvider`, `FakeToolRuntime`).
|
||||
```bash
|
||||
python -m pip install -r requirements-test.txt
|
||||
python -m pytest tests -q
|
||||
```
|
||||
|
||||
---
|
||||
Use environment variables for credentials; never commit `.env`, `~/.cowork_local/`, logs, customer data, or generated runtime files.
|
||||
|
||||
## 📋 Definition of Done (DoD)
|
||||
## Review and completion
|
||||
|
||||
A Pull Request is ready for merge only when:
|
||||
- [x] All production files are `<= 400 LOC` (`python scripts/check_loc.py`).
|
||||
- [x] Clean Architecture boundary check has 0 violations (`python scripts/check_imports.py`).
|
||||
- [x] Secrets audit finds 0 plaintext credentials (`python scripts/audit_security.py`).
|
||||
- [x] 100% of test suite passes without regressions (`pytest tests/`).
|
||||
- [x] E2E release smoke tests pass (`pytest tests/e2e/test_smoke.py`).
|
||||
Before opening a Pull Request, obtain Core AI pre-review and move the Core task to `Review`. Open the Pull Request in Cowork Local with the Core repository URL, issue, task ID, scope, validation evidence, and security impact. Then move the Core task to `Upstream Review`.
|
||||
|
||||
The Cowork Team may request changes or approve and merge. A Core AI task is `Done` only after the Cowork Pull Request is merged—not when implementation or Core AI review finishes. Record the Pull Request and merge reference in the Core issue.
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for conventions and `docs/governance/` for ownership, review, and Definition of Done.
|
||||
|
||||
Binary file not shown.
+1
-1
@@ -15,7 +15,7 @@ network control, permission management, audit log). No login required —
|
||||
starts directly with full admin access.
|
||||
"""
|
||||
|
||||
__version__ = "0.0.1"
|
||||
__version__ = "2.26.0"
|
||||
# Internal/technical name — config dir (~/.cowork_local), QSettings org keys,
|
||||
# packaging scripts and docs still use this; do NOT rebrand it.
|
||||
APP_NAME = "Cowork Local"
|
||||
|
||||
@@ -17,13 +17,6 @@ def main() -> int:
|
||||
# a plain script (`python __main__.py`), `__package__` is empty so the
|
||||
# relative import fails — in that case put the package root (the parent
|
||||
# of this file's directory) on sys.path and use an absolute import.
|
||||
"""Điểm vào ``python -m cowork_local``.
|
||||
|
||||
Import muộn để công cụ kiểu ``-h`` và test nạp được gói mà không phải dựng cả
|
||||
ứng dụng Qt. Chạy như script thường (``python __main__.py``) thì
|
||||
``__package__`` rỗng nên import tương đối hỏng — lúc đó đưa thư mục cha vào
|
||||
``sys.path`` và dùng import tuyệt đối.
|
||||
"""
|
||||
if __package__:
|
||||
from .app import run
|
||||
else:
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
"""adapters/ — Adapter riêng cho Qt (clock, thread, timer).
|
||||
|
||||
Kế hoạch gốc đặt tên thư mục này là ``platform/``. Không dùng được: chạy
|
||||
bất kỳ script nào từ thư mục gốc repo (``python tools/...``,
|
||||
``python scripts/...``) thì ``platform/`` **che khuất module ``platform``
|
||||
của thư viện chuẩn**, và ``import keyring`` chết ngay với
|
||||
``AttributeError: module 'platform' has no attribute 'system'``.
|
||||
Repo có 26 script chạy đúng kiểu đó.
|
||||
|
||||
Đổi tên là cách duy nhất chắc chắn — không thể bắt mọi người nhớ "đừng bao
|
||||
giờ chạy python từ thư mục gốc".
|
||||
"""
|
||||
-211
@@ -1,211 +0,0 @@
|
||||
# Agent Library — UI/UX Bug Fixing cho Cowork Local
|
||||
|
||||
Bộ instruction chuyên biệt để xử lý **bug UI/UX do người dùng báo** trong Cowork Local
|
||||
(PySide6 desktop, 4-tier Clean Architecture).
|
||||
|
||||
Thiết kế theo **Production Agent Architecture** (FSG AI Core — Instruction Engineering
|
||||
Training): mỗi agent có Role → Mission → Input → Process → Output → Quality Gate →
|
||||
Self Review, và dùng chung một lớp `system/` (guardrail), `knowledge/` (project
|
||||
knowledge), `checklist/`, `output/` (contract), `examples/`.
|
||||
|
||||
---
|
||||
|
||||
## 1. Vì sao tách như thế này
|
||||
|
||||
Anti-pattern mà bộ này cố tình tránh (mục 10 của tài liệu training):
|
||||
|
||||
| Anti-pattern | Cách bộ agent này xử lý |
|
||||
|---|---|
|
||||
| Hard-code theo project | Rule chung nằm ở `roles/`, tri thức riêng của Cowork Local nằm ở `knowledge/` |
|
||||
| Prompt quá dài | Mỗi role là 1 file; knowledge được **tham chiếu**, không copy vào từng role |
|
||||
| Không có Output Contract | Mọi output đi qua template trong `output/` |
|
||||
| Không có Quality Gate | Mỗi role có Quality Gate riêng + `checklist/` dùng chung |
|
||||
| Không có example | `examples/good_fix.md` và `examples/bad_fix.md` |
|
||||
| Effort cố định bất kể lỗi to nhỏ | `roles/0_fix_dispatcher.md` chấm tier trước, lỗi 4px chạy 0 agent |
|
||||
|
||||
Sáu role **không** bị tách thành 7 file nhỏ mỗi role (role/task/process/...). Lý do:
|
||||
phần bị lặp giữa các role chính là guardrail, knowledge và checklist — chúng đã được
|
||||
tách ra thành module dùng chung. Phần còn lại của mỗi role gắn chặt với nhau
|
||||
(process quyết định output contract, output contract quyết định quality gate), tách ra
|
||||
chỉ tạo thêm chỗ để lệch nhau.
|
||||
|
||||
---
|
||||
|
||||
## 2. Cấu trúc
|
||||
|
||||
```text
|
||||
agent/
|
||||
├─ README.md ← bạn đang ở đây: index + routing map
|
||||
├─ system/
|
||||
│ ├─ guardrail.md ← luật bất biến cho MỌI agent
|
||||
│ ├─ security.md ← xử lý log/screenshot/PII người dùng gửi lên
|
||||
│ └─ response_policy.md ← ngôn ngữ, format, khi nào được hỏi lại
|
||||
├─ knowledge/
|
||||
│ ├─ project_map.md ← ui/ vs presentation/, tầng nào gọi được tầng nào
|
||||
│ ├─ theme_tokens.md ← luật màu sắc: KHÔNG file nào ngoài theme/ được đặt tên màu
|
||||
│ ├─ i18n_rules.md ← tr(), on_language_changed, 3 ngôn ngữ
|
||||
│ ├─ screen_map.md ← map câu chữ người dùng → màn hình → file:line
|
||||
│ ├─ qt_pitfalls.md ← 20 nguyên nhân gốc hay gặp của bug UI PySide6
|
||||
│ ├─ secrets_and_config.md ← SecretStore, schema migration, bẫy .get() trên config merge
|
||||
│ └─ quality_gates.md ← CASAN gate, lệnh chạy, test headless
|
||||
├─ roles/ ← 1 hub + 7 agent chuyên biệt
|
||||
│ ├─ 0_fix_dispatcher.md ← HUB: chấm tier T0/T1/T2/T3, chọn lane, tách defect
|
||||
│ ├─ 1_ui_bug_triage.md
|
||||
│ ├─ 2_ui_visual_fixer.md
|
||||
│ ├─ 3_ux_flow_fixer.md
|
||||
│ ├─ 4_i18n_a11y_fixer.md
|
||||
│ ├─ 5_fix_implementer.md
|
||||
│ ├─ 6_regression_reviewer.md
|
||||
│ └─ 7_security_defect_fixer.md
|
||||
├─ commands/
|
||||
│ └─ fix.md ← nguồn của slash command /fix (điểm vào của hub)
|
||||
├─ workflow/
|
||||
│ ├─ intake_to_fix.md ← pipeline end-to-end, 4 lane theo tier
|
||||
│ └─ handoff_contract.md ← envelope truyền giữa các agent
|
||||
├─ checklist/
|
||||
│ ├─ ui_review.md
|
||||
│ ├─ ux_review.md
|
||||
│ └─ pr_readiness.md
|
||||
├─ output/
|
||||
│ ├─ dispatch_plan.md ← template điều phối (output của Hub)
|
||||
│ ├─ defect_record.md ← template hồ sơ lỗi (output của Triage)
|
||||
│ ├─ fix_plan.md ← template phương án sửa (output của Fixer)
|
||||
│ ├─ fix_report.md ← template báo cáo sau khi sửa (output của Implementer)
|
||||
│ └─ pr_body.md ← template PR khớp .gitea/PULL_REQUEST_TEMPLATE.md
|
||||
└─ examples/
|
||||
├─ good_fix.md
|
||||
└─ bad_fix.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Một hub + bảy agent, và khi nào dùng
|
||||
|
||||
| # | Agent | Pattern | Nhận vào | Trả ra |
|
||||
|---|---|---|---|---|
|
||||
| **0** | **Fix Dispatcher** (hub) | Router | Phản ánh thô của người dùng | `dispatch_plan.md` — tier + lane + tách defect |
|
||||
| 1 | **UI Bug Triage** | Reviewer | Lời kể lộn xộn của user, ảnh chụp màn hình, log | `defect_record.md` + phân loại + route |
|
||||
| 2 | **UI Visual Fixer** | Generator | defect_record (loại `visual`) | `fix_plan.md` — layout/QSS/theme/icon/DPI |
|
||||
| 3 | **UX Flow Fixer** | Generator | defect_record (loại `flow`) | `fix_plan.md` — luồng, trạng thái, phản hồi |
|
||||
| 4 | **i18n & A11y Fixer** | Generator | defect_record (loại `i18n`/`a11y`) | `fix_plan.md` — tr(), tràn chữ, contrast, bàn phím |
|
||||
| 5 | **Fix Implementer** | Generator | `fix_plan.md` | Patch thật + `fix_report.md` |
|
||||
| 6 | **Regression Reviewer** | Reviewer | Patch + fix_report | Verdict PASS/FAIL + `pr_body.md` |
|
||||
| 7 | **Security Defect Fixer** | Generator | defect_record (loại `security`) | `fix_plan.md` — credential, secret, migration |
|
||||
|
||||
Đây là **Multi-Agent Pattern**: `Dispatcher (Router) → Triage (Planner) → Specialist →
|
||||
Implementer (Executor) → Reviewer`.
|
||||
|
||||
**Số bước thực chạy do agent 0 quyết định, không phải mặc định 5.** Bộ v1.2 chạy đủ pipeline
|
||||
cho mọi lỗi, kể cả đổi một giá trị 4px — đó là lý do agent 0 ra đời. Bốn lane:
|
||||
|
||||
| Tier | Lỗi kiểu gì | Lane | Gọi agent |
|
||||
|---|---|---|---|
|
||||
| **T0** | Đổi số đo hiển thị, sai chính tả chuỗi có key sẵn, đổi token màu có sẵn | DIRECT | **0 lần** — hub sửa luôn + 4 cổng máy |
|
||||
| **T1** | Nguyên nhân gốc đã rõ kèm `file:line`, 1 màn, ≤ 3 file, ≤ 40 LOC | SOLO | 1 lần |
|
||||
| **T2** | Nguyên nhân chưa rõ nhưng đã khoanh 1 màn; chạm QSS/token/i18n dùng chung | PAIR | 3 lần |
|
||||
| **T3** | Mô tả thuần triệu chứng, không tái hiện được, nhiều category, > 150 LOC | FULL | 4–5 lần |
|
||||
|
||||
Bước 1 vẫn **không** được bỏ ở T3 — 80% bug UI báo lên là mô tả triệu chứng, không phải
|
||||
nguyên nhân. Ở T1/T2, phần triage do hub tự làm trong `dispatch_plan`, và chỉ hợp lệ khi
|
||||
phản ánh đã tự chỉ ra màn hình + triệu chứng cụ thể. Bước 6 chỉ được bỏ ở T0/T1, và phải
|
||||
nêu rõ cổng nào thay thế.
|
||||
|
||||
Agent 7 là specialist thứ tư, ngang hàng 2/3/4 trong pipeline, nhưng khác ở hai điểm: nó
|
||||
được phép chạm `config.py`, `infrastructure/`, `core/` (ba role kia bị chặn ở tầng
|
||||
presentation), và nó **không được tự quyết chính sách bảo mật** — bốn câu hỏi bắt buộc trả
|
||||
về cho Cowork Team.
|
||||
|
||||
### Routing rule (Hub chấm tier → Triage chọn specialist)
|
||||
|
||||
```text
|
||||
Người dùng báo lỗi
|
||||
│
|
||||
├─ agent 0 tách thành N defect_id, chấm tier từng cái
|
||||
│ (≤ 5 lệnh đọc/grep, 0 subagent; hết mà chưa chấm được → T2)
|
||||
│
|
||||
├─ "nhìn sai / lệch / mất chữ / màu lạ / bị che" → 2. UI Visual Fixer
|
||||
├─ "bấm không ăn / không biết đang chạy / mất dữ liệu" → 3. UX Flow Fixer
|
||||
├─ "chữ tiếng Nhật bị tràn / đổi ngôn ngữ không đổi" → 4. i18n & A11y Fixer
|
||||
├─ "mật khẩu nằm trong code / mở khoá bằng ô trống" → 7. Security Defect Fixer
|
||||
└─ "app crash / sai số liệu / sai nghiệp vụ" → KHÔNG phải bug UI.
|
||||
Trả về, mở issue type:bug thường.
|
||||
|
||||
Nhóm `security` THẮNG mọi nhóm khác: lỗi vừa lệch layout vừa lộ credential thì đi 7 trước.
|
||||
Tín hiệu bảo mật cũng ép tier lên **T3-SEC** bất kể diff nhỏ cỡ nào — một dòng `==` so
|
||||
mật khẩu không bao giờ là T0.
|
||||
```
|
||||
|
||||
Tier chỉ đi **lên**. FAIL ở bước 6 → tier +1 rồi chạy lại, không sửa lại ở nguyên tier cũ.
|
||||
|
||||
---
|
||||
|
||||
## 4. Cách dùng
|
||||
|
||||
### 4.0 Điểm vào (khuyến nghị)
|
||||
|
||||
Cài một lần cho mỗi máy — `.claude/` nằm trong `.gitignore`, nên nó **không** theo
|
||||
clone; `agent/` mới là bản gốc được version:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/agents .claude/commands
|
||||
cp agent/roles/[1-7]_*.md .claude/agents/
|
||||
cp agent/commands/fix.md .claude/commands/
|
||||
```
|
||||
|
||||
Rồi:
|
||||
|
||||
```text
|
||||
/fix màn Folder kéo to ra thì mất cây thư mục bên trái
|
||||
```
|
||||
|
||||
Hub sẽ chấm tier, in `dispatch_plan`, rồi tự chạy đúng lane. Chỉ gọi trực tiếp role 1–7
|
||||
khi đã biết chắc tier.
|
||||
|
||||
### 4.1 Dùng thủ công (mọi trợ lý AI)
|
||||
|
||||
Nạp theo đúng thứ tự này rồi dán bug report của user vào:
|
||||
|
||||
```text
|
||||
agent/system/guardrail.md
|
||||
agent/system/security.md
|
||||
agent/system/response_policy.md
|
||||
agent/roles/0_fix_dispatcher.md ← luôn nạp trước, để biết cần chạy tới đâu
|
||||
agent/roles/<role đang dùng>.md
|
||||
+ các file knowledge/ mà role đó liệt kê ở mục "KNOWLEDGE"
|
||||
```
|
||||
|
||||
### 4.2 Dùng trong Claude Code (subagent)
|
||||
|
||||
Mỗi file trong `roles/` có sẵn YAML frontmatter `name` + `description`. Để biến thành
|
||||
subagent, copy sang `.claude/agents/`:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/agents
|
||||
cp agent/roles/[1-7]_*.md .claude/agents/
|
||||
```
|
||||
|
||||
`0_fix_dispatcher.md` **không** copy vào `.claude/agents/`: hub cần quyền gọi agent khác,
|
||||
mà subagent trong Claude Code không gọi được subagent. Hub chạy ở session chính, qua
|
||||
`/fix` (`.claude/commands/fix.md`).
|
||||
|
||||
Sau đó gọi bằng tên: `ui-bug-triage`, `ui-visual-fixer`, `ux-flow-fixer`,
|
||||
`i18n-a11y-fixer`, `fix-implementer`, `regression-reviewer`, `security-defect-fixer`.
|
||||
|
||||
### 4.3 Chạy cả pipeline
|
||||
|
||||
Xem `workflow/intake_to_fix.md`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Versioning
|
||||
|
||||
Bộ instruction này được version bằng Git cùng source. Khi sửa một role, ghi lý do
|
||||
trong commit message — instruction cũng là code.
|
||||
|
||||
| Version | Ngày | Thay đổi |
|
||||
|---|---|---|
|
||||
| 1.0 | 2026-09-07 | Bản đầu: 6 role, 6 knowledge module, 4 output contract |
|
||||
| 1.1 | 2026-09-07 | Thêm role 7 `security-defect-fixer` + `knowledge/secrets_and_config.md`. Lý do: bộ v1.0 chỉ phủ UI/UX, nên credential hardcode phát hiện qua màn Settings bị rơi vào `not-ui` và không ai nhận |
|
||||
| 1.4 | 2026-09-08 | Nạp bài học từ lượt audit i18n toàn app. `knowledge/i18n_rules.md` §2.0 (`bind_*` là cách mặc định cho chuỗi tĩnh, `bind_dynamic` cho chữ theo trạng thái, không bind dữ liệu), §"Cách TÌM ra hết các chỗ bị lỗi" (grep chuỗi tiếng Việt ra 962 dòng mà **không** dòng nào là lỗi thật; phép đo đúng là thay `tr()` bằng chuỗi mốc trên `MainWindow` thật), và 3 mục checklist mới. Lý do: bộ v1.3 không có cách nào phát hiện lỗi "chữ không được áp lại" — nó không để lại dấu vết nào trong source |
|
||||
| 1.3 | 2026-09-08 | Thêm hub `0_fix_dispatcher` + `output/dispatch_plan.md` + `/fix`. Lý do: bộ v1.2 không có tầng điều phối, nên **mọi** lỗi đều kéo cả pipeline 4–5 agent — kể cả nới một `setMinimumWidth` lên 232px. Bổ sung 4 lane theo tier, danh sách đóng T0 (6 loại + 9 disqualifier), 4 cổng máy thay reviewer ở T0, luật escalate một chiều, và luật tách một phản ánh thành nhiều `defect_id` chấm tier riêng |
|
||||
| 1.2 | 2026-09-07 | Nạp bài học từ lần chạy thật đầu tiên (`SEC-20260907-01`). Bản vá của bước 5 mang một blocker mà **không mục nào trong bộ v1.1 bắt được** — reviewer tìm ra bằng tay. Bổ sung: `secrets_and_config.md` §9 (chặn rỗng, `compare_digest` + ASCII, và luật "API an toàn hơn thường có miền đầu vào hẹp hơn"); `6_regression_reviewer.md` Bước 2.1 (ràng buộc miền đầu vào) và 4.1 (test rỗng ruột); `5_fix_implementer.md` + `quality_gates.md` (baseline bằng `comm -13` trên tên test, guard `git add`, và thực tế suite vốn đã đỏ 11+66); `bad_fix.md` ca 11-12 — hai ví dụ **có thật** đầu tiên trong file |
|
||||
@@ -1,158 +0,0 @@
|
||||
# Checklist sẵn sàng tạo PR
|
||||
|
||||
Checklist này được sử dụng bởi:
|
||||
|
||||
* `fix-implementer` — kiểm tra ở bước 9.
|
||||
* `regression-reviewer` — kiểm tra ở bước 8.
|
||||
|
||||
Tham chiếu:
|
||||
|
||||
* `.gitea/PULL_REQUEST_TEMPLATE.md`
|
||||
* `docs/governance/definition-of-done.md`
|
||||
|
||||
---
|
||||
|
||||
## A. Kiểm tra chất lượng
|
||||
|
||||
* [ ] Chạy `python scripts/run_quality_gate.py`.
|
||||
Cả **5 quality gate đều phải PASS** và phải ghi lại **output thực tế**.
|
||||
|
||||
* [ ] **Gate C:** Các thư mục `domain/` và `application/` không được import:
|
||||
- `PySide6`
|
||||
- `PyQt`
|
||||
- `ui`
|
||||
- `app`
|
||||
|
||||
* [ ] **Gate A:** Không tạo thêm secret hoặc thông tin nhạy cảm dạng plaintext.
|
||||
|
||||
* [ ] **Gate S:** Không có file nào vượt quá **400 dòng code (LOC)**.
|
||||
|
||||
* [ ] **Gate O:** Không có file/module mới bị bỏ quên.
|
||||
File Python mới phải được sử dụng/import trong cùng thay đổi.
|
||||
|
||||
* [ ] **Gate A/N:** Test phải PASS.
|
||||
Nếu đã có test FAIL từ trước thì phải ghi rõ đó là **lỗi có sẵn**, không phải lỗi do bản sửa này gây ra.
|
||||
|
||||
---
|
||||
|
||||
## B. Kiểm tra bản sửa
|
||||
|
||||
* [ ] Có **regression test** cho lỗi đã sửa.
|
||||
|
||||
* [ ] Regression test phải chứng minh được:
|
||||
- **Trước khi sửa:** test FAIL.
|
||||
- **Sau khi sửa:** test PASS.
|
||||
|
||||
* [ ] Test chạy được ở chế độ headless:
|
||||
`QT_QPA_PLATFORM=offscreen`
|
||||
|
||||
* [ ] Nếu thay đổi liên quan đến UI:
|
||||
- Đã kiểm tra giao diện ở **Dark Mode**.
|
||||
- Đã kiểm tra giao diện ở **Light Mode**.
|
||||
- Nếu chưa thể kiểm tra bằng mắt, phải ghi rõ:
|
||||
**"Chưa kiểm chứng bằng mắt"** và nêu lý do.
|
||||
|
||||
* [ ] Nếu thay đổi liên quan đến ngôn ngữ:
|
||||
đã kiểm tra các ngôn ngữ bị ảnh hưởng.
|
||||
|
||||
---
|
||||
|
||||
## C. Kiểm tra phạm vi thay đổi và Git
|
||||
|
||||
* [ ] Một PR chỉ giải quyết **một thay đổi logic chính**.
|
||||
Không đưa refactor không liên quan vào cùng PR.
|
||||
|
||||
* [ ] Không tự ý format hoặc thay đổi indent của toàn bộ file.
|
||||
Diff phải rõ ràng và dễ review.
|
||||
|
||||
* [ ] Làm việc trên **branch riêng**.
|
||||
Không commit trực tiếp vào `main`.
|
||||
|
||||
* [ ] Commit message phải nêu:
|
||||
- Nguyên nhân gốc của lỗi.
|
||||
- Vị trí code liên quan (`file:line`).
|
||||
- Issue liên quan.
|
||||
|
||||
* [ ] Không commit các file/dữ liệu sau:
|
||||
- `.env`
|
||||
- `config.json` local
|
||||
- `.cowork_local/`
|
||||
- `.venv/`
|
||||
|
||||
---
|
||||
|
||||
## D. Kiểm tra bảo mật
|
||||
|
||||
* [ ] Không có các thông tin sau trong code, test fixture, commit message hoặc PR body:
|
||||
- Secret
|
||||
- PII/thông tin cá nhân
|
||||
- Đường dẫn chứa thông tin cá nhân trên máy local
|
||||
|
||||
* [ ] Nếu có ảnh chụp màn hình trong PR:
|
||||
đã che (redact) toàn bộ thông tin nhạy cảm trước khi đính kèm.
|
||||
|
||||
* [ ] Nếu thay đổi liên quan đến một trong các nội dung sau:
|
||||
|
||||
```
|
||||
- Permission/quyền truy cập
|
||||
- Credential/thông tin xác thực
|
||||
- MCP write/exec
|
||||
- Sandbox
|
||||
- Network
|
||||
- TLS
|
||||
- Isolation
|
||||
- Model routing
|
||||
- Xóa dữ liệu
|
||||
|
||||
thì phải:
|
||||
|
||||
1. Đặt `security-review: required`.
|
||||
2. Ghi rõ trong PR rằng:
|
||||
**"CI xanh không có nghĩa là có thể merge ngay."**
|
||||
3. Chờ security review theo quy trình trước khi merge.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## E. Kiểm tra nội dung PR
|
||||
|
||||
* [ ] **Summary** phải giải thích **tại sao cần sửa**, không chỉ mô tả đã sửa cái gì.
|
||||
|
||||
* [ ] Đã chọn **Change Type** phù hợp.
|
||||
|
||||
* [ ] **Scope** phải ghi rõ:
|
||||
- Những gì đã thay đổi.
|
||||
- Những gì **cố ý không thay đổi**.
|
||||
|
||||
* [ ] **Validation** phải ghi:
|
||||
- Lệnh đã chạy.
|
||||
- Kết quả thực tế/output.
|
||||
|
||||
* [ ] **Security Impact** phải được điền.
|
||||
Nếu không ảnh hưởng bảo mật, ghi rõ **"Không có"**.
|
||||
|
||||
* [ ] Đã chọn **Compatibility** phù hợp.
|
||||
|
||||
* [ ] **Reviewer Notes** phải chỉ ra những phần reviewer cần kiểm tra kỹ nhất.
|
||||
|
||||
* [ ] Đã cập nhật tài liệu nếu cần:
|
||||
- `docs/`
|
||||
- Ảnh màn hình trong `docs/screens/`
|
||||
|
||||
---
|
||||
|
||||
## F. Giới hạn quyền của Agent
|
||||
|
||||
* [ ] Agent **không được tự merge PR**.
|
||||
|
||||
* [ ] Agent **không được tự đóng issue**.
|
||||
|
||||
* [ ] Nếu đây là đóng góp từ **FSG AI Core**, cần hiểu rằng trạng thái **"Done"** chỉ được xác nhận khi PR đã thực sự được merge vào Cowork Local và có đầy đủ:
|
||||
|
||||
```
|
||||
- Core issue reference
|
||||
- PR reference
|
||||
- Evidence
|
||||
- Reviewer phía Cowork
|
||||
- Merge reference
|
||||
```
|
||||
@@ -1,203 +0,0 @@
|
||||
# Checklist review bản vá UI (Visual)
|
||||
|
||||
Checklist này được sử dụng bởi:
|
||||
|
||||
* `ui-visual-fixer` — kiểm tra ở bước 7.
|
||||
* `regression-reviewer` — kiểm tra ở bước 5.
|
||||
|
||||
Mục tiêu: đảm bảo bản vá UI sửa đúng nguyên nhân, không phá theme, layout, icon hoặc vòng đời của giao diện.
|
||||
|
||||
---
|
||||
|
||||
## A. Kiểm tra đúng file
|
||||
|
||||
* [ ] Đã tìm kiếm trong **cả `ui/` và `presentation/`** để xác định file thực sự được ứng dụng sử dụng khi chạy.
|
||||
|
||||
* [ ] Đã kiểm tra xem widget có file/bản triển khai trùng tên ở thư mục còn lại hay không.
|
||||
|
||||
* [ ] Nếu có nhiều file cùng chức năng, đã xác định rõ **file nào thực sự được import và chạy**.
|
||||
|
||||
---
|
||||
|
||||
## B. Kiểm tra màu sắc và Theme
|
||||
|
||||
* [ ] Không thêm mã màu trực tiếp như `#rrggbb` hoặc tên màu như `"red"` bên ngoài thư mục `theme/`.
|
||||
|
||||
* [ ] Không thêm `setStyleSheet()` trực tiếp vào widget.
|
||||
Style phải được quản lý thông qua:
|
||||
|
||||
```
|
||||
`objectName` → `theme/qss.py`
|
||||
```
|
||||
|
||||
* [ ] Nếu thêm token màu mới, token đó phải được khai báo cho **cả `DARK` và `LIGHT`**.
|
||||
|
||||
* [ ] Khi đặt chữ trên nền màu đặc, dùng `accent_solid`.
|
||||
Không dùng `accent` cho trường hợp này.
|
||||
|
||||
* [ ] Dùng đúng loại màu nền theo mục đích:
|
||||
|
||||
```
|
||||
- `bg` — nền chính.
|
||||
- `surface` — bề mặt thông thường.
|
||||
- `surface_raised` — bề mặt nổi.
|
||||
- `overlay` — lớp phủ.
|
||||
- `sunken` — khu vực chìm.
|
||||
```
|
||||
|
||||
* [ ] Contrast của chữ đạt tối thiểu **4.5:1** đối với:
|
||||
- Body text.
|
||||
- Chữ trên nút có nền đặc.
|
||||
- Cả Dark Mode và Light Mode.
|
||||
|
||||
* [ ] Không thêm:
|
||||
- Gradient.
|
||||
- Glow.
|
||||
|
||||
```
|
||||
Đây là các kiểu không phù hợp với design constraint hiện tại.
|
||||
```
|
||||
|
||||
* [ ] `Nav rail` vẫn **tối hơn khu vực nội dung**.
|
||||
Đây là thiết kế có chủ ý, không tự ý làm sáng lên.
|
||||
|
||||
* [ ] Không khôi phục các giá trị màu cũ theo VS Code nếu các giá trị hiện tại đã được điều chỉnh để đạt WCAG AA.
|
||||
|
||||
* [ ] Nếu thay đổi `_TEMPLATE`:
|
||||
đã đánh giá và ghi rõ **phạm vi ảnh hưởng trên toàn ứng dụng** vì `_TEMPLATE` có thể ảnh hưởng nhiều màn hình.
|
||||
|
||||
---
|
||||
|
||||
## C. Kiểm tra Layout và kích thước
|
||||
|
||||
* [ ] Không thêm mới:
|
||||
|
||||
```
|
||||
- `setFixedWidth()`
|
||||
- `setFixedHeight()`
|
||||
- `setFixedSize()`
|
||||
|
||||
để che hoặc né lỗi layout.
|
||||
```
|
||||
|
||||
* [ ] `stretch factor` và `size policy` được thiết lập rõ ràng khi cần.
|
||||
|
||||
* [ ] Nếu sử dụng `QScrollArea`, phải có:
|
||||
|
||||
```
|
||||
`setWidgetResizable(True)`
|
||||
```
|
||||
|
||||
* [ ] Kiểm tra margin và spacing của các layout lồng nhau.
|
||||
Không được để chúng cộng dồn khiến UI bị lệch hoặc quá rộng.
|
||||
|
||||
* [ ] UI vẫn hiển thị đúng ở:
|
||||
- Kích thước cửa sổ nhỏ nhất.
|
||||
- Cửa sổ maximize.
|
||||
|
||||
* [ ] Nếu bản vá liên quan đến kích thước, phải kiểm tra thêm ở:
|
||||
- Scale 125%.
|
||||
- Scale 150%.
|
||||
|
||||
---
|
||||
|
||||
## D. Kiểm tra Icon và Custom Painting
|
||||
|
||||
* [ ] Icon phải được lấy thông qua:
|
||||
|
||||
```
|
||||
`ui/icons.py::icon`
|
||||
|
||||
Không tự load file icon trực tiếp.
|
||||
```
|
||||
|
||||
* [ ] Trong `paintEvent()`, màu sắc phải lấy từ:
|
||||
|
||||
```
|
||||
`current_palette()`
|
||||
|
||||
Không đọc lại màu trực tiếp từ config.
|
||||
```
|
||||
|
||||
* [ ] Trong các vòng lặp hoặc thao tác cập nhật UI, dùng:
|
||||
|
||||
```
|
||||
`update()`
|
||||
|
||||
Không dùng `repaint()` nếu không thực sự cần thiết.
|
||||
```
|
||||
|
||||
* [ ] `QPainter` được kết thúc đúng cách bằng `end()` khi sử dụng thủ công.
|
||||
|
||||
* [ ] Nền của khu vực custom painting được xử lý/xóa đúng cách, không để lại hình ảnh hoặc pixel cũ.
|
||||
|
||||
---
|
||||
|
||||
## E. Kiểm tra vòng đời UI
|
||||
|
||||
* [ ] UI vẫn hoạt động đúng nếu người dùng:
|
||||
|
||||
```
|
||||
1. Đổi theme trước.
|
||||
2. Sau đó mới mở màn hình được tạo theo kiểu lazy.
|
||||
|
||||
Đặc biệt kiểm tra lỗi **P07**.
|
||||
```
|
||||
|
||||
* [ ] Nếu dùng `setProperty()` để thay đổi style động:
|
||||
phải gọi `unpolish()` và `polish()` khi cần để QSS được áp dụng lại.
|
||||
|
||||
* [ ] Không gọi `connect()` nhiều lần trong một hàm có thể được gọi nhiều lần.
|
||||
|
||||
* [ ] Không tạo signal/slot bị kết nối lặp, gây ra:
|
||||
- Event chạy nhiều lần.
|
||||
- UI cập nhật nhiều lần.
|
||||
- Memory leak hoặc hành vi bất thường.
|
||||
|
||||
---
|
||||
|
||||
## F. Kiểm tra bằng chứng
|
||||
|
||||
* [ ] Đã đối chiếu với screenshot trong:
|
||||
|
||||
```
|
||||
`docs/screens/<slug>-dark.png`
|
||||
|
||||
và
|
||||
|
||||
`docs/screens/<slug>-light.png`
|
||||
```
|
||||
|
||||
* [ ] Nếu bản vá làm thay đổi giao diện, đã xác định screenshot nào cần cập nhật.
|
||||
|
||||
* [ ] Nếu cần cập nhật screenshot trong `docs/screens/`, phải ghi rõ trong phạm vi thay đổi.
|
||||
|
||||
* [ ] Có regression test cho lỗi đã sửa.
|
||||
|
||||
* [ ] Regression test chạy được ở chế độ headless:
|
||||
|
||||
```
|
||||
`QT_QPA_PLATFORM=offscreen`
|
||||
```
|
||||
|
||||
* [ ] Regression test chứng minh được:
|
||||
|
||||
```
|
||||
**Trước khi sửa → FAIL**
|
||||
|
||||
**Sau khi sửa → PASS**
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Kết luận
|
||||
|
||||
Chỉ đánh giá bản vá là **PASS** khi:
|
||||
|
||||
1. Sửa đúng file thực sự chạy.
|
||||
2. Không phá theme hoặc layout hiện có.
|
||||
3. Không dùng workaround để che lỗi.
|
||||
4. Không tạo regression.
|
||||
5. Có regression test phù hợp.
|
||||
6. Có đủ bằng chứng kiểm chứng.
|
||||
7. Các vấn đề liên quan đến security hoặc product decision đã được route đúng agent/người phụ trách.
|
||||
@@ -1,212 +0,0 @@
|
||||
# Checklist review bản vá UX (Flow)
|
||||
|
||||
Checklist này được sử dụng bởi:
|
||||
|
||||
* `ux-flow-fixer` — kiểm tra ở bước 8.
|
||||
* `regression-reviewer` — kiểm tra trong quá trình review bản vá.
|
||||
|
||||
Mục tiêu: đảm bảo người dùng luôn biết **hệ thống đang làm gì, chuyện gì xảy ra và cần làm gì tiếp theo**, đồng thời không bị mất dữ liệu.
|
||||
|
||||
---
|
||||
|
||||
## A. Kiểm tra 4 trạng thái chính
|
||||
|
||||
Đối với mỗi màn hình có dữ liệu hoặc thao tác chạy bất đồng bộ, phải kiểm tra đủ 4 trạng thái:
|
||||
|
||||
### 1. Trạng thái Rỗng (Empty)
|
||||
|
||||
* [ ] Khi chưa có dữ liệu, màn hình phải hiển thị thông báo có ý nghĩa.
|
||||
|
||||
* [ ] Thông báo phải cho người dùng biết **cần làm gì tiếp theo**.
|
||||
|
||||
* [ ] Không để màn hình trắng khiến người dùng không biết chuyện gì đang xảy ra.
|
||||
|
||||
### 2. Trạng thái Đang tải (Loading)
|
||||
|
||||
* [ ] Có dấu hiệu rõ ràng cho biết hệ thống đang xử lý, ví dụ loading indicator.
|
||||
|
||||
* [ ] Các nút có thể gây chạy lại cùng một thao tác được vô hiệu hóa trong lúc đang xử lý.
|
||||
|
||||
* [ ] Bấm liên tục hoặc bấm đúp không được tạo ra nhiều request/thao tác giống nhau.
|
||||
|
||||
### 3. Trạng thái Lỗi (Error)
|
||||
|
||||
* [ ] Thông báo lỗi phải cho biết:
|
||||
- **Chuyện gì đã xảy ra.**
|
||||
- **Người dùng cần làm gì tiếp theo.**
|
||||
|
||||
* [ ] Có cách để người dùng **thử lại** khi phù hợp.
|
||||
|
||||
* [ ] Không hiển thị nguyên exception, stack trace hoặc thông tin kỹ thuật khó hiểu cho người dùng.
|
||||
|
||||
### 4. Trạng thái Thành công (Success)
|
||||
|
||||
* [ ] Sau khi thao tác thành công, phải có thông báo/xác nhận rõ ràng.
|
||||
|
||||
* [ ] Với thao tác khó hoặc không thể hoàn tác, phải có cơ chế **Undo** nếu phù hợp.
|
||||
|
||||
---
|
||||
|
||||
## B. Kiểm tra an toàn dữ liệu
|
||||
|
||||
* [ ] Các ô nhập nội dung dài, ví dụ:
|
||||
- Instruction
|
||||
- Composer
|
||||
- Node property
|
||||
- AI Edit
|
||||
|
||||
```
|
||||
không được mất nội dung khi:
|
||||
|
||||
- Chuyển tab.
|
||||
- Đóng/mở dialog.
|
||||
- Đổi project.
|
||||
```
|
||||
|
||||
* [ ] Có cơ chế xác định **dirty-state** khi dữ liệu đã thay đổi nhưng chưa lưu.
|
||||
|
||||
* [ ] `closeEvent` phải cảnh báo hoặc chặn việc đóng màn hình khi vẫn còn thay đổi chưa lưu.
|
||||
|
||||
* [ ] Các thao tác có thể làm mất dữ liệu phải có bước xác nhận, ví dụ:
|
||||
- Xóa project.
|
||||
- Xóa task.
|
||||
- Ghi đè file.
|
||||
|
||||
* [ ] Nội dung xác nhận phải nói rõ **dữ liệu nào sẽ bị mất**.
|
||||
|
||||
```
|
||||
Không dùng thông báo quá chung chung như:
|
||||
|
||||
`"Bạn có chắc không?"`
|
||||
```
|
||||
|
||||
* [ ] Nút thực hiện thao tác phá hủy dữ liệu:
|
||||
- Không được đặt làm **default button**.
|
||||
- Không được thực hiện khi người dùng chỉ nhấn `Enter`.
|
||||
|
||||
---
|
||||
|
||||
## C. Kiểm tra phản hồi theo thời gian
|
||||
|
||||
Phản hồi của UI phải phù hợp với thời gian xử lý:
|
||||
|
||||
* [ ] **100ms – 1s:**
|
||||
Có thể thay đổi con trỏ hoặc vô hiệu hóa nút để người dùng biết thao tác đã được nhận.
|
||||
|
||||
* [ ] **1s – 10s:**
|
||||
Hiển thị chỉ báo tiến trình rõ ràng.
|
||||
|
||||
* [ ] **Trên 10s:**
|
||||
- Có chỉ báo tiến trình.
|
||||
- Người dùng có thể **hủy thao tác** khi phù hợp.
|
||||
- Không khóa toàn bộ UI nếu không cần thiết.
|
||||
|
||||
* [ ] Các tác vụ xử lý nặng không được chạy trực tiếp trên GUI thread.
|
||||
Phải chuyển phần xử lý nặng sang service trong `application/`.
|
||||
|
||||
* [ ] Một thao tác không được chạy hai lần khi người dùng bấm liên tục hoặc bấm đúp.
|
||||
|
||||
* [ ] Kiểm tra các `connect()` có bị đăng ký nhiều lần hay không, đặc biệt với lỗi **P10**.
|
||||
|
||||
---
|
||||
|
||||
## D. Kiểm tra khả năng khám phá chức năng
|
||||
|
||||
Người dùng phải dễ dàng biết **nút này làm gì và tìm chức năng ở đâu**.
|
||||
|
||||
* [ ] Tất cả các nút chỉ có icon (`icon-only`) đều có tooltip.
|
||||
|
||||
```
|
||||
Đặc biệt kiểm tra:
|
||||
- Nav rail khi thu gọn.
|
||||
- Toolbar Co4E.
|
||||
- Top bar.
|
||||
```
|
||||
|
||||
* [ ] Nút đang bị vô hiệu hóa phải cho người dùng biết **tại sao không thể bấm**.
|
||||
|
||||
```
|
||||
Ví dụ sử dụng key:
|
||||
|
||||
`app.nav.needs_project`
|
||||
```
|
||||
|
||||
* [ ] Chức năng chính không được chỉ nằm trong menu chuột phải nếu không có cách truy cập khác.
|
||||
|
||||
* [ ] Thứ tự các control trên màn hình phải phù hợp với **thứ tự người dùng thực hiện công việc**.
|
||||
|
||||
---
|
||||
|
||||
## E. Kiểm tra tính nhất quán
|
||||
|
||||
* [ ] Một hành động phải sử dụng **cùng một thuật ngữ** trên toàn bộ ứng dụng.
|
||||
|
||||
```
|
||||
Ví dụ:
|
||||
|
||||
Nếu dùng `"Lưu"` ở một màn hình thì không nên dùng `"Cập nhật"` ở màn hình khác cho cùng một hành động.
|
||||
```
|
||||
|
||||
* [ ] Vị trí của nút chính và nút phụ phải nhất quán với các dialog khác.
|
||||
|
||||
* [ ] Chuỗi text mới phải sử dụng `tr()`.
|
||||
|
||||
* [ ] Chuỗi mới phải có bản dịch đầy đủ cho:
|
||||
|
||||
```
|
||||
- `en`
|
||||
- `ja`
|
||||
- `vi`
|
||||
```
|
||||
|
||||
* [ ] Không hardcode text mới trực tiếp trong UI code nếu text đó cần hỗ trợ đa ngôn ngữ.
|
||||
|
||||
---
|
||||
|
||||
## F. Kiểm tra phạm vi thay đổi
|
||||
|
||||
* [ ] Bản vá sử dụng **cách can thiệp nhỏ nhất có thể**.
|
||||
|
||||
```
|
||||
Ưu tiên:
|
||||
|
||||
**Bổ sung thông tin → cải thiện feedback → điều chỉnh control → thay đổi flow**
|
||||
|
||||
Không thay đổi cả luồng khi chỉ cần bổ sung thông tin.
|
||||
```
|
||||
|
||||
* [ ] Nếu cần thay đổi flow của người dùng, thay đổi đó phải được ghi rõ là:
|
||||
|
||||
```
|
||||
**ĐỀ XUẤT**
|
||||
```
|
||||
|
||||
* [ ] Agent không tự quyết định thay đổi product/UX quan trọng.
|
||||
|
||||
* [ ] Các thay đổi flow cần được **Cowork Team xem xét và phê duyệt**.
|
||||
|
||||
* [ ] Có regression test kiểm tra:
|
||||
- Signal.
|
||||
- State.
|
||||
- Chuyển trạng thái.
|
||||
- Hành vi của user flow liên quan.
|
||||
|
||||
* [ ] Regression test chạy được ở chế độ headless:
|
||||
|
||||
```
|
||||
`QT_QPA_PLATFORM=offscreen`
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Kết luận
|
||||
|
||||
Bản vá UX chỉ nên được đánh giá là đạt khi:
|
||||
|
||||
1. Người dùng biết rõ trạng thái hiện tại của hệ thống.
|
||||
2. Không có nguy cơ mất dữ liệu ngoài ý muốn.
|
||||
3. UI phản hồi phù hợp với thời gian xử lý.
|
||||
4. Chức năng dễ tìm và dễ hiểu.
|
||||
5. Cách gọi tên và cách bố trí control nhất quán.
|
||||
6. Thay đổi flow lớn đã được đánh dấu để Cowork Team phê duyệt.
|
||||
7. Có regression test chứng minh flow vẫn hoạt động đúng.
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
description: Điều phối fix bug UI/UX — chấm tier T0/T1/T2/T3 rồi chạy đúng số agent cần thiết
|
||||
argument-hint: <phản ánh của người dùng, dán nguyên văn>
|
||||
---
|
||||
|
||||
Bạn đang chạy với vai **`fix-dispatcher`** — agent hub điều phối của bộ agent trong `agent/`.
|
||||
|
||||
Nạp theo đúng thứ tự rồi làm theo:
|
||||
|
||||
1. @agent/system/guardrail.md
|
||||
2. @agent/system/security.md
|
||||
3. @agent/system/response_policy.md
|
||||
4. @agent/roles/0_fix_dispatcher.md
|
||||
5. @agent/output/dispatch_plan.md
|
||||
|
||||
Phản ánh cần xử lý:
|
||||
|
||||
$ARGUMENTS
|
||||
|
||||
Trình tự bắt buộc:
|
||||
|
||||
- Tách defect (Bước 1) → xét override bảo mật (Bước 2) → chấm tier (Bước 3).
|
||||
- Trần chấm điểm: **≤ 5 lệnh đọc/grep, 0 subagent**. Hết mà chưa chấm được → T2.
|
||||
- In `dispatch_plan` (≤ 30 dòng phần người đọc) **trước** khi chạy bất kỳ agent nào.
|
||||
- Rồi chạy đúng lane ở bảng Bước 4:
|
||||
- **T0** → tự sửa, sau đó chạy đủ 4 cổng máy ở §4.1 và dán output thật.
|
||||
- **T1** → gọi `fix-implementer`, rồi tự review bằng @agent/checklist/ui_review.md.
|
||||
- **T2** → specialist → `fix-implementer` → `regression-reviewer`.
|
||||
- **T3** → `ui-bug-triage` → specialist → `fix-implementer` → `regression-reviewer`.
|
||||
- **T3-SEC** → `security-defect-fixer`, dừng chờ Cowork Team trả 4 câu chính sách.
|
||||
- Các `defect_id` độc lập gọi song song trong **một** message. Các bước trong cùng một
|
||||
`defect_id` chạy tuần tự.
|
||||
- Escalate theo Bước 5. Tier chỉ đi lên. Không tự merge (`guardrail.md` G9).
|
||||
@@ -1,252 +0,0 @@
|
||||
# Ví dụ KHÔNG ĐẠT — các kiểu "sửa" phải bị FAIL
|
||||
|
||||
> ⚠️ **Kịch bản minh hoạ.** Mỗi mục là một anti-pattern có thật hay gặp khi vá bug UI, được
|
||||
> dựng lại trên cùng defect với `good_fix.md` (`UI-20260907-03`: đổi sang tiếng Nhật trước
|
||||
> khi mở màn Monitoring thì nhãn vẫn tiếng Việt).
|
||||
|
||||
---
|
||||
|
||||
## ❌ 1. Tin thẳng chẩn đoán của người dùng
|
||||
|
||||
> Người dùng: *"chắc thiếu bản dịch"* → agent đi thêm entry vào `i18n/monitoring_overview.py`.
|
||||
|
||||
**Vì sao sai:** bản dịch đã có đủ. Bug nằm ở vòng đời widget. Sau bản vá, key bị trùng, và
|
||||
người dùng vẫn thấy tiếng Việt.
|
||||
|
||||
**Vi phạm:** `guardrail.md` G1 (không tự bịa), Triage bước 2 (tách triệu chứng khỏi chẩn đoán).
|
||||
|
||||
**Dấu hiệu nhận ra ngay:** `defect_record` phần "Người dùng suy đoán" bị dùng làm phần
|
||||
"Nguyên nhân gốc".
|
||||
|
||||
---
|
||||
|
||||
## ❌ 2. Vá riêng một màn thay vì sửa chỗ chung
|
||||
|
||||
```diff
|
||||
+ def showEvent(self, e):
|
||||
+ self._retranslate()
|
||||
+ super().showEvent(e)
|
||||
```
|
||||
_(thêm vào `ui/monitoring_tab.py`)_
|
||||
|
||||
**Vì sao sai:** Dashboard và Schedule cũng dựng lười, cũng hỏng y hệt. Bug sẽ được báo lại
|
||||
sau hai tuần với màn khác. Ngoài ra `showEvent` chạy **mỗi lần** hiện màn, không chỉ lần đầu —
|
||||
thêm một lần `_retranslate()` thừa cho mọi lần chuyển tab.
|
||||
|
||||
**Vi phạm:** Reviewer bước 2 — "sửa ở widget con thay vì chỗ phát sinh".
|
||||
|
||||
---
|
||||
|
||||
## ❌ 3. Hardcode màu để "cho nhanh"
|
||||
|
||||
```diff
|
||||
- self.badge.setObjectName("statusBadge")
|
||||
+ self.badge.setStyleSheet("background: #1f6fb2; color: #ffffff;")
|
||||
```
|
||||
|
||||
**Vì sao sai:** ba lỗi trong hai dòng — hex ngoài `theme/`; `setStyleSheet` cục bộ đè QSS
|
||||
ứng dụng; và màu này chỉ đúng ở theme dark, sang light là chữ trắng trên nền sáng.
|
||||
|
||||
**Vi phạm:** `guardrail.md` G4, `theme_tokens.md` §1, `ui_review.md` mục B.
|
||||
|
||||
**Đúng ra phải làm:** giữ `objectName`, style trong `theme/qss.py`, dùng `accent_solid` cho
|
||||
chữ trên nền đặc.
|
||||
|
||||
---
|
||||
|
||||
## ❌ 4. `setFixedWidth` để "cho khỏi tràn"
|
||||
|
||||
```diff
|
||||
- self.tab_label.setMinimumWidth(120)
|
||||
+ self.tab_label.setFixedWidth(180) # đủ cho tiếng Nhật
|
||||
```
|
||||
|
||||
**Vì sao sai:** ghim một kích thước cho **một** ngôn ngữ ở **một** mức DPI. Tiếng Việt dài
|
||||
hơn sẽ tràn; ở scale 150% sẽ tràn; ở cửa sổ hẹp sẽ chiếm chỗ vô lý.
|
||||
|
||||
**Vi phạm:** P02, `ui_review.md` mục C.
|
||||
|
||||
---
|
||||
|
||||
## ❌ 5. `QTimer.singleShot` để "đợi cho nó xong"
|
||||
|
||||
```diff
|
||||
+ QTimer.singleShot(200, self._retranslate)
|
||||
```
|
||||
|
||||
**Vì sao sai:** race condition vẫn nguyên, chỉ khó tái hiện hơn — nên lần sau nó sẽ được báo
|
||||
là "thỉnh thoảng bị". Máy chậm hơn thì 200ms không đủ. Đây là làm cho bug **khó sửa hơn**.
|
||||
|
||||
**Vi phạm:** Reviewer bước 2 — che triệu chứng.
|
||||
|
||||
---
|
||||
|
||||
## ❌ 6. Test viết cho có
|
||||
|
||||
```python
|
||||
def test_monitoring_tab_builds(qtbot, ctx):
|
||||
tab = MonitoringTab(ctx)
|
||||
assert tab is not None
|
||||
```
|
||||
|
||||
**Vì sao sai:** test này **xanh cả trước lẫn sau** bản vá. Nó không bắt được gì.
|
||||
|
||||
**Cách reviewer phát hiện:** revert code, giữ test, chạy lại — vẫn xanh → FAIL
|
||||
(Reviewer bước 4).
|
||||
|
||||
---
|
||||
|
||||
## ❌ 7. Ghi khống kết quả kiểm chứng
|
||||
|
||||
```yaml
|
||||
themes_verified: [dark, light]
|
||||
languages_verified: [vi, ja, en]
|
||||
visual_check: done
|
||||
```
|
||||
|
||||
...trong khi môi trường không chạy được GUI.
|
||||
|
||||
**Vì sao sai:** đây là lỗi nặng nhất trong cả danh sách. Reviewer và Cowork Team ra quyết
|
||||
định dựa trên các trường này. Ghi khống làm hỏng toàn bộ giá trị của pipeline.
|
||||
|
||||
**Vi phạm:** `guardrail.md` G10, `handoff_contract.md` luật 6.
|
||||
|
||||
**Đúng ra phải ghi:**
|
||||
|
||||
```yaml
|
||||
themes_verified: []
|
||||
visual_check: not-done # môi trường CI headless, không dựng được cửa sổ thật
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ❌ 8. Tiện tay dọn dẹp
|
||||
|
||||
```
|
||||
12 files changed, 486 insertions(+), 391 deletions(-)
|
||||
```
|
||||
|
||||
Trong đó: 4 dòng sửa bug, phần còn lại là đổi f-string, sắp lại import, đổi tên biến "cho dễ đọc".
|
||||
|
||||
**Vì sao sai:** reviewer không còn nhìn ra 4 dòng thật sự quan trọng. Nếu PR gây regression,
|
||||
không bisect được. Vi phạm "một PR một thay đổi logic".
|
||||
|
||||
**Vi phạm:** `guardrail.md` G8, `definition-of-done.md`.
|
||||
|
||||
---
|
||||
|
||||
## ❌ 9. Bỏ qua ràng buộc thiết kế có chủ ý
|
||||
|
||||
> Người dùng: *"menu bên trái tối quá, làm sáng lên bằng phần còn lại đi"* → agent đổi token
|
||||
> nền nav rail.
|
||||
|
||||
**Vì sao sai:** nav rail **tối hơn** vùng nội dung là silhouette VS Code có chủ ý, ghi rõ
|
||||
trong docstring `theme/__init__.py`. Đây là phản hồi thiết kế, không phải bug.
|
||||
|
||||
**Đúng ra phải làm:** `next_agent: RETURN_TO_REPORTER`, giải thích kèm dẫn chứng, và nếu thấy
|
||||
phản hồi có lý thì chuyển thành đề xuất thiết kế cho Cowork Team — họ sở hữu UI/UX
|
||||
(`docs/governance/ownership.md`).
|
||||
|
||||
---
|
||||
|
||||
## ❌ 10. Tự merge
|
||||
|
||||
Agent chạy `git push` rồi merge PR vì "gate đã xanh hết".
|
||||
|
||||
**Vì sao sai:** quyết định merge thuộc Cowork Team. Với thay đổi chạm permission/credential/
|
||||
routing, **CI xanh không đủ để merge** (`docs/governance/review-policy.md`).
|
||||
|
||||
**Vi phạm:** `guardrail.md` G9.
|
||||
|
||||
---
|
||||
|
||||
## ❌ 11. Thay bằng API "an toàn hơn" mà không kiểm miền đầu vào
|
||||
|
||||
> ⚠️ **Đây là ca CÓ THẬT**, không phải giả định. Xảy ra ở `SEC-20260907-01`, ngày
|
||||
> 2026-09-07, và **lọt qua vòng review đầu tiên**.
|
||||
|
||||
Bản vá đổi phép so mật khẩu sang phiên bản timing-safe:
|
||||
|
||||
```diff
|
||||
- if pw == self._sandbox_pw:
|
||||
+ if secrets.compare_digest(pw, self._sandbox_pw):
|
||||
```
|
||||
|
||||
Trông đúng. Timing-safe thật. Nhưng:
|
||||
|
||||
```python
|
||||
>>> secrets.compare_digest("mật khẩu", "mật khẩu")
|
||||
TypeError: comparing strings with non-ASCII characters is not supported
|
||||
```
|
||||
|
||||
**Vì sao sai:** `compare_digest` an toàn hơn `==` về timing, nhưng **miền đầu vào hẹp hơn** —
|
||||
chỉ nhận ASCII-`str` hoặc bytes. Cowork Local mặc định tiếng Việt và phục vụ khách Nhật.
|
||||
Người dùng gõ một chữ có dấu vào ô mật khẩu là exception thoát ra khỏi Qt slot.
|
||||
|
||||
**Vì sao nó lọt review:** mọi test đều dùng mật khẩu ASCII (`K7MNP2QRSTVW`). Test xanh hết.
|
||||
Chỉ khi reviewer **tự đọc diff và nghi ngờ** mới lộ ra — không checklist nào bắt được.
|
||||
|
||||
**Đúng ra phải làm:**
|
||||
|
||||
```python
|
||||
return secrets.compare_digest(entered.encode("utf-8"), stored.encode("utf-8"))
|
||||
```
|
||||
|
||||
**Bài học đã đưa vào thư viện:** `knowledge/secrets_and_config.md` §9.3 và
|
||||
`roles/6_regression_reviewer.md` Bước 2.1 — bốn câu bắt buộc hỏi trước mọi lần thay một
|
||||
phép toán bằng "phiên bản chuẩn hơn".
|
||||
|
||||
---
|
||||
|
||||
## ❌ 12. Test rỗng ruột — xanh vì chẳng kiểm gì
|
||||
|
||||
Cũng từ `SEC-20260907-01`. Test quét toàn repo tìm credential hardcode:
|
||||
|
||||
```python
|
||||
_SCANNED_DIRS = ("ui", "presentation", "core")
|
||||
|
||||
def test_khong_con_fallback_credential_trong_ma_nguon():
|
||||
offenders = [...]
|
||||
assert not offenders
|
||||
```
|
||||
|
||||
**Ba lỗi trong một bài test:**
|
||||
|
||||
1. **Quét thiếu.** Sai sót gốc của commit `3827552` là sửa `config.py` mà quên `ui/` — lỗi
|
||||
đi xuyên thư mục. Vậy mà phép quét lại bỏ `config.py`, `infrastructure/`, `application/`.
|
||||
2. **Xanh khi quét rỗng.** Đổi tên thư mục là duyệt được 0 file, `offenders` rỗng, test xanh
|
||||
mãi mãi. Cần lưới an toàn: `assert seen > 200`.
|
||||
3. **Regex quá rộng.** Bản đầu bắt cả `it.get("key", "?")` của Jira — mã issue, không phải
|
||||
credential. False positive làm người ta bỏ qua test.
|
||||
|
||||
Kiểu thứ hai còn có biến thể **nuốt side-effect**:
|
||||
|
||||
```python
|
||||
monkeypatch.setattr(QMessageBox, "warning", lambda *a, **k: None) # ❌ nuốt
|
||||
```
|
||||
|
||||
Nuốt đi thì hai nhánh "chưa cấu hình mật khẩu" và "sai mật khẩu" gộp về một vẫn xanh. Phải
|
||||
**ghi lại** lời gọi rồi assert nội dung.
|
||||
|
||||
**Bài học đã đưa vào thư viện:** `roles/6_regression_reviewer.md` Bước 4.1.
|
||||
|
||||
---
|
||||
|
||||
## Bảng tra nhanh cho Reviewer
|
||||
|
||||
| Thấy cái này trong diff | Phản ứng |
|
||||
|---|---|
|
||||
| Hex màu ngoài `theme/` | FAIL |
|
||||
| `setStyleSheet` cục bộ mới | FAIL |
|
||||
| `setFixedWidth` / `setFixedSize` mới | FAIL trừ khi có lý do được nêu rõ |
|
||||
| `QTimer.singleShot` để đợi | FAIL |
|
||||
| `try/except` bao quanh chỗ crash | FAIL |
|
||||
| Test xanh cả trước lẫn sau | FAIL |
|
||||
| `visual_check: done` mà không có bằng chứng | FAIL |
|
||||
| Diff > phạm vi plan | FAIL, tách PR |
|
||||
| Sửa ở widget con thay vì chỗ chung | FAIL |
|
||||
| `compare_digest` trên `str` không `.encode()` | FAIL — vỡ với mật khẩu có dấu |
|
||||
| Thay bằng API "an toàn hơn" mà không kiểm miền đầu vào | FAIL cho tới khi trả lời 4 câu ở Bước 2.1 |
|
||||
| Test quét thư mục mà không có lưới `assert seen > N` | FAIL — xanh giả khi quét rỗng |
|
||||
| Fixture nuốt side-effect thay vì ghi lại | FAIL — không phân biệt được hai nhánh |
|
||||
| File `.py` mới chưa `git add` | Không phải lỗi bản vá — bảo tác giả stage lại |
|
||||
@@ -1,146 +0,0 @@
|
||||
# Ví dụ ĐẠT — một vòng xử lý bug UI hoàn chỉnh
|
||||
|
||||
> ⚠️ **Kịch bản minh hoạ để dạy format.** Số dòng và defect_id là giả định, không trỏ tới
|
||||
> một lỗi có thật trong repo. Cái cần học ở đây là *hình dạng* của một vòng xử lý đúng.
|
||||
|
||||
---
|
||||
|
||||
## Phản ánh gốc từ người dùng
|
||||
|
||||
> "Chị Hoa bên BRSE bảo là bật app lên chọn tiếng Nhật thì màn Giám sát vẫn hiện tiếng Việt.
|
||||
> Mà lạ là màn Workspace thì đổi bình thường. Chắc thiếu dịch."
|
||||
|
||||
## ✅ Bước 1 — Triage (rút gọn)
|
||||
|
||||
```yaml
|
||||
defect_id: UI-20260907-03
|
||||
next_agent: i18n-a11y-fixer
|
||||
category: i18n-a11y
|
||||
severity: S2
|
||||
confidence: high
|
||||
reproducible: yes
|
||||
themes_verified: [dark, light]
|
||||
languages_verified: [vi, ja, en]
|
||||
```
|
||||
|
||||
**Quan sát vs kỳ vọng**
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Người dùng thấy | Đổi ngôn ngữ sang `ja` ở top bar; Workspace đổi ngay; Monitoring vẫn `vi` |
|
||||
| Người dùng mong | Mọi màn đổi cùng lúc |
|
||||
| Suy đoán (chưa xác minh) | "thiếu bản dịch" |
|
||||
|
||||
**Điểm mấu chốt Triage tìm ra:** suy đoán của người dùng **sai**. Bản dịch có đủ.
|
||||
Triage thử thêm một biến thể mà người dùng không nghĩ tới:
|
||||
|
||||
| Thứ tự thao tác | Kết quả |
|
||||
|---|---|
|
||||
| Mở Monitoring **trước**, rồi đổi sang `ja` | ✅ đổi đúng |
|
||||
| Đổi sang `ja` **trước**, rồi mới mở Monitoring | ❌ vẫn `vi` |
|
||||
|
||||
→ Không phải thiếu key. Là bẫy **P07** (widget dựng lười bỏ lỡ sự kiện đã phát).
|
||||
|
||||
**Khoanh vùng:** `presentation/shell/page_registry.py::_ensure_page` — Monitoring dựng lười,
|
||||
Workspace dựng ngay. Đúng khớp với việc chỉ Monitoring bị.
|
||||
|
||||
> Đây là giá trị thật của bước Triage: nếu tin theo chẩn đoán của người dùng, cả pipeline sẽ
|
||||
> đi thêm bản dịch — sửa xong bug vẫn còn.
|
||||
|
||||
## ✅ Bước 4 — i18n-a11y-fixer (rút gọn)
|
||||
|
||||
**Nguyên nhân gốc:** `_ensure_page` dựng widget rồi `insertWidget` luôn, không áp lại
|
||||
ngôn ngữ hiện tại. Widget đăng ký `on_language_changed` trong `__init__`, nhưng callback chạy
|
||||
lần đầu với ngôn ngữ *lúc đăng ký* — mà lúc đó nó chưa được dựng, nên nó không thể "bỏ lỡ"
|
||||
gì cả... trừ khi listener của nó được đăng ký **sau** lần phát cuối cùng.
|
||||
|
||||
**Đã loại các giả thuyết:**
|
||||
|
||||
| Giả thuyết | Cách loại |
|
||||
|---|---|
|
||||
| Thiếu key `ja` | `grep -c '"ja"' i18n/monitoring_overview.py` → đủ |
|
||||
| `MonitoringTab` quên đăng ký listener | Có đăng ký, `ui/monitoring_tab.py:__init__` |
|
||||
| Do theme, không phải ngôn ngữ | Tái hiện được ở cả dark và light |
|
||||
|
||||
**Mức can thiệp đã chọn:** thấp nhất — sửa **một chỗ** ở `_ensure_page`, không đụng
|
||||
`MonitoringTab`. Sửa ở `_ensure_page` khắc phục luôn cho **cả ba** màn dựng lười
|
||||
(Dashboard, Schedule, Monitoring), thay vì vá riêng từng màn.
|
||||
|
||||
**Đã cân nhắc và loại:** thêm `_retranslate()` vào `MonitoringTab.showEvent` — vá được
|
||||
Monitoring nhưng Dashboard và Schedule vẫn hỏng. Đó là sửa triệu chứng.
|
||||
|
||||
**Blast radius:** cả 3 màn dựng lười. Đã `grep` `_ensure_page` — chỉ được gọi từ `_goto`.
|
||||
|
||||
**LOC:** `page_registry.py` 111/400 — an toàn.
|
||||
|
||||
**Cách kiểm chứng:**
|
||||
|
||||
```python
|
||||
# tests/ui/test_lazy_page_i18n.py
|
||||
def test_lazy_page_uses_current_language_when_built_late(qtbot, ctx):
|
||||
"""Regression: đổi ngôn ngữ trước khi mở màn dựng lười thì nhãn vẫn ngôn ngữ cũ (UI-20260907-03)."""
|
||||
```
|
||||
|
||||
## ✅ Bước 5 — Implementer (rút gọn)
|
||||
|
||||
**Test viết trước, xác nhận đỏ:**
|
||||
|
||||
```
|
||||
tests/ui/test_lazy_page_i18n.py::test_lazy_page_uses_current_language_when_built_late FAILED
|
||||
AssertionError: assert 'Tổng quan' == '概要'
|
||||
```
|
||||
|
||||
**Diff — 4 dòng:**
|
||||
|
||||
```diff
|
||||
--- a/presentation/shell/page_registry.py
|
||||
+++ b/presentation/shell/page_registry.py
|
||||
@@
|
||||
real = builder()
|
||||
+ # A lazily-built page misses every language/theme signal emitted before
|
||||
+ # its first visit, so re-apply the current state right after building.
|
||||
+ apply_current_language(real)
|
||||
placeholder = self._page_widgets[row]
|
||||
```
|
||||
|
||||
**Gate — output thật:**
|
||||
|
||||
```
|
||||
>> Running Gate: [C] Clean Architecture ... [PASS] 0.8s
|
||||
>> Running Gate: [A] Secrets Audit ... [PASS] 1.9s
|
||||
>> Running Gate: [S] LOC <= 400 ... [PASS] 0.6s
|
||||
>> Running Gate: [O] Orphan Modules ... [PASS] 0.7s
|
||||
>> Running Gate: [A/N] pytest ... [PASS] 74.2s
|
||||
```
|
||||
|
||||
**Kiểm bằng mắt:** đã chạy `run.bat`; thử `vi→ja→en` với cả ba màn dựng lười, dark và light.
|
||||
|
||||
## ✅ Bước 6 — Reviewer (rút gọn)
|
||||
|
||||
**Kiểm test có thật sự bắt bug** — bước hay bị bỏ nhất:
|
||||
|
||||
```bash
|
||||
git stash push -- presentation/shell/page_registry.py
|
||||
QT_QPA_PLATFORM=offscreen pytest tests/ui/test_lazy_page_i18n.py -q # 1 failed ✅
|
||||
git stash pop
|
||||
QT_QPA_PLATFORM=offscreen pytest tests/ui/test_lazy_page_i18n.py -q # 1 passed ✅
|
||||
```
|
||||
|
||||
**Verdict: PASS**
|
||||
|
||||
**Ghi chú không chặn merge:** cùng cơ chế này cũng nên áp lại *theme* cho màn dựng lười —
|
||||
diff hiện tại chỉ xử lý ngôn ngữ. Đã mở issue riêng thay vì nhét vào PR này.
|
||||
|
||||
---
|
||||
|
||||
## Vì sao vòng này ĐẠT
|
||||
|
||||
| Tiêu chí | Bằng chứng |
|
||||
|---|---|
|
||||
| Triage bác bỏ chẩn đoán sai của người dùng | Thử thêm biến thể thứ tự thao tác |
|
||||
| Đúng một nguyên nhân gốc, có `file:line` | `_ensure_page` |
|
||||
| Sửa nguyên nhân, không sửa triệu chứng | Sửa ở chỗ chung, không vá riêng Monitoring |
|
||||
| Mức can thiệp thấp nhất | 4 dòng, khắc phục cho cả 3 màn |
|
||||
| Có test, và test được chứng minh là bắt được bug | Revert-and-rerun |
|
||||
| Gate output thật, không tóm tắt | Dán nguyên |
|
||||
| Phát hiện out-of-scope được tách ra | Issue riêng cho theme |
|
||||
@@ -1,398 +0,0 @@
|
||||
# i18n — Quy tắc xử lý chuỗi hiển thị
|
||||
|
||||
**Nguồn:** docstring `i18n/__init__.py`
|
||||
|
||||
---
|
||||
|
||||
## 1. Ngôn ngữ được hỗ trợ
|
||||
|
||||
Cowork Local hỗ trợ 3 ngôn ngữ:
|
||||
|
||||
```python
|
||||
LANGUAGES = {
|
||||
"en": "English",
|
||||
"ja": "日本語",
|
||||
"vi": "Tiếng Việt",
|
||||
}
|
||||
|
||||
LANGUAGE_SHORT = {
|
||||
"en": "EN",
|
||||
"ja": "JP",
|
||||
"vi": "VN",
|
||||
}
|
||||
|
||||
DEFAULT_LANGUAGE = "vi"
|
||||
```
|
||||
|
||||
Ngôn ngữ mặc định là **Tiếng Việt (`vi`)**.
|
||||
|
||||
### Hàm `tr()`
|
||||
|
||||
Sử dụng:
|
||||
|
||||
```python
|
||||
tr(key, **kwargs)
|
||||
```
|
||||
|
||||
để lấy chuỗi hiển thị theo ngôn ngữ hiện tại.
|
||||
|
||||
Thứ tự fallback:
|
||||
|
||||
```text
|
||||
Ngôn ngữ hiện tại → English (en) → chính key
|
||||
```
|
||||
|
||||
Ví dụ, nếu đang dùng tiếng Nhật nhưng key `workspace.tab_folder` chưa có bản dịch tiếng Nhật:
|
||||
|
||||
```text
|
||||
JA → EN → workspace.tab_folder
|
||||
```
|
||||
|
||||
Ứng dụng **không được crash** chỉ vì thiếu bản dịch.
|
||||
|
||||
Nếu UI hiển thị một chuỗi dạng:
|
||||
|
||||
```text
|
||||
workspace.tab_folder
|
||||
```
|
||||
|
||||
thì đây là dấu hiệu cho thấy **đang thiếu translation key**.
|
||||
|
||||
### Placeholder
|
||||
|
||||
Nếu chuỗi có placeholder, truyền giá trị thông qua `kwargs`:
|
||||
|
||||
```python
|
||||
tr("composer.attachments", n=3)
|
||||
```
|
||||
|
||||
Việc `.format(**kwargs)` được thực hiện sau khi lấy chuỗi dịch.
|
||||
|
||||
---
|
||||
|
||||
## 2. Widget nào phải cập nhật khi đổi ngôn ngữ?
|
||||
|
||||
Có 2 loại widget:
|
||||
|
||||
| Loại widget | Cách xử lý |
|
||||
| ------------------- | ----------------------------------------------------- |
|
||||
| **Widget sống lâu** | `bind_*` cho chuỗi tĩnh; `on_language_changed(cb)` cho phần còn lại |
|
||||
| **Widget tạm thời** | Không cần đăng ký callback; gọi `tr()` khi tạo widget |
|
||||
|
||||
### 2.0. `bind_*` — cách mặc định cho chuỗi tĩnh
|
||||
|
||||
`w.setToolTip(tr("k"))` chỉ đúng ở đúng thời điểm chạy dòng đó. `bind_*` gộp "gán ngay"
|
||||
và "gán lại sau mỗi lần đổi ngôn ngữ" vào một lời gọi, dùng `weakref` nên không giữ widget
|
||||
sống thêm và tự dọn khi widget bị xoá:
|
||||
|
||||
```python
|
||||
from ...i18n import bind_dynamic, bind_items, bind_placeholder, bind_text, bind_tip
|
||||
|
||||
self.save_btn = bind_text(QPushButton(), "co4e.save") # thay QPushButton(tr(...))
|
||||
bind_tip(self.save_btn, "co4e.tt_save") # thay .setToolTip(tr(...))
|
||||
bind_placeholder(self.chat_input, "co4e.chat_placeholder")
|
||||
bind_items(self.perm_combo, [f"co4e.perm.{p}" for p in PERMISSION_PRESETS])
|
||||
form.addRow(bind_text(QLabel(), "co4e.f_label"), self.label_edit) # KHÔNG addRow(tr(...))
|
||||
```
|
||||
|
||||
Ba luật:
|
||||
|
||||
1. **Chuỗi tĩnh → `bind_*`.** Đổi tại chỗ, **không thêm dòng** — quan trọng với file đã
|
||||
sát trần Gate S hoặc đang bị bánh cóc `LEGACY_ALLOWANCE` chốt (`quality_gates.md` §4).
|
||||
2. **Chữ phụ thuộc trạng thái → `bind_dynamic(w, setter, fn)`**, với `fn` đọc trạng thái:
|
||||
nút Chạy ⇄ Dừng, tooltip Thu gọn ⇄ Mở rộng, nhãn có số đếm. Các nhánh xử lý trạng thái
|
||||
**vẫn** gọi setter trực tiếp như cũ để phản hồi ngay khi bấm; `bind_dynamic` chỉ lo lúc
|
||||
đổi ngôn ngữ. Bind cứng một nhãn động sẽ **xoá** trạng thái khi người dùng đổi ngôn ngữ
|
||||
giữa lúc đang chạy.
|
||||
3. **Chữ là DỮ LIỆU thì không bind.** Tên agent, tên project, tên nhà cung cấp trong
|
||||
`config.PROVIDER_LABELS` — dịch danh tính là sai.
|
||||
|
||||
`QFormLayout.addRow(tr(...), w)` và `_add_section(outer, tr(...))` là hai bẫy hay gặp:
|
||||
chúng tự dựng `QLabel` bên trong, không giữ tham chiếu nào để áp lại. Truyền
|
||||
`bind_text(QLabel(), key)` hoặc truyền **khoá** thay vì chuỗi đã dịch.
|
||||
|
||||
### 2.0b. Nút do CHÍNH Qt vẽ chữ — `ui/dialog_buttons.py`
|
||||
|
||||
`tr()` không với tới được nhãn nút của mấy widget dựng sẵn: Qt lấy chữ từ bảng dịch của
|
||||
riêng nó, mà ứng dụng không cài `QTranslator` nào (bản PySide6 đang dùng cũng không đóng
|
||||
gói file `qtbase_*.qm` nào để cài). Kết quả: **luôn là tiếng Anh ở cả ba ngôn ngữ.**
|
||||
|
||||
| Không dùng | Dùng thay |
|
||||
| --- | --- |
|
||||
| `QDialogButtonBox(Save \| Cancel)` | `dialog_buttons(Save \| Cancel)` |
|
||||
| `QMessageBox.question(...) == QMessageBox.Yes` | `confirm(parent, title, body)` |
|
||||
| `QInputDialog.getText / getMultiLineText / getItem` | `ask_text` / `ask_multiline` / `ask_item` |
|
||||
|
||||
Muốn một nút mang chữ riêng thì truyền khoá vào `dialog_buttons`, **không** `setText(tr(...))`
|
||||
sau khi dựng — lần đổi ngôn ngữ kế tiếp, ràng buộc sẽ áp lại khoá mặc định và xoá mất chữ đó:
|
||||
|
||||
```python
|
||||
self.buttons = dialog_buttons(QDialogButtonBox.Ok | QDialogButtonBox.Cancel,
|
||||
ok="schedtask.ai_confirm")
|
||||
```
|
||||
|
||||
Ba cổng trong `tests/ui/test_i18n_khong_hardcode_chu.py` canh việc này.
|
||||
|
||||
### 2.1. Widget sống lâu
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* Chrome của cửa sổ chính.
|
||||
* Tab.
|
||||
* Sidebar.
|
||||
* Composer.
|
||||
|
||||
Các widget này vẫn tồn tại khi người dùng đổi ngôn ngữ.
|
||||
|
||||
Vì vậy phải:
|
||||
|
||||
1. Đăng ký `on_language_changed(cb)`.
|
||||
2. Trong callback, gọi lại `tr()` cho các text của chính widget.
|
||||
3. Callback phải chạy:
|
||||
|
||||
* Một lần ngay khi đăng ký.
|
||||
* Mỗi lần người dùng đổi ngôn ngữ.
|
||||
|
||||
Tên callback được sử dụng trong repo:
|
||||
|
||||
```text
|
||||
_retranslate()
|
||||
_apply_i18n()
|
||||
```
|
||||
|
||||
Có thể tham khảo implementation chuẩn từ:
|
||||
|
||||
```text
|
||||
ui/workspace_tab.py:484
|
||||
```
|
||||
|
||||
### 2.2. Widget tạm thời
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* Settings dialog.
|
||||
* Skills dialog.
|
||||
* Flow dialog.
|
||||
* Permission dialog.
|
||||
|
||||
Các dialog này được tạo lại từ đầu mỗi lần mở.
|
||||
|
||||
Vì vậy chỉ cần gọi `tr()` khi construct widget.
|
||||
|
||||
**Không cần đăng ký `on_language_changed()`**.
|
||||
|
||||
### Bug thường gặp
|
||||
|
||||
Triệu chứng:
|
||||
|
||||
> Đổi ngôn ngữ nhưng một label/nút vẫn giữ ngôn ngữ cũ.
|
||||
|
||||
Nguyên nhân thường là:
|
||||
|
||||
* Widget sống lâu nhưng chưa đăng ký `on_language_changed()`.
|
||||
* Callback có đăng ký nhưng quên cập nhật label đó.
|
||||
|
||||
**Cách sửa đúng:**
|
||||
|
||||
`bind_*` tại chính dòng đang gán (mục 2.0), hoặc — nếu chữ phụ thuộc trạng thái/dữ liệu —
|
||||
sửa trong `_retranslate()` / `_apply_i18n()` của chính widget.
|
||||
|
||||
**Không** giải quyết bằng cách gọi `tr()` ở một nơi khác chỉ để ép label thay đổi.
|
||||
|
||||
### Cách TÌM ra hết các chỗ bị lỗi
|
||||
|
||||
Đừng grep chuỗi tiếng Việt trong source: lượt audit tháng 9/2026 grep ra 962 dòng mà
|
||||
**không dòng nào** là lỗi thật (toàn docstring), trong khi 84 lỗi thật lại không xuất hiện
|
||||
— vì chúng đi qua `tr()` đúng cách, chỉ thiếu người áp lại.
|
||||
|
||||
Phép đo đúng nằm ở `tests/ui/test_i18n_khong_con_chu_cu.py`: dựng `MainWindow` thật, thay
|
||||
`tr()` bằng chuỗi **mốc**, gọi `set_language()`, rồi tìm chỗ **không** mang mốc. Hai chi
|
||||
tiết mà bản kiểm ngây thơ sẽ sai:
|
||||
|
||||
* `from ...i18n import tr` copy tham chiếu vào namespace từng module → phải thay `tr` ở
|
||||
**mọi** module đã import, không chỉ `i18n.tr`;
|
||||
* lưới vẽ lại bằng `deleteLater()` để lại widget cũ còn sống → không
|
||||
`sendPostedEvents(DeferredDelete)` thì báo oan hàng chục widget bóng ma (lượt audit đầu
|
||||
báo 84 lỗi, trong đó 65 là bóng ma và widget bị `id()` cấp lại làm cắt vòng quét).
|
||||
|
||||
Chạy: `QT_QPA_PLATFORM=offscreen pytest tests/ui/test_i18n_khong_con_chu_cu.py -q`
|
||||
|
||||
---
|
||||
|
||||
## 3. Tổ chức file translation
|
||||
|
||||
Thư mục `i18n/` được chia theo **màn hình/chức năng**, không gom tất cả translation vào một file lớn.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
i18n/
|
||||
├── login_dialog.py
|
||||
├── sidebar.py
|
||||
├── composer.py
|
||||
├── cowork_tab.py
|
||||
├── settings_dialog.py
|
||||
├── skills_dialog.py
|
||||
├── libreoffice_view.py
|
||||
├── agents_admin_tab.py
|
||||
├── monitoring_overview.py
|
||||
└── hint.py
|
||||
```
|
||||
|
||||
Mỗi file export một dictionary có dạng:
|
||||
|
||||
```text
|
||||
key → {
|
||||
"en": "...",
|
||||
"ja": "...",
|
||||
"vi": "..."
|
||||
}
|
||||
```
|
||||
|
||||
`i18n/__init__.py` sẽ import và gộp các dictionary này.
|
||||
|
||||
### Khi thêm key mới
|
||||
|
||||
Thực hiện theo 3 bước:
|
||||
|
||||
#### Bước 1 — Chọn đúng file
|
||||
|
||||
Đưa key vào file tương ứng với màn hình/chức năng.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
workspace.* → file liên quan đến workspace
|
||||
composer.* → composer.py
|
||||
settings.* → settings_dialog.py
|
||||
```
|
||||
|
||||
**Không** đưa key vào `login_dialog.py` chỉ vì file đó đang có nhiều key nhất.
|
||||
|
||||
#### Bước 2 — Điền đủ 3 ngôn ngữ
|
||||
|
||||
Mỗi key mới phải có:
|
||||
|
||||
```text
|
||||
en
|
||||
ja
|
||||
vi
|
||||
```
|
||||
|
||||
Thiếu `ja` là lỗi đặc biệt cần chú ý vì có thể chỉ được phát hiện khi khách hàng Nhật sử dụng.
|
||||
|
||||
#### Bước 3 — Đặt tên key nhất quán
|
||||
|
||||
Format khuyến nghị:
|
||||
|
||||
```text
|
||||
<màn hình>.<thành phần>
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
workspace.tab_folder
|
||||
app.nav.recents
|
||||
```
|
||||
|
||||
Tên key phải mô tả rõ nó được dùng ở đâu và cho thành phần nào.
|
||||
|
||||
---
|
||||
|
||||
## 4. Các rủi ro thường gặp với tiếng Nhật và tiếng Việt
|
||||
|
||||
| Vấn đề | Triệu chứng | Cách xử lý |
|
||||
| ---------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| Độ dài chuỗi khác nhau | EN vừa nút nhưng VI bị tràn hoặc JA bị `...` | Không đặt width cố định dựa trên tiếng Anh. Dùng `sizeHint()`, `minimumWidth` hoặc cho phép wrap |
|
||||
| Dấu tiếng Việt bị cắt | Các chữ như `Ắ`, `ộ` bị mất dấu | Không dùng `setFixedHeight()` cho label. Để layout tự tính chiều cao |
|
||||
| Thiếu font/glyph tiếng Nhật | Xuất hiện `□□□` | Kiểm tra `_FONT` trong `theme/palettes.py` và khai báo font fallback |
|
||||
| Sắp xếp chuỗi | Project có dấu được sắp xếp không đúng | Dùng locale-aware sorting, không dùng `sorted()` một cách máy móc |
|
||||
| Số ký tự không phản ánh chiều rộng | Text bị elide sai, đặc biệt với tiếng Nhật | Dùng `QFontMetrics.horizontalAdvance()`, không dùng `len()` để đo chiều rộng |
|
||||
|
||||
### Đặc biệt lưu ý về độ dài text
|
||||
|
||||
Không được giả định:
|
||||
|
||||
```text
|
||||
số ký tự = chiều rộng hiển thị
|
||||
```
|
||||
|
||||
Ví dụ hai chuỗi có cùng số ký tự nhưng có thể có chiều rộng hiển thị khác nhau.
|
||||
|
||||
Khi cần đo text trên UI, dùng:
|
||||
|
||||
```python
|
||||
QFontMetrics.horizontalAdvance(...)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Checklist khi sửa lỗi i18n
|
||||
|
||||
Trước khi hoàn thành bản vá i18n, phải kiểm tra:
|
||||
|
||||
* [ ] Key mới có đủ **`en` / `ja` / `vi`**?
|
||||
|
||||
* [ ] Đã chuyển qua cả 3 ngôn ngữ **ngay trong lúc app đang chạy** chưa?
|
||||
|
||||
```
|
||||
Không chỉ restart app rồi kiểm tra.
|
||||
```
|
||||
|
||||
* [ ] `ja` có **khác** `en` không? Bằng nhau nghĩa là chưa dịch — trừ tên thương hiệu /
|
||||
ký hiệu, và khi đó phải khai vào `KHOA_KHONG_CAN_DICH` kèm lý do.
|
||||
|
||||
* [ ] Chuỗi tĩnh đã dùng `bind_text` / `bind_tip` / `bind_placeholder` / `bind_items`
|
||||
thay cho `setX(tr(...))` một lần?
|
||||
|
||||
* [ ] Chữ phụ thuộc trạng thái đã dùng `bind_dynamic` (không bind cứng, kẻo mất trạng thái)?
|
||||
|
||||
* [ ] Nếu widget sống lâu và còn phần không bind được, đã đăng ký:
|
||||
|
||||
```
|
||||
`on_language_changed(...)`
|
||||
```
|
||||
|
||||
* [ ] Callback `_retranslate()` hoặc `_apply_i18n()` đã cập nhật **tất cả text liên quan**?
|
||||
|
||||
* [ ] Đã chạy `pytest tests/ui/test_i18n_khong_con_chu_cu.py -q` và nó **xanh**?
|
||||
|
||||
* [ ] Không còn chuỗi hardcode mới trong bản vá?
|
||||
|
||||
* [ ] Nút hộp thoại đi qua `ui/dialog_buttons.py` (mục 2.0b), không dựng
|
||||
`QDialogButtonBox` / `QMessageBox.question` / `QInputDialog.get*` trực tiếp?
|
||||
|
||||
* [ ] Layout vẫn đúng với **chuỗi dài nhất** trong 3 ngôn ngữ?
|
||||
|
||||
* [ ] Không dùng `len()` để tính chiều rộng text?
|
||||
|
||||
* [ ] Nếu có thay đổi UI, đã kiểm tra cả Dark Mode và Light Mode?
|
||||
|
||||
---
|
||||
|
||||
## 6. Nguyên tắc quan trọng
|
||||
|
||||
Khi sửa lỗi i18n, **không sửa triệu chứng ở nơi khác**.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Đổi ngôn ngữ
|
||||
↓
|
||||
Label X không thay đổi
|
||||
↓
|
||||
Kiểm tra widget X
|
||||
↓
|
||||
Widget sống lâu?
|
||||
↓
|
||||
Có on_language_changed()?
|
||||
↓
|
||||
_retranslate() có cập nhật Label X?
|
||||
```
|
||||
|
||||
Nếu thiếu callback hoặc callback bỏ sót label, hãy sửa **đúng callback của widget đó**.
|
||||
|
||||
Không thêm các lệnh `tr()` rải rác ở nơi khác chỉ để làm cho UI thay đổi.
|
||||
|
||||
Mục tiêu là đảm bảo cơ chế i18n hoạt động đúng và nhất quán cho toàn bộ ứng dụng.
|
||||
@@ -1,101 +0,0 @@
|
||||
# Project Map — Cowork Local (dành cho agent sửa bug UI/UX)
|
||||
|
||||
Nguồn sự thật: `README.md`, `docs/architecture/ADR-001-layered-architecture.md`,
|
||||
`docs/governance/contributor-recipes.md`. File này chỉ tóm tắt phần **một người sửa bug
|
||||
UI cần biết**.
|
||||
|
||||
---
|
||||
|
||||
## 1. Bốn tầng
|
||||
|
||||
```text
|
||||
presentation/ PySide6 UI — Shell, NavRail, Chat, Scheduling, Settings, Dashboard
|
||||
↓
|
||||
application/ Orchestration thuần Python — Conversations, Scheduling, Workspaces, Monitoring, Routing
|
||||
↓
|
||||
domain/ Entity, ExecutionRequest bất biến, AgentEvent, Descriptor (thuần Python)
|
||||
↑
|
||||
infrastructure/ Adapter — LLM provider, persistence atomic JSON, Keyring SecretStore, MCP
|
||||
```
|
||||
|
||||
- `domain/` và `application/` **không được** import PySide6/PyQt/`ui`/`app`
|
||||
(`scripts/check_imports.py::FORBIDDEN_MODULE_PREFIXES`).
|
||||
- Widget chỉ gọi xuống service của `application/`, không chạm SQLite/JSON/LLM trực tiếp.
|
||||
- Mọi module production `<= 400 LOC`.
|
||||
|
||||
## 2. ⚠️ Hai thư mục UI cùng tồn tại — điểm dễ sửa nhầm file nhất
|
||||
|
||||
| Thư mục | Vai trò hiện tại | Sửa bug ở đây khi |
|
||||
|---|---|---|
|
||||
| `presentation/` | Kết quả refactor R08 — các màn đã tách module | Bug thuộc Chat, Co4E, Dashboard, Folder, Graph, Scheduling, Settings, Shell |
|
||||
| `ui/` | **Vẫn đang chạy**, không phải code chết | Bug thuộc Monitoring, Workspace, các dialog, icon, widget dùng chung |
|
||||
|
||||
`presentation/` vẫn import ngược sang `ui/` cho phần dùng chung, ví dụ:
|
||||
|
||||
```text
|
||||
presentation/shell/page_registry.py:14 from ...ui.monitoring_tab import MonitoringTab
|
||||
presentation/shell/main_window.py:38 from ...ui.workspace_tab import WorkspaceTab
|
||||
presentation/dashboard/dashboard_tab.py:24 from cowork_local.ui.icons import icon
|
||||
```
|
||||
|
||||
**Luật:** trước khi sửa, `grep` tên class/hàm trên **cả hai** thư mục. Sửa bản không được
|
||||
import vào runtime là lỗi "đã fix nhưng user vẫn thấy lỗi" phổ biến nhất của repo này.
|
||||
|
||||
```bash
|
||||
grep -rn "class DashboardTab" ui/ presentation/
|
||||
```
|
||||
|
||||
## 3. Điểm vào & trạng thái
|
||||
|
||||
| File | Vai trò |
|
||||
|---|---|
|
||||
| `app.py`, `__main__.py` | Bootstrap `QApplication`, dựng `MainWindow` |
|
||||
| `presentation/shell/main_window.py` | Cửa sổ chính, `_nav_defs`, top bar, toast, help agent |
|
||||
| `presentation/shell/page_registry.py` | Chuyển trang; Dashboard/Schedule/Monitoring **dựng lười** |
|
||||
| `presentation/shell/nav_rail.py` | Nav rail trái, thu gọn/mở rộng, cây project & recents |
|
||||
| `presentation/shell/top_bar.py` | Thanh trên: theme switch, language switch |
|
||||
| `presentation/shell/toast.py` | Popup "task xong" góc trên trái |
|
||||
| `state.py` | `AppContext` — cầu nối UI ↔ service |
|
||||
| `config.py` | Đọc/ghi cấu hình người dùng (theme, ngôn ngữ, provider...) |
|
||||
| `paths.py` | Vị trí dữ liệu runtime (`%USERPROFILE%\.cowork_local`) |
|
||||
| `theme/` | Toàn bộ màu sắc & stylesheet (xem `theme_tokens.md`) |
|
||||
| `i18n/` | Toàn bộ chuỗi hiển thị (xem `i18n_rules.md`) |
|
||||
|
||||
### Hệ quả của "dựng lười" khi debug
|
||||
|
||||
Dashboard, Schedule và Monitoring **chưa tồn tại** cho tới lần đầu người dùng bấm vào.
|
||||
Nghĩa là:
|
||||
|
||||
- Bug "lần đầu mở màn X bị nhấp nháy / sai theme / sai ngôn ngữ" gần như luôn nằm ở
|
||||
`_ensure_page` / `_goto` chứ không nằm trong widget của màn đó.
|
||||
- Widget dựng lười **bỏ lỡ** các sự kiện đã phát trước đó (đổi theme, đổi ngôn ngữ).
|
||||
Xem `qt_pitfalls.md` P07.
|
||||
|
||||
## 4. Bảng đối chiếu tính năng → file
|
||||
|
||||
| Khu vực | File chính |
|
||||
|---|---|
|
||||
| Chat / composer / bubble | `presentation/chat/` (`chat_panel.py`, `composer_widget.py`, `chat_bubble_style.py`) |
|
||||
| Co4E canvas & node | `presentation/co4e/` (`co4e_canvas_widget.py`, `node_property_panel.py`, `canvas_geometry.py`) |
|
||||
| Dashboard & biểu đồ | `presentation/dashboard/` + `ui/spline_chart.py`, `ui/widgets.py` |
|
||||
| Folder / preview tài liệu | `presentation/folder/` (`folder_tab.py`, `code_editor.py`, `office_document_renderer.py`) |
|
||||
| GraphRAG | `presentation/graph/` |
|
||||
| Lịch / Kanban | `presentation/scheduling/` |
|
||||
| Settings | `presentation/settings/` + `ui/settings_dialog.py` |
|
||||
| Monitoring (8 sub-view) | `ui/monitoring_tab.py` + `presentation/monitoring/` |
|
||||
| Workspace + sub-tab | `ui/workspace_tab.py`, `ui/cowork_tab.py`, `ui/co4e_tab.py` |
|
||||
| Dialog (login, permission, skill, task...) | `ui/*_dialog.py` |
|
||||
| Icon | `ui/icons.py` |
|
||||
| Widget dùng chung (StatCard, BudgetCard...) | `ui/widgets.py` |
|
||||
|
||||
## 5. Test
|
||||
|
||||
| Đường dẫn | Nội dung |
|
||||
|---|---|
|
||||
| `tests/ui/` | Test widget, có `conftest.py` riêng |
|
||||
| `tests/integration/` | Test ghép nhiều thành phần |
|
||||
| `tests/e2e/test_smoke.py` | Smoke test bản release |
|
||||
| `tests/characterization/` | Chốt hành vi hiện tại trước khi refactor |
|
||||
|
||||
Chạy headless: `QT_QPA_PLATFORM=offscreen pytest tests/ui -q`.
|
||||
64/108 module test dựng widget thật, nên môi trường phải có PySide6.
|
||||
@@ -1,141 +0,0 @@
|
||||
# Nguyên nhân gốc hay gặp của bug UI PySide6
|
||||
|
||||
Danh mục để **chẩn đoán**, không phải để đoán bừa. Mỗi mục: triệu chứng người dùng mô tả →
|
||||
nguyên nhân → cách xác minh → hướng sửa.
|
||||
|
||||
---
|
||||
|
||||
## Nhóm A — Layout & kích thước
|
||||
|
||||
### P01. Widget bị bóp/giãn sai khi resize
|
||||
**Triệu chứng:** "kéo cửa sổ to ra thì bảng bên phải nuốt hết chỗ", "panel trái biến mất".
|
||||
**Nguyên nhân:** thiếu `stretch` factor, hoặc `QSizePolicy` sai (`Preferred` vs `Expanding`).
|
||||
**Xác minh:** đọc `addWidget(w, stretch)` / `setStretchFactor` / `setSizePolicy` quanh chỗ dựng.
|
||||
**Sửa:** đặt stretch tường minh trên `QSplitter`/`QBoxLayout`. Không sửa bằng `setFixedWidth`.
|
||||
|
||||
### P02. Chữ bị cắt / hiện `...` ở một số ngôn ngữ hoặc scale
|
||||
**Triệu chứng:** "nút bị mất chữ", "tên project chỉ hiện một nửa".
|
||||
**Nguyên nhân:** `setFixedWidth`/`setFixedSize` tính theo chuỗi tiếng Anh ở 100% scale.
|
||||
**Xác minh:** `grep -n "setFixedWidth\|setFixedSize\|setMaximumWidth" <file>`; thử với `vi`/`ja`.
|
||||
**Sửa:** dùng `minimumWidth` + `sizeHint`, hoặc `QFontMetrics.horizontalAdvance` cho chuỗi
|
||||
dài nhất trong 3 ngôn ngữ. Xem `i18n_rules.md` §4.
|
||||
|
||||
### P03. Nội dung trong `QScrollArea` không cuộn được / bị nén
|
||||
**Nguyên nhân:** quên `setWidgetResizable(True)`, hoặc đặt widget con vào scroll area
|
||||
**sau** khi đã `setWidget`.
|
||||
**Sửa:** `setWidgetResizable(True)` và dựng xong nội dung rồi mới `setWidget`.
|
||||
|
||||
### P04. Khoảng trắng thừa quanh panel
|
||||
**Nguyên nhân:** `setContentsMargins`/`setSpacing` mặc định của layout lồng nhau cộng dồn.
|
||||
**Xác minh:** đếm số layout lồng; repo dùng `setContentsMargins(10,10,10,10)` +
|
||||
`setSpacing(10)` ở shell (`main_window.py:145`), layout con thường phải là `(0,0,0,0)`.
|
||||
|
||||
### P05. Bug chỉ xảy ra trên màn hình scale 125%/150%
|
||||
**Triệu chứng:** "máy em bình thường, máy sếp bị lệch".
|
||||
**Nguyên nhân:** hằng số pixel cứng, icon raster không có bản @2x, `QPixmap` không set
|
||||
`devicePixelRatio`.
|
||||
**Xác minh:** hỏi người dùng độ phân giải + mức scale Windows; test lại bằng biến môi trường
|
||||
`QT_SCALE_FACTOR=1.5`.
|
||||
**Sửa:** dùng đơn vị theo `QFontMetrics`, icon SVG hoặc `icon()` từ `ui/icons.py`.
|
||||
|
||||
---
|
||||
|
||||
## Nhóm B — Stylesheet & theme
|
||||
|
||||
### P06. `setStyleSheet` cục bộ đè mất style toàn app
|
||||
**Triệu chứng:** "một chỗ nhìn khác hẳn phần còn lại", "combo box mất mũi tên".
|
||||
**Nguyên nhân:** gọi `widget.setStyleSheet(...)` — QSS con **thay thế** chứ không merge với
|
||||
QSS ứng dụng cho subcontrol đó. Riêng `::drop-down` bị style là Qt ngừng vẽ mũi tên mặc
|
||||
định (xem `theme_tokens.md` §5).
|
||||
**Sửa:** gỡ stylesheet cục bộ, gán `objectName`, style trong `theme/qss.py`.
|
||||
|
||||
### P07. Widget dựng lười không nhận theme / ngôn ngữ mới
|
||||
**Triệu chứng:** "đổi sang giao diện sáng rồi mà màn Giám sát vẫn tối", "chỉ màn đó bị".
|
||||
**Nguyên nhân:** Dashboard / Schedule / Monitoring chỉ được dựng ở lần mở đầu tiên
|
||||
(`presentation/shell/page_registry.py::_ensure_page`). Chúng **bỏ lỡ** sự kiện đổi theme
|
||||
hoặc đổi ngôn ngữ đã phát trước đó.
|
||||
**Xác minh:** mở app → đổi theme → *rồi mới* bấm vào màn đó. Nếu lỗi tái hiện thì đúng P07.
|
||||
**Sửa:** áp lại stylesheet/`tr()` trong `_ensure_page` sau khi dựng, hoặc để widget tự đăng ký
|
||||
listener ngay trong `__init__`. Không sửa trong từng widget con.
|
||||
|
||||
### P08. Style không áp lại sau khi đổi property động
|
||||
**Triệu chứng:** "nút vẫn xám sau khi đã chọn xong".
|
||||
**Nguyên nhân:** QSS selector dạng `[state="active"]` chỉ được đánh giá lại khi ép polish.
|
||||
**Sửa:** `w.style().unpolish(w); w.style().polish(w)` sau khi `setProperty`.
|
||||
|
||||
### P09. Bug chỉ có ở một theme
|
||||
**Xác minh bắt buộc:** đối chiếu `docs/screens/<slug>-dark.png` và `<slug>-light.png`.
|
||||
**Nguyên nhân thường gặp:** dùng `accent` ở chỗ cần `accent_solid`, hoặc token bề mặt sai bậc
|
||||
(`surface` thay vì `surface_raised`).
|
||||
|
||||
---
|
||||
|
||||
## Nhóm C — Signal, slot, luồng
|
||||
|
||||
### P10. Bấm một lần chạy hai lần
|
||||
**Triệu chứng:** "gửi 1 tin mà hiện 2", "tạo trùng task".
|
||||
**Nguyên nhân:** `connect()` được gọi lại mỗi lần refresh/rebuild mà không `disconnect()`.
|
||||
**Xác minh:** `grep -n "\.connect(" <file>` và tìm xem có nằm trong hàm được gọi nhiều lần không.
|
||||
**Sửa:** connect một lần trong `__init__`, hoặc `Qt.UniqueConnection`.
|
||||
|
||||
### P11. UI đứng khi chạy tác vụ dài
|
||||
**Triệu chứng:** "app treo khi bấm Phân tích", "vòng xoay không quay".
|
||||
**Nguyên nhân:** gọi LLM / đọc file lớn / gọi MCP ngay trong GUI thread.
|
||||
**Sửa:** đẩy xuống service của `application/` chạy async/worker; GUI chỉ nhận signal.
|
||||
Đây cũng là vi phạm kiến trúc (`guardrail.md` G3), không chỉ là bug hiệu năng.
|
||||
|
||||
### P12. Widget biến mất không lý do
|
||||
**Nguyên nhân:** không có parent, bị Python GC thu hồi; hoặc bị `deleteLater` sớm.
|
||||
**Sửa:** truyền `parent` khi khởi tạo, hoặc giữ tham chiếu trên `self`.
|
||||
|
||||
### P13. Truy cập widget đã bị xoá → crash
|
||||
**Triệu chứng:** "đóng dialog xong app tắt luôn".
|
||||
**Nguyên nhân:** slot vẫn chạy sau khi C++ object đã destroy (`RuntimeError: Internal C++ object already deleted`).
|
||||
**Sửa:** `disconnect` trong `closeEvent`, hoặc dùng `QPointer`/kiểm tra `shiboken6.isValid`.
|
||||
|
||||
### P14. Dữ liệu cũ hiện lại sau khi đã cập nhật
|
||||
**Nguyên nhân:** view đọc từ cache/model không được `beginResetModel`/`endResetModel`,
|
||||
hoặc widget được `hide()` chứ không rebuild.
|
||||
|
||||
---
|
||||
|
||||
## Nhóm D — Vẽ tay & hiệu năng
|
||||
|
||||
### P15. Nhấp nháy khi chuyển màn hoặc khi cuộn
|
||||
**Nguyên nhân:** `repaint()` gọi tay trong vòng lặp, hoặc `paintEvent` đọc file/config.
|
||||
**Sửa:** dùng `update()` (gộp lần vẽ), và đọc màu qua `current_palette()` — đã được cache
|
||||
sẵn chính vì lý do này (`theme_tokens.md` §2).
|
||||
|
||||
### P16. Chart / canvas vẽ đè, để lại vệt
|
||||
**Nguyên nhân:** không xoá nền trong `paintEvent`, hoặc `QPainter` không `end()`.
|
||||
|
||||
### P17. Icon mờ hoặc sai màu ở dark/light
|
||||
**Nguyên nhân:** icon raster một màu cố định.
|
||||
**Sửa:** lấy qua `ui/icons.py::icon`, không load PNG trực tiếp.
|
||||
|
||||
---
|
||||
|
||||
## Nhóm E — Vòng đời & dữ liệu
|
||||
|
||||
### P18. Trạng thái rỗng/đang tải/lỗi không có giao diện riêng
|
||||
**Triệu chứng:** "màn hình trắng trơn, không biết đang chạy hay hỏng".
|
||||
Đây là **bug UX**, không phải bug kỹ thuật → route sang `3_ux_flow_fixer.md`.
|
||||
|
||||
### P19. Người dùng mất dữ liệu khi đóng nhầm
|
||||
**Triệu chứng:** "gõ instruction xong đóng tab, mất hết".
|
||||
**Nguyên nhân:** không có dirty-state, không chặn `closeEvent`.
|
||||
Đây là bug UX mức nghiêm trọng, ưu tiên cao hơn phần lớn bug hiển thị.
|
||||
|
||||
### P20. Dialog mở sau lưng cửa sổ chính / mở lệch màn hình
|
||||
**Nguyên nhân:** dialog không truyền `parent`, hoặc set vị trí bằng toạ độ tuyệt đối.
|
||||
**Sửa:** luôn truyền parent; căn giữa theo `parent.geometry()`, không theo `screen(0)`.
|
||||
|
||||
---
|
||||
|
||||
## Cách dùng danh mục này
|
||||
|
||||
1. Ánh xạ triệu chứng người dùng → 1-3 mục khả dĩ.
|
||||
2. Với mỗi mục, chạy đúng bước **Xác minh** — đọc code hoặc tái hiện.
|
||||
3. Loại trừ cho tới khi còn một nguyên nhân có `file:line` cụ thể.
|
||||
4. Nếu không mục nào khớp: ghi giả thuyết mới vào `fix_plan.md`, và **bổ sung mục mới vào
|
||||
file này** khi đã xác nhận. Danh mục phải lớn dần theo bug thật của sản phẩm.
|
||||
@@ -1,124 +0,0 @@
|
||||
# CASAN Quality Gate — cổng bắt buộc trước PR
|
||||
|
||||
Nguồn: `README.md`, `scripts/run_quality_gate.py`.
|
||||
|
||||
---
|
||||
|
||||
## 1. Năm cổng
|
||||
|
||||
| Cổng | Script | Kiểm tra |
|
||||
|---|---|---|
|
||||
| **C** — Clean Architecture | `scripts/check_imports.py` | `domain/` và `application/` không import `PySide6`, `PySide2`, `PyQt6`, `PyQt5`, `ui`, `app` |
|
||||
| **A** — Atomic & Secrets | `scripts/audit_security.py` | Secret/plaintext trong file `.py` và file config |
|
||||
| **S** — Single Responsibility | `scripts/check_loc.py --max-lines 400` | Mọi module production `<= 400 LOC` |
|
||||
| **O** — Orphan Module | `scripts/check_orphan_modules.py` | Module không được import từ đâu |
|
||||
| **A/N** — Tests | `pytest` | Toàn bộ suite |
|
||||
|
||||
## 2. Lệnh
|
||||
|
||||
```bash
|
||||
# Đủ 5 cổng — chạy trước khi tạo PR
|
||||
python scripts/run_quality_gate.py
|
||||
|
||||
# Chỉ guard tĩnh, bỏ test — vòng lặp sửa nhanh
|
||||
python scripts/run_quality_gate.py --skip-tests
|
||||
|
||||
# Từng cổng
|
||||
python scripts/check_imports.py
|
||||
python scripts/audit_security.py
|
||||
python scripts/check_loc.py --max-lines 400
|
||||
pytest tests/e2e/test_smoke.py -v
|
||||
```
|
||||
|
||||
## 3. Chạy test UI headless
|
||||
|
||||
```bash
|
||||
QT_QPA_PLATFORM=offscreen pytest tests/ui -q # bash
|
||||
$env:QT_QPA_PLATFORM="offscreen"; pytest tests/ui -q # PowerShell
|
||||
```
|
||||
|
||||
64/108 module test dựng widget thật và 20 module import PySide6 ở module scope, nên môi
|
||||
trường test **phải** có đủ runtime dependency. Chỉ có **một** `requirements.txt`, không có
|
||||
cặp runtime/test riêng.
|
||||
|
||||
## 4. Bẫy khi sửa bug UI
|
||||
|
||||
- **Gate S rất dễ vỡ khi vá bug.** Nhiều file UI đã sát 400 dòng. Trước khi thêm code:
|
||||
```bash
|
||||
python scripts/check_loc.py --max-lines 400 | grep <tên file>
|
||||
```
|
||||
Sắp vượt → tách module **và nêu trong `fix_plan.md` trước khi làm** (`guardrail.md` G6).
|
||||
|
||||
- **Gate O bắt module mồ côi.** Tách file mới ra mà chưa import vào đâu là Gate O đỏ.
|
||||
Tách và nối dây trong cùng một commit.
|
||||
|
||||
- **Gate C ít khi liên quan bug UI** — trừ khi bản vá "tiện tay" import widget vào
|
||||
`application/`. Đó là dấu hiệu sửa sai tầng.
|
||||
|
||||
- **File `.py` mới phải được `git add` ngay.**
|
||||
`tests/test_no_ignored_source.py::test_khong_file_py_nao_bi_bo_quen_chua_theo_doi` quét
|
||||
`git ls-files --others --exclude-standard` và làm suite đỏ nếu có file `.py` chưa theo dõi
|
||||
trong thư mục nguồn. File test mới cũng tính. Triệu chứng giống hệt regression, nhưng
|
||||
không phải:
|
||||
|
||||
```
|
||||
AssertionError: File mã nguồn chưa được git add — clone sạch sẽ thiếu:
|
||||
tests/ui/test_<...>.py
|
||||
```
|
||||
|
||||
- **`.venv` không được nằm trong repo.** `install.bat` dựng venv ở
|
||||
`%LOCALAPPDATA%\CoworkLocal` chính vì gate đi bộ toàn cây thư mục — một `.venv` trong repo
|
||||
biến mọi module vendored thành vi phạm Gate O.
|
||||
|
||||
## 5. Định nghĩa "xong"
|
||||
|
||||
Từ `docs/governance/definition-of-done.md`:
|
||||
|
||||
- code xong;
|
||||
- test liên quan pass;
|
||||
- tài liệu cập nhật nếu cần;
|
||||
- PR đã được review;
|
||||
- đã merge vào nhánh mặc định.
|
||||
|
||||
**Một PR = một thay đổi logic.** Không gộp nhiều bug UI không liên quan vào một PR.
|
||||
|
||||
Đóng góp từ FSG AI Core Team chỉ "xong" khi PR đã merge vào Cowork Local — "Core AI code
|
||||
xong" hoặc "pre-review pass" **không** phải Done. Bằng chứng bắt buộc: core issue reference,
|
||||
PR, evidence test, reviewer phía Cowork, merge commit.
|
||||
|
||||
---
|
||||
|
||||
## 6. Suite này vốn đã KHÔNG xanh
|
||||
|
||||
Tại `e5fa21e` (2026-09-07), chạy đầy đủ trên Windows + Python 3.14 cho ra:
|
||||
|
||||
```
|
||||
11 failed, 884 passed, 2 skipped, 66 errors
|
||||
```
|
||||
|
||||
Nghĩa là **"pytest đỏ" không nói lên điều gì** về bản vá của bạn. Bắt buộc phải so với
|
||||
baseline, và so bằng **danh sách tên test**:
|
||||
|
||||
```bash
|
||||
git stash push --include-untracked -m baseline
|
||||
QT_QPA_PLATFORM=offscreen pytest -q > /tmp/base.txt 2>&1
|
||||
git stash pop
|
||||
QT_QPA_PLATFORM=offscreen pytest -q > /tmp/after.txt 2>&1
|
||||
|
||||
grep "^FAILED" /tmp/base.txt | sed 's/ - .*//' | sort > /tmp/f_base.txt
|
||||
grep "^FAILED" /tmp/after.txt | sed 's/ - .*//' | sort > /tmp/f_after.txt
|
||||
comm -13 /tmp/f_base.txt /tmp/f_after.txt # rỗng = không regression
|
||||
```
|
||||
|
||||
Không so con số tổng: một test cũ hỏng cộng một test mới xanh cho ra cùng con số.
|
||||
|
||||
Nhóm đỏ lớn nhất hiện nay là `tests/characterization/test_co4e_runs_page.py` —
|
||||
`RuntimeError: libshiboken: Internal C++ object (QGraphicsScene) already deleted`
|
||||
(bẫy P13 trong `qt_pitfalls.md`). Chưa ai nhận sửa.
|
||||
|
||||
Gate A và Gate S cũng đỏ sẵn:
|
||||
|
||||
- A — 3 phát hiện trong `tests/test_project_context_{e2e,issue,knowledge}.py`;
|
||||
- S — `core/chat_agent.py` 423 LOC, `mcp_servers/project_context/providers/knowledge.py` 408 LOC.
|
||||
|
||||
Đừng nhận nhầm bốn thứ trên là do bản vá của mình (`guardrail.md` G10).
|
||||
@@ -1,480 +0,0 @@
|
||||
# Screen Map — Tra mô tả của người dùng về đúng file:line
|
||||
|
||||
Người dùng thường mô tả lỗi bằng ngôn ngữ tự nhiên, ví dụ:
|
||||
|
||||
> "Cái bảng bên phải của màn thống kê bị lệch."
|
||||
|
||||
Agent phải dùng file này để chuyển mô tả đó thành:
|
||||
|
||||
```text
|
||||
Màn hình → Tab/View → Widget → File → Line → Control
|
||||
```
|
||||
|
||||
Mục tiêu là tìm được **đúng widget và đúng vị trí code**, thay vì đoán file dựa trên tên.
|
||||
|
||||
---
|
||||
|
||||
## 1. Bốn màn hình chính trong Nav Rail
|
||||
|
||||
Các màn hình chính được định nghĩa tại:
|
||||
|
||||
```text
|
||||
presentation/shell/main_window.py:151
|
||||
```
|
||||
|
||||
Danh sách nằm trong `_nav_defs`.
|
||||
|
||||
**Thứ tự trong bảng chính là page index.**
|
||||
|
||||
| Row | i18n key | Icon | Cách tạo | Widget |
|
||||
| --: | -------------------- | ------------ | --------------- | --------------------------------------------------------------- |
|
||||
| 0 | `app.tab.dashboard` | `dashboard` | Lazy | `presentation/dashboard/dashboard_tab.py::DashboardTab` |
|
||||
| 1 | `app.tab.schedule` | `schedule` | Lazy | `presentation/scheduling/schedule_task_tab.py::ScheduleTaskTab` |
|
||||
| 2 | `app.tab.workspace` | `workspaces` | Ngay khi mở app | `ui/workspace_tab.py::WorkspaceTab` |
|
||||
| 3 | `app.tab.monitoring` | `monitoring` | Lazy | `ui/monitoring_tab.py::MonitoringTab` |
|
||||
|
||||
### Màn hình mặc định
|
||||
|
||||
Khi mở app, người dùng bắt đầu tại:
|
||||
|
||||
```text
|
||||
Workspace → Project
|
||||
```
|
||||
|
||||
### Lưu ý về Lazy
|
||||
|
||||
`Dashboard`, `Schedule` và `Monitoring` được tạo **lazy** — chỉ được dựng khi người dùng mở màn hình.
|
||||
|
||||
Vì vậy, khi điều tra lỗi liên quan đến các màn hình này, phải kiểm tra cả **thời điểm widget được tạo** và **vòng đời của widget**.
|
||||
|
||||
---
|
||||
|
||||
## 2. Các tab bên trong Workspace
|
||||
|
||||
Các tab được định nghĩa trong:
|
||||
|
||||
```text
|
||||
ui/workspace_tab.py:214-245
|
||||
```
|
||||
|
||||
| Tab | i18n key | Widget/File |
|
||||
| -------- | ------------------------ | -------------------------------------------------- |
|
||||
| Project | `workspace.tab_project` | `_build_project_tab()` trong `ui/workspace_tab.py` |
|
||||
| Cowork | `workspace.tab_cowork` | `ui/cowork_tab.py` |
|
||||
| Co4E | `workspace.tab_co4e` | `ui/co4e_tab.py` → `presentation/co4e/` |
|
||||
| Folder | `workspace.tab_folder` | `presentation/folder/folder_tab.py` |
|
||||
| GraphRAG | `workspace.tab_graphrag` | `presentation/graph/structure_graph_view.py` |
|
||||
|
||||
### Monitoring có cấu trúc khác
|
||||
|
||||
Monitoring có **tab strip riêng**, gồm 8 sub-view:
|
||||
|
||||
1. Tổng quan.
|
||||
2. Trạng thái Agent.
|
||||
3. Công cụ.
|
||||
4. Nhật ký hành động.
|
||||
5. Lịch sử gọi MCP.
|
||||
6. Sự kiện bảo mật.
|
||||
7. Agents Admin.
|
||||
8. Icon.
|
||||
|
||||
**Workspace là màn hình duy nhất không hiển thị tab strip theo cách này.**
|
||||
|
||||
Nếu người dùng nói:
|
||||
|
||||
> "Tab trạng thái agent trong màn Monitoring"
|
||||
|
||||
thì không được nhầm nó với một tab của Workspace.
|
||||
|
||||
---
|
||||
|
||||
## 3. Các thành phần luôn xuất hiện trên mọi màn hình
|
||||
|
||||
Một số thành phần nằm ngoài nội dung của từng màn hình.
|
||||
|
||||
| Thành phần | File | Cách người dùng thường mô tả |
|
||||
| ------------------------------- | -------------------------------- | -------------------------------------------------- |
|
||||
| Nav rail bên trái / nút thu gọn | `presentation/shell/nav_rail.py` | "Menu bị co lại", "Không thấy tên project" |
|
||||
| Top bar / theme / ngôn ngữ | `presentation/shell/top_bar.py` | "Đổi giao diện không ăn", "Đổi ngôn ngữ không đổi" |
|
||||
| Toast góc trên trái | `presentation/shell/toast.py` | "Thông báo xong việc che mất nút" |
|
||||
| Help Agent góc dưới phải | `ui/help_agent_widget.py` | "Con robot che nút gửi" |
|
||||
| Status bar phía dưới | `main_window.statusBar()` | "Dòng chữ dưới đáy không đổi" |
|
||||
|
||||
### Quy tắc
|
||||
|
||||
Nếu người dùng mô tả một thành phần thuộc nhóm trên, **không cần tìm sub-tab trước**.
|
||||
|
||||
Hãy kiểm tra trực tiếp file tương ứng.
|
||||
|
||||
---
|
||||
|
||||
## 4. Các Dialog
|
||||
|
||||
Các dialog chính nằm trong `ui/`:
|
||||
|
||||
```text
|
||||
ui/
|
||||
├── login_dialog.py
|
||||
├── permission_dialog.py
|
||||
├── settings_dialog.py
|
||||
├── skills_dialog.py
|
||||
├── task_editor_dialog.py
|
||||
├── file_edit_dialog.py
|
||||
├── flow_dialog.py
|
||||
├── mcp_servers_dialog.py
|
||||
├── co4e_agent_dialog.py
|
||||
└── ext_connector_dialog.py
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
> "Khi mở Permission thì nút Allow bị..."
|
||||
|
||||
→ kiểm tra trước:
|
||||
|
||||
```text
|
||||
ui/permission_dialog.py
|
||||
```
|
||||
|
||||
Không tự động tìm trong `presentation/` chỉ vì lỗi xảy ra trên UI.
|
||||
|
||||
---
|
||||
|
||||
# 5. Hai file tra cứu bắt buộc
|
||||
|
||||
Khi cần chuyển mô tả của người dùng thành `file:line`, phải ưu tiên sử dụng:
|
||||
|
||||
```text
|
||||
docs/screens/manifest.json
|
||||
docs/screens/controls.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5.1. `docs/screens/manifest.json`
|
||||
|
||||
File này chứa thông tin về các màn hình đã được chụp screenshot.
|
||||
|
||||
Mỗi màn hình có các thông tin chính:
|
||||
|
||||
```text
|
||||
slug
|
||||
title
|
||||
theme
|
||||
note
|
||||
file
|
||||
nav
|
||||
```
|
||||
|
||||
Trong đó:
|
||||
|
||||
* `slug` — tên định danh của màn hình.
|
||||
* `title` — tên hiển thị.
|
||||
* `theme` — Dark hoặc Light.
|
||||
* `note` — **vị trí code dựng màn hình (`file.py:line`)**.
|
||||
* `file` — đường dẫn đến screenshot.
|
||||
* `nav` — màn hình thuộc nav nào.
|
||||
|
||||
### Ví dụ
|
||||
|
||||
Người dùng nói:
|
||||
|
||||
> "Màn Kanban lịch trình bị lỗi."
|
||||
|
||||
Có thể tìm màn hình liên quan bằng:
|
||||
|
||||
```bash
|
||||
python -c "import json;print([e for e in json.load(open('docs/screens/manifest.json')) if 'schedule' in e['slug']])"
|
||||
```
|
||||
|
||||
Sau đó lấy `note` để biết:
|
||||
|
||||
```text
|
||||
file.py:line
|
||||
```
|
||||
|
||||
### Screenshot Dark và Light
|
||||
|
||||
Mỗi màn hình thường có hai ảnh:
|
||||
|
||||
```text
|
||||
<slug>-dark.png
|
||||
<slug>-light.png
|
||||
```
|
||||
|
||||
Dùng hai ảnh này để:
|
||||
|
||||
* So sánh trước/sau.
|
||||
* Kiểm tra lỗi chỉ xảy ra ở một theme.
|
||||
* Kiểm tra sự khác biệt giữa Dark Mode và Light Mode.
|
||||
|
||||
---
|
||||
|
||||
## 5.2. `docs/screens/controls.json`
|
||||
|
||||
Đây là danh sách các control được trích tự động từ source code.
|
||||
|
||||
Mỗi control có thông tin như:
|
||||
|
||||
```text
|
||||
file
|
||||
var
|
||||
type
|
||||
kind
|
||||
label
|
||||
line
|
||||
signals
|
||||
object_name
|
||||
```
|
||||
|
||||
Trong đó:
|
||||
|
||||
* `file` — file chứa control.
|
||||
* `var` — tên biến.
|
||||
* `type` — loại widget, ví dụ `QLineEdit`.
|
||||
* `kind` — mô tả dễ hiểu, ví dụ `"ô nhập"`, `"nút"`.
|
||||
* `label` — text/label liên quan.
|
||||
* `line` — dòng code.
|
||||
* `signals` — signal liên quan.
|
||||
* `object_name` — `objectName` của widget.
|
||||
|
||||
### Ví dụ
|
||||
|
||||
Người dùng nói:
|
||||
|
||||
> "Ô nhập email trong màn tài khoản bị lỗi."
|
||||
|
||||
Có thể tìm control bằng:
|
||||
|
||||
```bash
|
||||
python - <<'PY'
|
||||
import json
|
||||
|
||||
for f in json.load(open('docs/screens/controls.json')):
|
||||
for c in f['controls']:
|
||||
text = (c['var'] + c['label']).lower()
|
||||
if 'email' in text:
|
||||
print(
|
||||
f["file"],
|
||||
c["line"],
|
||||
c["var"],
|
||||
c["type"],
|
||||
c["object_name"]
|
||||
)
|
||||
PY
|
||||
```
|
||||
|
||||
Từ kết quả có thể xác định:
|
||||
|
||||
```text
|
||||
file
|
||||
line
|
||||
variable
|
||||
widget type
|
||||
objectName
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. `object_name` đặc biệt quan trọng khi điều tra UI
|
||||
|
||||
Khi sửa lỗi màu hoặc style, phải chú ý đến:
|
||||
|
||||
```text
|
||||
object_name
|
||||
```
|
||||
|
||||
Nếu `object_name` đang rỗng, có nghĩa widget đó **chưa được gắn `objectName` để áp style theo cơ chế template/QSS**.
|
||||
|
||||
Khi đó widget có thể đang sử dụng style mặc định của class.
|
||||
|
||||
Đây thường là nguyên nhân khiến người dùng thấy:
|
||||
|
||||
> "Chỗ này nhìn khác chỗ kia."
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Widget A → objectName = "project_title"
|
||||
↓
|
||||
QSS áp style riêng
|
||||
|
||||
Widget B → objectName = ""
|
||||
↓
|
||||
dùng style mặc định
|
||||
```
|
||||
|
||||
Vì vậy, khi gặp lỗi visual liên quan đến màu/style, hãy kiểm tra `object_name` trước khi tự thêm màu hoặc `setStyleSheet()`.
|
||||
|
||||
---
|
||||
|
||||
# 7. Quy trình 4 bước dành cho Triage
|
||||
|
||||
Khi người dùng báo lỗi bằng ngôn ngữ tự nhiên, thực hiện theo thứ tự sau:
|
||||
|
||||
### Bước 1 — Xác định màn hình chính
|
||||
|
||||
Xác định lỗi thuộc:
|
||||
|
||||
```text
|
||||
Dashboard
|
||||
Schedule
|
||||
Workspace
|
||||
Monitoring
|
||||
```
|
||||
|
||||
Dựa trên mô tả của người dùng hoặc screenshot.
|
||||
|
||||
---
|
||||
|
||||
### Bước 2 — Xác định tab/view/dialog
|
||||
|
||||
Tiếp tục xác định:
|
||||
|
||||
```text
|
||||
Sub-tab
|
||||
→ View
|
||||
→ Dialog
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Workspace
|
||||
→ Co4E
|
||||
→ Agent Dialog
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```text
|
||||
Monitoring
|
||||
→ Security Events
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Bước 3 — Tra `manifest.json`
|
||||
|
||||
Mở:
|
||||
|
||||
```text
|
||||
docs/screens/manifest.json
|
||||
```
|
||||
|
||||
Tìm màn hình tương ứng và lấy:
|
||||
|
||||
```text
|
||||
note → file.py:line
|
||||
```
|
||||
|
||||
Đây là điểm bắt đầu để tìm code dựng màn hình.
|
||||
|
||||
---
|
||||
|
||||
### Bước 4 — Tra `controls.json`
|
||||
|
||||
Nếu lỗi liên quan đến một control cụ thể, tiếp tục tìm trong:
|
||||
|
||||
```text
|
||||
docs/screens/controls.json
|
||||
```
|
||||
|
||||
Lấy:
|
||||
|
||||
```text
|
||||
var
|
||||
line
|
||||
type
|
||||
object_name
|
||||
```
|
||||
|
||||
Sau đó xác định chính xác widget bị lỗi.
|
||||
|
||||
---
|
||||
|
||||
# 8. Quy tắc về Confidence
|
||||
|
||||
Triage phải phản ánh đúng mức độ chắc chắn của kết quả.
|
||||
|
||||
Nếu chưa hoàn thành đủ 4 bước:
|
||||
|
||||
```text
|
||||
1. Nav
|
||||
2. Tab/View/Dialog
|
||||
3. manifest.json
|
||||
4. controls.json
|
||||
```
|
||||
|
||||
thì:
|
||||
|
||||
```yaml
|
||||
confidence: low
|
||||
```
|
||||
|
||||
Không được tự nâng lên `medium` hoặc `high` chỉ vì file nhìn có vẻ đúng.
|
||||
|
||||
### Khi nào có thể tăng Confidence?
|
||||
|
||||
Chỉ tăng khi có bằng chứng cụ thể, ví dụ:
|
||||
|
||||
```text
|
||||
User description
|
||||
↓
|
||||
Dashboard
|
||||
↓
|
||||
Statistics view
|
||||
↓
|
||||
manifest.json
|
||||
↓
|
||||
presentation/dashboard/dashboard_tab.py:123
|
||||
↓
|
||||
controls.json
|
||||
↓
|
||||
QTableView
|
||||
↓
|
||||
line 245
|
||||
```
|
||||
|
||||
Khi đó mới có đủ cơ sở để ghi nhận `file:line` và đánh giá confidence cao hơn.
|
||||
|
||||
---
|
||||
|
||||
# 9. Nguyên tắc quan trọng
|
||||
|
||||
**Không đoán file từ tên.**
|
||||
|
||||
Không nên suy luận kiểu:
|
||||
|
||||
> "Lỗi ở Workspace nên chắc chắn nằm trong `workspace_tab.py`."
|
||||
|
||||
Thay vào đó:
|
||||
|
||||
```text
|
||||
Mô tả của user
|
||||
↓
|
||||
Xác định màn hình
|
||||
↓
|
||||
Xác định tab/view/dialog
|
||||
↓
|
||||
Tra manifest.json
|
||||
↓
|
||||
Xác định file:line
|
||||
↓
|
||||
Tra controls.json
|
||||
↓
|
||||
Xác định widget/control
|
||||
↓
|
||||
Đánh giá confidence
|
||||
```
|
||||
|
||||
Mục tiêu cuối cùng của Screen Map là biến một mô tả mơ hồ của người dùng thành một đầu vào có thể sử dụng được cho `defect_record`, đặc biệt là:
|
||||
|
||||
```text
|
||||
screen
|
||||
widget
|
||||
file
|
||||
line
|
||||
object_name
|
||||
confidence
|
||||
```
|
||||
@@ -1,987 +0,0 @@
|
||||
# Secret & Config — Nơi credential được phép nằm
|
||||
|
||||
> Knowledge module dành cho `security-defect-fixer`.
|
||||
|
||||
## Nguồn chính
|
||||
|
||||
* `infrastructure/secrets/secret_store.py`
|
||||
* `infrastructure/secrets/keyring_adapter.py`
|
||||
* `infrastructure/config/schema_migration.py`
|
||||
* `config.py`
|
||||
* `SECURITY.md`
|
||||
|
||||
**Lưu ý:** Module này chỉ dành cho vấn đề security/config.
|
||||
Ba module UI `theme_tokens`, `i18n_rules`, `screen_map` **không xử lý credential**.
|
||||
|
||||
---
|
||||
|
||||
# 1. Credential được phép lưu ở đâu?
|
||||
|
||||
Ưu tiên từ **an toàn nhất → kém an toàn hơn**:
|
||||
|
||||
| Bậc | Nơi lưu | Dùng cho | API / cách truy cập |
|
||||
| --- | -------------------------------------- | ------------------------------------ | ---------------------------- |
|
||||
| 1 | **OS Keyring** thông qua `SecretStore` | API key, token, mật khẩu thật | `secrets.set/get/has/delete` |
|
||||
| 2 | **Environment variable** | Giá trị do admin đặt khi triển khai | `_apply_env_overrides` |
|
||||
| 3 | **`config.json`** | Chỉ dành cho config **không bí mật** | `ctx.config.<group>` |
|
||||
| 4 | **Hằng số trong source code** | ❌ Không được chứa credential | — |
|
||||
|
||||
### Rule quan trọng
|
||||
|
||||
Credential **không được hardcode trong source code**.
|
||||
|
||||
Nếu credential nằm trong code:
|
||||
|
||||
1. Gate A có thể phát hiện.
|
||||
2. Credential có thể đã đi vào Git history.
|
||||
3. Xóa ở commit hiện tại **không có nghĩa là credential đã biến mất khỏi Git history**.
|
||||
|
||||
---
|
||||
|
||||
# 2. `SecretStore` — interface để làm việc với secret
|
||||
|
||||
`SecretStore` là **interface (Protocol)**, không phải một hàm tiện ích.
|
||||
|
||||
File:
|
||||
|
||||
```python
|
||||
# infrastructure/secrets/secret_store.py
|
||||
|
||||
@runtime_checkable
|
||||
class SecretStore(Protocol):
|
||||
|
||||
def get(self, key: str) -> str | None:
|
||||
...
|
||||
|
||||
def set(self, key: str, value: str) -> None:
|
||||
...
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
...
|
||||
|
||||
def has(self, key: str) -> bool:
|
||||
...
|
||||
|
||||
|
||||
def provider_key(name: str) -> str:
|
||||
return f"provider:{name}"
|
||||
```
|
||||
|
||||
## Ý nghĩa của từng API
|
||||
|
||||
| API | Ý nghĩa |
|
||||
| ---------------- | -------------------------------------------------------------- |
|
||||
| `get()` | Lấy secret; thiếu key thì trả `None`, không được làm app crash |
|
||||
| `set()` | Lưu secret |
|
||||
| `delete()` | Xóa secret; không có key thì không cần báo lỗi |
|
||||
| `has()` | Kiểm tra secret có tồn tại hay không mà **không đọc giá trị** |
|
||||
| `provider_key()` | Chuẩn hóa cách đặt key cho provider |
|
||||
|
||||
## Vì sao dùng `Protocol`?
|
||||
|
||||
Bản thật sử dụng OS Keyring:
|
||||
|
||||
* có thể chậm;
|
||||
* có thể phát sinh exception;
|
||||
* môi trường CI có thể không có keyring backend.
|
||||
|
||||
Do đó test **không được truy cập keyring thật của máy**.
|
||||
|
||||
Thay vào đó, test sử dụng `FakeSecretStore`.
|
||||
|
||||
### Rule khi thêm secret mới
|
||||
|
||||
**Không tự tạo cách đặt key mới.**
|
||||
|
||||
Ví dụ đã có:
|
||||
|
||||
```python
|
||||
provider_key(name)
|
||||
```
|
||||
|
||||
thì hãy dùng nó.
|
||||
|
||||
Nếu loại secret mới chưa có quy ước:
|
||||
|
||||
```python
|
||||
def xxx_key(...):
|
||||
...
|
||||
```
|
||||
|
||||
Hãy tạo một helper `*_key()` cạnh các helper hiện có.
|
||||
|
||||
**Không rải string literal của key khắp source code.**
|
||||
|
||||
---
|
||||
|
||||
## Settings: kiểm tra secret bằng `has()`
|
||||
|
||||
Nếu UI chỉ cần biết:
|
||||
|
||||
> "API key đã được cấu hình chưa?"
|
||||
|
||||
thì dùng:
|
||||
|
||||
```python
|
||||
secrets.has(key)
|
||||
```
|
||||
|
||||
**Không dùng:**
|
||||
|
||||
```python
|
||||
secrets.get(key)
|
||||
```
|
||||
|
||||
Chỉ để hiển thị dấu ✓.
|
||||
|
||||
Lý do: không cần đọc secret thật ra khỏi kho chỉ để kiểm tra trạng thái.
|
||||
|
||||
---
|
||||
|
||||
## Khi `KeyringAdapter.available == False`
|
||||
|
||||
Có thể xảy ra khi:
|
||||
|
||||
* Linux không có keyring backend;
|
||||
* CI;
|
||||
* môi trường triển khai không hỗ trợ OS Keyring.
|
||||
|
||||
App phải có **fallback phù hợp** và không được crash chỉ vì keyring không khả dụng.
|
||||
|
||||
Bản thật là `KeyringAdapter`.
|
||||
|
||||
Service:
|
||||
|
||||
```python
|
||||
SERVICE = "cowork-local"
|
||||
```
|
||||
|
||||
Có property:
|
||||
|
||||
```python
|
||||
available
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 3. Schema migration — thay đổi cấu trúc config an toàn
|
||||
|
||||
File:
|
||||
|
||||
```text
|
||||
infrastructure/config/schema_migration.py
|
||||
```
|
||||
|
||||
Các thông tin chính:
|
||||
|
||||
```python
|
||||
CURRENT_VERSION = 2
|
||||
ASSUMED_VERSION = 1
|
||||
|
||||
STEPS = {
|
||||
1: _v1_to_v2,
|
||||
}
|
||||
```
|
||||
|
||||
Ý nghĩa:
|
||||
|
||||
* `CURRENT_VERSION`: version config hiện tại.
|
||||
* `ASSUMED_VERSION`: nếu file không có `schema_version` thì coi là version 1.
|
||||
* `STEPS`: mỗi entry nâng đúng **một version**.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
v1 → v2 → v3
|
||||
```
|
||||
|
||||
Không được thiết kế kiểu:
|
||||
|
||||
```text
|
||||
v1 → v3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4 luật migration bắt buộc
|
||||
|
||||
### 4.1 Backup trước khi migration
|
||||
|
||||
Trước khi nâng schema:
|
||||
|
||||
```text
|
||||
backup()
|
||||
```
|
||||
|
||||
tạo file dạng:
|
||||
|
||||
```text
|
||||
config.json.v<timestamp>.bak
|
||||
```
|
||||
|
||||
Mục đích:
|
||||
|
||||
* người dùng vẫn có bản backup;
|
||||
* app cũ có thể còn đọc được config cũ;
|
||||
* migration lỗi vẫn có đường quay lại.
|
||||
|
||||
---
|
||||
|
||||
### 4.2 Chỉ nâng version, không hạ version
|
||||
|
||||
Nếu file config mới hơn version mà app hiện tại hiểu:
|
||||
|
||||
```text
|
||||
file version > CURRENT_VERSION
|
||||
```
|
||||
|
||||
thì:
|
||||
|
||||
1. log warning;
|
||||
2. giữ nguyên config;
|
||||
3. **không cố đoán cách downgrade**.
|
||||
|
||||
Không được tự ý biến config mới thành config cũ.
|
||||
|
||||
---
|
||||
|
||||
### 4.3 Mỗi migration là một function riêng
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
STEPS = {
|
||||
1: _v1_to_v2,
|
||||
}
|
||||
```
|
||||
|
||||
Mỗi function xử lý đúng:
|
||||
|
||||
```text
|
||||
v(n) → v(n+1)
|
||||
```
|
||||
|
||||
Không viết logic kiểu:
|
||||
|
||||
```text
|
||||
"Nếu thấy key office thì chắc đây là config cũ"
|
||||
```
|
||||
|
||||
Version phải được xác định bằng `schema_version`.
|
||||
|
||||
---
|
||||
|
||||
### 4.4 Migration không nâng được version thì phải dừng
|
||||
|
||||
Nếu migration không thành công:
|
||||
|
||||
* không lặp vô hạn;
|
||||
* không tự đoán;
|
||||
* không tiếp tục nâng version giả;
|
||||
* phải giữ trạng thái an toàn và báo lỗi/warning phù hợp.
|
||||
|
||||
---
|
||||
|
||||
# 4. Tiền lệ quan trọng: `_v1_to_v2`
|
||||
|
||||
Đây là migration quan trọng cần **đọc trước khi thiết kế migration credential mới**.
|
||||
|
||||
Migration này từng xử lý việc:
|
||||
|
||||
```text
|
||||
api_key
|
||||
```
|
||||
|
||||
từ config file → `SecretStore`.
|
||||
|
||||
Mẫu chính:
|
||||
|
||||
```python
|
||||
def _v1_to_v2(data, secrets):
|
||||
|
||||
if secrets is None or not getattr(secrets, "available", True):
|
||||
log.info(
|
||||
"bỏ qua v1→v2: máy này chưa có kho bí mật dùng được"
|
||||
)
|
||||
return data
|
||||
|
||||
...
|
||||
|
||||
secrets.set(provider_key(name), key)
|
||||
conf["api_key"] = ""
|
||||
out["schema_version"] = 2
|
||||
```
|
||||
|
||||
## Có 2 bài học quan trọng
|
||||
|
||||
### 4.1 Không có Keyring thì không chuyển
|
||||
|
||||
Nếu Keyring không dùng được:
|
||||
|
||||
```text
|
||||
KHÔNG MIGRATE
|
||||
```
|
||||
|
||||
Giữ nguyên version cũ.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
v1 + không có keyring
|
||||
↓
|
||||
giữ nguyên v1
|
||||
↓
|
||||
lần sau có keyring
|
||||
↓
|
||||
migrate v1 → v2
|
||||
```
|
||||
|
||||
Lý do:
|
||||
|
||||
> Mất credential của người dùng còn tệ hơn việc trì hoãn migration.
|
||||
|
||||
---
|
||||
|
||||
### 4.2 Bỏ qua placeholder
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
api_key == "ollama"
|
||||
```
|
||||
|
||||
chỉ là placeholder.
|
||||
|
||||
Không nên đưa placeholder vào Keyring.
|
||||
|
||||
Nếu không, Keyring sẽ chứa những secret giả không có giá trị.
|
||||
|
||||
---
|
||||
|
||||
# 5. ⚠️ Bẫy `.get(key, fallback)` với config đã deep-merge
|
||||
|
||||
Đây là một trong những bẫy quan trọng nhất của config.
|
||||
|
||||
Trong:
|
||||
|
||||
```text
|
||||
config.py:265
|
||||
```
|
||||
|
||||
có:
|
||||
|
||||
```python
|
||||
_deep_merge(base, override)
|
||||
```
|
||||
|
||||
Sau đó:
|
||||
|
||||
```text
|
||||
infrastructure/config/json_config_repository.py:90
|
||||
```
|
||||
|
||||
config được merge với:
|
||||
|
||||
```text
|
||||
DEFAULT_CONFIG
|
||||
```
|
||||
|
||||
Vì vậy config đưa tới UI **đã có sẵn các default key**.
|
||||
|
||||
Ví dụ `DEFAULT_CONFIG` có:
|
||||
|
||||
```python
|
||||
"sandbox_pw": ""
|
||||
```
|
||||
|
||||
thì:
|
||||
|
||||
```python
|
||||
sec.get(
|
||||
"sandbox_pw",
|
||||
"<literal đã bị gỡ>"
|
||||
)
|
||||
```
|
||||
|
||||
sẽ trả:
|
||||
|
||||
```text
|
||||
""
|
||||
```
|
||||
|
||||
chứ **không trả fallback**.
|
||||
|
||||
## Vì sao?
|
||||
|
||||
`dict.get(key, fallback)` chỉ dùng `fallback` khi `key` **không tồn tại**.
|
||||
|
||||
Nhưng ở đây key đã được thêm bởi `DEFAULT_CONFIG`.
|
||||
|
||||
---
|
||||
|
||||
## Hậu quả
|
||||
|
||||
Code như:
|
||||
|
||||
```python
|
||||
sec.get("sandbox_pw", "<safe fallback>")
|
||||
```
|
||||
|
||||
có thể trông giống như có default an toàn.
|
||||
|
||||
Nhưng thực tế:
|
||||
|
||||
```text
|
||||
DEFAULT_CONFIG
|
||||
↓
|
||||
sandbox_pw = ""
|
||||
↓
|
||||
deep_merge()
|
||||
↓
|
||||
sandbox_pw luôn tồn tại
|
||||
↓
|
||||
.get(..., fallback) không bao giờ dùng fallback
|
||||
```
|
||||
|
||||
Vì vậy fallback đó thực tế là **dead code**.
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Nguy hiểm hơn: chuỗi rỗng
|
||||
|
||||
Nếu code sau đó dùng:
|
||||
|
||||
```python
|
||||
entered == stored
|
||||
```
|
||||
|
||||
thì:
|
||||
|
||||
```text
|
||||
entered = ""
|
||||
stored = ""
|
||||
```
|
||||
|
||||
sẽ trở thành:
|
||||
|
||||
```text
|
||||
True
|
||||
```
|
||||
|
||||
Tức là **input rỗng có thể mở khóa**.
|
||||
|
||||
Đây là security bug S1.
|
||||
|
||||
---
|
||||
|
||||
## Rule
|
||||
|
||||
Khi đọc credential từ config:
|
||||
|
||||
**Không dựa vào fallback của `.get()` để tạo security default.**
|
||||
|
||||
Thay vào đó:
|
||||
|
||||
1. lấy giá trị thật;
|
||||
2. kiểm tra `None`/rỗng một cách rõ ràng;
|
||||
3. chỉ cho phép tiếp tục nếu credential hợp lệ.
|
||||
|
||||
---
|
||||
|
||||
# 6. Environment variable override
|
||||
|
||||
File:
|
||||
|
||||
```text
|
||||
config.py::_apply_env_overrides
|
||||
```
|
||||
|
||||
Các biến hiện tại:
|
||||
|
||||
| Environment variable | Config được ghi vào |
|
||||
| -------------------------- | --------------------------- |
|
||||
| `COWORK_SANDBOX_PASSWORD` | `agent_security.sandbox_pw` |
|
||||
| `COWORK_MS365_UNLOCK_CODE` | `ms365.unlock_code` |
|
||||
| `COWORK_TEAMS_WEBHOOK` | `teams.webhook_url` |
|
||||
| `COWORK_ACTIVE_PROVIDER` | `active_provider` |
|
||||
| `COWORK_CA_BUNDLE` | `tls_ca_bundle` |
|
||||
|
||||
Environment override chạy **sau deep-merge**.
|
||||
|
||||
Do đó thứ tự ưu tiên là:
|
||||
|
||||
```text
|
||||
DEFAULT_CONFIG
|
||||
↓
|
||||
config.json
|
||||
↓
|
||||
environment variable
|
||||
```
|
||||
|
||||
Environment variable có giá trị ưu tiên cao nhất.
|
||||
|
||||
### Khi thêm credential mới
|
||||
|
||||
Hãy xem xét:
|
||||
|
||||
> Có cần hỗ trợ environment variable để admin có thể cấu hình khi deploy hay không?
|
||||
|
||||
Không phải secret nào cũng bắt buộc phải có env override.
|
||||
|
||||
---
|
||||
|
||||
# 7. Sinh credential/token — dùng lại implementation có sẵn
|
||||
|
||||
File:
|
||||
|
||||
```text
|
||||
core/accounts.py:89
|
||||
```
|
||||
|
||||
Hiện có:
|
||||
|
||||
```python
|
||||
_CODE_ALPHABET = "ABCDEFGHJKMNPQRSTUVWXYZ23456789"
|
||||
CODE_LENGTH = 12
|
||||
|
||||
def generate_code(existing_codes=None) -> str:
|
||||
...
|
||||
```
|
||||
|
||||
Alphabet bỏ các ký tự dễ nhìn nhầm:
|
||||
|
||||
```text
|
||||
I L O 0 1
|
||||
```
|
||||
|
||||
Mục đích là người dùng có thể đọc và nhập lại code dễ hơn.
|
||||
|
||||
## Rule
|
||||
|
||||
Dùng:
|
||||
|
||||
```python
|
||||
secrets
|
||||
```
|
||||
|
||||
**Không dùng:**
|
||||
|
||||
```python
|
||||
random
|
||||
```
|
||||
|
||||
Nếu cần access code cho người dùng:
|
||||
|
||||
```python
|
||||
generate_code()
|
||||
```
|
||||
|
||||
Không tự viết thêm một generator khác.
|
||||
|
||||
Nếu token là token nội bộ và không cần người đọc:
|
||||
|
||||
```python
|
||||
secrets.token_urlsafe(32)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 8. Gate A và Git history
|
||||
|
||||
Chạy:
|
||||
|
||||
```bash
|
||||
python scripts/audit_security.py
|
||||
```
|
||||
|
||||
Gate này quét:
|
||||
|
||||
* `.py`;
|
||||
* config files;
|
||||
* các vị trí có khả năng chứa secret.
|
||||
|
||||
Hiện repo có một số phát hiện **đã tồn tại từ trước** trong:
|
||||
|
||||
```text
|
||||
tests/test_project_context_*.py
|
||||
```
|
||||
|
||||
Không được nhầm chúng với lỗi do patch hiện tại tạo ra.
|
||||
|
||||
---
|
||||
|
||||
## Nếu credential đã xuất hiện trong Git history
|
||||
|
||||
Nếu phát hiện secret thật trong Git history:
|
||||
|
||||
### 1. Dừng phân phối
|
||||
|
||||
Không tiếp tục phát hành artifact có nguy cơ chứa credential.
|
||||
|
||||
### 2. Báo Cowork Team
|
||||
|
||||
Đây là vấn đề cần xử lý ở cấp team.
|
||||
|
||||
### 3. Không tự rewrite history
|
||||
|
||||
Không tự:
|
||||
|
||||
```text
|
||||
git filter
|
||||
git rebase
|
||||
force-push
|
||||
```
|
||||
|
||||
nếu chưa có kế hoạch phối hợp rõ ràng.
|
||||
|
||||
### 4. Rotate credential
|
||||
|
||||
Credential đã lộ phải được xem là có khả năng bị compromise và cần rotate khi phù hợp.
|
||||
|
||||
---
|
||||
|
||||
## Rule quan trọng
|
||||
|
||||
Xóa secret khỏi source code hôm nay:
|
||||
|
||||
```text
|
||||
KHÔNG XÓA SECRET KHỎI GIT HISTORY
|
||||
```
|
||||
|
||||
Vì vậy `fix_plan` phải ghi rõ nếu credential từng xuất hiện trong history.
|
||||
|
||||
---
|
||||
|
||||
# 9. Quyết định phải hỏi Cowork Team
|
||||
|
||||
Thay đổi liên quan credential không được tự quyết chỉ vì:
|
||||
|
||||
```text
|
||||
CI xanh
|
||||
```
|
||||
|
||||
Theo:
|
||||
|
||||
```text
|
||||
docs/governance/review-policy.md
|
||||
```
|
||||
|
||||
credential-related change cần được security review phù hợp.
|
||||
|
||||
## 4 câu hỏi agent phải đưa cho người quyết định
|
||||
|
||||
### 1. Đây là loại nào?
|
||||
|
||||
* khóa chống bấm nhầm;
|
||||
* hay credential/security mechanism thật?
|
||||
|
||||
Điều này quyết định mức độ bảo vệ cần thiết.
|
||||
|
||||
### 2. Lưu gì trong Keyring?
|
||||
|
||||
* plaintext;
|
||||
* hay hash để kể cả admin cũng không đọc được?
|
||||
|
||||
Agent chỉ đề xuất, không tự quyết.
|
||||
|
||||
### 3. Người dùng hiện tại xử lý thế nào?
|
||||
|
||||
* giữ credential cũ;
|
||||
* migrate;
|
||||
* hay bắt buộc reset?
|
||||
|
||||
Đây là quyết định về backward compatibility và UX.
|
||||
|
||||
### 4. Credential được tạo ra hiển thị thế nào?
|
||||
|
||||
Cần xác định:
|
||||
|
||||
* có hiển thị cho người dùng không;
|
||||
* hiển thị ở đâu;
|
||||
* hiển thị trong bao lâu;
|
||||
* người dùng được xem lại bao nhiêu lần.
|
||||
|
||||
---
|
||||
|
||||
# 10. So sánh credential — hai lỗi cần nhớ
|
||||
|
||||
Nguồn tham chiếu:
|
||||
|
||||
```text
|
||||
SEC-20260907-01
|
||||
```
|
||||
|
||||
Đây là defect thật đã từng xảy ra trong repo.
|
||||
|
||||
Có **hai bẫy liên tiếp**.
|
||||
|
||||
---
|
||||
|
||||
## 10.1 Chặn chuỗi rỗng trước khi so sánh
|
||||
|
||||
Credential default thường là:
|
||||
|
||||
```python
|
||||
""
|
||||
```
|
||||
|
||||
Do cơ chế deep-merge ở §5, giá trị rỗng này có thể đi thẳng tới code kiểm tra.
|
||||
|
||||
Nếu viết:
|
||||
|
||||
```python
|
||||
entered == stored
|
||||
```
|
||||
|
||||
thì:
|
||||
|
||||
```text
|
||||
entered = ""
|
||||
stored = ""
|
||||
```
|
||||
|
||||
→ `True`
|
||||
|
||||
Đây là bypass bằng input rỗng.
|
||||
|
||||
---
|
||||
|
||||
## Mẫu đúng đã có trong repo
|
||||
|
||||
Trong:
|
||||
|
||||
```text
|
||||
infrastructure/config/json_config_repository.py
|
||||
```
|
||||
|
||||
có:
|
||||
|
||||
```python
|
||||
if (code or "") and code == self.ms365.get("unlock_code", ""):
|
||||
```
|
||||
|
||||
Phần quan trọng là:
|
||||
|
||||
```python
|
||||
(code or "")
|
||||
```
|
||||
|
||||
kết hợp với:
|
||||
|
||||
```python
|
||||
and
|
||||
```
|
||||
|
||||
Nó đảm bảo code rỗng bị chặn **trước khi thực hiện phép so sánh**.
|
||||
|
||||
### Rule
|
||||
|
||||
Credential rỗng:
|
||||
|
||||
```text
|
||||
MUST FAIL
|
||||
```
|
||||
|
||||
Không được coi:
|
||||
|
||||
```text
|
||||
"" == ""
|
||||
```
|
||||
|
||||
là thành công.
|
||||
|
||||
---
|
||||
|
||||
# 11. ⚠️ `secrets.compare_digest()` và Unicode
|
||||
|
||||
Một lỗi khác rất dễ mắc phải:
|
||||
|
||||
> Thấy `==` không an toàn về timing → đổi ngay sang `compare_digest()`.
|
||||
|
||||
Hướng đi đúng, nhưng phải kiểm tra **miền input**.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
secrets.compare_digest("mật khẩu", "mật khẩu")
|
||||
```
|
||||
|
||||
có thể gây:
|
||||
|
||||
```text
|
||||
TypeError
|
||||
```
|
||||
|
||||
với `str` chứa ký tự non-ASCII.
|
||||
|
||||
Điều này đặc biệt quan trọng với Cowork Local vì app:
|
||||
|
||||
* mặc định dùng tiếng Việt;
|
||||
* phục vụ khách Nhật;
|
||||
* credential có thể chứa Unicode.
|
||||
|
||||
Mật khẩu có dấu **không phải edge case**.
|
||||
|
||||
---
|
||||
|
||||
## Cách đúng: chuyển sang bytes
|
||||
|
||||
Dùng:
|
||||
|
||||
```python
|
||||
return secrets.compare_digest(
|
||||
entered.encode("utf-8"),
|
||||
stored.encode("utf-8"),
|
||||
)
|
||||
```
|
||||
|
||||
Như vậy phép so sánh hoạt động trên UTF-8 bytes.
|
||||
|
||||
---
|
||||
|
||||
# 12. Bài học tổng quát: API an toàn hơn có thể có input hẹp hơn
|
||||
|
||||
Đây là rule quan trọng cần nhớ khi review security.
|
||||
|
||||
Một API mới có thể:
|
||||
|
||||
```text
|
||||
an toàn hơn
|
||||
```
|
||||
|
||||
nhưng đồng thời:
|
||||
|
||||
```text
|
||||
nhận ít loại input hơn
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
==
|
||||
↓
|
||||
compare_digest()
|
||||
```
|
||||
|
||||
`compare_digest()` tốt hơn về timing attack, nhưng có thêm ràng buộc về kiểu dữ liệu/input.
|
||||
|
||||
---
|
||||
|
||||
## Trước khi thay một API bằng phiên bản "an toàn hơn", phải kiểm tra
|
||||
|
||||
### 1. API mới nhận kiểu dữ liệu nào?
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* `str`;
|
||||
* `bytes`;
|
||||
* ASCII;
|
||||
* Unicode;
|
||||
* `None`;
|
||||
* empty string.
|
||||
|
||||
### 2. Input thật của app có nằm trong miền đó không?
|
||||
|
||||
Phải kiểm tra:
|
||||
|
||||
* EN;
|
||||
* VI;
|
||||
* JA;
|
||||
* Unicode;
|
||||
* độ dài;
|
||||
* `None`;
|
||||
* empty;
|
||||
* boundary values.
|
||||
|
||||
### 3. Input ngoài miền sẽ xảy ra chuyện gì?
|
||||
|
||||
API mới có thể:
|
||||
|
||||
```text
|
||||
return False
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```text
|
||||
raise TypeError
|
||||
```
|
||||
|
||||
Không được giả định behavior.
|
||||
|
||||
### 4. Có regression test cho input đó chưa?
|
||||
|
||||
Đặc biệt phải test các input trước đây API cũ chấp nhận nhưng API mới có thể không chấp nhận.
|
||||
|
||||
---
|
||||
|
||||
# 13. Checklist nhanh cho `security-defect-fixer`
|
||||
|
||||
Trước khi tạo `fix_plan`, kiểm tra:
|
||||
|
||||
* [ ] Credential có đang nằm trong source code không?
|
||||
* [ ] Credential có xuất hiện trong Git history không?
|
||||
* [ ] Secret có nên nằm trong `SecretStore` không?
|
||||
* [ ] Có thể dùng `provider_key()` hoặc helper `*_key()` hiện có không?
|
||||
* [ ] UI có dùng `has()` thay vì `get()` để kiểm tra trạng thái không?
|
||||
* [ ] Có xử lý `KeyringAdapter.available == False` không?
|
||||
* [ ] Migration có backup trước không?
|
||||
* [ ] Migration có chỉ nâng version không?
|
||||
* [ ] Mỗi migration có một step rõ ràng không?
|
||||
* [ ] Migration có dừng khi không thể nâng version không?
|
||||
* [ ] Có đang dùng `.get(key, fallback)` sai trên config đã deep-merge không?
|
||||
* [ ] Credential rỗng có bị chặn trước khi compare không?
|
||||
* [ ] Nếu dùng `compare_digest()`, input có thể là Unicode không?
|
||||
* [ ] Có chuyển credential sang UTF-8 bytes khi cần không?
|
||||
* [ ] Có test `None`, empty, Unicode, long và boundary input không?
|
||||
* [ ] Có cần environment variable override không?
|
||||
* [ ] Có quyết định product/security nào cần Cowork Team không?
|
||||
* [ ] `security_review: required` đã được ghi trong `fix_plan` chưa?
|
||||
|
||||
---
|
||||
|
||||
# 14. Nguyên tắc cuối cùng
|
||||
|
||||
Khi xử lý credential, luôn đi theo chuỗi:
|
||||
|
||||
```text
|
||||
Defect
|
||||
↓
|
||||
Xác định credential thật hay chỉ là UI guard
|
||||
↓
|
||||
Xác định nơi credential đang được lưu
|
||||
↓
|
||||
Trace 4 bước:
|
||||
generate → store → read → compare
|
||||
↓
|
||||
Kiểm tra config deep-merge / DEFAULT_CONFIG
|
||||
↓
|
||||
Kiểm tra empty-input bypass
|
||||
↓
|
||||
Kiểm tra miền input của API bảo mật
|
||||
↓
|
||||
Kiểm tra migration + backward compatibility
|
||||
↓
|
||||
Kiểm tra Git history
|
||||
↓
|
||||
Xác định quyết định cần Cowork Team
|
||||
↓
|
||||
Tạo fix_plan
|
||||
↓
|
||||
security_review: required
|
||||
```
|
||||
|
||||
**Không tự thiết kế policy bảo mật thay cho Cowork Team.**
|
||||
|
||||
Agent chịu trách nhiệm:
|
||||
|
||||
```text
|
||||
phát hiện
|
||||
→ phân tích
|
||||
→ chứng minh root cause
|
||||
→ đề xuất phương án
|
||||
→ ghi rõ rủi ro
|
||||
→ route đúng
|
||||
```
|
||||
|
||||
Agent **không tự quyết** những vấn đề thuộc policy, product hoặc security governance.
|
||||
@@ -1,665 +0,0 @@
|
||||
# Theme & Design Tokens — Luật màu sắc của Cowork Local
|
||||
|
||||
> Knowledge module dành cho các agent xử lý **UI Visual / Theme / QSS** của Cowork Local.
|
||||
|
||||
## Nguồn chính
|
||||
|
||||
* `theme/__init__.py` — docstring và API theme
|
||||
* `theme/palettes.py` — định nghĩa Palette/token
|
||||
* `theme/qss.py` — `_TEMPLATE` và stylesheet
|
||||
* `theme/qss_controls.py` — style cho các Qt controls
|
||||
|
||||
---
|
||||
|
||||
# 1. Luật quan trọng nhất
|
||||
|
||||
> **Ngoài thư mục `theme/`, không file nào được tự định nghĩa màu.**
|
||||
|
||||
Luồng màu chuẩn của Cowork Local:
|
||||
|
||||
```text
|
||||
Palette
|
||||
↓
|
||||
token ngữ nghĩa
|
||||
↓
|
||||
_TEMPLATE
|
||||
↓
|
||||
stylesheet(theme)
|
||||
↓
|
||||
QApplication.setStyleSheet(...)
|
||||
```
|
||||
|
||||
Nói đơn giản:
|
||||
|
||||
> **Widget không tự chọn màu. Theme quyết định màu.**
|
||||
|
||||
---
|
||||
|
||||
# 2. Hai cách hợp lệ để widget có màu
|
||||
|
||||
## Cách 1 — Style bằng QSS
|
||||
|
||||
Đây là cách mặc định.
|
||||
|
||||
Widget đặt `objectName`, sau đó style được định nghĩa trong:
|
||||
|
||||
```text
|
||||
theme/qss.py
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
widget.setObjectName("my_widget")
|
||||
```
|
||||
|
||||
và style tương ứng nằm trong `_TEMPLATE`.
|
||||
|
||||
---
|
||||
|
||||
## Cách 2 — Widget tự vẽ bằng `QPainter`
|
||||
|
||||
Dùng cho các thành phần như:
|
||||
|
||||
* chart;
|
||||
* canvas;
|
||||
* syntax highlighter;
|
||||
* custom painting.
|
||||
|
||||
Code phải lấy màu từ:
|
||||
|
||||
```python
|
||||
current_palette()
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
palette = current_palette()
|
||||
```
|
||||
|
||||
Sau đó dùng token từ palette.
|
||||
|
||||
---
|
||||
|
||||
# 3. Những cách KHÔNG được phép
|
||||
|
||||
Không được tự đặt màu trong UI code.
|
||||
|
||||
### ❌ Hardcode HEX
|
||||
|
||||
```python
|
||||
self.label.setStyleSheet("color: #dc2626;")
|
||||
```
|
||||
|
||||
### ❌ Hardcode tên màu
|
||||
|
||||
```python
|
||||
pen.setColor(QColor("red"))
|
||||
```
|
||||
|
||||
### ❌ Hardcode RGBA
|
||||
|
||||
```python
|
||||
self.card.setStyleSheet(
|
||||
"background: rgba(0,0,0,.1)"
|
||||
)
|
||||
```
|
||||
|
||||
Các trường hợp này phải bị reject khi review.
|
||||
|
||||
### Rule ngắn gọn
|
||||
|
||||
```text
|
||||
Không có màu literal ngoài theme/
|
||||
```
|
||||
|
||||
Không chỉ tránh `#hex`, mà cả:
|
||||
|
||||
* tên màu;
|
||||
* RGB;
|
||||
* RGBA;
|
||||
* stylesheet cục bộ chứa màu.
|
||||
|
||||
---
|
||||
|
||||
# 4. API Theme cần nhớ
|
||||
|
||||
| API | Dùng để |
|
||||
| ------------------------------- | --------------------------------------------------- |
|
||||
| `theme.stylesheet(theme)` | Tạo QSS cho toàn app |
|
||||
| `theme.set_active_theme(theme)` | Ghi nhận theme hiện đang active |
|
||||
| `theme.current_theme()` | Lấy theme hiện tại: `dark` / `light` |
|
||||
| `theme.current_palette()` | Lấy Palette của theme hiện tại |
|
||||
| `theme.palette(theme)` | Lấy Palette của một theme cụ thể |
|
||||
| `theme.resolve_theme("system")` | Xác định dark/light theo OS |
|
||||
| `theme.role_colors(theme)` | Lấy màu theo role: user/assistant/tool/result/error |
|
||||
|
||||
---
|
||||
|
||||
## Khi đổi theme
|
||||
|
||||
Hai lệnh này phải đi cùng nhau:
|
||||
|
||||
```python
|
||||
theme.set_active_theme(theme)
|
||||
app.setStyleSheet(theme.stylesheet(theme))
|
||||
```
|
||||
|
||||
Không được chỉ gọi `setStyleSheet()` mà quên cập nhật active theme.
|
||||
|
||||
---
|
||||
|
||||
# 5. `current_palette()` dùng để làm gì?
|
||||
|
||||
Code vẽ bằng `QPainter` phải dùng:
|
||||
|
||||
```python
|
||||
current_palette()
|
||||
```
|
||||
|
||||
Không được mỗi lần `paintEvent()` lại đọc:
|
||||
|
||||
```text
|
||||
config.json
|
||||
```
|
||||
|
||||
Lý do:
|
||||
|
||||
```text
|
||||
paintEvent()
|
||||
↓
|
||||
repaint
|
||||
↓
|
||||
đọc config
|
||||
↓
|
||||
lặp lại rất nhiều lần
|
||||
```
|
||||
|
||||
Điều này từng gây vấn đề hiệu năng thực tế.
|
||||
|
||||
Vì vậy:
|
||||
|
||||
> `current_palette()` tồn tại để custom painting lấy màu nhanh từ theme hiện tại.
|
||||
|
||||
---
|
||||
|
||||
# 6. Palette và Design Token
|
||||
|
||||
`Palette` là:
|
||||
|
||||
```python
|
||||
@dataclass(frozen=True)
|
||||
```
|
||||
|
||||
Token phải mang **ý nghĩa**, không phải tên màu.
|
||||
|
||||
### ❌ Không đặt token kiểu:
|
||||
|
||||
```text
|
||||
blue
|
||||
grey2
|
||||
dark_blue
|
||||
light_grey
|
||||
```
|
||||
|
||||
### ✅ Đặt theo vai trò:
|
||||
|
||||
```text
|
||||
accent
|
||||
danger
|
||||
text
|
||||
text_muted
|
||||
surface
|
||||
surface_raised
|
||||
```
|
||||
|
||||
Lợi ích:
|
||||
|
||||
> Thêm theme mới = thêm một `Palette`, không phải viết lại stylesheet.
|
||||
|
||||
---
|
||||
|
||||
# 7. Các nhóm token chính
|
||||
|
||||
## 7.1. Surface — các mức bề mặt
|
||||
|
||||
| Token | Dùng cho |
|
||||
| ---------------- | -------------------------------------------- |
|
||||
| `bg` | Nền chính của cửa sổ/canvas |
|
||||
| `surface` | Panel, card, group box |
|
||||
| `surface_raised` | Input, list, tree — nơi người dùng nhập/chọn |
|
||||
| `overlay` | Menu, tooltip, popup |
|
||||
| `sunken` | Log, code, terminal — vùng chủ yếu để đọc |
|
||||
| `hover` | Trạng thái hover |
|
||||
| `active` | Trạng thái đang active/pressed |
|
||||
|
||||
### Lưu ý
|
||||
|
||||
`surface` **không có nghĩa là nav rail**.
|
||||
|
||||
Nav rail có chủ đích riêng về độ sáng/tối.
|
||||
|
||||
---
|
||||
|
||||
## 7.2. Text
|
||||
|
||||
Các token chính:
|
||||
|
||||
```text
|
||||
text
|
||||
text_muted
|
||||
...
|
||||
```
|
||||
|
||||
Dùng token theo vai trò thay vì tự chọn màu.
|
||||
|
||||
---
|
||||
|
||||
## 7.3. Accent
|
||||
|
||||
Có hai token:
|
||||
|
||||
```text
|
||||
accent
|
||||
accent_solid
|
||||
```
|
||||
|
||||
**Hai token này khác nhau có chủ đích.**
|
||||
|
||||
### `accent`
|
||||
|
||||
Dùng cho accent thông thường, ví dụ:
|
||||
|
||||
* trạng thái;
|
||||
* thành phần UI;
|
||||
* điểm nhấn.
|
||||
|
||||
### `accent_solid`
|
||||
|
||||
Dùng khi accent trở thành **nền đặc và bên trên có chữ**.
|
||||
|
||||
Lý do:
|
||||
|
||||
> Một màu accent có thể đủ sáng để đọc khi dùng như chữ trên nền tối, nhưng lại quá sáng khi dùng làm nền cho chữ trắng.
|
||||
|
||||
Vì vậy:
|
||||
|
||||
```text
|
||||
Chữ trên nền accent đặc
|
||||
↓
|
||||
accent_solid
|
||||
```
|
||||
|
||||
Không tự lấy `accent` chỉ vì nó có vẻ "cùng màu".
|
||||
|
||||
---
|
||||
|
||||
## 7.4. State
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
danger
|
||||
...
|
||||
```
|
||||
|
||||
Các state token cũng phải mang ý nghĩa, không đặt theo tên màu.
|
||||
|
||||
---
|
||||
|
||||
## 7.5. Conversation roles
|
||||
|
||||
Có các token:
|
||||
|
||||
```text
|
||||
role_user
|
||||
role_assistant
|
||||
role_tool
|
||||
role_result
|
||||
role_error
|
||||
```
|
||||
|
||||
Dùng để phân biệt các role trong giao diện hội thoại.
|
||||
|
||||
---
|
||||
|
||||
## 7.6. Code / Syntax
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
code_string
|
||||
...
|
||||
```
|
||||
|
||||
Dùng cho syntax highlighting.
|
||||
|
||||
---
|
||||
|
||||
# 8. Các nguyên tắc thiết kế — đừng nhầm thành bug
|
||||
|
||||
Một số đặc điểm nhìn "khác mắt" nhưng **có chủ đích**.
|
||||
|
||||
Không được tự ý sửa chỉ vì người dùng nói "trông hơi tối" hoặc "không giống app hiện đại".
|
||||
|
||||
---
|
||||
|
||||
## 8.1. Không gradient, không glow
|
||||
|
||||
Thiết kế lấy cảm hứng từ:
|
||||
|
||||
```text
|
||||
VS Code Dark Modern
|
||||
VS Code Light Modern
|
||||
```
|
||||
|
||||
Phong cách chính:
|
||||
|
||||
* surface phẳng;
|
||||
* góc gần vuông;
|
||||
* không gradient;
|
||||
* không glow;
|
||||
* một accent chính;
|
||||
* accent dành cho thứ người dùng tương tác.
|
||||
|
||||
---
|
||||
|
||||
## 8.2. Độ sâu đến từ surface và border
|
||||
|
||||
Không tạo chiều sâu bằng cách:
|
||||
|
||||
```text
|
||||
đổi màu quá mạnh
|
||||
```
|
||||
|
||||
Thay vào đó dùng:
|
||||
|
||||
```text
|
||||
surface hierarchy
|
||||
+
|
||||
border mảnh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 9. Nav rail tối hơn là thiết kế có chủ đích
|
||||
|
||||
Silhouette của Cowork Local lấy theo VS Code:
|
||||
|
||||
```text
|
||||
NAV RAIL
|
||||
↓
|
||||
tối hơn
|
||||
↓
|
||||
CONTENT AREA
|
||||
```
|
||||
|
||||
Không phải:
|
||||
|
||||
```text
|
||||
nav rail sáng hơn content
|
||||
```
|
||||
|
||||
Vì vậy nếu user báo:
|
||||
|
||||
> "Menu bên trái tối quá."
|
||||
|
||||
thì **chưa được kết luận ngay là visual bug**.
|
||||
|
||||
Đây có thể là design intent.
|
||||
|
||||
Xem thêm:
|
||||
|
||||
```text
|
||||
examples/bad_fix.md
|
||||
```
|
||||
|
||||
để tránh sửa nhầm.
|
||||
|
||||
---
|
||||
|
||||
# 10. Contrast — WCAG AA
|
||||
|
||||
Body text và chữ trên button nền đặc phải đạt:
|
||||
|
||||
```text
|
||||
Contrast ratio ≥ 4.5:1
|
||||
```
|
||||
|
||||
Đây là yêu cầu tối thiểu.
|
||||
|
||||
Khi thay token/màu:
|
||||
|
||||
```text
|
||||
Dark theme
|
||||
+
|
||||
Light theme
|
||||
+
|
||||
text/background
|
||||
```
|
||||
|
||||
đều phải được kiểm tra.
|
||||
|
||||
---
|
||||
|
||||
## Không khôi phục màu VS Code cũ nếu màu đó không đạt AA
|
||||
|
||||
Một số màu gốc của VS Code không đạt yêu cầu AA.
|
||||
|
||||
Các giá trị đã được Cowork Local điều chỉnh vừa đủ, ví dụ:
|
||||
|
||||
| Trường hợp | Contrast cũ |
|
||||
| ------------------------ | ----------: |
|
||||
| Dark line | 3.59:1 |
|
||||
| Chữ mờ trên sidebar sáng | 4.28:1 |
|
||||
| Xanh lá sáng | 4.33:1 |
|
||||
| Hổ phách sáng | 3.12:1 |
|
||||
|
||||
Các chỗ này có comment ghi lại giá trị gốc.
|
||||
|
||||
### Rule
|
||||
|
||||
**Không đưa chúng trở lại giá trị VS Code ban đầu.**
|
||||
|
||||
Mục tiêu của Cowork Local là:
|
||||
|
||||
```text
|
||||
VS Code silhouette
|
||||
+
|
||||
WCAG AA
|
||||
```
|
||||
|
||||
không phải copy nguyên xi mọi giá trị màu của VS Code.
|
||||
|
||||
---
|
||||
|
||||
# 11. ⚠️ Combo Box và `_chevron_asset`
|
||||
|
||||
Một lỗi dễ gặp:
|
||||
|
||||
> Combo box mất mũi tên.
|
||||
|
||||
Nguyên nhân liên quan đến cách Qt xử lý QSS.
|
||||
|
||||
---
|
||||
|
||||
## 11.1. `image:` trong QSS không nhận `QPixmap`
|
||||
|
||||
QSS:
|
||||
|
||||
```text
|
||||
image:
|
||||
```
|
||||
|
||||
chỉ nhận đường dẫn tới:
|
||||
|
||||
* file;
|
||||
* resource.
|
||||
|
||||
Không nhận trực tiếp:
|
||||
|
||||
```text
|
||||
QPixmap
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11.2. Style `::drop-down` sẽ làm Qt ngừng vẽ arrow mặc định
|
||||
|
||||
Khi style các selector như:
|
||||
|
||||
```text
|
||||
::drop-down
|
||||
::up-button
|
||||
::down-button
|
||||
```
|
||||
|
||||
Qt có thể ngừng vẽ mũi tên mặc định.
|
||||
|
||||
---
|
||||
|
||||
## 11.3. Cowork Local dùng `_chevron_asset`
|
||||
|
||||
Trong:
|
||||
|
||||
```text
|
||||
theme/palettes.py
|
||||
```
|
||||
|
||||
`_chevron_asset`:
|
||||
|
||||
1. render chevron thành PNG;
|
||||
2. lưu vào thư mục tạm;
|
||||
3. cache theo:
|
||||
|
||||
```text
|
||||
(direction, color)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Khi debug combo box
|
||||
|
||||
Nếu thấy:
|
||||
|
||||
> Combo box mất mũi tên.
|
||||
|
||||
Hãy kiểm tra trước:
|
||||
|
||||
```text
|
||||
stylesheet cục bộ
|
||||
↓
|
||||
::drop-down
|
||||
```
|
||||
|
||||
Đây thường là nguyên nhân.
|
||||
|
||||
Cache nằm tại:
|
||||
|
||||
```text
|
||||
%TEMP%/cowork_local_theme/chevron_*.png
|
||||
```
|
||||
|
||||
Nếu đang test màu mới, có thể xóa cache để buộc render lại.
|
||||
|
||||
---
|
||||
|
||||
# 12. Checklist sửa bug màu sắc/theme
|
||||
|
||||
Trước khi hoàn thành visual fix, kiểm tra:
|
||||
|
||||
### Theme coverage
|
||||
|
||||
* [ ] Bug đã được kiểm tra trên **Dark** chưa?
|
||||
* [ ] Bug đã được kiểm tra trên **Light** chưa?
|
||||
* [ ] Có thể dùng screenshot:
|
||||
|
||||
* `docs/screens/*-dark.png`
|
||||
* `docs/screens/*-light.png`
|
||||
|
||||
### Token
|
||||
|
||||
* [ ] Patch dùng semantic token thay vì hex literal?
|
||||
* [ ] Không có `setStyleSheet()` cục bộ để thay màu?
|
||||
* [ ] Không có `QColor("red")`, `QColor("blue")`, v.v.?
|
||||
* [ ] Nếu thêm token mới, đã thêm cho **cả `DARK` và `LIGHT`**?
|
||||
* [ ] Token mới có tên theo **ý nghĩa**, không theo màu?
|
||||
|
||||
### Accent
|
||||
|
||||
* [ ] Chữ trên nền accent đặc đã dùng `accent_solid`?
|
||||
* [ ] Không dùng `accent` chỉ vì hai token có vẻ giống nhau?
|
||||
|
||||
### Accessibility
|
||||
|
||||
* [ ] Contrast đạt **≥ 4.5:1**?
|
||||
* [ ] Đã kiểm tra cả text và button có nền đặc?
|
||||
|
||||
### Theme lifecycle
|
||||
|
||||
* [ ] Widget tạo sau khi đổi theme có nhận đúng stylesheet?
|
||||
* [ ] Đã kiểm tra vấn đề lazy screen theo `qt_pitfalls.md` **P07**?
|
||||
|
||||
### Design intent
|
||||
|
||||
* [ ] Không vô tình thêm gradient?
|
||||
* [ ] Không thêm glow?
|
||||
* [ ] Không làm nav rail sáng hơn content?
|
||||
* [ ] Không khôi phục các màu VS Code cũ đã bị loại vì không đạt WCAG AA?
|
||||
|
||||
---
|
||||
|
||||
# 13. Quy tắc review nhanh
|
||||
|
||||
Khi gặp một defect liên quan màu sắc, đi theo thứ tự:
|
||||
|
||||
```text
|
||||
1. Xác định widget
|
||||
↓
|
||||
2. Kiểm tra objectName
|
||||
↓
|
||||
3. Tìm rule trong theme/qss.py
|
||||
↓
|
||||
4. Kiểm tra token trong palettes.py
|
||||
↓
|
||||
5. Kiểm tra DARK + LIGHT
|
||||
↓
|
||||
6. Kiểm tra contrast
|
||||
↓
|
||||
7. Kiểm tra local setStyleSheet()
|
||||
↓
|
||||
8. Kiểm tra lazy theme lifecycle (P07)
|
||||
↓
|
||||
9. Xác định đây là bug thật hay design intent
|
||||
↓
|
||||
10. Chỉ sau đó mới tạo fix_plan
|
||||
```
|
||||
|
||||
## Nguyên tắc cuối
|
||||
|
||||
```text
|
||||
UI code
|
||||
↓
|
||||
không tự chọn màu
|
||||
↓
|
||||
semantic token
|
||||
↓
|
||||
Palette
|
||||
↓
|
||||
_TEMPLATE / current_palette()
|
||||
↓
|
||||
theme
|
||||
```
|
||||
|
||||
**Nếu một màu mới cần xuất hiện, trước tiên hỏi:**
|
||||
|
||||
> "Màu này đang đại diện cho vai trò gì?"
|
||||
|
||||
Sau đó tạo hoặc dùng **semantic token** phù hợp.
|
||||
|
||||
Không hỏi:
|
||||
|
||||
> "Mình muốn màu xanh nào?"
|
||||
|
||||
Vì trong Cowork Local, **ý nghĩa của màu quan trọng hơn bản thân màu**.
|
||||
@@ -1,106 +0,0 @@
|
||||
# Output Contract — `defect_record`
|
||||
|
||||
Do `ui-bug-triage` sinh ra. Giữ **đúng** thứ tự và tên mục. Không có dữ liệu thì ghi
|
||||
`unknown` hoặc `N/A` kèm lý do — **không xoá mục**.
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
---
|
||||
defect_id: UI-<YYYYMMDD>-<NN>
|
||||
from_agent: ui-bug-triage
|
||||
next_agent: <ui-visual-fixer | ux-flow-fixer | i18n-a11y-fixer | RETURN_TO_REPORTER>
|
||||
category: <visual | flow | i18n-a11y | not-ui>
|
||||
severity: <S1 | S2 | S3 | S4>
|
||||
confidence: <low | medium | high>
|
||||
reproducible: <yes | no | intermittent>
|
||||
security_review: <required | not-required>
|
||||
affected_files: []
|
||||
themes_verified: []
|
||||
languages_verified: []
|
||||
blocked_on: []
|
||||
---
|
||||
```
|
||||
|
||||
# 1. Tóm tắt
|
||||
|
||||
Một câu: cái gì hỏng, ở màn nào, với ai.
|
||||
|
||||
# 2. Quan sát vs kỳ vọng
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Người dùng thấy** | |
|
||||
| **Người dùng mong** | |
|
||||
| **Người dùng suy đoán (chưa xác minh)** | |
|
||||
|
||||
# 3. Môi trường
|
||||
|
||||
| Trường | Giá trị |
|
||||
|---|---|
|
||||
| Phiên bản app / commit | |
|
||||
| OS + độ phân giải + mức scale | |
|
||||
| Theme lúc xảy ra | |
|
||||
| Ngôn ngữ lúc xảy ra | |
|
||||
| Project / workspace liên quan | (mô tả, **không** nêu tên khách hàng) |
|
||||
|
||||
# 4. Các bước tái hiện
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
**Tỉ lệ tái hiện:** _luôn / thỉnh thoảng (n/m lần) / không_
|
||||
|
||||
# 5. Ma trận biến thể đã thử
|
||||
|
||||
| Biến thể | Đã thử | Kết quả |
|
||||
|---|---|---|
|
||||
| Theme dark | | |
|
||||
| Theme light | | |
|
||||
| Ngôn ngữ vi / ja / en | | |
|
||||
| Cửa sổ nhỏ nhất / maximize | | |
|
||||
| Đổi theme/ngôn ngữ **trước** rồi mới mở màn (bẫy P07) | | |
|
||||
|
||||
# 6. Khoanh vùng
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Nav row | Dashboard / Schedule / Workspace / Monitoring |
|
||||
| Sub-tab / dialog | |
|
||||
| `manifest.json` slug | |
|
||||
| Widget dựng tại | `file.py:line` |
|
||||
| Control (`controls.json`) | `var`, `type`, `object_name` |
|
||||
| Đã kiểm cả `ui/` và `presentation/` | có / không |
|
||||
|
||||
# 7. Giả thuyết nguyên nhân gốc
|
||||
|
||||
| # | Giả thuyết | Mã pitfall | Đã xác minh thế nào | Còn / loại |
|
||||
|---|---|---|---|---|
|
||||
| 1 | | P__ | | |
|
||||
| 2 | | P__ | | |
|
||||
|
||||
**Kết luận:** _(một nguyên nhân + `file:line`, hoặc "chưa xác định" nếu `confidence: low`)_
|
||||
|
||||
# 8. Tác động
|
||||
|
||||
- Ai bị ảnh hưởng:
|
||||
- Chặn công việc gì:
|
||||
- Có đường vòng không:
|
||||
- Lý do chọn mức `severity` này:
|
||||
|
||||
# 9. Cân nhắc bảo mật
|
||||
|
||||
- Chạm permission / credential / monitoring bảo mật / isolation / routing? _có / không_
|
||||
- Dữ liệu người dùng gửi lên đã redact? _có / không — mô tả đã bỏ gì_
|
||||
- Có dấu hiệu ở `system/security.md` S4 không?
|
||||
|
||||
# 10. Open Questions (tối đa 3)
|
||||
|
||||
| # | Câu hỏi | Mặc định nếu không trả lời | Có chặn không |
|
||||
|---|---|---|---|
|
||||
| 1 | | | có / không |
|
||||
|
||||
# 11. Out of scope
|
||||
|
||||
Vấn đề khác phát hiện được, **không** sửa trong lần này — đề xuất issue riêng.
|
||||
@@ -1,75 +0,0 @@
|
||||
# Output Contract — `dispatch_plan`
|
||||
|
||||
Do `fix-dispatcher` sinh ra, trước khi bất kỳ agent nào khác chạy.
|
||||
Đây là thứ quyết định **effort** của cả lượt xử lý, nên nó phải chứng minh được lựa chọn
|
||||
của mình — nhưng phải ngắn. Trần: **30 dòng** cho phần người đọc.
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
---
|
||||
report_id: RPT-<YYYYMMDD>-<NN> # một phản ánh của người dùng = một report_id
|
||||
defects:
|
||||
- defect_id: UI-<YYYYMMDD>-<NN>
|
||||
tier: <T0 | T1 | T2 | T3 | T3-SEC>
|
||||
lane: <DIRECT | SOLO | PAIR | FULL | FULL-SEC>
|
||||
category: <visual | flow | i18n-a11y | security | not-ui>
|
||||
severity: <S1 | S2 | S3 | S4>
|
||||
confidence: <low | medium | high>
|
||||
reproducible: <yes | no | intermittent>
|
||||
security_review: <required | not-required>
|
||||
entry_agent: <fix-implementer | ui-visual-fixer | ux-flow-fixer | i18n-a11y-fixer | security-defect-fixer | ui-bug-triage | SELF | RETURN_TO_REPORTER>
|
||||
affected_files: [path/to/file.py:123]
|
||||
tier_evidence: "<dòng nào của roles/0_fix_dispatcher.md Bước 3 đã trúng>"
|
||||
budget_calls: <số lần gọi agent dự kiến>
|
||||
execution:
|
||||
parallel: [[UI-...-01, UI-...-02]] # các defect_id độc lập, chạy cùng lúc
|
||||
sequential: [UI-...-03] # phụ thuộc, hoặc T3 cần triage trước
|
||||
blocked_on: []
|
||||
---
|
||||
```
|
||||
|
||||
# 1. Phản ánh gốc
|
||||
|
||||
Nguyên văn của người báo lỗi, **đã redact** (`system/security.md`). Không diễn giải lại.
|
||||
|
||||
# 2. Tách defect
|
||||
|
||||
| defect_id | Triệu chứng người dùng thấy | Category | Tier |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
Một dòng = một nguyên nhân gốc. Chỉ có một defect thì bảng có một dòng — không xoá bảng.
|
||||
|
||||
# 3. Bằng chứng chấm tier
|
||||
|
||||
Mỗi defect **một dòng**, trích đúng tiêu chí đã trúng. Không được viết "trông đơn giản".
|
||||
|
||||
| defect_id | Tier | Trúng tiêu chí | Lệnh đã dùng để xác nhận |
|
||||
|---|---|---|---|
|
||||
| | T0 | loại 1 (số đo hiển thị), 0 disqualifier | `check_loc.py`, `grep -rn` blast radius |
|
||||
| | T2 | "chạm QSS/token dùng chung" | `grep -rn "<objectName>"` |
|
||||
|
||||
Với **T0** bắt buộc có cột lệnh — Gate S và blast radius phải đo, không được ước lượng.
|
||||
|
||||
# 4. Kế hoạch chạy
|
||||
|
||||
```text
|
||||
UI-...-01 T0 DIRECT → hub sửa luôn, cổng máy §4.1
|
||||
UI-...-02 T2 PAIR → ui-visual-fixer → fix-implementer → regression-reviewer
|
||||
UI-...-03 T3 FULL → ui-bug-triage → ... (chờ triage mới biết specialist nào)
|
||||
```
|
||||
|
||||
Ngân sách tổng: `___` lần gọi agent (bảng §4 của role 0 cho phép `___`).
|
||||
|
||||
# 5. Điều đã cố ý KHÔNG làm
|
||||
|
||||
- Không gọi `ui-bug-triage` cho defect nào? Vì sao được phép bỏ (phản ánh đã tự chỉ ra
|
||||
màn hình + triệu chứng cụ thể).
|
||||
- Không gọi `regression-reviewer` cho defect nào? Chỉ hợp lệ ở T0/T1 — nêu rõ cổng nào
|
||||
thay thế.
|
||||
|
||||
# 6. Open question
|
||||
|
||||
Tối đa 3, mỗi câu kèm phương án mặc định nếu người dùng không trả lời
|
||||
(`response_policy.md` R3). Câu hỏi **chặn** thì đưa vào `blocked_on`.
|
||||
@@ -1,114 +0,0 @@
|
||||
# Output Contract — `fix_plan`
|
||||
|
||||
Do `ui-visual-fixer` / `ux-flow-fixer` / `i18n-a11y-fixer` sinh ra.
|
||||
Đây là thứ `fix-implementer` thi hành — mơ hồ chỗ nào thì chỗ đó sẽ bị đoán bừa.
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
---
|
||||
defect_id: UI-<YYYYMMDD>-<NN>
|
||||
from_agent: <tên specialist>
|
||||
next_agent: <fix-implementer | RETURN_TO_REPORTER>
|
||||
root_cause_file: path/to/file.py:123
|
||||
root_cause_pitfall: P__
|
||||
confidence: <medium | high>
|
||||
security_review: <required | not-required>
|
||||
loc_risk: <none | near-limit | exceeds>
|
||||
blast_radius: [] # màn/widget khác dùng chung phần bị sửa
|
||||
---
|
||||
```
|
||||
|
||||
# 1. Nguyên nhân gốc
|
||||
|
||||
**Đúng một.** Nêu `file:line`, trích đoạn code, và giải thích *tại sao dòng đó sinh ra
|
||||
triệu chứng người dùng thấy*.
|
||||
|
||||
```python
|
||||
# path/to/file.py:118
|
||||
```
|
||||
|
||||
**Vì sao đây là nguyên nhân gốc chứ không phải triệu chứng:**
|
||||
|
||||
**Các giả thuyết đã loại và lý do loại:**
|
||||
|
||||
# 2. Ràng buộc thiết kế đã kiểm
|
||||
|
||||
- [ ] Không mâu thuẫn với ràng buộc có chủ ý ở `theme_tokens.md` §4.
|
||||
- [ ] Nếu phản ánh của người dùng thực ra là thiết kế đúng: nêu ở đây và chuyển
|
||||
`next_agent: RETURN_TO_REPORTER`.
|
||||
|
||||
# 3. Phương án sửa
|
||||
|
||||
| # | File | Thay đổi | Vì sao chọn mức này |
|
||||
|---|---|---|---|
|
||||
| 1 | | | |
|
||||
|
||||
**Mức can thiệp đã chọn** (theo thang ưu tiên của role):
|
||||
|
||||
**Các phương án đã cân nhắc và bị loại:**
|
||||
|
||||
# 4. Diff dự kiến
|
||||
|
||||
```diff
|
||||
```
|
||||
|
||||
# 5. Ảnh hưởng lan toả
|
||||
|
||||
| Chỗ khác dùng chung | Đã kiểm | Kết luận |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
Lệnh đã chạy để tìm:
|
||||
|
||||
```bash
|
||||
grep -rn "<...>" --include=*.py .
|
||||
```
|
||||
|
||||
# 6. Ràng buộc kiến trúc
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Tầng bị sửa | presentation / ui / theme / i18n |
|
||||
| Có chạm `application/` hoặc `domain/` không | không — hoặc **lý do bắt buộc phải chạm** |
|
||||
| LOC file sau khi sửa | `___ / 400` |
|
||||
| Cần tách module không | có/không — nếu có, tách thế nào |
|
||||
| File mới có được import ngay không (Gate O) | |
|
||||
|
||||
# 7. i18n
|
||||
|
||||
| Key | en | ja | vi | File |
|
||||
|---|---|---|---|---|
|
||||
| | | | | `i18n/____.py` |
|
||||
|
||||
Không thêm chuỗi mới thì ghi `N/A`.
|
||||
|
||||
# 8. Cách kiểm chứng
|
||||
|
||||
## 8.1 Test tự động
|
||||
|
||||
```python
|
||||
# tests/ui/test_____.py
|
||||
def test_...(qtbot, ctx):
|
||||
"""Regression: <triệu chứng> (defect UI-...)."""
|
||||
```
|
||||
|
||||
Test này phải **đỏ** trước khi sửa. Nếu không viết được test tự động: nêu lý do cụ thể.
|
||||
|
||||
## 8.2 Kiểm bằng mắt
|
||||
|
||||
| Trục | Giá trị phải thử | Kết quả mong đợi |
|
||||
|---|---|---|
|
||||
| Theme | dark, light | |
|
||||
| Ngôn ngữ | | |
|
||||
| Kích thước cửa sổ | nhỏ nhất, maximize | |
|
||||
| Thứ tự thao tác | có kịch bản P07 | |
|
||||
|
||||
# 9. Rủi ro
|
||||
|
||||
| Rủi ro | Khả năng | Giảm thiểu |
|
||||
|---|---|---|
|
||||
|
||||
# 10. Out of scope
|
||||
|
||||
Cố ý **không** làm trong lần này, và vì sao.
|
||||
@@ -1,111 +0,0 @@
|
||||
# Output Contract — `fix_report`
|
||||
|
||||
Do `fix-implementer` sinh ra sau khi đã áp bản vá.
|
||||
Mục tiêu duy nhất: **trung thực** (`guardrail.md` G10). Reviewer sẽ chạy lại mọi thứ.
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
---
|
||||
defect_id: UI-<YYYYMMDD>-<NN>
|
||||
from_agent: fix-implementer
|
||||
next_agent: regression-reviewer
|
||||
branch: fix/ui-<slug>
|
||||
commits: []
|
||||
gate_result: <all-pass | partial | fail>
|
||||
tests_added: []
|
||||
visual_check: <done | not-done>
|
||||
security_review: <required | not-required>
|
||||
---
|
||||
```
|
||||
|
||||
# 1. Đã làm gì
|
||||
|
||||
| # | File | Thay đổi | Khớp mục nào trong fix_plan |
|
||||
|---|---|---|---|
|
||||
| 1 | | | §3.1 |
|
||||
|
||||
# 2. Diff
|
||||
|
||||
```bash
|
||||
git diff main...HEAD --stat
|
||||
```
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
# 3. Test regression
|
||||
|
||||
| File test | Tên test | Đỏ trước khi sửa | Xanh sau khi sửa |
|
||||
|---|---|---|---|
|
||||
| | | ✅ / ❌ | ✅ / ❌ |
|
||||
|
||||
Bằng chứng "đỏ trước":
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
Bằng chứng "xanh sau":
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
Nếu chưa chứng minh được "đỏ trước": **nói rõ**, đừng bỏ trống.
|
||||
|
||||
# 4. Kết quả CASAN gate
|
||||
|
||||
```bash
|
||||
python scripts/run_quality_gate.py
|
||||
```
|
||||
|
||||
Dán **output thật**, không tóm tắt:
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
| Cổng | Kết quả | Ghi chú |
|
||||
|---|---|---|
|
||||
| C — Clean Architecture | | |
|
||||
| A — Secrets | | |
|
||||
| S — LOC ≤ 400 | | LOC file lớn nhất: `___/400` |
|
||||
| O — Orphan module | | |
|
||||
| A/N — pytest | | |
|
||||
|
||||
## Test vốn đã đỏ TỪ TRƯỚC bản vá này
|
||||
|
||||
| Test | Lý do đỏ | Có liên quan bản vá không |
|
||||
|---|---|---|
|
||||
|
||||
# 5. Kiểm chứng bằng mắt
|
||||
|
||||
| Trục | Đã thử | Kết quả |
|
||||
|---|---|---|
|
||||
| dark | | |
|
||||
| light | | |
|
||||
| vi / ja / en | | |
|
||||
| cửa sổ nhỏ nhất / maximize | | |
|
||||
| kịch bản P07 | | |
|
||||
|
||||
Chưa chạy được app → ghi thẳng **"chưa kiểm chứng bằng mắt"** kèm lý do. Không suy đoán
|
||||
kết quả.
|
||||
|
||||
# 6. Lệch so với fix_plan
|
||||
|
||||
| Chỗ lệch | Vì sao |
|
||||
|---|---|
|
||||
|
||||
Không lệch thì ghi "không có".
|
||||
|
||||
# 7. Chưa làm được
|
||||
|
||||
| Việc | Vì sao | Đề xuất |
|
||||
|---|---|---|
|
||||
|
||||
# 8. Out of scope — phát hiện thêm khi sửa
|
||||
|
||||
Vấn đề khác nhìn thấy nhưng **không** sửa (G1, G8). Đề xuất mở issue riêng.
|
||||
|
||||
# 9. Bảo mật
|
||||
|
||||
- Có secret/PII lọt vào code, test fixture, commit message không? _đã kiểm — có/không_
|
||||
- Cờ `security_review` còn nguyên như plan? _có/không_
|
||||
@@ -1,88 +0,0 @@
|
||||
# Output Contract — `pr_body`
|
||||
|
||||
Do `regression-reviewer` sinh ra khi verdict là PASS / PASS_WITH_NOTES.
|
||||
Khớp **đúng** `.gitea/PULL_REQUEST_TEMPLATE.md` — giữ nguyên tiêu đề mục để reviewer quen mắt.
|
||||
|
||||
Tiêu đề PR: `fix(ui): <mô tả ngắn, tiếng Anh, thể mệnh lệnh>`
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
_Nói **tại sao**, không chỉ **cái gì**. Nêu triệu chứng người dùng, nguyên nhân gốc kèm
|
||||
`file:line`, và vì sao chọn cách sửa này._
|
||||
|
||||
Root cause: `path/to/file.py:123` (pitfall P__)
|
||||
Defect: `UI-<YYYYMMDD>-<NN>`
|
||||
|
||||
## Change Type
|
||||
|
||||
- [ ] Cowork feature
|
||||
- [x] Bug fix
|
||||
- [ ] Core AI contribution
|
||||
- [ ] Test / hardening
|
||||
- [ ] Performance
|
||||
- [ ] Documentation
|
||||
|
||||
## Related Work
|
||||
|
||||
Cowork Task:
|
||||
|
||||
Core Repo: http://34.143.229.138/gitea-admin/fsg-ai-core-assets
|
||||
|
||||
Core AI Issue:
|
||||
|
||||
Core Task:
|
||||
|
||||
Related PR:
|
||||
|
||||
## Scope
|
||||
|
||||
**Cố ý bao gồm:**
|
||||
|
||||
**Cố ý KHÔNG bao gồm:** _(các phát hiện out-of-scope, kèm issue đề xuất)_
|
||||
|
||||
## Validation
|
||||
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests
|
||||
- [ ] Manual verification
|
||||
- [ ] Regression check
|
||||
|
||||
Commands / evidence:
|
||||
|
||||
```bash
|
||||
python scripts/run_quality_gate.py
|
||||
QT_QPA_PLATFORM=offscreen pytest tests/ui/test_<...>.py -q
|
||||
```
|
||||
|
||||
```
|
||||
<output thật>
|
||||
```
|
||||
|
||||
Ma trận kiểm bằng mắt:
|
||||
|
||||
| Trục | Kết quả |
|
||||
|---|---|
|
||||
| dark / light | |
|
||||
| vi / ja / en | |
|
||||
| cửa sổ nhỏ nhất / maximize | |
|
||||
|
||||
## Security Impact
|
||||
|
||||
_Permission / credential / network / customer data impact._
|
||||
|
||||
Điền cả khi là "không có". Nếu `security-review: required`: ghi rõ tại sao, và nhắc rằng
|
||||
**CI xanh không đủ để merge** (`docs/governance/review-policy.md`).
|
||||
|
||||
## Compatibility
|
||||
|
||||
- [ ] No breaking change
|
||||
- [ ] Breaking change documented
|
||||
|
||||
## Reviewer Notes
|
||||
|
||||
_Chỉ đúng chỗ cần soi kỹ nhất. Kèm các finding `should-fix` / `nit` mà reviewer agent đã
|
||||
ghi nhận nhưng không chặn merge._
|
||||
|
||||
Ảnh `docs/screens/` cần chụp lại: _có/không — liệt kê slug_
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,740 +0,0 @@
|
||||
---
|
||||
name: ui-bug-triage
|
||||
|
||||
description: >
|
||||
Chuyên gia tiếp nhận và phân loại bug UI/UX của Cowork Local.
|
||||
Biến mô tả bug chưa rõ ràng thành defect_record có thể tái hiện,
|
||||
xác định file:line, phân loại lỗi, đánh giá severity và route
|
||||
sang specialist phù hợp. Luôn chạy agent này đầu tiên khi có
|
||||
phản ánh liên quan đến giao diện.
|
||||
---
|
||||
|
||||
## WHEN TO USE
|
||||
|
||||
Gọi `ui-bug-triage` trước tiên đối với mọi vấn đề UI/UX do người dùng báo cáo hoặc mọi vấn đề giao diện được nghi ngờ. Không được gọi trực tiếp UI specialist trước khi thực hiện bước triage.
|
||||
|
||||
---
|
||||
|
||||
# ROLE
|
||||
|
||||
Bạn là **UI/UX Defect Triage Engineer** của Cowork Local.
|
||||
|
||||
Bạn là người đầu tiên xử lý mọi phản ánh UI/UX từ:
|
||||
|
||||
- PM
|
||||
- BRSE
|
||||
- BA
|
||||
- QA
|
||||
- Dev
|
||||
- Người dùng nội bộ
|
||||
|
||||
Nhiệm vụ của bạn là biến một mô tả mơ hồ như:
|
||||
|
||||
"Cái bảng bên phải nhìn kỳ lắm."
|
||||
|
||||
thành một `defect_record` mà specialist có thể tiếp tục xử lý mà không cần hỏi lại người báo lỗi.
|
||||
|
||||
Bạn **KHÔNG sửa code**.
|
||||
|
||||
Bạn chỉ:
|
||||
|
||||
1. Làm rõ triệu chứng.
|
||||
2. Tái hiện lỗi.
|
||||
3. Xác định màn hình/widget liên quan.
|
||||
4. Xác định `file:line`.
|
||||
5. Phân loại lỗi.
|
||||
6. Đánh giá severity.
|
||||
7. Xác định security review nếu cần.
|
||||
8. Route sang agent phù hợp.
|
||||
|
||||
---
|
||||
|
||||
# MISSION
|
||||
|
||||
Với mỗi bug report, tạo một `defect_record` hoàn chỉnh.
|
||||
|
||||
Một `defect_record` tốt phải trả lời được:
|
||||
|
||||
- Lỗi xảy ra ở đâu?
|
||||
- Người dùng đã làm gì?
|
||||
- Thực tế xảy ra chuyện gì?
|
||||
- Người dùng kỳ vọng điều gì?
|
||||
- Có tái hiện được không?
|
||||
- File/code nào liên quan?
|
||||
- Nguyên nhân có khả năng nằm ở đâu?
|
||||
- Đây là loại lỗi gì?
|
||||
- Severity bao nhiêu?
|
||||
- Có cần security review không?
|
||||
- Agent nào sẽ xử lý tiếp?
|
||||
|
||||
---
|
||||
|
||||
# KNOWLEDGE TO LOAD FIRST
|
||||
|
||||
Trước khi phân tích, đọc các file sau:
|
||||
|
||||
- `agent/system/guardrail.md`
|
||||
- `agent/system/security.md`
|
||||
- `agent/system/response_policy.md`
|
||||
- `agent/knowledge/screen_map.md` **(BẮT BUỘC)**
|
||||
- `agent/knowledge/project_map.md`
|
||||
- `agent/knowledge/qt_pitfalls.md`
|
||||
|
||||
`screen_map.md` là nguồn chính để xác định:
|
||||
|
||||
screen → sub-tab/dialog → widget → file:line
|
||||
|
||||
---
|
||||
|
||||
# INPUT
|
||||
|
||||
## Required
|
||||
|
||||
Mô tả bug của người dùng.
|
||||
|
||||
Ngôn ngữ có thể là:
|
||||
|
||||
- Vietnamese
|
||||
- Japanese
|
||||
- English
|
||||
|
||||
Mô tả có thể rất ngắn hoặc không đầy đủ.
|
||||
|
||||
## Optional
|
||||
|
||||
Có thể có thêm:
|
||||
|
||||
- Screenshot
|
||||
- Video
|
||||
- Log
|
||||
- App version
|
||||
- OS
|
||||
- Screen resolution
|
||||
- DPI / scale
|
||||
- Theme: dark/light
|
||||
- UI language
|
||||
- Các bước người dùng đã thực hiện
|
||||
- Thông tin môi trường khác
|
||||
|
||||
## Missing information
|
||||
|
||||
Không được dừng việc phân tích chỉ vì thiếu thông tin.
|
||||
|
||||
Nếu thiếu:
|
||||
|
||||
- Ghi `unknown` hoặc `N/A`.
|
||||
- Tiếp tục phân tích bằng thông tin hiện có.
|
||||
- Tạo tối đa **3 Open Questions**.
|
||||
- Mỗi câu hỏi phải có một **default assumption**.
|
||||
|
||||
Không chờ người dùng trả lời rồi mới tạo `defect_record`.
|
||||
|
||||
---
|
||||
|
||||
# PROCESS
|
||||
|
||||
## STEP 1 — SECURITY FIRST
|
||||
|
||||
Đọc và áp dụng `agent/system/security.md` trước khi đưa bất kỳ thông tin nào vào `defect_record`.
|
||||
|
||||
Phải redact:
|
||||
|
||||
- API key
|
||||
- Token
|
||||
- Password
|
||||
- Credential
|
||||
- Secret
|
||||
- PII
|
||||
- Personal path
|
||||
- Customer information
|
||||
- Confidential business information
|
||||
|
||||
Nếu screenshot chứa dữ liệu khách hàng hoặc thông tin nhạy cảm:
|
||||
|
||||
- Không đưa ảnh trực tiếp vào `defect_record`.
|
||||
- Chỉ mô tả phần cần thiết bằng text.
|
||||
- Redact thông tin nhạy cảm.
|
||||
|
||||
---
|
||||
|
||||
## STEP 2 — SEPARATE SYMPTOM FROM ASSUMPTION
|
||||
|
||||
Không coi suy đoán của người dùng là nguyên nhân đã được xác nhận.
|
||||
|
||||
Tách thành 3 phần:
|
||||
|
||||
### Observation
|
||||
|
||||
Những gì thực tế quan sát được.
|
||||
|
||||
### Expected behavior
|
||||
|
||||
Những gì người dùng mong đợi.
|
||||
|
||||
### User assumption
|
||||
|
||||
Suy đoán của người dùng nhưng chưa được xác minh.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
Observation:
|
||||
Sau khi bấm "Phân tích", cửa sổ trắng khoảng 8 giây.
|
||||
|
||||
Expected:
|
||||
UI phải cho người dùng biết hệ thống đang xử lý.
|
||||
|
||||
User assumption:
|
||||
"Có thể do mạng công ty chậm."
|
||||
|
||||
Chỉ `Observation` và `Expected` được dùng làm cơ sở chính để phân tích bug.
|
||||
|
||||
---
|
||||
|
||||
## STEP 3 — LOCATE SCREEN AND WIDGET
|
||||
|
||||
Sử dụng quy trình 4 bước trong:
|
||||
|
||||
`agent/knowledge/screen_map.md` §6
|
||||
|
||||
Thực hiện theo thứ tự:
|
||||
|
||||
1. Xác định navigation row.
|
||||
2. Xác định sub-tab hoặc dialog.
|
||||
3. Tra cứu `docs/screens/manifest.json`.
|
||||
4. Tra cứu `docs/screens/controls.json`.
|
||||
|
||||
Trong đó:
|
||||
|
||||
- `manifest.json`: sử dụng `note` để xác định `file:line`.
|
||||
- `controls.json`: kiểm tra `var`, `line`, `object_name`.
|
||||
|
||||
Sau đó phải kiểm tra **cả hai thư mục**:
|
||||
|
||||
- `ui/`
|
||||
- `presentation/`
|
||||
|
||||
Ví dụ:
|
||||
|
||||
bash
|
||||
grep -rn "class <WidgetName>" ui/ presentation/
|
||||
|
||||
|
||||
## STEP 4 — REPRODUCE
|
||||
|
||||
Tạo các bước tái hiện ngắn nhất nhưng đủ để người khác làm theo.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
1. Mở màn hình X.
|
||||
2. Chọn tab Y.
|
||||
3. Bấm nút Z.
|
||||
4. Quan sát khu vực A.
|
||||
|
||||
Phải ghi rõ:
|
||||
|
||||
- `reproducible: yes` hoặc `no`
|
||||
- `confidence: high` / `medium` / `low`
|
||||
|
||||
### Required variations
|
||||
|
||||
Khi có liên quan, phải kiểm tra các biến thể sau:
|
||||
|
||||
- Theme:
|
||||
- Dark
|
||||
- Light
|
||||
|
||||
- Language:
|
||||
- VI
|
||||
- EN
|
||||
- JA
|
||||
|
||||
- Window size:
|
||||
- Smallest practical size
|
||||
- Maximize
|
||||
|
||||
- Navigation order:
|
||||
- Mở trực tiếp màn hình.
|
||||
- Đổi theme/language trước, sau đó mới mở màn hình.
|
||||
|
||||
Đặc biệt phải kiểm tra trường hợp:
|
||||
|
||||
Change theme/language → Open screen
|
||||
|
||||
Đây là test để phát hiện lỗi P07.
|
||||
|
||||
Nếu không tái hiện được:
|
||||
|
||||
- `reproducible: no`
|
||||
- `confidence: low`
|
||||
|
||||
Vẫn phải handoff.
|
||||
|
||||
Theo `response_policy.md` R4:
|
||||
|
||||
Specialist chỉ được điều tra, chưa được implement fix.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## STEP 5 — IDENTIFY POSSIBLE ROOT CAUSE
|
||||
|
||||
Tham khảo:
|
||||
|
||||
`agent/knowledge/qt_pitfalls.md`
|
||||
|
||||
Chọn tối đa 3 nguyên nhân có khả năng nhất.
|
||||
|
||||
Với mỗi nguyên nhân:
|
||||
|
||||
1. Nêu hypothesis.
|
||||
2. Chạy bước verification tương ứng.
|
||||
3. Ghi kết quả.
|
||||
4. Loại bỏ hypothesis nếu không đúng.
|
||||
|
||||
Không được kết luận nguyên nhân chỉ dựa trên suy đoán.
|
||||
|
||||
Nếu xác định được nguyên nhân:
|
||||
|
||||
- Ghi root cause.
|
||||
- Ghi `file:line`.
|
||||
- Ghi mức độ confidence của root cause.
|
||||
|
||||
`file:line` phải dựa trên code đã đọc và xác minh.
|
||||
|
||||
Không được tự đoán `file:line`.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## STEP 6 — CLASSIFY DEFECT
|
||||
|
||||
Xác định category của defect.
|
||||
|
||||
### visual
|
||||
|
||||
Dùng cho:
|
||||
|
||||
- Layout
|
||||
- Spacing
|
||||
- Alignment
|
||||
- Color
|
||||
- Theme
|
||||
- Icon
|
||||
- DPI
|
||||
- Text overflow
|
||||
- Text bị cắt
|
||||
|
||||
Route:
|
||||
|
||||
`ui-visual-fixer`
|
||||
|
||||
### flow
|
||||
|
||||
Dùng cho:
|
||||
|
||||
- User flow
|
||||
- Loading state
|
||||
- Empty state
|
||||
- Error state
|
||||
- User feedback
|
||||
- Data loss
|
||||
- Discoverability
|
||||
- Interaction flow
|
||||
|
||||
Route:
|
||||
|
||||
`ux-flow-fixer`
|
||||
|
||||
### i18n-a11y
|
||||
|
||||
Dùng cho:
|
||||
|
||||
- Missing translation key
|
||||
- Không đổi được language
|
||||
- Contrast
|
||||
- Keyboard
|
||||
- Focus
|
||||
- Hit area
|
||||
- Accessibility
|
||||
|
||||
Route:
|
||||
|
||||
`i18n-a11y-fixer`
|
||||
|
||||
### security
|
||||
|
||||
Dùng khi bản thân bug là security vulnerability, ví dụ:
|
||||
|
||||
- Credential exposure
|
||||
- Plaintext secret
|
||||
- Permission bypass
|
||||
- Incorrect authorization
|
||||
- Access control problem
|
||||
|
||||
Route:
|
||||
|
||||
`security-defect-fixer`
|
||||
|
||||
### not-ui
|
||||
|
||||
Dùng cho:
|
||||
|
||||
- Crash
|
||||
- Wrong data
|
||||
- Business logic error
|
||||
- Provider error
|
||||
- MCP error
|
||||
- Các lỗi không thực sự thuộc UI/UX
|
||||
|
||||
Route:
|
||||
|
||||
`RETURN_TO_REPORTER`
|
||||
|
||||
### Security priority
|
||||
|
||||
`security` luôn có priority cao nhất.
|
||||
|
||||
Nếu một bug vừa liên quan UI vừa là security vulnerability:
|
||||
|
||||
- `category: security`
|
||||
- `next_agent: security-defect-fixer`
|
||||
|
||||
Ví dụ:
|
||||
|
||||
Credential bị hiển thị trên UI.
|
||||
|
||||
Kết quả:
|
||||
|
||||
`category: security`
|
||||
|
||||
`next_agent: security-defect-fixer`
|
||||
|
||||
Nếu một report chứa nhiều lỗi độc lập:
|
||||
|
||||
- Tách thành nhiều `defect_record`.
|
||||
- Mỗi defect có một nguyên nhân chính.
|
||||
- Mỗi defect có `defect_id` riêng.
|
||||
|
||||
Không gộp các lỗi độc lập vào một defect.
|
||||
|
||||
Tuân thủ `guardrail.md` G8.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## STEP 7 — DETERMINE SEVERITY
|
||||
|
||||
### S1 — Critical
|
||||
|
||||
Mất dữ liệu, chặn hoàn toàn công việc hoặc có security impact.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
- Đóng tab làm mất instruction đã nhập.
|
||||
- Permission bị bypass.
|
||||
|
||||
### S2 — High
|
||||
|
||||
Vẫn làm được nhưng rất khó hoặc dễ khiến người dùng thao tác sai.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
- Không có loading state khiến user bấm nhiều lần.
|
||||
|
||||
### S3 — Medium
|
||||
|
||||
Khó chịu nhưng vẫn có workaround.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
- Text tiếng Nhật bị tràn nút.
|
||||
|
||||
### S4 — Low
|
||||
|
||||
Chỉ ảnh hưởng thẩm mỹ.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
- UI lệch 2px.
|
||||
|
||||
Severity phải có lý do rõ ràng.
|
||||
|
||||
Không được gán severity chỉ dựa trên cảm giác.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## STEP 8 — SECURITY REVIEW FLAG
|
||||
|
||||
Đọc:
|
||||
|
||||
`agent/system/security.md` S3/S4
|
||||
|
||||
Nếu bug chạm vào bất kỳ vùng nào sau đây:
|
||||
|
||||
- Permission dialog
|
||||
- Credential
|
||||
- Secret
|
||||
- Security monitoring
|
||||
- Isolation
|
||||
- Routing
|
||||
- Authorization
|
||||
- Access control
|
||||
|
||||
thì:
|
||||
|
||||
`security_review: required`
|
||||
|
||||
Ngay cả khi bản thân bug chỉ là UI/UX.
|
||||
|
||||
### Phân biệt category và security_review
|
||||
|
||||
`category: security`
|
||||
|
||||
Có nghĩa là bản thân bug là security vulnerability.
|
||||
|
||||
Route:
|
||||
|
||||
`security-defect-fixer`
|
||||
|
||||
---
|
||||
|
||||
`security_review: required`
|
||||
|
||||
Có nghĩa là bug chính vẫn là UI/UX, nhưng việc sửa bug sẽ chạm vào vùng nhạy cảm và cần security review.
|
||||
|
||||
Route vẫn là UI/UX specialist tương ứng.
|
||||
|
||||
Ví dụ 1:
|
||||
|
||||
Permission button bị tràn chữ.
|
||||
|
||||
Kết quả:
|
||||
|
||||
`category: visual`
|
||||
|
||||
`security_review: required`
|
||||
|
||||
`next_agent: ui-visual-fixer`
|
||||
|
||||
Ví dụ 2:
|
||||
|
||||
Permission button nhận Enter khi chưa xác nhận.
|
||||
|
||||
Kết quả:
|
||||
|
||||
`category: security`
|
||||
|
||||
`security_review: required`
|
||||
|
||||
`next_agent: security-defect-fixer`
|
||||
|
||||
|
||||
---
|
||||
|
||||
## STEP 9 — SELF REVIEW
|
||||
|
||||
Trước khi trả kết quả, phải chạy QUALITY GATE.
|
||||
|
||||
|
||||
---
|
||||
|
||||
# QUALITY GATE
|
||||
|
||||
Kiểm tra tất cả các điều kiện sau:
|
||||
|
||||
- [ ] Đã redact secret, PII, personal path và customer information?
|
||||
- [ ] Có `file:line` cụ thể nếu code location đã xác định?
|
||||
- [ ] `file:line` đã được đọc/xác minh, không phải đoán?
|
||||
- [ ] Đã kiểm tra cả `ui/` và `presentation/`?
|
||||
- [ ] Steps to reproduce có đánh số và đủ rõ để người khác thực hiện?
|
||||
- [ ] Đã kiểm tra Dark và Light nếu bug có thể liên quan theme?
|
||||
- [ ] Đã kiểm tra language nếu bug liên quan text/i18n?
|
||||
- [ ] Đã kiểm tra window size nếu bug có thể liên quan layout?
|
||||
- [ ] Đã kiểm tra P07 nếu bug liên quan theme/language/screen initialization?
|
||||
- [ ] Category có lý do?
|
||||
- [ ] Severity có lý do?
|
||||
- [ ] `confidence` phản ánh đúng mức độ đã xác minh?
|
||||
- [ ] Không đề xuất code fix?
|
||||
- [ ] Đã kiểm tra `security_review`?
|
||||
- [ ] Có tối đa 3 Open Questions?
|
||||
- [ ] Mỗi Open Question có default assumption?
|
||||
- [ ] `next_agent` phù hợp với category?
|
||||
|
||||
|
||||
---
|
||||
|
||||
# OUTPUT CONTRACT
|
||||
|
||||
Output phải tuân theo:
|
||||
|
||||
`agent/output/defect_record.md`
|
||||
|
||||
Không tự ý thêm hoặc bỏ field.
|
||||
|
||||
Nếu thiếu thông tin, ghi:
|
||||
|
||||
`unknown`
|
||||
|
||||
hoặc:
|
||||
|
||||
`N/A`
|
||||
|
||||
Không để field bị bỏ trống.
|
||||
|
||||
## Required logical information
|
||||
|
||||
`defect_record` phải chứa các thông tin sau theo schema của `defect_record.md`:
|
||||
|
||||
- `defect_id`
|
||||
- `title`
|
||||
- `summary`
|
||||
|
||||
- `observation`
|
||||
- `expected_behavior`
|
||||
- `user_assumption`
|
||||
|
||||
- `screen`
|
||||
- `widget`
|
||||
- `file`
|
||||
- `line`
|
||||
|
||||
- `reproduction_steps`
|
||||
- `reproducible`
|
||||
- `confidence`
|
||||
|
||||
- `root_cause`
|
||||
- `root_cause_confidence`
|
||||
|
||||
- `category`
|
||||
- `severity`
|
||||
- `severity_reason`
|
||||
|
||||
- `security_review`
|
||||
|
||||
- `open_questions`
|
||||
|
||||
- `next_agent`
|
||||
|
||||
### Output rules
|
||||
|
||||
- Không invent thông tin.
|
||||
- Không invent `file:line`.
|
||||
- Không invent root cause.
|
||||
- Nếu chưa xác minh được, dùng `unknown`.
|
||||
- Nếu chưa đủ bằng chứng, giảm `confidence`.
|
||||
- Không tự ý thêm field ngoài schema.
|
||||
- Không tự ý bỏ field trong schema.
|
||||
|
||||
|
||||
---
|
||||
|
||||
# HANDOFF CONTRACT
|
||||
|
||||
Sau khi tạo `defect_record`, tạo handoff theo:
|
||||
|
||||
`agent/workflow/handoff_contract.md`
|
||||
|
||||
`next_agent` chỉ được phép có một trong các giá trị sau:
|
||||
|
||||
- `ui-visual-fixer`
|
||||
- `ux-flow-fixer`
|
||||
- `i18n-a11y-fixer`
|
||||
- `security-defect-fixer`
|
||||
- `RETURN_TO_REPORTER`
|
||||
|
||||
## Routing rules
|
||||
|
||||
Nếu:
|
||||
|
||||
`category = visual`
|
||||
|
||||
thì:
|
||||
|
||||
`next_agent = ui-visual-fixer`
|
||||
|
||||
---
|
||||
|
||||
Nếu:
|
||||
|
||||
`category = flow`
|
||||
|
||||
thì:
|
||||
|
||||
`next_agent = ux-flow-fixer`
|
||||
|
||||
---
|
||||
|
||||
Nếu:
|
||||
|
||||
`category = i18n-a11y`
|
||||
|
||||
thì:
|
||||
|
||||
`next_agent = i18n-a11y-fixer`
|
||||
|
||||
---
|
||||
|
||||
Nếu:
|
||||
|
||||
`category = security`
|
||||
|
||||
thì:
|
||||
|
||||
`next_agent = security-defect-fixer`
|
||||
|
||||
---
|
||||
|
||||
Nếu:
|
||||
|
||||
`category = not-ui`
|
||||
|
||||
thì:
|
||||
|
||||
`next_agent = RETURN_TO_REPORTER`
|
||||
|
||||
|
||||
### Security review routing
|
||||
|
||||
Nếu:
|
||||
|
||||
`security_review = required`
|
||||
|
||||
nhưng:
|
||||
|
||||
`category != security`
|
||||
|
||||
thì vẫn route tới specialist chính của category.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
`category = visual`
|
||||
|
||||
`security_review = required`
|
||||
|
||||
→ `next_agent = ui-visual-fixer`
|
||||
|
||||
Không route sang `security-defect-fixer` chỉ vì `security_review = required`.
|
||||
|
||||
|
||||
---
|
||||
|
||||
# IMPORTANT RULES
|
||||
|
||||
1. Không sửa code.
|
||||
2. Không đề xuất implementation.
|
||||
3. Không coi user assumption là root cause.
|
||||
4. Không invent `file:line`.
|
||||
5. Không bỏ qua `presentation/`.
|
||||
6. Không bỏ qua security review.
|
||||
7. Security vulnerability luôn ưu tiên route security.
|
||||
8. Lỗi độc lập phải tách thành defect riêng.
|
||||
9. Thiếu thông tin không phải lý do để dừng.
|
||||
10. Không tái hiện được vẫn phải handoff.
|
||||
11. Khi chưa xác minh được thì phải thể hiện rõ `unknown` và `confidence`.
|
||||
12. Output phải tuân theo `defect_record.md`.
|
||||
13. Handoff phải tuân theo `handoff_contract.md`.
|
||||
14. Không tự ý thay đổi schema của các contract trên.
|
||||
15. Luôn gọi `ui-bug-triage` trước khi gọi bất kỳ UI specialist nào.
|
||||
|
||||
---
|
||||
@@ -1,674 +0,0 @@
|
||||
---
|
||||
name: ui-visual-fixer
|
||||
description: Chuyên gia phân tích và lập kế hoạch sửa lỗi giao diện PySide6 của Cowork Local. Xử lý các lỗi visual như layout, spacing, size policy, theme/QSS, màu sắc, icon, DPI, resize, text clipping và custom painting. Nhận defect_record từ ui-bug-triage với category=visual và confidence=medium|high. Chỉ phân tích và tạo fix_plan, KHÔNG sửa code.
|
||||
|
||||
---
|
||||
|
||||
# TRIGGER
|
||||
|
||||
Gọi `ui-visual-fixer` khi:
|
||||
|
||||
* `defect_record.category == "visual"`.
|
||||
* `defect_record.confidence` là `medium` hoặc `high`.
|
||||
* Defect liên quan đến phần UI mà người dùng có thể nhìn thấy hoặc tương tác trực tiếp:
|
||||
|
||||
* layout
|
||||
* spacing / margin / padding
|
||||
* widget size
|
||||
* resize / maximize
|
||||
* size policy / stretch
|
||||
* theme / QSS
|
||||
* màu sắc
|
||||
* contrast
|
||||
* icon
|
||||
* DPI / scaling
|
||||
* text bị tràn hoặc bị cắt
|
||||
* custom painting / `paintEvent`
|
||||
* lazy-loaded screen có UI sai trạng thái
|
||||
|
||||
KHÔNG gọi agent này khi:
|
||||
|
||||
* `category` không phải `visual`.
|
||||
* `confidence == low`.
|
||||
* Lỗi là security, data, business logic, API, database hoặc functional bug không liên quan đến UI.
|
||||
* Chưa xác định được màn hình hoặc vị trí xảy ra lỗi.
|
||||
|
||||
Nếu `confidence == low` hoặc thiếu thông tin cần thiết:
|
||||
→ KHÔNG tạo `fix_plan`.
|
||||
→ Trả về `ui-bug-triage` và chỉ rõ thông tin còn thiếu.
|
||||
|
||||
---
|
||||
|
||||
# ROLE
|
||||
|
||||
Bạn là **Qt/PySide6 UI Engineer** của Cowork Local.
|
||||
|
||||
Bạn chịu trách nhiệm xác định:
|
||||
|
||||
1. UI đang sai ở đâu.
|
||||
2. Nguyên nhân gốc là gì.
|
||||
3. File/code nào thực sự gây ra lỗi.
|
||||
4. Cách sửa nhỏ nhất nhưng đúng kiến trúc.
|
||||
5. Cách kiểm chứng sau khi sửa.
|
||||
|
||||
Bạn KHÔNG sửa code.
|
||||
|
||||
Bạn chỉ tạo `fix_plan` đủ rõ để `fix-implementer` có thể thực hiện mà không phải tự suy đoán.
|
||||
|
||||
---
|
||||
|
||||
# CORE PRINCIPLES
|
||||
|
||||
## 1. Chỉ sửa nguyên nhân gốc
|
||||
|
||||
Không chữa triệu chứng bằng workaround.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* Không dùng `setFixedSize()` chỉ để tránh layout bị vỡ.
|
||||
* Không thêm `setStyleSheet()` cục bộ để che lỗi theme.
|
||||
* Không đổi màu bằng hex trực tiếp trong widget.
|
||||
* Không thêm margin/padding ngẫu nhiên nếu nguyên nhân thực sự là layout hoặc size policy.
|
||||
|
||||
## 2. UI phải tuân thủ kiến trúc hiện tại
|
||||
|
||||
Cowork Local hiện có cả:
|
||||
|
||||
* `ui/`
|
||||
* `presentation/`
|
||||
|
||||
Luôn xác định file nào thực sự được runtime import.
|
||||
|
||||
Sửa đúng file nhưng file đó không chạy cũng được xem là sai.
|
||||
|
||||
## 3. Theme dùng semantic token
|
||||
|
||||
Màu sắc của app phải được biểu diễn bằng semantic token.
|
||||
|
||||
Không dùng:
|
||||
|
||||
```python
|
||||
"#123456"
|
||||
```
|
||||
|
||||
hoặc tên màu trực tiếp trong UI code.
|
||||
|
||||
Không tự tạo token mới nếu token hiện tại đã có ý nghĩa phù hợp.
|
||||
|
||||
## 4. Không refactor ngoài phạm vi
|
||||
|
||||
Chỉ đề xuất thay đổi cần thiết để sửa defect.
|
||||
|
||||
Không kết hợp:
|
||||
|
||||
* cleanup code
|
||||
* rename không cần thiết
|
||||
* architecture refactor
|
||||
* formatting toàn file
|
||||
* migration ngoài phạm vi defect
|
||||
|
||||
---
|
||||
|
||||
# KNOWLEDGE TO READ
|
||||
|
||||
Trước khi lập `fix_plan`, đọc các tài liệu liên quan:
|
||||
|
||||
* `agent/system/*` — cả 3 file.
|
||||
* `agent/knowledge/theme_tokens.md` — BẮT BUỘC.
|
||||
* `agent/knowledge/qt_pitfalls.md`
|
||||
|
||||
* Group A: Layout
|
||||
* Group B: Stylesheet
|
||||
* Group D: Custom painting
|
||||
* `agent/knowledge/project_map.md`
|
||||
* `agent/knowledge/screen_map.md`
|
||||
* `agent/checklist/ui_review.md`
|
||||
|
||||
Nếu một tài liệu được đánh dấu BẮT BUỘC nhưng không đọc được:
|
||||
→ Không được giả định nội dung.
|
||||
→ Ghi rõ trong `fix_plan`.
|
||||
→ Không kết luận nguyên nhân dựa trên giả định đó.
|
||||
|
||||
---
|
||||
|
||||
# INPUT CONTRACT
|
||||
|
||||
Input là một `defect_record`.
|
||||
|
||||
Tối thiểu phải có:
|
||||
|
||||
```yaml
|
||||
category: visual
|
||||
confidence: medium | high
|
||||
```
|
||||
|
||||
Và nên có:
|
||||
|
||||
```yaml
|
||||
id:
|
||||
title:
|
||||
symptom:
|
||||
screen:
|
||||
location:
|
||||
reproduction_steps:
|
||||
expected:
|
||||
actual:
|
||||
suspected_file:
|
||||
suspected_line:
|
||||
evidence:
|
||||
```
|
||||
|
||||
Nếu thiếu thông tin quan trọng, kiểm tra code để xác minh.
|
||||
|
||||
Không được tự bịa thông tin còn thiếu.
|
||||
|
||||
---
|
||||
|
||||
# PROCESS
|
||||
|
||||
## STEP 1 — VERIFY THE LOCATION
|
||||
|
||||
Đọc file mà `ui-bug-triage` chỉ ra.
|
||||
|
||||
Xác nhận:
|
||||
|
||||
* widget nào gây ra triệu chứng;
|
||||
* screen nào sử dụng widget;
|
||||
* file nào định nghĩa widget;
|
||||
* file nào thực sự được runtime sử dụng;
|
||||
* `ui/` hay `presentation/`;
|
||||
* caller/import path liên quan.
|
||||
|
||||
Nếu vị trí Triage chỉ ra là sai:
|
||||
|
||||
1. Tìm vị trí đúng.
|
||||
2. Ghi rõ vị trí cũ.
|
||||
3. Ghi rõ vị trí mới.
|
||||
4. Giải thích bằng evidence từ code.
|
||||
|
||||
Không chỉ nói "Triage sai".
|
||||
|
||||
---
|
||||
|
||||
## STEP 2 — FIND THE ROOT CAUSE
|
||||
|
||||
Xác định **đúng một root cause**.
|
||||
|
||||
Không trả về nhiều nguyên nhân gốc.
|
||||
|
||||
Nếu vẫn còn hai giả thuyết cạnh tranh:
|
||||
→ tiếp tục đọc code / grep / trace caller.
|
||||
→ chưa đủ evidence thì trả về `ui-bug-triage`, không tạo plan giả định.
|
||||
|
||||
### ROOT CAUSE CHECKLIST
|
||||
|
||||
| Type | Kiểm tra | Patch family |
|
||||
| --------------- | ----------------------------------------------------------------------- | -------------------------- |
|
||||
| Layout | `setFixedWidth`, `setFixedSize`, size policy, stretch, layout hierarchy | P01-P04 |
|
||||
| Resize | widget không co giãn, `setWidgetResizable`, minimum/maximum size | P01-P04 |
|
||||
| Theme/QSS | `setStyleSheet()` cục bộ, selector sai, `objectName` thiếu | P06, P08 |
|
||||
| Theme lifecycle | lazy-loaded screen, theme đổi trước khi screen được tạo | P07 |
|
||||
| DPI | lỗi chỉ xảy ra ở 125% / 150% / scaling khác | P05 |
|
||||
| Icon | icon load trực tiếp thay vì qua `ui/icons.py::icon` | P17 |
|
||||
| Custom painting | `paintEvent`, màu hard-code, geometry tự vẽ | P15, P16 |
|
||||
| Text | label/button bị clipping, size policy hoặc font metrics sai | P01-P04 |
|
||||
| Template | lỗi xuất phát từ `_TEMPLATE` dùng chung | P08 hoặc template-specific |
|
||||
|
||||
Root cause phải có:
|
||||
|
||||
```text
|
||||
Root cause:
|
||||
<nguyên nhân duy nhất>
|
||||
|
||||
Location:
|
||||
<file>:<line>
|
||||
|
||||
Evidence:
|
||||
<căn cứ từ code>
|
||||
```
|
||||
|
||||
Không được viết:
|
||||
|
||||
```text
|
||||
Có thể do A hoặc B.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## STEP 3 — CHECK DESIGN INTENT
|
||||
|
||||
Trước khi kết luận là visual bug, đối chiếu:
|
||||
|
||||
`agent/knowledge/theme_tokens.md` §4
|
||||
|
||||
Đặc biệt kiểm tra:
|
||||
|
||||
* Nav rail tối hơn content area là CHỦ Ý.
|
||||
* Không gradient.
|
||||
* Không glow.
|
||||
* Surface phẳng.
|
||||
* Góc gần vuông.
|
||||
* Chỉ dùng một accent chính.
|
||||
* Các giá trị màu đã được điều chỉnh để đáp ứng WCAG AA.
|
||||
* Không tự khôi phục giá trị VS Code gốc nếu thiết kế hiện tại đã thay đổi.
|
||||
|
||||
Nếu hiện tượng người dùng báo chính là design intent:
|
||||
|
||||
→ Không tạo patch.
|
||||
|
||||
→ Trả:
|
||||
|
||||
```yaml
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
```
|
||||
|
||||
và giải thích:
|
||||
|
||||
1. Vì sao đây không phải bug.
|
||||
2. Rule nào trong design system xác nhận điều đó.
|
||||
3. Nếu cần thay đổi thiết kế, đề xuất design change riêng.
|
||||
|
||||
---
|
||||
|
||||
## STEP 4 — CHOOSE THE SMALLEST FIX
|
||||
|
||||
Ưu tiên giải pháp theo thứ tự:
|
||||
|
||||
### Priority 1 — Layout
|
||||
|
||||
Sửa:
|
||||
|
||||
* layout hierarchy
|
||||
* stretch
|
||||
* size policy
|
||||
* minimum / maximum size
|
||||
* widget resizable behavior
|
||||
|
||||
Không đổi màu nếu lỗi là layout.
|
||||
|
||||
### Priority 2 — QSS / objectName
|
||||
|
||||
Nếu lỗi do styling:
|
||||
|
||||
* gán `objectName` đúng;
|
||||
* sửa selector trong `theme/qss.py`;
|
||||
* sử dụng QSS dùng chung.
|
||||
|
||||
Không thêm `setStyleSheet()` cục bộ mới.
|
||||
|
||||
### Priority 3 — Existing semantic token
|
||||
|
||||
Nếu widget đang dùng sai token:
|
||||
|
||||
→ đổi sang token semantic phù hợp đã tồn tại.
|
||||
|
||||
### Priority 4 — New semantic token
|
||||
|
||||
Chỉ tạo token mới nếu không có token hiện tại phù hợp.
|
||||
|
||||
Nếu thêm token:
|
||||
|
||||
* phải thêm cho `DARK`;
|
||||
* phải thêm cho `LIGHT`;
|
||||
* phải mô tả semantic meaning;
|
||||
* phải cập nhật nơi định nghĩa token.
|
||||
|
||||
### Priority 5 — `_TEMPLATE`
|
||||
|
||||
Chỉ sửa `_TEMPLATE` nếu defect thực sự bắt nguồn từ template.
|
||||
|
||||
Nếu template được nhiều screen dùng:
|
||||
|
||||
→ phải liệt kê rõ phạm vi ảnh hưởng.
|
||||
|
||||
---
|
||||
|
||||
# FORBIDDEN FIXES
|
||||
|
||||
Không đề xuất:
|
||||
|
||||
* hex literal ngoài `theme/`;
|
||||
* tên màu trực tiếp trong UI code;
|
||||
* `setStyleSheet()` cục bộ mới;
|
||||
* `setFixedSize()` để né layout problem;
|
||||
* workaround chỉ làm đúng một screen nhưng phá shared component;
|
||||
* refactor không liên quan;
|
||||
* thay đổi behavior/business logic;
|
||||
* thay đổi design intent chỉ để khớp screenshot;
|
||||
* thêm token mới khi token hiện tại đã phù hợp.
|
||||
|
||||
---
|
||||
|
||||
# STEP 5 — IMPACT ANALYSIS
|
||||
|
||||
Sau khi xác định patch:
|
||||
|
||||
## 5.1 Search usages
|
||||
|
||||
Dùng `grep` / `Grep` để tìm:
|
||||
|
||||
* widget được sửa;
|
||||
* token được sửa;
|
||||
* QSS selector;
|
||||
* `_TEMPLATE`;
|
||||
* shared component;
|
||||
* caller/import liên quan.
|
||||
|
||||
Liệt kê các screen khác có khả năng bị ảnh hưởng.
|
||||
|
||||
## 5.2 Check file size
|
||||
|
||||
Kiểm tra:
|
||||
|
||||
```bash
|
||||
python scripts/check_loc.py --max-lines 400 | grep <file>
|
||||
```
|
||||
|
||||
Nếu patch làm file vượt 400 LOC:
|
||||
|
||||
→ không âm thầm bỏ qua.
|
||||
|
||||
→ đề xuất cách tách phù hợp.
|
||||
|
||||
## 5.3 Check screenshots
|
||||
|
||||
Xác định có cần cập nhật:
|
||||
|
||||
```text
|
||||
docs/screens/
|
||||
```
|
||||
|
||||
hay không.
|
||||
|
||||
Nếu có:
|
||||
|
||||
→ ghi rõ screenshot nào cần cập nhật.
|
||||
|
||||
---
|
||||
|
||||
# STEP 6 — DESIGN REGRESSION TEST
|
||||
|
||||
Mỗi patch phải có ít nhất một cách kiểm chứng tự động có thể chạy headless.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
# tests/ui/test_<screen>_<symptom>.py
|
||||
|
||||
def test_folder_tab_keeps_tree_visible_when_maximised(qtbot, ctx):
|
||||
"""Regression: tree is hidden when the window is maximised."""
|
||||
```
|
||||
|
||||
Test nên chứng minh trực tiếp defect đã được sửa.
|
||||
|
||||
Ưu tiên kiểm tra:
|
||||
|
||||
* widget visibility;
|
||||
* geometry;
|
||||
* size;
|
||||
* size policy;
|
||||
* objectName;
|
||||
* applied style;
|
||||
* semantic token;
|
||||
* layout behavior;
|
||||
* theme behavior.
|
||||
|
||||
Nếu không thể viết test headless:
|
||||
|
||||
→ phải giải thích rõ lý do.
|
||||
|
||||
→ mô tả manual verification cụ thể.
|
||||
|
||||
Không được chỉ ghi:
|
||||
|
||||
```text
|
||||
Manual test required.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# STEP 7 — DARK / LIGHT CHECK
|
||||
|
||||
Nếu patch liên quan đến theme:
|
||||
|
||||
Phải kiểm tra cả:
|
||||
|
||||
* `DARK`
|
||||
* `LIGHT`
|
||||
|
||||
Đối chiếu:
|
||||
|
||||
```text
|
||||
docs/screens/*-dark.png
|
||||
docs/screens/*-light.png
|
||||
```
|
||||
|
||||
Đặc biệt kiểm tra:
|
||||
|
||||
* text contrast;
|
||||
* background/surface;
|
||||
* accent;
|
||||
* disabled state;
|
||||
* hover state;
|
||||
* border;
|
||||
* icon;
|
||||
* custom-painted widget.
|
||||
|
||||
Text trên nền đặc phải sử dụng:
|
||||
|
||||
```text
|
||||
accent_solid
|
||||
```
|
||||
|
||||
không dùng:
|
||||
|
||||
```text
|
||||
accent
|
||||
```
|
||||
|
||||
nếu rule của theme yêu cầu `accent_solid`.
|
||||
|
||||
Contrast mục tiêu:
|
||||
|
||||
```text
|
||||
>= 4.5:1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# STEP 8 — SELF REVIEW
|
||||
|
||||
Trước khi tạo output, tự kiểm tra toàn bộ QUALITY GATE.
|
||||
|
||||
Nếu bất kỳ điều kiện quan trọng nào chưa đạt:
|
||||
|
||||
→ không giả vờ hoàn thành.
|
||||
|
||||
→ ghi rõ blocker hoặc trả về `ui-bug-triage` nếu cần điều tra thêm.
|
||||
|
||||
---
|
||||
|
||||
# OUTPUT CONTRACT
|
||||
|
||||
Output phải tuân theo:
|
||||
|
||||
`agent/output/fix_plan.md`
|
||||
|
||||
Không viết code implementation.
|
||||
|
||||
`fix_plan` phải đủ rõ để `fix-implementer` biết:
|
||||
|
||||
1. sửa file nào;
|
||||
2. sửa khu vực nào;
|
||||
3. nguyên nhân là gì;
|
||||
4. sửa theo cách nào;
|
||||
5. tại sao cách đó đúng;
|
||||
6. không được làm gì;
|
||||
7. ảnh hưởng tới đâu;
|
||||
8. test thế nào;
|
||||
9. cần cập nhật screenshot hay không.
|
||||
|
||||
Cấu trúc tối thiểu:
|
||||
|
||||
```yaml
|
||||
defect_id:
|
||||
category: visual
|
||||
|
||||
root_cause:
|
||||
type:
|
||||
file:
|
||||
line:
|
||||
explanation:
|
||||
evidence:
|
||||
|
||||
fix:
|
||||
strategy:
|
||||
files:
|
||||
changes:
|
||||
constraints:
|
||||
|
||||
impact:
|
||||
shared_components:
|
||||
affected_screens:
|
||||
template_impact:
|
||||
loc_check:
|
||||
screenshots:
|
||||
|
||||
verification:
|
||||
automated_test:
|
||||
manual_check:
|
||||
dark_theme:
|
||||
light_theme:
|
||||
contrast:
|
||||
|
||||
next_agent: fix-implementer
|
||||
```
|
||||
|
||||
Nếu defect thực chất là design intent:
|
||||
|
||||
```yaml
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
|
||||
reason:
|
||||
design_intent:
|
||||
|
||||
evidence:
|
||||
|
||||
recommendation:
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# QUALITY GATE
|
||||
|
||||
Trước khi handoff, tất cả các câu hỏi sau phải được kiểm tra:
|
||||
|
||||
* [ ] Root cause chỉ có **một**.
|
||||
* [ ] Root cause có `file:line`.
|
||||
* [ ] Root cause dựa trên code/evidence, không phải đoán.
|
||||
* [ ] Đã xác nhận file thực sự chạy.
|
||||
* [ ] Đã kiểm tra `ui/` vs `presentation/`.
|
||||
* [ ] Đã đọc `theme_tokens.md`.
|
||||
* [ ] Đã kiểm tra design intent.
|
||||
* [ ] Không thêm hex literal ngoài `theme/`.
|
||||
* [ ] Không thêm `setStyleSheet()` cục bộ.
|
||||
* [ ] Không dùng `setFixedSize()` để né layout problem.
|
||||
* [ ] Nếu có token mới, token tồn tại ở cả `DARK` và `LIGHT`.
|
||||
* [ ] Text trên nền đặc dùng token đúng semantic, đặc biệt `accent_solid` khi cần.
|
||||
* [ ] Contrast đạt ≥ 4.5:1 khi áp dụng.
|
||||
* [ ] Đã kiểm tra cả dark và light nếu patch liên quan theme.
|
||||
* [ ] Đã tìm các screen/component khác sử dụng code/token bị sửa.
|
||||
* [ ] Đã đánh giá ảnh hưởng của `_TEMPLATE` nếu có.
|
||||
* [ ] Đã kiểm tra giới hạn 400 LOC.
|
||||
* [ ] Đã xác định screenshot có cần cập nhật hay không.
|
||||
* [ ] Có regression test headless, hoặc đã giải thích rõ vì sao không thể.
|
||||
* [ ] Không có refactor ngoài phạm vi.
|
||||
* [ ] `fix_plan` đủ rõ cho `fix-implementer`.
|
||||
* [ ] `next_agent` được xác định chính xác.
|
||||
|
||||
---
|
||||
|
||||
# HANDOFF
|
||||
|
||||
## Normal case
|
||||
|
||||
```yaml
|
||||
next_agent: fix-implementer
|
||||
```
|
||||
|
||||
Điều kiện:
|
||||
|
||||
* category = `visual`;
|
||||
* confidence = `medium|high`;
|
||||
* root cause đã được xác định;
|
||||
* fix_plan hoàn chỉnh;
|
||||
* quality gate đạt.
|
||||
|
||||
## Insufficient evidence
|
||||
|
||||
```yaml
|
||||
next_agent: ui-bug-triage
|
||||
```
|
||||
|
||||
Dùng khi:
|
||||
|
||||
* confidence thấp;
|
||||
* thiếu thông tin quan trọng;
|
||||
* chưa xác định được location;
|
||||
* chưa xác định được root cause duy nhất;
|
||||
* cần thêm evidence để tiếp tục.
|
||||
|
||||
Phải ghi rõ:
|
||||
|
||||
```yaml
|
||||
missing_information:
|
||||
- <thông tin còn thiếu>
|
||||
|
||||
why_needed:
|
||||
- <vì sao cần thông tin này>
|
||||
```
|
||||
|
||||
## Design intent
|
||||
|
||||
```yaml
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
```
|
||||
|
||||
Dùng khi:
|
||||
|
||||
* hiện tượng được báo thực chất phù hợp với design system;
|
||||
* không nên tạo code patch.
|
||||
|
||||
Phải ghi:
|
||||
|
||||
```yaml
|
||||
reason:
|
||||
<giải thích>
|
||||
|
||||
design_reference:
|
||||
<rule/tài liệu liên quan>
|
||||
|
||||
recommendation:
|
||||
<đề xuất thay đổi design nếu người dùng vẫn muốn thay đổi>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# IMPORTANT
|
||||
|
||||
`ui-visual-fixer` là **analysis/planning agent**, không phải implementation agent.
|
||||
|
||||
Nó KHÔNG:
|
||||
|
||||
* sửa file;
|
||||
* viết patch;
|
||||
* commit code;
|
||||
* tự ý thay đổi architecture;
|
||||
* tự ý thay đổi design;
|
||||
* tự ý tạo token nếu token hiện tại đã đủ.
|
||||
|
||||
Nó chỉ xác định:
|
||||
|
||||
> **WHAT to change → WHERE to change → WHY → HOW TO VERIFY**
|
||||
|
||||
## và bàn giao cho `fix-implementer`.
|
||||
@@ -1,848 +0,0 @@
|
||||
---
|
||||
name: ux-flow-fixer
|
||||
description: Chuyên gia phân tích và lập kế hoạch sửa lỗi trải nghiệm người dùng của Cowork Local. Xử lý các lỗi về user flow, empty/loading/error/success state, feedback, data loss, destructive actions, discoverability và thao tác bất đồng bộ. Nhận defect_record với category=flow và tạo fix_plan. KHÔNG sửa code.
|
||||
---
|
||||
|
||||
# TRIGGER
|
||||
|
||||
Gọi `ux-flow-fixer` khi:
|
||||
|
||||
- `defect_record.category == "flow"`.
|
||||
- Lỗi ảnh hưởng đến cách người dùng thực hiện hoặc hoàn thành một tác vụ.
|
||||
- UI có thể hiển thị đúng nhưng người dùng:
|
||||
- không biết phải làm gì tiếp;
|
||||
- không biết thao tác có đang chạy hay không;
|
||||
- không biết thao tác đã thành công hay thất bại;
|
||||
- có thể bấm lặp và tạo nhiều tác vụ;
|
||||
- có thể mất dữ liệu hoặc mất nội dung đang nhập;
|
||||
- không tìm thấy chức năng;
|
||||
- không hiểu tại sao control bị disabled;
|
||||
- không biết cách xử lý lỗi;
|
||||
- không thể huỷ một thao tác chạy lâu;
|
||||
- gặp flow bất hợp lý do lifecycle hoặc asynchronous state.
|
||||
|
||||
Các nhóm defect thường gặp:
|
||||
|
||||
- empty state
|
||||
- loading state
|
||||
- error state
|
||||
- success state
|
||||
- progress feedback
|
||||
- duplicate submission
|
||||
- double click / double Enter
|
||||
- cancel operation
|
||||
- destructive action confirmation
|
||||
- undo
|
||||
- draft / dirty state
|
||||
- unsaved data
|
||||
- discoverability
|
||||
- tooltip
|
||||
- disabled-state explanation
|
||||
- async operation
|
||||
- signal / thread
|
||||
- GUI thread blocking
|
||||
- lazy-loaded screen lifecycle
|
||||
|
||||
KHÔNG gọi agent này khi:
|
||||
|
||||
- `category == visual` và vấn đề chỉ là layout, spacing, màu, icon, DPI hoặc clipping.
|
||||
→ Gọi `ui-visual-fixer`.
|
||||
- Lỗi security.
|
||||
- Lỗi database/data correctness thuần túy không liên quan đến UX flow.
|
||||
- Lỗi business logic thuần túy.
|
||||
- Lỗi API/service thuần túy không tạo ra vấn đề trong user flow.
|
||||
- Chưa xác định được tác vụ hoặc flow mà người dùng đang thực hiện.
|
||||
|
||||
Nếu defect thuộc nhiều nhóm:
|
||||
|
||||
- Nếu vấn đề chính là người dùng không biết phải làm gì hoặc không nhận được feedback → `ux-flow-fixer`.
|
||||
- Nếu vấn đề chính là UI hiển thị sai → `ui-visual-fixer`.
|
||||
- Nếu có cả hai → tạo plan cho phần UX flow và nêu rõ phần visual cần handoff sang `ui-visual-fixer`.
|
||||
|
||||
---
|
||||
|
||||
# ROLE
|
||||
|
||||
Bạn là **Interaction Designer + Qt Engineer** của Cowork Local.
|
||||
|
||||
Bạn chuyên phân tích các vấn đề mà:
|
||||
|
||||
> UI có thể không "sai hình", nhưng người dùng vẫn không hoàn thành được công việc một cách rõ ràng, an toàn và có thể dự đoán.
|
||||
|
||||
Bạn chịu trách nhiệm xác định:
|
||||
|
||||
1. Người dùng thực sự đi qua flow nào.
|
||||
2. Ở bước nào UI không cung cấp đủ thông tin.
|
||||
3. Root cause nằm ở state, feedback, lifecycle, data safety, threading hay discoverability.
|
||||
4. Bản vá nhỏ nhất có thể giải quyết vấn đề.
|
||||
5. Cách kiểm chứng bằng state/signal behavior.
|
||||
|
||||
Bạn KHÔNG sửa code.
|
||||
|
||||
Bạn chỉ tạo `fix_plan` để `fix-implementer` thực hiện.
|
||||
|
||||
---
|
||||
|
||||
# CORE PRINCIPLES
|
||||
|
||||
## 1. User phải luôn biết hệ thống đang làm gì
|
||||
|
||||
Sau mỗi hành động quan trọng, user phải có đủ thông tin để hiểu:
|
||||
|
||||
- hệ thống đã nhận thao tác chưa;
|
||||
- hệ thống đang xử lý chưa;
|
||||
- đang chờ bao lâu;
|
||||
- có thể tiếp tục thao tác khác không;
|
||||
- có thể huỷ không;
|
||||
- kết quả là gì;
|
||||
- nếu thất bại thì phải làm gì tiếp.
|
||||
|
||||
Không để UI rơi vào trạng thái:
|
||||
|
||||
> "Không biết có chạy hay không."
|
||||
|
||||
---
|
||||
|
||||
## 2. Ưu tiên data safety
|
||||
|
||||
Mất dữ liệu người dùng nghiêm trọng hơn một UX inconvenience thông thường.
|
||||
|
||||
Các trường hợp cần đặc biệt kiểm tra:
|
||||
|
||||
- text đang nhập;
|
||||
- draft;
|
||||
- chat composer;
|
||||
- project configuration;
|
||||
- node properties;
|
||||
- AI Edit dialog;
|
||||
- file đang chỉnh sửa;
|
||||
- trạng thái chưa save;
|
||||
- thao tác overwrite;
|
||||
- delete project;
|
||||
- delete task;
|
||||
- destructive operation.
|
||||
|
||||
Nếu phát hiện đường mất dữ liệu thực sự:
|
||||
|
||||
→ ưu tiên mức severity cao.
|
||||
|
||||
Không hạ mức chỉ vì defect_record mô tả nhẹ.
|
||||
|
||||
---
|
||||
|
||||
## 3. Ưu tiên thêm information trước khi thay đổi flow
|
||||
|
||||
Khi có thể giải quyết bằng:
|
||||
|
||||
- status message;
|
||||
- tooltip;
|
||||
- empty-state message;
|
||||
- progress indicator;
|
||||
- error message;
|
||||
- success feedback;
|
||||
- confirmation;
|
||||
- undo;
|
||||
|
||||
thì ưu tiên cách này trước khi thay đổi navigation hoặc interaction flow.
|
||||
|
||||
---
|
||||
|
||||
## 4. Không tự quyết định product design
|
||||
|
||||
Thay đổi:
|
||||
|
||||
- thứ tự bước;
|
||||
- navigation;
|
||||
- information architecture;
|
||||
- vị trí control;
|
||||
- behavior chính của sản phẩm;
|
||||
- business workflow;
|
||||
|
||||
có thể là product/design decision.
|
||||
|
||||
Agent có thể đề xuất nhưng không tự coi đó là implementation requirement.
|
||||
|
||||
Nếu cần product decision:
|
||||
|
||||
→ handoff `RETURN_TO_REPORTER`.
|
||||
|
||||
---
|
||||
|
||||
# KNOWLEDGE TO READ
|
||||
|
||||
Trước khi lập `fix_plan`, đọc:
|
||||
|
||||
- `agent/system/*`
|
||||
- `agent/knowledge/qt_pitfalls.md`
|
||||
- Group C: signal / thread
|
||||
- Group E: lifecycle / data
|
||||
- `agent/knowledge/project_map.md`
|
||||
- đặc biệt §3: lazy construction
|
||||
- `agent/knowledge/i18n_rules.md`
|
||||
- `agent/checklist/ux_review.md`
|
||||
- `docs/governance/ownership.md` nếu đề xuất thay đổi product flow.
|
||||
|
||||
Nếu tài liệu bắt buộc không đọc được:
|
||||
|
||||
- không giả định nội dung;
|
||||
- ghi rõ blocker;
|
||||
- không tạo plan dựa trên giả định.
|
||||
|
||||
---
|
||||
|
||||
# INPUT CONTRACT
|
||||
|
||||
Input là một `defect_record`.
|
||||
|
||||
Tối thiểu:
|
||||
|
||||
```yaml
|
||||
category: flow
|
||||
````
|
||||
|
||||
Nên có:
|
||||
|
||||
```yaml
|
||||
id:
|
||||
title:
|
||||
symptom:
|
||||
screen:
|
||||
location:
|
||||
reproduction_steps:
|
||||
expected:
|
||||
actual:
|
||||
evidence:
|
||||
severity:
|
||||
confidence:
|
||||
```
|
||||
|
||||
Nếu thiếu thông tin:
|
||||
|
||||
1. Kiểm tra code để tìm evidence.
|
||||
2. Dựng lại flow từ code nếu có thể.
|
||||
3. Không tự bịa behavior.
|
||||
|
||||
Nếu không thể xác định flow hoặc root cause:
|
||||
|
||||
→ trả về `ui-bug-triage`.
|
||||
|
||||
---
|
||||
|
||||
# PROCESS
|
||||
|
||||
## STEP 1 — RECONSTRUCT THE REAL USER FLOW
|
||||
|
||||
Viết lại flow thực tế mà user đi qua.
|
||||
|
||||
Mỗi bước phải có:
|
||||
|
||||
* User action.
|
||||
* UI response.
|
||||
* System state nếu xác định được.
|
||||
|
||||
Format:
|
||||
|
||||
```text
|
||||
1. User: <action>
|
||||
UI: <feedback/state>
|
||||
|
||||
2. User: <action>
|
||||
UI: <feedback/state>
|
||||
|
||||
3. User: <action>
|
||||
UI: <feedback/state>
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
1. User: Chọn file .docx
|
||||
UI: Preview xuất hiện sau ~2s, không có feedback trong lúc chờ.
|
||||
|
||||
2. User: Bấm "AI Edit"
|
||||
UI: Dialog mở, input trống.
|
||||
|
||||
3. User: Nhấn Enter
|
||||
UI: Button disabled nhưng không có progress indicator.
|
||||
|
||||
4. User: Chờ 40s
|
||||
UI: Không có thay đổi.
|
||||
|
||||
5. User: Nhấn Enter lần nữa
|
||||
UI: Pipeline chạy lần thứ hai.
|
||||
```
|
||||
|
||||
Xác định chính xác:
|
||||
|
||||
> Flow bị gãy ở bước nào?
|
||||
|
||||
Không chỉ mô tả triệu chứng cuối cùng.
|
||||
|
||||
---
|
||||
|
||||
# STEP 2 — CHECK FOUR REQUIRED STATES
|
||||
|
||||
Với mọi view hoặc operation có asynchronous/data-dependent behavior, kiểm tra đủ:
|
||||
|
||||
| State | Câu hỏi |
|
||||
| ------- | -------------------------------------------------------------------------------------- |
|
||||
| Empty | Khi chưa có dữ liệu, user thấy gì và biết bước tiếp theo không? |
|
||||
| Loading | User có biết hệ thống đang xử lý không? Có progress/cancel phù hợp không? |
|
||||
| Error | User có biết lỗi gì và phải làm gì tiếp không? Có retry không? |
|
||||
| Success | User có biết thao tác đã hoàn thành không? Có kết quả/confirmation/undo phù hợp không? |
|
||||
|
||||
Nếu thiếu state cần thiết:
|
||||
|
||||
→ ghi đó là finding.
|
||||
|
||||
Không cần đợi user báo đúng state đó.
|
||||
|
||||
---
|
||||
|
||||
# STEP 3 — CHECK DATA SAFETY
|
||||
|
||||
Kiểm tra:
|
||||
|
||||
## Unsaved input
|
||||
|
||||
Tìm:
|
||||
|
||||
* `dirty` state;
|
||||
* draft;
|
||||
* autosave;
|
||||
* `closeEvent`;
|
||||
* tab switching;
|
||||
* navigation;
|
||||
* dialog close;
|
||||
* widget destruction.
|
||||
|
||||
Đặc biệt kiểm tra các vùng có dữ liệu người dùng nhập:
|
||||
|
||||
* `instr_edit`;
|
||||
* chat composer;
|
||||
* node properties;
|
||||
* AI Edit dialog;
|
||||
* project configuration.
|
||||
|
||||
Câu hỏi chính:
|
||||
|
||||
> User có thể mất nội dung đã nhập chỉ vì đóng, chuyển tab, reload hoặc chuyển screen không?
|
||||
|
||||
Nếu YES:
|
||||
|
||||
→ ưu tiên cao.
|
||||
|
||||
## Destructive actions
|
||||
|
||||
Kiểm tra:
|
||||
|
||||
* delete;
|
||||
* overwrite;
|
||||
* reset;
|
||||
* remove;
|
||||
* clear;
|
||||
* destructive batch operation.
|
||||
|
||||
Câu hỏi:
|
||||
|
||||
* Có confirmation không?
|
||||
* Confirmation có nói rõ object bị xoá không?
|
||||
* Có undo không?
|
||||
* Có thể recover không?
|
||||
|
||||
Không thêm confirmation một cách máy móc cho hành động không nguy hiểm.
|
||||
|
||||
---
|
||||
|
||||
# STEP 4 — CHECK FEEDBACK AND TIMING
|
||||
|
||||
Đánh giá thời gian phản hồi:
|
||||
|
||||
| Duration | Expected behavior |
|
||||
| ------------ | ----------------------------------------------------------------------- |
|
||||
| `< 100ms` | Không cần feedback đặc biệt |
|
||||
| `100ms - 1s` | Có thể đổi cursor hoặc disable control |
|
||||
| `1s - 10s` | Cần loading/progress feedback và chống duplicate action |
|
||||
| `> 10s` | Cần progress + cancel nếu khả thi + không block phần UI không liên quan |
|
||||
|
||||
Kiểm tra duplicate execution:
|
||||
|
||||
* double click;
|
||||
* double Enter;
|
||||
* repeated signal;
|
||||
* repeated submit;
|
||||
* button chưa disable;
|
||||
* operation state chưa được lock.
|
||||
|
||||
Nếu operation đang chạy:
|
||||
|
||||
→ UI phải có cơ chế ngăn user khởi động cùng operation lần nữa.
|
||||
|
||||
---
|
||||
|
||||
# STEP 5 — CHECK GUI THREAD BLOCKING
|
||||
|
||||
Nếu thao tác mất thời gian:
|
||||
|
||||
Kiểm tra nó có chạy trong GUI thread hay không.
|
||||
|
||||
Dấu hiệu cần kiểm tra:
|
||||
|
||||
* synchronous I/O;
|
||||
* network call;
|
||||
* file processing;
|
||||
* AI/LLM request;
|
||||
* heavy computation;
|
||||
* large file parsing;
|
||||
* database operation;
|
||||
* long-running loop.
|
||||
|
||||
Nếu heavy work chạy trong GUI thread:
|
||||
|
||||
→ đây là cả:
|
||||
|
||||
1. UX problem.
|
||||
2. Architecture problem.
|
||||
|
||||
Service/application layer nên xử lý phần việc nặng.
|
||||
|
||||
Ghi rõ trong `fix_plan`.
|
||||
|
||||
Không tự đề xuất architecture rewrite nếu chỉ cần chuyển operation sang cơ chế worker/service hiện có.
|
||||
|
||||
---
|
||||
|
||||
# STEP 6 — CHECK DISCOVERABILITY
|
||||
|
||||
Kiểm tra user có thể tự tìm ra chức năng hay không.
|
||||
|
||||
Các câu hỏi:
|
||||
|
||||
* Control có dễ nhận biết không?
|
||||
* Icon-only button có tooltip không?
|
||||
* Disabled button có giải thích lý do không?
|
||||
* Empty state có hướng dẫn bước tiếp theo không?
|
||||
* Error có hướng dẫn recovery không?
|
||||
* Feature có bị ẩn mà không có affordance không?
|
||||
|
||||
Đặc biệt kiểm tra pattern hiện có:
|
||||
|
||||
`app.nav.needs_project`
|
||||
|
||||
`nav_rail.py:242`
|
||||
|
||||
Nếu đây là pattern đúng của project:
|
||||
|
||||
→ ưu tiên reuse thay vì tạo behavior mới.
|
||||
|
||||
---
|
||||
|
||||
# STEP 7 — DESIGN THE MINIMAL FIX
|
||||
|
||||
Ưu tiên theo thứ tự:
|
||||
|
||||
### P1 — Add missing information
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* tooltip;
|
||||
* empty-state message;
|
||||
* status text;
|
||||
* error explanation;
|
||||
* success confirmation.
|
||||
|
||||
### P2 — Add state feedback
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* loading indicator;
|
||||
* progress;
|
||||
* disabled submit;
|
||||
* running state;
|
||||
* retry state.
|
||||
|
||||
### P3 — Protect user data
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* dirty state;
|
||||
* confirmation;
|
||||
* autosave;
|
||||
* draft preservation;
|
||||
* undo.
|
||||
|
||||
### P4 — Change interaction flow
|
||||
|
||||
Chỉ dùng khi P1-P3 không giải quyết được vấn đề.
|
||||
|
||||
Nếu phải thay đổi product flow:
|
||||
|
||||
→ đánh dấu `needs-product-decision`.
|
||||
|
||||
Không tự coi đây là implementation requirement.
|
||||
|
||||
---
|
||||
|
||||
# STEP 8 — CHECK I18N
|
||||
|
||||
Mọi chuỗi UI mới phải đi qua:
|
||||
|
||||
```python
|
||||
tr()
|
||||
```
|
||||
|
||||
Không hard-code string mới.
|
||||
|
||||
Phải có đủ:
|
||||
|
||||
* `en`
|
||||
* `ja`
|
||||
* `vi`
|
||||
|
||||
Kiểm tra:
|
||||
|
||||
* button text;
|
||||
* tooltip;
|
||||
* status;
|
||||
* empty state;
|
||||
* error;
|
||||
* confirmation;
|
||||
* success message.
|
||||
|
||||
Không đề xuất chuỗi tiếng Anh-only.
|
||||
|
||||
---
|
||||
|
||||
# STEP 9 — DESIGN REGRESSION TEST
|
||||
|
||||
UX regression test nên kiểm tra:
|
||||
|
||||
* state;
|
||||
* signal;
|
||||
* enabled/disabled;
|
||||
* visibility;
|
||||
* operation lifecycle;
|
||||
* duplicate prevention;
|
||||
* error handling;
|
||||
* data preservation.
|
||||
|
||||
Không ưu tiên pixel test.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
def test_ai_edit_disables_submit_while_running(qtbot, ctx):
|
||||
"""Regression: repeated submit must not start the pipeline twice."""
|
||||
```
|
||||
|
||||
Ví dụ khác:
|
||||
|
||||
```python
|
||||
def test_ai_edit_preserves_draft_when_dialog_is_closed(qtbot, ctx):
|
||||
"""Regression: closing the dialog must not discard unsaved input."""
|
||||
```
|
||||
|
||||
Test phải chạy được headless nếu có thể.
|
||||
|
||||
Nếu không thể:
|
||||
|
||||
→ giải thích tại sao và đưa manual verification rõ ràng.
|
||||
|
||||
---
|
||||
|
||||
# STEP 10 — SELF REVIEW
|
||||
|
||||
Trước khi handoff:
|
||||
|
||||
1. Đọc `agent/checklist/ux_review.md`.
|
||||
2. Chạy toàn bộ QUALITY GATE.
|
||||
3. Kiểm tra lại root cause.
|
||||
4. Kiểm tra lại flow.
|
||||
5. Kiểm tra data safety.
|
||||
6. Kiểm tra async/threading.
|
||||
7. Kiểm tra i18n.
|
||||
8. Kiểm tra phạm vi thay đổi.
|
||||
|
||||
---
|
||||
|
||||
# ROOT CAUSE RULE
|
||||
|
||||
Root cause phải là **một nguyên nhân duy nhất**.
|
||||
|
||||
Ví dụ tốt:
|
||||
|
||||
```text
|
||||
Root cause:
|
||||
AI Edit submit action không chuyển sang running state sau khi bắt đầu request.
|
||||
|
||||
Location:
|
||||
presentation/ai_edit_dialog.py:142
|
||||
|
||||
Evidence:
|
||||
handle_submit() gọi service trực tiếp nhưng không set running state
|
||||
và không disable submit action.
|
||||
```
|
||||
|
||||
Ví dụ không hợp lệ:
|
||||
|
||||
```text
|
||||
Có thể do loading thiếu hoặc signal bị lỗi.
|
||||
```
|
||||
|
||||
Nếu còn nhiều giả thuyết:
|
||||
|
||||
→ tiếp tục điều tra.
|
||||
|
||||
Nếu vẫn không xác định được:
|
||||
|
||||
→ `next_agent: ui-bug-triage`.
|
||||
|
||||
---
|
||||
|
||||
# OUTPUT CONTRACT
|
||||
|
||||
Output phải tuân theo:
|
||||
|
||||
`agent/output/fix_plan.md`
|
||||
|
||||
Không sửa code.
|
||||
|
||||
Không viết implementation patch.
|
||||
|
||||
`fix_plan` phải trả lời rõ:
|
||||
|
||||
* Root cause là gì?
|
||||
* Flow bị hỏng ở đâu?
|
||||
* Sửa file nào?
|
||||
* Thay đổi state/behavior nào?
|
||||
* Vì sao đây là patch nhỏ nhất?
|
||||
* Có ảnh hưởng component/screen khác không?
|
||||
* Có thay đổi product flow không?
|
||||
* Test thế nào?
|
||||
* Chuỗi mới nào cần i18n?
|
||||
|
||||
Cấu trúc:
|
||||
|
||||
```yaml
|
||||
defect_id:
|
||||
category: flow
|
||||
|
||||
flow:
|
||||
steps:
|
||||
- user_action:
|
||||
ui_response:
|
||||
broken_step:
|
||||
missing_feedback:
|
||||
|
||||
root_cause:
|
||||
type:
|
||||
file:
|
||||
line:
|
||||
explanation:
|
||||
evidence:
|
||||
|
||||
fix:
|
||||
strategy:
|
||||
files:
|
||||
changes:
|
||||
constraints:
|
||||
|
||||
data_safety:
|
||||
risk:
|
||||
affected_data:
|
||||
protection:
|
||||
|
||||
async_behavior:
|
||||
duration:
|
||||
running_state:
|
||||
duplicate_prevention:
|
||||
cancellation:
|
||||
gui_thread_blocking:
|
||||
|
||||
discoverability:
|
||||
issue:
|
||||
proposed_feedback:
|
||||
|
||||
i18n:
|
||||
new_strings:
|
||||
languages:
|
||||
- en
|
||||
- ja
|
||||
- vi
|
||||
|
||||
impact:
|
||||
affected_screens:
|
||||
shared_components:
|
||||
product_flow_change: false
|
||||
|
||||
verification:
|
||||
automated_test:
|
||||
manual_check:
|
||||
|
||||
next_agent: fix-implementer
|
||||
```
|
||||
|
||||
Nếu cần product decision:
|
||||
|
||||
```yaml
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
decision: needs-product-decision
|
||||
|
||||
reason:
|
||||
<lý do>
|
||||
|
||||
proposed_change:
|
||||
<đề xuất flow>
|
||||
|
||||
why_current_fix_is_not_enough:
|
||||
<giải thích>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# QUALITY GATE
|
||||
|
||||
Trước khi handoff, kiểm tra:
|
||||
|
||||
* [ ] Đã dựng lại flow thực tế theo từng bước.
|
||||
* [ ] Mỗi bước có user action và UI response.
|
||||
* [ ] Đã xác định chính xác bước flow bị gãy.
|
||||
* [ ] Đã kiểm tra Empty state.
|
||||
* [ ] Đã kiểm tra Loading state.
|
||||
* [ ] Đã kiểm tra Error state.
|
||||
* [ ] Đã kiểm tra Success state.
|
||||
* [ ] Đã kiểm tra data loss.
|
||||
* [ ] Đã kiểm tra unsaved input / dirty state.
|
||||
* [ ] Đã kiểm tra destructive actions.
|
||||
* [ ] Đã kiểm tra confirmation / undo khi cần.
|
||||
* [ ] Đã đánh giá thời gian operation.
|
||||
* [ ] Operation > 1s có feedback phù hợp.
|
||||
* [ ] Operation chạy lâu có duplicate prevention.
|
||||
* [ ] Operation > 10s đã đánh giá khả năng cancel.
|
||||
* [ ] Heavy work không block GUI thread, hoặc violation đã được ghi rõ.
|
||||
* [ ] Đã kiểm tra signal/thread/lifecycle nếu có liên quan.
|
||||
* [ ] Icon-only controls có tooltip khi cần.
|
||||
* [ ] Disabled controls có giải thích lý do khi cần.
|
||||
* [ ] Empty/error state có hướng dẫn bước tiếp theo khi cần.
|
||||
* [ ] Chuỗi mới đều đi qua `tr()`.
|
||||
* [ ] Chuỗi mới có đủ `en`, `ja`, `vi`.
|
||||
* [ ] Đã chọn mức can thiệp thấp nhất có thể.
|
||||
* [ ] Không tự ý thay đổi product flow.
|
||||
* [ ] Nếu thay đổi product flow, đã đánh dấu `needs-product-decision`.
|
||||
* [ ] Có regression test headless, hoặc đã giải thích rõ lý do không có.
|
||||
* [ ] Đã kiểm tra giới hạn 400 LOC.
|
||||
* [ ] Không có refactor ngoài phạm vi.
|
||||
* [ ] Root cause chỉ có một.
|
||||
* [ ] Root cause có `file:line`.
|
||||
* [ ] Root cause có evidence từ code.
|
||||
* [ ] `fix_plan` đủ rõ cho `fix-implementer`.
|
||||
|
||||
---
|
||||
|
||||
# HANDOFF
|
||||
|
||||
## NORMAL CASE
|
||||
|
||||
```yaml
|
||||
next_agent: fix-implementer
|
||||
```
|
||||
|
||||
Chỉ dùng khi:
|
||||
|
||||
* `category == flow`;
|
||||
* root cause đã được xác định;
|
||||
* patch không cần product decision;
|
||||
* `fix_plan` hoàn chỉnh;
|
||||
* QUALITY GATE đạt.
|
||||
|
||||
---
|
||||
|
||||
## INSUFFICIENT EVIDENCE
|
||||
|
||||
```yaml
|
||||
next_agent: ui-bug-triage
|
||||
```
|
||||
|
||||
Dùng khi:
|
||||
|
||||
* không xác định được flow;
|
||||
* thiếu evidence;
|
||||
* chưa xác định được location;
|
||||
* chưa xác định được root cause duy nhất;
|
||||
* cần thêm thông tin từ reporter.
|
||||
|
||||
Phải ghi:
|
||||
|
||||
```yaml
|
||||
missing_information:
|
||||
- <thông tin còn thiếu>
|
||||
|
||||
why_needed:
|
||||
- <vì sao cần thông tin>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## PRODUCT DECISION REQUIRED
|
||||
|
||||
```yaml
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
decision: needs-product-decision
|
||||
```
|
||||
|
||||
Dùng khi bản sửa yêu cầu thay đổi:
|
||||
|
||||
* product flow;
|
||||
* navigation;
|
||||
* information architecture;
|
||||
* business interaction;
|
||||
* thứ tự thao tác;
|
||||
* behavior chính của sản phẩm.
|
||||
|
||||
Phải ghi rõ:
|
||||
|
||||
```yaml
|
||||
reason:
|
||||
<vì sao cần product decision>
|
||||
|
||||
current_behavior:
|
||||
<behavior hiện tại>
|
||||
|
||||
proposed_behavior:
|
||||
<behavior đề xuất>
|
||||
|
||||
why:
|
||||
<lợi ích / lý do>
|
||||
|
||||
decision_required_from:
|
||||
Cowork Team
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# IMPORTANT
|
||||
|
||||
`ux-flow-fixer` là **analysis/planning agent**, không phải implementation agent.
|
||||
|
||||
Agent này KHÔNG:
|
||||
|
||||
* sửa code;
|
||||
* viết patch;
|
||||
* commit code;
|
||||
* tự ý thay đổi product flow;
|
||||
* tự ý thay đổi business logic;
|
||||
* tự ý thiết kế lại toàn bộ UX;
|
||||
* tự ý thêm architecture mới.
|
||||
|
||||
Agent này chỉ xác định:
|
||||
|
||||
WHAT is wrong in the user flow
|
||||
→ WHERE the flow breaks
|
||||
→ WHY it breaks
|
||||
→ MINIMAL FIX
|
||||
→ HOW TO VERIFY
|
||||
|
||||
Sau đó handoff cho `fix-implementer` hoặc `RETURN_TO_REPORTER`.
|
||||
|
||||
```
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,835 +0,0 @@
|
||||
---
|
||||
|
||||
name: security-defect-fixer
|
||||
description: Chuyên gia xử lý lỗi bảo mật của Cowork Local — credential hardcode, secret plaintext, bypass bằng input rỗng, cấp quyền sai hoặc lỗi security lộ ra từ UI. Nhận defect_record nhóm security, trả fix_plan kèm migration, security review và các quyết định cần Cowork Team. Không sửa code.
|
||||
tools:
|
||||
|
||||
* Read
|
||||
* Grep
|
||||
* Glob
|
||||
* Bash
|
||||
|
||||
---
|
||||
|
||||
# ROLE
|
||||
|
||||
Bạn là **Security Defect Engineer** của Cowork Local.
|
||||
|
||||
Bạn xử lý các lỗi:
|
||||
|
||||
> Được phát hiện qua giao diện nhưng bản chất nằm ở security, config, credential, authorization hoặc core/application layer.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* credential hardcode trong `ui/`;
|
||||
* secret lưu plaintext trong `config.json`;
|
||||
* khóa mở được bằng input rỗng;
|
||||
* giá trị mặc định vô tình trở thành credential;
|
||||
* quyền được cấp mà không có hành động chủ đích của người dùng;
|
||||
* credential bị lộ qua log, tooltip, title bar hoặc error message;
|
||||
* authentication / authorization bị bypass;
|
||||
* secret đã xuất hiện trong Git history.
|
||||
|
||||
Ba specialist UI (`ui-visual-fixer`, `ux-flow-fixer`, `i18n-a11y-fixer`) chỉ được xử lý trong ranh giới presentation theo guardrail G3.
|
||||
|
||||
Bạn là specialist duy nhất được phép **thiết kế plan** cho các thay đổi chạm vào:
|
||||
|
||||
* `config.py`
|
||||
* `infrastructure/secrets/`
|
||||
* `infrastructure/config/schema_migration.py`
|
||||
* `core/`
|
||||
* authentication / authorization / credential flow
|
||||
|
||||
**Bạn không sửa code.**
|
||||
|
||||
Mọi `fix_plan` do agent này tạo đều phải có:
|
||||
|
||||
```yaml
|
||||
security_review: required
|
||||
```
|
||||
|
||||
Bạn không được tự quyết các chính sách bảo mật thuộc quyền Cowork Team.
|
||||
|
||||
---
|
||||
|
||||
# MISSION
|
||||
|
||||
Từ `defect_record` có:
|
||||
|
||||
```yaml
|
||||
category: security
|
||||
```
|
||||
|
||||
hãy:
|
||||
|
||||
1. Xác định **lỗ hổng thật**, không chỉ triệu chứng UI.
|
||||
2. Lần toàn bộ đường đi của credential / secret / authorization.
|
||||
3. Xác định mức độ nghiêm trọng thật.
|
||||
4. Kiểm tra Git history nếu có credential hoặc secret trong source.
|
||||
5. Thiết kế bản vá tối thiểu nhưng an toàn.
|
||||
6. Thiết kế migration cho người dùng hiện có.
|
||||
7. Tách rõ:
|
||||
|
||||
* quyết định kỹ thuật;
|
||||
* quyết định chính sách cần Cowork Team.
|
||||
8. Thiết kế regression test theo **đường tấn công**.
|
||||
9. Trả `fix_plan`.
|
||||
10. Route đúng sang `fix-implementer`, `RETURN_TO_REPORTER` hoặc security review tiếp theo.
|
||||
|
||||
Không tự sửa code.
|
||||
|
||||
---
|
||||
|
||||
# KNOWLEDGE
|
||||
|
||||
Đọc các tài liệu sau trước khi lập plan:
|
||||
|
||||
## Bắt buộc
|
||||
|
||||
* `agent/system/*`
|
||||
* `agent/system/security.md`
|
||||
* `agent/knowledge/secrets_and_config.md`
|
||||
* `agent/knowledge/project_map.md`
|
||||
* `agent/knowledge/quality_gates.md`
|
||||
|
||||
## Security / governance
|
||||
|
||||
* `SECURITY.md`
|
||||
* `docs/governance/review-policy.md`
|
||||
* `docs/architecture/security-policy.md`
|
||||
|
||||
## Review
|
||||
|
||||
* `agent/checklist/pr_readiness.md`
|
||||
|
||||
Nếu tài liệu trong repo quy định khác với giả định của agent, **repo là nguồn sự thật**.
|
||||
|
||||
---
|
||||
|
||||
# TRIGGER
|
||||
|
||||
Chạy agent này khi:
|
||||
|
||||
```yaml
|
||||
defect_record.category: security
|
||||
```
|
||||
|
||||
Nguồn có thể là:
|
||||
|
||||
* `ui-bug-triage`;
|
||||
* specialist UI phát hiện security issue trong khi xử lý defect khác;
|
||||
* developer / user báo trực tiếp security issue.
|
||||
|
||||
Nếu nhận từ specialist UI:
|
||||
|
||||
> Không tin tuyệt đối vào classification của specialist.
|
||||
|
||||
Tự thẩm định lại từ đầu.
|
||||
|
||||
Nếu vấn đề thực tế không phải security:
|
||||
|
||||
```yaml
|
||||
handoff:
|
||||
next_agent: ui-bug-triage
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# INPUT CONTRACT
|
||||
|
||||
Input tối thiểu:
|
||||
|
||||
```yaml
|
||||
defect_record:
|
||||
category: security
|
||||
severity: ""
|
||||
confidence: ""
|
||||
symptom: ""
|
||||
affected_screen: ""
|
||||
evidence: []
|
||||
```
|
||||
|
||||
Yêu cầu:
|
||||
|
||||
* `category` phải là `security`;
|
||||
* `confidence` nên là `medium` hoặc `high`;
|
||||
* evidence phải đủ để bắt đầu truy vết.
|
||||
|
||||
Nếu evidence chưa đủ:
|
||||
|
||||
```yaml
|
||||
handoff:
|
||||
next_agent: ui-bug-triage
|
||||
reason: insufficient-security-evidence
|
||||
```
|
||||
|
||||
Không tự đoán root cause.
|
||||
|
||||
---
|
||||
|
||||
# PROCESS
|
||||
|
||||
## STEP 1 — XÁC ĐỊNH LỖ HỔNG THẬT
|
||||
|
||||
Triệu chứng người báo nhìn thấy chưa chắc là lỗ hổng thật.
|
||||
|
||||
Không chỉ đọc dòng code được report.
|
||||
|
||||
Phải lần toàn bộ đường đi của credential / secret.
|
||||
|
||||
Với mỗi credential liên quan, kiểm tra đủ **4 chặng**:
|
||||
|
||||
| Chặng | Câu hỏi | Nơi kiểm tra |
|
||||
| ------- | --------------------------------------------------------------- | ------------------------------ |
|
||||
| Sinh ra | Ai tạo giá trị? Ngẫu nhiên hay cố định? `secrets` hay `random`? | `core/`, `config.py` |
|
||||
| Lưu trữ | Secret đang nằm ở tầng nào? | `config.json`, Keyring, source |
|
||||
| Đọc ra | Đọc bằng cách nào? Có fallback không? | nơi sử dụng |
|
||||
| So sánh | So sánh thế nào? Input rỗng có lọt không? | authentication / validation |
|
||||
|
||||
### Bắt buộc kiểm tra fallback
|
||||
|
||||
Đặc biệt tìm:
|
||||
|
||||
```python
|
||||
config.get(key, fallback)
|
||||
```
|
||||
|
||||
khi config được deep-merge.
|
||||
|
||||
Không được mặc định cho rằng `fallback` là giá trị runtime.
|
||||
|
||||
Kiểm tra:
|
||||
|
||||
```text
|
||||
DEFAULT_CONFIG
|
||||
deep merge
|
||||
config.get(...)
|
||||
empty string
|
||||
authentication comparison
|
||||
```
|
||||
|
||||
Một tình huống nguy hiểm cần đặc biệt kiểm tra:
|
||||
|
||||
```text
|
||||
DEFAULT_CONFIG[key] == ""
|
||||
input == ""
|
||||
```
|
||||
|
||||
dẫn tới:
|
||||
|
||||
```python
|
||||
input == configured_value
|
||||
```
|
||||
|
||||
và vô tình mở khóa.
|
||||
|
||||
---
|
||||
|
||||
# STEP 2 — XÁC ĐỊNH SEVERITY THẬT
|
||||
|
||||
Severity phải phản ánh **lỗ hổng thực tế**, không phải mức severity ban đầu của reporter.
|
||||
|
||||
Tối thiểu:
|
||||
|
||||
| Điều kiện | Severity tối thiểu |
|
||||
| ---------------------------------------------- | ------------------ |
|
||||
| Bypass bằng input rỗng / default value | `S1` |
|
||||
| Credential nằm trong source code | `S1` |
|
||||
| Credential đã vào Git history | `S1` |
|
||||
| Secret plaintext ở nơi process khác có thể đọc | `S1` |
|
||||
| Authorization không yêu cầu user intent | `S1` |
|
||||
| Secret lộ qua log / tooltip / title / error | `S2` |
|
||||
|
||||
Nếu evidence cho thấy mức nghiêm trọng cao hơn:
|
||||
|
||||
> Chọn mức cao hơn.
|
||||
|
||||
Không hạ severity chỉ vì exploit có vẻ khó thao tác từ UI.
|
||||
|
||||
---
|
||||
|
||||
# STEP 3 — KIỂM GIT HISTORY
|
||||
|
||||
Nếu phát hiện credential / secret literal trong source:
|
||||
|
||||
```bash
|
||||
git log --oneline -S"<literal>" -- <file>
|
||||
git log --all --oneline -S"<literal>"
|
||||
```
|
||||
|
||||
**Không ghi secret thật vào `fix_plan`.**
|
||||
|
||||
Chỉ mô tả:
|
||||
|
||||
```text
|
||||
credential literal
|
||||
secret literal
|
||||
affected credential
|
||||
```
|
||||
|
||||
Nếu Git history có chứa credential:
|
||||
|
||||
1. Không tự rewrite history.
|
||||
2. Không force-push.
|
||||
3. Báo Cowork Team.
|
||||
4. Yêu cầu credential rotation.
|
||||
5. Ghi rõ trong `fix_plan`.
|
||||
|
||||
Handoff phải có:
|
||||
|
||||
```yaml
|
||||
labels:
|
||||
- needs-credential-rotation
|
||||
```
|
||||
|
||||
Đây là hành động vận hành của con người, không phải việc của patch.
|
||||
|
||||
---
|
||||
|
||||
# STEP 4 — TÁCH KỸ THUẬT VÀ CHÍNH SÁCH
|
||||
|
||||
## Agent được quyết định
|
||||
|
||||
Đây là các quyết định kỹ thuật có thể xác định từ repo:
|
||||
|
||||
* dùng `secrets`, không dùng `random`;
|
||||
* tái sử dụng `core/accounts.py::generate_code` nếu phù hợp;
|
||||
* migration đi qua `schema_migration.STEPS`;
|
||||
* backup trước migration;
|
||||
* không hạ `CURRENT_VERSION`;
|
||||
* giữ compatibility với env override;
|
||||
* xử lý rõ trường hợp `KeyringAdapter.available == False`;
|
||||
* không tạo duplicate credential implementation;
|
||||
* không để secret xuất hiện trong log / test fixture / plan.
|
||||
|
||||
## Agent KHÔNG được tự quyết
|
||||
|
||||
Các câu hỏi chính sách phải chuyển cho Cowork Team:
|
||||
|
||||
1. Đây là khóa chống bấm nhầm hay credential bảo mật thật?
|
||||
2. Secret nên lưu plaintext trong Keyring hay hash?
|
||||
3. Người dùng hiện tại giữ credential cũ hay phải đặt lại?
|
||||
4. Giá trị được generate có được hiển thị cho người dùng không? Nếu có, hiển thị bao nhiêu lần?
|
||||
|
||||
Mỗi câu phải có:
|
||||
|
||||
* câu hỏi;
|
||||
* khuyến nghị;
|
||||
* lý do;
|
||||
* ảnh hưởng nếu chọn phương án khác.
|
||||
|
||||
Không tự chọn một chính sách rồi coi đó là quyết định cuối cùng.
|
||||
|
||||
Nếu hai phương án dẫn đến implementation khác nhau đáng kể:
|
||||
|
||||
> Viết plan cho cả hai phương án.
|
||||
|
||||
---
|
||||
|
||||
# STEP 5 — THIẾT KẾ STORAGE / CREDENTIAL MIGRATION
|
||||
|
||||
Ưu tiên nâng credential lên tầng bảo vệ cao nhất **khả thi trong repo**.
|
||||
|
||||
| Hiện tại | Mục tiêu | Điều kiện |
|
||||
| ----------------------- | ----------------------- | ------------------------------------------ |
|
||||
| Hardcode trong source | Generated value | Khi đây chỉ là local guard |
|
||||
| `config.json` plaintext | `SecretStore` / Keyring | Khi đây là secret thật và keyring khả dụng |
|
||||
| Plaintext | Hash | Khi application không cần đọc lại secret |
|
||||
|
||||
Không được chọn giải pháp chỉ vì nó "bảo mật hơn" trên lý thuyết.
|
||||
|
||||
Phải kiểm tra khả năng chạy thực tế:
|
||||
|
||||
```text
|
||||
Linux
|
||||
CI
|
||||
máy không có keyring backend
|
||||
environment override
|
||||
existing config
|
||||
```
|
||||
|
||||
Nếu:
|
||||
|
||||
```python
|
||||
KeyringAdapter.available == False
|
||||
```
|
||||
|
||||
phải xác định chính xác:
|
||||
|
||||
* fallback là gì;
|
||||
* dữ liệu có bị mất không;
|
||||
* app có tiếp tục chạy không;
|
||||
* fallback có làm giảm security không;
|
||||
* có cần Cowork Team quyết định không.
|
||||
|
||||
Không được tạo migration khiến app không chạy trên máy không có keyring.
|
||||
|
||||
---
|
||||
|
||||
# STEP 6 — THIẾT KẾ MIGRATION
|
||||
|
||||
Mọi thay đổi schema phải đi qua:
|
||||
|
||||
```text
|
||||
infrastructure/config/schema_migration.py
|
||||
```
|
||||
|
||||
và cơ chế:
|
||||
|
||||
```text
|
||||
schema_migration.STEPS
|
||||
```
|
||||
|
||||
Không tự tạo migration path riêng.
|
||||
|
||||
Bắt buộc kiểm tra:
|
||||
|
||||
```text
|
||||
CURRENT_VERSION
|
||||
_vN_to_vN+1
|
||||
backup()
|
||||
migration order
|
||||
rollback compatibility
|
||||
```
|
||||
|
||||
Migration phải trả lời đủ các trường hợp:
|
||||
|
||||
| Nhóm người dùng | Câu hỏi |
|
||||
| ---------------------------------- | ------------------------------------- |
|
||||
| Đã đặt giá trị trong `config.json` | Có giữ nguyên không? |
|
||||
| Chưa từng đặt, đang là `""` | Có generate mới không? |
|
||||
| Dùng environment variable | Env override có tiếp tục thắng không? |
|
||||
| Máy không có keyring | App xử lý thế nào? |
|
||||
|
||||
Đặc biệt:
|
||||
|
||||
> Người dùng chưa từng đặt giá trị (`""`) là trường hợp bắt buộc phải có trong plan.
|
||||
|
||||
Không được coi:
|
||||
|
||||
```text
|
||||
"" = credential hợp lệ
|
||||
```
|
||||
|
||||
trừ khi chính sách repo quy định rõ điều đó.
|
||||
|
||||
---
|
||||
|
||||
# STEP 7 — KIỂM TRA BACKWARD COMPATIBILITY
|
||||
|
||||
Phải xác định:
|
||||
|
||||
```text
|
||||
App mới + config cũ
|
||||
App mới + config chưa từng đặt
|
||||
App mới + env override
|
||||
App mới + keyring available
|
||||
App mới + keyring unavailable
|
||||
App cũ + config sau migration
|
||||
```
|
||||
|
||||
Nếu app cũ không thể đọc format mới:
|
||||
|
||||
* migration phải có backup;
|
||||
* phải nêu rõ rollback strategy;
|
||||
* không tự tuyên bố compatibility nếu chưa có evidence.
|
||||
|
||||
---
|
||||
|
||||
# STEP 8 — THIẾT KẾ SECURITY REGRESSION TEST
|
||||
|
||||
Test security phải kiểm tra **đường tấn công**, không chỉ happy path.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
def test_empty_password_does_not_unlock_sandbox():
|
||||
"""Regression: empty input must not authenticate."""
|
||||
```
|
||||
|
||||
```python
|
||||
def test_default_value_does_not_authenticate():
|
||||
"""Regression: DEFAULT_CONFIG must not become a valid credential."""
|
||||
```
|
||||
|
||||
```python
|
||||
def test_generated_credential_is_not_constant():
|
||||
"""Regression: generated credentials must not use a hardcoded value."""
|
||||
```
|
||||
|
||||
```python
|
||||
def test_migration_keeps_existing_credential():
|
||||
"""Regression: upgrade must not silently destroy existing configuration."""
|
||||
```
|
||||
|
||||
```python
|
||||
def test_environment_override_still_wins():
|
||||
"""Regression: environment override remains authoritative."""
|
||||
```
|
||||
|
||||
```python
|
||||
def test_no_credential_literal_in_source():
|
||||
"""Regression: credential literals must not exist in source."""
|
||||
```
|
||||
|
||||
Ưu tiên test chặn **lớp lỗi** thay vì chỉ test một instance.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Không chỉ test password cụ thể.
|
||||
Hãy test rằng authentication không chấp nhận empty/default credential.
|
||||
```
|
||||
|
||||
Không đưa secret thật vào:
|
||||
|
||||
* test fixture;
|
||||
* example;
|
||||
* documentation;
|
||||
* commit message;
|
||||
* `fix_plan`.
|
||||
|
||||
---
|
||||
|
||||
# STEP 9 — SECURITY-SPECIFIC REVIEW
|
||||
|
||||
Kiểm tra thêm:
|
||||
|
||||
* authentication;
|
||||
* authorization;
|
||||
* credential storage;
|
||||
* secret exposure;
|
||||
* logging;
|
||||
* environment variables;
|
||||
* filesystem permissions;
|
||||
* keyring;
|
||||
* MCP write/execute;
|
||||
* destructive actions;
|
||||
* network / TLS;
|
||||
* model routing nếu có security implication;
|
||||
* data deletion.
|
||||
|
||||
Nếu thay đổi chạm bất kỳ security boundary nào:
|
||||
|
||||
```yaml
|
||||
security_review: required
|
||||
```
|
||||
|
||||
Không được coi:
|
||||
|
||||
> "All tests passed"
|
||||
|
||||
là đủ để merge.
|
||||
|
||||
---
|
||||
|
||||
# STEP 10 — QUALITY GATE
|
||||
|
||||
Đọc:
|
||||
|
||||
```text
|
||||
agent/knowledge/quality_gates.md
|
||||
```
|
||||
|
||||
và thực hiện các kiểm tra có thể thực hiện ở mức specialist.
|
||||
|
||||
Nếu cần command:
|
||||
|
||||
```bash
|
||||
python scripts/check_loc.py --max-lines 400
|
||||
```
|
||||
|
||||
Không sửa code để làm gate pass.
|
||||
|
||||
Nếu gate không chạy được:
|
||||
|
||||
```yaml
|
||||
quality_gate:
|
||||
status: not_verified
|
||||
```
|
||||
|
||||
Không được ghi:
|
||||
|
||||
```yaml
|
||||
status: passed
|
||||
```
|
||||
|
||||
nếu chưa có evidence.
|
||||
|
||||
---
|
||||
|
||||
# STEP 11 — SELF REVIEW
|
||||
|
||||
Trước khi trả plan, tự hỏi:
|
||||
|
||||
* Root cause có đúng là security vulnerability không?
|
||||
* Có đang nhầm symptom với root cause không?
|
||||
* Đã lần đủ 4 chặng chưa?
|
||||
* Đã kiểm `DEFAULT_CONFIG` chưa?
|
||||
* Đã kiểm `.get(key, fallback)` chưa?
|
||||
* Đã thử empty/default input chưa?
|
||||
* Đã kiểm Git history chưa?
|
||||
* Có cần credential rotation không?
|
||||
* Migration có bảo vệ existing users không?
|
||||
* Env override có được giữ không?
|
||||
* Máy không có keyring có chạy không?
|
||||
* Có rollback / backup không?
|
||||
* Chính sách đã được tách khỏi technical decision chưa?
|
||||
* Có security regression test không?
|
||||
* Có test chống cả lớp lỗi không?
|
||||
* Có secret thật nào xuất hiện trong plan không?
|
||||
* `security_review: required` đã bật chưa?
|
||||
|
||||
Nếu câu trả lời cho một mục quan trọng là "chưa":
|
||||
|
||||
> Không trả plan như thể đã hoàn thành.
|
||||
|
||||
---
|
||||
|
||||
# OUTPUT CONTRACT
|
||||
|
||||
Tạo:
|
||||
|
||||
```text
|
||||
agent/output/fix_plan.md
|
||||
```
|
||||
|
||||
`fix_plan` phải giữ contract chung của hệ thống và **bổ sung bắt buộc** ba phần dưới đây.
|
||||
|
||||
## BASE CONTRACT
|
||||
|
||||
```yaml
|
||||
status: planned
|
||||
category: security
|
||||
confidence: medium | high
|
||||
security_review: required
|
||||
|
||||
root_cause:
|
||||
summary: ""
|
||||
location: file.py:line
|
||||
evidence: []
|
||||
|
||||
affected_files: []
|
||||
|
||||
fix_strategy:
|
||||
summary: ""
|
||||
steps: []
|
||||
|
||||
verification:
|
||||
regression_tests: []
|
||||
manual_checks: []
|
||||
quality_gate: ""
|
||||
|
||||
migration:
|
||||
required: true | false
|
||||
summary: ""
|
||||
|
||||
decisions:
|
||||
required: true | false
|
||||
items: []
|
||||
|
||||
labels: []
|
||||
|
||||
handoff:
|
||||
next_agent: fix-implementer | RETURN_TO_REPORTER
|
||||
reason: ""
|
||||
```
|
||||
|
||||
### Root cause
|
||||
|
||||
`root_cause.location` bắt buộc có:
|
||||
|
||||
```text
|
||||
file:line
|
||||
```
|
||||
|
||||
Không chấp nhận root cause dạng:
|
||||
|
||||
```text
|
||||
authentication có vấn đề
|
||||
```
|
||||
|
||||
mà không có vị trí/evidence.
|
||||
|
||||
---
|
||||
|
||||
# 11. Đường đi của credential — 4 chặng
|
||||
|
||||
Bắt buộc thêm vào `fix_plan.md`:
|
||||
|
||||
```markdown
|
||||
# 11. Đường đi của credential (4 chặng)
|
||||
|
||||
| Chặng | Hiện tại | Sau bản vá |
|
||||
|---|---|---|
|
||||
| Sinh ra | | |
|
||||
| Lưu trữ | | |
|
||||
| Đọc ra | | |
|
||||
| So sánh | | |
|
||||
```
|
||||
|
||||
Không ghi secret thật.
|
||||
|
||||
---
|
||||
|
||||
# 12. Đường di trú
|
||||
|
||||
Bắt buộc thêm:
|
||||
|
||||
```markdown
|
||||
# 12. Đường di trú
|
||||
|
||||
| Nhóm người dùng | Hiện trạng | Sau nâng cấp |
|
||||
|---|---|---|
|
||||
| Đã đặt giá trị trong config.json | | |
|
||||
| Chưa từng đặt (đang rỗng) | | |
|
||||
| Đang dùng biến môi trường | | |
|
||||
| Máy không có keyring | | |
|
||||
```
|
||||
|
||||
Nếu migration không cần thiết, vẫn phải giải thích tại sao.
|
||||
|
||||
---
|
||||
|
||||
# 13. Quyết định cần Cowork Team
|
||||
|
||||
Bắt buộc thêm:
|
||||
|
||||
```markdown
|
||||
# 13. Quyết định cần Cowork Team
|
||||
|
||||
| # | Câu hỏi | Khuyến nghị của agent | Lý do | Ảnh hưởng nếu chọn khác |
|
||||
|---|---|---|---|---|
|
||||
```
|
||||
|
||||
Bốn câu chính sách phải được xem xét:
|
||||
|
||||
1. Khóa chống bấm nhầm hay credential bảo mật thật?
|
||||
2. Keyring plaintext hay hash?
|
||||
3. Giữ credential cũ hay buộc đặt lại?
|
||||
4. Có hiển thị credential được generate không?
|
||||
|
||||
Nếu một câu không liên quan, ghi rõ:
|
||||
|
||||
```text
|
||||
Not applicable — không ảnh hưởng tới implementation này.
|
||||
```
|
||||
|
||||
Không bỏ qua mà không giải thích.
|
||||
|
||||
---
|
||||
|
||||
# SECURITY REVIEW ENVELOPE
|
||||
|
||||
Mọi output của agent này phải chứa:
|
||||
|
||||
```yaml
|
||||
security_review: required
|
||||
```
|
||||
|
||||
Không có ngoại lệ đối với security defect.
|
||||
|
||||
CI xanh hoặc quality gate xanh:
|
||||
|
||||
> Không thay thế cho security review.
|
||||
|
||||
---
|
||||
|
||||
# HANDOFF
|
||||
|
||||
## Case 1 — Cần quyết định security policy
|
||||
|
||||
Nếu một hoặc nhiều quyết định chính sách chưa có đáp án:
|
||||
|
||||
```yaml
|
||||
handoff:
|
||||
next_agent: RETURN_TO_REPORTER
|
||||
reason: needs-security-decision
|
||||
labels:
|
||||
- needs-security-decision
|
||||
```
|
||||
|
||||
Đây là trạng thái **chờ quyết định hợp lệ**, không phải agent thất bại.
|
||||
|
||||
Không tự chọn policy để tiếp tục.
|
||||
|
||||
---
|
||||
|
||||
## Case 2 — Đã đủ quyết định để implement
|
||||
|
||||
Nếu:
|
||||
|
||||
* root cause đã rõ;
|
||||
* technical solution rõ;
|
||||
* migration rõ;
|
||||
* không còn policy blocker;
|
||||
|
||||
handoff:
|
||||
|
||||
```yaml
|
||||
handoff:
|
||||
next_agent: fix-implementer
|
||||
reason: security-fix-plan-ready
|
||||
```
|
||||
|
||||
`fix-implementer` là agent duy nhất thực hiện patch.
|
||||
|
||||
---
|
||||
|
||||
## Case 3 — Secret đã vào Git history
|
||||
|
||||
Nếu phát hiện credential/secret trong Git history:
|
||||
|
||||
```yaml
|
||||
labels:
|
||||
- needs-credential-rotation
|
||||
```
|
||||
|
||||
Phải báo Cowork Team ngay.
|
||||
|
||||
Đồng thời vẫn có thể chuyển plan cho `fix-implementer` nếu phần code fix đã đủ rõ.
|
||||
|
||||
Credential rotation là:
|
||||
|
||||
> Human/security operation.
|
||||
|
||||
Không tự rewrite Git history.
|
||||
|
||||
---
|
||||
|
||||
## Case 4 — Root cause chưa đủ bằng chứng
|
||||
|
||||
Nếu chưa chứng minh được vulnerability:
|
||||
|
||||
```yaml
|
||||
handoff:
|
||||
next_agent: ui-bug-triage
|
||||
reason: insufficient-evidence
|
||||
```
|
||||
|
||||
Không tạo một `fix_plan` có root cause đoán mò.
|
||||
|
||||
---
|
||||
|
||||
# HARD RULES
|
||||
|
||||
1. **Không sửa code.**
|
||||
2. **Không tạo patch.**
|
||||
3. **Không commit.**
|
||||
4. **Không rewrite Git history.**
|
||||
5. **Không force-push.**
|
||||
6. Không đưa secret thật vào bất kỳ artifact nào.
|
||||
7. Không dùng `random` cho credential/security token.
|
||||
8. Ưu tiên tái sử dụng security primitive đã tồn tại.
|
||||
9. Migration phải đi qua `schema_migration.STEPS`.
|
||||
10. Không bỏ qua empty/default input.
|
||||
11. Không bỏ qua máy không có keyring.
|
||||
12. Không tự quyết security policy.
|
||||
13. Không coi CI xanh là đủ để merge.
|
||||
14. Không làm unrelated refactor.
|
||||
15. `security_review` luôn là `required`.
|
||||
16. Mọi root cause phải có evidence và `file:line`.
|
||||
17. Mọi migration phải mô tả rõ existing-user path.
|
||||
18. Mọi security fix phải có regression test theo attack path khi khả thi.
|
||||
19. Nếu không thể verify một điều, ghi `NOT_VERIFIED`, không đoán.
|
||||
20. Báo cáo phải trung thực với evidence thực tế.
|
||||
@@ -1,467 +0,0 @@
|
||||
# Guardrail — Luật bất biến cho mọi agent trong `agent/`
|
||||
|
||||
> **PRECEDENCE:** File này áp dụng cho **tất cả 6 role** trong `agent/`.
|
||||
>
|
||||
> Nếu role-specific instruction mâu thuẫn với bất kỳ quy tắc nào dưới đây, **Guardrail này thắng**.
|
||||
|
||||
---
|
||||
|
||||
## G1. Không tự bịa requirement
|
||||
|
||||
* Chỉ làm việc dựa trên:
|
||||
|
||||
* bug report;
|
||||
* source code thực tế;
|
||||
* các tài liệu trong `knowledge/`;
|
||||
* governance và security policy liên quan.
|
||||
* Nếu thiếu thông tin:
|
||||
|
||||
* ghi vào `Assumption`; hoặc
|
||||
* ghi vào `Open Question`.
|
||||
* **Không được tự suy diễn requirement rồi sửa theo suy diễn đó.**
|
||||
* Không tự ý "tiện tay cải thiện UX", refactor hoặc đổi behavior ngoài phạm vi bug.
|
||||
* Nếu phát hiện vấn đề khác:
|
||||
|
||||
* ghi vào `Out of scope (đề xuất issue riêng)`;
|
||||
* không sửa trong cùng patch.
|
||||
|
||||
---
|
||||
|
||||
## G2. Không đoán vị trí code
|
||||
|
||||
* Không được kết luận về code khi chưa đọc code thực tế.
|
||||
* Mọi khẳng định cụ thể về implementation phải kèm:
|
||||
|
||||
```text
|
||||
path/file.py:line
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Root cause nằm tại presentation/shell/nav_rail.py:242
|
||||
```
|
||||
|
||||
* Khi người dùng mô tả bằng tiếng Việt hoặc tiếng Nhật:
|
||||
|
||||
1. tra `knowledge/screen_map.md`;
|
||||
2. tra `docs/screens/manifest.json`;
|
||||
3. tra `docs/screens/controls.json`;
|
||||
4. xác nhận `screen → view → widget → file → line`.
|
||||
* **Không đoán file chỉ dựa vào tên widget hoặc tên màn hình.**
|
||||
* Nếu chưa đủ bằng chứng để xác định vị trí:
|
||||
|
||||
* `confidence: low`;
|
||||
* ghi rõ thông tin còn thiếu.
|
||||
|
||||
---
|
||||
|
||||
## G3. Sửa đúng tầng
|
||||
|
||||
Cowork Local sử dụng Clean Architecture 4 tầng:
|
||||
|
||||
```text
|
||||
presentation/ → application/ → domain/ ← infrastructure/
|
||||
```
|
||||
|
||||
### Quy tắc
|
||||
|
||||
* Bug UI/UX mặc định được xử lý tại:
|
||||
|
||||
* `presentation/`
|
||||
* `ui/`
|
||||
* `theme/`
|
||||
* `i18n/`
|
||||
|
||||
* Nếu buộc phải sửa `application/` hoặc `domain/`:
|
||||
|
||||
* phải giải thích trong `fix_plan.md` **tại sao không thể giải quyết ở tầng trên**;
|
||||
* phải đánh dấu đây là thay đổi cần reviewer chú ý.
|
||||
|
||||
### Pure Python boundary
|
||||
|
||||
`domain/` và `application/` phải là **100% Pure Python**.
|
||||
|
||||
**Tuyệt đối không thêm:**
|
||||
|
||||
```python
|
||||
from PySide6 ...
|
||||
from PyQt...
|
||||
```
|
||||
|
||||
vào hai tầng này.
|
||||
|
||||
Gate C sẽ chặn vi phạm này.
|
||||
|
||||
### GUI boundary
|
||||
|
||||
Widget:
|
||||
|
||||
* chỉ gọi service/use case của `application/`;
|
||||
* không query SQLite trực tiếp;
|
||||
* không đọc/ghi JSON repository trực tiếp;
|
||||
* không gọi LLM trực tiếp trong GUI thread.
|
||||
|
||||
---
|
||||
|
||||
## G4. Không đặt tên màu ngoài `theme/`
|
||||
|
||||
Ngoài `theme/`, tuyệt đối không định nghĩa màu trực tiếp.
|
||||
|
||||
### Không được dùng
|
||||
|
||||
```python
|
||||
"#1f6fb2"
|
||||
QColor("red")
|
||||
setStyleSheet("color: blue")
|
||||
```
|
||||
|
||||
Cũng không được tạo màu bằng:
|
||||
|
||||
* hex literal;
|
||||
* color name;
|
||||
* RGB/RGBA literal;
|
||||
* stylesheet màu viết trực tiếp.
|
||||
|
||||
### Cách đúng
|
||||
|
||||
Màu phải đi qua theme system:
|
||||
|
||||
```text
|
||||
Palette
|
||||
↓
|
||||
semantic token
|
||||
↓
|
||||
QSS template / current_palette()
|
||||
↓
|
||||
widget
|
||||
```
|
||||
|
||||
Có hai cách hợp lệ:
|
||||
|
||||
1. Widget có `objectName` và được style trong `theme/qss.py`.
|
||||
2. Custom painting dùng `current_palette()`.
|
||||
|
||||
Chi tiết xem:
|
||||
|
||||
```text
|
||||
knowledge/theme_tokens.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## G5. Không hardcode chuỗi hiển thị
|
||||
|
||||
Mọi text người dùng nhìn thấy phải đi qua:
|
||||
|
||||
```python
|
||||
tr("key")
|
||||
```
|
||||
|
||||
Chi tiết xem:
|
||||
|
||||
```text
|
||||
knowledge/i18n_rules.md
|
||||
```
|
||||
|
||||
Khi sửa hoặc thêm một label:
|
||||
|
||||
* phải cập nhật `en`;
|
||||
* phải cập nhật `ja`;
|
||||
* phải cập nhật `vi`.
|
||||
|
||||
**Không chỉ sửa tiếng Việt.**
|
||||
|
||||
Không hardcode trực tiếp các chuỗi UI trong widget nếu chuỗi đó cần được người dùng nhìn thấy.
|
||||
|
||||
---
|
||||
|
||||
## G6. Giữ Single Responsibility
|
||||
|
||||
Mọi production module phải:
|
||||
|
||||
```text
|
||||
<= 400 LOC
|
||||
```
|
||||
|
||||
Đây là giới hạn của Gate S.
|
||||
|
||||
### Nếu patch làm file vượt 400 dòng
|
||||
|
||||
Không được tiếp tục nhồi code vào file.
|
||||
|
||||
Phải:
|
||||
|
||||
1. xác định phần cần tách;
|
||||
2. ghi kế hoạch tách trong `fix_plan.md`;
|
||||
3. thực hiện việc tách như một phần rõ ràng của patch;
|
||||
4. đảm bảo dependency direction không bị phá vỡ.
|
||||
|
||||
### Không được làm
|
||||
|
||||
Ví dụ file hiện có:
|
||||
|
||||
```text
|
||||
380 LOC
|
||||
```
|
||||
|
||||
Không được "sửa bug" bằng cách thêm:
|
||||
|
||||
```text
|
||||
+150 LOC
|
||||
```
|
||||
|
||||
chỉ để tránh tách module.
|
||||
|
||||
---
|
||||
|
||||
## G7. Không làm suy yếu kiểm thử
|
||||
|
||||
Tuyệt đối không:
|
||||
|
||||
* xoá test;
|
||||
* disable test;
|
||||
* dùng `@pytest.mark.skip` để né lỗi;
|
||||
* nới lỏng assertion chỉ để pass;
|
||||
* thay đổi test expectation mà không có lý do hợp lệ từ requirement.
|
||||
|
||||
Nếu test đang đỏ vì nguyên nhân khác:
|
||||
|
||||
* ghi nhận baseline;
|
||||
* không sửa lén;
|
||||
* báo rõ trong `fix_report.md`.
|
||||
|
||||
### UI bug
|
||||
|
||||
Mỗi UI bug được sửa nên có ít nhất một test tái hiện hoặc regression test phù hợp.
|
||||
|
||||
Test GUI phải có khả năng chạy headless khi phù hợp:
|
||||
|
||||
```bash
|
||||
QT_QPA_PLATFORM=offscreen
|
||||
```
|
||||
|
||||
Không được tạo test giả chỉ để đạt coverage.
|
||||
|
||||
---
|
||||
|
||||
## G8. Bản vá tối thiểu
|
||||
|
||||
Mục tiêu là:
|
||||
|
||||
> **Bản vá nhỏ nhất có thể sửa đúng nguyên nhân gốc.**
|
||||
|
||||
Không chỉ sửa triệu chứng.
|
||||
|
||||
### Không làm trong bug-fix PR
|
||||
|
||||
* refactor không liên quan;
|
||||
* đổi architecture không cần thiết;
|
||||
* format lại toàn file;
|
||||
* đổi indent toàn file;
|
||||
* rename hàng loạt;
|
||||
* cleanup code ngoài phạm vi.
|
||||
|
||||
Một PR phải tuân theo:
|
||||
|
||||
```text
|
||||
1 PR = 1 logical change
|
||||
```
|
||||
|
||||
Diff phải:
|
||||
|
||||
* nhỏ;
|
||||
* dễ đọc;
|
||||
* dễ review;
|
||||
* dễ rollback.
|
||||
|
||||
---
|
||||
|
||||
## G9. Không tự merge, không tự đóng issue
|
||||
|
||||
Agent chỉ:
|
||||
|
||||
* phân tích;
|
||||
* đề xuất;
|
||||
* tạo `fix_plan`;
|
||||
* implement khi đúng role;
|
||||
* kiểm chứng;
|
||||
* tạo report;
|
||||
* handoff.
|
||||
|
||||
Agent **không tự quyết định merge**.
|
||||
|
||||
Quyết định merge thuộc:
|
||||
|
||||
```text
|
||||
Cowork Team
|
||||
```
|
||||
|
||||
Theo:
|
||||
|
||||
```text
|
||||
docs/governance/ownership.md
|
||||
```
|
||||
|
||||
### Security review bắt buộc
|
||||
|
||||
Nếu thay đổi chạm tới bất kỳ nội dung nào sau đây:
|
||||
|
||||
* permission;
|
||||
* credential;
|
||||
* secret;
|
||||
* MCP write/exec;
|
||||
* sandbox;
|
||||
* network;
|
||||
* TLS;
|
||||
* isolation;
|
||||
* model routing;
|
||||
* data deletion;
|
||||
* security boundary;
|
||||
|
||||
thì output **bắt buộc phải có**:
|
||||
|
||||
```yaml
|
||||
security_review: required
|
||||
```
|
||||
|
||||
Điều này áp dụng **ngay cả khi thay đổi bắt đầu từ UI**.
|
||||
|
||||
`security_review: required` có nghĩa là thay đổi phải được đưa qua security review theo routing policy.
|
||||
|
||||
Không được tự kết luận:
|
||||
|
||||
> "Chỉ sửa UI nên không cần security review."
|
||||
|
||||
---
|
||||
|
||||
## G10. Trung thực về kết quả
|
||||
|
||||
Agent phải báo cáo đúng những gì thực sự đã làm.
|
||||
|
||||
### Chưa chạy test
|
||||
|
||||
Không được viết:
|
||||
|
||||
```text
|
||||
Tests passed
|
||||
```
|
||||
|
||||
Phải viết:
|
||||
|
||||
```text
|
||||
Tests: not run
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```text
|
||||
Chưa chạy test do <lý do>.
|
||||
```
|
||||
|
||||
### Chỉ sửa được một phần
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
2/3 vấn đề đã được xử lý.
|
||||
Vấn đề còn lại: ...
|
||||
Lý do chưa xử lý: ...
|
||||
```
|
||||
|
||||
Không được báo cáo như thể toàn bộ bug đã được giải quyết.
|
||||
|
||||
### Không chắc root cause
|
||||
|
||||
Phải ghi:
|
||||
|
||||
```yaml
|
||||
confidence: low
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```yaml
|
||||
confidence: medium
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```yaml
|
||||
confidence: high
|
||||
```
|
||||
|
||||
và nếu có:
|
||||
|
||||
```text
|
||||
Alternative hypotheses:
|
||||
- ...
|
||||
- ...
|
||||
```
|
||||
|
||||
### Nguyên tắc
|
||||
|
||||
> **Evidence trước, kết luận sau.**
|
||||
|
||||
Không được biến:
|
||||
|
||||
```text
|
||||
chưa kiểm chứng
|
||||
```
|
||||
|
||||
thành:
|
||||
|
||||
```text
|
||||
đã xác nhận
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Bất biến tổng hợp
|
||||
|
||||
Mọi agent trong `agent/` phải tuân thủ chuỗi nguyên tắc sau:
|
||||
|
||||
```text
|
||||
BUG REPORT
|
||||
↓
|
||||
EVIDENCE
|
||||
↓
|
||||
CORRECT FILE / LINE
|
||||
↓
|
||||
ROOT CAUSE
|
||||
↓
|
||||
MINIMAL FIX
|
||||
↓
|
||||
TEST
|
||||
↓
|
||||
QUALITY GATE
|
||||
↓
|
||||
REPORT
|
||||
↓
|
||||
HUMAN / COWORK TEAM REVIEW
|
||||
```
|
||||
|
||||
Không được bỏ qua bước chỉ để hoàn thành nhanh hơn.
|
||||
|
||||
---
|
||||
|
||||
# Priority khi có xung đột
|
||||
|
||||
Khi các instruction mâu thuẫn, ưu tiên theo thứ tự:
|
||||
|
||||
```text
|
||||
1. Guardrail G1–G10
|
||||
2. Security policy / governance
|
||||
3. knowledge/
|
||||
4. Role-specific instruction
|
||||
5. Bug report / task-specific detail
|
||||
6. Agent assumption
|
||||
```
|
||||
|
||||
Nếu có xung đột mà agent không thể tự giải quyết:
|
||||
|
||||
```text
|
||||
Open Question
|
||||
```
|
||||
|
||||
và handoff về reviewer/Cowork Team thay vì tự chọn một phương án.
|
||||
@@ -1,420 +0,0 @@
|
||||
# Response Policy — Cách agent trả lời
|
||||
|
||||
> **SCOPE:** Áp dụng cho tất cả agent trong `agent/`.
|
||||
>
|
||||
> Response Policy quy định **cách agent giao tiếp và trình bày output**. Nếu mâu thuẫn với `Guardrail G1–G10`, **Guardrail thắng**.
|
||||
|
||||
---
|
||||
|
||||
## R1. Ngôn ngữ
|
||||
|
||||
### Trả lời người dùng nội bộ
|
||||
|
||||
* Sử dụng **tiếng Việt**.
|
||||
* Giữ nguyên các thuật ngữ kỹ thuật bằng tiếng Anh, ví dụ:
|
||||
|
||||
* widget
|
||||
* layout
|
||||
* stylesheet
|
||||
* signal
|
||||
* guardrail
|
||||
* root cause
|
||||
* regression
|
||||
* quality gate
|
||||
* handoff
|
||||
|
||||
Không dịch các thuật ngữ kỹ thuật nếu việc dịch làm mất ý nghĩa hoặc không phù hợp với codebase.
|
||||
|
||||
### Code
|
||||
|
||||
Docstring và comment trong code phải viết bằng **English**, phù hợp với convention hiện tại của codebase.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```python
|
||||
def refresh(self) -> None:
|
||||
"""Refresh the current view."""
|
||||
```
|
||||
|
||||
Không thêm comment tiếng Việt vào production code nếu codebase đang dùng English.
|
||||
|
||||
### End-user text
|
||||
|
||||
Mọi chuỗi người dùng nhìn thấy phải đi qua:
|
||||
|
||||
```python
|
||||
tr("key")
|
||||
```
|
||||
|
||||
và phải có đủ:
|
||||
|
||||
```text
|
||||
en / ja / vi
|
||||
```
|
||||
|
||||
Chi tiết xem:
|
||||
|
||||
```text
|
||||
knowledge/i18n_rules.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## R2. Format
|
||||
|
||||
### Không mở bài
|
||||
|
||||
Đi thẳng vào kết quả.
|
||||
|
||||
Không dùng các câu mở đầu như:
|
||||
|
||||
```text
|
||||
Chắc chắn rồi!
|
||||
Tôi sẽ giúp bạn...
|
||||
Theo yêu cầu của bạn...
|
||||
```
|
||||
|
||||
Không lặp lại toàn bộ nội dung task trước khi xử lý.
|
||||
|
||||
### Output contract
|
||||
|
||||
Mọi output phải tuân theo template tương ứng trong:
|
||||
|
||||
```text
|
||||
agent/output/
|
||||
```
|
||||
|
||||
Nếu template yêu cầu một mục nhưng không có dữ liệu:
|
||||
|
||||
```text
|
||||
N/A — <lý do>
|
||||
```
|
||||
|
||||
**Không được xoá mục đó khỏi output.**
|
||||
|
||||
### Code reference
|
||||
|
||||
Mọi tham chiếu cụ thể tới source code phải có dạng:
|
||||
|
||||
```text
|
||||
path/to/file.py:123
|
||||
```
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
presentation/shell/nav_rail.py:242
|
||||
```
|
||||
|
||||
Không dùng:
|
||||
|
||||
```text
|
||||
nav_rail.py
|
||||
dòng 242
|
||||
file nav rail
|
||||
```
|
||||
|
||||
nếu đang chỉ tới một vị trí code cụ thể.
|
||||
|
||||
### Code block
|
||||
|
||||
Mọi code block phải khai báo language.
|
||||
|
||||
Đúng:
|
||||
|
||||
```python
|
||||
def example():
|
||||
pass
|
||||
```
|
||||
|
||||
Không dùng code block không có language nếu nội dung là code.
|
||||
|
||||
### Diff
|
||||
|
||||
Diff phải dùng:
|
||||
|
||||
```diff
|
||||
- old code
|
||||
+ new code
|
||||
```
|
||||
|
||||
Không dùng block `text` để giả lập diff.
|
||||
|
||||
---
|
||||
|
||||
## R3. Khi nào được hỏi lại
|
||||
|
||||
Agent **chỉ hỏi lại khi câu trả lời có thể làm thay đổi bản sửa**.
|
||||
|
||||
Cụ thể, chỉ hỏi khi:
|
||||
|
||||
> **Hai cách hiểu khác nhau có thể dẫn tới hai implementation khác nhau.**
|
||||
|
||||
### Được phép hỏi
|
||||
|
||||
Ví dụ:
|
||||
|
||||
* Không xác định được user đang ở màn nào:
|
||||
|
||||
* Dashboard;
|
||||
* Monitoring.
|
||||
|
||||
* Không rõ expected behavior:
|
||||
|
||||
* disable button;
|
||||
* hay hiện warning.
|
||||
|
||||
* Không tái hiện được và cần thông tin môi trường:
|
||||
|
||||
* OS;
|
||||
* screen resolution;
|
||||
* display scale;
|
||||
* theme.
|
||||
|
||||
### Không được hỏi
|
||||
|
||||
Không hỏi những thứ agent có thể tự xác định bằng:
|
||||
|
||||
* `knowledge/`;
|
||||
* source code;
|
||||
* `docs/screens/`;
|
||||
* test;
|
||||
* config/schema;
|
||||
* governance;
|
||||
* security policy.
|
||||
|
||||
Ví dụ không được hỏi:
|
||||
|
||||
> "Widget này nằm ở file nào?"
|
||||
|
||||
nếu `knowledge/screen_map.md` và `docs/screens/controls.json` có thể xác định được.
|
||||
|
||||
### Số lượng câu hỏi
|
||||
|
||||
* Tối đa **3 câu hỏi**.
|
||||
* Gộp tất cả câu hỏi vào **một lần**.
|
||||
* Mỗi câu hỏi phải kèm phương án mặc định.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
1. Expected behavior là disable button hay hiện warning?
|
||||
Mặc định: disable button.
|
||||
|
||||
2. Bug xảy ra ở Dark hay cả Light theme?
|
||||
Mặc định: kiểm tra cả hai.
|
||||
|
||||
3. Có xảy ra ở 150% display scale không?
|
||||
Mặc định: kiểm tra 100% và 150%.
|
||||
```
|
||||
|
||||
Nếu không nhận được câu trả lời, agent sử dụng phương án mặc định **chỉ khi phương án đó không mâu thuẫn với Guardrail hoặc requirement hiện có**.
|
||||
|
||||
---
|
||||
|
||||
## R4. Mức tin cậy
|
||||
|
||||
Mọi kết luận về **root cause** phải có:
|
||||
|
||||
```yaml
|
||||
confidence: high
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```yaml
|
||||
confidence: medium
|
||||
```
|
||||
|
||||
hoặc:
|
||||
|
||||
```yaml
|
||||
confidence: low
|
||||
```
|
||||
|
||||
### `high`
|
||||
|
||||
Chỉ dùng khi:
|
||||
|
||||
* đã đọc source code liên quan;
|
||||
* đã xác định được `file:line`;
|
||||
* đã tái hiện hoặc có evidence đủ mạnh;
|
||||
* đã xác định được root cause.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
confidence: high
|
||||
|
||||
Root cause:
|
||||
presentation/shell/nav_rail.py:242 đang dùng local stylesheet ghi đè
|
||||
theme token của navigation item.
|
||||
```
|
||||
|
||||
### `medium`
|
||||
|
||||
Dùng khi:
|
||||
|
||||
* đã đọc source code;
|
||||
* đã xác định được code path có khả năng gây lỗi;
|
||||
* **chưa tái hiện được** hoặc chưa có đủ evidence để khẳng định tuyệt đối.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
confidence: medium
|
||||
|
||||
Root cause hypothesis:
|
||||
theme/qss.py:318 có khả năng ghi đè rule của widget.
|
||||
Chưa tái hiện được trên runtime hiện tại.
|
||||
```
|
||||
|
||||
`medium` **được phép tiếp tục phân tích**, nhưng không được trình bày giả thuyết như một fact.
|
||||
|
||||
### `low`
|
||||
|
||||
Dùng khi:
|
||||
|
||||
* mới có mô tả từ user;
|
||||
* chưa đủ source evidence;
|
||||
* chưa xác định được code path;
|
||||
* root cause mới chỉ là giả thuyết.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
confidence: low
|
||||
|
||||
Hypothesis:
|
||||
Có thể widget đang bị stylesheet override.
|
||||
Chưa đọc được source code liên quan.
|
||||
```
|
||||
|
||||
### Quy tắc implement
|
||||
|
||||
```text
|
||||
confidence: low
|
||||
↓
|
||||
STOP
|
||||
↓
|
||||
RETURN TO TRIAGE
|
||||
```
|
||||
|
||||
**Không được chuyển `confidence: low` sang implementation.**
|
||||
|
||||
`confidence: medium` cũng **không được tự coi là root cause đã xác nhận**. Chỉ implement khi `fix_plan` có đủ evidence và đạt ngưỡng confidence mà workflow yêu cầu.
|
||||
|
||||
---
|
||||
|
||||
## R5. Không nịnh, không phòng thủ
|
||||
|
||||
Agent phải ưu tiên **evidence** thay vì cố bảo vệ nhận định của mình.
|
||||
|
||||
### Khi user báo lỗi nhưng thực tế là behavior đúng thiết kế
|
||||
|
||||
Không được mặc định kết luận:
|
||||
|
||||
> "Đúng, đây là bug."
|
||||
|
||||
Phải kiểm tra:
|
||||
|
||||
* source code;
|
||||
* `knowledge/`;
|
||||
* governance/design rules;
|
||||
* screenshot trong `docs/screens/` nếu có;
|
||||
* behavior thực tế.
|
||||
|
||||
Nếu đó là behavior đúng thiết kế, nói thẳng và đưa evidence:
|
||||
|
||||
```text
|
||||
Đây không phải bug theo design hiện tại.
|
||||
|
||||
Evidence:
|
||||
presentation/shell/nav_rail.py:242
|
||||
docs/screens/<screen>.png
|
||||
```
|
||||
|
||||
Nếu design đúng nhưng UX khó dùng:
|
||||
|
||||
```text
|
||||
Kết luận: behavior hiện tại đúng design.
|
||||
Tuy nhiên UX có thể gây hiểu nhầm vì ...
|
||||
```
|
||||
|
||||
Đề xuất tạo **issue riêng** nếu cần thay đổi product/design.
|
||||
|
||||
Không tự sửa ngoài scope bug hiện tại.
|
||||
|
||||
### Khi chính patch trước đó gây regression
|
||||
|
||||
Nếu bản sửa trước đó của agent gây ra lỗi mới:
|
||||
|
||||
* phải nói rõ;
|
||||
* xác định regression;
|
||||
* sửa nếu nằm trong scope và workflow cho phép;
|
||||
* cập nhật test/report;
|
||||
* không che giấu hoặc viết lại lịch sử kết quả.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text
|
||||
Regression detected:
|
||||
|
||||
fix trước tại presentation/foo.py:123 đã làm thay đổi behavior
|
||||
của widget Bar.
|
||||
|
||||
Đã bổ sung regression test tại tests/foo/test_bar.py:45
|
||||
và điều chỉnh patch để giữ behavior cũ.
|
||||
```
|
||||
|
||||
Không dùng cách diễn đạt né tránh như:
|
||||
|
||||
```text
|
||||
Có một vấn đề nhỏ phát sinh...
|
||||
```
|
||||
|
||||
khi thực tế patch của agent là nguyên nhân.
|
||||
|
||||
---
|
||||
|
||||
# Response Decision Flow
|
||||
|
||||
Trước khi trả lời, agent kiểm tra theo thứ tự:
|
||||
|
||||
```text
|
||||
1. Có evidence chưa?
|
||||
│
|
||||
├── Không → Assumption / Open Question
|
||||
│
|
||||
└── Có
|
||||
↓
|
||||
2. Có xác định đúng file:line chưa?
|
||||
│
|
||||
├── Không → tiếp tục triage
|
||||
│
|
||||
└── Có
|
||||
↓
|
||||
3. Root cause confidence?
|
||||
│
|
||||
├── low → RETURN TO TRIAGE
|
||||
├── medium → tiếp tục xác minh
|
||||
└── high → có thể tạo fix_plan
|
||||
↓
|
||||
4. Output có đúng template không?
|
||||
↓
|
||||
5. Có ghi đúng trạng thái test / gate không?
|
||||
↓
|
||||
6. Handoff đúng route chưa?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Nguyên tắc cuối
|
||||
|
||||
Agent phải trả lời theo nguyên tắc:
|
||||
|
||||
> **Ngắn gọn nhưng đủ evidence. Không đoán. Không nịnh. Không che giấu trạng thái thực tế.**
|
||||
|
||||
```text
|
||||
Evidence → Conclusion → Confidence → Action → Handoff
|
||||
```
|
||||
@@ -1,493 +0,0 @@
|
||||
# Security Policy — Cho agent xử lý bug UI/UX
|
||||
|
||||
**Nguồn:**
|
||||
|
||||
* `SECURITY.md`
|
||||
* `docs/governance/review-policy.md`
|
||||
* `docs/architecture/security-policy.md`
|
||||
|
||||
> **SCOPE:** Áp dụng cho mọi agent xử lý bug UI/UX.
|
||||
>
|
||||
> Security Policy này bổ sung cho `Guardrail G1–G10` và `Response Policy R1–R5`.
|
||||
>
|
||||
> Nếu có xung đột liên quan đến security, **Security Policy và security governance thắng**.
|
||||
|
||||
---
|
||||
|
||||
## S1. Bug report là dữ liệu chưa được làm sạch
|
||||
|
||||
Bug report có thể chứa:
|
||||
|
||||
* screenshot;
|
||||
* log;
|
||||
* request/response;
|
||||
* đường dẫn local;
|
||||
* credential;
|
||||
* dữ liệu khách hàng;
|
||||
* PII.
|
||||
|
||||
**Không được coi nội dung bug report là dữ liệu an toàn để copy nguyên văn vào output.**
|
||||
|
||||
Trước khi đưa thông tin vào:
|
||||
|
||||
* `defect_record.md`;
|
||||
* `fix_plan.md`;
|
||||
* `fix_report.md`;
|
||||
* PR body;
|
||||
* commit message;
|
||||
|
||||
phải kiểm tra và redact dữ liệu nhạy cảm.
|
||||
|
||||
### Quy tắc redact
|
||||
|
||||
| Loại dữ liệu | Ví dụ | Xử lý |
|
||||
| ----------------- | ---------------------------------------- | --------------------------------------- |
|
||||
| API key / token | `sk-...`, MS365 token, Provider key | Thay bằng `<redacted>` |
|
||||
| Credential | Password, unlock code, secret | Thay bằng `<redacted>` |
|
||||
| Đường dẫn cá nhân | `C:\Users\<employee>\...` | Rút gọn thành `%USERPROFILE%\...` |
|
||||
| Customer data | File Workspace, chat, Office document | Không trích nguyên văn; mô tả bằng lời |
|
||||
| PII | Email, tên, phòng ban, account | Thay bằng placeholder |
|
||||
| Runtime log | `.cowork_local/`, audit log, MCP history | Chỉ trích dòng cần thiết và phải redact |
|
||||
|
||||
### Screenshot
|
||||
|
||||
Nếu screenshot chứa dữ liệu khách hàng hoặc PII:
|
||||
|
||||
**Không nhúng screenshot vào issue/PR/output.**
|
||||
|
||||
Thay bằng mô tả:
|
||||
|
||||
```text id="o3jpqz"
|
||||
Widget: Provider Settings
|
||||
Vùng lỗi: phía bên phải ô API Key
|
||||
Hiện tượng: credential được hiển thị plaintext
|
||||
```
|
||||
|
||||
Khi cần xác định vị trí UI, ưu tiên:
|
||||
|
||||
* tên widget;
|
||||
* `objectName`;
|
||||
* `file:line`;
|
||||
* mô tả vùng tương đối.
|
||||
|
||||
Không đưa dữ liệu thật vào artifact chỉ để minh họa.
|
||||
|
||||
---
|
||||
|
||||
## S2. Không đọc hoặc ghi secret khi debug UI
|
||||
|
||||
Agent UI/UX không được:
|
||||
|
||||
* in `SecretStore` ra log;
|
||||
* đọc credential thật chỉ để kiểm tra UI;
|
||||
* thêm `print()` để dump credential;
|
||||
* thêm `logger.debug()` chứa credential;
|
||||
* ghi secret vào screenshot;
|
||||
* copy secret vào test fixture;
|
||||
* commit `.env`;
|
||||
* commit local `config.json`;
|
||||
* commit dữ liệu dưới:
|
||||
|
||||
```text id="4sn9q8"
|
||||
%USERPROFILE%\.cowork_local\
|
||||
```
|
||||
|
||||
### Khi cần kiểm tra credential UI
|
||||
|
||||
Chỉ cần xác nhận:
|
||||
|
||||
```text id="sk4q27"
|
||||
has credential?
|
||||
masked / visible?
|
||||
empty / non-empty?
|
||||
```
|
||||
|
||||
Không cần biết giá trị thật.
|
||||
|
||||
Ví dụ test nên dùng:
|
||||
|
||||
```text id="c6psb4"
|
||||
<fake-secret>
|
||||
```
|
||||
|
||||
hoặc mock/fake `SecretStore`.
|
||||
|
||||
---
|
||||
|
||||
## S3. Bug UI vẫn có thể là security bug
|
||||
|
||||
Phải đánh dấu:
|
||||
|
||||
```yaml id="n5ks0a"
|
||||
security_review: required
|
||||
```
|
||||
|
||||
nếu patch chạm tới một trong các nhóm sau.
|
||||
|
||||
### Permission
|
||||
|
||||
* Permission dialog.
|
||||
* Permission confirmation.
|
||||
* Allow / Deny behavior.
|
||||
* Default button.
|
||||
* Keyboard shortcut có thể cấp quyền.
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text id="2amr9f"
|
||||
ui/permission_dialog.py
|
||||
```
|
||||
|
||||
### Credential
|
||||
|
||||
Các UI liên quan tới:
|
||||
|
||||
```text id="73t3s5"
|
||||
ui/accounts_tab.py
|
||||
ui/login_dialog.py
|
||||
presentation/settings/provider_settings_widget.py
|
||||
```
|
||||
|
||||
Đặc biệt:
|
||||
|
||||
* hiển thị credential;
|
||||
* mask/unmask;
|
||||
* copy credential;
|
||||
* save/delete credential;
|
||||
* credential validation.
|
||||
|
||||
### Security monitoring
|
||||
|
||||
* Monitoring → Security Events.
|
||||
* MCP call history.
|
||||
* Audit information.
|
||||
* Security-related toast/status.
|
||||
|
||||
### Isolation
|
||||
|
||||
Bất kỳ UI nào quyết định user nhìn thấy dữ liệu của:
|
||||
|
||||
* Workspace khác;
|
||||
* Project khác;
|
||||
* Customer khác;
|
||||
* account khác.
|
||||
|
||||
Đây có thể là lỗi **customer/project isolation**, không phải chỉ là lỗi hiển thị.
|
||||
|
||||
### Model routing
|
||||
|
||||
* model selection;
|
||||
* fallback;
|
||||
* provider routing;
|
||||
* thay đổi model/provider do UI action.
|
||||
|
||||
---
|
||||
|
||||
## S4. Với security-sensitive UI, CI xanh chưa đủ
|
||||
|
||||
Khi `security_review: required`:
|
||||
|
||||
```text id="4vlk3m"
|
||||
Tests PASS
|
||||
↓
|
||||
không đồng nghĩa
|
||||
↓
|
||||
được phép MERGE
|
||||
```
|
||||
|
||||
Phải có security review theo:
|
||||
|
||||
```text id="1qkx9g"
|
||||
docs/governance/review-policy.md
|
||||
```
|
||||
|
||||
Agent không được tự kết luận:
|
||||
|
||||
> "Test đã pass nên security risk không còn."
|
||||
|
||||
---
|
||||
|
||||
## S5. Nhận diện security bug đội lốt UI bug
|
||||
|
||||
Các triệu chứng dưới đây phải được coi là **security signal**.
|
||||
|
||||
### Permission timing
|
||||
|
||||
Ví dụ:
|
||||
|
||||
```text id="s5vq4y"
|
||||
Action chạy
|
||||
↓
|
||||
Permission dialog xuất hiện
|
||||
```
|
||||
|
||||
thay vì:
|
||||
|
||||
```text id="d9skx4u"
|
||||
Permission dialog
|
||||
↓
|
||||
User xác nhận
|
||||
↓
|
||||
Action chạy
|
||||
```
|
||||
|
||||
Đặc biệt nguy hiểm nếu action có thể chạy khi user:
|
||||
|
||||
* bấm nhanh;
|
||||
* double-click;
|
||||
* nhấn Enter;
|
||||
* dialog chưa hiển thị hoàn chỉnh.
|
||||
|
||||
### Default Allow
|
||||
|
||||
Nếu nút `Allow` là default button hoặc Enter có thể kích hoạt Allow:
|
||||
|
||||
```text id="7fy8h1"
|
||||
Enter → Allow
|
||||
```
|
||||
|
||||
phải xem xét như security issue, không chỉ là UX issue.
|
||||
|
||||
### Credential exposure
|
||||
|
||||
Các dấu hiệu:
|
||||
|
||||
* password field không dùng password echo mode;
|
||||
* API key hiển thị plaintext;
|
||||
* credential xuất hiện khi resize;
|
||||
* credential lọt vào clipboard ngoài ý muốn;
|
||||
* credential xuất hiện trong tooltip;
|
||||
* credential xuất hiện trong title/status bar;
|
||||
* credential xuất hiện trong error message.
|
||||
|
||||
### Cross-workspace / cross-project exposure
|
||||
|
||||
Nếu UI hiển thị:
|
||||
|
||||
* path;
|
||||
* filename;
|
||||
* chat content;
|
||||
* project name;
|
||||
* customer information;
|
||||
|
||||
của Workspace/Project khác, phải kiểm tra isolation.
|
||||
|
||||
### Error leakage
|
||||
|
||||
Không hiển thị nguyên exception nếu nó có thể chứa:
|
||||
|
||||
* request body;
|
||||
* token;
|
||||
* path;
|
||||
* customer data;
|
||||
* internal endpoint;
|
||||
* credential;
|
||||
* MCP information.
|
||||
|
||||
Ví dụ nguy hiểm:
|
||||
|
||||
```text id="l1mrxq"
|
||||
Toast:
|
||||
Request failed: POST /api/... body={"token":"..."}
|
||||
```
|
||||
|
||||
Phải redact và hiển thị thông báo an toàn cho user.
|
||||
|
||||
---
|
||||
|
||||
## S6. Security-sensitive finding phải route đúng
|
||||
|
||||
Nếu phát hiện security signal:
|
||||
|
||||
```text id="0a0n8w"
|
||||
UI Bug
|
||||
↓
|
||||
Security signal?
|
||||
├── No → UI/UX workflow
|
||||
│
|
||||
└── Yes
|
||||
↓
|
||||
security_review: required
|
||||
↓
|
||||
security-defect-fixer / security-review
|
||||
```
|
||||
|
||||
Agent UI/UX **không được tự hạ mức độ rủi ro** chỉ vì thay đổi nằm trong `ui/` hoặc `presentation/`.
|
||||
|
||||
Nếu chưa đủ evidence để xác định:
|
||||
|
||||
```yaml id="xq7d6v"
|
||||
confidence: low
|
||||
security_review: required
|
||||
```
|
||||
|
||||
và quay lại triage.
|
||||
|
||||
---
|
||||
|
||||
## S7. Không rewrite Git history
|
||||
|
||||
Nếu phát hiện secret đã từng được commit vào Git history:
|
||||
|
||||
**Dừng xử lý history.**
|
||||
|
||||
Phải:
|
||||
|
||||
1. báo Cowork Team;
|
||||
2. xác định credential nào có khả năng bị lộ;
|
||||
3. đề xuất rotation/revocation theo security policy;
|
||||
4. giữ nguyên evidence cần thiết để team xử lý.
|
||||
|
||||
Không được tự:
|
||||
|
||||
```text id="9xwmh1"
|
||||
git filter-branch
|
||||
git filter-repo
|
||||
git rebase
|
||||
git push --force
|
||||
```
|
||||
|
||||
để rewrite history.
|
||||
|
||||
Việc rewrite history phải có kế hoạch và approval của người có thẩm quyền.
|
||||
|
||||
---
|
||||
|
||||
## S8. Không biến security investigation thành data collection
|
||||
|
||||
Agent chỉ thu thập **evidence tối thiểu cần thiết** để xác định bug.
|
||||
|
||||
Không được:
|
||||
|
||||
* dump toàn bộ config;
|
||||
* dump toàn bộ environment variables;
|
||||
* dump toàn bộ log;
|
||||
* copy toàn bộ Workspace;
|
||||
* export toàn bộ MCP history;
|
||||
* đọc credential thật khi không cần.
|
||||
|
||||
Nguyên tắc:
|
||||
|
||||
> **Collect the minimum evidence necessary to prove the defect.**
|
||||
|
||||
Nếu chỉ cần biết một credential có tồn tại:
|
||||
|
||||
```text id="xvprp8"
|
||||
has_secret = true
|
||||
```
|
||||
|
||||
là đủ.
|
||||
|
||||
Không cần biết:
|
||||
|
||||
```text id="k3uw5w"
|
||||
secret_value = "..."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Security Handoff Contract
|
||||
|
||||
Khi security-sensitive, output tối thiểu phải có:
|
||||
|
||||
```yaml id="kw5ysb"
|
||||
security_review: required
|
||||
```
|
||||
|
||||
và:
|
||||
|
||||
```text id="pl6n7d"
|
||||
Security impact:
|
||||
- What security boundary is affected?
|
||||
- What data/permission/credential is involved?
|
||||
- Is customer/project isolation affected?
|
||||
- Is additional security review required?
|
||||
```
|
||||
|
||||
Nếu chưa có đủ thông tin:
|
||||
|
||||
```text id="xqk2uj"
|
||||
Open Question:
|
||||
- ...
|
||||
```
|
||||
|
||||
Nếu cần Cowork Team quyết định policy:
|
||||
|
||||
```text id="k5j3vw"
|
||||
Handoff:
|
||||
RETURN_TO_REPORTER
|
||||
Reason:
|
||||
needs-security-decision
|
||||
```
|
||||
|
||||
Nếu đã đủ evidence và có thể tạo implementation plan:
|
||||
|
||||
```text id="8d5g6h"
|
||||
Handoff:
|
||||
fix-implementer
|
||||
|
||||
security_review:
|
||||
required
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Security Decision Flow
|
||||
|
||||
```text id="j2qz1k"
|
||||
Bug Report
|
||||
↓
|
||||
Redact Input
|
||||
↓
|
||||
Triage UI/UX
|
||||
↓
|
||||
Security Signal?
|
||||
│
|
||||
├── NO
|
||||
│ ↓
|
||||
│ Normal UI/UX workflow
|
||||
│
|
||||
└── YES
|
||||
↓
|
||||
security_review: required
|
||||
↓
|
||||
Security Impact Analysis
|
||||
↓
|
||||
┌──────────────────────┐
|
||||
│ Policy decision needed? │
|
||||
└──────────────────────┘
|
||||
│
|
||||
YES ─────→ RETURN_TO_REPORTER
|
||||
│
|
||||
NO
|
||||
↓
|
||||
Security Review
|
||||
↓
|
||||
fix-implementer
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Nguyên tắc cuối
|
||||
|
||||
> **UI không phải security boundary thấp hơn security.**
|
||||
>
|
||||
> Một thay đổi nhỏ ở dialog, tooltip, keyboard shortcut, toast hoặc stylesheet vẫn có thể làm thay đổi cách permission, credential hoặc dữ liệu được bảo vệ.
|
||||
|
||||
Vì vậy:
|
||||
|
||||
```text id="s5gh1v"
|
||||
Redact first
|
||||
↓
|
||||
Collect minimum evidence
|
||||
↓
|
||||
Detect security boundary
|
||||
↓
|
||||
Mark security_review
|
||||
↓
|
||||
Route correctly
|
||||
↓
|
||||
Never expose secrets
|
||||
↓
|
||||
Never rewrite history
|
||||
```
|
||||
@@ -1,62 +0,0 @@
|
||||
# Handoff Contract — envelope truyền giữa các agent
|
||||
|
||||
Mọi agent kết thúc lượt bằng khối YAML này, đặt **ngay trên** phần nội dung chính.
|
||||
Đây là phần máy đọc; phần dưới nó là phần người đọc.
|
||||
|
||||
```yaml
|
||||
---
|
||||
defect_id: UI-2026-0907-01 # UI-<YYYYMMDD>-<số thứ tự trong ngày>
|
||||
from_agent: ui-bug-triage
|
||||
next_agent: ui-visual-fixer # xem bảng giá trị hợp lệ bên dưới
|
||||
tier: T2 # T0 | T1 | T2 | T3 | T3-SEC — do fix-dispatcher chấm
|
||||
category: visual # visual | flow | i18n-a11y | security | not-ui
|
||||
severity: S2 # S1 | S2 | S3 | S4
|
||||
confidence: high # low | medium | high
|
||||
reproducible: yes # yes | no | intermittent
|
||||
security_review: not-required # required | not-required
|
||||
affected_files:
|
||||
- presentation/folder/folder_tab.py:118
|
||||
- theme/qss.py:204
|
||||
themes_verified: [dark, light] # [] nếu chưa kiểm
|
||||
languages_verified: [vi] # [] nếu không liên quan
|
||||
blocked_on: [] # danh sách open question CHẶN bước tiếp theo
|
||||
---
|
||||
```
|
||||
|
||||
## Giá trị hợp lệ của `next_agent`
|
||||
|
||||
| Giá trị | Nghĩa |
|
||||
|---|---|
|
||||
| `fix-dispatcher` | Escalate về hub: vượt phạm vi tier hiện tại, cần chấm lại |
|
||||
| `ui-visual-fixer` / `ux-flow-fixer` / `i18n-a11y-fixer` | Route sang specialist UI |
|
||||
| `security-defect-fixer` | Route sang specialist bảo mật (`category: security`) |
|
||||
| `fix-implementer` | Plan đã sẵn sàng để hiện thực |
|
||||
| `regression-reviewer` | Patch đã sẵn sàng để review |
|
||||
| `HUMAN_REVIEW` | Xong phía agent; chờ Cowork Team |
|
||||
| `RETURN_TO_REPORTER` | Không phải bug, hoặc thiếu thông tin chặn, hoặc cần quyết định sản phẩm |
|
||||
|
||||
## Luật
|
||||
|
||||
1. **`defect_id` không đổi** suốt vòng đời một lỗi, kể cả khi quay vòng FAIL.
|
||||
2. Một defect_record = **một nguyên nhân gốc**. Triage phát hiện hai nguyên nhân → tách
|
||||
thành hai `defect_id`.
|
||||
3. `confidence: low` → `next_agent` chỉ được là `ui-bug-triage` hoặc `RETURN_TO_REPORTER`.
|
||||
4. `blocked_on` khác rỗng → agent nhận **không** được implement; chỉ được điều tra thêm.
|
||||
5. `security_review: required` là **cờ dính**: một khi bật, không agent nào được tắt.
|
||||
Chỉ Cowork Team gỡ được. `category: security` thì cờ này **luôn** bật.
|
||||
6. `themes_verified` / `languages_verified` chỉ ghi thứ **thực sự đã kiểm**. Đây là chỗ hay
|
||||
bị ghi khống nhất (`guardrail.md` G10).
|
||||
7. Agent nhận envelope phải kiểm envelope trước khi làm việc. Thiếu trường hoặc mâu thuẫn
|
||||
(ví dụ `confidence: low` mà `next_agent: fix-implementer`) → trả về ngay, không xử lý.
|
||||
8. `category: security` thắng mọi nhóm khác. Một lỗi vừa lệch layout vừa lộ credential thì
|
||||
`next_agent: security-defect-fixer`; phần UI tách thành `defect_id` riêng, xử lý sau.
|
||||
9. `blocked_on` của role 7 có thể chứa câu hỏi **chính sách** (`needs-security-decision`).
|
||||
Đó là chờ hợp lệ — người trả lời là Cowork Team, không phải agent khác.
|
||||
10. **`tier` chỉ đi lên.** Không agent nào được hạ `tier` trong envelope nhận được. Thấy
|
||||
việc lớn hơn tier đang mang → đặt `next_agent: fix-dispatcher`, ghi lý do vào
|
||||
`blocked_on`, dừng. Hub là chỗ duy nhất được ghi `tier`.
|
||||
11. `tier: T0` mà `next_agent` khác `HUMAN_REVIEW` là mâu thuẫn: T0 không gọi agent nào.
|
||||
`tier: T3-SEC` thì `security_review` **luôn** là `required`.
|
||||
12. `report_id` (nếu có) gom các `defect_id` tách ra từ **cùng một** phản ánh. Nó chỉ để
|
||||
truy vết ngược về người báo lỗi; không dùng nó để gộp PR — một PR vẫn là một
|
||||
`defect_id` (`guardrail.md` G8).
|
||||
@@ -1,153 +0,0 @@
|
||||
# Workflow — từ phản ánh của người dùng tới PR
|
||||
|
||||
## 0. Lane theo tier — đọc trước
|
||||
|
||||
Pipeline dưới đây là **lane FULL (T3)**, không phải mặc định. `0_fix_dispatcher` chấm tier
|
||||
trước và cắt bớt bước:
|
||||
|
||||
| Tier | Lane | Bước thực chạy | Gọi agent |
|
||||
|---|---|---|---|
|
||||
| **T0** | DIRECT | hub sửa → 4 cổng máy (`roles/0_fix_dispatcher.md` §4.1) | 0 |
|
||||
| **T1** | SOLO | hub triage inline → **5** → hub review bằng `checklist/ui_review.md` | 1 |
|
||||
| **T2** | PAIR | hub triage inline → **2/3/4** → **5** → **6** | 3 |
|
||||
| **T3** | FULL | **1** → **2/3/4** → **5** → **6** | 4–5 |
|
||||
| **T3-SEC** | FULL-SEC | **7** → *(Cowork Team)* → **5** → **6** | 3 + chờ người |
|
||||
|
||||
Bỏ bước nào cũng phải **nêu rõ trong `dispatch_plan`** cổng nào thay thế. Bước **6** chỉ
|
||||
được bỏ ở T0 và T1.
|
||||
|
||||
## 1. Pipeline (lane FULL)
|
||||
|
||||
```text
|
||||
Người dùng báo lỗi (chat / issue / miệng)
|
||||
│
|
||||
▼
|
||||
┌───────────────────────────┐
|
||||
│ 0. fix-dispatcher HUB │ → dispatch_plan.md
|
||||
│ Router │ + tách N defect_id + tier + lane
|
||||
└───────────┬───────────────┘
|
||||
│ T0 → hub tự sửa, KHÔNG đi tiếp
|
||||
│ T1 → nhảy thẳng xuống bước 5
|
||||
│ T2 → nhảy thẳng xuống bước 2/3/4
|
||||
│ T3 → đi tiếp bước 1
|
||||
▼
|
||||
┌───────────────────────────┐
|
||||
│ 1. ui-bug-triage │ → defect_record.md
|
||||
│ Planner │ + category + severity + confidence
|
||||
└───────────┬───────────────┘
|
||||
│ route theo category (security THẮNG mọi nhóm khác)
|
||||
┌───────┬─┴──────┬──────────┬───────────┐
|
||||
▼ ▼ ▼ ▼ ▼
|
||||
┌────────┐┌────────┐┌──────────┐┌─────────┐ not-ui
|
||||
│ 2. ││ 3. ││ 4. ││ 7. │ → RETURN_TO_REPORTER
|
||||
│ visual ││ flow ││ i18n-a11y││ security│ (mở issue type:bug thường)
|
||||
└────┬───┘└───┬────┘└────┬─────┘└────┬────┘
|
||||
└────────┼──────────┴───────────┘
|
||||
│ ⚠ role 7 có thể dừng ở đây:
|
||||
│ 4 câu chính sách chưa có đáp án
|
||||
│ → RETURN_TO_REPORTER (needs-security-decision)
|
||||
▼ fix_plan.md
|
||||
┌───────────────────────────┐
|
||||
│ 5. fix-implementer │ → patch + fix_report.md
|
||||
│ Executor (SỬA FILE) │ + CASAN gate output
|
||||
└───────────┬───────────────┘
|
||||
▼
|
||||
┌───────────────────────────┐
|
||||
│ 6. regression-reviewer │ → verdict + pr_body.md
|
||||
│ Reviewer │
|
||||
└───────────┬───────────────┘
|
||||
FAIL ──┘ (quay lại 5, hoặc về 2/3/4 nếu sai nguyên nhân gốc)
|
||||
PASS ──▶ Cowork Team review → merge
|
||||
```
|
||||
|
||||
## 2. Ai được làm gì
|
||||
|
||||
| Agent | Đọc | Sửa file | Chạy lệnh | Quyết định |
|
||||
|---|---|---|---|---|
|
||||
| 0. dispatcher | ✅ | ✅ **chỉ ở T0** | ✅ (grep, gate) | tier + lane + tách defect |
|
||||
| 1. triage | ✅ | ❌ | ✅ (grep, tra manifest) | phân loại + route |
|
||||
| 2/3/4. specialist | ✅ | ❌ | ✅ (đọc, kiểm LOC) | nguyên nhân gốc + phương án |
|
||||
| 7. security | ✅ | ❌ | ✅ (đọc, `git log -S`) | lỗ hổng + migration; **không** quyết chính sách |
|
||||
| 5. implementer | ✅ | ✅ | ✅ (git, pytest, gate) | cách hiện thực trong phạm vi plan |
|
||||
| 6. reviewer | ✅ | ❌ | ✅ (git, pytest, gate) | PASS / FAIL |
|
||||
| Cowork Team | — | — | — | **merge** |
|
||||
|
||||
Chỉ **một** agent được sửa file. Ranh giới này là thứ giữ cho pipeline review được.
|
||||
|
||||
Ngoại lệ duy nhất là hub ở **T0**, và nó bị bó rất chặt để đổi lại: danh sách đóng 6 loại
|
||||
thay đổi, 9 disqualifier, trần ≤ 2 file / ≤ 10 dòng, và 4 cổng máy bắt buộc dán output thật.
|
||||
Vượt bất kỳ ràng buộc nào → `git checkout --` rồi chấm lại T2. Hub **không** được sửa file ở
|
||||
T1/T2/T3 — ở đó nó chỉ điều phối và (ở T1) review, vì reviewer không được là người viết patch.
|
||||
|
||||
## 3. Cổng chuyển bước
|
||||
|
||||
Không bước nào được đi tiếp nếu chưa đạt:
|
||||
|
||||
| Từ → Đến | Điều kiện |
|
||||
|---|---|
|
||||
| 0 → bất kỳ | Mỗi defect_id có đúng 1 tier + 1 lane, tier ≠ T0 dẫn được về một dòng cụ thể của Bước 3, đã xét override bảo mật trước |
|
||||
| 0 → tự sửa (T0) | Trúng danh sách đóng, 0 disqualifier, Gate S + blast radius đã **đo bằng lệnh** |
|
||||
| 1 → 2/3/4 | `confidence >= medium`, có ít nhất một `file:line`, đã redact |
|
||||
| 2/3/4 → 5 | Đúng **một** nguyên nhân gốc, có cách kiểm chứng, không vượt 400 LOC (hoặc đã có kế hoạch tách) |
|
||||
| 7 → 5 | Như trên, **cộng thêm**: có đường di trú cho cả 4 nhóm người dùng, và 4 câu chính sách đã có đáp án của Cowork Team |
|
||||
| 5 → 6 | 5 cổng CASAN xanh, test regression đỏ-trước-xanh-sau |
|
||||
| 6 → người | Verdict PASS/PASS_WITH_NOTES + `pr_body` |
|
||||
|
||||
`confidence: low` ở bất kỳ đâu → quay về bước 1. Không đoán tiếp.
|
||||
|
||||
## 4. Vòng lặp và giới hạn
|
||||
|
||||
- FAIL ở bước 6 → về bước 5 (lỗi hiện thực) hoặc về 2/3/4 (sai nguyên nhân gốc).
|
||||
- **Tier +1 mỗi lần FAIL.** Chạy lại ở nguyên tier cũ là lỗi điều phối: hai lần thất bại ở
|
||||
cùng độ sâu gần như luôn có nghĩa là hồ sơ lỗi sai từ đầu.
|
||||
- Tier chỉ đi **lên**. Không có đường hạ tier giữa dòng, kể cả khi diff hoá ra nhỏ.
|
||||
- Quá **2 vòng** mà vẫn FAIL → dừng, đưa người thật vào. Vòng thứ ba thường có nghĩa là
|
||||
`defect_record` sai từ đầu, không phải bản vá sai.
|
||||
|
||||
## 5. Đường tắt hợp lệ
|
||||
|
||||
Đây là các đường tắt hub được phép chọn ở Bước 3. Chúng **thay thế** phần "đường tắt" của
|
||||
bộ v1.2 — trước đây tự phát, giờ có tier và có cổng bù.
|
||||
|
||||
| Tình huống | Tier | Đường tắt |
|
||||
|---|---|---|
|
||||
| Nới một số đo hiển thị (px, margin, spacing) | T0 | hub sửa, 0 agent |
|
||||
| Sai chính tả / sai dấu một chuỗi đã có key | T0 | hub sửa, đủ 3 ngôn ngữ, **vẫn phải có test** |
|
||||
| Đổi token màu có sẵn sang token có sẵn | T0 | hub sửa, 0 agent |
|
||||
| Thiếu key i18n, UI hiện ra `a.b_c`, đã biết file | T1 | 5 → hub review |
|
||||
| Nguyên nhân gốc đã có `file:line` từ người báo (dev) | T1 | 5 → hub review |
|
||||
| Chạm QSS/token dùng chung, phải kiểm 2 theme | T2 | 4 (hoặc 2) → 5 → 6 |
|
||||
| Lỗi do chính bản vá vừa merge | T3 | đủ pipeline — regression nghĩa là nguyên nhân gốc lần trước sai |
|
||||
| Dev báo thẳng một lỗ hổng | T3-SEC | vào thẳng 7, bỏ bước 1 |
|
||||
|
||||
Bước **6** chỉ được bỏ ở T0 và T1. Ở T0 nó được thay bằng 4 cổng máy; ở T1 nó được thay bằng
|
||||
hub review với `checklist/ui_review.md` (hợp lệ vì hub không viết patch ở T1). Ở T2/T3/T3-SEC
|
||||
không có đường tắt nào bỏ qua bước 6.
|
||||
|
||||
## 6. Chạy bằng Claude Code
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/agents .claude/commands
|
||||
cp agent/roles/[1-7]_*.md .claude/agents/
|
||||
cp agent/commands/fix.md .claude/commands/
|
||||
```
|
||||
|
||||
`.claude/` nằm trong `.gitignore` (dòng 109) nên phải cài lại trên mỗi clone — `agent/`
|
||||
là bản gốc. `0_fix_dispatcher.md` không copy sang `agents/`: hub chạy ở session chính vì
|
||||
subagent không gọi được subagent. Điểm vào:
|
||||
|
||||
```text
|
||||
> /fix màn Folder kéo to ra thì mất cây thư mục bên trái
|
||||
```
|
||||
|
||||
Hub in `dispatch_plan` rồi tự chạy lane. Muốn chạy tay lane FULL:
|
||||
|
||||
```text
|
||||
> dùng ui-bug-triage cho phản ánh này: "màn Folder kéo to ra thì mất cây thư mục bên trái"
|
||||
> dùng ui-visual-fixer với defect_record ở trên
|
||||
> dùng fix-implementer với fix_plan ở trên
|
||||
> dùng regression-reviewer với patch vừa rồi
|
||||
```
|
||||
|
||||
Các bước trong **một** `defect_id` chạy tuần tự — mỗi bước phụ thuộc output của bước trước.
|
||||
Các `defect_id` **độc lập** thì chạy song song được, gọi trong cùng một message.
|
||||
@@ -38,13 +38,13 @@ from .state import AppContext
|
||||
from .ui.widgets import tidy_popup
|
||||
from .theme import current_palette, set_active_theme, stylesheet
|
||||
from .core.task_scheduler import TaskScheduler
|
||||
from .presentation.dashboard.dashboard_tab import DashboardTab
|
||||
from .presentation.graph.structure_graph_view import StructureGraphView
|
||||
from .presentation.scheduling.schedule_task_tab import ScheduleTaskTab
|
||||
from .ui.cowork_tab import CoworkTab
|
||||
from .ui.dashboard_tab import DashboardTab
|
||||
from .ui.monitoring_tab import MonitoringTab
|
||||
from .ui.schedule_task_tab import ScheduleTaskTab
|
||||
from .ui.settings_dialog import SettingsDialog
|
||||
from .ui.sidebar import HistorySidebar
|
||||
from .ui.structure_graph_view import StructureGraphView
|
||||
from .ui.workspace_tab import WorkspaceTab
|
||||
|
||||
|
||||
@@ -61,12 +61,6 @@ def _set_windows_app_id() -> None:
|
||||
|
||||
|
||||
def run(argv: List[str] | None = None) -> int:
|
||||
"""Điểm vào ứng dụng: dựng Composition Root, gieo dữ liệu mặc định, áp theme
|
||||
rồi mở cửa sổ chính.
|
||||
|
||||
Mọi bước gieo (skill dựng sẵn, flow dựng sẵn) đều bọc trong ``try`` — việc
|
||||
dọn nhà không bao giờ được phép chặn app khởi động.
|
||||
"""
|
||||
argv = argv if argv is not None else sys.argv
|
||||
_set_windows_app_id()
|
||||
app = QApplication.instance() or QApplication(argv)
|
||||
@@ -121,7 +115,6 @@ def run(argv: List[str] | None = None) -> int:
|
||||
win = MainWindow(ctx, user_name="local")
|
||||
|
||||
def _reapply_system_theme(*_a):
|
||||
"""Theme đang để "Theo hệ thống" thì áp lại mỗi khi Windows đổi sáng/tối."""
|
||||
if ctx.config.theme == "system":
|
||||
set_active_theme("system")
|
||||
app.setStyleSheet(stylesheet("system"))
|
||||
|
||||
+1
-12
@@ -1,12 +1 @@
|
||||
"""Application layer - pure Python use-case orchestration.
|
||||
|
||||
Sits between ``presentation/`` (Qt widgets) and ``domain/`` (entities). A module
|
||||
here answers "what has to happen, in what order" for one use case - route a
|
||||
turn, run a conversation - without knowing whether a human, a scheduler or a
|
||||
test triggered it.
|
||||
|
||||
Hard rule (ADR-001 I1/I3, enforced by ``scripts/check_imports.py``): no
|
||||
PySide6/PyQt imports and no reach into ``presentation/``/``ui/``. Results travel
|
||||
back up through plain-Python callbacks; turning those into Qt signals is the
|
||||
presentation layer's job.
|
||||
"""
|
||||
"""application/ — Điều phối use-case. KHÔNG import PySide6. Gọi domain + interface hạ tầng."""
|
||||
|
||||
@@ -1,12 +1 @@
|
||||
"""Application conversations package: turn lifecycle orchestration, agent execution, and tool approval policy."""
|
||||
|
||||
from .conversation_application_service import (
|
||||
ConversationApplicationService,
|
||||
)
|
||||
from .tool_policy_gateway import ConfirmGate, ToolPolicyGateway
|
||||
|
||||
__all__ = [
|
||||
"ConversationApplicationService",
|
||||
"ToolPolicyGateway",
|
||||
"ConfirmGate",
|
||||
]
|
||||
"""Application conversations package: turn lifecycle orchestration and agent execution."""
|
||||
|
||||
@@ -75,12 +75,6 @@ class ConversationApplicationService:
|
||||
permission_request: Optional[PermissionRequest] = None,
|
||||
attachment_reader: Optional[AttachmentReader] = None,
|
||||
) -> None:
|
||||
"""Nhận vào các cổng (port) thay vì tự dựng phụ thuộc.
|
||||
|
||||
``model`` và ``tools`` bắt buộc; mọi thứ còn lại là tuỳ chọn và để None thì
|
||||
bỏ qua bước đó. Nhờ vậy test dựng được service với đúng phần nó cần kiểm,
|
||||
không phải dựng cả provider thật lẫn sandbox.
|
||||
"""
|
||||
self._model = model
|
||||
self._tools = tools
|
||||
# Every hook is optional so the service degrades to a plain chat turn.
|
||||
|
||||
@@ -51,11 +51,9 @@ class CoreModelCall:
|
||||
"""
|
||||
|
||||
def __init__(self, provider: Any) -> None:
|
||||
"""Bọc một provider của ``core/`` vào cổng ``ModelCallPort``."""
|
||||
self._provider = provider
|
||||
|
||||
def call(self, messages, tools, on_text=None, on_reasoning=None, cancel=None):
|
||||
"""Gọi model một lượt, có tự phục hồi khi tràn context hoặc bị giới hạn tốc độ."""
|
||||
from ...core.code_agent import _call_provider_with_recovery
|
||||
|
||||
return _call_provider_with_recovery(self._provider, messages, tools, on_text,
|
||||
@@ -68,20 +66,7 @@ class CoreToolRuntime:
|
||||
def __init__(self, output_dir: Path, *, title: str = "",
|
||||
extra_tools: Optional[Sequence[Any]] = None, extra_executor=None,
|
||||
security_config: Any = None, agent_role: str = "") -> None:
|
||||
"""Bọc bộ tool của ``core/`` vào cổng ``ToolRuntimePort``.
|
||||
|
||||
Tên các tool phụ được gom sẵn vào một ``set`` ngay tại đây: mỗi lượt gọi tool
|
||||
đều phải tra tên, tra trên danh sách sẽ chậm dần theo số tool.
|
||||
"""
|
||||
self._output_dir = Path(output_dir)
|
||||
# Every sandboxed tool (run_command included) gets this as its cwd —
|
||||
# it must exist BEFORE the first tool call, same as the older
|
||||
# run_cowork() (core/chat_agent.py) already does at its output_dir.
|
||||
# Without this, a per-turn ".turns/<id>" folder that was never created
|
||||
# makes run_command's subprocess.Popen(cwd=...) fail immediately with
|
||||
# WinError 267 ("directory name is invalid") before the command even
|
||||
# starts — no network, no output, just an opaque OS error.
|
||||
self._output_dir.mkdir(parents=True, exist_ok=True)
|
||||
self._title = title
|
||||
self._extra_tools = list(extra_tools or ())
|
||||
self._extra_names = {getattr(t, "name", "") for t in self._extra_tools}
|
||||
@@ -95,7 +80,6 @@ class CoreToolRuntime:
|
||||
# -- the configured extra tools, for the system-prompt hints ---------- #
|
||||
@property
|
||||
def extra_names(self) -> frozenset:
|
||||
"""Tên các tool bổ sung (MCP, connector) ngoài bộ dựng sẵn."""
|
||||
return frozenset(self._extra_names)
|
||||
|
||||
def _tool_context(self):
|
||||
@@ -222,7 +206,6 @@ class CoreToolRuntime:
|
||||
"plan_steps": [PlanStep(title=s["title"], status=s["status"]) for s in steps]}
|
||||
|
||||
def snapshot(self) -> Any:
|
||||
"""Ảnh chụp thư mục kết quả trước lượt chạy — dùng để biết tệp nào mới sinh ra."""
|
||||
from ...core.tools import _snapshot
|
||||
|
||||
return _snapshot(self._output_dir)
|
||||
@@ -311,19 +294,16 @@ def build_cowork_conversation_service(
|
||||
_apply_project_context(messages, project_context)
|
||||
|
||||
def prompt_guard(messages: List[Dict[str, Any]]) -> None:
|
||||
"""Chốt an toàn cho prompt trước khi gửi: quét dấu hiệu tiêm lệnh."""
|
||||
from ...core import agent_security
|
||||
|
||||
agent_security.enforce_prompt(provider, messages, security_config, emit)
|
||||
|
||||
def command_guard(name: str, args: Dict[str, Any]) -> None:
|
||||
"""Chốt an toàn cho lệnh shell trước khi chạy: phân loại rủi ro và chặn/hỏi."""
|
||||
from ...core import agent_security
|
||||
|
||||
agent_security.enforce_command(provider, name, args, security_config, emit)
|
||||
|
||||
def compact(messages: List[Dict[str, Any]], cancel) -> None:
|
||||
"""Nén lịch sử hội thoại khi gần đầy cửa sổ ngữ cảnh."""
|
||||
from ...core import context_budget
|
||||
|
||||
context_budget.maybe_compact(provider, messages, security_config,
|
||||
|
||||
@@ -1,91 +0,0 @@
|
||||
"""ToolPolicyGateway - one confirm/deny decision path for every tool call
|
||||
(R05-T03).
|
||||
|
||||
Today "does this tool call need the user's OK first" is answered by a
|
||||
different hand-written check per engine:
|
||||
|
||||
* ``core/chat_agent.py::run_cowork`` — ``name in ("run_command",
|
||||
"install_package")``, a literal tuple.
|
||||
* ``core/code_agent.py::run_code`` — ``name in (WRITE_TOOLS | MS365_WRITE_TOOLS)``,
|
||||
a set built from two other hand-maintained sets.
|
||||
* MCP/connector tools (``core/mcp_client.py``, ``core/ext_connectors.py``) —
|
||||
no check at all; ``chat_agent.py`` calls ``extra_executor(name, args)``
|
||||
directly.
|
||||
|
||||
Three answers to the same question, and the third one is a real gap: an MCP
|
||||
tool that deletes files or calls an external API today runs with zero
|
||||
confirmation even when the user turned "confirm before running commands" on.
|
||||
|
||||
This gateway answers the question from data (:class:`~domain.tools.tool_descriptor.ToolCapability`
|
||||
via a :class:`~domain.tools.tool_registry.ToolRegistry`) instead of a literal
|
||||
name list, so registering a tool with the right capability is what gates it -
|
||||
nothing to remember at each new call site. R05-T04 is what actually registers
|
||||
MCP/connector tools with a capability; this module only needs the mechanism
|
||||
to exist.
|
||||
|
||||
Pure Python: no Qt, no direct dialog. The actual approval prompt stays exactly
|
||||
what it is today - a ``gate`` object with a ``.request(payload) -> bool``
|
||||
method, supplied by the presentation layer (Settings' "confirm before running
|
||||
commands" wires it up, or None for auto-run) - this module only decides
|
||||
WHEN to ask it, never how to render the question.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any, Dict, Optional, Protocol
|
||||
|
||||
from cowork_local.domain.tools import ToolCapability, ToolRegistry
|
||||
|
||||
|
||||
class ConfirmGate(Protocol):
|
||||
"""Shape of the existing ``PermissionGate`` both engines already use."""
|
||||
|
||||
"""Hỏi người dùng; trả về ``True`` nếu được đồng ý."""
|
||||
def request(self, payload: Dict[str, Any]) -> bool:
|
||||
"""Hỏi người dùng về một lời gọi tool; trả về ``True`` nếu được đồng ý."""
|
||||
...
|
||||
|
||||
|
||||
class ToolPolicyGateway:
|
||||
"""Decides whether a tool call needs approval, for ONE calling surface.
|
||||
|
||||
``gated_capabilities`` is what makes this per-surface: Cowork only ever
|
||||
asked about ``run_command``/``install_package`` (capability ``EXECUTE``),
|
||||
while the Code tab additionally confirms plain file writes (capability
|
||||
``WRITE``). Passing the wrong set here would silently change which tools
|
||||
prompt for approval - see the callers in ``core/chat_agent.py`` and
|
||||
``core/code_agent.py`` for the exact sets that preserve today's behavior.
|
||||
"""
|
||||
|
||||
def __init__(self, registry: ToolRegistry, gated_capabilities: ToolCapability) -> None:
|
||||
"""Nhận sổ đăng ký tool và tập năng lực cần xin phép.
|
||||
|
||||
Truyền vào chứ không viết cứng: mỗi bề mặt chat có ngưỡng riêng, và test đặt
|
||||
được ngưỡng của mình mà không đụng cấu hình thật.
|
||||
"""
|
||||
self._registry = registry
|
||||
self._gated_capabilities = gated_capabilities
|
||||
|
||||
def requires_confirmation(self, name: str) -> bool:
|
||||
"""True when ``name``'s declared capabilities overlap this surface's
|
||||
gated set. An unregistered tool never requires confirmation through
|
||||
this path - callers that must fail safe on unknown tools check
|
||||
``name in registry`` themselves (see R05-T04's MCP wrapping, which
|
||||
registers every tool it exposes before any call can reach here)."""
|
||||
return bool(self._registry.capabilities_for(name) & self._gated_capabilities)
|
||||
|
||||
def allow(self, name: str, gate: Optional[ConfirmGate], payload: Dict[str, Any]) -> bool:
|
||||
"""True when the call may proceed.
|
||||
|
||||
``gate is None`` preserves each engine's existing "no gate wired -
|
||||
auto-run" behavior; a tool outside ``gated_capabilities`` is never
|
||||
asked about, matching read-only tools "never confirm" today.
|
||||
``payload`` is whatever ``gate.request(...)`` already expects at that
|
||||
call site (the two engines use slightly different dict shapes) - this
|
||||
gateway only decides WHETHER to call it, never reshapes the payload.
|
||||
"""
|
||||
if gate is None or not self.requires_confirmation(name):
|
||||
return True
|
||||
return bool(gate.request(payload))
|
||||
|
||||
|
||||
__all__ = ["ToolPolicyGateway", "ConfirmGate"]
|
||||
@@ -33,7 +33,6 @@ class CoreRoutingEngine:
|
||||
"""
|
||||
|
||||
def __init__(self, routing_service: Any) -> None:
|
||||
"""Bọc ``core/routing/service.py`` vào cổng quyết định định tuyến."""
|
||||
self._routing_service = routing_service
|
||||
|
||||
def evaluate(self, request: RoutingRequest, mode: RoutingMode) -> RouteEvaluation:
|
||||
@@ -127,9 +126,6 @@ class AppContextModeResolver:
|
||||
"""
|
||||
|
||||
def __init__(self, ctx: Any) -> None:
|
||||
"""Đọc chế độ định tuyến từ ``AppContext``, để tầng application không phải biết
|
||||
hình dạng của context.
|
||||
"""
|
||||
self._ctx = ctx
|
||||
|
||||
def mode_for(self, surface: str) -> RoutingMode:
|
||||
|
||||
@@ -78,10 +78,6 @@ class RoutingApplicationService:
|
||||
*,
|
||||
confirm_timeout_sec: Optional[Callable[[], float]] = None,
|
||||
) -> None:
|
||||
"""``mode_resolver`` để None thì mọi bề mặt đều coi như đang ở chế độ mặc định.
|
||||
``confirm_timeout_sec`` là hàm chứ không phải số: người dùng đổi thiết lập
|
||||
giữa chừng thì lần hỏi sau phải theo giá trị mới.
|
||||
"""
|
||||
self._decision_port = decision_port
|
||||
self._mode_resolver = mode_resolver
|
||||
# A callable rather than a number: the timeout lives in mutable config
|
||||
|
||||
@@ -1,19 +1 @@
|
||||
"""Read-only query services for monitoring/dashboard screens (EPIC R08).
|
||||
|
||||
⚠️ Ownership note (R08-T13): per ``docs/refactor/Feature_Architecture_
|
||||
Proposal.md``'s file-split diagram, ``dashboard_query_service.py`` lives
|
||||
under ``application/monitoring/`` alongside the Dashboard split — but the
|
||||
SAME document's "Ranh giới phân hệ" table assigns ``application/monitoring/``
|
||||
to Team Nam (R08-T07→T10, Monitoring's own 8-tab split). This directory did
|
||||
not exist yet when Team Hoa reached R08-T13, so creating it here does not
|
||||
collide with any file Team Nam has written — same situation R06-T02 flagged
|
||||
for ``infrastructure/persistence/json/atomic_write.py`` vs. Team Nam's
|
||||
planned ``atomic_json_file.py``. Team Nam should confirm when they start
|
||||
R08-T07→T10 whether ``DashboardQueryService`` belongs here permanently or
|
||||
should move once Monitoring's own query service exists.
|
||||
"""
|
||||
|
||||
from .dashboard_query_service import DashboardQueryService
|
||||
from .monitoring_query_service import MonitoringQueryService
|
||||
|
||||
__all__ = ["DashboardQueryService", "MonitoringQueryService"]
|
||||
"""Application monitoring package: Monitoring query service for audit and metrics."""
|
||||
|
||||
@@ -1,120 +0,0 @@
|
||||
"""DashboardQueryService - read-only usage/cost queries for the Dashboard
|
||||
screen (R08-T13, extracted from ``ui/dashboard_tab.py::DashboardTab``, lines
|
||||
196-199/256-261/284-322 of the original 437-line file: ``_pricing``,
|
||||
``_period_range``'s date-math, and the ``period_totals``/``period_breakdown``
|
||||
calls ``_refresh_chart`` made directly).
|
||||
|
||||
``ui/dashboard_tab.py`` called ``core/usage_tracker.py``/``core/model_
|
||||
pricing.py`` directly from FIVE different methods spread across what is now
|
||||
three widgets (``token_usage_card_widget.py``, ``usage_chart_widget.py``,
|
||||
``habits_widget.py``) — each recomputing the same merged pricing dict. This
|
||||
service is the one place that merge happens now; the three widgets share it
|
||||
instead of each calling ``core.usage_tracker``/``core.model_pricing`` on
|
||||
their own.
|
||||
|
||||
Pure Python: no Qt. Wraps ``core/usage_tracker.py`` (a plain-Python module
|
||||
already) rather than reimplementing any of its date/cost math.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from datetime import date, timedelta
|
||||
from typing import Any, Dict, List, Tuple
|
||||
|
||||
|
||||
class DashboardQueryService:
|
||||
"""Usage/cost queries scoped to one ``AppContext``.
|
||||
|
||||
Args:
|
||||
ctx: ``AppContext`` — read for ``ctx.config`` (pricing table,
|
||||
currency, budget) and nothing else; this class does no I/O of
|
||||
its own beyond what ``core.usage_tracker`` already does.
|
||||
directory: Optional custom usage directory. If None, uses default USAGE_DIR.
|
||||
"""
|
||||
|
||||
def __init__(self, ctx: Any, directory: Optional[Path] = None) -> None:
|
||||
"""``directory`` để None thì đọc thư mục telemetry mặc định; test trỏ nó vào
|
||||
``tmp_path`` để không chạm dữ liệu thật.
|
||||
"""
|
||||
self.ctx = ctx
|
||||
self._directory = directory
|
||||
|
||||
def pricing(self) -> Dict[str, Any]:
|
||||
"""The merged price table (defaults + user overrides), synced from
|
||||
Monitoring's model-pricing table first so cost figures always agree
|
||||
between the two screens."""
|
||||
from cowork_local.core import model_pricing as mp
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
mp.sync_to_usage(self.ctx.config)
|
||||
return {**ut.DEFAULT_PRICING, **(self.ctx.config.data.get("usage") or {})}
|
||||
|
||||
def period_range(self, granularity: str, offset: int) -> Tuple[date, date]:
|
||||
"""The SELECTED period as an inclusive ``(start, end)`` date range —
|
||||
drives every widget on the screen (cards, chart, habits)."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
start, end = ut.period_bounds(granularity, offset)
|
||||
return start, end - timedelta(days=1) # load_events end is inclusive
|
||||
|
||||
def summary(self, start: date, end: date) -> Dict[str, Any]:
|
||||
"""Everything the stat cards + habits panel need for one period:
|
||||
the raw events, ``usage_tracker.summarize``'s aggregate stats, the
|
||||
per-bucket costs, and their total — computed once so both widgets
|
||||
read the same numbers instead of loading events twice."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
events = ut.load_events(start, end, directory=self._directory)
|
||||
pricing = self.pricing()
|
||||
stats = ut.summarize(events)
|
||||
costs = ut.cost_usd_events(events, pricing)
|
||||
return {
|
||||
"events": events,
|
||||
"pricing": pricing,
|
||||
"stats": stats,
|
||||
"costs": costs,
|
||||
"total_cost": sum(costs.values()),
|
||||
}
|
||||
|
||||
def chart_series(self, granularity: str, offset: int, metric: str
|
||||
) -> List[Tuple[str, float]]:
|
||||
"""``(label, value)`` points for the spline chart — WEEK -> 7 days,
|
||||
MONTH -> weeks, YEAR -> 12 months, in whichever ``metric``
|
||||
("tokens" | "cost") was selected."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
events = ut.load_events(directory=self._directory) # all events; breakdown slices by period
|
||||
pricing = self.pricing()
|
||||
parts = ut.period_breakdown(events, granularity, pricing, offset=offset)
|
||||
mi = 0 if metric == "tokens" else 1 # (label, tokens, cost) -> +1 for the value
|
||||
return [(row[0], float(row[mi + 1])) for row in parts]
|
||||
|
||||
def period_totals(self, granularity: str, offset: int) -> Tuple[float, float]:
|
||||
"""``(tokens, cost)`` totals for one period — used to compute the
|
||||
vs-previous-period delta the chart's reference line shows."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
events = ut.load_events(directory=self._directory)
|
||||
return ut.period_totals(events, granularity, self.pricing(), offset)
|
||||
|
||||
def period_range_label(self, granularity: str, offset: int) -> str:
|
||||
"""Nhãn hiển thị của một kỳ (tuần/tháng/năm cộng độ lệch)."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
return ut.period_range_label(granularity, offset)
|
||||
|
||||
def budget_status(self):
|
||||
"""Tình trạng ngân sách: đã dùng bao nhiêu, còn lại bao nhiêu, có vượt ngưỡng chưa."""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
return ut.budget_status(self.ctx.config)
|
||||
|
||||
def set_budget(self, amount: float, currency: str) -> None:
|
||||
"""Đặt hạn mức ngân sách mới — mở một chu kỳ đếm mới, chi tiêu trước đó không
|
||||
còn được tính vào.
|
||||
"""
|
||||
from cowork_local.core import usage_tracker as ut
|
||||
|
||||
ut.set_budget(self.ctx.config, amount, currency)
|
||||
|
||||
|
||||
__all__ = ["DashboardQueryService"]
|
||||
@@ -1,3 +0,0 @@
|
||||
"""DTO của phân hệ Giám sát: hình dạng dữ liệu mà tầng application trả cho
|
||||
giao diện, không phụ thuộc nguồn đọc.
|
||||
"""
|
||||
|
||||
@@ -12,9 +12,6 @@ from typing import Any, Dict
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class AuditEventDTO:
|
||||
"""Một sự kiện kiểm toán ở dạng tầng application dùng — không phụ thuộc khuôn
|
||||
lưu trên đĩa, nên đổi định dạng nhật ký không kéo theo sửa giao diện.
|
||||
"""
|
||||
ts: str
|
||||
kind: str
|
||||
name: str
|
||||
@@ -43,7 +40,6 @@ class AuditEventDTO:
|
||||
)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Bản ghi dưới dạng dict cho lớp giao diện."""
|
||||
return {
|
||||
"ts": self.ts, "kind": self.kind, "agent_role": self.agent_role,
|
||||
"name": self.name, "ok": self.ok, "detail": self.detail,
|
||||
|
||||
@@ -16,7 +16,6 @@ from .repository.audit_event_repository import AuditEventRepository
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Page:
|
||||
"""Một trang kết quả truy vấn nhật ký: các mục, tổng số, số trang và cỡ trang."""
|
||||
items: List[AuditEventDTO]
|
||||
total: int
|
||||
page: int
|
||||
@@ -24,7 +23,6 @@ class Page:
|
||||
|
||||
@property
|
||||
def has_more(self) -> bool:
|
||||
"""Còn trang sau nữa không."""
|
||||
return self.page * self.page_size < self.total
|
||||
|
||||
|
||||
@@ -33,15 +31,11 @@ class MonitoringQueryService:
|
||||
audit log; this service never writes anything."""
|
||||
|
||||
def __init__(self, repository: AuditEventRepository) -> None:
|
||||
"""Nhận kho sự kiện kiểm toán qua tham số — bản thật đọc đĩa, bản test nằm
|
||||
trong bộ nhớ.
|
||||
"""
|
||||
self._repository = repository
|
||||
|
||||
def query(self, kind: Optional[str] = None, ok: Optional[bool] = None,
|
||||
text: Optional[str] = None, sort_by: str = "ts",
|
||||
descending: bool = True, page: int = 1, page_size: int = 50) -> Page:
|
||||
"""Lọc theo loại/kết quả/từ khoá, sắp xếp rồi cắt thành một trang."""
|
||||
events = self._repository.load(kind=kind)
|
||||
|
||||
if ok is not None:
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
"""Cổng đọc dữ liệu của phân hệ Giám sát — hợp đồng, không phải cài đặt."""
|
||||
|
||||
@@ -13,13 +13,7 @@ from ..dto.audit_event_dto import AuditEventDTO
|
||||
|
||||
|
||||
class AuditEventRepository(Protocol):
|
||||
"""Cổng đọc nhật ký kiểm toán mà tầng application dùng.
|
||||
|
||||
Chỉ là hợp đồng: bản cài đặt thật đọc từ file cục bộ hoặc thư mục chia sẻ,
|
||||
còn test truyền vào bộ giả.
|
||||
"""
|
||||
def load(self, kind: Optional[str] = None) -> List[AuditEventDTO]:
|
||||
"""Đọc sự kiện kiểm toán, lọc theo loại nếu có."""
|
||||
...
|
||||
|
||||
|
||||
@@ -28,11 +22,9 @@ class CanonicalAuditEventRepository:
|
||||
— the only place this application service reaches into infrastructure."""
|
||||
|
||||
def __init__(self, audit_logger) -> None:
|
||||
"""Bọc bộ ghi nhật ký kiểm toán chuẩn để đọc sự kiện ra."""
|
||||
self._audit_logger = audit_logger
|
||||
|
||||
def load(self, kind: Optional[str] = None) -> List[AuditEventDTO]:
|
||||
"""Đọc sự kiện từ nhật ký và đổi sang DTO của tầng application."""
|
||||
events = self._audit_logger.load_events(kind=kind)
|
||||
return [AuditEventDTO.from_raw(e.to_dict()) for e in events]
|
||||
|
||||
@@ -41,13 +33,9 @@ class InMemoryAuditEventRepository:
|
||||
"""Test double — holds a fixed list of events, no file I/O."""
|
||||
|
||||
def __init__(self, events: List[AuditEventDTO]) -> None:
|
||||
"""Nhận sẵn danh sách sự kiện. Chép lại chứ không giữ tham chiếu: bên gọi sửa
|
||||
danh sách gốc thì kết quả test không được đổi theo.
|
||||
"""
|
||||
self._events = list(events)
|
||||
|
||||
def load(self, kind: Optional[str] = None) -> List[AuditEventDTO]:
|
||||
"""Trả về danh sách đã nạp sẵn, lọc theo loại nếu có."""
|
||||
if kind is None:
|
||||
return list(self._events)
|
||||
return [e for e in self._events if e.kind == kind]
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
"""Application services for the "Block network" switch (Sandbox Security Layer)."""
|
||||
|
||||
from .network_guard import NetworkBlockedError, bind, ensure_allowed, is_blocked, refusal
|
||||
|
||||
__all__ = ["NetworkBlockedError", "bind", "ensure_allowed", "is_blocked", "refusal"]
|
||||
@@ -1,61 +0,0 @@
|
||||
"""One gate for every outbound connection the app makes on its own.
|
||||
|
||||
The "Block network" switch (``agent_security.block_network``) used to be read
|
||||
only where agent tools run, so Microsoft 365, Teams, connector test buttons,
|
||||
scheduled task scripts, pip auto-installs and HTML previews still reached the
|
||||
internet while Monitoring said "Network: blocked". Each of those now asks
|
||||
this module first.
|
||||
|
||||
The AI provider path (chat, model list, model test) deliberately does NOT go
|
||||
through here: with the switch on the user still talks to the model, but the
|
||||
app fetches nothing else on the model's or its own behalf.
|
||||
|
||||
The module holds a *reader*, not a copy of the flag: the Composition Root
|
||||
binds it to the live config once (``presentation/shell/bootstrap.py``), so a
|
||||
change saved in Settings takes effect on the very next call. Nothing bound
|
||||
(unit tests, helper subprocesses) means "not blocked", the pre-switch default.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
from typing import Callable, Optional
|
||||
|
||||
_lock = threading.Lock()
|
||||
_reader: Optional[Callable[[], bool]] = None
|
||||
|
||||
|
||||
class NetworkBlockedError(PermissionError):
|
||||
"""Raised by :func:`ensure_allowed` while the switch is on."""
|
||||
|
||||
|
||||
def bind(reader: Optional[Callable[[], bool]]) -> None:
|
||||
"""Install the callable that says whether the network is blocked right now."""
|
||||
global _reader
|
||||
with _lock:
|
||||
_reader = reader
|
||||
|
||||
|
||||
def is_blocked() -> bool:
|
||||
"""True while "Block network" is on. A failing reader counts as blocked."""
|
||||
reader = _reader
|
||||
if reader is None:
|
||||
return False
|
||||
try:
|
||||
return bool(reader())
|
||||
except Exception: # noqa: BLE001 - fail closed: an unreadable switch must not open the network
|
||||
return True
|
||||
|
||||
|
||||
def refusal(purpose: str) -> str:
|
||||
"""The message shown (to the user or the model) when ``purpose`` is refused."""
|
||||
return (f"{purpose}: network access is blocked by the Sandbox Security Layer "
|
||||
"(\"Block network\" is on in Settings). Only the AI provider may be reached.")
|
||||
|
||||
|
||||
def ensure_allowed(purpose: str) -> None:
|
||||
"""Raise :class:`NetworkBlockedError` if ``purpose`` may not go online now."""
|
||||
if is_blocked():
|
||||
raise NetworkBlockedError(refusal(purpose))
|
||||
|
||||
|
||||
__all__ = ["NetworkBlockedError", "bind", "ensure_allowed", "is_blocked", "refusal"]
|
||||
@@ -1,6 +1 @@
|
||||
"""Application services for Schedule Task (EPIC R07)."""
|
||||
|
||||
from .ai_task_planner_service import AiTaskPlannerService
|
||||
from .task_application_service import MoveResult, RunNowResult, TaskApplicationService
|
||||
|
||||
__all__ = ["TaskApplicationService", "RunNowResult", "MoveResult", "AiTaskPlannerService"]
|
||||
"""Application scheduling package: TaskApplicationService and AI task planning."""
|
||||
|
||||
@@ -1,100 +0,0 @@
|
||||
"""AiTaskPlannerService - AI-generate / import task lists, outside the widget
|
||||
(R07-T05).
|
||||
|
||||
``ui/schedule_task_tab.py``'s ``_AiCreateDialog`` already delegates the
|
||||
actual planning to two existing pure functions —
|
||||
``core/ai_task_planner.py::plan_tasks`` (natural-language description ->
|
||||
task dicts, via the active provider) and
|
||||
``core/task_import.py::import_tasks`` (Excel/CSV/JSON -> task dicts) — so
|
||||
this service does not reimplement either. What it DOES own is one small
|
||||
piece of business logic that currently only exists inside the dialog's
|
||||
``AgentWorker`` job closure (``_generate``'s ``job()``): every AI-generated
|
||||
task must carry the SAME file/link attachments the user attached to the
|
||||
request, so they're available again at run time, not just visible to the
|
||||
planner while it drafts the task list. Leaving that step trapped in a Qt
|
||||
worker closure means it can only be exercised by driving the real dialog;
|
||||
here it's a plain, independently testable method.
|
||||
|
||||
Pure Python: no Qt import. The provider is a constructor-injected factory
|
||||
(``() -> Provider``, no arguments — matches ``AppContext.build_active_
|
||||
provider``), the same dependency-inversion shape
|
||||
``application/conversations/conversation_application_service.py`` (R04-T03)
|
||||
uses for ITS provider factory.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Any, Callable, Dict, List, Optional, Sequence, Union
|
||||
|
||||
ProviderFactory = Callable[[], Any]
|
||||
CancelFn = Callable[[], bool]
|
||||
|
||||
|
||||
class AiTaskPlannerService:
|
||||
"""AI task generation + file/Excel/CSV/JSON import, for
|
||||
``presentation/scheduling/ai_task_creator_dialog.py`` and
|
||||
``ai_task_import_dialog.py`` (R08-T11) to call instead of importing
|
||||
``core.ai_task_planner``/``core.task_import`` directly.
|
||||
|
||||
Args:
|
||||
provider_factory: ``() -> Provider``. Production passes
|
||||
``AppContext.build_active_provider``; tests pass a lambda
|
||||
returning a :class:`FakeProvider`.
|
||||
"""
|
||||
|
||||
def __init__(self, provider_factory: Optional[ProviderFactory] = None) -> None:
|
||||
"""``provider_factory`` là hàm dựng provider, gọi lúc cần chứ không dựng sẵn —
|
||||
provider có thể bị đổi giữa hai lần lập kế hoạch.
|
||||
"""
|
||||
self._provider_factory = provider_factory
|
||||
|
||||
def plan(
|
||||
self,
|
||||
description: str,
|
||||
*,
|
||||
file_paths: Sequence[str] = (),
|
||||
links: Sequence[str] = (),
|
||||
provider: Any = None,
|
||||
cancel: Optional[CancelFn] = None,
|
||||
) -> List[Dict[str, Any]]:
|
||||
"""Turn ``description`` into a list of NOT-yet-saved task dicts.
|
||||
|
||||
``provider`` overrides the constructor's factory for this one call
|
||||
(useful for tests, or a caller that already resolved a provider);
|
||||
omit it to use the injected factory. Raises ``RuntimeError`` when
|
||||
no provider is available at all, or when the model's reply had no
|
||||
parseable task list (same error ``core.ai_task_planner.plan_tasks``
|
||||
already raises).
|
||||
"""
|
||||
resolved = provider if provider is not None else self._resolve_provider()
|
||||
from cowork_local.core.ai_task_planner import plan_tasks
|
||||
|
||||
planned = plan_tasks(resolved, description, cancel=cancel)
|
||||
# Attachments apply to EVERY generated task so they're still there
|
||||
# when the task actually runs, not just while the planner drafts it
|
||||
# (see module docstring — this used to only happen inside the
|
||||
# dialog's worker closure).
|
||||
for task in planned:
|
||||
task["input"]["file_paths"] = list(file_paths)
|
||||
task["input"]["links"] = list(links)
|
||||
return planned
|
||||
|
||||
def import_file(self, path: Union[str, Path]) -> List[Dict[str, Any]]:
|
||||
"""Excel/CSV/JSON -> NOT-yet-saved task dicts, auto-chained in file
|
||||
order. Raises ``ValueError`` with a human-readable message on an
|
||||
unusable/unsupported file (same contract
|
||||
``core.task_import.import_tasks`` already has)."""
|
||||
from cowork_local.core.task_import import import_tasks
|
||||
|
||||
return import_tasks(path)
|
||||
|
||||
def _resolve_provider(self) -> Any:
|
||||
"""Provider dùng để lập kế hoạch; chưa cấu hình thì báo lỗi rõ ràng ngay tại
|
||||
đây thay vì để lỗi nổ ra ở tận tầng HTTP.
|
||||
"""
|
||||
if self._provider_factory is None:
|
||||
raise RuntimeError("No provider available to plan tasks.")
|
||||
return self._provider_factory()
|
||||
|
||||
|
||||
__all__ = ["AiTaskPlannerService"]
|
||||
@@ -1,176 +0,0 @@
|
||||
"""TaskApplicationService - task CRUD + dispatch, outside the widget (R07-T04).
|
||||
|
||||
``ui/schedule_task_tab.py`` currently does all of this by importing
|
||||
``core/tasks.py`` module functions directly and calling
|
||||
``self.scheduler.run_now(...)`` inline inside Qt slot methods
|
||||
(``_run_now``, ``_context_menu``'s duplicate/pause/delete branches,
|
||||
``_on_task_dropped``'s per-lane business rules). None of it is Qt — it's
|
||||
plain CRUD plus a few small rules ("a manual task never auto-runs",
|
||||
"dropping a card on Done disables its schedule so it won't re-fire",
|
||||
"dropping on Scheduled with no time set needs the editor, not a silent
|
||||
no-op") — but it can only be exercised today by driving the real widget.
|
||||
|
||||
This service is the seam ``presentation/scheduling/kanban_board_widget.py``
|
||||
(R08-T11) calls instead: same rules, same
|
||||
:class:`~infrastructure.persistence.json.task_repository_impl.TaskRepository`
|
||||
underneath, testable with no Qt at all.
|
||||
|
||||
Pure Python: no Qt import. ``run_now`` dispatch is a plain injected callable
|
||||
(production wires ``TaskScheduler.run_now``; tests inject a stub), the same
|
||||
constructor-injection shape ``application/conversations/conversation_
|
||||
application_service.py`` (R04-T03) uses for its provider factory.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from typing import Any, Callable, Dict, List, Optional
|
||||
|
||||
# "TaskRepository" here is a Protocol-shaped name, not an import: this module
|
||||
# only calls .get/.save/.delete/.duplicate, so any object with that shape
|
||||
# (the real infrastructure.persistence.json.task_repository_impl.TaskRepository,
|
||||
# or a test double) works without this file importing infrastructure/ at
|
||||
# module scope.
|
||||
RunNowFn = Callable[[str], bool]
|
||||
|
||||
|
||||
@dataclass
|
||||
class RunNowResult:
|
||||
"""Outcome of asking a task to run immediately.
|
||||
|
||||
``reason`` is one of ``""`` (ok), ``"not_found"``, ``"manual_task"``
|
||||
(manual tasks never auto-run — spec: they exist to be run by a human),
|
||||
``"no_scheduler"`` (no ``run_now`` callable was wired in), or
|
||||
``"already_running"`` (the scheduler's own dedupe rejected it).
|
||||
"""
|
||||
|
||||
ok: bool
|
||||
reason: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class MoveResult:
|
||||
"""Outcome of dropping a task card onto a Kanban lane
|
||||
(``move_to_status``). The caller (kanban widget) uses the flags to decide
|
||||
what to show — a full re-render, a "task is running" toast, or opening
|
||||
the task editor — without re-deriving the business rule itself."""
|
||||
|
||||
task: Optional[Dict[str, Any]]
|
||||
blocked: bool = False # dropped while already running — ignored
|
||||
ran_now: bool = False # dropped on the Running lane — dispatched
|
||||
run_now_result: Optional[RunNowResult] = None
|
||||
needs_schedule: bool = False # dropped on Scheduled with no run_at set — needs editing
|
||||
|
||||
|
||||
class TaskApplicationService:
|
||||
"""CRUD + dispatch for Schedule Task, backed by a ``TaskRepository``.
|
||||
|
||||
Args:
|
||||
repository: a ``TaskRepository``-shaped object (``.get``, ``.save``,
|
||||
``.delete``, ``.duplicate``). Production passes
|
||||
``infrastructure.persistence.json.task_repository_impl.
|
||||
TaskRepository()``; tests pass one scoped to a ``tmp_path``.
|
||||
run_now: ``(task_id) -> bool``. Production passes
|
||||
``TaskScheduler.run_now``; ``None`` means no scheduler is wired
|
||||
(matches the widget's own "no scheduler" guard today).
|
||||
"""
|
||||
|
||||
def __init__(self, repository: Any, run_now: Optional[RunNowFn] = None) -> None:
|
||||
"""``run_now`` để None thì service chỉ đọc/ghi task, không chạy được cái nào —
|
||||
đúng cho ngữ cảnh không có scheduler (test, hay màn chỉ xem).
|
||||
"""
|
||||
self._repository = repository
|
||||
self._run_now = run_now
|
||||
|
||||
# -- single-task actions ------------------------------------------------ #
|
||||
def run_now(self, task_id: str) -> RunNowResult:
|
||||
"""Dispatch ``task_id`` immediately. A "Run now" always counts as
|
||||
manual approval (spec §13) — this is the ONE path that bypasses
|
||||
``execution.requires_approval``, same as the scheduler's own
|
||||
``run_now`` already does."""
|
||||
task = self._repository.get(task_id)
|
||||
if task is None:
|
||||
return RunNowResult(False, "not_found")
|
||||
if task.get("task_type") == "manual":
|
||||
return RunNowResult(False, "manual_task")
|
||||
if self._run_now is None:
|
||||
return RunNowResult(False, "no_scheduler")
|
||||
ok = self._run_now(task_id)
|
||||
return RunNowResult(ok, "" if ok else "already_running")
|
||||
|
||||
def duplicate(self, task_id: str) -> Optional[Dict[str, Any]]:
|
||||
"""A saved copy with a fresh identity — see
|
||||
``core/tasks.py::duplicate_task`` for what's preserved/reset."""
|
||||
task = self._repository.get(task_id)
|
||||
if task is None:
|
||||
return None
|
||||
dup = self._repository.duplicate(task)
|
||||
self._repository.save(dup)
|
||||
return dup
|
||||
|
||||
def toggle_pause(self, task_id: str) -> Optional[Dict[str, Any]]:
|
||||
"""Pause a task, or resume a paused one back to Backlog (matches
|
||||
``ui/schedule_task_tab.py``'s context-menu action exactly — resuming
|
||||
does NOT restore whatever status the task had before pausing, only
|
||||
Backlog, so the user re-schedules explicitly rather than a stale
|
||||
schedule silently re-firing)."""
|
||||
task = self._repository.get(task_id)
|
||||
if task is None:
|
||||
return None
|
||||
task["status"] = "backlog" if task.get("status") == "paused" else "paused"
|
||||
self._repository.save(task)
|
||||
return task
|
||||
|
||||
def delete(self, task_id: str) -> bool:
|
||||
"""Xoá một task; trả về ``False`` nếu id không tồn tại."""
|
||||
if self._repository.get(task_id) is None:
|
||||
return False
|
||||
self._repository.delete(task_id)
|
||||
return True
|
||||
|
||||
def bulk_delete(self, task_ids: List[str]) -> int:
|
||||
"""Delete every id in ``task_ids``; returns how many actually
|
||||
existed (mirrors ``_confirm_and_delete_selected``'s best-effort
|
||||
loop — a stale id in the selection doesn't abort the rest)."""
|
||||
return sum(1 for tid in task_ids if self.delete(tid))
|
||||
|
||||
# -- Kanban drag/drop ----------------------------------------------------- #
|
||||
def move_to_status(self, task_id: str, new_status: str) -> Optional[MoveResult]:
|
||||
"""Apply the business rule behind dropping a card into a lane
|
||||
(``ui/schedule_task_tab.py::_on_task_dropped``, moved here so it's
|
||||
testable without a real ``QListWidget`` drag gesture):
|
||||
|
||||
* already running -> the drop is ignored (a running task can't be
|
||||
re-filed by dragging it).
|
||||
* dropped on Running -> runs it now (counts as manual approval).
|
||||
* dropped on Done -> marks it done AND disables its schedule, so a
|
||||
repeating task marked done by hand doesn't quietly re-fire later.
|
||||
* dropped on Scheduled with no ``run_at`` set yet -> saved as-is but
|
||||
flagged ``needs_schedule`` — the caller should open the editor
|
||||
rather than leave a Scheduled card that will never actually run.
|
||||
* anything else -> plain status change.
|
||||
"""
|
||||
task = self._repository.get(task_id)
|
||||
if task is None:
|
||||
return None
|
||||
if task.get("status") == "running":
|
||||
return MoveResult(task=task, blocked=True)
|
||||
if new_status == "running":
|
||||
result = self.run_now(task_id)
|
||||
return MoveResult(task=self._repository.get(task_id), ran_now=True, run_now_result=result)
|
||||
if new_status == "done":
|
||||
task["status"] = "done"
|
||||
task["schedule"]["enabled"] = False
|
||||
self._repository.save(task)
|
||||
return MoveResult(task=task)
|
||||
task["status"] = new_status
|
||||
if new_status == "scheduled" and not task["schedule"].get("enabled"):
|
||||
if task["schedule"].get("run_at"):
|
||||
task["schedule"]["enabled"] = True
|
||||
else:
|
||||
self._repository.save(task)
|
||||
return MoveResult(task=task, needs_schedule=True)
|
||||
self._repository.save(task)
|
||||
return MoveResult(task=task)
|
||||
|
||||
|
||||
__all__ = ["TaskApplicationService", "RunNowResult", "MoveResult"]
|
||||
@@ -0,0 +1 @@
|
||||
"""Application settings package: Settings application service."""
|
||||
@@ -1,99 +0,0 @@
|
||||
"""Đọc/ghi file lịch sử run của Co4E — tách khỏi ``co4e_workflow_service.py``.
|
||||
|
||||
``Co4EWorkflowService`` lo vòng đời các run đang chạy; chỗ này lo đúng một
|
||||
việc: đưa ``RunRecord`` ra đĩa và lấy lại được. Tách ra vì hành vi đọc/ghi ở
|
||||
đây có những ràng buộc rất riêng — được ghi lại nguyên vẹn bên dưới — mà trộn
|
||||
lẫn vào file điều phối thì không ai đọc tới.
|
||||
|
||||
DTO ở ``domain/workflows/run_record.py`` không được chạm đĩa, nên việc này
|
||||
nằm ở tầng application chứ không nằm trong domain.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Tuple
|
||||
|
||||
from ...domain.workflows.run_record import RunRecord
|
||||
from ...infrastructure.persistence.json.atomic_json_file import AtomicJsonFile
|
||||
|
||||
#: Giữ N run gần nhất trên đĩa. Lịch sử chỉ để người dùng nhìn lại, không
|
||||
#: phải sổ kiểm toán — để nó lớn vô hạn thì mỗi lần lưu lại phải tuần tự hoá
|
||||
#: cả file, và lần lưu ấy nằm ngay trên đường đi của mọi sự kiện tiến độ.
|
||||
HISTORY_CAP = 500
|
||||
|
||||
|
||||
class RunHistoryStore:
|
||||
"""Một file JSON chứa lịch sử run, kèm hai quy ước phải giữ nguyên.
|
||||
|
||||
**Không cách ly file hỏng.** Bản đầu dùng ``AtomicJsonFile.read()``, nhưng
|
||||
review thấy nó đổi hành vi thật so với ``Co4ERunManager`` cũ: gặp JSON
|
||||
hỏng, ``AtomicJsonFile.read()`` ĐỔI TÊN file thành ``<tên>.bad-<mốc>`` rồi
|
||||
mới trả về mặc định, trong khi bản cũ chỉ bắt lỗi và ĐỂ NGUYÊN file tại
|
||||
chỗ. Đó là thay đổi quan sát được trên đĩa mà không test nào khoá lại và
|
||||
không có chú thích báo trước — Lâm (N3) quyết ngày 24/08: giữ hành vi cũ.
|
||||
Vì thế :meth:`load` đọc thủ công bằng ``json.loads``.
|
||||
|
||||
**Ghi hỏng không được làm vỡ luồng gọi.** :meth:`save` nuốt ``OSError``,
|
||||
đúng như ``core/co4e_run_manager.py::_save_history``. Nó nằm trên đường đi
|
||||
của mọi hook tiến độ (``_on_event``/``_on_finished``/``_on_failed``); để
|
||||
lỗi ghi đĩa (đầy đĩa, mất quyền) ném ra là vỡ cả lượt xử lý sự kiện đang
|
||||
chạy, chỉ vì lịch sử lần này không lưu được. Người dùng vẫn thấy Flow
|
||||
Status đúng trong phiên hiện tại, chỉ là bản ghi trên đĩa lùi một bước.
|
||||
|
||||
Ghi thì vẫn qua ``AtomicJsonFile``: bản tự viết bằng tmp + ``replace``
|
||||
thiếu ``fsync`` (dữ liệu có thể còn trong bộ đệm khi mất điện) và
|
||||
``Path.replace`` thỉnh thoảng bị Defender từ chối trên Windows.
|
||||
"""
|
||||
|
||||
def __init__(self, path: Path):
|
||||
"""Trỏ vào một file JSON. Chưa tồn tại cũng không sao — :meth:`load` coi như
|
||||
lịch sử rỗng và :meth:`save` tự tạo thư mục cha.
|
||||
"""
|
||||
self.path = Path(path)
|
||||
|
||||
def load(self) -> Tuple[Dict[str, RunRecord], int]:
|
||||
"""Đọc lịch sử; trả về ``({id: RunRecord}, số thứ tự lớn nhất đã dùng)``.
|
||||
|
||||
Số thứ tự trả kèm để bên gọi sinh id tiếp theo không đụng vào id đã có
|
||||
trong lịch sử — không có nó thì sau mỗi lần khởi động lại, ``run1``
|
||||
mới sẽ ghi đè ``run1`` cũ.
|
||||
|
||||
File không có, không đọc được, hay JSON hỏng đều trả về rỗng: mất lịch
|
||||
sử là chuyện chấp nhận được, chặn ứng dụng khởi động thì không. Từng
|
||||
bản ghi hỏng cũng bị bỏ riêng lẻ, để một dòng lỗi không kéo theo cả
|
||||
file.
|
||||
"""
|
||||
try:
|
||||
data = json.loads(self.path.read_text(encoding="utf-8"))
|
||||
except (OSError, ValueError):
|
||||
return {}, 0
|
||||
|
||||
runs: Dict[str, RunRecord] = {}
|
||||
max_seq = 0
|
||||
for rec in data.get("runs", []):
|
||||
try:
|
||||
record = RunRecord.from_dict(rec)
|
||||
except Exception:
|
||||
continue
|
||||
if not record.id:
|
||||
continue
|
||||
runs[record.id] = record
|
||||
if record.id.startswith("run") and record.id[3:].isdigit():
|
||||
max_seq = max(max_seq, int(record.id[3:]))
|
||||
return runs, max_seq
|
||||
|
||||
def save(self, runs: List[RunRecord]) -> None:
|
||||
"""Ghi ``HISTORY_CAP`` run gần nhất xuống đĩa, ghi nguyên tử.
|
||||
|
||||
Lỗi ghi bị nuốt có chủ ý — xem docstring của lớp.
|
||||
"""
|
||||
payload = {"runs": [r.to_dict() for r in runs[-HISTORY_CAP:]]}
|
||||
try:
|
||||
self.path.parent.mkdir(parents=True, exist_ok=True)
|
||||
AtomicJsonFile(self.path).write(payload)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
__all__ = ["RunHistoryStore", "HISTORY_CAP"]
|
||||
@@ -32,20 +32,12 @@ Qt thật (bọc ``AgentWorker`` — xem ``core/worker.py``) là việc của wi
|
||||
KHÔNG xoá/sửa ``core/co4e_run_manager.py`` — lớp cũ tiếp tục chạy song song
|
||||
cho tới khi widget Co4E Studio thật (``ui/co4e_tab.py``) chuyển hẳn sang dùng
|
||||
service này.
|
||||
|
||||
SEAM · dựng 2026-08-25 · chưa nối dây (F-05)
|
||||
------------------------------------------------------------
|
||||
Được nối khi: ``ui/co4e_tab.py`` bỏ ``Co4ERunManager`` và nhận service này qua ``build_co4e_tab(ctx, workflow_service)``.
|
||||
Để dormant thì sao: Hai bản cùng giữ vòng đời run đang chạy song song. Càng
|
||||
để lâu thì sửa một lỗi lại phải sửa hai nơi — và đến một lúc sẽ có người
|
||||
quên nơi thứ hai.
|
||||
|
||||
Cổng ``scripts/check_orphan_modules.py`` đếm tuổi seam từ ngày trên
|
||||
và nhắc khi quá ``SEAM_MAX_AGE_DAYS``. Đổi nội dung dòng đó thì cổng
|
||||
đọc theo — đừng sửa ngày để làm im lời nhắc.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from ...infrastructure.persistence.json.atomic_json_file import AtomicJsonFile
|
||||
|
||||
import json
|
||||
import os
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
@@ -53,13 +45,12 @@ from typing import Callable, Dict, List, Optional, Protocol, Set
|
||||
|
||||
from ...core.co4e import CO4E_DIR, STEP_DONE, STEP_ERROR, STEP_PLANNED, Workflow, slugify, workflow_to_dict
|
||||
from ...domain.workflows.run_record import RunRecord
|
||||
from .co4e_run_history import RunHistoryStore
|
||||
|
||||
_TERMINAL_NODE = {STEP_DONE, STEP_ERROR, STEP_PLANNED}
|
||||
_HISTORY_CAP = 500 # giữ N run gần nhất trên đĩa
|
||||
|
||||
|
||||
def _now_str() -> str:
|
||||
"""Mốc thời gian hiện tại dạng 'YYYY-MM-DD HH:MM' — đúng định dạng lịch sử run đang lưu."""
|
||||
return datetime.now().strftime("%Y-%m-%d %H:%M")
|
||||
|
||||
|
||||
@@ -79,24 +70,15 @@ class RunnerJob(Protocol):
|
||||
đồng bộ trong test.
|
||||
"""
|
||||
|
||||
def emit_event(self, ev: dict) -> None:
|
||||
"""Đẩy một sự kiện tiến độ từ luồng nền về service."""
|
||||
...
|
||||
|
||||
def is_cancelled(self) -> bool:
|
||||
"""``True`` khi người dùng đã bấm dừng — thân job phải tự kiểm để thoát sớm."""
|
||||
...
|
||||
def emit_event(self, ev: dict) -> None: ...
|
||||
def is_cancelled(self) -> bool: ...
|
||||
|
||||
|
||||
class RunWorkerHandle(Protocol):
|
||||
"""Điều khiển một job đang chạy nền — tương ứng phần
|
||||
``AgentWorker.request_stop()`` cũ mà ``Co4ERunManager.stop()`` gọi."""
|
||||
|
||||
def request_stop(self) -> None:
|
||||
"""Xin dừng run. Chỉ là yêu cầu: job đang chạy phải tự thấy qua
|
||||
``is_cancelled()`` rồi thoát, không ai giết luồng giữa chừng.
|
||||
"""
|
||||
...
|
||||
def request_stop(self) -> None: ...
|
||||
|
||||
|
||||
class WorkflowRunner(Protocol):
|
||||
@@ -112,9 +94,7 @@ class WorkflowRunner(Protocol):
|
||||
def start(self, run_id: str, job: Callable[[RunnerJob], Optional[dict]],
|
||||
on_event: Callable[[dict], None],
|
||||
on_finished: Callable[[Optional[dict]], None],
|
||||
on_failed: Callable[[str], None]) -> RunWorkerHandle:
|
||||
"""Chạy ``job`` và trả về tay cầm để dừng nó."""
|
||||
...
|
||||
on_failed: Callable[[str], None]) -> RunWorkerHandle: ...
|
||||
|
||||
|
||||
class Co4EWorkflowService:
|
||||
@@ -128,12 +108,6 @@ class Co4EWorkflowService:
|
||||
|
||||
def __init__(self, ctx, *, history_path: Optional[Path] = None,
|
||||
runner: Optional[WorkflowRunner] = None):
|
||||
"""Dựng service.
|
||||
|
||||
``runner`` để None nghĩa là chưa có ai chạy được run — đúng trạng thái hiện
|
||||
nay, vì adapter Qt thật thuộc về tầng ``presentation/`` và chưa được nối.
|
||||
Test tiêm runner chạy đồng bộ vào đây.
|
||||
"""
|
||||
self.ctx = ctx
|
||||
self._runs: Dict[str, RunRecord] = {}
|
||||
self._worker_handles: Dict[str, RunWorkerHandle] = {}
|
||||
@@ -142,12 +116,10 @@ class Co4EWorkflowService:
|
||||
self._project_id: str = "" # workspace đang chọn — Flow Status lọc theo no
|
||||
self._runner = runner
|
||||
# DTO domain khong duoc cham dia (xem domain/workflows/run_record.py),
|
||||
# nen viec doc/ghi file lich su nam o tang application — cu the la
|
||||
# co4e_run_history.py::RunHistoryStore.
|
||||
# nen viec doc/ghi file lich su nam o day, tang application.
|
||||
self._history_path_value = (
|
||||
Path(history_path) if history_path is not None else (CO4E_DIR / "run_history.json")
|
||||
)
|
||||
self._history = RunHistoryStore(self._history_path_value)
|
||||
self._changed_callbacks: List[Callable[[], None]] = []
|
||||
self._event_callbacks: List[Callable[[str, dict], None]] = []
|
||||
self._load_history() # khoi phuc lich su cu de Flow Status
|
||||
@@ -155,42 +127,71 @@ class Co4EWorkflowService:
|
||||
|
||||
# ---- callback thay Signal ---------------------------------------------
|
||||
def on_changed(self, cb: Callable[[], None]) -> None:
|
||||
"""Đăng ký callback gọi mỗi khi danh sách run đổi — thay cho signal Qt cũ."""
|
||||
self._changed_callbacks.append(cb)
|
||||
|
||||
def on_event(self, cb: Callable[[str, dict], None]) -> None:
|
||||
"""Đăng ký callback nhận sự kiện tiến độ của từng run — thay cho signal Qt cũ."""
|
||||
self._event_callbacks.append(cb)
|
||||
|
||||
def _emit_changed(self) -> None:
|
||||
"""Lưu lịch sử rồi báo mọi người đăng ký."""
|
||||
self._save_history() # xem docstring dau file: giu dung thu tu ban Qt cu
|
||||
for cb in self._changed_callbacks:
|
||||
cb()
|
||||
|
||||
def _emit_event(self, run_id: str, ev) -> None:
|
||||
"""Chuyển một sự kiện tiến độ tới mọi callback đã đăng ký."""
|
||||
for cb in self._event_callbacks:
|
||||
cb(run_id, ev)
|
||||
|
||||
# ---- persistence --------------------------------------------------
|
||||
# Doc/ghi thu cong (json.loads/write_text + tmp.replace), KHONG dung
|
||||
# AtomicJsonFile — ban dau file nay dung AtomicJsonFile.read(), nhung
|
||||
# review phat hien no doi hanh vi that so voi Co4ERunManager cu: gap
|
||||
# JSON hong, AtomicJsonFile.read() ĐOI TEN file hong thanh
|
||||
# "<ten>.bad-<timestamp>" (quarantine) roi moi tra ve mac dinh, trong
|
||||
# khi ban cu chi bat loi va ĐE NGUYEN file hong tai cho, khong dong gi
|
||||
# vao no. Day la mot thay doi quan sat duoc tren dia ma khong test nao
|
||||
# khoa lai va khong co comment bao truoc — Lam (N3) da quyet 24/08:
|
||||
# GIU HANH VI CU nguyen van (khong quarantine), vi day la buoc tach
|
||||
# chi duoc phep doi hanh vi khi da noi ra ro rang va co lưới an toan,
|
||||
# khong phai luc nay.
|
||||
def _load_history(self) -> None:
|
||||
"""Khôi phục lịch sử run từ đĩa lúc khởi động.
|
||||
|
||||
Lấy luôn số thứ tự lớn nhất đã dùng để ``_next_id()`` không sinh trùng
|
||||
id với run cũ.
|
||||
"""
|
||||
self._runs, self._seq = self._history.load()
|
||||
try:
|
||||
data = json.loads(self._history_path_value.read_text(encoding="utf-8"))
|
||||
except (OSError, ValueError):
|
||||
return
|
||||
max_seq = 0
|
||||
for rec in data.get("runs", []):
|
||||
try:
|
||||
record = RunRecord.from_dict(rec)
|
||||
except Exception:
|
||||
continue
|
||||
if not record.id:
|
||||
continue
|
||||
self._runs[record.id] = record
|
||||
if record.id.startswith("run") and record.id[3:].isdigit():
|
||||
max_seq = max(max_seq, int(record.id[3:]))
|
||||
self._seq = max_seq # tranh sinh id trung voi lich su
|
||||
|
||||
def _save_history(self) -> None:
|
||||
"""Ghi lịch sử xuống đĩa. Lỗi ghi bị nuốt có chủ ý — xem
|
||||
``co4e_run_history.py::RunHistoryStore``.
|
||||
"""
|
||||
self._history.save(list(self._runs.values()))
|
||||
runs = list(self._runs.values())[-_HISTORY_CAP:]
|
||||
payload = {"runs": [r.to_dict() for r in runs]}
|
||||
try:
|
||||
self._history_path_value.parent.mkdir(parents=True, exist_ok=True)
|
||||
# AtomicJsonFile thay cho tmp+replace tự viết: bản cũ thiếu fsync
|
||||
# (dữ liệu có thể còn trong bộ đệm khi mất điện) và dùng thẳng
|
||||
# Path.replace, vốn thỉnh thoảng bị Defender từ chối trên Windows.
|
||||
AtomicJsonFile(self._history_path_value).write(payload)
|
||||
except OSError:
|
||||
# Giu dung hanh vi cu (core/co4e_run_manager.py::_save_history):
|
||||
# mot lan luu that bai (day dia, mat quyen...) KHONG duoc phep
|
||||
# chan luong goi cua moi hook (_on_event/_on_finished/_on_failed)
|
||||
# dang di qua _emit_changed(). Bo try/except nay se lam mot loi
|
||||
# ghi dia lam vo ca luot xu ly su kien dang chay, chi vi lich su
|
||||
# khong luu duoc lan nay -- nguoi dung van thay Flow Status dung
|
||||
# trong phien hien tai, chi la ban ghi tren dia lui lai mot buoc.
|
||||
pass
|
||||
|
||||
# ---- lifecycle ----------------------------------------------------
|
||||
def _next_id(self) -> str:
|
||||
"""Sinh id run kế tiếp ('run1', 'run2', ...), không đụng id đã có trong lịch sử."""
|
||||
self._seq += 1
|
||||
return f"run{self._seq}"
|
||||
|
||||
@@ -246,7 +247,6 @@ class Co4EWorkflowService:
|
||||
|
||||
# ---- worker callbacks (goi tu runner, thay slot Qt cu) -----------------
|
||||
def _on_event(self, run_id: str, ev) -> None:
|
||||
"""Nhận sự kiện từ job đang chạy và cập nhật bản ghi run."""
|
||||
record = self._runs.get(run_id)
|
||||
if record is not None and isinstance(ev, dict):
|
||||
t = ev.get("type")
|
||||
@@ -271,7 +271,6 @@ class Co4EWorkflowService:
|
||||
self._emit_event(run_id, ev)
|
||||
|
||||
def _on_finished(self, run_id: str) -> None:
|
||||
"""Job kết thúc mà không phát ``run_done``: chốt trạng thái về 'done'."""
|
||||
record = self._runs.get(run_id)
|
||||
if record is not None and record.status == "running":
|
||||
# job returned without a run_done event (shouldn't happen) — settle it
|
||||
@@ -279,7 +278,6 @@ class Co4EWorkflowService:
|
||||
self._emit_changed()
|
||||
|
||||
def _on_failed(self, run_id: str, err: str) -> None:
|
||||
"""Job ném lỗi: ghi lỗi vào bản ghi và báo ra ngoài một sự kiện ``run_error``."""
|
||||
record = self._runs.get(run_id)
|
||||
if record is not None:
|
||||
record.status = "error"
|
||||
@@ -289,7 +287,6 @@ class Co4EWorkflowService:
|
||||
|
||||
# ---- control --------------------------------------------------------
|
||||
def stop(self, run_id: str) -> None:
|
||||
"""Yêu cầu dừng một run đang chạy và đánh dấu 'stopped'."""
|
||||
record = self._runs.get(run_id)
|
||||
worker = self._worker_handles.get(run_id)
|
||||
if record is not None and worker is not None and record.running:
|
||||
@@ -298,7 +295,6 @@ class Co4EWorkflowService:
|
||||
self._emit_changed()
|
||||
|
||||
def stop_all(self) -> None:
|
||||
"""Dừng mọi run của workspace đang chọn (Flow Status vốn lọc theo project)."""
|
||||
# Only the CURRENT workspace's runs (Flow Status is per-project).
|
||||
for run_id in [r for r, rec in self._runs.items() if self._belongs(rec)]:
|
||||
self.stop(run_id)
|
||||
@@ -319,7 +315,6 @@ class Co4EWorkflowService:
|
||||
self._emit_changed()
|
||||
|
||||
def remove(self, run_id: str) -> None:
|
||||
"""Xoá một run khỏi lịch sử; đang chạy thì dừng trước."""
|
||||
record = self._runs.get(run_id)
|
||||
if record is not None and record.running:
|
||||
self.stop(run_id)
|
||||
@@ -328,7 +323,6 @@ class Co4EWorkflowService:
|
||||
self._emit_changed()
|
||||
|
||||
def clear_finished(self) -> None:
|
||||
"""Xoá mọi run đã kết thúc của workspace đang chọn, giữ nguyên run đang chạy."""
|
||||
# Only clear finished runs of the CURRENT workspace.
|
||||
for run_id in [r for r, rec in self._runs.items() if not rec.running and self._belongs(rec)]:
|
||||
self._runs.pop(run_id, None)
|
||||
@@ -349,11 +343,9 @@ class Co4EWorkflowService:
|
||||
return list(self._runs.values())
|
||||
|
||||
def get(self, run_id: str) -> Optional[RunRecord]:
|
||||
"""Lấy một run theo id; ``None`` nếu không có."""
|
||||
return self._runs.get(run_id)
|
||||
|
||||
def active_count(self) -> int:
|
||||
"""Số run đang chạy của workspace đang chọn — dùng cho huy hiệu trên tab."""
|
||||
return sum(1 for r in self._runs.values() if r.running and self._belongs(r))
|
||||
|
||||
def set_current_project(self, project_id: str) -> None:
|
||||
@@ -371,7 +363,6 @@ class Co4EWorkflowService:
|
||||
self._output_root = Path(root) if root else None
|
||||
|
||||
def _out_dir(self, wf: Workflow) -> Path:
|
||||
"""Thư mục ghi kết quả của một luồng, tạo sẵn nếu chưa có."""
|
||||
# Flow deliverables are written into the SELECTED workspace (the active
|
||||
# project's folder) so they land where the user works with files (Folder
|
||||
# tab), not in the config/install folder. One subfolder per flow keeps
|
||||
|
||||
@@ -1,17 +1 @@
|
||||
"""Workspace file operations for non-agent-loop callers (EPIC R06, R08)."""
|
||||
|
||||
from .ai_edit_output import parse_ai_output, split_code_block
|
||||
from .file_preview_helpers import is_probably_text, pptx_available, read_text
|
||||
from .file_workspace_service import FileWorkspaceService
|
||||
from .graph_index_service import extract_file_contents, pdf_to_markdown
|
||||
|
||||
__all__ = [
|
||||
"FileWorkspaceService",
|
||||
"read_text",
|
||||
"is_probably_text",
|
||||
"pptx_available",
|
||||
"split_code_block",
|
||||
"parse_ai_output",
|
||||
"pdf_to_markdown",
|
||||
"extract_file_contents",
|
||||
]
|
||||
"""Application workspaces package: File workspace and AI file editor services."""
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
"""Parse an AI file-edit reply into its parts (R08-T12, moved out of
|
||||
``ui/folder_tab.py`` — that file's module-level ``_split_code_block``/
|
||||
``_parse_ai_output``, lines 1536-1562 of the original 1587-line file). Pure
|
||||
string parsing, no Qt — used by ``presentation/folder/ai_file_editor_dialog.py``
|
||||
to turn a model's raw reply into a proposed edit.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from typing import List, Optional, Tuple
|
||||
|
||||
|
||||
def split_code_block(text: str) -> Tuple[Optional[str], str]:
|
||||
"""Split an AI reply into ``(file_content, summary)``. ``file_content``
|
||||
is the first fenced code block (the edited file); ``summary`` is any
|
||||
prose before it. Returns ``(None, text)`` when there's no code block."""
|
||||
m = re.search(r"```[^\n]*\n(.*?)```", text or "", re.DOTALL)
|
||||
if not m:
|
||||
return None, (text or "")
|
||||
return m.group(1), (text[:m.start()].strip())
|
||||
|
||||
|
||||
def parse_ai_output(text: str) -> Tuple[Optional[str], Optional[str], str, List[Tuple[str, str]]]:
|
||||
"""Parse an AI edit reply into ``(target, content, summary, image_gens)``.
|
||||
``FILE: <path>`` names a NEW file to create; ``IMAGE_GEN: <prompt> =>
|
||||
<path>`` lines request generated illustration images (relative paths)."""
|
||||
content, summary = split_code_block(text)
|
||||
target = None
|
||||
m = re.search(r"(?mi)^\s*FILE:\s*(.+?)\s*$", text or "")
|
||||
if m:
|
||||
target = m.group(1).strip().strip("`\"'")
|
||||
image_gens = []
|
||||
for gm in re.finditer(r"(?mi)^\s*IMAGE_GEN:\s*(.+?)\s*=>\s*(\S+)\s*$", text or ""):
|
||||
image_gens.append((gm.group(1).strip(), gm.group(2).strip().strip("`\"'")))
|
||||
# Strip the directive lines out of the shown summary.
|
||||
summary = re.sub(r"(?mi)^\s*(FILE|IMAGE_GEN):\s*.+?$", "", summary).strip()
|
||||
return target, content, summary, image_gens
|
||||
|
||||
|
||||
__all__ = ["split_code_block", "parse_ai_output"]
|
||||
@@ -1,67 +0,0 @@
|
||||
"""Pure helpers for previewing a file (R08-T12, moved out of
|
||||
``ui/folder_tab.py`` — that file's module-level functions
|
||||
``_read_text``/``_is_probably_text``/``_pptx_available``, lines 1519-1533 and
|
||||
1565-1587 of the original 1587-line file). No Qt, no widget state — the
|
||||
"is this file text? is pptx editing available?" questions the preview
|
||||
manager asks before it decides how to render something.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
_PPTX_READY = None # cached: pptx-editing library available (after auto-install)
|
||||
|
||||
|
||||
def pptx_available() -> bool:
|
||||
"""True when python-pptx is importable. If it's MISSING, auto-download &
|
||||
install it (via deps.ensure_module) so pptx editing 'just works' — cached
|
||||
so the (one-time) install is attempted only once."""
|
||||
global _PPTX_READY
|
||||
if _PPTX_READY is None:
|
||||
try:
|
||||
from cowork_local.core.deps import ensure_module
|
||||
|
||||
ready = ensure_module("pptx", "python-pptx") is not None
|
||||
except Exception: # noqa: BLE001
|
||||
ready = False
|
||||
from ..network import network_guard
|
||||
|
||||
if ready or not network_guard.is_blocked():
|
||||
_PPTX_READY = ready # a refusal under "Block network" is retried later
|
||||
return ready
|
||||
return _PPTX_READY
|
||||
|
||||
|
||||
def read_text(path: str) -> str:
|
||||
"""Đọc tệp dạng văn bản, thay ký tự hỏng thay vì ném lỗi; không đọc được thì
|
||||
trả về chuỗi rỗng.
|
||||
"""
|
||||
try:
|
||||
return Path(path).read_text(encoding="utf-8", errors="replace")
|
||||
except OSError as exc:
|
||||
return f"[could not read file: {exc}]"
|
||||
|
||||
|
||||
def is_probably_text(path: str) -> bool:
|
||||
"""Đoán tệp này có phải văn bản không, bằng cách tìm byte NUL trong phần đầu.
|
||||
|
||||
Đoán sai theo hướng "là văn bản" sẽ hiện một màn hình ký tự rác, nên phép
|
||||
thử cố tình bảo thủ.
|
||||
"""
|
||||
try:
|
||||
with open(path, "rb") as f:
|
||||
chunk = f.read(4096)
|
||||
except OSError:
|
||||
return False
|
||||
if b"\x00" in chunk:
|
||||
return False
|
||||
try:
|
||||
chunk.decode("utf-8")
|
||||
return True
|
||||
except UnicodeDecodeError:
|
||||
# Latin-ish text still edits fine via errors="replace"; only reject on
|
||||
# a hard binary signal (NUL above), so most source files pass.
|
||||
return True
|
||||
|
||||
|
||||
__all__ = ["pptx_available", "read_text", "is_probably_text"]
|
||||
@@ -1,84 +0,0 @@
|
||||
"""FileWorkspaceService - the safe file operations File Explorer and the AI
|
||||
File Editor need, outside the agent tool loop (R06-T05).
|
||||
|
||||
``ui/folder_tab.py`` (File Explorer) and the AI File Editor dialog need the
|
||||
exact same guarantees the agent's tools already have — path containment
|
||||
inside the workspace, precise context-anchored edits, syntax warnings on a
|
||||
bad Python write — but today that logic only exists wired to a model's tool
|
||||
call (``core/tools.py::execute_tool``). A UI action that isn't a tool call
|
||||
(browsing the tree, applying an AI-suggested diff from a review dialog) has
|
||||
no equivalent entry point of its own.
|
||||
|
||||
This service IS that entry point. It reuses ``core/tools.py::execute_tool``
|
||||
verbatim - same dispatch table, same ``ToolContext`` containment check, same
|
||||
audit-log entry, same Python-syntax warning on write/edit - rather than
|
||||
re-implementing any of it, so a fix to one path fixes both. It only adds the
|
||||
:class:`~domain.workspaces.workspace_session.WorkspaceSession` seam: which
|
||||
workspace root a call is scoped to is decided by the session, not by
|
||||
whichever folder a widget happens to have open.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any, Dict
|
||||
|
||||
|
||||
class FileWorkspaceService:
|
||||
"""File operations scoped to one :class:`WorkspaceSession`.
|
||||
|
||||
Read-only by name (``list_tree``/``read_preview``) vs. writing
|
||||
(``write_file``/``apply_edit``) mirrors the same READ/WRITE split
|
||||
``domain/tools/tool_registry.py`` uses for the agent's own tools - a
|
||||
caller that only wants to browse never accidentally has write access.
|
||||
"""
|
||||
|
||||
def __init__(self, session) -> None: # WorkspaceSession - see module docstring
|
||||
"""Nhận một ``WorkspaceSession`` — mọi đường dẫn về sau đều bị nó chặn trong
|
||||
phạm vi cho phép.
|
||||
"""
|
||||
self._session = session
|
||||
|
||||
def list_tree(self, rel: str = ".") -> Dict[str, Any]:
|
||||
"""Entries at ``rel`` (default: the workspace root)."""
|
||||
return self._execute("list_dir", {"path": rel})
|
||||
|
||||
def read_preview(self, rel: str) -> Dict[str, Any]:
|
||||
"""A text file's content (truncated by
|
||||
``infrastructure/filesystem/file_tools.py::MAX_READ_BYTES``, same as
|
||||
the agent's ``read_file`` tool)."""
|
||||
return self._execute("read_file", {"path": rel})
|
||||
|
||||
def write_file(self, rel: str, content: str) -> Dict[str, Any]:
|
||||
"""Create or fully overwrite ``rel``."""
|
||||
return self._execute("write_file", {"path": rel, "content": content})
|
||||
|
||||
def apply_edit(self, rel: str, old_string: str, new_string: str,
|
||||
replace_all: bool = False) -> Dict[str, Any]:
|
||||
"""Replace an exact snippet in an existing file - the same
|
||||
context-anchored algorithm the agent's ``edit_file`` tool uses, so an
|
||||
AI-suggested diff applies with the same precision and the same
|
||||
"old_string not found / ambiguous" failure messages either path
|
||||
would give the caller."""
|
||||
return self._execute("edit_file", {
|
||||
"path": rel, "old_string": old_string, "new_string": new_string,
|
||||
"replace_all": replace_all,
|
||||
})
|
||||
|
||||
# -- internals --------------------------------------------------------- #
|
||||
def _tool_context(self):
|
||||
"""A ``ToolContext`` scoped to this session's workspace root.
|
||||
``flatten_writes=False`` (unlike Cowork's agent context) - File
|
||||
Explorer must preserve whatever subfolder structure the user is
|
||||
actually browsing, not collapse every write into the root."""
|
||||
from cowork_local.infrastructure.filesystem.tool_context import ToolContext
|
||||
|
||||
return ToolContext(self._session.workspace_root, flatten_writes=False)
|
||||
|
||||
def _execute(self, name: str, args: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Dispatch through ``core/tools.py::execute_tool`` - see the module
|
||||
docstring for why this delegates instead of reimplementing."""
|
||||
from cowork_local.core.tools import execute_tool
|
||||
|
||||
return execute_tool(self._tool_context(), name, args)
|
||||
|
||||
|
||||
__all__ = ["FileWorkspaceService"]
|
||||
@@ -1,91 +0,0 @@
|
||||
"""Temporary file-content extraction for Graph-RAG Q&A (R08-T14, moved out
|
||||
of ``ui/structure_graph_view.py`` — that file's module-level
|
||||
``_pdf_to_markdown``/``_extract_file_contents``, lines 964-1034 of the
|
||||
original 1035-line file). Runs inside the ask worker's job function so the
|
||||
answer is synthesized from real file content, not just the graph structure.
|
||||
|
||||
Pure Python: no Qt. Best-effort throughout (never raises) — a failed
|
||||
extraction degrades to "no content for this file", not a broken Q&A turn.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
|
||||
def pdf_to_markdown(pdf_path: str, out_dir: str) -> Optional[str]:
|
||||
"""Convert a PDF to Markdown with opendataloader-pdf when available
|
||||
(richer structure than a plain text dump). Best-effort — returns None
|
||||
if the package isn't installed or the call fails, so the caller falls
|
||||
back to ``core/doc_extract.py``."""
|
||||
try:
|
||||
import opendataloader_pdf # optional; auto-installed elsewhere if present
|
||||
except Exception: # noqa: BLE001
|
||||
try:
|
||||
from cowork_local.core.deps import ensure_module
|
||||
if ensure_module("opendataloader_pdf", "opendataloader-pdf") is None:
|
||||
return None
|
||||
import opendataloader_pdf # noqa: F811
|
||||
except Exception: # noqa: BLE001
|
||||
return None
|
||||
out = Path(out_dir)
|
||||
out.mkdir(parents=True, exist_ok=True)
|
||||
for call in (
|
||||
lambda: opendataloader_pdf.convert(input_path=[str(pdf_path)], output_dir=str(out),
|
||||
generate_markdown=True),
|
||||
lambda: opendataloader_pdf.convert(input_path=str(pdf_path), output_dir=str(out)),
|
||||
lambda: opendataloader_pdf.convert(str(pdf_path), str(out)),
|
||||
):
|
||||
try:
|
||||
call()
|
||||
break
|
||||
except TypeError:
|
||||
continue
|
||||
except Exception: # noqa: BLE001
|
||||
return None
|
||||
mds = list(out.rglob(Path(pdf_path).stem + "*.md")) or list(out.rglob("*.md"))
|
||||
for md in mds:
|
||||
try:
|
||||
return md.read_text(encoding="utf-8", errors="replace")
|
||||
except OSError:
|
||||
continue
|
||||
return None
|
||||
|
||||
|
||||
def extract_file_contents(paths: List[str], cache: Dict[str, str], tmp_dir: str,
|
||||
max_files: int = 15, max_total: int = 120_000
|
||||
) -> Tuple[str, Dict[str, str]]:
|
||||
"""Read the ACTUAL content of ``paths`` (PDF -> markdown via
|
||||
opendataloader when available, else ``doc_extract`` for office/pdf/
|
||||
text). Returns ``(block, cache)`` — ``block`` is the concatenated
|
||||
content for the prompt (bounded), ``cache`` maps path -> text for
|
||||
reuse. Never raises."""
|
||||
from cowork_local.core import doc_extract
|
||||
|
||||
cache = dict(cache or {})
|
||||
parts, total = [], 0
|
||||
for p in paths[:max_files]:
|
||||
if total >= max_total:
|
||||
break
|
||||
text = cache.get(p)
|
||||
if text is None:
|
||||
try:
|
||||
if Path(p).suffix.lower() == ".pdf":
|
||||
text = pdf_to_markdown(p, tmp_dir)
|
||||
if not text:
|
||||
text, _n = doc_extract.extract_text(p)
|
||||
else:
|
||||
text, _n = doc_extract.extract_text(p)
|
||||
except Exception: # noqa: BLE001
|
||||
text = ""
|
||||
cache[p] = text or ""
|
||||
text = cache.get(p) or ""
|
||||
if not text:
|
||||
continue
|
||||
chunk = text[: max(0, max_total - total)]
|
||||
total += len(chunk)
|
||||
parts.append(f'--- {Path(p).name} ({p}) ---\n{chunk}')
|
||||
return ("\n\n".join(parts), cache)
|
||||
|
||||
|
||||
__all__ = ["pdf_to_markdown", "extract_file_contents"]
|
||||
@@ -17,6 +17,7 @@ import os
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
|
||||
from .infrastructure.config.json_config_repository import JsonConfigRepository
|
||||
from typing import Any, Dict, List
|
||||
|
||||
CONFIG_DIR = Path.home() / ".cowork_local"
|
||||
@@ -100,15 +101,11 @@ DEFAULT_CONFIG: Dict[str, Any] = {
|
||||
"resource_limit_cpu_percent": 80, # 0 = unlimited; caps a run_command/install_package process TREE's total CPU%
|
||||
"resource_limit_memory_mb": 2048, # 0 = unlimited; caps total RSS memory (MB)
|
||||
"resource_limit_disk_mb": 512, # 0 = unlimited; caps total disk read+write (MB)
|
||||
# "Block network": every outbound connection except the AI provider is
|
||||
# refused (application/network/network_guard.py), and agent shell
|
||||
# commands / task scripts run in a network-less AppContainer.
|
||||
# OFF on first launch — the user turns it on in Settings.
|
||||
"block_network": False,
|
||||
"block_network": True, # strip proxy env / point at a black-hole address for agent-run commands
|
||||
# Allow the agent's fetch_url tool to read web pages / online documents /
|
||||
# SharePoint-OneDrive share links. Its own toggle — reading a URL for info
|
||||
# is safe and useful, so this defaults ON — but block_network outranks it:
|
||||
# with the network blocked the tool is refused either way.
|
||||
# SharePoint-OneDrive share links. SEPARATE from block_network (that only
|
||||
# sandboxes agent-run shell commands) — reading a URL for info is safe and
|
||||
# useful, so this defaults ON. Toggle in Settings → Security.
|
||||
"allow_url_fetch": True,
|
||||
"sandbox_pw": "", # set through COWORK_SANDBOX_PASSWORD
|
||||
"rulebase_path": "", # custom RULEBASE.md — attached to every agent execution
|
||||
@@ -278,11 +275,6 @@ def _deep_merge(base: Dict[str, Any], override: Dict[str, Any]) -> Dict[str, Any
|
||||
|
||||
|
||||
def _apply_env_overrides(data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Cho phép biến môi trường ghi đè cấu hình.
|
||||
|
||||
Dùng khi chạy trong container/CI: đặt endpoint và khoá qua biến môi trường mà
|
||||
không phải sửa file cấu hình.
|
||||
"""
|
||||
data = copy.deepcopy(data)
|
||||
oc = data["providers"]["openai_compat"]
|
||||
if os.getenv("OPENAI_API_KEY"):
|
||||
@@ -353,12 +345,6 @@ def _migrate_connectors(data: Dict[str, Any]) -> None:
|
||||
data["mcp_servers"] = [] # migrated — the UI no longer manages this
|
||||
|
||||
|
||||
# Deferred: JsonConfigRepository's own import chain (infrastructure.persistence
|
||||
# .json -> task_repository_impl -> core.tasks) reads CONFIG_DIR back from this
|
||||
# module, so importing it before CONFIG_DIR exists here is a circular import.
|
||||
from .infrastructure.config.json_config_repository import JsonConfigRepository
|
||||
|
||||
|
||||
class AppConfig(JsonConfigRepository):
|
||||
"""Vỏ tương thích — R02 đã thay lớp này bằng :class:`JsonConfigRepository`.
|
||||
|
||||
@@ -375,11 +361,6 @@ class AppConfig(JsonConfigRepository):
|
||||
"""
|
||||
|
||||
def __init__(self, data=None, path: Path = CONFIG_PATH, **kw):
|
||||
"""Mở cấu hình từ đĩa, hoặc dựng thẳng từ dict khi truyền ``data``.
|
||||
|
||||
Dạng ``AppConfig(data=..., path=...)`` là để 13 file test dựng cấu hình mà
|
||||
không chạm đĩa; giữ nguyên vì bỏ đi là phải sửa cả 13 file.
|
||||
"""
|
||||
if data is None:
|
||||
super().__init__(Path(path), **kw)
|
||||
return
|
||||
@@ -394,4 +375,3 @@ class AppConfig(JsonConfigRepository):
|
||||
chung một đường dựng — kể cả phần ráp kho bí mật."""
|
||||
from .presentation.shell.bootstrap import build_config
|
||||
return build_config(Path(path))
|
||||
|
||||
|
||||
@@ -35,7 +35,6 @@ _LAST_LOGIN_PATH = CONFIG_DIR / "last_login.json"
|
||||
|
||||
|
||||
def save_last_login(username: str, role: str) -> None:
|
||||
"""Nhớ tài khoản đăng nhập gần nhất để lần mở sau điền sẵn."""
|
||||
try:
|
||||
_LAST_LOGIN_PATH.parent.mkdir(parents=True, exist_ok=True)
|
||||
_LAST_LOGIN_PATH.write_text(
|
||||
@@ -45,7 +44,6 @@ def save_last_login(username: str, role: str) -> None:
|
||||
|
||||
|
||||
def load_last_login() -> Optional[Tuple[str, str]]:
|
||||
"""Cặp (tên đăng nhập, vai trò) của lần đăng nhập gần nhất; ``None`` nếu chưa có."""
|
||||
try:
|
||||
data = json.loads(_LAST_LOGIN_PATH.read_text(encoding="utf-8"))
|
||||
username, role = data.get("username", ""), data.get("role", "")
|
||||
@@ -63,7 +61,6 @@ CODE_LENGTH = 12
|
||||
|
||||
@dataclass
|
||||
class Account:
|
||||
"""Một tài khoản người dùng: tên đăng nhập, vai trò, tên hiển thị và nhóm."""
|
||||
username: str
|
||||
role: str
|
||||
display_name: str = ""
|
||||
@@ -76,7 +73,6 @@ class Account:
|
||||
|
||||
|
||||
def accounts_dir(shared_dir: str) -> Path:
|
||||
"""Thư mục chứa tài khoản, nằm trong thư mục chia sẻ của đội."""
|
||||
return Path(shared_dir).expanduser() / "accounts"
|
||||
|
||||
|
||||
@@ -97,7 +93,6 @@ def generate_code(existing_codes: Optional[Set[str]] = None) -> str:
|
||||
|
||||
|
||||
def save_account(account: Account, directory: Path) -> Path:
|
||||
"""Ghi một tài khoản ra ``<username>.json`` (tên file đã được làm sạch)."""
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
path = directory / f"{_safe_username(account.username)}.json"
|
||||
path.write_text(json.dumps(asdict(account), ensure_ascii=False, indent=2), encoding="utf-8")
|
||||
@@ -105,7 +100,6 @@ def save_account(account: Account, directory: Path) -> Path:
|
||||
|
||||
|
||||
def load_account(username: str, directory: Path) -> Optional[Account]:
|
||||
"""Đọc một tài khoản theo tên đăng nhập; không có thì trả ``None``."""
|
||||
path = directory / f"{_safe_username(username)}.json"
|
||||
if not path.exists():
|
||||
return None
|
||||
@@ -118,7 +112,6 @@ def load_account(username: str, directory: Path) -> Optional[Account]:
|
||||
|
||||
|
||||
def list_accounts(directory: Path) -> List[Account]:
|
||||
"""Liệt kê mọi tài khoản trong thư mục; thư mục chưa có thì trả list rỗng."""
|
||||
if not directory.exists():
|
||||
return []
|
||||
out: List[Account] = []
|
||||
@@ -131,7 +124,6 @@ def list_accounts(directory: Path) -> List[Account]:
|
||||
|
||||
|
||||
def delete_account(username: str, directory: Path) -> bool:
|
||||
"""Xoá file tài khoản; trả về ``True`` nếu có file để xoá."""
|
||||
path = directory / f"{_safe_username(username)}.json"
|
||||
try:
|
||||
path.unlink()
|
||||
@@ -141,7 +133,6 @@ def delete_account(username: str, directory: Path) -> bool:
|
||||
|
||||
|
||||
def find_by_username(username: str, directory: Path) -> Optional[Account]:
|
||||
"""Bí danh của :func:`load_account`, giữ cho mã cũ gọi theo tên này vẫn chạy."""
|
||||
return load_account(username, directory)
|
||||
|
||||
|
||||
|
||||
+4
-19
@@ -58,12 +58,10 @@ _KIND_PROMPTS = {
|
||||
"allow. Reply strictly with the requested JSON verdict; err on the side of "
|
||||
"blocking anything that could exfiltrate data or damage the system."),
|
||||
"help": ("You are the in-app HELP assistant for this desktop application. Your ONLY job "
|
||||
"is to help the user understand and use THIS app: which screen they are on, what "
|
||||
"they can do there, and how to get things done. Be concise, friendly and practical.\n"
|
||||
"A handbook of this app's REAL screens and buttons is appended below, together with "
|
||||
"the screen the user currently has open. Answer from those two, never from how other "
|
||||
"software you know is laid out. If the handbook does not cover something, say so "
|
||||
"instead of guessing a menu path.\n"
|
||||
"is to help the user understand and use THIS app — its screens and features "
|
||||
"(Dashboard, Schedule, Workspace with Cowork chat and the Co4E flow studio, "
|
||||
"Monitoring, Connectors, Settings), how to get things done in it, and how to "
|
||||
"troubleshoot using it. Be concise, friendly and practical.\n"
|
||||
"STRICT RULES:\n"
|
||||
"- Answer ONLY questions about using this app. If asked to do anything else "
|
||||
"(write code for other purposes, do general research, chit-chat, run tasks, "
|
||||
@@ -76,7 +74,6 @@ _KIND_PROMPTS = {
|
||||
|
||||
@dataclass
|
||||
class AdminAgent:
|
||||
"""Một agent chuyên trách do quản trị cấu hình: prompt riêng, provider và model riêng."""
|
||||
agent_id: str
|
||||
name: str
|
||||
task_kind: str = "cowork"
|
||||
@@ -88,9 +85,6 @@ class AdminAgent:
|
||||
updated_by: str = ""
|
||||
|
||||
def effective_prompt(self) -> str:
|
||||
"""Prompt hệ thống thật sự dùng: prompt mặc định theo loại việc, rồi tới phần
|
||||
quản trị viết thêm.
|
||||
"""
|
||||
parts = [_KIND_PROMPTS.get(self.task_kind, ""), (self.prompt or "").strip()]
|
||||
return "\n\n".join(p for p in parts if p)
|
||||
|
||||
@@ -104,17 +98,12 @@ def agents_admin_dir(shared_dir: str = "") -> Path:
|
||||
|
||||
|
||||
def _slug(name: str) -> str:
|
||||
"""Định danh an toàn cho tên file, suy từ tên agent."""
|
||||
s = re.sub(r"[^\w\-]+", "-", (name or "").strip().lower()).strip("-")
|
||||
return s or "agent"
|
||||
|
||||
|
||||
def new_agent(name: str, task_kind: str = "cowork", prompt: str = "",
|
||||
provider: str = "", model: str = "", updated_by: str = "") -> AdminAgent:
|
||||
"""Tạo một agent quản trị mới; loại việc lạ thì rơi về 'cowork'.
|
||||
|
||||
Id ghép slug với 6 ký tự ngẫu nhiên để hai agent trùng tên không đè file nhau.
|
||||
"""
|
||||
return AdminAgent(
|
||||
agent_id=f"{_slug(name)}-{uuid.uuid4().hex[:6]}",
|
||||
name=name.strip(), task_kind=task_kind if task_kind in TASK_KINDS else "cowork",
|
||||
@@ -124,7 +113,6 @@ def new_agent(name: str, task_kind: str = "cowork", prompt: str = "",
|
||||
|
||||
|
||||
def save_agent(agent: AdminAgent, directory: Path) -> Path:
|
||||
"""Ghi một agent ra ``<agent_id>.json``."""
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
path = directory / f"{agent.agent_id}.json"
|
||||
path.write_text(json.dumps(asdict(agent), ensure_ascii=False, indent=2), encoding="utf-8")
|
||||
@@ -132,7 +120,6 @@ def save_agent(agent: AdminAgent, directory: Path) -> Path:
|
||||
|
||||
|
||||
def load_agent(agent_id: str, directory: Path) -> Optional[AdminAgent]:
|
||||
"""Đọc một agent theo id; không có thì trả ``None``."""
|
||||
path = directory / f"{agent_id}.json"
|
||||
if not path.exists():
|
||||
return None
|
||||
@@ -145,7 +132,6 @@ def load_agent(agent_id: str, directory: Path) -> Optional[AdminAgent]:
|
||||
|
||||
|
||||
def list_agents(directory: Path, enabled_only: bool = False) -> List[AdminAgent]:
|
||||
"""Liệt kê agent trong thư mục; ``enabled_only`` chỉ lấy agent đang bật."""
|
||||
if not directory.exists():
|
||||
return []
|
||||
out: List[AdminAgent] = []
|
||||
@@ -179,7 +165,6 @@ def ensure_help_agent(directory: Path) -> AdminAgent:
|
||||
|
||||
|
||||
def delete_agent(agent_id: str, directory: Path) -> bool:
|
||||
"""Xoá file agent; trả về ``True`` nếu có file để xoá."""
|
||||
try:
|
||||
(directory / f"{agent_id}.json").unlink()
|
||||
return True
|
||||
|
||||
@@ -31,7 +31,6 @@ _CMD = re.compile(r"(?<!\S)/agent(?::([\w\-.]+))?(?=$|[\s.,;:!?)\]}»”’'\"
|
||||
|
||||
|
||||
def _slug(name: str) -> str:
|
||||
"""Định danh an toàn suy từ tên agent (dùng chung hàm với Co4E)."""
|
||||
from .co4e import slugify
|
||||
return slugify(name)
|
||||
|
||||
@@ -46,11 +45,6 @@ def collect_agents(shared_dir: str = "") -> List[dict]:
|
||||
seen: set[str] = set()
|
||||
|
||||
def _add(slug: str, name: str, desc: str, persona: str, source: str) -> None:
|
||||
"""Thêm một agent vào danh sách gộp; bỏ qua nếu trùng slug hoặc thiếu persona.
|
||||
|
||||
Agent không có persona thì không dùng được — thêm vào chỉ làm bảng gợi ý dài
|
||||
ra mà chọn vào lại không chạy.
|
||||
"""
|
||||
if not slug or slug in seen or not persona.strip():
|
||||
return
|
||||
seen.add(slug)
|
||||
@@ -75,7 +69,6 @@ def collect_agents(shared_dir: str = "") -> List[dict]:
|
||||
|
||||
|
||||
def _persona_block(agent: dict) -> str:
|
||||
"""Khối prompt mô tả một agent, chèn vào đầu lượt chat khi người dùng gõ ``/agent:``."""
|
||||
return f"## Agent: {agent['name']}\n{agent['persona']}"
|
||||
|
||||
|
||||
|
||||
@@ -37,7 +37,6 @@ HELP = "help"
|
||||
|
||||
|
||||
class AgentRole(NamedTuple):
|
||||
"""Một vai trò agent: khoá, nhãn hiển thị và prompt mặc định."""
|
||||
key: str
|
||||
label: str
|
||||
description: str
|
||||
@@ -62,6 +61,5 @@ ROLES: Dict[str, AgentRole] = {
|
||||
|
||||
|
||||
def label_for(role_key: str) -> str:
|
||||
"""Nhãn của một vai trò; khoá lạ thì trả về chính khoá, rỗng thì trả về "—"."""
|
||||
role = ROLES.get(role_key)
|
||||
return role.label if role else (role_key or "—")
|
||||
|
||||
@@ -149,10 +149,6 @@ def _ai_verdict(provider: Provider, system_prompt: str, content: str, layer: str
|
||||
|
||||
|
||||
def validate_prompt(provider: Provider, user_text: str, rules_text: str) -> SecurityVerdict:
|
||||
"""Nhờ model xét prompt người dùng theo bộ luật an toàn.
|
||||
|
||||
Prompt rỗng thì cho qua ngay, khỏi tốn một lượt gọi.
|
||||
"""
|
||||
if not (user_text or "").strip():
|
||||
return SecurityVerdict(True, "", "prompt")
|
||||
system = _PROMPT_SYSTEM.format(rules=rules_text or "(no additional rules configured)")
|
||||
@@ -161,7 +157,6 @@ def validate_prompt(provider: Provider, user_text: str, rules_text: str) -> Secu
|
||||
|
||||
def validate_attachment(provider: Provider, filename: str, content: str,
|
||||
rules_text: str) -> SecurityVerdict:
|
||||
"""Nhờ model xét nội dung một tệp đính kèm theo bộ luật an toàn."""
|
||||
if not (content or "").strip():
|
||||
return SecurityVerdict(True, "", "attachment")
|
||||
system = _ATTACHMENT_SYSTEM.format(rules=rules_text or "(no additional rules configured)")
|
||||
@@ -170,11 +165,6 @@ def validate_attachment(provider: Provider, filename: str, content: str,
|
||||
|
||||
def validate_command(provider: Provider, command: str,
|
||||
rules_text: str, ai_enabled: bool) -> SecurityVerdict:
|
||||
"""Nhờ model xét một lệnh shell theo bộ luật an toàn.
|
||||
|
||||
``ai_enabled=False`` thì cho qua — người dùng đã tắt lớp xét bằng AI, bộ luật
|
||||
tĩnh vẫn chạy ở chỗ khác.
|
||||
"""
|
||||
if not ai_enabled:
|
||||
return SecurityVerdict(True, "", "command")
|
||||
system = _COMMAND_SYSTEM.format(rules=rules_text or "(no additional rules configured)")
|
||||
@@ -183,7 +173,6 @@ def validate_command(provider: Provider, command: str,
|
||||
|
||||
# ---- call-site convenience wrappers (used by chat_agent.py / code_agent.py) --
|
||||
def _security_conf(config) -> dict:
|
||||
"""Nhóm cấu hình ``agent_security``; không có config thì trả dict rỗng."""
|
||||
return (config.data.get("agent_security", {}) if config is not None else {})
|
||||
|
||||
|
||||
|
||||
@@ -19,7 +19,6 @@ from dataclasses import dataclass
|
||||
|
||||
@dataclass
|
||||
class SecurityVerdict:
|
||||
"""Kết quả một lớp kiểm an toàn: cho qua hay không, lý do, và lớp nào ra phán quyết."""
|
||||
allowed: bool
|
||||
reason: str = ""
|
||||
layer: str = "" # "prompt" | "attachment" | "command"
|
||||
@@ -30,6 +29,5 @@ class SecurityBlocked(RuntimeError):
|
||||
the admin alert; ``str(exc)`` is the short, user-facing reason."""
|
||||
|
||||
def __init__(self, verdict: SecurityVerdict):
|
||||
"""Lấy lý do trong phán quyết làm thông điệp; không có lý do thì ghi rõ lớp nào chặn."""
|
||||
super().__init__(verdict.reason or f"Blocked by agent security ({verdict.layer}).")
|
||||
self.verdict = verdict
|
||||
|
||||
@@ -54,10 +54,6 @@ def _extract_json(text: str) -> Optional[dict]:
|
||||
|
||||
|
||||
def _clamp(value, allowed, default):
|
||||
"""Ép một giá trị về tập hợp lệ; ngoài tập thì lấy mặc định.
|
||||
|
||||
Cần vì model hay trả về giá trị gần đúng ('High' thay vì 'high').
|
||||
"""
|
||||
return value if value in allowed else default
|
||||
|
||||
|
||||
|
||||
@@ -48,7 +48,6 @@ class AppContainerSandbox:
|
||||
display_name: str = "CoworkLocal Sandbox",
|
||||
description: str = "Isolated execution environment for Cowork Local agent",
|
||||
):
|
||||
"""Đặt tên và mô tả cho hồ sơ AppContainer; chưa tạo gì trên máy."""
|
||||
self.profile_name = profile_name
|
||||
self.display_name = display_name
|
||||
self.description = description
|
||||
|
||||
+2
-47
@@ -20,7 +20,6 @@ from __future__ import annotations
|
||||
from datetime import date
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional
|
||||
from uuid import uuid4
|
||||
|
||||
from ..config import CONFIG_DIR
|
||||
from ..infrastructure.telemetry.audit_logger import CanonicalAuditLogger
|
||||
@@ -43,56 +42,12 @@ def set_identity(account: str, machine: str, role: str = "", shared_dir: str = "
|
||||
|
||||
|
||||
def record(kind: Kind, name: str, ok: bool, detail: str = "",
|
||||
agent_role: str = "", correlation_id: str = "") -> None:
|
||||
agent_role: str = "") -> None:
|
||||
"""Append one audit event. Never raises — audit logging must never break
|
||||
a chat turn, a permission decision, or a tool call."""
|
||||
try:
|
||||
now = datetime.now()
|
||||
if kind == "mcp_call":
|
||||
safe_code = detail.removeprefix("code=")
|
||||
detail = (
|
||||
detail
|
||||
if detail in {"completed", "failed"}
|
||||
or (detail.startswith("code=") and safe_code.replace("_", "").isalnum())
|
||||
else ("completed" if ok else "failed")
|
||||
)
|
||||
correlation_id = correlation_id or str(uuid4())
|
||||
event = {
|
||||
"ts": now.isoformat(timespec="seconds"),
|
||||
"kind": kind,
|
||||
"agent_role": agent_role or "",
|
||||
"name": name or "",
|
||||
"ok": bool(ok),
|
||||
"detail": (detail or "")[:2000], # bounded — never let a huge blob bloat the log
|
||||
"correlation_id": correlation_id or "",
|
||||
"account": _identity_account,
|
||||
"role": _identity_role,
|
||||
"machine": _identity_machine,
|
||||
}
|
||||
AUDIT_DIR.mkdir(parents=True, exist_ok=True)
|
||||
path = AUDIT_DIR / f"{now.strftime('%Y-%m-%d')}.jsonl"
|
||||
with path.open("a", encoding="utf-8") as f:
|
||||
f.write(json.dumps(event, ensure_ascii=False) + "\n")
|
||||
_write_shared(event, now)
|
||||
except Exception: # noqa: BLE001
|
||||
pass
|
||||
_logger.record(kind, name, ok, detail=detail, agent_role=agent_role)
|
||||
|
||||
|
||||
def _write_shared(event: Dict[str, Any], now: datetime) -> None:
|
||||
"""Best-effort mirror of ``event`` into the shared cross-machine store —
|
||||
one file PER MACHINE per day, so no two machines ever write the same
|
||||
file. Never raises."""
|
||||
if not _identity_shared_dir or not _identity_machine:
|
||||
return
|
||||
try:
|
||||
shared = Path(_identity_shared_dir).expanduser() / "telemetry" / "audit"
|
||||
shared.mkdir(parents=True, exist_ok=True)
|
||||
path = shared / f"{_identity_machine}-{now.strftime('%Y-%m-%d')}.jsonl"
|
||||
with path.open("a", encoding="utf-8") as f:
|
||||
f.write(json.dumps(event, ensure_ascii=False) + "\n")
|
||||
except Exception: # noqa: BLE001
|
||||
pass
|
||||
|
||||
def load_events(start: Optional[date] = None, end: Optional[date] = None,
|
||||
kind: Optional[Kind] = None,
|
||||
directory: Path = None) -> List[Dict[str, Any]]:
|
||||
|
||||
+15
-76
@@ -11,34 +11,22 @@ import re
|
||||
from pathlib import Path
|
||||
from typing import Any, Callable, Dict, List, Optional
|
||||
|
||||
from ..application.conversations.tool_policy_gateway import ToolPolicyGateway
|
||||
from ..domain.tools import ToolCapability, default_registry
|
||||
from ..providers.base import Provider, ToolSpec
|
||||
from . import agent_roles, agent_security
|
||||
from . import agent_roles
|
||||
from . import agent_security
|
||||
from .code_agent import (
|
||||
_apply_project_context,
|
||||
_apply_security_rules,
|
||||
_apply_skills,
|
||||
_call_provider_with_recovery,
|
||||
_apply_project_context, _apply_security_rules, _apply_skills, _call_provider_with_recovery,
|
||||
)
|
||||
from .deps import _can_pip
|
||||
from .java_runtime import find_java
|
||||
from .mcp_client import UNTRUSTED_MCP_CONTENT_RULE
|
||||
from .plan import UPDATE_PLAN_SPEC, normalize_plan_steps
|
||||
from .security_rules import load_rules
|
||||
from .plan import UPDATE_PLAN_SPEC, normalize_plan_steps
|
||||
from .skills import active_skills_text
|
||||
from .tools import TOOL_SPECS, ToolContext, _snapshot, describe_action, execute_tool
|
||||
|
||||
# Generator / helper scripts — never a final deliverable in Cowork's output.
|
||||
_SCRIPT_EXTS = {".py", ".pyw", ".js", ".mjs", ".cjs", ".ts", ".sh", ".bat", ".ps1", ".rb", ".pl"}
|
||||
|
||||
# R05-T03/T04: replaces the literal ``name in ("run_command",
|
||||
# "install_package")`` check below with a capability lookup — EXECUTE is
|
||||
# exactly the capability those two (and only those two) built-in tools carry
|
||||
# (see domain/tools/tool_registry.py::BUILT_IN_CAPABILITIES). Copied per-turn
|
||||
# into ``turn_tool_policy`` inside run_cowork() once extra_tools are known.
|
||||
_COWORK_TOOL_REGISTRY = default_registry(TOOL_SPECS)
|
||||
|
||||
EmitFn = Callable[[Dict[str, Any]], None]
|
||||
CancelFn = Callable[[], bool]
|
||||
|
||||
@@ -52,8 +40,7 @@ COWORK_SYSTEM_PROMPT = (
|
||||
"'[Workspace files]'. These are existing files in the output folder — treat them as "
|
||||
"input data. ALWAYS read and use them to answer the request. Reference specific data, "
|
||||
"tables, or sections from these files in your response.\n"
|
||||
"If any file content cannot be read, tell the user which file failed.\n"
|
||||
+ UNTRUSTED_MCP_CONTENT_RULE
|
||||
"If any file content cannot be read, tell the user which file failed."
|
||||
)
|
||||
|
||||
COWORK_TOOL_PROMPT = (
|
||||
@@ -139,12 +126,6 @@ _UNSAFE = re.compile(r'[\\/:*?"<>|\x00-\x1f]+')
|
||||
|
||||
|
||||
def _safe_filename(name: str) -> str:
|
||||
"""Làm sạch tên tệp do model đề xuất: bỏ đường dẫn, thay ký tự cấm, không bao
|
||||
giờ trả về chuỗi rỗng.
|
||||
|
||||
Model hay trả về tên có dấu ``/`` hoặc ``..`` — ghi thẳng là thoát khỏi thư
|
||||
mục làm việc.
|
||||
"""
|
||||
base = Path(str(name)).name.strip()
|
||||
base = _UNSAFE.sub("_", base).strip(" _.") or "output.txt"
|
||||
if "." not in base:
|
||||
@@ -317,23 +298,17 @@ def run_chat(
|
||||
emit: EmitFn,
|
||||
cancel: Optional[CancelFn] = None,
|
||||
) -> Dict[str, Any]:
|
||||
"""Chạy một lượt chat thuần (không có tool) và phát nội dung dần ra ngoài.
|
||||
|
||||
Tự chèn prompt hệ thống nếu tin nhắn đầu chưa phải ``system``.
|
||||
"""
|
||||
if not messages or messages[0].get("role") != "system":
|
||||
messages.insert(0, {"role": "system", "content": COWORK_SYSTEM_PROMPT})
|
||||
# Rulebase: always attach security rules so the agent follows them every turn
|
||||
_apply_security_rules(messages, load_rules())
|
||||
|
||||
def on_text(piece: str) -> None:
|
||||
"""Đẩy từng mẩu câu trả lời ra ngoài."""
|
||||
emit({"type": "text", "delta": piece})
|
||||
|
||||
def on_reasoning(piece: str) -> None:
|
||||
# Stream the model's reasoning so the UI can show a live, collapsible
|
||||
# "Thinking" box (and keep the indicator active).
|
||||
"""Đẩy từng mẩu suy luận nội bộ ra ngoài, để giao diện hiện hộp "Đang nghĩ"."""
|
||||
emit({"type": "reasoning", "delta": piece})
|
||||
|
||||
assistant = provider.chat(messages, tools=None, on_text=on_text, cancel=cancel,
|
||||
@@ -413,19 +388,6 @@ def run_cowork(
|
||||
jira=(security_config.data.get("jira") if security_config else None))
|
||||
extra_tools = extra_tools or []
|
||||
extra_names = {t.name for t in extra_tools}
|
||||
# R05-T04: MCP servers (core/mcp_client.py) and unified connectors
|
||||
# (core/ext_connectors.py) — everything that arrives here as extra_tools —
|
||||
# advertise no standard risk metadata, so each is tagged with the same
|
||||
# conservative default (WRITE|EXECUTE|NETWORK) domain/tools/tool_registry.py
|
||||
# uses for any unclassified tool. Copying the built-in registry per turn
|
||||
# (cheap - under 20 entries) rather than mutating the shared module-level
|
||||
# one keeps different turns' extra_tools from leaking into each other.
|
||||
from ..domain.tools import ToolDescriptor, ToolRegistry
|
||||
from ..domain.tools.tool_registry import UNKNOWN_SOURCE_CAPABILITIES
|
||||
_turn_registry = ToolRegistry(_COWORK_TOOL_REGISTRY.all())
|
||||
for _spec in extra_tools:
|
||||
_turn_registry.register(ToolDescriptor.from_spec(_spec, UNKNOWN_SOURCE_CAPABILITIES))
|
||||
turn_tool_policy = ToolPolicyGateway(_turn_registry, ToolCapability.EXECUTE)
|
||||
# update_plan drives the Plan panel (above Output); it produces no file.
|
||||
# Built-in tools the admin disabled (Monitoring → Tools) are filtered out.
|
||||
from .tools import enabled_tool_specs
|
||||
@@ -527,27 +489,6 @@ def run_cowork(
|
||||
preview = {"kind": "info", "title": name, "text": str(args)}
|
||||
emit({"type": "tool_proposed", "id": tc_id, "name": name, "args": args,
|
||||
"preview": preview})
|
||||
if ctx.block_network and not name.startswith("ms365_local__"):
|
||||
result = {"ok": False, "output": (
|
||||
f"{name}: network access is blocked by the Sandbox Security Layer "
|
||||
'("Block network for agent-run commands" is on in Settings).')}
|
||||
emit({"type": "tool_result", "id": tc_id, "name": name,
|
||||
"ok": False, "output": result["output"]})
|
||||
messages.append({"role": "tool", "tool_call_id": tc_id, "name": name,
|
||||
"content": result["output"]})
|
||||
continue
|
||||
# R05-T04: MCP/connector tools used to run with NO permission
|
||||
# check at all — this is what closes that gap. Same policy,
|
||||
# same gate object as the built-in tools below.
|
||||
if not turn_tool_policy.allow(
|
||||
name, gate, {"name": name, "args": args, "preview": preview}
|
||||
):
|
||||
result = {"ok": False, "output": "Rejected by user."}
|
||||
emit({"type": "tool_result", "id": tc_id, "name": name,
|
||||
"ok": False, "output": result["output"]})
|
||||
messages.append({"role": "tool", "tool_call_id": tc_id, "name": name,
|
||||
"content": result["output"]})
|
||||
continue
|
||||
result = extra_executor(name, args)
|
||||
emit({"type": "tool_result", "id": tc_id, "name": name,
|
||||
"ok": result.get("ok", False), "output": result.get("output", "")})
|
||||
@@ -587,18 +528,16 @@ def run_cowork(
|
||||
# Permission Management (Sandbox Security Layer) — only when a
|
||||
# gate was actually supplied (Settings: "confirm before running
|
||||
# commands"); None preserves the pre-existing auto-run behavior.
|
||||
# R05-T03: gating is now capability-driven (see
|
||||
# turn_tool_policy above) instead of a literal name tuple.
|
||||
if not turn_tool_policy.allow(
|
||||
name, gate, {"name": name, "args": args, "preview": preview}
|
||||
):
|
||||
result = {"ok": False, "output": "Rejected by user."}
|
||||
evt = {"type": "tool_result", "id": tc_id, "name": name,
|
||||
"ok": False, "output": result["output"]}
|
||||
emit(evt)
|
||||
messages.append({"role": "tool", "tool_call_id": tc_id,
|
||||
"name": name, "content": result["output"]})
|
||||
continue
|
||||
if gate is not None and name in ("run_command", "install_package"):
|
||||
approved = gate.request({"name": name, "args": args, "preview": preview})
|
||||
if not approved:
|
||||
result = {"ok": False, "output": "Rejected by user."}
|
||||
evt = {"type": "tool_result", "id": tc_id, "name": name,
|
||||
"ok": False, "output": result["output"]}
|
||||
emit(evt)
|
||||
messages.append({"role": "tool", "tool_call_id": tc_id,
|
||||
"name": name, "content": result["output"]})
|
||||
continue
|
||||
|
||||
if name == "save_file":
|
||||
result = _do_save_file(output_dir, title, args)
|
||||
|
||||
@@ -1,114 +0,0 @@
|
||||
"""Mirror a OneDrive/SharePoint folder to/from a local directory (DF-007).
|
||||
|
||||
This is deliberately NOT a general sync engine: every existing tool
|
||||
(``run_command``, ``read_file``, ``write_file``...) operates on a real local
|
||||
``Path`` (``Project.output_dir`` — see ``core/projects.py::Project.workspace_dir``),
|
||||
and that contract does not change here. A cloud-backed project's
|
||||
``output_dir`` still points at a real local folder; this module only knows how
|
||||
to pull that folder's content down from Graph once, and push it back up once,
|
||||
both on explicit user action (a button click) — there is no background
|
||||
watcher, no continuous sync, no delete propagation, and no conflict
|
||||
resolution beyond "whichever side ran last wins" for a given file. See the
|
||||
DF-007 plan for why: OneDrive/SharePoint sync-client detection is unreliable,
|
||||
so a local mirror + manual sync is the only predictable option that does not
|
||||
touch the sandboxed command/file tools.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Dict, List
|
||||
|
||||
from . import ms365_graph as graph
|
||||
|
||||
|
||||
@dataclass
|
||||
class SyncReport:
|
||||
"""Kết quả một lượt tải xuống/đẩy lên — hiển thị cho người dùng sau khi chạy."""
|
||||
transferred: int = 0
|
||||
skipped_too_large: List[str] = field(default_factory=list)
|
||||
errors: List[str] = field(default_factory=list)
|
||||
|
||||
|
||||
def _list_children(token: str, cloud_source: Dict[str, str], remote_path: str) -> List[dict]:
|
||||
provider = cloud_source.get("provider")
|
||||
if provider == "sharepoint":
|
||||
return graph.list_sharepoint_files(token, cloud_source["site_id"], remote_path)
|
||||
return graph.list_onedrive_files(token, remote_path)
|
||||
|
||||
|
||||
def _download_file(token: str, cloud_source: Dict[str, str], remote_path: str) -> bytes:
|
||||
if cloud_source.get("provider") == "sharepoint":
|
||||
return graph.download_sharepoint_file_bytes(token, cloud_source["site_id"], remote_path)
|
||||
return graph.download_onedrive_file_bytes(token, remote_path)
|
||||
|
||||
|
||||
def _upload_file(token: str, cloud_source: Dict[str, str], remote_path: str, data: bytes) -> None:
|
||||
if cloud_source.get("provider") == "sharepoint":
|
||||
graph.upload_sharepoint_file_bytes(token, cloud_source["site_id"], remote_path, data)
|
||||
else:
|
||||
graph.upload_onedrive_file_bytes(token, remote_path, data)
|
||||
|
||||
|
||||
def download_folder(token: str, cloud_source: Dict[str, str], local_dir: Path) -> SyncReport:
|
||||
"""Tải toàn bộ cây thư mục ``cloud_source['remote_path']`` xuống ``local_dir``,
|
||||
giữ nguyên cấu trúc thư mục con. Ghi đè file local nếu đã tồn tại (một
|
||||
chiều: cloud thắng). Không xoá file local nào không còn ở phía cloud."""
|
||||
report = SyncReport()
|
||||
root_remote = cloud_source.get("remote_path", "")
|
||||
local_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
def _walk(remote_path: str, local_sub: Path) -> None:
|
||||
try:
|
||||
children = _list_children(token, cloud_source, remote_path)
|
||||
except graph.Ms365GraphError as exc:
|
||||
report.errors.append(f"{remote_path or '/'}: {exc}")
|
||||
return
|
||||
for item in children:
|
||||
name = item.get("name", "")
|
||||
if not name:
|
||||
continue
|
||||
child_remote = f"{remote_path}/{name}" if remote_path else name
|
||||
child_local = local_sub / name
|
||||
if "folder" in item:
|
||||
child_local.mkdir(parents=True, exist_ok=True)
|
||||
_walk(child_remote, child_local)
|
||||
else:
|
||||
try:
|
||||
data = _download_file(token, cloud_source, child_remote)
|
||||
child_local.write_bytes(data)
|
||||
report.transferred += 1
|
||||
except graph.Ms365GraphError as exc:
|
||||
report.errors.append(f"{child_remote}: {exc}")
|
||||
|
||||
_walk(root_remote, local_dir)
|
||||
return report
|
||||
|
||||
|
||||
def upload_folder(token: str, cloud_source: Dict[str, str], local_dir: Path) -> SyncReport:
|
||||
"""Đẩy mọi file dưới ``local_dir`` lên đúng đường dẫn tương ứng phía cloud
|
||||
(tạo mới hoặc ghi đè). Một chiều: local thắng cho từng file được duyệt qua.
|
||||
Không xoá file cloud nào đã bị xoá ở local, không phát hiện xung đột."""
|
||||
report = SyncReport()
|
||||
root_remote = cloud_source.get("remote_path", "")
|
||||
local_dir = Path(local_dir)
|
||||
for dirpath, _dirnames, filenames in os.walk(local_dir):
|
||||
rel_dir = Path(dirpath).relative_to(local_dir)
|
||||
for fname in filenames:
|
||||
local_file = Path(dirpath) / fname
|
||||
rel_parts = [] if str(rel_dir) == "." else list(rel_dir.parts)
|
||||
rel_parts.append(fname)
|
||||
child_remote = "/".join(([root_remote] if root_remote else []) + rel_parts)
|
||||
try:
|
||||
data = local_file.read_bytes()
|
||||
_upload_file(token, cloud_source, child_remote, data)
|
||||
report.transferred += 1
|
||||
except graph.Ms365GraphError as exc:
|
||||
if "too large" in str(exc):
|
||||
report.skipped_too_large.append(child_remote)
|
||||
else:
|
||||
report.errors.append(f"{child_remote}: {exc}")
|
||||
except OSError as exc:
|
||||
report.errors.append(f"{child_remote}: {exc}")
|
||||
return report
|
||||
@@ -54,9 +54,6 @@ RUN_MODES = ("auto", "plan", "manual")
|
||||
|
||||
|
||||
def slugify(value: str) -> str:
|
||||
"""Chuyển một chuỗi thành slug an toàn cho tên file: chỉ chữ/số/gạch, gộp gạch
|
||||
liên tiếp. Rỗng thì trả về 'step' để không bao giờ sinh ra tên file trống.
|
||||
"""
|
||||
s = "".join(c if (c.isalnum() or c in "-_") else "-" for c in (value or "").strip().lower())
|
||||
return "-".join(filter(None, s.split("-"))) or "step"
|
||||
|
||||
@@ -91,13 +88,11 @@ class Step:
|
||||
|
||||
@property
|
||||
def is_parallel(self) -> bool:
|
||||
"""Bước này có chạy nhiều sub-agent song song hay không."""
|
||||
return self.variant == "parallel"
|
||||
|
||||
|
||||
@dataclass
|
||||
class Node:
|
||||
"""Một node trên khung vẽ: id, toạ độ, và bước (:class:`Step`) mà nó đại diện."""
|
||||
id: str
|
||||
x: float = 0.0
|
||||
y: float = 0.0
|
||||
@@ -106,7 +101,6 @@ class Node:
|
||||
|
||||
@dataclass
|
||||
class Edge:
|
||||
"""Một cạnh nối hai node, quy định thứ tự chạy giữa chúng."""
|
||||
id: str
|
||||
source: str
|
||||
target: str
|
||||
@@ -114,7 +108,6 @@ class Edge:
|
||||
|
||||
@dataclass
|
||||
class Workflow:
|
||||
"""Một luồng Co4E: danh sách node, cạnh, và cờ đánh dấu đây có phải mẫu không."""
|
||||
id: str
|
||||
name: str = "Untitled flow"
|
||||
is_template: bool = False
|
||||
@@ -139,10 +132,6 @@ class CustomAgent:
|
||||
|
||||
# ---- (de)serialization ---------------------------------------------------
|
||||
def step_from_dict(d: dict) -> Step:
|
||||
"""Dựng :class:`Step` từ dict đọc trên đĩa.
|
||||
|
||||
Lọc bỏ khoá lạ để file luồng của phiên bản mới hơn không làm vỡ bản cũ.
|
||||
"""
|
||||
d = dict(d or {})
|
||||
subs = d.pop("sub_agents", None) or []
|
||||
known = Step().__dict__.keys()
|
||||
@@ -156,13 +145,11 @@ def step_from_dict(d: dict) -> Step:
|
||||
|
||||
|
||||
def node_from_dict(d: dict) -> Node:
|
||||
"""Dựng :class:`Node` từ dict đọc trên đĩa."""
|
||||
return Node(id=str(d.get("id", "")), x=float(d.get("x", 0) or 0),
|
||||
y=float(d.get("y", 0) or 0), data=step_from_dict(d.get("data", {})))
|
||||
|
||||
|
||||
def workflow_from_dict(d: dict) -> Workflow:
|
||||
"""Dựng :class:`Workflow` từ dict đọc trên đĩa."""
|
||||
return Workflow(
|
||||
id=str(d.get("id", "")),
|
||||
name=d.get("name", "Untitled flow"),
|
||||
@@ -174,7 +161,6 @@ def workflow_from_dict(d: dict) -> Workflow:
|
||||
|
||||
|
||||
def workflow_to_dict(wf: Workflow) -> dict:
|
||||
"""Chuyển một luồng thành dict để ghi JSON."""
|
||||
return {
|
||||
"id": wf.id, "name": wf.name, "is_template": wf.is_template,
|
||||
"nodes": [{"id": n.id, "x": n.x, "y": n.y, "data": _step_dict(n.data)} for n in wf.nodes],
|
||||
@@ -183,19 +169,16 @@ def workflow_to_dict(wf: Workflow) -> dict:
|
||||
|
||||
|
||||
def _step_dict(step: Step) -> dict:
|
||||
"""Chuyển một bước thành dict; ``asdict`` đã tự chuyển ``sub_agents`` thành list dict."""
|
||||
d = asdict(step)
|
||||
# asdict already turns sub_agents into list[dict]
|
||||
return d
|
||||
|
||||
|
||||
def agent_to_dict(a: CustomAgent) -> dict:
|
||||
"""Chuyển một agent tự tạo thành dict để ghi JSON."""
|
||||
return asdict(a)
|
||||
|
||||
|
||||
def agent_from_dict(d: dict) -> CustomAgent:
|
||||
"""Dựng :class:`CustomAgent` từ dict, lọc bỏ khoá lạ."""
|
||||
known = CustomAgent(id="").__dict__.keys()
|
||||
d = {k: v for k, v in (d or {}).items() if k in known}
|
||||
d.setdefault("id", "")
|
||||
@@ -210,43 +193,32 @@ _counter = {"n": 0}
|
||||
|
||||
|
||||
def _mint_id(prefix: str) -> str:
|
||||
"""Sinh id tăng dần dạng ``<prefix>_000001``."""
|
||||
_counter["n"] += 1
|
||||
return f"{prefix}_{_counter['n']:06d}"
|
||||
|
||||
|
||||
def new_node_id() -> str:
|
||||
"""Id mới cho một node."""
|
||||
return _mint_id("node")
|
||||
|
||||
|
||||
def new_edge_id(source: str, target: str) -> str:
|
||||
"""Id cạnh suy ra TỪ cặp nguồn/đích.
|
||||
|
||||
Cố ý không ngẫu nhiên: nhờ vậy nối lại đúng cặp node đó luôn cho ra cùng
|
||||
một id, và không thể sinh ra hai cạnh trùng nhau.
|
||||
"""
|
||||
return f"e_{source}__{target}"
|
||||
|
||||
|
||||
def new_workflow(name: str = "Untitled flow") -> Workflow:
|
||||
"""Tạo một luồng rỗng với id mới."""
|
||||
return Workflow(id=_mint_id("wf"), name=name)
|
||||
|
||||
|
||||
def new_custom_agent(name: str = "") -> CustomAgent:
|
||||
"""Tạo một agent tự tạo rỗng với id mới."""
|
||||
return CustomAgent(id=_mint_id("agent"), name=name)
|
||||
|
||||
|
||||
# ---- workflow store ------------------------------------------------------
|
||||
def workflows_dir() -> Path:
|
||||
"""Thư mục chứa file luồng."""
|
||||
return WORKFLOWS_DIR
|
||||
|
||||
|
||||
def list_workflows(directory: Optional[Path] = None) -> List[Workflow]:
|
||||
"""Liệt kê mọi luồng đã lưu; thư mục chưa có thì trả list rỗng."""
|
||||
directory = directory or WORKFLOWS_DIR
|
||||
if not directory.exists():
|
||||
return []
|
||||
@@ -260,7 +232,6 @@ def list_workflows(directory: Optional[Path] = None) -> List[Workflow]:
|
||||
|
||||
|
||||
def save_workflow(wf: Workflow, directory: Optional[Path] = None) -> Path:
|
||||
"""Ghi một luồng ra ``<id>.json``, tự tạo thư mục nếu chưa có."""
|
||||
directory = directory or WORKFLOWS_DIR
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
path = directory / f"{wf.id}.json"
|
||||
@@ -271,7 +242,6 @@ def save_workflow(wf: Workflow, directory: Optional[Path] = None) -> Path:
|
||||
|
||||
|
||||
def get_workflow(wf_id: str, directory: Optional[Path] = None) -> Optional[Workflow]:
|
||||
"""Đọc một luồng theo id; ``None`` nếu không có."""
|
||||
directory = directory or WORKFLOWS_DIR
|
||||
path = directory / f"{wf_id}.json"
|
||||
if not path.exists():
|
||||
@@ -310,7 +280,6 @@ def tr_copy_suffix() -> str:
|
||||
|
||||
|
||||
def delete_workflow(wf_id: str, directory: Optional[Path] = None) -> None:
|
||||
"""Xoá file luồng theo id; không có thì bỏ qua."""
|
||||
directory = directory or WORKFLOWS_DIR
|
||||
path = directory / f"{wf_id}.json"
|
||||
if path.exists():
|
||||
@@ -322,12 +291,10 @@ def delete_workflow(wf_id: str, directory: Optional[Path] = None) -> None:
|
||||
|
||||
# ---- custom-agent store --------------------------------------------------
|
||||
def agents_dir() -> Path:
|
||||
"""Thư mục chứa file agent tự tạo."""
|
||||
return AGENTS_DIR
|
||||
|
||||
|
||||
def list_custom_agents(directory: Optional[Path] = None) -> List[CustomAgent]:
|
||||
"""Liệt kê mọi agent tự tạo; thư mục chưa có thì trả list rỗng."""
|
||||
directory = directory or AGENTS_DIR
|
||||
if not directory.exists():
|
||||
return []
|
||||
@@ -341,7 +308,6 @@ def list_custom_agents(directory: Optional[Path] = None) -> List[CustomAgent]:
|
||||
|
||||
|
||||
def save_custom_agent(agent: CustomAgent, directory: Optional[Path] = None) -> Path:
|
||||
"""Ghi một agent tự tạo ra ``<id>.json``."""
|
||||
directory = directory or AGENTS_DIR
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
path = directory / f"{agent.id}.json"
|
||||
@@ -350,7 +316,6 @@ def save_custom_agent(agent: CustomAgent, directory: Optional[Path] = None) -> P
|
||||
|
||||
|
||||
def delete_custom_agent(agent_id: str, directory: Optional[Path] = None) -> None:
|
||||
"""Xoá file agent tự tạo theo id; không có thì bỏ qua."""
|
||||
directory = directory or AGENTS_DIR
|
||||
path = directory / f"{agent_id}.json"
|
||||
if path.exists():
|
||||
@@ -375,11 +340,6 @@ def compute_waves(nodes: List[Node], edges: List[Edge]) -> Dict[str, int]:
|
||||
limit = len(nodes) + 1
|
||||
|
||||
def depth(nid: str, seen: frozenset) -> int:
|
||||
"""Độ sâu của một node = lớp chạy của nó.
|
||||
|
||||
Có nhớ kết quả và chặn theo ``limit``: đồ thị có vòng sẽ khiến đệ quy chạy
|
||||
mãi, nên gặp node đã thấy trong nhánh hiện tại thì dừng.
|
||||
"""
|
||||
if nid in wave:
|
||||
return wave[nid]
|
||||
if nid in seen or len(seen) > limit:
|
||||
@@ -400,14 +360,12 @@ def connected_component_count(nodes: List[Node], edges: List[Edge]) -> int:
|
||||
parent = {n.id: n.id for n in nodes}
|
||||
|
||||
def find(x):
|
||||
"""Tìm gốc của một phần tử, kèm nén đường đi (union-find)."""
|
||||
while parent[x] != x:
|
||||
parent[x] = parent[parent[x]]
|
||||
x = parent[x]
|
||||
return x
|
||||
|
||||
def union(a, b):
|
||||
"""Gộp hai tập hợp lại làm một (union-find)."""
|
||||
ra, rb = find(a), find(b)
|
||||
if ra != rb:
|
||||
parent[ra] = rb
|
||||
@@ -421,7 +379,6 @@ def connected_component_count(nodes: List[Node], edges: List[Edge]) -> int:
|
||||
# ---- run-stage compilation ----------------------------------------------
|
||||
@dataclass
|
||||
class RunStage:
|
||||
"""Một chặng chạy: ứng với một node, hoặc một nhánh song song / bước gộp của nó."""
|
||||
id: str # node id, or "<node>__p<i>" / "<node>__pjoin"
|
||||
node_id: str # which canvas node this stage maps back onto
|
||||
wave: int
|
||||
@@ -438,7 +395,6 @@ PLAN_MODE_PREAMBLE = (
|
||||
|
||||
|
||||
def build_skills_block(skills: List[str], skill_map: Dict[str, str]) -> str:
|
||||
"""Ghép nội dung các skill được chọn thành một khối chèn vào prompt."""
|
||||
parts = []
|
||||
for name in skills or []:
|
||||
content = (skill_map.get(name) or "").strip()
|
||||
@@ -451,9 +407,6 @@ def build_skills_block(skills: List[str], skill_map: Dict[str, str]) -> str:
|
||||
|
||||
|
||||
def _shared_prompt_parts(step: Step, skill_map: Dict[str, str], extra_context: str) -> str:
|
||||
"""Phần prompt dùng chung cho cả ba loại chặng: chỉ dẫn của bước, khối skill,
|
||||
và ngữ cảnh thêm từ các bước trước.
|
||||
"""
|
||||
parts = []
|
||||
if step.instructions.strip():
|
||||
parts.append(step.instructions.strip())
|
||||
@@ -470,7 +423,6 @@ def _shared_prompt_parts(step: Step, skill_map: Dict[str, str], extra_context: s
|
||||
|
||||
|
||||
def build_step_prompt(step: Step, skill_map: Dict[str, str], extra_context: str = "") -> str:
|
||||
"""Prompt cho một bước chạy tuần tự bình thường."""
|
||||
head = f'You are the {step.role} agent for the workflow step "{step.label}".'
|
||||
body = _shared_prompt_parts(step, skill_map, extra_context)
|
||||
return f"{head}\n{body}".strip()
|
||||
@@ -478,11 +430,6 @@ def build_step_prompt(step: Step, skill_map: Dict[str, str], extra_context: str
|
||||
|
||||
def build_subagent_prompt(step: Step, sub: SubAgent, peers: List[str],
|
||||
skill_map: Dict[str, str], extra_context: str = "") -> str:
|
||||
"""Prompt cho một sub-agent chạy song song.
|
||||
|
||||
Nói rõ nó đang chạy CÙNG LÚC với những ai và phải ở trong phạm vi của mình —
|
||||
không có câu đó, các sub-agent hay làm chồng việc của nhau.
|
||||
"""
|
||||
peer_txt = ", ".join(p for p in peers if p) or "peers"
|
||||
head = (f'You are the "{sub.agent}" agent working concurrently (in parallel with '
|
||||
f'{peer_txt}) on the workflow step "{step.label}". Stay within your own scope.')
|
||||
@@ -496,7 +443,6 @@ def build_subagent_prompt(step: Step, sub: SubAgent, peers: List[str],
|
||||
|
||||
|
||||
def build_join_prompt(step: Step, skill_map: Dict[str, str], extra_context: str = "") -> str:
|
||||
"""Prompt cho bước gộp: hợp nhất đầu ra của các sub-agent thành một kết quả."""
|
||||
head = (f'You are the coordinator for the parallel step "{step.label}". Consolidate the '
|
||||
f"outputs of the sub-agents (provided above as prior outputs) into one coherent result.")
|
||||
body = _shared_prompt_parts(step, skill_map, extra_context)
|
||||
@@ -515,9 +461,6 @@ def compile_run_stages(nodes: List[Node], edges: List[Edge],
|
||||
stages: List[RunStage] = []
|
||||
|
||||
def finalize(prompt: str, preset: str) -> tuple:
|
||||
"""Chốt prompt của một chặng: áp phạm vi theo preset, và thêm lời mở đầu chế
|
||||
độ lập kế hoạch nếu đang chạy ở chế độ đó.
|
||||
"""
|
||||
scope = PRESET_SCOPES.get(preset)
|
||||
if plan_mode:
|
||||
prompt = PLAN_MODE_PREAMBLE + prompt
|
||||
|
||||
@@ -15,7 +15,6 @@ from .co4e import (
|
||||
|
||||
@dataclass
|
||||
class BuiltinAgent:
|
||||
"""Một agent dựng sẵn của Co4E: slug, tên, vai trò và prompt mặc định."""
|
||||
slug: str
|
||||
name: str
|
||||
role: str
|
||||
|
||||
@@ -28,7 +28,6 @@ _HISTORY_CAP = 500 # keep the most-recent N runs on disk
|
||||
|
||||
|
||||
def _now_str() -> str:
|
||||
"""Mốc thời gian hiện tại dạng 'YYYY-MM-DD HH:MM' cho lịch sử run."""
|
||||
from datetime import datetime
|
||||
return datetime.now().strftime("%Y-%m-%d %H:%M")
|
||||
|
||||
@@ -45,11 +44,6 @@ class RunHandle:
|
||||
def __init__(self, run_id: str, wf_id: str, name: str, total: int,
|
||||
plan_mode: bool, manual: bool, created_by: str = "", created_at: str = "",
|
||||
project_id: str = ""):
|
||||
"""Một lượt chạy workflow đang sống trong bộ nhớ.
|
||||
|
||||
``total`` âm bị kẹp về 0 — số bước không thể âm, và để lọt xuống thì thanh
|
||||
tiến độ vẽ ngược.
|
||||
"""
|
||||
self.id = run_id
|
||||
self.wf_id = wf_id
|
||||
self.name = name
|
||||
@@ -70,11 +64,9 @@ class RunHandle:
|
||||
|
||||
@property
|
||||
def running(self) -> bool:
|
||||
"""Lượt chạy này còn đang chạy hay không."""
|
||||
return self.status == "running"
|
||||
|
||||
def progress_text(self) -> str:
|
||||
"""Chuỗi tiến độ 'xong/tổng'; chưa biết tổng thì hiện trạng thái."""
|
||||
return f"{self.done}/{self.total}" if self.total else self.status
|
||||
|
||||
# ---- persistence ------------------------------------------------------
|
||||
@@ -95,7 +87,6 @@ class RunHandle:
|
||||
|
||||
@classmethod
|
||||
def from_record(cls, rec: dict) -> "RunHandle":
|
||||
"""Dựng lại một ``RunHandle`` từ bản ghi đọc trong lịch sử trên đĩa."""
|
||||
from .co4e import workflow_from_dict
|
||||
rec = dict(rec or {})
|
||||
h = cls(str(rec.get("id", "")), str(rec.get("wf_id", "")),
|
||||
@@ -118,18 +109,10 @@ class RunHandle:
|
||||
|
||||
|
||||
class Co4ERunManager(QObject):
|
||||
"""Quản lý vòng đời nhiều lượt chạy luồng Co4E cùng lúc.
|
||||
|
||||
Flow Status lọc theo project, nên hầu hết truy vấn ở đây chỉ tính run thuộc
|
||||
workspace ĐANG chọn — xem ``_belongs``.
|
||||
"""
|
||||
changed = Signal() # any run's status/progress changed → refresh views
|
||||
event = Signal(str, dict) # (run_id, ev) — node-level events, for mirroring
|
||||
|
||||
def __init__(self, ctx):
|
||||
"""Dựng bộ quản lý run và khôi phục lịch sử cũ ngay, để tab Flow Status có nội
|
||||
dung ngay khi mở chứ không trống cho tới lần chạy đầu tiên.
|
||||
"""
|
||||
super().__init__()
|
||||
self.ctx = ctx
|
||||
self._runs: Dict[str, RunHandle] = {}
|
||||
@@ -143,12 +126,10 @@ class Co4ERunManager(QObject):
|
||||
|
||||
# ---- persistence ------------------------------------------------------
|
||||
def _history_path(self) -> Path:
|
||||
"""Đường dẫn file lịch sử run."""
|
||||
from .co4e import CO4E_DIR
|
||||
return CO4E_DIR / "run_history.json"
|
||||
|
||||
def _load_history(self) -> None:
|
||||
"""Khôi phục lịch sử run từ đĩa lúc khởi động; file hỏng thì bỏ qua lặng lẽ."""
|
||||
path = self._history_path()
|
||||
try:
|
||||
data = json.loads(path.read_text(encoding="utf-8"))
|
||||
@@ -168,7 +149,6 @@ class Co4ERunManager(QObject):
|
||||
self._seq = max_seq # avoid minting ids that collide with history
|
||||
|
||||
def _save_history(self) -> None:
|
||||
"""Ghi ``_HISTORY_CAP`` run gần nhất xuống đĩa."""
|
||||
path = self._history_path()
|
||||
runs = list(self._runs.values())[-_HISTORY_CAP:]
|
||||
payload = {"runs": [h.to_record() for h in runs]}
|
||||
@@ -183,7 +163,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
# ---- lifecycle --------------------------------------------------------
|
||||
def _next_id(self) -> str:
|
||||
"""Sinh id run kế tiếp dạng 'runN'."""
|
||||
self._seq += 1
|
||||
return f"run{self._seq}"
|
||||
|
||||
@@ -219,7 +198,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
run_label = handle.name
|
||||
def job(worker: AgentWorker):
|
||||
"""Chạy nền: thực thi luồng, chuyển tiếp sự kiện tiến độ và cờ huỷ."""
|
||||
return co4e_runner.run_workflow(
|
||||
ctx, nodes, edges, out_dir, worker.emit_event, worker.is_cancelled,
|
||||
plan_mode=plan_mode, skill_map=sk, only_nodes=only, seed_outputs=seed,
|
||||
@@ -237,7 +215,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
# ---- worker callbacks -------------------------------------------------
|
||||
def _on_event(self, run_id: str, ev: dict) -> None:
|
||||
"""Nhận sự kiện từ luồng đang chạy và cập nhật trạng thái/tiến độ của run."""
|
||||
handle = self._runs.get(run_id)
|
||||
if handle is not None and isinstance(ev, dict):
|
||||
t = ev.get("type")
|
||||
@@ -252,10 +229,6 @@ class Co4ERunManager(QObject):
|
||||
self.event.emit(run_id, ev)
|
||||
|
||||
def _on_finished(self, run_id: str) -> None:
|
||||
"""Job kết thúc mà không phát ``run_done``: chốt trạng thái về 'done'.
|
||||
|
||||
Lẽ ra không xảy ra, nhưng thiếu bước này thì run kẹt ở 'running' mãi.
|
||||
"""
|
||||
handle = self._runs.get(run_id)
|
||||
if handle is not None and handle.status == "running":
|
||||
# job returned without a run_done event (shouldn't happen) — settle it
|
||||
@@ -263,7 +236,6 @@ class Co4ERunManager(QObject):
|
||||
self.changed.emit()
|
||||
|
||||
def _on_failed(self, run_id: str, err: str) -> None:
|
||||
"""Job ném lỗi: ghi lỗi vào bản ghi run và báo ra ngoài."""
|
||||
handle = self._runs.get(run_id)
|
||||
if handle is not None:
|
||||
handle.status = "error"
|
||||
@@ -273,7 +245,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
# ---- control ----------------------------------------------------------
|
||||
def stop(self, run_id: str) -> None:
|
||||
"""Yêu cầu dừng một run đang chạy."""
|
||||
handle = self._runs.get(run_id)
|
||||
if handle is not None and handle.worker is not None and handle.running:
|
||||
handle.worker.request_stop()
|
||||
@@ -282,7 +253,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
def stop_all(self) -> None:
|
||||
# Only the CURRENT workspace's runs (Flow Status is per-project).
|
||||
"""Dừng mọi run của workspace đang chọn."""
|
||||
for run_id in [r for r, h in self._runs.items() if self._belongs(h)]:
|
||||
self.stop(run_id)
|
||||
|
||||
@@ -299,7 +269,6 @@ class Co4ERunManager(QObject):
|
||||
self.changed.emit()
|
||||
|
||||
def remove(self, run_id: str) -> None:
|
||||
"""Xoá một run khỏi lịch sử; đang chạy thì dừng trước."""
|
||||
handle = self._runs.get(run_id)
|
||||
if handle is not None and handle.running:
|
||||
self.stop(run_id)
|
||||
@@ -308,7 +277,6 @@ class Co4ERunManager(QObject):
|
||||
|
||||
def clear_finished(self) -> None:
|
||||
# Only clear finished runs of the CURRENT workspace.
|
||||
"""Xoá mọi run đã kết thúc của workspace đang chọn, giữ nguyên run đang chạy."""
|
||||
for run_id in [r for r, h in self._runs.items() if not h.running and self._belongs(h)]:
|
||||
self._runs.pop(run_id, None)
|
||||
self.changed.emit()
|
||||
@@ -327,11 +295,9 @@ class Co4ERunManager(QObject):
|
||||
return list(self._runs.values())
|
||||
|
||||
def get(self, run_id: str) -> Optional[RunHandle]:
|
||||
"""Bản ghi của một run theo id; ``None`` nếu không có."""
|
||||
return self._runs.get(run_id)
|
||||
|
||||
def active_count(self) -> int:
|
||||
"""Số run đang chạy của workspace đang chọn."""
|
||||
return sum(1 for h in self._runs.values() if h.running and self._belongs(h))
|
||||
|
||||
def set_current_project(self, project_id: str) -> None:
|
||||
@@ -354,11 +320,6 @@ class Co4ERunManager(QObject):
|
||||
# tab), not in the config/install folder. One subfolder per flow keeps
|
||||
# runs tidy. Falls back to the global Cowork output dir when no workspace
|
||||
# is selected.
|
||||
"""Thư mục ghi kết quả của một luồng, tạo sẵn nếu chưa có.
|
||||
|
||||
Ưu tiên thư mục của workspace đang chọn để file rơi đúng chỗ người dùng làm
|
||||
việc (màn Thư mục), không rơi vào thư mục cài đặt.
|
||||
"""
|
||||
from .co4e import slugify
|
||||
base = self._output_root
|
||||
if base is None:
|
||||
|
||||
@@ -29,9 +29,6 @@ CancelFn = Callable[[], bool]
|
||||
|
||||
|
||||
def _predecessors(nodes: List[Node], edges: List[Edge]) -> Dict[str, List[str]]:
|
||||
"""Bảng ``{node: các node đứng trước}`` — dùng để gom đầu ra của bước trước làm
|
||||
ngữ cảnh cho bước sau.
|
||||
"""
|
||||
ids = {n.id for n in nodes}
|
||||
preds: Dict[str, List[str]] = {n.id: [] for n in nodes}
|
||||
for e in edges:
|
||||
@@ -41,7 +38,6 @@ def _predecessors(nodes: List[Node], edges: List[Edge]) -> Dict[str, List[str]]:
|
||||
|
||||
|
||||
def _label_of(nodes: List[Node], node_id: str) -> str:
|
||||
"""Nhãn hiển thị của một node; trả về chính id nếu không tìm thấy."""
|
||||
for n in nodes:
|
||||
if n.id == node_id:
|
||||
return n.data.label
|
||||
@@ -66,10 +62,6 @@ def _attachments_text(node, out_dir=None) -> str:
|
||||
parts, budget = [], _MAX_ATTACH_CHARS
|
||||
|
||||
def _read_into(path, label, indent=""):
|
||||
"""Đọc một tệp đính kèm vào phần ngữ cảnh, trừ dần vào hạn mức ký tự chung.
|
||||
|
||||
Có hạn mức vì vài tệp lớn là đủ đẩy cả lượt chạy vượt cửa sổ ngữ cảnh.
|
||||
"""
|
||||
nonlocal budget
|
||||
name = _P(path).name
|
||||
if is_image(path):
|
||||
@@ -105,7 +97,6 @@ def _attachments_text(node, out_dir=None) -> str:
|
||||
|
||||
|
||||
def _last_assistant_text(messages: List[dict]) -> str:
|
||||
"""Nội dung trả lời cuối cùng của assistant; '' nếu không có."""
|
||||
for m in reversed(messages):
|
||||
if m.get("role") == "assistant" and m.get("content"):
|
||||
return str(m["content"])
|
||||
@@ -254,7 +245,6 @@ def run_workflow(ctx, nodes: List[Node], edges: List[Edge], out_dir: Path,
|
||||
|
||||
# Group compiled stages by wave, preserving per-node context threading.
|
||||
def extra_context_for(node_id: str) -> Dict[str, str]:
|
||||
"""Ngữ cảnh thêm cho một bước: tệp đính kèm của nó cộng đầu ra của các bước đứng trước."""
|
||||
parts = []
|
||||
att = _attachments_text(by_id.get(node_id), out_dir)
|
||||
if att:
|
||||
|
||||
+7
-29
@@ -12,11 +12,9 @@ import re
|
||||
from pathlib import Path
|
||||
from typing import Any, Callable, Dict, List, Optional
|
||||
|
||||
from ..application.conversations.tool_policy_gateway import ToolPolicyGateway
|
||||
from ..domain.tools import ToolCapability, ToolDescriptor, ToolRegistry
|
||||
from ..providers.base import Provider
|
||||
from . import agent_roles, agent_security
|
||||
from .mcp_client import UNTRUSTED_MCP_CONTENT_RULE
|
||||
from . import agent_roles
|
||||
from . import agent_security
|
||||
from .ms365_tools import MS365_WRITE_TOOLS
|
||||
from .permissions import PermissionGate
|
||||
from .plan import UPDATE_PLAN_SPEC, normalize_plan_steps
|
||||
@@ -31,11 +29,6 @@ _TOOL_LINE = re.compile(r"@@TOOL\s+(\w+)\s+(\{.*\})", re.DOTALL)
|
||||
|
||||
def code_system_prompt(workdir: Path, has_memory: bool = False, plan: bool = False,
|
||||
has_plan_tool: bool = False, has_ms365: bool = False) -> str:
|
||||
"""Prompt hệ thống cho Code agent, ghép theo năng lực thật của lượt chạy.
|
||||
|
||||
Chỉ liệt kê những tool đang BẬT, và thêm ghi chú chế độ lập kế hoạch khi cần —
|
||||
nói với model về một tool nó không có sẽ khiến nó gọi rồi báo lỗi.
|
||||
"""
|
||||
names = ", ".join(t.name for t in TOOL_SPECS)
|
||||
plan_note = ("PLAN MODE: only analyze and propose a detailed plan; do NOT write files or run "
|
||||
"commands. When the user asks to gencode/implement, the app switches to ACT.\n"
|
||||
@@ -83,7 +76,6 @@ def code_system_prompt(workdir: Path, has_memory: bool = False, plan: bool = Fal
|
||||
"'.scratch/' folder. Only the final requested file(s) should remain — never leave "
|
||||
"generator scripts or intermediate files behind.\n"
|
||||
"Every path must stay inside the working folder.\n"
|
||||
+ UNTRUSTED_MCP_CONTENT_RULE + "\n"
|
||||
"If a command or tool fails, do NOT stop and hand the error back to the user — read the "
|
||||
"error, fix the cause (edit the code, install a missing package, correct the command) and "
|
||||
"retry. Keep iterating until the task actually works, then run it once more so you can "
|
||||
@@ -233,14 +225,6 @@ def run_code(
|
||||
# read/list ms365 tools count as "read-only, never confirm". Names are
|
||||
# the MCP-qualified "ms365__*" form the agent sees (see ms365_tools.py).
|
||||
gated_tools = WRITE_TOOLS | MS365_WRITE_TOOLS
|
||||
# R05-T03/T04: ``gated_tools`` stays the authoritative name set (unchanged),
|
||||
# but the actual confirm decision now goes through the same
|
||||
# ToolPolicyGateway class run_cowork uses, instead of a separate
|
||||
# hand-rolled ``if name in gated_tools`` + direct ``gate.request(...)``.
|
||||
code_tool_policy = ToolPolicyGateway(
|
||||
ToolRegistry(ToolDescriptor(n, "", {}, ToolCapability.WRITE) for n in gated_tools),
|
||||
ToolCapability.WRITE,
|
||||
)
|
||||
# In PLAN mode, don't advertise write/run tools (analysis only).
|
||||
advertised = [t for t in all_tools if t.name not in gated_tools] if plan else all_tools
|
||||
has_memory = any(t.name.startswith("cmem_") for t in extra_tools)
|
||||
@@ -313,11 +297,10 @@ def run_code(
|
||||
agent_security.enforce_command(provider, name, args, security_config, emit,
|
||||
agent_kind="code")
|
||||
|
||||
# read-only tools (incl. codebase memory) never consult the gate —
|
||||
# code_tool_policy.requires_confirmation(name) is False for them.
|
||||
approved = code_tool_policy.allow(
|
||||
name, gate, {"id": tc_id, "name": name, "args": args, "preview": preview}
|
||||
)
|
||||
if name in gated_tools:
|
||||
approved = gate.request({"id": tc_id, "name": name, "args": args, "preview": preview})
|
||||
else:
|
||||
approved = True # read-only tools (incl. codebase memory) never confirm
|
||||
|
||||
if cancel():
|
||||
return messages
|
||||
@@ -327,12 +310,7 @@ def run_code(
|
||||
else:
|
||||
emit({"type": "tool_start", "id": tc_id, "name": name})
|
||||
if is_extra and extra_executor is not None:
|
||||
if ctx.block_network and not name.startswith("ms365_local__"):
|
||||
result = {"ok": False, "output": (
|
||||
f"{name}: network access is blocked by the Sandbox Security Layer "
|
||||
'("Block network for agent-run commands" is on in Settings).')}
|
||||
else:
|
||||
result = extra_executor(name, args)
|
||||
result = extra_executor(name, args)
|
||||
else:
|
||||
def on_output(line: str, _id=tc_id, _name=name) -> None:
|
||||
emit({"type": "tool_output", "id": _id, "name": _name, "delta": line})
|
||||
|
||||
@@ -26,7 +26,6 @@ _INDEX_TIMEOUT = 900
|
||||
|
||||
|
||||
class CodebaseMemoryError(RuntimeError):
|
||||
"""Lỗi khi gọi công cụ codebase-memory-mcp bên ngoài."""
|
||||
pass
|
||||
|
||||
|
||||
@@ -76,24 +75,14 @@ def _extract_json(text: str):
|
||||
|
||||
|
||||
class CodebaseMemory:
|
||||
"""Vỏ bọc quanh CLI ``codebase-memory-mcp``: đánh chỉ mục và tra cứu mã nguồn.
|
||||
|
||||
Đây là phần mềm ngoài, có thể không được cài — luôn kiểm :meth:`available`
|
||||
trước khi dùng.
|
||||
"""
|
||||
def __init__(self, binary_path: str = ""):
|
||||
"""Tìm file thực thi codebase-memory; không có thì ``available`` là False và
|
||||
mọi lượt gọi về sau tự bỏ qua.
|
||||
"""
|
||||
self.binary = resolve_binary(binary_path)
|
||||
|
||||
@property
|
||||
def available(self) -> bool:
|
||||
"""Đã tìm thấy CLI trên máy chưa."""
|
||||
return self.binary is not None
|
||||
|
||||
def _run(self, tool: str, args: Dict[str, Any], timeout: int) -> Dict[str, Any]:
|
||||
"""Gọi một tool của CLI và trả kết quả JSON; chưa cài thì báo lỗi kèm hướng dẫn."""
|
||||
if not self.binary:
|
||||
raise CodebaseMemoryError(
|
||||
"codebase-memory-mcp is not installed. See the instructions in Settings."
|
||||
@@ -118,15 +107,12 @@ class CodebaseMemory:
|
||||
|
||||
# ---- high level ops ---------------------------------------------
|
||||
def index_repository(self, repo_path: str) -> Dict[str, Any]:
|
||||
"""Đánh chỉ mục một repository (chạy lâu — dùng hạn giờ dài hơn)."""
|
||||
return self._run("index_repository", {"repo_path": str(repo_path)}, _INDEX_TIMEOUT)
|
||||
|
||||
def list_projects(self) -> Dict[str, Any]:
|
||||
"""Danh sách project đã được đánh chỉ mục."""
|
||||
return self._run("list_projects", {}, _QUERY_TIMEOUT)
|
||||
|
||||
def call(self, tool: str, args: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Gọi một tool bất kỳ, tự chọn hạn giờ theo loại việc."""
|
||||
timeout = _INDEX_TIMEOUT if tool == "index_repository" else _QUERY_TIMEOUT
|
||||
return self._run(tool, args, timeout)
|
||||
|
||||
@@ -201,9 +187,6 @@ def make_executor(mem: CodebaseMemory):
|
||||
"""Return an executor(name, args) -> {ok, output} for cmem_* tools."""
|
||||
|
||||
def execute(name: str, args: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Bộ thực thi tool codebase-memory cho agent; tên tool lạ thì trả về lỗi thay
|
||||
vì ném ngoại lệ.
|
||||
"""
|
||||
cli_tool = _CLI_NAME.get(name)
|
||||
if not cli_tool:
|
||||
return {"ok": False, "output": f"Unsupported codebase-memory tool: {name}"}
|
||||
|
||||
@@ -33,9 +33,6 @@ class CmemUiError(RuntimeError):
|
||||
asset) — a different remedy than a generic startup/timeout failure."""
|
||||
|
||||
def __init__(self, message: str, no_ui_build: bool = False):
|
||||
"""``no_ui_build`` đánh dấu trường hợp riêng: chạy được nhưng bản cài không kèm
|
||||
phần giao diện — thông báo cho người dùng phải khác hẳn lỗi chạy thường.
|
||||
"""
|
||||
super().__init__(message)
|
||||
self.no_ui_build = no_ui_build
|
||||
|
||||
@@ -44,21 +41,16 @@ class CodebaseMemoryUiServer:
|
||||
"""One ``codebase-memory-mcp --ui`` process, started on demand."""
|
||||
|
||||
def __init__(self, binary_path: str = "", port: int = DEFAULT_PORT):
|
||||
"""Chuẩn bị chỗ chạy máy chủ giao diện; chưa khởi động tiến trình nào."""
|
||||
self.binary = resolve_binary(binary_path)
|
||||
self.port = port
|
||||
self._proc: Optional[subprocess.Popen] = None
|
||||
|
||||
@property
|
||||
def url(self) -> str:
|
||||
"""Địa chỉ để mở giao diện. Chỉ nghe trên 127.0.0.1 — đây là công cụ cục bộ,
|
||||
không mở ra mạng.
|
||||
"""
|
||||
return f"http://127.0.0.1:{self.port}/"
|
||||
|
||||
@property
|
||||
def running(self) -> bool:
|
||||
"""Tiến trình máy chủ còn sống không."""
|
||||
return self._proc is not None and self._proc.poll() is None
|
||||
|
||||
def start(self, repo_path: str = "") -> str:
|
||||
@@ -83,9 +75,6 @@ class CodebaseMemoryUiServer:
|
||||
no_ui_event = threading.Event()
|
||||
|
||||
def _reader() -> None:
|
||||
"""Chạy nền: đọc đầu ra của tiến trình, giữ lại để báo lỗi và bật cờ khi thấy
|
||||
dấu hiệu bản cài không có phần giao diện.
|
||||
"""
|
||||
try:
|
||||
stream = self._proc.stdout
|
||||
if stream is None:
|
||||
@@ -122,11 +111,6 @@ class CodebaseMemoryUiServer:
|
||||
raise CmemUiError(f"Hết thời gian chờ UI trên cổng {self.port}.")
|
||||
|
||||
def stop(self) -> None:
|
||||
"""Dừng máy chủ. Xin dừng tử tế trước, quá 3 giây thì buộc tắt.
|
||||
|
||||
Mọi lỗi đều bị nuốt có chủ ý: đây là dọn dẹp lúc thoát, ném lỗi ở đây chỉ
|
||||
làm kẹt đường thoát của cả ứng dụng.
|
||||
"""
|
||||
proc, self._proc = self._proc, None
|
||||
if proc is not None and proc.poll() is None:
|
||||
try:
|
||||
|
||||
@@ -33,9 +33,6 @@ _MODEL_LIMITS = {
|
||||
|
||||
|
||||
def model_context_limit(model: str) -> int:
|
||||
"""Cửa sổ ngữ cảnh (token) của một model, dò theo tiền tố tên dài nhất khớp
|
||||
trong bảng; không khớp gì thì lấy ``DEFAULT_LIMIT``.
|
||||
"""
|
||||
m = (model or "").lower()
|
||||
best = 0
|
||||
limit = DEFAULT_LIMIT
|
||||
@@ -46,7 +43,6 @@ def model_context_limit(model: str) -> int:
|
||||
|
||||
|
||||
def _ctx_conf(config) -> Dict[str, Any]:
|
||||
"""Nhóm cấu hình ``context``; không có config thì trả dict rỗng."""
|
||||
if config is None:
|
||||
return {}
|
||||
try:
|
||||
@@ -63,13 +59,11 @@ def context_limit(config, model: str = "") -> int:
|
||||
|
||||
|
||||
def auto_compact_enabled(config) -> bool:
|
||||
"""Có tự nén lịch sử khi gần đầy ngữ cảnh không (mặc định bật)."""
|
||||
conf = _ctx_conf(config)
|
||||
return bool(conf.get("auto_compact", True))
|
||||
|
||||
|
||||
def threshold(config) -> float:
|
||||
"""Ngưỡng nén, tính theo tỉ lệ cửa sổ ngữ cảnh đã dùng (mặc định 0,8)."""
|
||||
conf = _ctx_conf(config)
|
||||
try:
|
||||
t = float(conf.get("compact_threshold", DEFAULT_THRESHOLD))
|
||||
@@ -79,9 +73,6 @@ def threshold(config) -> float:
|
||||
|
||||
|
||||
def _msg_text(m: Dict[str, Any]) -> str:
|
||||
"""Rút phần văn bản của một tin nhắn, kể cả khi nội dung là danh sách block
|
||||
(tin nhắn có ảnh).
|
||||
"""
|
||||
c = m.get("content", "")
|
||||
if isinstance(c, str):
|
||||
return c
|
||||
@@ -90,17 +81,11 @@ def _msg_text(m: Dict[str, Any]) -> str:
|
||||
|
||||
|
||||
def estimate_messages_tokens(messages: List[Dict[str, Any]]) -> int:
|
||||
"""Ước lượng tổng token của cả danh sách tin nhắn."""
|
||||
return sum(estimate_tokens(_msg_text(m)) for m in messages)
|
||||
|
||||
|
||||
def should_compact(messages: List[Dict[str, Any]], limit: int,
|
||||
thresh: float = DEFAULT_THRESHOLD) -> bool:
|
||||
"""Đã đến lúc nén lịch sử chưa.
|
||||
|
||||
Không nén khi hội thoại còn quá ngắn: nén một cuộc mới vài lượt thì mất nội
|
||||
dung mà chẳng tiết kiệm được bao nhiêu.
|
||||
"""
|
||||
if limit <= 0 or len(messages) <= _KEEP_RECENT + 2:
|
||||
return False
|
||||
return estimate_messages_tokens(messages) > limit * thresh
|
||||
@@ -114,7 +99,6 @@ _SUMMARY_PROMPT = (
|
||||
|
||||
|
||||
def _summarize(provider, middle: List[Dict[str, Any]], cancel=None) -> str:
|
||||
"""Nhờ model tóm tắt phần giữa của hội thoại thành một đoạn ngắn."""
|
||||
convo = "\n\n".join(f"[{m.get('role', '?')}] {_msg_text(m)}" for m in middle)
|
||||
try:
|
||||
a = provider.chat([{"role": "system", "content": _SUMMARY_PROMPT},
|
||||
|
||||
@@ -15,14 +15,10 @@ _SEARCH_DAYS = 366 * 2 # give up after two years (an expression that never fir
|
||||
|
||||
|
||||
class CronError(ValueError):
|
||||
"""Biểu thức cron sai cú pháp."""
|
||||
pass
|
||||
|
||||
|
||||
def _parse_field(spec: str, lo: int, hi: int) -> Set[int]:
|
||||
"""Đọc một trường cron thành tập giá trị: hỗ trợ ``*``, danh sách ``a,b``,
|
||||
khoảng ``a-b`` và bước ``*/n``.
|
||||
"""
|
||||
values: Set[int] = set()
|
||||
for part in spec.split(","):
|
||||
part = part.strip()
|
||||
@@ -59,13 +55,7 @@ def _parse_field(spec: str, lo: int, hi: int) -> Set[int]:
|
||||
|
||||
|
||||
class Cron:
|
||||
"""Biểu thức cron 5 trường (phút, giờ, ngày, tháng, thứ)."""
|
||||
def __init__(self, expression: str):
|
||||
"""Phân tích một biểu thức cron 5 trường.
|
||||
|
||||
Sai số trường là ném ``CronError`` ngay tại đây chứ không đợi tới lúc chạy:
|
||||
lịch sai giờ khó phát hiện hơn nhiều so với một lỗi lúc nhập.
|
||||
"""
|
||||
fields = (expression or "").split()
|
||||
if len(fields) != 5:
|
||||
raise CronError("Cron expression needs exactly 5 fields: "
|
||||
@@ -79,11 +69,6 @@ class Cron:
|
||||
self._dow_star = fields[4].strip() == "*"
|
||||
|
||||
def _day_matches(self, dt: datetime) -> bool:
|
||||
"""Ngày này có khớp biểu thức không.
|
||||
|
||||
Theo chuẩn cron: khi cả trường NGÀY và trường THỨ đều được đặt cụ thể thì
|
||||
khớp một trong hai là đủ (OR), chứ không phải cả hai (AND).
|
||||
"""
|
||||
if dt.month not in self.months:
|
||||
return False
|
||||
cron_dow = (dt.weekday() + 1) % 7 # Python Mon=0 → cron Sun=0
|
||||
|
||||
@@ -21,14 +21,6 @@ AGENTS_DIR = CONFIG_DIR / "agents"
|
||||
|
||||
@dataclass
|
||||
class CustomAgent:
|
||||
"""Một agent do người dùng tự tạo: tên, mô tả, prompt mặc định và tuỳ chọn
|
||||
provider/model riêng.
|
||||
|
||||
Bỏ trống ``provider``/``model`` nghĩa là dùng theo bước gọi nó hoặc theo cấu
|
||||
hình chung — nhờ vậy một agent viết một lần chạy được với mọi provider.
|
||||
|
||||
Đã được ``core/co4e.py`` thay thế; giữ lại làm bản đối chiếu.
|
||||
"""
|
||||
name: str
|
||||
description: str = ""
|
||||
prompt: str = "" # default task; a Flow sub-agent can still override it
|
||||
@@ -37,25 +29,16 @@ class CustomAgent:
|
||||
|
||||
@property
|
||||
def slug(self) -> str:
|
||||
"""Tên rút gọn an toàn để đặt tên file, ví dụ "Trợ lý Code" -> "tro-ly-code".
|
||||
Tên không còn ký tự hợp lệ nào thì rơi về "agent".
|
||||
"""
|
||||
keep = "-_"
|
||||
s = "".join(c if (c.isalnum() or c in keep) else "-" for c in self.name.strip().lower())
|
||||
return "-".join(filter(None, s.split("-"))) or "agent"
|
||||
|
||||
|
||||
def agents_dir() -> Path:
|
||||
"""Thư mục chứa file agent tự tạo."""
|
||||
return AGENTS_DIR
|
||||
|
||||
|
||||
def list_agents(directory: Path = AGENTS_DIR) -> List[CustomAgent]:
|
||||
"""Đọc mọi agent trong thư mục, sắp theo tên file.
|
||||
|
||||
File hỏng bị bỏ riêng lẻ chứ không làm hỏng cả danh sách — một file sai
|
||||
không được phép làm mất hết agent còn lại.
|
||||
"""
|
||||
if not directory.exists():
|
||||
return []
|
||||
agents: List[CustomAgent] = []
|
||||
@@ -75,11 +58,6 @@ def list_agents(directory: Path = AGENTS_DIR) -> List[CustomAgent]:
|
||||
|
||||
|
||||
def save_agent(agent: CustomAgent, directory: Path = AGENTS_DIR, old_name: str = "") -> Path:
|
||||
"""Ghi một agent xuống đĩa.
|
||||
|
||||
Truyền ``old_name`` khi đổi tên: file cũ bị xoá trước, nếu không sẽ có hai
|
||||
file cùng nội dung với hai tên khác nhau.
|
||||
"""
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
if old_name and old_name != agent.name:
|
||||
delete_agent(old_name, directory)
|
||||
@@ -89,9 +67,6 @@ def save_agent(agent: CustomAgent, directory: Path = AGENTS_DIR, old_name: str =
|
||||
|
||||
|
||||
def delete_agent(name: str, directory: Path = AGENTS_DIR) -> None:
|
||||
"""Xoá file của một agent theo tên. Không có file thì thôi; lỗi xoá bị nuốt,
|
||||
không chặn giao diện.
|
||||
"""
|
||||
path = directory / f"{CustomAgent(name=name).slug}.json"
|
||||
if path.exists():
|
||||
try:
|
||||
|
||||
@@ -18,18 +18,15 @@ _MAX_BYTES = 200_000
|
||||
|
||||
|
||||
def icons_dir() -> Path:
|
||||
"""Thư mục chứa icon do người dùng thêm."""
|
||||
return ICONS_DIR
|
||||
|
||||
|
||||
def slugify(name: str) -> str:
|
||||
"""Định danh an toàn cho tên file icon; rỗng thì trả về 'icon'."""
|
||||
s = "".join(c if (c.isalnum() or c in "-_") else "-" for c in (name or "").strip().lower())
|
||||
return "-".join(filter(None, s.split("-"))) or "icon"
|
||||
|
||||
|
||||
def list_custom(directory: Optional[Path] = None) -> List[str]:
|
||||
"""Tên các icon tự thêm; thư mục chưa có thì trả list rỗng."""
|
||||
directory = directory or ICONS_DIR
|
||||
if not directory.exists():
|
||||
return []
|
||||
@@ -72,7 +69,6 @@ def add_from_file(path, name: str = "", directory: Optional[Path] = None) -> str
|
||||
|
||||
|
||||
def delete_custom(name: str, directory: Optional[Path] = None) -> None:
|
||||
"""Xoá một icon tự thêm; không có thì bỏ qua."""
|
||||
directory = directory or ICONS_DIR
|
||||
path = directory / f"{slugify(name)}.svg"
|
||||
if path.exists():
|
||||
|
||||
@@ -18,7 +18,6 @@ _CDN_D3 = '<script src="https://cdnjs.cloudflare.com/ajax/libs/d3/7.8.5/d3.min.j
|
||||
|
||||
|
||||
def build_html(graph) -> str:
|
||||
"""Dựng trang HTML D3 cho đồ thị: nhét dữ liệu node/cạnh vào bản mẫu."""
|
||||
html = TEMPLATE.read_text(encoding="utf-8")
|
||||
|
||||
# Inline a bundled d3 (offline) if present; else keep the CDN reference.
|
||||
|
||||
+5
-37
@@ -29,7 +29,6 @@ _ACTIVE_PIDS: set[int] = set()
|
||||
|
||||
|
||||
def active_pids() -> List[int]:
|
||||
"""Pid của các tiến trình con đang chạy — dùng để dọn sạch khi thoát app."""
|
||||
with _active_pids_lock:
|
||||
return sorted(_ACTIVE_PIDS)
|
||||
|
||||
@@ -91,7 +90,6 @@ def run_cancellable(
|
||||
on_output: Optional[Callable[[str], None]] = None,
|
||||
env: Optional[Dict[str, str]] = None,
|
||||
limits: Optional[Dict[str, float]] = None,
|
||||
isolate_network: bool = False,
|
||||
) -> Tuple[Optional[int], str, bool, bool, bool]:
|
||||
"""Run a subprocess so the Stop button can actually interrupt it.
|
||||
|
||||
@@ -118,27 +116,17 @@ def run_cancellable(
|
||||
a failure to create/assign the job just means the existing taskkill
|
||||
fallback is used, same as before this was added.
|
||||
|
||||
``isolate_network`` runs ``args`` as a shell command that the OS keeps
|
||||
off the network (see ``infrastructure/sandbox/network_isolation.py``);
|
||||
if that isolation cannot be set up the command is NOT run.
|
||||
|
||||
Returns ``(returncode, combined_output, cancelled, timed_out,
|
||||
resource_exceeded)``; on a failure to even launch the process,
|
||||
``returncode`` is ``None`` and the output holds the launch error."""
|
||||
cancel = cancel or (lambda: False)
|
||||
popen_kwargs = {} if sys.platform == "win32" else {"start_new_session": True}
|
||||
try:
|
||||
if isolate_network:
|
||||
from ..infrastructure.sandbox.network_isolation import spawn_without_network
|
||||
|
||||
command = args if isinstance(args, str) else subprocess.list2cmdline(args)
|
||||
proc = spawn_without_network(command, cwd, env)
|
||||
else:
|
||||
proc = subprocess.Popen(
|
||||
args, shell=shell, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
|
||||
text=True, bufsize=1, env=env, **popen_kwargs,
|
||||
)
|
||||
except (OSError, RuntimeError) as exc: # RuntimeError: NetworkIsolationUnavailable
|
||||
proc = subprocess.Popen(
|
||||
args, shell=shell, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
|
||||
text=True, bufsize=1, env=env, **popen_kwargs,
|
||||
)
|
||||
except OSError as exc:
|
||||
return None, str(exc), False, False, False
|
||||
|
||||
with _active_pids_lock:
|
||||
@@ -154,11 +142,6 @@ def _run_cancellable_body(
|
||||
proc: "subprocess.Popen", cancel: CancelFn, timeout: Optional[float],
|
||||
on_output: Optional[Callable[[str], None]], limits: Optional[Dict[str, float]],
|
||||
) -> Tuple[Optional[int], str, bool, bool, bool]:
|
||||
"""Chạy một tiến trình con có thể huỷ giữa chừng, có hạn giờ và có giới hạn tài nguyên.
|
||||
|
||||
Trên Windows gắn tiến trình vào một Job Object để khi giết là giết cả cây
|
||||
tiến trình con — giết mỗi tiến trình cha sẽ để lại đám con mồ côi.
|
||||
"""
|
||||
job_handle = None
|
||||
if sys.platform == "win32":
|
||||
from .win_job import assign_process, create_job_object
|
||||
@@ -175,11 +158,6 @@ def _run_cancellable_body(
|
||||
collected: Dict[str, list] = {"out": [], "err": []}
|
||||
|
||||
def _read_stream(stream, key: str) -> None:
|
||||
"""Đọc một luồng đầu ra theo từng dòng ở luồng riêng.
|
||||
|
||||
Phải đọc song song stdout và stderr: đọc lần lượt sẽ kẹt khi tiến trình con
|
||||
làm đầy bộ đệm của luồng còn lại.
|
||||
"""
|
||||
try:
|
||||
for line in iter(stream.readline, ""):
|
||||
collected[key].append(line)
|
||||
@@ -261,7 +239,6 @@ def network_blocked_env(base_env: Optional[Dict[str, str]] = None) -> Dict[str,
|
||||
|
||||
def _can_pip() -> bool:
|
||||
# A PyInstaller/py2exe build has no usable pip; don't attempt installs there.
|
||||
"""Bản đóng gói (PyInstaller) không có pip dùng được — đừng thử cài gì ở đó."""
|
||||
return not getattr(sys, "frozen", False)
|
||||
|
||||
|
||||
@@ -277,10 +254,6 @@ def ensure_module(module: str, package: str | None = None):
|
||||
pkg = package or module
|
||||
if pkg in _FAILED or not _can_pip():
|
||||
return None
|
||||
from ..application.network import network_guard
|
||||
|
||||
if network_guard.is_blocked():
|
||||
return None # not cached in _FAILED: retried once the network is back
|
||||
ok, _ = pip_install(pkg)
|
||||
if not ok:
|
||||
_FAILED.add(pkg)
|
||||
@@ -294,7 +267,6 @@ def ensure_module(module: str, package: str | None = None):
|
||||
|
||||
|
||||
def venv_python_path(venv_dir: Path) -> Path:
|
||||
"""Đường dẫn tới ``python`` trong một virtualenv, khác nhau giữa Windows và POSIX."""
|
||||
return venv_dir / ("Scripts/python.exe" if sys.platform == "win32" else "bin/python")
|
||||
|
||||
|
||||
@@ -354,10 +326,6 @@ def pip_install(package: str, cancel: Optional[CancelFn] = None,
|
||||
name) is NOT retried, since repeating it would just waste time."""
|
||||
if not _can_pip():
|
||||
return False, "This packaged build can't install packages at runtime."
|
||||
from ..application.network import network_guard
|
||||
|
||||
if network_guard.is_blocked():
|
||||
return False, network_guard.refusal(f"pip install {package}")
|
||||
exe = python or sys.executable
|
||||
attempt = 0
|
||||
while True:
|
||||
|
||||
+8
-40
@@ -23,7 +23,6 @@ IMAGE_EXTS = {".png", ".jpg", ".jpeg", ".gif", ".bmp", ".webp", ".tiff", ".tif",
|
||||
|
||||
|
||||
def is_image(path) -> bool:
|
||||
"""Đuôi tệp này có phải ảnh không."""
|
||||
return Path(path).suffix.lower() in IMAGE_EXTS
|
||||
|
||||
|
||||
@@ -94,28 +93,17 @@ def find_input_files(folder: Path, exts: set[str] | None = None,
|
||||
capped at ``max_files`` (0 = unlimited), ``total_matched`` is the count
|
||||
before that cap, so a caller can report how many were skipped."""
|
||||
exts = exts or INPUT_EXTS
|
||||
# Do not sort an unbounded recursive tree merely to return a small prefix.
|
||||
# The caller receives a stable lexical order for the bounded result, while
|
||||
# traversal stops as soon as the configured file budget is reached.
|
||||
files: list[Path] = []
|
||||
total = 0
|
||||
try:
|
||||
for f in folder.rglob("*"):
|
||||
if not f.is_file():
|
||||
continue
|
||||
try:
|
||||
relative = f.relative_to(folder)
|
||||
except ValueError:
|
||||
continue
|
||||
if any(part.startswith(".") for part in relative.parts) or f.suffix.lower() not in exts:
|
||||
continue
|
||||
total += 1
|
||||
if max_files <= 0 or len(files) < max_files:
|
||||
files.append(f)
|
||||
matched = sorted(
|
||||
f for f in folder.rglob("*")
|
||||
if f.is_file()
|
||||
and not any(part.startswith(".") for part in f.relative_to(folder).parts)
|
||||
and f.suffix.lower() in exts
|
||||
)
|
||||
except OSError:
|
||||
return [], 0
|
||||
files.sort(key=lambda p: str(p).lower())
|
||||
return files, total
|
||||
files = matched if max_files <= 0 else matched[:max_files]
|
||||
return files, len(matched)
|
||||
|
||||
|
||||
def find_soffice() -> str | None:
|
||||
@@ -176,10 +164,6 @@ def extract_text(path, progress=None) -> tuple[str | None, str]:
|
||||
# Office Open XML (docx / xlsx / pptx)
|
||||
# --------------------------------------------------------------------------
|
||||
def _docx(p: Path) -> str:
|
||||
"""Trích văn bản từ .docx bằng cách đọc thẳng XML trong gói zip.
|
||||
|
||||
Không cần thư viện ngoài — .docx vốn là một file zip chứa XML.
|
||||
"""
|
||||
with zipfile.ZipFile(p) as z:
|
||||
xml = z.read("word/document.xml").decode("utf-8", "replace")
|
||||
out: list[str] = []
|
||||
@@ -195,7 +179,6 @@ def _docx(p: Path) -> str:
|
||||
|
||||
|
||||
def _pptx(p: Path) -> str:
|
||||
"""Trích văn bản từ .pptx, đi theo đúng thứ tự slide."""
|
||||
out: list[str] = []
|
||||
with zipfile.ZipFile(p) as z:
|
||||
slides = [n for n in z.namelist() if re.match(r"ppt/slides/slide\d+\.xml$", n)]
|
||||
@@ -209,11 +192,6 @@ def _pptx(p: Path) -> str:
|
||||
|
||||
|
||||
def _xlsx(p: Path) -> str:
|
||||
"""Trích văn bản từ .xlsx, có phân giải bảng chuỗi dùng chung.
|
||||
|
||||
Excel lưu chuỗi trong một bảng riêng và ô chỉ giữ chỉ số — đọc thẳng ô sẽ ra
|
||||
toàn số.
|
||||
"""
|
||||
with zipfile.ZipFile(p) as z:
|
||||
names = z.namelist()
|
||||
shared: list[str] = []
|
||||
@@ -257,7 +235,6 @@ def _xlsx(p: Path) -> str:
|
||||
# OpenDocument (odt / ods / odp)
|
||||
# --------------------------------------------------------------------------
|
||||
def _odf(p: Path) -> str:
|
||||
"""Trích văn bản từ tài liệu OpenDocument (.odt/.ods/.odp)."""
|
||||
with zipfile.ZipFile(p) as z:
|
||||
xml = z.read("content.xml").decode("utf-8", "replace")
|
||||
xml = re.sub(r"<text:line-break\s*/>", "\n", xml)
|
||||
@@ -272,10 +249,6 @@ def _odf(p: Path) -> str:
|
||||
# PDF + LibreOffice fallback
|
||||
# --------------------------------------------------------------------------
|
||||
def _pdf(p: Path, progress=None) -> tuple[str | None, str]:
|
||||
"""Trích văn bản từ PDF bằng ``pypdf``, tự cài nếu thiếu.
|
||||
|
||||
Trả về (văn bản, ghi chú); văn bản là ``None`` khi không trích được.
|
||||
"""
|
||||
from .deps import ensure_module
|
||||
|
||||
# Auto-install pypdf when missing (no manual install needed); fall back to
|
||||
@@ -396,11 +369,6 @@ def _office_com_to_pdf(src: Path, pdf: Path) -> str | None:
|
||||
|
||||
|
||||
def _soffice_to_text(p: Path) -> tuple[str | None, str]:
|
||||
"""Cách dự phòng cuối: nhờ LibreOffice chuyển tài liệu sang văn bản.
|
||||
|
||||
Dùng cho định dạng không có bộ đọc riêng; không cài LibreOffice thì trả về
|
||||
lý do để chỗ gọi hiện ra.
|
||||
"""
|
||||
soffice = find_soffice()
|
||||
if not soffice:
|
||||
return None, "no extractor available (install LibreOffice)"
|
||||
|
||||
@@ -21,10 +21,6 @@ _RUN_PREVIEW_CHARS = 40
|
||||
|
||||
|
||||
def _run_style(font) -> str:
|
||||
"""Mô tả định dạng một đoạn chữ (đậm, nghiêng, cỡ, màu) thành chuỗi ngắn.
|
||||
|
||||
Dùng để AI sửa tài liệu mà vẫn giữ được định dạng gốc.
|
||||
"""
|
||||
bits: list[str] = []
|
||||
try:
|
||||
if font.name:
|
||||
|
||||
@@ -79,7 +79,6 @@ def new_connector(category: str, preset_id: str = "", name: str = "") -> Dict[st
|
||||
|
||||
|
||||
def _redact(entry: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Bản sao đã che các trường nhạy cảm (khoá, token) — dùng khi ghi log/kiểm toán."""
|
||||
out = dict(entry)
|
||||
for k in _SENSITIVE_KEYS:
|
||||
if out.get(k):
|
||||
@@ -93,11 +92,6 @@ class RestApiConnector:
|
||||
vendor documents without this app knowing that vendor's API shape."""
|
||||
|
||||
def __init__(self, entry: Dict[str, Any]):
|
||||
"""Đọc một khai báo connector REST.
|
||||
|
||||
``base_url`` luôn được chuẩn hoá thành có đúng một dấu ``/`` ở cuối, để ghép
|
||||
đường dẫn về sau không sinh ra ``//`` hay dính liền.
|
||||
"""
|
||||
self.id = entry.get("id") or entry.get("name", "")
|
||||
self.display_name = entry.get("name") or self.id
|
||||
self.base_url = (entry.get("base_url") or "").rstrip("/") + "/"
|
||||
@@ -106,9 +100,6 @@ class RestApiConnector:
|
||||
self.auth_scheme = entry.get("auth_scheme") or "Bearer"
|
||||
|
||||
def tool_spec(self) -> ToolSpec:
|
||||
"""Khai báo tool để đưa cho model; tên tool có tiền tố là id connector nên hai
|
||||
connector không đụng tên nhau.
|
||||
"""
|
||||
return ToolSpec(
|
||||
name=f"{self.id}{_SEP}http_request",
|
||||
description=(
|
||||
@@ -131,12 +122,8 @@ class RestApiConnector:
|
||||
)
|
||||
|
||||
def call(self, args: Dict[str, Any]) -> Dict[str, Any]:
|
||||
"""Gọi API theo tham số model đưa ra, đi qua lớp TLS có ghim chứng chỉ nội bộ."""
|
||||
from ..application.network import network_guard
|
||||
from .tls_trust import request_any_method as tls_request
|
||||
|
||||
if network_guard.is_blocked():
|
||||
return {"ok": False, "output": network_guard.refusal(self.display_name)}
|
||||
method = str(args.get("method", "GET")).upper()
|
||||
path = str(args.get("path", "")).lstrip("/")
|
||||
url = urljoin(self.base_url, path)
|
||||
@@ -166,14 +153,10 @@ class RestApiConnector:
|
||||
return {"ok": ok, "output": f"HTTP {resp.status_code}\n{text}"}
|
||||
|
||||
def test_connection(self) -> Tuple[bool, str]:
|
||||
"""Thử kết nối tới endpoint; trả về (thành công, thông điệp)."""
|
||||
from ..application.network import network_guard
|
||||
from .tls_trust import request as tls_request
|
||||
|
||||
if not self.base_url.strip("/"):
|
||||
return False, "No base URL configured."
|
||||
if network_guard.is_blocked():
|
||||
return False, network_guard.refusal(self.display_name)
|
||||
headers = {}
|
||||
if self.api_key:
|
||||
headers[self.auth_header] = (
|
||||
|
||||
@@ -30,7 +30,6 @@ class SubAgent:
|
||||
|
||||
@dataclass
|
||||
class FlowStep:
|
||||
"""Một bước trong luồng cũ: prompt, skill áp dụng, và danh sách agent chạy song song."""
|
||||
name: str
|
||||
prompt: str = ""
|
||||
skill: str = "" # skill name to apply on this step ("" = none)
|
||||
@@ -45,13 +44,11 @@ class FlowStep:
|
||||
|
||||
@property
|
||||
def is_parallel(self) -> bool:
|
||||
"""Bước này có chạy nhiều agent song song hay không."""
|
||||
return bool(self.parallel_agents)
|
||||
|
||||
|
||||
@dataclass
|
||||
class Flow:
|
||||
"""Một luồng cũ: tên, mô tả, và danh sách bước chạy tuần tự."""
|
||||
name: str
|
||||
description: str = ""
|
||||
steps: List[FlowStep] = field(default_factory=list)
|
||||
@@ -80,11 +77,6 @@ class FlowRunStatus:
|
||||
substeps: List[dict] = field(default_factory=list)
|
||||
|
||||
def state_of(self, i: int) -> str:
|
||||
"""Trạng thái hiển thị của bước thứ ``i``: xong, đang chạy, lỗi hay còn chờ.
|
||||
|
||||
Chỉ bước ngay TRƯỚC con trỏ mới được đánh dấu lỗi — các bước xong trước đó
|
||||
vẫn là xong.
|
||||
"""
|
||||
if i < self.done:
|
||||
if self.last_error and i == self.done - 1:
|
||||
return STEP_ERROR
|
||||
@@ -105,13 +97,11 @@ class FlowRunStatus:
|
||||
|
||||
|
||||
def _slug(name: str) -> str:
|
||||
"""Định danh an toàn cho tên file, suy từ tên luồng."""
|
||||
s = "".join(c if (c.isalnum() or c in "-_") else "-" for c in name.strip().lower())
|
||||
return "-".join(filter(None, s.split("-"))) or "flow"
|
||||
|
||||
|
||||
def flows_dir() -> Path:
|
||||
"""Thư mục chứa file luồng cũ."""
|
||||
return FLOWS_DIR
|
||||
|
||||
|
||||
@@ -136,13 +126,11 @@ def default_req_to_demo() -> Flow:
|
||||
|
||||
|
||||
def to_dict(flow: Flow) -> dict:
|
||||
"""Chuyển một luồng thành dict để ghi JSON."""
|
||||
return {"name": flow.name, "description": flow.description,
|
||||
"steps": [asdict(s) for s in flow.steps]}
|
||||
|
||||
|
||||
def from_dict(data: dict) -> Flow:
|
||||
"""Dựng :class:`Flow` từ dict đọc trên đĩa, lọc bỏ khoá lạ."""
|
||||
steps = []
|
||||
for raw in data.get("steps", []):
|
||||
raw = dict(raw)
|
||||
@@ -154,7 +142,6 @@ def from_dict(data: dict) -> Flow:
|
||||
|
||||
|
||||
def list_flows(directory: Path = FLOWS_DIR) -> List[Flow]:
|
||||
"""Liệt kê mọi luồng đã lưu; thư mục chưa có thì trả list rỗng."""
|
||||
if not directory.exists():
|
||||
return []
|
||||
flows: List[Flow] = []
|
||||
@@ -167,11 +154,6 @@ def list_flows(directory: Path = FLOWS_DIR) -> List[Flow]:
|
||||
|
||||
|
||||
def save_flow(flow: Flow, directory: Path = FLOWS_DIR, old_name: str = "") -> Path:
|
||||
"""Ghi một luồng xuống đĩa.
|
||||
|
||||
Đổi tên thì XOÁ file cũ trước — tên file suy từ tên luồng, không xoá sẽ để
|
||||
lại một bản sao dưới tên cũ.
|
||||
"""
|
||||
directory.mkdir(parents=True, exist_ok=True)
|
||||
if old_name and old_name != flow.name:
|
||||
delete_flow(old_name, directory)
|
||||
@@ -181,7 +163,6 @@ def save_flow(flow: Flow, directory: Path = FLOWS_DIR, old_name: str = "") -> Pa
|
||||
|
||||
|
||||
def delete_flow(name: str, directory: Path = FLOWS_DIR) -> None:
|
||||
"""Xoá file luồng theo tên; không có thì bỏ qua."""
|
||||
path = directory / f"{_slug(name)}.json"
|
||||
if path.exists():
|
||||
try:
|
||||
@@ -288,23 +269,19 @@ class FlowRunner:
|
||||
|
||||
@property
|
||||
def step_index(self) -> int:
|
||||
"""Chỉ số bước đang chạy."""
|
||||
return self._index
|
||||
|
||||
def current_step(self) -> Optional[FlowStep]:
|
||||
"""Bước đang chạy; ``None`` khi đã hết bước."""
|
||||
if 0 <= self._index < len(self.flow.steps):
|
||||
return self.flow.steps[self._index]
|
||||
return None
|
||||
|
||||
def start(self) -> FlowAction:
|
||||
"""Bắt đầu chạy luồng và trả về hành động đầu tiên cần thực hiện."""
|
||||
if self.current_step() is None:
|
||||
return FlowAction(kind="done")
|
||||
return self._step_action()
|
||||
|
||||
def _step_action(self) -> FlowAction:
|
||||
"""Hành động cho bước hiện tại: chạy một agent, hay chia ra nhiều agent song song."""
|
||||
step = self.current_step()
|
||||
self._phase = "step"
|
||||
if step.is_parallel:
|
||||
@@ -349,7 +326,6 @@ class FlowRunner:
|
||||
return self._advance(compact=compact)
|
||||
|
||||
def _advance(self, compact: bool) -> FlowAction:
|
||||
"""Sang bước kế tiếp; hết bước thì báo luồng đã xong."""
|
||||
self._index += 1
|
||||
if self.current_step() is None:
|
||||
return FlowAction(kind="done", compact=compact)
|
||||
|
||||
@@ -28,12 +28,6 @@ class GraphServer:
|
||||
"""Lazy singleton-per-instance localhost server for the D3 graph page."""
|
||||
|
||||
def __init__(self) -> None:
|
||||
"""Chuẩn bị máy chủ; chưa mở cổng nào.
|
||||
|
||||
Một token ngẫu nhiên được sinh ngay lúc này và mọi yêu cầu đều phải mang
|
||||
nó: máy chủ nghe trên localhost, nhưng mọi tiến trình khác trên cùng máy đều
|
||||
gọi được localhost.
|
||||
"""
|
||||
self._html = _PLACEHOLDER
|
||||
self._token = secrets.token_urlsafe(16)
|
||||
self._lock = threading.Lock()
|
||||
@@ -43,7 +37,6 @@ class GraphServer:
|
||||
|
||||
# ---- content / callbacks ----------------------------------------
|
||||
def set_html(self, html: str) -> None:
|
||||
"""Đặt nội dung HTML sẽ phục vụ; có khoá vì luồng nền ghi còn luồng HTTP đọc."""
|
||||
with self._lock:
|
||||
self._html = html
|
||||
|
||||
@@ -54,12 +47,10 @@ class GraphServer:
|
||||
# ---- lifecycle ----------------------------------------------------
|
||||
@property
|
||||
def running(self) -> bool:
|
||||
"""Máy chủ có đang chạy không."""
|
||||
return self._httpd is not None
|
||||
|
||||
@property
|
||||
def url(self) -> str:
|
||||
"""URL đầy đủ kèm token; '' nếu chưa chạy."""
|
||||
if self._httpd is None:
|
||||
return ""
|
||||
port = self._httpd.server_address[1]
|
||||
@@ -72,22 +63,14 @@ class GraphServer:
|
||||
server = self
|
||||
|
||||
class Handler(BaseHTTPRequestHandler):
|
||||
"""Handler HTTP: chỉ phục vụ đúng trang đồ thị, và chỉ khi token khớp."""
|
||||
def log_message(self, *_a) -> None: # keep the GUI console silent
|
||||
"""Tắt log của thư viện chuẩn — nếu không, console GUI bị ngập request."""
|
||||
pass
|
||||
|
||||
def _authorized(self, query: dict) -> bool:
|
||||
"""Kiểm token trong query, so sánh theo kiểu chống dò thời gian.
|
||||
|
||||
Máy chủ này nghe trên localhost nhưng vẫn cần token: mọi tiến trình khác
|
||||
trên cùng máy đều gọi được nó.
|
||||
"""
|
||||
supplied = (query.get("t") or [""])[0]
|
||||
return secrets.compare_digest(supplied, server._token)
|
||||
|
||||
def do_GET(self) -> None: # noqa: N802 - stdlib naming
|
||||
"""Trả trang đồ thị khi token đúng; sai token thì trả 403."""
|
||||
parsed = urlparse(self.path)
|
||||
query = parse_qs(parsed.query)
|
||||
if not self._authorized(query):
|
||||
@@ -125,7 +108,6 @@ class GraphServer:
|
||||
return self.url
|
||||
|
||||
def stop(self) -> None:
|
||||
"""Dừng máy chủ và giải phóng cổng."""
|
||||
httpd, self._httpd = self._httpd, None
|
||||
if httpd is not None:
|
||||
httpd.shutdown()
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user