Compare commits
137 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e60621d519 | |||
| f7a6ca8364 | |||
| 2540acd5f7 | |||
| 092bf13f5e | |||
| fe2595a05c | |||
| 718dddde75 | |||
| 679ca657ee | |||
| fa96acdf4b | |||
| 90299e2710 | |||
| 7dc0c7d01f | |||
| 809b341350 | |||
| b1aabe88b8 | |||
| 654354c624 | |||
| eef0a6e2da | |||
| b107444878 | |||
| 16aa51c9b3 | |||
| 133ffe7174 | |||
| f88970985a | |||
| 6572fa5b75 | |||
| 194bab4691 | |||
| 35f141fc48 | |||
| 0b6fa8b9e1 | |||
| 140907ce1d | |||
| 52718b0f23 | |||
| 563383c60f | |||
| 1b74d84590 | |||
| 823f3af98c | |||
| 13664e99e7 | |||
| 60e0abfdb8 | |||
| 616caa92b1 | |||
| 31a3c9a3de | |||
| b2704525a0 | |||
| ad6d934a5f | |||
| 5350b2fb24 | |||
| 29817c3b34 | |||
| e5b149068c | |||
| 85b7ed3cec | |||
| 24805200f0 | |||
| 722a9c4753 | |||
| d1baf7212b | |||
| 0948c7a4e1 | |||
| c3170f22da | |||
| 1193ac64dc | |||
| ab41de2961 | |||
| 3b3e8e1b0b | |||
| 4004fb849f | |||
| f467e613b6 | |||
| 00e0e9a49a | |||
| f0dd8cb0d2 | |||
| 7643a46fca | |||
| c4da0e8ca9 | |||
| 3acdf79beb | |||
| 2d068cc075 | |||
| 88e535269e | |||
| 888f7bfb9d | |||
| 055e4df049 | |||
| 1ced6e977c | |||
| f5088ed70d | |||
| 55e78de6fc | |||
| dd30e609f7 | |||
| 5fd2c581f6 | |||
| d7a3eff23e | |||
| ee06440205 | |||
| 7c68dd4ad4 | |||
| 29575c32f9 | |||
| ed90a2ee9d | |||
| 993fb0ff9d | |||
| ca2fb95ee6 | |||
| 117fa9b05d | |||
| 28474c47cb | |||
| 8049785de6 | |||
| 9ca68ffaaa | |||
| 0ffe5a73c1 | |||
| d3b59a7931 | |||
| e5416b539a | |||
| 72d4347adb | |||
| a283d4a02d | |||
| 5f8dac66e6 | |||
| 8bb14fa1a7 | |||
| 2a150f5d4a | |||
| 1c0051c1db | |||
| 144c9b2464 | |||
| 163121d327 | |||
| 19809800f1 | |||
| 6473d38917 | |||
| 4ceb18c6e4 | |||
| bbd0866374 | |||
| fd310582bd | |||
| fb2d99fd86 | |||
| db82b59254 | |||
| ddfc988bef | |||
| 5ff230eafd | |||
| 46d0c329c1 | |||
| a2aba23962 | |||
| 6dbdd4674f | |||
| 83039fa22c | |||
| 3d4f9a88fe | |||
| 1694c616ef | |||
| c6cdf200ce | |||
| 9735d73b83 | |||
| 48565664e0 | |||
| 76fad8b08d | |||
| 5664b9d413 | |||
| 6de9c7b43f | |||
| c1366cf559 | |||
| ef711a48b3 | |||
| 952059eb51 | |||
| 8128a3bc57 | |||
| 636053fb6d | |||
| f56d0b4869 | |||
| a2cb38f62b | |||
| 3aab2445a6 | |||
| f8fb8d6fb1 | |||
| 2d1f90d5dc | |||
| 3a672b39c7 | |||
| df5339b5d0 | |||
| 0eb6550cf4 | |||
| 0a379602b8 | |||
| 1fb5acee39 | |||
| 82c3dbbc6b | |||
| e97c8c9943 | |||
| 68d44f6755 | |||
| c2ff59a5b1 | |||
| 2f3744f807 | |||
| 52c8c06cf2 | |||
| 0cdecf7b30 | |||
| 3e461d9d08 | |||
| cf43584d24 | |||
| 6ff60f2af1 | |||
| a3bfea631c | |||
| aae59a8ba8 | |||
| 3ff15423d6 | |||
| c2f7be37b3 | |||
| 09a9209724 | |||
| b356a13da5 | |||
| ac9a6ee6a2 | |||
| 64e0f5329a |
@@ -0,0 +1,181 @@
|
|||||||
|
---
|
||||||
|
name: smoke-test
|
||||||
|
description: End-to-end smoke test skill for DeerFlow. Guides through: 1) Pulling latest code, 2) Docker OR Local installation and deployment (user preference, default to Local if Docker network issues), 3) Service availability verification, 4) Health check, 5) Final test report. Use when the user says "run smoke test", "smoke test deployment", "verify installation", "test service availability", "end-to-end test", or similar.
|
||||||
|
---
|
||||||
|
|
||||||
|
# DeerFlow Smoke Test Skill
|
||||||
|
|
||||||
|
This skill guides the Agent through DeerFlow's full end-to-end smoke test workflow, including code updates, deployment (supporting both Docker and local installation modes), service availability verification, and health checks.
|
||||||
|
|
||||||
|
## Deployment Mode Selection
|
||||||
|
|
||||||
|
This skill supports two deployment modes:
|
||||||
|
- **Local installation mode** (recommended, especially when network issues occur) - Run all services directly on the local machine
|
||||||
|
- **Docker mode** - Run all services inside Docker containers
|
||||||
|
|
||||||
|
**Selection strategy**:
|
||||||
|
- If the user explicitly asks for Docker mode, use Docker
|
||||||
|
- If network issues occur (such as slow image pulls), automatically switch to local mode
|
||||||
|
- Default to local mode whenever possible
|
||||||
|
|
||||||
|
## Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
smoke-test/
|
||||||
|
├── SKILL.md ← You are here - core workflow and logic
|
||||||
|
├── scripts/
|
||||||
|
│ ├── check_docker.sh ← Check the Docker environment
|
||||||
|
│ ├── check_local_env.sh ← Check local environment dependencies
|
||||||
|
│ ├── frontend_check.sh ← Frontend page smoke check
|
||||||
|
│ ├── pull_code.sh ← Pull the latest code
|
||||||
|
│ ├── deploy_docker.sh ← Docker deployment
|
||||||
|
│ ├── deploy_local.sh ← Local deployment
|
||||||
|
│ └── health_check.sh ← Service health check
|
||||||
|
├── references/
|
||||||
|
│ ├── SOP.md ← Standard operating procedure
|
||||||
|
│ └── troubleshooting.md ← Troubleshooting guide
|
||||||
|
└── templates/
|
||||||
|
├── report.local.template.md ← Local mode smoke test report template
|
||||||
|
└── report.docker.template.md ← Docker mode smoke test report template
|
||||||
|
```
|
||||||
|
|
||||||
|
## Standard Operating Procedure (SOP)
|
||||||
|
|
||||||
|
### Phase 1: Code Update Check
|
||||||
|
|
||||||
|
1. **Confirm current directory** - Verify that the current working directory is the DeerFlow project root
|
||||||
|
2. **Check Git status** - See whether there are uncommitted changes
|
||||||
|
3. **Pull the latest code** - Use `git pull origin main` to get the latest updates
|
||||||
|
4. **Confirm code update** - Verify that the latest code was pulled successfully
|
||||||
|
|
||||||
|
### Phase 2: Deployment Mode Selection and Environment Check
|
||||||
|
|
||||||
|
**Choose deployment mode**:
|
||||||
|
- Ask for user preference, or choose automatically based on network conditions
|
||||||
|
- Default to local installation mode
|
||||||
|
|
||||||
|
**Local mode environment check**:
|
||||||
|
1. **Check Node.js version** - Requires 22+
|
||||||
|
2. **Check pnpm** - Package manager
|
||||||
|
3. **Check uv** - Python package manager
|
||||||
|
4. **Check nginx** - Reverse proxy
|
||||||
|
5. **Check required ports** - Confirm that ports 2026, 3000, 8001, and 2024 are not occupied
|
||||||
|
|
||||||
|
**Docker mode environment check** (if Docker is selected):
|
||||||
|
1. **Check whether Docker is installed** - Run `docker --version`
|
||||||
|
2. **Check Docker daemon status** - Run `docker info`
|
||||||
|
3. **Check Docker Compose availability** - Run `docker compose version`
|
||||||
|
4. **Check required ports** - Confirm that port 2026 is not occupied
|
||||||
|
|
||||||
|
### Phase 3: Configuration Preparation
|
||||||
|
|
||||||
|
1. **Check whether config.yaml exists**
|
||||||
|
- If it does not exist, run `make config` to generate it
|
||||||
|
- If it already exists, check whether it needs an upgrade with `make config-upgrade`
|
||||||
|
2. **Check the .env file**
|
||||||
|
- Verify that required environment variables are configured
|
||||||
|
- Especially model API keys such as `OPENAI_API_KEY`
|
||||||
|
|
||||||
|
### Phase 4: Deployment Execution
|
||||||
|
|
||||||
|
**Local mode deployment**:
|
||||||
|
1. **Check dependencies** - Run `make check`
|
||||||
|
2. **Install dependencies** - Run `make install`
|
||||||
|
3. **(Optional) Pre-pull the sandbox image** - If needed, run `make setup-sandbox`
|
||||||
|
4. **Start services** - Run `make dev-daemon` (background mode, recommended) or `make dev` (foreground mode)
|
||||||
|
5. **Wait for startup** - Give all services enough time to start completely (90-120 seconds recommended)
|
||||||
|
|
||||||
|
**Docker mode deployment** (if Docker is selected):
|
||||||
|
1. **Initialize Docker environment** - Run `make docker-init`
|
||||||
|
2. **Start Docker services** - Run `make docker-start`
|
||||||
|
3. **Wait for startup** - Give all containers enough time to start completely (60 seconds recommended)
|
||||||
|
|
||||||
|
### Phase 5: Service Health Check
|
||||||
|
|
||||||
|
**Local mode health check**:
|
||||||
|
1. **Check process status** - Confirm that LangGraph, Gateway, Frontend, and Nginx processes are all running
|
||||||
|
2. **Check frontend service** - Visit `http://localhost:2026` and verify that the page loads
|
||||||
|
3. **Check API Gateway** - Verify the `http://localhost:2026/health` endpoint
|
||||||
|
4. **Check LangGraph service** - Verify the availability of relevant endpoints
|
||||||
|
5. **Frontend route smoke check** - Run `bash .agent/skills/smoke-test/scripts/frontend_check.sh` to verify key routes under `/workspace`
|
||||||
|
|
||||||
|
**Docker mode health check** (when using Docker):
|
||||||
|
1. **Check container status** - Run `docker ps` and confirm that all containers are running
|
||||||
|
2. **Check frontend service** - Visit `http://localhost:2026` and verify that the page loads
|
||||||
|
3. **Check API Gateway** - Verify the `http://localhost:2026/health` endpoint
|
||||||
|
4. **Check LangGraph service** - Verify the availability of relevant endpoints
|
||||||
|
5. **Frontend route smoke check** - Run `bash .agent/skills/smoke-test/scripts/frontend_check.sh` to verify key routes under `/workspace`
|
||||||
|
|
||||||
|
### Optional Functional Verification
|
||||||
|
|
||||||
|
1. **List available models** - Verify that model configuration loads correctly
|
||||||
|
2. **List available skills** - Verify that the skill directory is mounted correctly
|
||||||
|
3. **Simple chat test** - Send a simple message to verify the end-to-end flow
|
||||||
|
|
||||||
|
### Phase 6: Generate Test Report
|
||||||
|
|
||||||
|
1. **Collect all test results** - Summarize execution status for each phase
|
||||||
|
2. **Record encountered issues** - If anything fails, record the error details
|
||||||
|
3. **Generate the final report** - Use the template that matches the selected deployment mode to create the complete test report, including overall conclusion, detailed key test cases, and explicit frontend page / route results
|
||||||
|
4. **Provide follow-up recommendations** - Offer suggestions based on the test results
|
||||||
|
|
||||||
|
## Execution Rules
|
||||||
|
|
||||||
|
- **Follow the sequence** - Execute strictly in the order described above
|
||||||
|
- **Idempotency** - Every step should be safe to repeat
|
||||||
|
- **Error handling** - If a step fails, stop and report the issue, then provide troubleshooting suggestions
|
||||||
|
- **Detailed logging** - Record the execution result and status of each step
|
||||||
|
- **User confirmation** - Ask for confirmation before potentially risky operations such as overwriting config
|
||||||
|
- **Mode preference** - Prefer local mode to avoid network-related issues
|
||||||
|
- **Template requirement** - The final report must use the matching template under `templates/`; do not output a free-form summary instead of the template-based report
|
||||||
|
- **Report clarity** - The execution summary must include the overall pass/fail conclusion plus per-case result explanations, and frontend smoke check results must be listed explicitly in the report
|
||||||
|
- **Optional phase handling** - If functional verification is not executed, do not present it as a separate skipped phase in the final report
|
||||||
|
|
||||||
|
## Known Acceptable Warnings
|
||||||
|
|
||||||
|
The following warnings can appear during smoke testing and do not block a successful result:
|
||||||
|
- Feishu/Lark SSL errors in Gateway logs (certificate verification failure) can be ignored if that channel is not enabled
|
||||||
|
- Warnings in LangGraph logs about missing methods in the custom checkpointer, such as `adelete_for_runs` or `aprune`, do not affect the core functionality
|
||||||
|
|
||||||
|
## Key Tools
|
||||||
|
|
||||||
|
Use the following tools during execution:
|
||||||
|
|
||||||
|
1. **bash** - Run shell commands
|
||||||
|
2. **present_file** - Show generated reports and important files
|
||||||
|
3. **task_tool** - Organize complex steps with subtasks when needed
|
||||||
|
|
||||||
|
## Success Criteria
|
||||||
|
|
||||||
|
Smoke test pass criteria (local mode):
|
||||||
|
- [x] Latest code is pulled successfully
|
||||||
|
- [x] Local environment check passes (Node.js 22+, pnpm, uv, nginx)
|
||||||
|
- [x] Configuration files are set up correctly
|
||||||
|
- [x] `make check` passes
|
||||||
|
- [x] `make install` completes successfully
|
||||||
|
- [x] `make dev` starts successfully
|
||||||
|
- [x] All service processes run normally
|
||||||
|
- [x] Frontend page is accessible
|
||||||
|
- [x] Frontend route smoke check passes (`/workspace` key routes)
|
||||||
|
- [x] API Gateway health check passes
|
||||||
|
- [x] Test report is generated completely
|
||||||
|
|
||||||
|
Smoke test pass criteria (Docker mode):
|
||||||
|
- [x] Latest code is pulled successfully
|
||||||
|
- [x] Docker environment check passes
|
||||||
|
- [x] Configuration files are set up correctly
|
||||||
|
- [x] `make docker-init` completes successfully
|
||||||
|
- [x] `make docker-start` completes successfully
|
||||||
|
- [x] All Docker containers run normally
|
||||||
|
- [x] Frontend page is accessible
|
||||||
|
- [x] Frontend route smoke check passes (`/workspace` key routes)
|
||||||
|
- [x] API Gateway health check passes
|
||||||
|
- [x] Test report is generated completely
|
||||||
|
|
||||||
|
## Read Reference Files
|
||||||
|
|
||||||
|
Before starting execution, read the following reference files:
|
||||||
|
1. `references/SOP.md` - Detailed step-by-step operating instructions
|
||||||
|
2. `references/troubleshooting.md` - Common issues and solutions
|
||||||
|
3. `templates/report.local.template.md` - Local mode test report template
|
||||||
|
4. `templates/report.docker.template.md` - Docker mode test report template
|
||||||
@@ -0,0 +1,452 @@
|
|||||||
|
# DeerFlow Smoke Test Standard Operating Procedure (SOP)
|
||||||
|
|
||||||
|
This document describes the detailed operating steps for each phase of the DeerFlow smoke test.
|
||||||
|
|
||||||
|
## Phase 1: Code Update Check
|
||||||
|
|
||||||
|
### 1.1 Confirm Current Directory
|
||||||
|
|
||||||
|
**Objective**: Verify that the current working directory is the DeerFlow project root.
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `pwd` to view the current working directory
|
||||||
|
2. Check whether the directory contains the following files/directories:
|
||||||
|
- `Makefile`
|
||||||
|
- `backend/`
|
||||||
|
- `frontend/`
|
||||||
|
- `config.example.yaml`
|
||||||
|
|
||||||
|
**Success Criteria**: The current directory contains all of the files/directories listed above.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 1.2 Check Git Status
|
||||||
|
|
||||||
|
**Objective**: Check whether there are uncommitted changes.
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `git status`
|
||||||
|
2. Check whether the output includes "Changes not staged for commit" or "Untracked files"
|
||||||
|
|
||||||
|
**Notes**:
|
||||||
|
- If there are uncommitted changes, recommend that the user commit or stash them first to avoid conflicts while pulling
|
||||||
|
- If the user confirms that they want to continue, this step can be skipped
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 1.3 Pull the Latest Code
|
||||||
|
|
||||||
|
**Objective**: Fetch the latest code updates.
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `git fetch origin main`
|
||||||
|
2. Run `git pull origin main`
|
||||||
|
|
||||||
|
**Success Criteria**:
|
||||||
|
- The commands succeed without errors
|
||||||
|
- The output shows "Already up to date" or indicates that new commits were pulled successfully
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 1.4 Confirm Code Update
|
||||||
|
|
||||||
|
**Objective**: Verify that the latest code was pulled successfully.
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `git log -1 --oneline` to view the latest commit
|
||||||
|
2. Record the commit hash and message
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 2: Deployment Mode Selection and Environment Check
|
||||||
|
|
||||||
|
### 2.1 Choose Deployment Mode
|
||||||
|
|
||||||
|
**Objective**: Decide whether to use local mode or Docker mode.
|
||||||
|
|
||||||
|
**Decision Flow**:
|
||||||
|
1. Prefer local mode first to avoid network-related issues
|
||||||
|
2. If the user explicitly requests Docker, use Docker
|
||||||
|
3. If Docker network issues occur, switch to local mode automatically
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.2 Local Mode Environment Check
|
||||||
|
|
||||||
|
**Objective**: Verify that local development environment dependencies are satisfied.
|
||||||
|
|
||||||
|
#### 2.2.1 Check Node.js Version
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. If nvm is used, run `nvm use 22` to switch to Node 22+
|
||||||
|
2. Run `node --version`
|
||||||
|
|
||||||
|
**Success Criteria**: Version >= 22.x
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If the version is too low, ask the user to install/switch Node.js with nvm:
|
||||||
|
```bash
|
||||||
|
nvm install 22
|
||||||
|
nvm use 22
|
||||||
|
```
|
||||||
|
- Or install it from the official website: https://nodejs.org/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.2.2 Check pnpm
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `pnpm --version`
|
||||||
|
|
||||||
|
**Success Criteria**: The command returns pnpm version information.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If pnpm is not installed, ask the user to install it with `npm install -g pnpm`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.2.3 Check uv
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `uv --version`
|
||||||
|
|
||||||
|
**Success Criteria**: The command returns uv version information.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If uv is not installed, ask the user to install uv
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.2.4 Check nginx
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `nginx -v`
|
||||||
|
|
||||||
|
**Success Criteria**: The command returns nginx version information.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- macOS: install with Homebrew using `brew install nginx`
|
||||||
|
- Linux: install using the system package manager
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.2.5 Check Required Ports
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run the following commands to check ports:
|
||||||
|
```bash
|
||||||
|
lsof -i :2026 # Main port
|
||||||
|
lsof -i :3000 # Frontend
|
||||||
|
lsof -i :8001 # Gateway
|
||||||
|
lsof -i :2024 # LangGraph
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: All ports are free, or they are occupied only by DeerFlow-related processes.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If a port is occupied, ask the user to stop the related process
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2.3 Docker Mode Environment Check (If Docker Is Selected)
|
||||||
|
|
||||||
|
#### 2.3.1 Check Whether Docker Is Installed
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `docker --version`
|
||||||
|
|
||||||
|
**Success Criteria**: The command returns Docker version information, such as "Docker version 24.x.x".
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.3.2 Check Docker Daemon Status
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `docker info`
|
||||||
|
|
||||||
|
**Success Criteria**: The command runs successfully and shows Docker system information.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If it fails, ask the user to start Docker Desktop or the Docker service
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.3.3 Check Docker Compose Availability
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `docker compose version`
|
||||||
|
|
||||||
|
**Success Criteria**: The command returns Docker Compose version information.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 2.3.4 Check Required Ports
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `lsof -i :2026` (macOS/Linux) or `netstat -ano | findstr :2026` (Windows)
|
||||||
|
|
||||||
|
**Success Criteria**: Port 2026 is free, or it is occupied only by a DeerFlow-related process.
|
||||||
|
|
||||||
|
**Failure Handling**:
|
||||||
|
- If the port is occupied by another process, ask the user to stop that process or change the configuration
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 3: Configuration Preparation
|
||||||
|
|
||||||
|
### 3.1 Check config.yaml
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Check whether `config.yaml` exists
|
||||||
|
2. If it does not exist, run `make config`
|
||||||
|
3. If it already exists, consider running `make config-upgrade` to merge new fields
|
||||||
|
|
||||||
|
**Validation**:
|
||||||
|
- Check whether at least one model is configured in config.yaml
|
||||||
|
- Check whether the model configuration references the correct environment variables
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3.2 Check the .env File
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Check whether the `.env` file exists
|
||||||
|
2. If it does not exist, copy it from `.env.example`
|
||||||
|
3. Check whether the following environment variables are configured:
|
||||||
|
- `OPENAI_API_KEY` (or other model API keys)
|
||||||
|
- Other required settings
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 4: Deployment Execution
|
||||||
|
|
||||||
|
### 4.1 Local Mode Deployment
|
||||||
|
|
||||||
|
#### 4.1.1 Check Dependencies
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `make check`
|
||||||
|
|
||||||
|
**Description**: This command validates all required tools (Node.js 22+, pnpm, uv, nginx).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.1.2 Install Dependencies
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `make install`
|
||||||
|
|
||||||
|
**Description**: This command installs both backend and frontend dependencies.
|
||||||
|
|
||||||
|
**Notes**:
|
||||||
|
- This step may take some time
|
||||||
|
- If network issues cause failures, try using a closer or mirrored package registry
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.1.3 (Optional) Pre-pull the Sandbox Image
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. If Docker / Container sandbox is used, run `make setup-sandbox`
|
||||||
|
|
||||||
|
**Description**: This step is optional and not needed for local sandbox mode.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.1.4 Start Services
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `make dev-daemon` (background mode)
|
||||||
|
|
||||||
|
**Description**: This command starts all services (LangGraph, Gateway, Frontend, Nginx).
|
||||||
|
|
||||||
|
**Notes**:
|
||||||
|
- `make dev` runs in the foreground and stops with Ctrl+C
|
||||||
|
- `make dev-daemon` runs in the background
|
||||||
|
- Use `make stop` to stop services
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.1.5 Wait for Services to Start
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Wait 90-120 seconds for all services to start completely
|
||||||
|
2. You can monitor startup progress by checking these log files:
|
||||||
|
- `logs/langgraph.log`
|
||||||
|
- `logs/gateway.log`
|
||||||
|
- `logs/frontend.log`
|
||||||
|
- `logs/nginx.log`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4.2 Docker Mode Deployment (If Docker Is Selected)
|
||||||
|
|
||||||
|
#### 4.2.1 Initialize the Docker Environment
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `make docker-init`
|
||||||
|
|
||||||
|
**Description**: This command pulls the sandbox image if needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.2.2 Start Docker Services
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `make docker-start`
|
||||||
|
|
||||||
|
**Description**: This command builds and starts all required Docker containers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 4.2.3 Wait for Services to Start
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Wait 60-90 seconds for all services to start completely
|
||||||
|
2. You can run `make docker-logs` to monitor startup progress
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 5: Service Health Check
|
||||||
|
|
||||||
|
### 5.1 Local Mode Health Check
|
||||||
|
|
||||||
|
#### 5.1.1 Check Process Status
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run the following command to check processes:
|
||||||
|
```bash
|
||||||
|
ps aux | grep -E "(langgraph|uvicorn|next|nginx)" | grep -v grep
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: Confirm that the following processes are running:
|
||||||
|
- LangGraph (`langgraph dev`)
|
||||||
|
- Gateway (`uvicorn app.gateway.app:app`)
|
||||||
|
- Frontend (`next dev` or `next start`)
|
||||||
|
- Nginx (`nginx`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.1.2 Check Frontend Service
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Use curl or a browser to visit `http://localhost:2026`
|
||||||
|
2. Verify that the page loads normally
|
||||||
|
|
||||||
|
**Example curl command**:
|
||||||
|
```bash
|
||||||
|
curl -I http://localhost:2026
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: Returns an HTTP 200 status code.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.1.3 Check API Gateway
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Visit `http://localhost:2026/health`
|
||||||
|
|
||||||
|
**Example curl command**:
|
||||||
|
```bash
|
||||||
|
curl http://localhost:2026/health
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: Returns health status JSON.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.1.4 Check LangGraph Service
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Visit relevant LangGraph endpoints to verify availability
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5.2 Docker Mode Health Check (When Using Docker)
|
||||||
|
|
||||||
|
#### 5.2.1 Check Container Status
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Run `docker ps`
|
||||||
|
2. Confirm that the following containers are running:
|
||||||
|
- `deer-flow-nginx`
|
||||||
|
- `deer-flow-frontend`
|
||||||
|
- `deer-flow-gateway`
|
||||||
|
- `deer-flow-langgraph` (if not in gateway mode)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.2.2 Check Frontend Service
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Use curl or a browser to visit `http://localhost:2026`
|
||||||
|
2. Verify that the page loads normally
|
||||||
|
|
||||||
|
**Example curl command**:
|
||||||
|
```bash
|
||||||
|
curl -I http://localhost:2026
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: Returns an HTTP 200 status code.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.2.3 Check API Gateway
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Visit `http://localhost:2026/health`
|
||||||
|
|
||||||
|
**Example curl command**:
|
||||||
|
```bash
|
||||||
|
curl http://localhost:2026/health
|
||||||
|
```
|
||||||
|
|
||||||
|
**Success Criteria**: Returns health status JSON.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 5.2.4 Check LangGraph Service
|
||||||
|
|
||||||
|
**Steps**:
|
||||||
|
1. Visit relevant LangGraph endpoints to verify availability
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Optional Functional Verification
|
||||||
|
|
||||||
|
### 6.1 List Available Models
|
||||||
|
|
||||||
|
**Steps**: Verify the model list through the API or UI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6.2 List Available Skills
|
||||||
|
|
||||||
|
**Steps**: Verify the skill list through the API or UI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6.3 Simple Chat Test
|
||||||
|
|
||||||
|
**Steps**: Send a simple message to test the complete workflow.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase 6: Generate the Test Report
|
||||||
|
|
||||||
|
### 6.1 Collect Test Results
|
||||||
|
|
||||||
|
Summarize the execution status of each phase and record successful and failed items.
|
||||||
|
|
||||||
|
### 6.2 Record Issues
|
||||||
|
|
||||||
|
If anything fails, record detailed error information.
|
||||||
|
|
||||||
|
### 6.3 Generate the Report
|
||||||
|
|
||||||
|
Use the template to create a complete test report.
|
||||||
|
|
||||||
|
### 6.4 Provide Recommendations
|
||||||
|
|
||||||
|
Provide follow-up recommendations based on the test results.
|
||||||
@@ -0,0 +1,612 @@
|
|||||||
|
# Troubleshooting Guide
|
||||||
|
|
||||||
|
This document lists common issues encountered during DeerFlow smoke testing and how to resolve them.
|
||||||
|
|
||||||
|
## Code Update Issues
|
||||||
|
|
||||||
|
### Issue: `git pull` Fails with a Merge Conflict Warning
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
error: Your local changes to the following files would be overwritten by merge
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Option A: Commit local changes first
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "Save local changes"
|
||||||
|
git pull origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Option B: Stash local changes
|
||||||
|
```bash
|
||||||
|
git stash
|
||||||
|
git pull origin main
|
||||||
|
git stash pop # Restore changes later if needed
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Option C: Discard local changes (use with caution)
|
||||||
|
```bash
|
||||||
|
git reset --hard HEAD
|
||||||
|
git pull origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Local Mode Environment Issues
|
||||||
|
|
||||||
|
### Issue: Node.js Version Is Too Old
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
Node.js version is too old. Requires 22+, got x.x.x
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Install or upgrade Node.js with nvm:
|
||||||
|
```bash
|
||||||
|
nvm install 22
|
||||||
|
nvm use 22
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Or download and install it from the official website: https://nodejs.org/
|
||||||
|
|
||||||
|
3. Verify the version:
|
||||||
|
```bash
|
||||||
|
node --version
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: pnpm Is Not Installed
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
command not found: pnpm
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Install pnpm with npm:
|
||||||
|
```bash
|
||||||
|
npm install -g pnpm
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Or use the official installation script:
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://get.pnpm.io/install.sh | sh -
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Verify the installation:
|
||||||
|
```bash
|
||||||
|
pnpm --version
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: uv Is Not Installed
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
command not found: uv
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Use the official installation script:
|
||||||
|
```bash
|
||||||
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
2. macOS users can also install it with Homebrew:
|
||||||
|
```bash
|
||||||
|
brew install uv
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Verify the installation:
|
||||||
|
```bash
|
||||||
|
uv --version
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: nginx Is Not Installed
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
command not found: nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. macOS (Homebrew):
|
||||||
|
```bash
|
||||||
|
brew install nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Ubuntu/Debian:
|
||||||
|
```bash
|
||||||
|
sudo apt update
|
||||||
|
sudo apt install nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
3. CentOS/RHEL:
|
||||||
|
```bash
|
||||||
|
sudo yum install nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Verify the installation:
|
||||||
|
```bash
|
||||||
|
nginx -v
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Port Is Already in Use
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
Error: listen EADDRINUSE: address already in use :::2026
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Find the process using the port:
|
||||||
|
```bash
|
||||||
|
lsof -i :2026 # macOS/Linux
|
||||||
|
netstat -ano | findstr :2026 # Windows
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Stop that process:
|
||||||
|
```bash
|
||||||
|
kill -9 <PID> # macOS/Linux
|
||||||
|
taskkill /PID <PID> /F # Windows
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Or stop DeerFlow services first:
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Local Mode Dependency Installation Issues
|
||||||
|
|
||||||
|
### Issue: `make install` Fails Due to Network Timeout
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Network timeouts or connection failures occur during dependency installation.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Configure pnpm to use a mirror registry:
|
||||||
|
```bash
|
||||||
|
pnpm config set registry https://registry.npmmirror.com
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Configure uv to use a mirror registry:
|
||||||
|
```bash
|
||||||
|
uv pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Retry the installation:
|
||||||
|
```bash
|
||||||
|
make install
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Python Dependency Installation Fails
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Errors occur during `uv sync`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Clean the uv cache:
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
uv cache clean
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Resync dependencies:
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
uv sync
|
||||||
|
```
|
||||||
|
|
||||||
|
3. View detailed error logs:
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
uv sync --verbose
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Frontend Dependency Installation Fails
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Errors occur during `pnpm install`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Clean the pnpm cache:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
pnpm store prune
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Remove node_modules and the lock file:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
rm -rf node_modules pnpm-lock.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Reinstall:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Local Mode Service Startup Issues
|
||||||
|
|
||||||
|
### Issue: Services Exit Immediately After Startup
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Processes exit quickly after running `make dev-daemon`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check log files:
|
||||||
|
```bash
|
||||||
|
tail -f logs/langgraph.log
|
||||||
|
tail -f logs/gateway.log
|
||||||
|
tail -f logs/frontend.log
|
||||||
|
tail -f logs/nginx.log
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check whether config.yaml is configured correctly
|
||||||
|
3. Check environment variables in the .env file
|
||||||
|
4. Confirm that required ports are not occupied
|
||||||
|
5. Stop all services and restart:
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
make dev-daemon
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Nginx Fails to Start Because Temp Directories Do Not Exist
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
nginx: [emerg] mkdir() "/opt/homebrew/var/run/nginx/client_body_temp" failed (2: No such file or directory)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
Add local temp directory configuration to `docker/nginx/nginx.local.conf` so nginx uses the repository's temp directory.
|
||||||
|
|
||||||
|
Add the following at the beginning of the `http` block:
|
||||||
|
```nginx
|
||||||
|
client_body_temp_path temp/client_body_temp;
|
||||||
|
proxy_temp_path temp/proxy_temp;
|
||||||
|
fastcgi_temp_path temp/fastcgi_temp;
|
||||||
|
uwsgi_temp_path temp/uwsgi_temp;
|
||||||
|
scgi_temp_path temp/scgi_temp;
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: The `temp/` directory under the repository root is created automatically by `make dev` or `make dev-daemon`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Nginx Fails to Start (General)
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
The nginx process fails to start or reports an error.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check the nginx configuration:
|
||||||
|
```bash
|
||||||
|
nginx -t -c docker/nginx/nginx.local.conf -p .
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check nginx logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/nginx.log
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Ensure no other nginx process is running:
|
||||||
|
```bash
|
||||||
|
ps aux | grep nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
4. If needed, stop existing nginx processes:
|
||||||
|
```bash
|
||||||
|
pkill -9 nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Frontend Compilation Fails
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Compilation errors appear in `frontend.log`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check frontend logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/frontend.log
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check whether Node.js version is 22+
|
||||||
|
3. Reinstall frontend dependencies:
|
||||||
|
```bash
|
||||||
|
cd frontend
|
||||||
|
rm -rf node_modules .next
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Restart services:
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
make dev-daemon
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Gateway Fails to Start
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Errors appear in `gateway.log`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check gateway logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/gateway.log
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check whether config.yaml exists and has valid formatting
|
||||||
|
3. Check whether Python dependencies are complete:
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
uv sync
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Confirm that the LangGraph service is running normally (if not in gateway mode)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: LangGraph Fails to Start
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Errors appear in `langgraph.log`.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check LangGraph logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/langgraph.log
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check config.yaml
|
||||||
|
3. Check whether Python dependencies are complete
|
||||||
|
4. Confirm that port 2024 is not occupied
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Docker-Related Issues
|
||||||
|
|
||||||
|
### Issue: Docker Commands Cannot Run
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
Cannot connect to the Docker daemon
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Confirm that Docker Desktop is running
|
||||||
|
2. macOS: check whether the Docker icon appears in the top menu bar
|
||||||
|
3. Linux: run `sudo systemctl start docker`
|
||||||
|
4. Run `docker info` again to verify
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: `make docker-init` Fails to Pull the Image
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
Error pulling image: connection refused
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Check network connectivity
|
||||||
|
2. Configure a Docker image mirror if needed
|
||||||
|
3. Check whether a proxy is required
|
||||||
|
4. Switch to local installation mode if necessary (recommended)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Configuration File Issues
|
||||||
|
|
||||||
|
### Issue: config.yaml Is Missing or Invalid
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
```
|
||||||
|
Error: could not read config.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Regenerate the configuration file:
|
||||||
|
```bash
|
||||||
|
make config
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check YAML syntax:
|
||||||
|
- Make sure indentation is correct (use 2 spaces)
|
||||||
|
- Make sure there are no tab characters
|
||||||
|
- Check that there is a space after each colon
|
||||||
|
|
||||||
|
3. Use a YAML validation tool to check the format
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: Model API Key Is Not Configured
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
After services start, API requests fail with authentication errors.
|
||||||
|
|
||||||
|
**Solutions**:
|
||||||
|
1. Edit the .env file and add the API key:
|
||||||
|
```bash
|
||||||
|
OPENAI_API_KEY=your-actual-api-key-here
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Restart services (local mode):
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
make dev-daemon
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Restart services (Docker mode):
|
||||||
|
```bash
|
||||||
|
make docker-stop
|
||||||
|
make docker-start
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Confirm that the model configuration in config.yaml references the environment variable correctly
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Service Health Check Issues
|
||||||
|
|
||||||
|
### Issue: Frontend Page Is Not Accessible
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
The browser shows a connection failure when visiting http://localhost:2026.
|
||||||
|
|
||||||
|
**Solutions** (local mode):
|
||||||
|
1. Confirm that the nginx process is running:
|
||||||
|
```bash
|
||||||
|
ps aux | grep nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check nginx logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/nginx.log
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Check firewall settings
|
||||||
|
|
||||||
|
**Solutions** (Docker mode):
|
||||||
|
1. Confirm that the nginx container is running:
|
||||||
|
```bash
|
||||||
|
docker ps | grep nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Check nginx logs:
|
||||||
|
```bash
|
||||||
|
cd docker && docker compose -p deer-flow-dev -f docker-compose-dev.yaml logs nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Check firewall settings
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Issue: API Gateway Health Check Fails
|
||||||
|
|
||||||
|
**Symptoms**:
|
||||||
|
Accessing `/health` returns an error or times out.
|
||||||
|
|
||||||
|
**Solutions** (local mode):
|
||||||
|
1. Check gateway logs:
|
||||||
|
```bash
|
||||||
|
tail -f logs/gateway.log
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Confirm that config.yaml exists and has valid formatting
|
||||||
|
3. Check whether Python dependencies are complete
|
||||||
|
4. Confirm that the LangGraph service is running normally
|
||||||
|
|
||||||
|
**Solutions** (Docker mode):
|
||||||
|
1. Check gateway container logs:
|
||||||
|
```bash
|
||||||
|
make docker-logs-gateway
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Confirm that config.yaml is mounted correctly
|
||||||
|
3. Check whether Python dependencies are complete
|
||||||
|
4. Confirm that the LangGraph service is running normally
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Diagnostic Commands
|
||||||
|
|
||||||
|
### Local Mode Diagnostics
|
||||||
|
|
||||||
|
#### View All Service Processes
|
||||||
|
```bash
|
||||||
|
ps aux | grep -E "(langgraph|uvicorn|next|nginx)" | grep -v grep
|
||||||
|
```
|
||||||
|
|
||||||
|
#### View Service Logs
|
||||||
|
```bash
|
||||||
|
# View all logs
|
||||||
|
tail -f logs/*.log
|
||||||
|
|
||||||
|
# View specific service logs
|
||||||
|
tail -f logs/langgraph.log
|
||||||
|
tail -f logs/gateway.log
|
||||||
|
tail -f logs/frontend.log
|
||||||
|
tail -f logs/nginx.log
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Stop All Services
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Fully Reset the Local Environment
|
||||||
|
```bash
|
||||||
|
make stop
|
||||||
|
make clean
|
||||||
|
make config
|
||||||
|
make install
|
||||||
|
make dev-daemon
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Docker Mode Diagnostics
|
||||||
|
|
||||||
|
#### View All Container Status
|
||||||
|
```bash
|
||||||
|
docker ps -a
|
||||||
|
```
|
||||||
|
|
||||||
|
#### View Container Resource Usage
|
||||||
|
```bash
|
||||||
|
docker stats
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Enter a Container for Debugging
|
||||||
|
```bash
|
||||||
|
docker exec -it deer-flow-gateway sh
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Clean Up All DeerFlow-Related Containers and Images
|
||||||
|
```bash
|
||||||
|
make docker-stop
|
||||||
|
cd docker && docker compose -p deer-flow-dev -f docker-compose-dev.yaml down -v
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Fully Reset the Docker Environment
|
||||||
|
```bash
|
||||||
|
make docker-stop
|
||||||
|
make clean
|
||||||
|
make config
|
||||||
|
make docker-init
|
||||||
|
make docker-start
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Get More Help
|
||||||
|
|
||||||
|
If the solutions above do not resolve the issue:
|
||||||
|
1. Check the GitHub issues for the project: https://github.com/bytedance/deer-flow/issues
|
||||||
|
2. Review the project documentation: README.md and the `backend/docs/` directory
|
||||||
|
3. Open a new issue and include detailed error logs
|
||||||
+80
@@ -0,0 +1,80 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Checking Docker Environment"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check whether Docker is installed
|
||||||
|
if command -v docker >/dev/null 2>&1; then
|
||||||
|
echo "✓ Docker is installed"
|
||||||
|
docker --version
|
||||||
|
else
|
||||||
|
echo "✗ Docker is not installed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check the Docker daemon
|
||||||
|
if docker info >/dev/null 2>&1; then
|
||||||
|
echo "✓ Docker daemon is running normally"
|
||||||
|
else
|
||||||
|
echo "✗ Docker daemon is not running"
|
||||||
|
echo " Please start Docker Desktop or the Docker service"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check Docker Compose
|
||||||
|
if docker compose version >/dev/null 2>&1; then
|
||||||
|
echo "✓ Docker Compose is available"
|
||||||
|
docker compose version
|
||||||
|
else
|
||||||
|
echo "✗ Docker Compose is not available"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check port 2026
|
||||||
|
if ! command -v lsof >/dev/null 2>&1; then
|
||||||
|
echo "✗ lsof is required to check whether port 2026 is available"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
port_2026_usage="$(lsof -nP -iTCP:2026 -sTCP:LISTEN 2>/dev/null || true)"
|
||||||
|
if [ -n "$port_2026_usage" ]; then
|
||||||
|
echo "⚠ Port 2026 is already in use"
|
||||||
|
echo " Occupying process:"
|
||||||
|
echo "$port_2026_usage"
|
||||||
|
|
||||||
|
deerflow_process_found=0
|
||||||
|
while IFS= read -r pid; do
|
||||||
|
if [ -z "$pid" ]; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
process_command="$(ps -p "$pid" -o command= 2>/dev/null || true)"
|
||||||
|
case "$process_command" in
|
||||||
|
*[Dd]eer[Ff]low*|*[Dd]eerflow*|*[Nn]ginx*deerflow*|*deerflow/*[Nn]ginx*)
|
||||||
|
deerflow_process_found=1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done <<EOF
|
||||||
|
$(printf '%s\n' "$port_2026_usage" | awk 'NR > 1 {print $2}')
|
||||||
|
EOF
|
||||||
|
|
||||||
|
if [ "$deerflow_process_found" -eq 1 ]; then
|
||||||
|
echo "✓ Port 2026 is occupied by DeerFlow"
|
||||||
|
else
|
||||||
|
echo "✗ Port 2026 must be free before starting DeerFlow"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "✓ Port 2026 is available"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Docker Environment Check Complete"
|
||||||
|
echo "=========================================="
|
||||||
+93
@@ -0,0 +1,93 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Checking Local Development Environment"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
all_passed=true
|
||||||
|
|
||||||
|
# Check Node.js
|
||||||
|
echo "1. Checking Node.js..."
|
||||||
|
if command -v node >/dev/null 2>&1; then
|
||||||
|
NODE_VERSION=$(node --version | sed 's/v//')
|
||||||
|
NODE_MAJOR=$(echo "$NODE_VERSION" | cut -d. -f1)
|
||||||
|
if [ "$NODE_MAJOR" -ge 22 ]; then
|
||||||
|
echo "✓ Node.js is installed (version: $NODE_VERSION)"
|
||||||
|
else
|
||||||
|
echo "✗ Node.js version is too old (current: $NODE_VERSION, required: 22+)"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "✗ Node.js is not installed"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check pnpm
|
||||||
|
echo "2. Checking pnpm..."
|
||||||
|
if command -v pnpm >/dev/null 2>&1; then
|
||||||
|
echo "✓ pnpm is installed (version: $(pnpm --version))"
|
||||||
|
else
|
||||||
|
echo "✗ pnpm is not installed"
|
||||||
|
echo " Install command: npm install -g pnpm"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check uv
|
||||||
|
echo "3. Checking uv..."
|
||||||
|
if command -v uv >/dev/null 2>&1; then
|
||||||
|
echo "✓ uv is installed (version: $(uv --version))"
|
||||||
|
else
|
||||||
|
echo "✗ uv is not installed"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check nginx
|
||||||
|
echo "4. Checking nginx..."
|
||||||
|
if command -v nginx >/dev/null 2>&1; then
|
||||||
|
echo "✓ nginx is installed (version: $(nginx -v 2>&1))"
|
||||||
|
else
|
||||||
|
echo "✗ nginx is not installed"
|
||||||
|
echo " macOS: brew install nginx"
|
||||||
|
echo " Linux: install it with the system package manager"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check ports
|
||||||
|
echo "5. Checking ports..."
|
||||||
|
if ! command -v lsof >/dev/null 2>&1; then
|
||||||
|
echo "✗ lsof is not installed, so port availability cannot be verified"
|
||||||
|
echo " Install lsof and rerun this check"
|
||||||
|
all_passed=false
|
||||||
|
else
|
||||||
|
for port in 2026 3000 8001 2024; do
|
||||||
|
if lsof -i :$port >/dev/null 2>&1; then
|
||||||
|
echo "⚠ Port $port is already in use:"
|
||||||
|
lsof -i :$port | head -2
|
||||||
|
all_passed=false
|
||||||
|
else
|
||||||
|
echo "✓ Port $port is available"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Environment Check Summary"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
if [ "$all_passed" = true ]; then
|
||||||
|
echo "✅ All environment checks passed!"
|
||||||
|
echo ""
|
||||||
|
echo "Next step: run make install to install dependencies"
|
||||||
|
exit 0
|
||||||
|
else
|
||||||
|
echo "❌ Some checks failed. Please fix the issues above first"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
+65
@@ -0,0 +1,65 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Docker Deployment"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check config.yaml
|
||||||
|
if [ ! -f "config.yaml" ]; then
|
||||||
|
echo "config.yaml does not exist. Generating it..."
|
||||||
|
make config
|
||||||
|
echo ""
|
||||||
|
echo "⚠ Please edit config.yaml to configure your models and API keys"
|
||||||
|
echo " Then run this script again"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "✓ config.yaml exists"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check the .env file
|
||||||
|
if [ ! -f ".env" ]; then
|
||||||
|
echo ".env does not exist. Copying it from the example..."
|
||||||
|
if [ -f ".env.example" ]; then
|
||||||
|
cp .env.example .env
|
||||||
|
echo "✓ Created the .env file"
|
||||||
|
else
|
||||||
|
echo "⚠ .env.example does not exist. Please create the .env file manually"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "✓ .env file exists"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check the frontend .env file
|
||||||
|
if [ ! -f "frontend/.env" ]; then
|
||||||
|
echo "frontend/.env does not exist. Copying it from the example..."
|
||||||
|
if [ -f "frontend/.env.example" ]; then
|
||||||
|
cp frontend/.env.example frontend/.env
|
||||||
|
echo "✓ Created the frontend/.env file"
|
||||||
|
else
|
||||||
|
echo "⚠ frontend/.env.example does not exist. Please create frontend/.env manually"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "✓ frontend/.env file exists"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
# Initialize the Docker environment
|
||||||
|
echo "Initializing the Docker environment..."
|
||||||
|
make docker-init
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Start Docker services
|
||||||
|
echo "Starting Docker services..."
|
||||||
|
make docker-start
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Deployment Complete"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
echo "🌐 Access URL: http://localhost:2026"
|
||||||
|
echo "📋 View logs: make docker-logs"
|
||||||
|
echo "🛑 Stop services: make docker-stop"
|
||||||
+63
@@ -0,0 +1,63 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Local Mode Deployment"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check config.yaml
|
||||||
|
if [ ! -f "config.yaml" ]; then
|
||||||
|
echo "config.yaml does not exist. Generating it..."
|
||||||
|
make config
|
||||||
|
echo ""
|
||||||
|
echo "⚠ Please edit config.yaml to configure your models and API keys"
|
||||||
|
echo " Then run this script again"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "✓ config.yaml exists"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check the .env file
|
||||||
|
if [ ! -f ".env" ]; then
|
||||||
|
echo ".env does not exist. Copying it from the example..."
|
||||||
|
if [ -f ".env.example" ]; then
|
||||||
|
cp .env.example .env
|
||||||
|
echo "✓ Created the .env file"
|
||||||
|
else
|
||||||
|
echo "⚠ .env.example does not exist. Please create the .env file manually"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "✓ .env file exists"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check dependencies
|
||||||
|
echo "Checking dependencies..."
|
||||||
|
make check
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
echo "Installing dependencies..."
|
||||||
|
make install
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Start services
|
||||||
|
echo "Starting services (background mode)..."
|
||||||
|
make dev-daemon
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Deployment Complete"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
echo "🌐 Access URL: http://localhost:2026"
|
||||||
|
echo "📋 View logs:"
|
||||||
|
echo " - logs/langgraph.log"
|
||||||
|
echo " - logs/gateway.log"
|
||||||
|
echo " - logs/frontend.log"
|
||||||
|
echo " - logs/nginx.log"
|
||||||
|
echo "🛑 Stop services: make stop"
|
||||||
|
echo ""
|
||||||
|
echo "Please wait 90-120 seconds for all services to start completely, then run the health check"
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set +e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Frontend Page Smoke Check"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
BASE_URL="${BASE_URL:-http://localhost:2026}"
|
||||||
|
DOC_PATH="${DOC_PATH:-/en/docs}"
|
||||||
|
|
||||||
|
all_passed=true
|
||||||
|
|
||||||
|
check_status() {
|
||||||
|
local name="$1"
|
||||||
|
local url="$2"
|
||||||
|
local expected_re="$3"
|
||||||
|
|
||||||
|
local status
|
||||||
|
status="$(curl -s -o /dev/null -w "%{http_code}" -L "$url")"
|
||||||
|
if echo "$status" | grep -Eq "$expected_re"; then
|
||||||
|
echo "✓ $name ($url) -> $status"
|
||||||
|
else
|
||||||
|
echo "✗ $name ($url) -> $status (expected: $expected_re)"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_final_url() {
|
||||||
|
local name="$1"
|
||||||
|
local url="$2"
|
||||||
|
local expected_path_re="$3"
|
||||||
|
|
||||||
|
local effective
|
||||||
|
effective="$(curl -s -o /dev/null -w "%{url_effective}" -L "$url")"
|
||||||
|
if echo "$effective" | grep -Eq "$expected_path_re"; then
|
||||||
|
echo "✓ $name redirect target -> $effective"
|
||||||
|
else
|
||||||
|
echo "✗ $name redirect target -> $effective (expected path: $expected_path_re)"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "1. Checking entry pages..."
|
||||||
|
check_status "Landing page" "${BASE_URL}/" "200"
|
||||||
|
check_status "Workspace redirect" "${BASE_URL}/workspace" "200|301|302|307|308"
|
||||||
|
check_final_url "Workspace redirect" "${BASE_URL}/workspace" "/workspace/chats/"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "2. Checking key workspace routes..."
|
||||||
|
check_status "New chat page" "${BASE_URL}/workspace/chats/new" "200"
|
||||||
|
check_status "Chats list page" "${BASE_URL}/workspace/chats" "200"
|
||||||
|
check_status "Agents gallery page" "${BASE_URL}/workspace/agents" "200"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "3. Checking docs route (optional)..."
|
||||||
|
check_status "Docs page" "${BASE_URL}${DOC_PATH}" "200|404"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Frontend Smoke Check Summary"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
if [ "$all_passed" = true ]; then
|
||||||
|
echo "✅ Frontend smoke checks passed!"
|
||||||
|
exit 0
|
||||||
|
else
|
||||||
|
echo "❌ Frontend smoke checks failed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
+125
@@ -0,0 +1,125 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set +e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Service Health Check"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
all_passed=true
|
||||||
|
mode="${SMOKE_TEST_MODE:-auto}"
|
||||||
|
summary_hint="make logs"
|
||||||
|
|
||||||
|
print_step() {
|
||||||
|
echo "$1"
|
||||||
|
}
|
||||||
|
|
||||||
|
check_http_status() {
|
||||||
|
local name="$1"
|
||||||
|
local url="$2"
|
||||||
|
local expected_re="$3"
|
||||||
|
local status
|
||||||
|
|
||||||
|
status="$(curl -s -o /dev/null -w "%{http_code}" "$url" 2>/dev/null)"
|
||||||
|
if echo "$status" | grep -Eq "$expected_re"; then
|
||||||
|
echo "✓ $name is accessible ($url -> $status)"
|
||||||
|
else
|
||||||
|
echo "✗ $name is not accessible ($url -> ${status:-000})"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_listen_port() {
|
||||||
|
local name="$1"
|
||||||
|
local port="$2"
|
||||||
|
|
||||||
|
if lsof -nP -iTCP:"$port" -sTCP:LISTEN >/dev/null 2>&1; then
|
||||||
|
echo "✓ $name is listening on port $port"
|
||||||
|
else
|
||||||
|
echo "✗ $name is not listening on port $port"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
docker_available() {
|
||||||
|
command -v docker >/dev/null 2>&1 && docker info >/dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
detect_mode() {
|
||||||
|
case "$mode" in
|
||||||
|
local|docker)
|
||||||
|
echo "$mode"
|
||||||
|
return
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if docker_available && docker ps --format "{{.Names}}" | grep -q "deer-flow"; then
|
||||||
|
echo "docker"
|
||||||
|
else
|
||||||
|
echo "local"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
mode="$(detect_mode)"
|
||||||
|
|
||||||
|
echo "Deployment mode: $mode"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
if [ "$mode" = "docker" ]; then
|
||||||
|
summary_hint="make docker-logs"
|
||||||
|
print_step "1. Checking container status..."
|
||||||
|
if docker ps --format "{{.Names}}" | grep -q "deer-flow"; then
|
||||||
|
echo "✓ Containers are running:"
|
||||||
|
docker ps --format " - {{.Names}} ({{.Status}})"
|
||||||
|
else
|
||||||
|
echo "✗ No DeerFlow-related containers are running"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
summary_hint="logs/{langgraph,gateway,frontend,nginx}.log"
|
||||||
|
print_step "1. Checking local service ports..."
|
||||||
|
check_listen_port "Nginx" 2026
|
||||||
|
check_listen_port "Frontend" 3000
|
||||||
|
check_listen_port "Gateway" 8001
|
||||||
|
check_listen_port "LangGraph" 2024
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "2. Waiting for services to fully start (30 seconds)..."
|
||||||
|
sleep 30
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "3. Checking frontend service..."
|
||||||
|
check_http_status "Frontend service" "http://localhost:2026" "200|301|302|307|308"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "4. Checking API Gateway..."
|
||||||
|
health_response=$(curl -s http://localhost:2026/health 2>/dev/null)
|
||||||
|
if [ $? -eq 0 ] && [ -n "$health_response" ]; then
|
||||||
|
echo "✓ API Gateway health check passed"
|
||||||
|
echo " Response: $health_response"
|
||||||
|
else
|
||||||
|
echo "✗ API Gateway health check failed"
|
||||||
|
all_passed=false
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "5. Checking LangGraph service..."
|
||||||
|
check_http_status "LangGraph service" "http://localhost:2024/" "200|301|302|307|308|404"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Health Check Summary"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
if [ "$all_passed" = true ]; then
|
||||||
|
echo "✅ All checks passed!"
|
||||||
|
echo ""
|
||||||
|
echo "🌐 Application URL: http://localhost:2026"
|
||||||
|
exit 0
|
||||||
|
else
|
||||||
|
echo "❌ Some checks failed"
|
||||||
|
echo ""
|
||||||
|
echo "Please review: $summary_hint"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
+49
@@ -0,0 +1,49 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Pulling the Latest Code"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check whether the current directory is a Git repository
|
||||||
|
if [ ! -d ".git" ]; then
|
||||||
|
echo "✗ The current directory is not a Git repository"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check Git status
|
||||||
|
echo "Checking Git status..."
|
||||||
|
if git status --porcelain | grep -q .; then
|
||||||
|
echo "⚠ Uncommitted changes detected:"
|
||||||
|
git status --short
|
||||||
|
echo ""
|
||||||
|
echo "Please commit or stash your changes before continuing"
|
||||||
|
echo "Options:"
|
||||||
|
echo " 1. git add . && git commit -m 'Save changes'"
|
||||||
|
echo " 2. git stash (stash changes and restore them later)"
|
||||||
|
echo " 3. git reset --hard HEAD (discard local changes - use with caution)"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "✓ Working tree is clean"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Fetch remote updates
|
||||||
|
echo "Fetching remote updates..."
|
||||||
|
git fetch origin main
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Pull the latest code
|
||||||
|
echo "Pulling the latest code..."
|
||||||
|
git pull origin main
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Show the latest commit
|
||||||
|
echo "Latest commit:"
|
||||||
|
git log -1 --oneline
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Code Update Complete"
|
||||||
|
echo "=========================================="
|
||||||
@@ -0,0 +1,180 @@
|
|||||||
|
# DeerFlow Smoke Test Report
|
||||||
|
|
||||||
|
**Test Date**: {{test_date}}
|
||||||
|
**Test Environment**: {{test_environment}}
|
||||||
|
**Deployment Mode**: Docker
|
||||||
|
**Test Version**: {{git_commit}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Execution Summary
|
||||||
|
|
||||||
|
| Metric | Status |
|
||||||
|
|------|------|
|
||||||
|
| Total Test Phases | 6 |
|
||||||
|
| Passed Phases | {{passed_stages}} |
|
||||||
|
| Failed Phases | {{failed_stages}} |
|
||||||
|
| Overall Conclusion | **{{overall_status}}** |
|
||||||
|
|
||||||
|
### Key Test Cases
|
||||||
|
|
||||||
|
| Case | Result | Details |
|
||||||
|
|------|--------|---------|
|
||||||
|
| Code update check | {{case_code_update}} | {{case_code_update_details}} |
|
||||||
|
| Environment check | {{case_env_check}} | {{case_env_check_details}} |
|
||||||
|
| Configuration preparation | {{case_config_prep}} | {{case_config_prep_details}} |
|
||||||
|
| Deployment | {{case_deploy}} | {{case_deploy_details}} |
|
||||||
|
| Health check | {{case_health_check}} | {{case_health_check_details}} |
|
||||||
|
| Frontend routes | {{case_frontend_routes_overall}} | {{case_frontend_routes_details}} |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Test Results
|
||||||
|
|
||||||
|
### Phase 1: Code Update Check
|
||||||
|
|
||||||
|
- [x] Confirm current directory - {{status_dir_check}}
|
||||||
|
- [x] Check Git status - {{status_git_status}}
|
||||||
|
- [x] Pull latest code - {{status_git_pull}}
|
||||||
|
- [x] Confirm code update - {{status_git_verify}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage1_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 2: Docker Environment Check
|
||||||
|
|
||||||
|
- [x] Docker version - {{status_docker_version}}
|
||||||
|
- [x] Docker daemon - {{status_docker_daemon}}
|
||||||
|
- [x] Docker Compose - {{status_docker_compose}}
|
||||||
|
- [x] Port check - {{status_port_check}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage2_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 3: Configuration Preparation
|
||||||
|
|
||||||
|
- [x] config.yaml - {{status_config_yaml}}
|
||||||
|
- [x] .env file - {{status_env_file}}
|
||||||
|
- [x] Model configuration - {{status_model_config}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage3_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 4: Docker Deployment
|
||||||
|
|
||||||
|
- [x] docker-init - {{status_docker_init}}
|
||||||
|
- [x] docker-start - {{status_docker_start}}
|
||||||
|
- [x] Service startup wait - {{status_wait_startup}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage4_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 5: Service Health Check
|
||||||
|
|
||||||
|
- [x] Container status - {{status_containers}}
|
||||||
|
- [x] Frontend service - {{status_frontend}}
|
||||||
|
- [x] API Gateway - {{status_api_gateway}}
|
||||||
|
- [x] LangGraph service - {{status_langgraph}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage5_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Frontend Routes Smoke Results
|
||||||
|
|
||||||
|
| Route | Status | Details |
|
||||||
|
|-------|--------|---------|
|
||||||
|
| Landing `/` | {{landing_status}} | {{landing_details}} |
|
||||||
|
| Workspace redirect `/workspace` | {{workspace_redirect_status}} | target {{workspace_redirect_target}} |
|
||||||
|
| New chat `/workspace/chats/new` | {{new_chat_status}} | {{new_chat_details}} |
|
||||||
|
| Chats list `/workspace/chats` | {{chats_list_status}} | {{chats_list_details}} |
|
||||||
|
| Agents gallery `/workspace/agents` | {{agents_gallery_status}} | {{agents_gallery_details}} |
|
||||||
|
| Docs `{{docs_path}}` | {{docs_status}} | {{docs_details}} |
|
||||||
|
|
||||||
|
**Summary**: {{frontend_routes_summary}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 6: Test Report Generation
|
||||||
|
|
||||||
|
- [x] Result summary - {{status_summary}}
|
||||||
|
- [x] Issue log - {{status_issues}}
|
||||||
|
- [x] Report generation - {{status_report}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage6_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Issue Log
|
||||||
|
|
||||||
|
### Issue 1
|
||||||
|
**Description**: {{issue1_description}}
|
||||||
|
**Severity**: {{issue1_severity}}
|
||||||
|
**Solution**: {{issue1_solution}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Environment Information
|
||||||
|
|
||||||
|
### Docker Version
|
||||||
|
```text
|
||||||
|
{{docker_version_output}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Git Information
|
||||||
|
```text
|
||||||
|
Repository: {{git_repo}}
|
||||||
|
Branch: {{git_branch}}
|
||||||
|
Commit: {{git_commit}}
|
||||||
|
Commit Message: {{git_commit_message}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration Summary
|
||||||
|
- config.yaml exists: {{config_exists}}
|
||||||
|
- .env file exists: {{env_exists}}
|
||||||
|
- Number of configured models: {{model_count}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Container Status
|
||||||
|
|
||||||
|
| Container Name | Status | Uptime |
|
||||||
|
|----------|------|----------|
|
||||||
|
| deer-flow-nginx | {{nginx_status}} | {{nginx_uptime}} |
|
||||||
|
| deer-flow-frontend | {{frontend_status}} | {{frontend_uptime}} |
|
||||||
|
| deer-flow-gateway | {{gateway_status}} | {{gateway_uptime}} |
|
||||||
|
| deer-flow-langgraph | {{langgraph_status}} | {{langgraph_uptime}} |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommendations and Next Steps
|
||||||
|
|
||||||
|
### If the Test Passes
|
||||||
|
1. [ ] Visit http://localhost:2026 to start using DeerFlow
|
||||||
|
2. [ ] Configure your preferred model if it is not configured yet
|
||||||
|
3. [ ] Explore available skills
|
||||||
|
4. [ ] Refer to the documentation to learn more features
|
||||||
|
|
||||||
|
### If the Test Fails
|
||||||
|
1. [ ] Review references/troubleshooting.md for common solutions
|
||||||
|
2. [ ] Check Docker logs: `make docker-logs`
|
||||||
|
3. [ ] Verify configuration file format and content
|
||||||
|
4. [ ] If needed, fully reset the environment: `make clean && make config && make docker-init && make docker-start`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Appendix
|
||||||
|
|
||||||
|
### Full Logs
|
||||||
|
{{full_logs}}
|
||||||
|
|
||||||
|
### Tester
|
||||||
|
{{tester_name}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Report generated at: {{report_time}}*
|
||||||
@@ -0,0 +1,185 @@
|
|||||||
|
# DeerFlow Smoke Test Report
|
||||||
|
|
||||||
|
**Test Date**: {{test_date}}
|
||||||
|
**Test Environment**: {{test_environment}}
|
||||||
|
**Deployment Mode**: Local
|
||||||
|
**Test Version**: {{git_commit}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Execution Summary
|
||||||
|
|
||||||
|
| Metric | Status |
|
||||||
|
|------|------|
|
||||||
|
| Total Test Phases | 6 |
|
||||||
|
| Passed Phases | {{passed_stages}} |
|
||||||
|
| Failed Phases | {{failed_stages}} |
|
||||||
|
| Overall Conclusion | **{{overall_status}}** |
|
||||||
|
|
||||||
|
### Key Test Cases
|
||||||
|
|
||||||
|
| Case | Result | Details |
|
||||||
|
|------|--------|---------|
|
||||||
|
| Code update check | {{case_code_update}} | {{case_code_update_details}} |
|
||||||
|
| Environment check | {{case_env_check}} | {{case_env_check_details}} |
|
||||||
|
| Configuration preparation | {{case_config_prep}} | {{case_config_prep_details}} |
|
||||||
|
| Deployment | {{case_deploy}} | {{case_deploy_details}} |
|
||||||
|
| Health check | {{case_health_check}} | {{case_health_check_details}} |
|
||||||
|
| Frontend routes | {{case_frontend_routes_overall}} | {{case_frontend_routes_details}} |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Test Results
|
||||||
|
|
||||||
|
### Phase 1: Code Update Check
|
||||||
|
|
||||||
|
- [x] Confirm current directory - {{status_dir_check}}
|
||||||
|
- [x] Check Git status - {{status_git_status}}
|
||||||
|
- [x] Pull latest code - {{status_git_pull}}
|
||||||
|
- [x] Confirm code update - {{status_git_verify}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage1_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 2: Local Environment Check
|
||||||
|
|
||||||
|
- [x] Node.js version - {{status_node_version}}
|
||||||
|
- [x] pnpm - {{status_pnpm}}
|
||||||
|
- [x] uv - {{status_uv}}
|
||||||
|
- [x] nginx - {{status_nginx}}
|
||||||
|
- [x] Port check - {{status_port_check}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage2_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 3: Configuration Preparation
|
||||||
|
|
||||||
|
- [x] config.yaml - {{status_config_yaml}}
|
||||||
|
- [x] .env file - {{status_env_file}}
|
||||||
|
- [x] Model configuration - {{status_model_config}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage3_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 4: Local Deployment
|
||||||
|
|
||||||
|
- [x] make check - {{status_make_check}}
|
||||||
|
- [x] make install - {{status_make_install}}
|
||||||
|
- [x] make dev-daemon / make dev - {{status_local_start}}
|
||||||
|
- [x] Service startup wait - {{status_wait_startup}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage4_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 5: Service Health Check
|
||||||
|
|
||||||
|
- [x] Process status - {{status_processes}}
|
||||||
|
- [x] Frontend service - {{status_frontend}}
|
||||||
|
- [x] API Gateway - {{status_api_gateway}}
|
||||||
|
- [x] LangGraph service - {{status_langgraph}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage5_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Frontend Routes Smoke Results
|
||||||
|
|
||||||
|
| Route | Status | Details |
|
||||||
|
|-------|--------|---------|
|
||||||
|
| Landing `/` | {{landing_status}} | {{landing_details}} |
|
||||||
|
| Workspace redirect `/workspace` | {{workspace_redirect_status}} | target {{workspace_redirect_target}} |
|
||||||
|
| New chat `/workspace/chats/new` | {{new_chat_status}} | {{new_chat_details}} |
|
||||||
|
| Chats list `/workspace/chats` | {{chats_list_status}} | {{chats_list_details}} |
|
||||||
|
| Agents gallery `/workspace/agents` | {{agents_gallery_status}} | {{agents_gallery_details}} |
|
||||||
|
| Docs `{{docs_path}}` | {{docs_status}} | {{docs_details}} |
|
||||||
|
|
||||||
|
**Summary**: {{frontend_routes_summary}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Phase 6: Test Report Generation
|
||||||
|
|
||||||
|
- [x] Result summary - {{status_summary}}
|
||||||
|
- [x] Issue log - {{status_issues}}
|
||||||
|
- [x] Report generation - {{status_report}}
|
||||||
|
|
||||||
|
**Phase Status**: {{stage6_status}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Issue Log
|
||||||
|
|
||||||
|
### Issue 1
|
||||||
|
**Description**: {{issue1_description}}
|
||||||
|
**Severity**: {{issue1_severity}}
|
||||||
|
**Solution**: {{issue1_solution}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Environment Information
|
||||||
|
|
||||||
|
### Local Dependency Versions
|
||||||
|
```text
|
||||||
|
Node.js: {{node_version_output}}
|
||||||
|
pnpm: {{pnpm_version_output}}
|
||||||
|
uv: {{uv_version_output}}
|
||||||
|
nginx: {{nginx_version_output}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Git Information
|
||||||
|
```text
|
||||||
|
Repository: {{git_repo}}
|
||||||
|
Branch: {{git_branch}}
|
||||||
|
Commit: {{git_commit}}
|
||||||
|
Commit Message: {{git_commit_message}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration Summary
|
||||||
|
- config.yaml exists: {{config_exists}}
|
||||||
|
- .env file exists: {{env_exists}}
|
||||||
|
- Number of configured models: {{model_count}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Local Service Status
|
||||||
|
|
||||||
|
| Service | Status | Endpoint |
|
||||||
|
|---------|--------|----------|
|
||||||
|
| Nginx | {{nginx_status}} | {{nginx_endpoint}} |
|
||||||
|
| Frontend | {{frontend_status}} | {{frontend_endpoint}} |
|
||||||
|
| Gateway | {{gateway_status}} | {{gateway_endpoint}} |
|
||||||
|
| LangGraph | {{langgraph_status}} | {{langgraph_endpoint}} |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommendations and Next Steps
|
||||||
|
|
||||||
|
### If the Test Passes
|
||||||
|
1. [ ] Visit http://localhost:2026 to start using DeerFlow
|
||||||
|
2. [ ] Configure your preferred model if it is not configured yet
|
||||||
|
3. [ ] Explore available skills
|
||||||
|
4. [ ] Refer to the documentation to learn more features
|
||||||
|
|
||||||
|
### If the Test Fails
|
||||||
|
1. [ ] Review references/troubleshooting.md for common solutions
|
||||||
|
2. [ ] Check local logs: `logs/{langgraph,gateway,frontend,nginx}.log`
|
||||||
|
3. [ ] Verify configuration file format and content
|
||||||
|
4. [ ] If needed, fully reset the environment: `make stop && make clean && make install && make dev-daemon`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Appendix
|
||||||
|
|
||||||
|
### Full Logs
|
||||||
|
{{full_logs}}
|
||||||
|
|
||||||
|
### Tester
|
||||||
|
{{tester_name}}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Report generated at: {{report_time}}*
|
||||||
@@ -17,6 +17,7 @@ INFOQUEST_API_KEY=your-infoquest-api-key
|
|||||||
# DEEPSEEK_API_KEY=your-deepseek-api-key
|
# DEEPSEEK_API_KEY=your-deepseek-api-key
|
||||||
# NOVITA_API_KEY=your-novita-api-key # OpenAI-compatible, see https://novita.ai
|
# NOVITA_API_KEY=your-novita-api-key # OpenAI-compatible, see https://novita.ai
|
||||||
# MINIMAX_API_KEY=your-minimax-api-key # OpenAI-compatible, see https://platform.minimax.io
|
# MINIMAX_API_KEY=your-minimax-api-key # OpenAI-compatible, see https://platform.minimax.io
|
||||||
|
# VLLM_API_KEY=your-vllm-api-key # OpenAI-compatible
|
||||||
# FEISHU_APP_ID=your-feishu-app-id
|
# FEISHU_APP_ID=your-feishu-app-id
|
||||||
# FEISHU_APP_SECRET=your-feishu-app-secret
|
# FEISHU_APP_SECRET=your-feishu-app-secret
|
||||||
|
|
||||||
@@ -32,3 +33,9 @@ INFOQUEST_API_KEY=your-infoquest-api-key
|
|||||||
|
|
||||||
# GitHub API Token
|
# GitHub API Token
|
||||||
# GITHUB_TOKEN=your-github-token
|
# GITHUB_TOKEN=your-github-token
|
||||||
|
|
||||||
|
# Database (only needed when config.yaml has database.backend: postgres)
|
||||||
|
# DATABASE_URL=postgresql://deerflow:password@localhost:5432/deerflow
|
||||||
|
#
|
||||||
|
# WECOM_BOT_ID=your-wecom-bot-id
|
||||||
|
# WECOM_BOT_SECRET=your-wecom-bot-secret
|
||||||
|
|||||||
@@ -54,3 +54,6 @@ web/
|
|||||||
# Deployment artifacts
|
# Deployment artifacts
|
||||||
backend/Dockerfile.langgraph
|
backend/Dockerfile.langgraph
|
||||||
config.yaml.bak
|
config.yaml.bak
|
||||||
|
.playwright-mcp
|
||||||
|
.gstack/
|
||||||
|
.worktrees
|
||||||
|
|||||||
@@ -0,0 +1,128 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
willem.jiang@gmail.com.
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||||
|
enforcement ladder](https://github.com/mozilla/diversity).
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
https://www.contributor-covenant.org/faq. Translations are available at
|
||||||
|
https://www.contributor-covenant.org/translations.
|
||||||
+13
-1
@@ -77,6 +77,18 @@ export UV_INDEX_URL=https://pypi.org/simple
|
|||||||
export NPM_REGISTRY=https://registry.npmjs.org
|
export NPM_REGISTRY=https://registry.npmjs.org
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Recommended host resources
|
||||||
|
|
||||||
|
Use these as practical starting points for development and review environments:
|
||||||
|
|
||||||
|
| Scenario | Starting point | Recommended | Notes |
|
||||||
|
|---------|-----------|------------|-------|
|
||||||
|
| `make dev` on one machine | 4 vCPU, 8 GB RAM | 8 vCPU, 16 GB RAM | Best when DeerFlow uses hosted model APIs. |
|
||||||
|
| `make docker-start` review environment | 4 vCPU, 8 GB RAM | 8 vCPU, 16 GB RAM | Docker image builds and sandbox containers need extra headroom. |
|
||||||
|
| Shared Linux test server | 8 vCPU, 16 GB RAM | 16 vCPU, 32 GB RAM | Prefer this for heavier multi-agent runs or multiple reviewers. |
|
||||||
|
|
||||||
|
`2 vCPU / 4 GB` environments often fail to start reliably or become unresponsive under normal DeerFlow workloads.
|
||||||
|
|
||||||
#### Linux: Docker daemon permission denied
|
#### Linux: Docker daemon permission denied
|
||||||
|
|
||||||
If `make docker-init`, `make docker-start`, or `make docker-stop` fails on Linux with an error like below, your current user likely does not have permission to access the Docker daemon socket:
|
If `make docker-init`, `make docker-start`, or `make docker-stop` fails on Linux with an error like below, your current user likely does not have permission to access the Docker daemon socket:
|
||||||
@@ -310,7 +322,7 @@ Every pull request runs the backend regression workflow at [.github/workflows/ba
|
|||||||
|
|
||||||
- [Configuration Guide](backend/docs/CONFIGURATION.md) - Setup and configuration
|
- [Configuration Guide](backend/docs/CONFIGURATION.md) - Setup and configuration
|
||||||
- [Architecture Overview](backend/CLAUDE.md) - Technical architecture
|
- [Architecture Overview](backend/CLAUDE.md) - Technical architecture
|
||||||
- [MCP Setup Guide](MCP_SETUP.md) - Model Context Protocol configuration
|
- [MCP Setup Guide](backend/docs/MCP_SERVER.md) - Model Context Protocol configuration
|
||||||
|
|
||||||
## Need Help?
|
## Need Help?
|
||||||
|
|
||||||
|
|||||||
@@ -1,45 +1,67 @@
|
|||||||
# DeerFlow - Unified Development Environment
|
# DeerFlow - Unified Development Environment
|
||||||
|
|
||||||
.PHONY: help config config-upgrade check install dev dev-daemon start stop up down clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway
|
.PHONY: help config config-upgrade check install setup doctor dev dev-pro dev-daemon dev-daemon-pro start start-pro start-daemon start-daemon-pro stop up up-pro down clean docker-init docker-start docker-start-pro docker-stop docker-logs docker-logs-frontend docker-logs-gateway
|
||||||
|
|
||||||
PYTHON ?= python
|
|
||||||
BASH ?= bash
|
BASH ?= bash
|
||||||
|
BACKEND_UV_RUN = cd backend && uv run
|
||||||
|
|
||||||
# Detect OS for Windows compatibility
|
# Detect OS for Windows compatibility
|
||||||
ifeq ($(OS),Windows_NT)
|
ifeq ($(OS),Windows_NT)
|
||||||
SHELL := cmd.exe
|
SHELL := cmd.exe
|
||||||
|
PYTHON ?= python
|
||||||
|
# Run repo shell scripts through Git Bash when Make is launched from cmd.exe / PowerShell.
|
||||||
|
RUN_WITH_GIT_BASH = call scripts\run-with-git-bash.cmd
|
||||||
|
else
|
||||||
|
PYTHON ?= python3
|
||||||
|
RUN_WITH_GIT_BASH =
|
||||||
endif
|
endif
|
||||||
|
|
||||||
help:
|
help:
|
||||||
@echo "DeerFlow Development Commands:"
|
@echo "DeerFlow Development Commands:"
|
||||||
|
@echo " make setup - Interactive setup wizard (recommended for new users)"
|
||||||
|
@echo " make doctor - Check configuration and system requirements"
|
||||||
@echo " make config - Generate local config files (aborts if config already exists)"
|
@echo " make config - Generate local config files (aborts if config already exists)"
|
||||||
@echo " make config-upgrade - Merge new fields from config.example.yaml into config.yaml"
|
@echo " make config-upgrade - Merge new fields from config.example.yaml into config.yaml"
|
||||||
@echo " make check - Check if all required tools are installed"
|
@echo " make check - Check if all required tools are installed"
|
||||||
@echo " make install - Install all dependencies (frontend + backend)"
|
@echo " make install - Install all dependencies (frontend + backend)"
|
||||||
@echo " make setup-sandbox - Pre-pull sandbox container image (recommended)"
|
@echo " make setup-sandbox - Pre-pull sandbox container image (recommended)"
|
||||||
@echo " make dev - Start all services in development mode (with hot-reloading)"
|
@echo " make dev - Start all services in development mode (with hot-reloading)"
|
||||||
@echo " make dev-daemon - Start all services in background (daemon mode)"
|
@echo " make dev-pro - Start in dev + Gateway mode (experimental, no LangGraph server)"
|
||||||
|
@echo " make dev-daemon - Start dev services in background (daemon mode)"
|
||||||
|
@echo " make dev-daemon-pro - Start dev daemon + Gateway mode (experimental)"
|
||||||
@echo " make start - Start all services in production mode (optimized, no hot-reloading)"
|
@echo " make start - Start all services in production mode (optimized, no hot-reloading)"
|
||||||
|
@echo " make start-pro - Start in prod + Gateway mode (experimental)"
|
||||||
|
@echo " make start-daemon - Start prod services in background (daemon mode)"
|
||||||
|
@echo " make start-daemon-pro - Start prod daemon + Gateway mode (experimental)"
|
||||||
@echo " make stop - Stop all running services"
|
@echo " make stop - Stop all running services"
|
||||||
@echo " make clean - Clean up processes and temporary files"
|
@echo " make clean - Clean up processes and temporary files"
|
||||||
@echo ""
|
@echo ""
|
||||||
@echo "Docker Production Commands:"
|
@echo "Docker Production Commands:"
|
||||||
@echo " make up - Build and start production Docker services (localhost:2026)"
|
@echo " make up - Build and start production Docker services (localhost:2026)"
|
||||||
|
@echo " make up-pro - Build and start production Docker in Gateway mode (experimental)"
|
||||||
@echo " make down - Stop and remove production Docker containers"
|
@echo " make down - Stop and remove production Docker containers"
|
||||||
@echo ""
|
@echo ""
|
||||||
@echo "Docker Development Commands:"
|
@echo "Docker Development Commands:"
|
||||||
@echo " make docker-init - Pull the sandbox image"
|
@echo " make docker-init - Pull the sandbox image"
|
||||||
@echo " make docker-start - Start Docker services (mode-aware from config.yaml, localhost:2026)"
|
@echo " make docker-start - Start Docker services (mode-aware from config.yaml, localhost:2026)"
|
||||||
|
@echo " make docker-start-pro - Start Docker in Gateway mode (experimental, no LangGraph container)"
|
||||||
@echo " make docker-stop - Stop Docker development services"
|
@echo " make docker-stop - Stop Docker development services"
|
||||||
@echo " make docker-logs - View Docker development logs"
|
@echo " make docker-logs - View Docker development logs"
|
||||||
@echo " make docker-logs-frontend - View Docker frontend logs"
|
@echo " make docker-logs-frontend - View Docker frontend logs"
|
||||||
@echo " make docker-logs-gateway - View Docker gateway logs"
|
@echo " make docker-logs-gateway - View Docker gateway logs"
|
||||||
|
|
||||||
|
## Setup & Diagnosis
|
||||||
|
setup:
|
||||||
|
@$(BACKEND_UV_RUN) python ../scripts/setup_wizard.py
|
||||||
|
|
||||||
|
doctor:
|
||||||
|
@$(BACKEND_UV_RUN) python ../scripts/doctor.py
|
||||||
|
|
||||||
config:
|
config:
|
||||||
@$(PYTHON) ./scripts/configure.py
|
@$(PYTHON) ./scripts/configure.py
|
||||||
|
|
||||||
config-upgrade:
|
config-upgrade:
|
||||||
@./scripts/config-upgrade.sh
|
@$(RUN_WITH_GIT_BASH) ./scripts/config-upgrade.sh
|
||||||
|
|
||||||
# Check required tools
|
# Check required tools
|
||||||
check:
|
check:
|
||||||
@@ -96,39 +118,47 @@ setup-sandbox:
|
|||||||
|
|
||||||
# Start all services in development mode (with hot-reloading)
|
# Start all services in development mode (with hot-reloading)
|
||||||
dev:
|
dev:
|
||||||
ifeq ($(OS),Windows_NT)
|
@$(PYTHON) ./scripts/check.py
|
||||||
@call scripts\run-with-git-bash.cmd ./scripts/serve.sh --dev
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev
|
||||||
else
|
|
||||||
@./scripts/serve.sh --dev
|
# Start all services in dev + Gateway mode (experimental: agent runtime embedded in Gateway)
|
||||||
endif
|
dev-pro:
|
||||||
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev --gateway
|
||||||
|
|
||||||
# Start all services in production mode (with optimizations)
|
# Start all services in production mode (with optimizations)
|
||||||
start:
|
start:
|
||||||
ifeq ($(OS),Windows_NT)
|
@$(PYTHON) ./scripts/check.py
|
||||||
@call scripts\run-with-git-bash.cmd ./scripts/serve.sh --prod
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod
|
||||||
else
|
|
||||||
@./scripts/serve.sh --prod
|
# Start all services in prod + Gateway mode (experimental)
|
||||||
endif
|
start-pro:
|
||||||
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod --gateway
|
||||||
|
|
||||||
# Start all services in daemon mode (background)
|
# Start all services in daemon mode (background)
|
||||||
dev-daemon:
|
dev-daemon:
|
||||||
@./scripts/start-daemon.sh
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev --daemon
|
||||||
|
|
||||||
|
# Start daemon + Gateway mode (experimental)
|
||||||
|
dev-daemon-pro:
|
||||||
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev --gateway --daemon
|
||||||
|
|
||||||
|
# Start prod services in daemon mode (background)
|
||||||
|
start-daemon:
|
||||||
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod --daemon
|
||||||
|
|
||||||
|
# Start prod daemon + Gateway mode (experimental)
|
||||||
|
start-daemon-pro:
|
||||||
|
@$(PYTHON) ./scripts/check.py
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod --gateway --daemon
|
||||||
|
|
||||||
# Stop all services
|
# Stop all services
|
||||||
stop:
|
stop:
|
||||||
@echo "Stopping all services..."
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --stop
|
||||||
@-pkill -f "langgraph dev" 2>/dev/null || true
|
|
||||||
@-pkill -f "uvicorn app.gateway.app:app" 2>/dev/null || true
|
|
||||||
@-pkill -f "next dev" 2>/dev/null || true
|
|
||||||
@-pkill -f "next start" 2>/dev/null || true
|
|
||||||
@-pkill -f "next-server" 2>/dev/null || true
|
|
||||||
@-pkill -f "next-server" 2>/dev/null || true
|
|
||||||
@-nginx -c $(PWD)/docker/nginx/nginx.local.conf -p $(PWD) -s quit 2>/dev/null || true
|
|
||||||
@sleep 1
|
|
||||||
@-pkill -9 nginx 2>/dev/null || true
|
|
||||||
@echo "Cleaning up sandbox containers..."
|
|
||||||
@-./scripts/cleanup-containers.sh deer-flow-sandbox 2>/dev/null || true
|
|
||||||
@echo "✓ All services stopped"
|
|
||||||
|
|
||||||
# Clean up
|
# Clean up
|
||||||
clean: stop
|
clean: stop
|
||||||
@@ -144,25 +174,29 @@ clean: stop
|
|||||||
|
|
||||||
# Initialize Docker containers and install dependencies
|
# Initialize Docker containers and install dependencies
|
||||||
docker-init:
|
docker-init:
|
||||||
@./scripts/docker.sh init
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh init
|
||||||
|
|
||||||
# Start Docker development environment
|
# Start Docker development environment
|
||||||
docker-start:
|
docker-start:
|
||||||
@./scripts/docker.sh start
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh start
|
||||||
|
|
||||||
|
# Start Docker in Gateway mode (experimental)
|
||||||
|
docker-start-pro:
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh start --gateway
|
||||||
|
|
||||||
# Stop Docker development environment
|
# Stop Docker development environment
|
||||||
docker-stop:
|
docker-stop:
|
||||||
@./scripts/docker.sh stop
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh stop
|
||||||
|
|
||||||
# View Docker development logs
|
# View Docker development logs
|
||||||
docker-logs:
|
docker-logs:
|
||||||
@./scripts/docker.sh logs
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs
|
||||||
|
|
||||||
# View Docker development logs
|
# View Docker development logs
|
||||||
docker-logs-frontend:
|
docker-logs-frontend:
|
||||||
@./scripts/docker.sh logs --frontend
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --frontend
|
||||||
docker-logs-gateway:
|
docker-logs-gateway:
|
||||||
@./scripts/docker.sh logs --gateway
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --gateway
|
||||||
|
|
||||||
# ==========================================
|
# ==========================================
|
||||||
# Production Docker Commands
|
# Production Docker Commands
|
||||||
@@ -170,8 +204,12 @@ docker-logs-gateway:
|
|||||||
|
|
||||||
# Build and start production services
|
# Build and start production services
|
||||||
up:
|
up:
|
||||||
@./scripts/deploy.sh
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh
|
||||||
|
|
||||||
|
# Build and start production services in Gateway mode
|
||||||
|
up-pro:
|
||||||
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh --gateway
|
||||||
|
|
||||||
# Stop and remove production containers
|
# Stop and remove production containers
|
||||||
down:
|
down:
|
||||||
@./scripts/deploy.sh down
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh down
|
||||||
|
|||||||
@@ -46,12 +46,14 @@ DeerFlow has newly integrated the intelligent search and crawling toolset indepe
|
|||||||
|
|
||||||
- [🦌 DeerFlow - 2.0](#-deerflow---20)
|
- [🦌 DeerFlow - 2.0](#-deerflow---20)
|
||||||
- [Official Website](#official-website)
|
- [Official Website](#official-website)
|
||||||
|
- [Coding Plan from ByteDance Volcengine](#coding-plan-from-bytedance-volcengine)
|
||||||
- [InfoQuest](#infoquest)
|
- [InfoQuest](#infoquest)
|
||||||
- [Table of Contents](#table-of-contents)
|
- [Table of Contents](#table-of-contents)
|
||||||
- [One-Line Agent Setup](#one-line-agent-setup)
|
- [One-Line Agent Setup](#one-line-agent-setup)
|
||||||
- [Quick Start](#quick-start)
|
- [Quick Start](#quick-start)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Running the Application](#running-the-application)
|
- [Running the Application](#running-the-application)
|
||||||
|
- [Deployment Sizing](#deployment-sizing)
|
||||||
- [Option 1: Docker (Recommended)](#option-1-docker-recommended)
|
- [Option 1: Docker (Recommended)](#option-1-docker-recommended)
|
||||||
- [Option 2: Local Development](#option-2-local-development)
|
- [Option 2: Local Development](#option-2-local-development)
|
||||||
- [Advanced](#advanced)
|
- [Advanced](#advanced)
|
||||||
@@ -59,6 +61,8 @@ DeerFlow has newly integrated the intelligent search and crawling toolset indepe
|
|||||||
- [MCP Server](#mcp-server)
|
- [MCP Server](#mcp-server)
|
||||||
- [IM Channels](#im-channels)
|
- [IM Channels](#im-channels)
|
||||||
- [LangSmith Tracing](#langsmith-tracing)
|
- [LangSmith Tracing](#langsmith-tracing)
|
||||||
|
- [Langfuse Tracing](#langfuse-tracing)
|
||||||
|
- [Using Both Providers](#using-both-providers)
|
||||||
- [From Deep Research to Super Agent Harness](#from-deep-research-to-super-agent-harness)
|
- [From Deep Research to Super Agent Harness](#from-deep-research-to-super-agent-harness)
|
||||||
- [Core Features](#core-features)
|
- [Core Features](#core-features)
|
||||||
- [Skills \& Tools](#skills--tools)
|
- [Skills \& Tools](#skills--tools)
|
||||||
@@ -71,6 +75,8 @@ DeerFlow has newly integrated the intelligent search and crawling toolset indepe
|
|||||||
- [Embedded Python Client](#embedded-python-client)
|
- [Embedded Python Client](#embedded-python-client)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
- [⚠️ Security Notice](#️-security-notice)
|
- [⚠️ Security Notice](#️-security-notice)
|
||||||
|
- [Improper Deployment May Introduce Security Risks](#improper-deployment-may-introduce-security-risks)
|
||||||
|
- [Security Recommendations](#security-recommendations)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
- [Acknowledgments](#acknowledgments)
|
- [Acknowledgments](#acknowledgments)
|
||||||
@@ -98,35 +104,38 @@ That prompt is intended for coding agents. It tells the agent to clone the repo
|
|||||||
cd deer-flow
|
cd deer-flow
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Generate local configuration files**
|
2. **Run the setup wizard**
|
||||||
|
|
||||||
From the project root directory (`deer-flow/`), run:
|
From the project root directory (`deer-flow/`), run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make config
|
make setup
|
||||||
```
|
```
|
||||||
|
|
||||||
This command creates local configuration files based on the provided example templates.
|
This launches an interactive wizard that guides you through choosing an LLM provider, optional web search, and execution/safety preferences such as sandbox mode, bash access, and file-write tools. It generates a minimal `config.yaml` and writes your keys to `.env`. Takes about 2 minutes.
|
||||||
|
|
||||||
3. **Configure your preferred model(s)**
|
The wizard also lets you configure an optional web search provider, or skip it for now.
|
||||||
|
|
||||||
Edit `config.yaml` and define at least one model:
|
Run `make doctor` at any time to verify your setup and get actionable fix hints.
|
||||||
|
|
||||||
|
> **Advanced / manual configuration**: If you prefer to edit `config.yaml` directly, run `make config` instead to copy the full template. See `config.example.yaml` for the complete reference including CLI-backed providers (Codex CLI, Claude Code OAuth), OpenRouter, Responses API, and more.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Manual model configuration examples</summary>
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
models:
|
models:
|
||||||
- name: gpt-4 # Internal identifier
|
- name: gpt-4o
|
||||||
display_name: GPT-4 # Human-readable name
|
display_name: GPT-4o
|
||||||
use: langchain_openai:ChatOpenAI # LangChain class path
|
use: langchain_openai:ChatOpenAI
|
||||||
model: gpt-4 # Model identifier for API
|
model: gpt-4o
|
||||||
api_key: $OPENAI_API_KEY # API key (recommended: use env var)
|
api_key: $OPENAI_API_KEY
|
||||||
max_tokens: 4096 # Maximum tokens per request
|
|
||||||
temperature: 0.7 # Sampling temperature
|
|
||||||
|
|
||||||
- name: openrouter-gemini-2.5-flash
|
- name: openrouter-gemini-2.5-flash
|
||||||
display_name: Gemini 2.5 Flash (OpenRouter)
|
display_name: Gemini 2.5 Flash (OpenRouter)
|
||||||
use: langchain_openai:ChatOpenAI
|
use: langchain_openai:ChatOpenAI
|
||||||
model: google/gemini-2.5-flash-preview
|
model: google/gemini-2.5-flash-preview
|
||||||
api_key: $OPENAI_API_KEY # OpenRouter still uses the OpenAI-compatible field name here
|
api_key: $OPENROUTER_API_KEY
|
||||||
base_url: https://openrouter.ai/api/v1
|
base_url: https://openrouter.ai/api/v1
|
||||||
|
|
||||||
- name: gpt-5-responses
|
- name: gpt-5-responses
|
||||||
@@ -136,12 +145,26 @@ That prompt is intended for coding agents. It tells the agent to clone the repo
|
|||||||
api_key: $OPENAI_API_KEY
|
api_key: $OPENAI_API_KEY
|
||||||
use_responses_api: true
|
use_responses_api: true
|
||||||
output_version: responses/v1
|
output_version: responses/v1
|
||||||
|
|
||||||
|
- name: qwen3-32b-vllm
|
||||||
|
display_name: Qwen3 32B (vLLM)
|
||||||
|
use: deerflow.models.vllm_provider:VllmChatModel
|
||||||
|
model: Qwen/Qwen3-32B
|
||||||
|
api_key: $VLLM_API_KEY
|
||||||
|
base_url: http://localhost:8000/v1
|
||||||
|
supports_thinking: true
|
||||||
|
when_thinking_enabled:
|
||||||
|
extra_body:
|
||||||
|
chat_template_kwargs:
|
||||||
|
enable_thinking: true
|
||||||
```
|
```
|
||||||
|
|
||||||
OpenRouter and similar OpenAI-compatible gateways should be configured with `langchain_openai:ChatOpenAI` plus `base_url`. If you prefer a provider-specific environment variable name, point `api_key` at that variable explicitly (for example `api_key: $OPENROUTER_API_KEY`).
|
OpenRouter and similar OpenAI-compatible gateways should be configured with `langchain_openai:ChatOpenAI` plus `base_url`. If you prefer a provider-specific environment variable name, point `api_key` at that variable explicitly (for example `api_key: $OPENROUTER_API_KEY`).
|
||||||
|
|
||||||
To route OpenAI models through `/v1/responses`, keep using `langchain_openai:ChatOpenAI` and set `use_responses_api: true` with `output_version: responses/v1`.
|
To route OpenAI models through `/v1/responses`, keep using `langchain_openai:ChatOpenAI` and set `use_responses_api: true` with `output_version: responses/v1`.
|
||||||
|
|
||||||
|
For vLLM 0.19.0, use `deerflow.models.vllm_provider:VllmChatModel`. For Qwen-style reasoning models, DeerFlow toggles reasoning with `extra_body.chat_template_kwargs.enable_thinking` and preserves vLLM's non-standard `reasoning` field across multi-turn tool-call conversations. Legacy `thinking` configs are normalized automatically for backward compatibility. Reasoning models may also require the server to be started with `--reasoning-parser ...`. If your local vLLM deployment accepts any non-empty API key, you can still set `VLLM_API_KEY` to a placeholder value.
|
||||||
|
|
||||||
CLI-backed provider examples:
|
CLI-backed provider examples:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@@ -162,50 +185,39 @@ That prompt is intended for coding agents. It tells the agent to clone the repo
|
|||||||
```
|
```
|
||||||
|
|
||||||
- Codex CLI reads `~/.codex/auth.json`
|
- Codex CLI reads `~/.codex/auth.json`
|
||||||
- The Codex Responses endpoint currently rejects `max_tokens` and `max_output_tokens`, so `CodexChatModel` does not expose a request-level token cap
|
- Claude Code accepts `CLAUDE_CODE_OAUTH_TOKEN`, `ANTHROPIC_AUTH_TOKEN`, `CLAUDE_CODE_CREDENTIALS_PATH`, or `~/.claude/.credentials.json`
|
||||||
- Claude Code accepts `CLAUDE_CODE_OAUTH_TOKEN`, `ANTHROPIC_AUTH_TOKEN`, `CLAUDE_CODE_OAUTH_TOKEN_FILE_DESCRIPTOR`, `CLAUDE_CODE_CREDENTIALS_PATH`, or plaintext `~/.claude/.credentials.json`
|
- ACP agent entries are separate from model providers — if you configure `acp_agents.codex`, point it at a Codex ACP adapter such as `npx -y @zed-industries/codex-acp`
|
||||||
- ACP agent entries are separate from model providers. If you configure `acp_agents.codex`, point it at a Codex ACP adapter such as `npx -y @zed-industries/codex-acp`; the standard `codex` CLI binary is not ACP-compatible by itself
|
- On macOS, export Claude Code auth explicitly if needed:
|
||||||
- On macOS, DeerFlow does not probe Keychain automatically. Export Claude Code auth explicitly if needed:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
eval "$(python3 scripts/export_claude_code_oauth.py --print-export)"
|
eval "$(python3 scripts/export_claude_code_oauth.py --print-export)"
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Set API keys for your configured model(s)**
|
|
||||||
|
|
||||||
Choose one of the following methods:
|
|
||||||
|
|
||||||
- Option A: Edit the `.env` file in the project root (Recommended)
|
|
||||||
|
|
||||||
|
API keys can also be set manually in `.env` (recommended) or exported in your shell:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
TAVILY_API_KEY=your-tavily-api-key
|
|
||||||
OPENAI_API_KEY=your-openai-api-key
|
OPENAI_API_KEY=your-openai-api-key
|
||||||
# OpenRouter also uses OPENAI_API_KEY when your config uses langchain_openai:ChatOpenAI + base_url.
|
TAVILY_API_KEY=your-tavily-api-key
|
||||||
# Add other provider keys as needed
|
|
||||||
INFOQUEST_API_KEY=your-infoquest-api-key
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- Option B: Export environment variables in your shell
|
</details>
|
||||||
|
|
||||||
```bash
|
|
||||||
export OPENAI_API_KEY=your-openai-api-key
|
|
||||||
```
|
|
||||||
|
|
||||||
For CLI-backed providers:
|
|
||||||
- Codex CLI: `~/.codex/auth.json`
|
|
||||||
- Claude Code OAuth: explicit env/file handoff or `~/.claude/.credentials.json`
|
|
||||||
|
|
||||||
- Option C: Edit `config.yaml` directly (Not recommended for production)
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
models:
|
|
||||||
- name: gpt-4
|
|
||||||
api_key: your-actual-api-key-here # Replace placeholder
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running the Application
|
### Running the Application
|
||||||
|
|
||||||
|
#### Deployment Sizing
|
||||||
|
|
||||||
|
Use the table below as a practical starting point when choosing how to run DeerFlow:
|
||||||
|
|
||||||
|
| Deployment target | Starting point | Recommended | Notes |
|
||||||
|
|---------|-----------|------------|-------|
|
||||||
|
| Local evaluation / `make dev` | 4 vCPU, 8 GB RAM, 20 GB free SSD | 8 vCPU, 16 GB RAM | Good for one developer or one light session with hosted model APIs. `2 vCPU / 4 GB` is usually not enough. |
|
||||||
|
| Docker development / `make docker-start` | 4 vCPU, 8 GB RAM, 25 GB free SSD | 8 vCPU, 16 GB RAM | Image builds, bind mounts, and sandbox containers need more headroom than pure local dev. |
|
||||||
|
| Long-running server / `make up` | 8 vCPU, 16 GB RAM, 40 GB free SSD | 16 vCPU, 32 GB RAM | Preferred for shared use, multi-agent runs, report generation, or heavier sandbox workloads. |
|
||||||
|
|
||||||
|
- These numbers cover DeerFlow itself. If you also host a local LLM, size that service separately.
|
||||||
|
- Linux plus Docker is the recommended deployment target for a persistent server. macOS and Windows are best treated as development or evaluation environments.
|
||||||
|
- If CPU or memory usage stays pinned, reduce concurrent runs first, then move to the next sizing tier.
|
||||||
|
|
||||||
#### Option 1: Docker (Recommended)
|
#### Option 1: Docker (Recommended)
|
||||||
|
|
||||||
**Development** (hot-reload, source mounts):
|
**Development** (hot-reload, source mounts):
|
||||||
@@ -242,7 +254,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed Docker development guide.
|
|||||||
|
|
||||||
If you prefer running services locally:
|
If you prefer running services locally:
|
||||||
|
|
||||||
Prerequisite: complete the "Configuration" steps above first (`make config` and model API keys). `make dev` requires a valid configuration file (defaults to `config.yaml` in the project root; can be overridden via `DEER_FLOW_CONFIG_PATH`).
|
Prerequisite: complete the "Configuration" steps above first (`make setup`). `make dev` requires a valid `config.yaml` in the project root (can be overridden via `DEER_FLOW_CONFIG_PATH`). Run `make doctor` to verify your setup before starting.
|
||||||
|
On Windows, run the local development flow from Git Bash. Native `cmd.exe` and PowerShell shells are not supported for the bash-based service scripts, and WSL is not guaranteed because some scripts rely on Git for Windows utilities such as `cygpath`.
|
||||||
|
|
||||||
1. **Check prerequisites**:
|
1. **Check prerequisites**:
|
||||||
```bash
|
```bash
|
||||||
@@ -274,6 +287,60 @@ Prerequisite: complete the "Configuration" steps above first (`make config` and
|
|||||||
|
|
||||||
6. **Access**: http://localhost:2026
|
6. **Access**: http://localhost:2026
|
||||||
|
|
||||||
|
#### Startup Modes
|
||||||
|
|
||||||
|
DeerFlow supports multiple startup modes across two dimensions:
|
||||||
|
|
||||||
|
- **Dev / Prod** — dev enables hot-reload; prod uses pre-built frontend
|
||||||
|
- **Standard / Gateway** — standard uses a separate LangGraph server (4 processes); Gateway mode (experimental) embeds the agent runtime in the Gateway API (3 processes)
|
||||||
|
|
||||||
|
| | **Local Foreground** | **Local Daemon** | **Docker Dev** | **Docker Prod** |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| **Dev** | `./scripts/serve.sh --dev`<br/>`make dev` | `./scripts/serve.sh --dev --daemon`<br/>`make dev-daemon` | `./scripts/docker.sh start`<br/>`make docker-start` | — |
|
||||||
|
| **Dev + Gateway** | `./scripts/serve.sh --dev --gateway`<br/>`make dev-pro` | `./scripts/serve.sh --dev --gateway --daemon`<br/>`make dev-daemon-pro` | `./scripts/docker.sh start --gateway`<br/>`make docker-start-pro` | — |
|
||||||
|
| **Prod** | `./scripts/serve.sh --prod`<br/>`make start` | `./scripts/serve.sh --prod --daemon`<br/>`make start-daemon` | — | `./scripts/deploy.sh`<br/>`make up` |
|
||||||
|
| **Prod + Gateway** | `./scripts/serve.sh --prod --gateway`<br/>`make start-pro` | `./scripts/serve.sh --prod --gateway --daemon`<br/>`make start-daemon-pro` | — | `./scripts/deploy.sh --gateway`<br/>`make up-pro` |
|
||||||
|
|
||||||
|
| Action | Local | Docker Dev | Docker Prod |
|
||||||
|
|---|---|---|---|
|
||||||
|
| **Stop** | `./scripts/serve.sh --stop`<br/>`make stop` | `./scripts/docker.sh stop`<br/>`make docker-stop` | `./scripts/deploy.sh down`<br/>`make down` |
|
||||||
|
| **Restart** | `./scripts/serve.sh --restart [flags]` | `./scripts/docker.sh restart` | — |
|
||||||
|
|
||||||
|
> **Gateway mode** eliminates the LangGraph server process — the Gateway API handles agent execution directly via async tasks, managing its own concurrency.
|
||||||
|
|
||||||
|
#### Why Gateway Mode?
|
||||||
|
|
||||||
|
In standard mode, DeerFlow runs a dedicated [LangGraph Platform](https://langchain-ai.github.io/langgraph/) server alongside the Gateway API. This architecture works well but has trade-offs:
|
||||||
|
|
||||||
|
| | Standard Mode | Gateway Mode |
|
||||||
|
|---|---|---|
|
||||||
|
| **Architecture** | Gateway (REST API) + LangGraph (agent runtime) | Gateway embeds agent runtime |
|
||||||
|
| **Concurrency** | `--n-jobs-per-worker` per worker (requires license) | `--workers` × async tasks (no per-worker cap) |
|
||||||
|
| **Containers / Processes** | 4 (frontend, gateway, langgraph, nginx) | 3 (frontend, gateway, nginx) |
|
||||||
|
| **Resource usage** | Higher (two Python runtimes) | Lower (single Python runtime) |
|
||||||
|
| **LangGraph Platform license** | Required for production images | Not required |
|
||||||
|
| **Cold start** | Slower (two services to initialize) | Faster |
|
||||||
|
|
||||||
|
Both modes are functionally equivalent — the same agents, tools, and skills work in either mode.
|
||||||
|
|
||||||
|
#### Docker Production Deployment
|
||||||
|
|
||||||
|
`deploy.sh` supports building and starting separately. Images are mode-agnostic — runtime mode is selected at start time:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# One-step (build + start)
|
||||||
|
deploy.sh # standard mode (default)
|
||||||
|
deploy.sh --gateway # gateway mode
|
||||||
|
|
||||||
|
# Two-step (build once, start with any mode)
|
||||||
|
deploy.sh build # build all images
|
||||||
|
deploy.sh start # start in standard mode
|
||||||
|
deploy.sh start --gateway # start in gateway mode
|
||||||
|
|
||||||
|
# Stop
|
||||||
|
deploy.sh down
|
||||||
|
```
|
||||||
|
|
||||||
### Advanced
|
### Advanced
|
||||||
#### Sandbox Mode
|
#### Sandbox Mode
|
||||||
|
|
||||||
@@ -301,6 +368,8 @@ DeerFlow supports receiving tasks from messaging apps. Channels auto-start when
|
|||||||
| Telegram | Bot API (long-polling) | Easy |
|
| Telegram | Bot API (long-polling) | Easy |
|
||||||
| Slack | Socket Mode | Moderate |
|
| Slack | Socket Mode | Moderate |
|
||||||
| Feishu / Lark | WebSocket | Moderate |
|
| Feishu / Lark | WebSocket | Moderate |
|
||||||
|
| WeChat | Tencent iLink (long-polling) | Moderate |
|
||||||
|
| WeCom | WebSocket | Moderate |
|
||||||
|
|
||||||
**Configuration in `config.yaml`:**
|
**Configuration in `config.yaml`:**
|
||||||
|
|
||||||
@@ -328,6 +397,11 @@ channels:
|
|||||||
# domain: https://open.feishu.cn # China (default)
|
# domain: https://open.feishu.cn # China (default)
|
||||||
# domain: https://open.larksuite.com # International
|
# domain: https://open.larksuite.com # International
|
||||||
|
|
||||||
|
wecom:
|
||||||
|
enabled: true
|
||||||
|
bot_id: $WECOM_BOT_ID
|
||||||
|
bot_secret: $WECOM_BOT_SECRET
|
||||||
|
|
||||||
slack:
|
slack:
|
||||||
enabled: true
|
enabled: true
|
||||||
bot_token: $SLACK_BOT_TOKEN # xoxb-...
|
bot_token: $SLACK_BOT_TOKEN # xoxb-...
|
||||||
@@ -339,6 +413,19 @@ channels:
|
|||||||
bot_token: $TELEGRAM_BOT_TOKEN
|
bot_token: $TELEGRAM_BOT_TOKEN
|
||||||
allowed_users: [] # empty = allow all
|
allowed_users: [] # empty = allow all
|
||||||
|
|
||||||
|
wechat:
|
||||||
|
enabled: false
|
||||||
|
bot_token: $WECHAT_BOT_TOKEN
|
||||||
|
ilink_bot_id: $WECHAT_ILINK_BOT_ID
|
||||||
|
qrcode_login_enabled: true # optional: allow first-time QR bootstrap when bot_token is absent
|
||||||
|
allowed_users: [] # empty = allow all
|
||||||
|
polling_timeout: 35
|
||||||
|
state_dir: ./.deer-flow/wechat/state
|
||||||
|
max_inbound_image_bytes: 20971520
|
||||||
|
max_outbound_image_bytes: 20971520
|
||||||
|
max_inbound_file_bytes: 52428800
|
||||||
|
max_outbound_file_bytes: 52428800
|
||||||
|
|
||||||
# Optional: per-channel / per-user session settings
|
# Optional: per-channel / per-user session settings
|
||||||
session:
|
session:
|
||||||
assistant_id: mobile-agent # custom agent names are also supported here
|
assistant_id: mobile-agent # custom agent names are also supported here
|
||||||
@@ -371,6 +458,14 @@ SLACK_APP_TOKEN=xapp-...
|
|||||||
# Feishu / Lark
|
# Feishu / Lark
|
||||||
FEISHU_APP_ID=cli_xxxx
|
FEISHU_APP_ID=cli_xxxx
|
||||||
FEISHU_APP_SECRET=your_app_secret
|
FEISHU_APP_SECRET=your_app_secret
|
||||||
|
|
||||||
|
# WeChat iLink
|
||||||
|
WECHAT_BOT_TOKEN=your_ilink_bot_token
|
||||||
|
WECHAT_ILINK_BOT_ID=your_ilink_bot_id
|
||||||
|
|
||||||
|
# WeCom
|
||||||
|
WECOM_BOT_ID=your_bot_id
|
||||||
|
WECOM_BOT_SECRET=your_bot_secret
|
||||||
```
|
```
|
||||||
|
|
||||||
**Telegram Setup**
|
**Telegram Setup**
|
||||||
@@ -393,6 +488,22 @@ FEISHU_APP_SECRET=your_app_secret
|
|||||||
3. Under **Events**, subscribe to `im.message.receive_v1` and select **Long Connection** mode.
|
3. Under **Events**, subscribe to `im.message.receive_v1` and select **Long Connection** mode.
|
||||||
4. Copy the App ID and App Secret. Set `FEISHU_APP_ID` and `FEISHU_APP_SECRET` in `.env` and enable the channel in `config.yaml`.
|
4. Copy the App ID and App Secret. Set `FEISHU_APP_ID` and `FEISHU_APP_SECRET` in `.env` and enable the channel in `config.yaml`.
|
||||||
|
|
||||||
|
**WeChat Setup**
|
||||||
|
|
||||||
|
1. Enable the `wechat` channel in `config.yaml`.
|
||||||
|
2. Either set `WECHAT_BOT_TOKEN` in `.env`, or set `qrcode_login_enabled: true` for first-time QR bootstrap.
|
||||||
|
3. When `bot_token` is absent and QR bootstrap is enabled, watch backend logs for the QR content returned by iLink and complete the binding flow.
|
||||||
|
4. After the QR flow succeeds, DeerFlow persists the acquired token under `state_dir` for later restarts.
|
||||||
|
5. For Docker Compose deployments, keep `state_dir` on a persistent volume so the `get_updates_buf` cursor and saved auth state survive restarts.
|
||||||
|
|
||||||
|
**WeCom Setup**
|
||||||
|
|
||||||
|
1. Create a bot on the WeCom AI Bot platform and obtain the `bot_id` and `bot_secret`.
|
||||||
|
2. Enable `channels.wecom` in `config.yaml` and fill in `bot_id` / `bot_secret`.
|
||||||
|
3. Set `WECOM_BOT_ID` and `WECOM_BOT_SECRET` in `.env`.
|
||||||
|
4. Make sure backend dependencies include `wecom-aibot-python-sdk`. The channel uses a WebSocket long connection and does not require a public callback URL.
|
||||||
|
5. The current integration supports inbound text, image, and file messages. Final images/files generated by the agent are also sent back to the WeCom conversation.
|
||||||
|
|
||||||
When DeerFlow runs in Docker Compose, IM channels execute inside the `gateway` container. In that case, do not point `channels.langgraph_url` or `channels.gateway_url` at `localhost`; use container service names such as `http://langgraph:2024` and `http://gateway:8001`, or set `DEER_FLOW_CHANNELS_LANGGRAPH_URL` and `DEER_FLOW_CHANNELS_GATEWAY_URL`.
|
When DeerFlow runs in Docker Compose, IM channels execute inside the `gateway` container. In that case, do not point `channels.langgraph_url` or `channels.gateway_url` at `localhost`; use container service names such as `http://langgraph:2024` and `http://gateway:8001`, or set `DEER_FLOW_CHANNELS_LANGGRAPH_URL` and `DEER_FLOW_CHANNELS_GATEWAY_URL`.
|
||||||
|
|
||||||
**Commands**
|
**Commands**
|
||||||
@@ -422,6 +533,27 @@ LANGSMITH_API_KEY=lsv2_pt_xxxxxxxxxxxxxxxx
|
|||||||
LANGSMITH_PROJECT=xxx
|
LANGSMITH_PROJECT=xxx
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Langfuse Tracing
|
||||||
|
|
||||||
|
DeerFlow also supports [Langfuse](https://langfuse.com) observability for LangChain-compatible runs.
|
||||||
|
|
||||||
|
Add the following to your `.env` file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
LANGFUSE_TRACING=true
|
||||||
|
LANGFUSE_PUBLIC_KEY=pk-lf-xxxxxxxxxxxxxxxx
|
||||||
|
LANGFUSE_SECRET_KEY=sk-lf-xxxxxxxxxxxxxxxx
|
||||||
|
LANGFUSE_BASE_URL=https://cloud.langfuse.com
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using a self-hosted Langfuse instance, set `LANGFUSE_BASE_URL` to your deployment URL.
|
||||||
|
|
||||||
|
#### Using Both Providers
|
||||||
|
|
||||||
|
If both LangSmith and Langfuse are enabled, DeerFlow attaches both tracing callbacks and reports the same model activity to both systems.
|
||||||
|
|
||||||
|
If a provider is explicitly enabled but missing required credentials, or if its callback fails to initialize, DeerFlow fails fast when tracing is initialized during model creation and the error message names the provider that caused the failure.
|
||||||
|
|
||||||
For Docker deployments, tracing is disabled by default. Set `LANGSMITH_TRACING=true` and `LANGSMITH_API_KEY` in your `.env` to enable it.
|
For Docker deployments, tracing is disabled by default. Set `LANGSMITH_TRACING=true` and `LANGSMITH_API_KEY` in your `.env` to enable it.
|
||||||
|
|
||||||
## From Deep Research to Super Agent Harness
|
## From Deep Research to Super Agent Harness
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ https://github.com/user-attachments/assets/a8bcadc4-e040-4cf2-8fda-dd768b999c18
|
|||||||
- [快速开始](#快速开始)
|
- [快速开始](#快速开始)
|
||||||
- [配置](#配置)
|
- [配置](#配置)
|
||||||
- [运行应用](#运行应用)
|
- [运行应用](#运行应用)
|
||||||
|
- [部署建议与资源规划](#部署建议与资源规划)
|
||||||
- [方式一:Docker(推荐)](#方式一docker推荐)
|
- [方式一:Docker(推荐)](#方式一docker推荐)
|
||||||
- [方式二:本地开发](#方式二本地开发)
|
- [方式二:本地开发](#方式二本地开发)
|
||||||
- [进阶配置](#进阶配置)
|
- [进阶配置](#进阶配置)
|
||||||
@@ -150,6 +151,20 @@ https://github.com/user-attachments/assets/a8bcadc4-e040-4cf2-8fda-dd768b999c18
|
|||||||
|
|
||||||
### 运行应用
|
### 运行应用
|
||||||
|
|
||||||
|
#### 部署建议与资源规划
|
||||||
|
|
||||||
|
可以先按下面的资源档位来选择 DeerFlow 的运行方式:
|
||||||
|
|
||||||
|
| 部署场景 | 起步配置 | 推荐配置 | 说明 |
|
||||||
|
|---------|-----------|------------|-------|
|
||||||
|
| 本地体验 / `make dev` | 4 vCPU、8 GB 内存、20 GB SSD 可用空间 | 8 vCPU、16 GB 内存 | 适合单个开发者或单个轻量会话,且模型走外部 API。`2 核 / 4 GB` 通常跑不稳。 |
|
||||||
|
| Docker 开发 / `make docker-start` | 4 vCPU、8 GB 内存、25 GB SSD 可用空间 | 8 vCPU、16 GB 内存 | 镜像构建、源码挂载和 sandbox 容器都会比纯本地模式更吃资源。 |
|
||||||
|
| 长期运行服务 / `make up` | 8 vCPU、16 GB 内存、40 GB SSD 可用空间 | 16 vCPU、32 GB 内存 | 更适合共享环境、多 agent 任务、报告生成或更重的 sandbox 负载。 |
|
||||||
|
|
||||||
|
- 上面的配置只覆盖 DeerFlow 本身;如果你还要本机部署本地大模型,请单独为模型服务预留资源。
|
||||||
|
- 持续运行的服务更推荐使用 Linux + Docker。macOS 和 Windows 更适合作为开发机或体验环境。
|
||||||
|
- 如果 CPU 或内存长期打满,先降低并发会话或重任务数量,再考虑升级到更高一档配置。
|
||||||
|
|
||||||
#### 方式一:Docker(推荐)
|
#### 方式一:Docker(推荐)
|
||||||
|
|
||||||
**开发模式**(支持热更新,挂载源码):
|
**开发模式**(支持热更新,挂载源码):
|
||||||
@@ -180,6 +195,7 @@ make down # 停止并移除容器
|
|||||||
如果你更希望直接在本地启动各个服务:
|
如果你更希望直接在本地启动各个服务:
|
||||||
|
|
||||||
前提:先完成上面的“配置”步骤(`make config` 和模型 API key 配置)。`make dev` 需要有效配置文件,默认读取项目根目录下的 `config.yaml`,也可以通过 `DEER_FLOW_CONFIG_PATH` 覆盖。
|
前提:先完成上面的“配置”步骤(`make config` 和模型 API key 配置)。`make dev` 需要有效配置文件,默认读取项目根目录下的 `config.yaml`,也可以通过 `DEER_FLOW_CONFIG_PATH` 覆盖。
|
||||||
|
在 Windows 上,请使用 Git Bash 运行本地开发流程。基于 bash 的服务脚本不支持直接在原生 `cmd.exe` 或 PowerShell 中执行,且 WSL 也不保证可用,因为部分脚本依赖 Git for Windows 的 `cygpath` 等工具。
|
||||||
|
|
||||||
1. **检查依赖环境**:
|
1. **检查依赖环境**:
|
||||||
```bash
|
```bash
|
||||||
@@ -231,6 +247,7 @@ DeerFlow 支持从即时通讯应用接收任务。只要配置完成,对应
|
|||||||
| Telegram | Bot API(long-polling) | 简单 |
|
| Telegram | Bot API(long-polling) | 简单 |
|
||||||
| Slack | Socket Mode | 中等 |
|
| Slack | Socket Mode | 中等 |
|
||||||
| Feishu / Lark | WebSocket | 中等 |
|
| Feishu / Lark | WebSocket | 中等 |
|
||||||
|
| 企业微信智能机器人 | WebSocket | 中等 |
|
||||||
|
|
||||||
**`config.yaml` 中的配置示例:**
|
**`config.yaml` 中的配置示例:**
|
||||||
|
|
||||||
@@ -258,6 +275,11 @@ channels:
|
|||||||
# domain: https://open.feishu.cn # 国内版(默认)
|
# domain: https://open.feishu.cn # 国内版(默认)
|
||||||
# domain: https://open.larksuite.com # 国际版
|
# domain: https://open.larksuite.com # 国际版
|
||||||
|
|
||||||
|
wecom:
|
||||||
|
enabled: true
|
||||||
|
bot_id: $WECOM_BOT_ID
|
||||||
|
bot_secret: $WECOM_BOT_SECRET
|
||||||
|
|
||||||
slack:
|
slack:
|
||||||
enabled: true
|
enabled: true
|
||||||
bot_token: $SLACK_BOT_TOKEN # xoxb-...
|
bot_token: $SLACK_BOT_TOKEN # xoxb-...
|
||||||
@@ -301,6 +323,10 @@ SLACK_APP_TOKEN=xapp-...
|
|||||||
# Feishu / Lark
|
# Feishu / Lark
|
||||||
FEISHU_APP_ID=cli_xxxx
|
FEISHU_APP_ID=cli_xxxx
|
||||||
FEISHU_APP_SECRET=your_app_secret
|
FEISHU_APP_SECRET=your_app_secret
|
||||||
|
|
||||||
|
# 企业微信智能机器人
|
||||||
|
WECOM_BOT_ID=your_bot_id
|
||||||
|
WECOM_BOT_SECRET=your_bot_secret
|
||||||
```
|
```
|
||||||
|
|
||||||
**Telegram 配置**
|
**Telegram 配置**
|
||||||
@@ -323,6 +349,14 @@ FEISHU_APP_SECRET=your_app_secret
|
|||||||
3. 在 **事件订阅** 中订阅 `im.message.receive_v1`,连接方式选择 **长连接**。
|
3. 在 **事件订阅** 中订阅 `im.message.receive_v1`,连接方式选择 **长连接**。
|
||||||
4. 复制 App ID 和 App Secret,在 `.env` 中设置 `FEISHU_APP_ID` 和 `FEISHU_APP_SECRET`,并在 `config.yaml` 中启用该渠道。
|
4. 复制 App ID 和 App Secret,在 `.env` 中设置 `FEISHU_APP_ID` 和 `FEISHU_APP_SECRET`,并在 `config.yaml` 中启用该渠道。
|
||||||
|
|
||||||
|
**企业微信智能机器人配置**
|
||||||
|
|
||||||
|
1. 在企业微信智能机器人平台创建机器人,获取 `bot_id` 和 `bot_secret`。
|
||||||
|
2. 在 `config.yaml` 中启用 `channels.wecom`,并填入 `bot_id` / `bot_secret`。
|
||||||
|
3. 在 `.env` 中设置 `WECOM_BOT_ID` 和 `WECOM_BOT_SECRET`。
|
||||||
|
4. 安装后端依赖时确保包含 `wecom-aibot-python-sdk`,渠道会通过 WebSocket 长连接接收消息,无需公网回调地址。
|
||||||
|
5. 当前支持文本、图片和文件入站消息;agent 生成的最终图片/文件也会回传到企业微信会话中。
|
||||||
|
|
||||||
**命令**
|
**命令**
|
||||||
|
|
||||||
渠道连接完成后,你可以直接在聊天窗口里和 DeerFlow 交互:
|
渠道连接完成后,你可以直接在聊天窗口里和 DeerFlow 交互:
|
||||||
|
|||||||
+40
-7
@@ -13,6 +13,10 @@ DeerFlow is a LangGraph-based AI super agent system with a full-stack architectu
|
|||||||
- **Nginx** (port 2026): Unified reverse proxy entry point
|
- **Nginx** (port 2026): Unified reverse proxy entry point
|
||||||
- **Provisioner** (port 8002, optional in Docker dev): Started only when sandbox is configured for provisioner/Kubernetes mode
|
- **Provisioner** (port 8002, optional in Docker dev): Started only when sandbox is configured for provisioner/Kubernetes mode
|
||||||
|
|
||||||
|
**Runtime Modes**:
|
||||||
|
- **Standard mode** (`make dev`): LangGraph Server handles agent execution as a separate process. 4 processes total.
|
||||||
|
- **Gateway mode** (`make dev-pro`, experimental): Agent runtime embedded in Gateway via `RunManager` + `run_agent()` + `StreamBridge` (`packages/harness/deerflow/runtime/`). Service manages its own concurrency via async tasks. 3 processes total, no LangGraph Server.
|
||||||
|
|
||||||
**Project Structure**:
|
**Project Structure**:
|
||||||
```
|
```
|
||||||
deer-flow/
|
deer-flow/
|
||||||
@@ -80,6 +84,8 @@ When making code changes, you MUST update the relevant documentation:
|
|||||||
make check # Check system requirements
|
make check # Check system requirements
|
||||||
make install # Install all dependencies (frontend + backend)
|
make install # Install all dependencies (frontend + backend)
|
||||||
make dev # Start all services (LangGraph + Gateway + Frontend + Nginx), with config.yaml preflight
|
make dev # Start all services (LangGraph + Gateway + Frontend + Nginx), with config.yaml preflight
|
||||||
|
make dev-pro # Gateway mode (experimental): skip LangGraph, agent runtime embedded in Gateway
|
||||||
|
make start-pro # Production + Gateway mode (experimental)
|
||||||
make stop # Stop all services
|
make stop # Stop all services
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -232,7 +238,7 @@ Proxied through nginx: `/api/langgraph/*` → LangGraph, all other `/api/*` →
|
|||||||
- `ls` - Directory listing (tree format, max 2 levels)
|
- `ls` - Directory listing (tree format, max 2 levels)
|
||||||
- `read_file` - Read file contents with optional line range
|
- `read_file` - Read file contents with optional line range
|
||||||
- `write_file` - Write/append to files, creates directories
|
- `write_file` - Write/append to files, creates directories
|
||||||
- `str_replace` - Substring replacement (single or all occurrences)
|
- `str_replace` - Substring replacement (single or all occurrences); same-path serialization is scoped to `(sandbox.id, path)` so isolated sandboxes do not contend on identical virtual paths inside one process
|
||||||
|
|
||||||
### Subagent System (`packages/harness/deerflow/subagents/`)
|
### Subagent System (`packages/harness/deerflow/subagents/`)
|
||||||
|
|
||||||
@@ -287,10 +293,17 @@ Proxied through nginx: `/api/langgraph/*` → LangGraph, all other `/api/*` →
|
|||||||
|
|
||||||
- `create_chat_model(name, thinking_enabled)` instantiates LLM from config via reflection
|
- `create_chat_model(name, thinking_enabled)` instantiates LLM from config via reflection
|
||||||
- Supports `thinking_enabled` flag with per-model `when_thinking_enabled` overrides
|
- Supports `thinking_enabled` flag with per-model `when_thinking_enabled` overrides
|
||||||
|
- Supports vLLM-style thinking toggles via `when_thinking_enabled.extra_body.chat_template_kwargs.enable_thinking` for Qwen reasoning models, while normalizing legacy `thinking` configs for backward compatibility
|
||||||
- Supports `supports_vision` flag for image understanding models
|
- Supports `supports_vision` flag for image understanding models
|
||||||
- Config values starting with `$` resolved as environment variables
|
- Config values starting with `$` resolved as environment variables
|
||||||
- Missing provider modules surface actionable install hints from reflection resolvers (for example `uv add langchain-google-genai`)
|
- Missing provider modules surface actionable install hints from reflection resolvers (for example `uv add langchain-google-genai`)
|
||||||
|
|
||||||
|
### vLLM Provider (`packages/harness/deerflow/models/vllm_provider.py`)
|
||||||
|
|
||||||
|
- `VllmChatModel` subclasses `langchain_openai:ChatOpenAI` for vLLM 0.19.0 OpenAI-compatible endpoints
|
||||||
|
- Preserves vLLM's non-standard assistant `reasoning` field on full responses, streaming deltas, and follow-up tool-call turns
|
||||||
|
- Designed for configs that enable thinking through `extra_body.chat_template_kwargs.enable_thinking` on vLLM 0.19.0 Qwen reasoning models, while accepting the older `thinking` alias
|
||||||
|
|
||||||
### IM Channels System (`app/channels/`)
|
### IM Channels System (`app/channels/`)
|
||||||
|
|
||||||
Bridges external messaging platforms (Feishu, Slack, Telegram) to the DeerFlow agent via the LangGraph Server.
|
Bridges external messaging platforms (Feishu, Slack, Telegram) to the DeerFlow agent via the LangGraph Server.
|
||||||
@@ -359,6 +372,7 @@ Focused regression coverage for the updater lives in `backend/tests/test_memory_
|
|||||||
|
|
||||||
**`config.yaml`** key sections:
|
**`config.yaml`** key sections:
|
||||||
- `models[]` - LLM configs with `use` class path, `supports_thinking`, `supports_vision`, provider-specific fields
|
- `models[]` - LLM configs with `use` class path, `supports_thinking`, `supports_vision`, provider-specific fields
|
||||||
|
- vLLM reasoning models should use `deerflow.models.vllm_provider:VllmChatModel`; for Qwen-style parsers prefer `when_thinking_enabled.extra_body.chat_template_kwargs.enable_thinking`, and DeerFlow will also normalize the older `thinking` alias
|
||||||
- `tools[]` - Tool configs with `use` variable path and `group`
|
- `tools[]` - Tool configs with `use` variable path and `group`
|
||||||
- `tool_groups[]` - Logical groupings for tools
|
- `tool_groups[]` - Logical groupings for tools
|
||||||
- `sandbox.use` - Sandbox provider class path
|
- `sandbox.use` - Sandbox provider class path
|
||||||
@@ -381,14 +395,16 @@ Both can be modified at runtime via Gateway API endpoints or `DeerFlowClient` me
|
|||||||
**Architecture**: Imports the same `deerflow` modules that LangGraph Server and Gateway API use. Shares the same config files and data directories. No FastAPI dependency.
|
**Architecture**: Imports the same `deerflow` modules that LangGraph Server and Gateway API use. Shares the same config files and data directories. No FastAPI dependency.
|
||||||
|
|
||||||
**Agent Conversation** (replaces LangGraph Server):
|
**Agent Conversation** (replaces LangGraph Server):
|
||||||
- `chat(message, thread_id)` — synchronous, returns final text
|
- `chat(message, thread_id)` — synchronous, accumulates streaming deltas per message-id and returns the final AI text
|
||||||
- `stream(message, thread_id)` — yields `StreamEvent` aligned with LangGraph SSE protocol:
|
- `stream(message, thread_id)` — subscribes to LangGraph `stream_mode=["values", "messages", "custom"]` and yields `StreamEvent`:
|
||||||
- `"values"` — full state snapshot (title, messages, artifacts)
|
- `"values"` — full state snapshot (title, messages, artifacts); AI text already delivered via `messages` mode is **not** re-synthesized here to avoid duplicate deliveries
|
||||||
- `"messages-tuple"` — per-message update (AI text, tool calls, tool results)
|
- `"messages-tuple"` — per-chunk update: for AI text this is a **delta** (concat per `id` to rebuild the full message); tool calls and tool results are emitted once each
|
||||||
- `"end"` — stream finished
|
- `"custom"` — forwarded from `StreamWriter`
|
||||||
|
- `"end"` — stream finished (carries cumulative `usage` counted once per message id)
|
||||||
- Agent created lazily via `create_agent()` + `_build_middlewares()`, same as `make_lead_agent`
|
- Agent created lazily via `create_agent()` + `_build_middlewares()`, same as `make_lead_agent`
|
||||||
- Supports `checkpointer` parameter for state persistence across turns
|
- Supports `checkpointer` parameter for state persistence across turns
|
||||||
- `reset_agent()` forces agent recreation (e.g. after memory or skill changes)
|
- `reset_agent()` forces agent recreation (e.g. after memory or skill changes)
|
||||||
|
- See [docs/STREAMING.md](docs/STREAMING.md) for the full design: why Gateway and DeerFlowClient are parallel paths, LangGraph's `stream_mode` semantics, the per-id dedup invariants, and regression testing strategy
|
||||||
|
|
||||||
**Gateway Equivalent Methods** (replaces Gateway API):
|
**Gateway Equivalent Methods** (replaces Gateway API):
|
||||||
|
|
||||||
@@ -436,8 +452,25 @@ make dev
|
|||||||
|
|
||||||
This starts all services and makes the application available at `http://localhost:2026`.
|
This starts all services and makes the application available at `http://localhost:2026`.
|
||||||
|
|
||||||
|
**All startup modes:**
|
||||||
|
|
||||||
|
| | **Local Foreground** | **Local Daemon** | **Docker Dev** | **Docker Prod** |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| **Dev** | `./scripts/serve.sh --dev`<br/>`make dev` | `./scripts/serve.sh --dev --daemon`<br/>`make dev-daemon` | `./scripts/docker.sh start`<br/>`make docker-start` | — |
|
||||||
|
| **Dev + Gateway** | `./scripts/serve.sh --dev --gateway`<br/>`make dev-pro` | `./scripts/serve.sh --dev --gateway --daemon`<br/>`make dev-daemon-pro` | `./scripts/docker.sh start --gateway`<br/>`make docker-start-pro` | — |
|
||||||
|
| **Prod** | `./scripts/serve.sh --prod`<br/>`make start` | `./scripts/serve.sh --prod --daemon`<br/>`make start-daemon` | — | `./scripts/deploy.sh`<br/>`make up` |
|
||||||
|
| **Prod + Gateway** | `./scripts/serve.sh --prod --gateway`<br/>`make start-pro` | `./scripts/serve.sh --prod --gateway --daemon`<br/>`make start-daemon-pro` | — | `./scripts/deploy.sh --gateway`<br/>`make up-pro` |
|
||||||
|
|
||||||
|
| Action | Local | Docker Dev | Docker Prod |
|
||||||
|
|---|---|---|---|
|
||||||
|
| **Stop** | `./scripts/serve.sh --stop`<br/>`make stop` | `./scripts/docker.sh stop`<br/>`make docker-stop` | `./scripts/deploy.sh down`<br/>`make down` |
|
||||||
|
| **Restart** | `./scripts/serve.sh --restart [flags]` | `./scripts/docker.sh restart` | — |
|
||||||
|
|
||||||
|
Gateway mode embeds the agent runtime in Gateway, no LangGraph server.
|
||||||
|
|
||||||
**Nginx routing**:
|
**Nginx routing**:
|
||||||
- `/api/langgraph/*` → LangGraph Server (2024)
|
- Standard mode: `/api/langgraph/*` → LangGraph Server (2024)
|
||||||
|
- Gateway mode: `/api/langgraph/*` → Gateway embedded runtime (8001) (via envsubst)
|
||||||
- `/api/*` (other) → Gateway API (8001)
|
- `/api/*` (other) → Gateway API (8001)
|
||||||
- `/` (non-API) → Frontend (3000)
|
- `/` (non-API) → Frontend (3000)
|
||||||
|
|
||||||
|
|||||||
+49
-10
@@ -1,14 +1,21 @@
|
|||||||
# Backend Development Dockerfile
|
# Backend Dockerfile — multi-stage build
|
||||||
|
# Stage 1 (builder): compiles native Python extensions with build-essential
|
||||||
|
# Stage 2 (dev): retains toolchain for dev containers (uv sync at startup)
|
||||||
|
# Stage 3 (runtime): clean image without compiler toolchain for production
|
||||||
|
|
||||||
# UV source image (override for restricted networks that cannot reach ghcr.io)
|
# UV source image (override for restricted networks that cannot reach ghcr.io)
|
||||||
ARG UV_IMAGE=ghcr.io/astral-sh/uv:0.7.20
|
ARG UV_IMAGE=ghcr.io/astral-sh/uv:0.7.20
|
||||||
FROM ${UV_IMAGE} AS uv-source
|
FROM ${UV_IMAGE} AS uv-source
|
||||||
|
|
||||||
FROM python:3.12-slim-bookworm
|
# ── Stage 1: Builder ──────────────────────────────────────────────────────────
|
||||||
|
FROM python:3.12-slim-bookworm AS builder
|
||||||
|
|
||||||
ARG NODE_MAJOR=22
|
ARG NODE_MAJOR=22
|
||||||
ARG APT_MIRROR
|
ARG APT_MIRROR
|
||||||
ARG UV_INDEX_URL
|
ARG UV_INDEX_URL
|
||||||
|
# Optional extras to install (e.g. "postgres" for PostgreSQL support)
|
||||||
|
# Usage: docker build --build-arg UV_EXTRAS=postgres ...
|
||||||
|
ARG UV_EXTRAS
|
||||||
|
|
||||||
# Optionally override apt mirror for restricted networks (e.g. APT_MIRROR=mirrors.aliyun.com)
|
# Optionally override apt mirror for restricted networks (e.g. APT_MIRROR=mirrors.aliyun.com)
|
||||||
RUN if [ -n "${APT_MIRROR}" ]; then \
|
RUN if [ -n "${APT_MIRROR}" ]; then \
|
||||||
@@ -16,7 +23,7 @@ RUN if [ -n "${APT_MIRROR}" ]; then \
|
|||||||
sed -i "s|deb.debian.org|${APT_MIRROR}|g" /etc/apt/sources.list 2>/dev/null || true; \
|
sed -i "s|deb.debian.org|${APT_MIRROR}|g" /etc/apt/sources.list 2>/dev/null || true; \
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Install system dependencies + Node.js (provides npx for MCP servers)
|
# Install build tools + Node.js (build-essential needed for native Python extensions)
|
||||||
RUN apt-get update && apt-get install -y \
|
RUN apt-get update && apt-get install -y \
|
||||||
curl \
|
curl \
|
||||||
build-essential \
|
build-essential \
|
||||||
@@ -29,6 +36,42 @@ RUN apt-get update && apt-get install -y \
|
|||||||
&& apt-get install -y nodejs \
|
&& apt-get install -y nodejs \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# Install uv (source image overridable via UV_IMAGE build arg)
|
||||||
|
COPY --from=uv-source /uv /uvx /usr/local/bin/
|
||||||
|
|
||||||
|
# Set working directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Copy backend source code
|
||||||
|
COPY backend ./backend
|
||||||
|
|
||||||
|
# Install dependencies with cache mount
|
||||||
|
# When UV_EXTRAS is set (e.g. "postgres"), installs optional dependencies.
|
||||||
|
RUN --mount=type=cache,target=/root/.cache/uv \
|
||||||
|
sh -c "cd backend && UV_INDEX_URL=${UV_INDEX_URL:-https://pypi.org/simple} uv sync ${UV_EXTRAS:+--extra $UV_EXTRAS}"
|
||||||
|
|
||||||
|
# ── Stage 2: Dev ──────────────────────────────────────────────────────────────
|
||||||
|
# Retains compiler toolchain from builder so startup-time `uv sync` can build
|
||||||
|
# source distributions in development containers.
|
||||||
|
FROM builder AS dev
|
||||||
|
|
||||||
|
# Install Docker CLI (for DooD: allows starting sandbox containers via host Docker socket)
|
||||||
|
COPY --from=docker:cli /usr/local/bin/docker /usr/local/bin/docker
|
||||||
|
|
||||||
|
EXPOSE 8001 2024
|
||||||
|
|
||||||
|
CMD ["sh", "-c", "cd backend && PYTHONPATH=. uv run uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001"]
|
||||||
|
|
||||||
|
# ── Stage 3: Runtime ──────────────────────────────────────────────────────────
|
||||||
|
# Clean image without build-essential — reduces size (~200 MB) and attack surface.
|
||||||
|
FROM python:3.12-slim-bookworm
|
||||||
|
|
||||||
|
# Copy Node.js runtime from builder (provides npx for MCP servers)
|
||||||
|
COPY --from=builder /usr/bin/node /usr/bin/node
|
||||||
|
COPY --from=builder /usr/lib/node_modules /usr/lib/node_modules
|
||||||
|
RUN ln -s ../lib/node_modules/npm/bin/npm-cli.js /usr/bin/npm \
|
||||||
|
&& ln -s ../lib/node_modules/npm/bin/npx-cli.js /usr/bin/npx
|
||||||
|
|
||||||
# Install Docker CLI (for DooD: allows starting sandbox containers via host Docker socket)
|
# Install Docker CLI (for DooD: allows starting sandbox containers via host Docker socket)
|
||||||
COPY --from=docker:cli /usr/local/bin/docker /usr/local/bin/docker
|
COPY --from=docker:cli /usr/local/bin/docker /usr/local/bin/docker
|
||||||
|
|
||||||
@@ -38,15 +81,11 @@ COPY --from=uv-source /uv /uvx /usr/local/bin/
|
|||||||
# Set working directory
|
# Set working directory
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# Copy frontend source code
|
# Copy backend with pre-built virtualenv from builder
|
||||||
COPY backend ./backend
|
COPY --from=builder /app/backend ./backend
|
||||||
|
|
||||||
# Install dependencies with cache mount
|
|
||||||
RUN --mount=type=cache,target=/root/.cache/uv \
|
|
||||||
sh -c "cd backend && UV_INDEX_URL=${UV_INDEX_URL:-https://pypi.org/simple} uv sync"
|
|
||||||
|
|
||||||
# Expose ports (gateway: 8001, langgraph: 2024)
|
# Expose ports (gateway: 8001, langgraph: 2024)
|
||||||
EXPOSE 8001 2024
|
EXPOSE 8001 2024
|
||||||
|
|
||||||
# Default command (can be overridden in docker-compose)
|
# Default command (can be overridden in docker-compose)
|
||||||
CMD ["sh", "-c", "cd backend && PYTHONPATH=. uv run uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001"]
|
CMD ["sh", "-c", "cd backend && PYTHONPATH=. uv run --no-sync uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001"]
|
||||||
|
|||||||
+1
-1
@@ -2,7 +2,7 @@ install:
|
|||||||
uv sync
|
uv sync
|
||||||
|
|
||||||
dev:
|
dev:
|
||||||
uv run langgraph dev --no-browser --allow-blocking --no-reload
|
uv run langgraph dev --no-browser --no-reload --n-jobs-per-worker 10
|
||||||
|
|
||||||
gateway:
|
gateway:
|
||||||
PYTHONPATH=. uv run uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001
|
PYTHONPATH=. uv run uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001
|
||||||
|
|||||||
+23
-1
@@ -78,6 +78,7 @@ Per-thread isolated execution with virtual path translation:
|
|||||||
- **Virtual paths**: `/mnt/user-data/{workspace,uploads,outputs}` → thread-specific physical directories
|
- **Virtual paths**: `/mnt/user-data/{workspace,uploads,outputs}` → thread-specific physical directories
|
||||||
- **Skills path**: `/mnt/skills` → `deer-flow/skills/` directory
|
- **Skills path**: `/mnt/skills` → `deer-flow/skills/` directory
|
||||||
- **Skills loading**: Recursively discovers nested `SKILL.md` files under `skills/{public,custom}` and preserves nested container paths
|
- **Skills loading**: Recursively discovers nested `SKILL.md` files under `skills/{public,custom}` and preserves nested container paths
|
||||||
|
- **File-write safety**: `str_replace` serializes read-modify-write per `(sandbox.id, path)` so isolated sandboxes keep concurrency even when virtual paths match
|
||||||
- **Tools**: `bash`, `ls`, `read_file`, `write_file`, `str_replace` (`bash` is disabled by default when using `LocalSandboxProvider`; use `AioSandboxProvider` for isolated shell access)
|
- **Tools**: `bash`, `ls`, `read_file`, `write_file`, `str_replace` (`bash` is disabled by default when using `LocalSandboxProvider`; use `AioSandboxProvider` for isolated shell access)
|
||||||
|
|
||||||
### Subagent System
|
### Subagent System
|
||||||
@@ -330,7 +331,28 @@ LANGSMITH_PROJECT=xxx
|
|||||||
|
|
||||||
**Legacy variables:** The `LANGCHAIN_TRACING_V2`, `LANGCHAIN_API_KEY`, `LANGCHAIN_PROJECT`, and `LANGCHAIN_ENDPOINT` variables are also supported for backward compatibility. `LANGSMITH_*` variables take precedence when both are set.
|
**Legacy variables:** The `LANGCHAIN_TRACING_V2`, `LANGCHAIN_API_KEY`, `LANGCHAIN_PROJECT`, and `LANGCHAIN_ENDPOINT` variables are also supported for backward compatibility. `LANGSMITH_*` variables take precedence when both are set.
|
||||||
|
|
||||||
**Docker:** In `docker-compose.yaml`, tracing is disabled by default (`LANGSMITH_TRACING=false`). Set `LANGSMITH_TRACING=true` and provide `LANGSMITH_API_KEY` in your `.env` to enable it in containerized deployments.
|
### Langfuse Tracing
|
||||||
|
|
||||||
|
DeerFlow also supports [Langfuse](https://langfuse.com) observability for LangChain-compatible runs.
|
||||||
|
|
||||||
|
Add the following to your `.env` file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
LANGFUSE_TRACING=true
|
||||||
|
LANGFUSE_PUBLIC_KEY=pk-lf-xxxxxxxxxxxxxxxx
|
||||||
|
LANGFUSE_SECRET_KEY=sk-lf-xxxxxxxxxxxxxxxx
|
||||||
|
LANGFUSE_BASE_URL=https://cloud.langfuse.com
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using a self-hosted Langfuse deployment, set `LANGFUSE_BASE_URL` to your Langfuse host.
|
||||||
|
|
||||||
|
### Dual Provider Behavior
|
||||||
|
|
||||||
|
If both LangSmith and Langfuse are enabled, DeerFlow initializes and attaches both callbacks so the same run data is reported to both systems.
|
||||||
|
|
||||||
|
If a provider is explicitly enabled but required credentials are missing, or the provider callback cannot be initialized, DeerFlow raises an error when tracing is initialized during model creation instead of silently disabling tracing.
|
||||||
|
|
||||||
|
**Docker:** In `docker-compose.yaml`, tracing is disabled by default (`LANGSMITH_TRACING=false`). Set `LANGSMITH_TRACING=true` and/or `LANGFUSE_TRACING=true` in your `.env`, together with the required credentials, to enable tracing in containerized deployments.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -106,3 +106,21 @@ class Channel(ABC):
|
|||||||
logger.warning("[%s] file upload skipped for %s", self.name, attachment.filename)
|
logger.warning("[%s] file upload skipped for %s", self.name, attachment.filename)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("[%s] failed to upload file %s", self.name, attachment.filename)
|
logger.exception("[%s] failed to upload file %s", self.name, attachment.filename)
|
||||||
|
|
||||||
|
async def receive_file(self, msg: InboundMessage, thread_id: str) -> InboundMessage:
|
||||||
|
"""
|
||||||
|
Optionally process and materialize inbound file attachments for this channel.
|
||||||
|
|
||||||
|
By default, this method does nothing and simply returns the original message.
|
||||||
|
Subclasses (e.g. FeishuChannel) may override this to download files (images, documents, etc)
|
||||||
|
referenced in msg.files, save them to the sandbox, and update msg.text to include
|
||||||
|
the sandbox file paths for downstream model consumption.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
msg: The inbound message, possibly containing file metadata in msg.files.
|
||||||
|
thread_id: The resolved DeerFlow thread ID for sandbox path context.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
The (possibly modified) InboundMessage, with text and/or files updated as needed.
|
||||||
|
"""
|
||||||
|
return msg
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
"""Shared command definitions used by all channel implementations.
|
||||||
|
|
||||||
|
Keeping the authoritative command set in one place ensures that channel
|
||||||
|
parsers (e.g. Feishu) and the ChannelManager dispatcher stay in sync
|
||||||
|
automatically — adding or removing a command here is the single edit
|
||||||
|
required.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
KNOWN_CHANNEL_COMMANDS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"/bootstrap",
|
||||||
|
"/new",
|
||||||
|
"/status",
|
||||||
|
"/models",
|
||||||
|
"/memory",
|
||||||
|
"/help",
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -5,15 +5,25 @@ from __future__ import annotations
|
|||||||
import asyncio
|
import asyncio
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
import threading
|
import threading
|
||||||
from typing import Any
|
from typing import Any, Literal
|
||||||
|
|
||||||
from app.channels.base import Channel
|
from app.channels.base import Channel
|
||||||
from app.channels.message_bus import InboundMessageType, MessageBus, OutboundMessage, ResolvedAttachment
|
from app.channels.commands import KNOWN_CHANNEL_COMMANDS
|
||||||
|
from app.channels.message_bus import InboundMessage, InboundMessageType, MessageBus, OutboundMessage, ResolvedAttachment
|
||||||
|
from deerflow.config.paths import VIRTUAL_PATH_PREFIX, get_paths
|
||||||
|
from deerflow.sandbox.sandbox_provider import get_sandbox_provider
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_feishu_command(text: str) -> bool:
|
||||||
|
if not text.startswith("/"):
|
||||||
|
return False
|
||||||
|
return text.split(maxsplit=1)[0].lower() in KNOWN_CHANNEL_COMMANDS
|
||||||
|
|
||||||
|
|
||||||
class FeishuChannel(Channel):
|
class FeishuChannel(Channel):
|
||||||
"""Feishu/Lark IM channel using the ``lark-oapi`` WebSocket client.
|
"""Feishu/Lark IM channel using the ``lark-oapi`` WebSocket client.
|
||||||
|
|
||||||
@@ -49,6 +59,8 @@ class FeishuChannel(Channel):
|
|||||||
self._CreateFileRequestBody = None
|
self._CreateFileRequestBody = None
|
||||||
self._CreateImageRequest = None
|
self._CreateImageRequest = None
|
||||||
self._CreateImageRequestBody = None
|
self._CreateImageRequestBody = None
|
||||||
|
self._GetMessageResourceRequest = None
|
||||||
|
self._thread_lock = threading.Lock()
|
||||||
|
|
||||||
async def start(self) -> None:
|
async def start(self) -> None:
|
||||||
if self._running:
|
if self._running:
|
||||||
@@ -66,6 +78,7 @@ class FeishuChannel(Channel):
|
|||||||
CreateMessageRequest,
|
CreateMessageRequest,
|
||||||
CreateMessageRequestBody,
|
CreateMessageRequestBody,
|
||||||
Emoji,
|
Emoji,
|
||||||
|
GetMessageResourceRequest,
|
||||||
PatchMessageRequest,
|
PatchMessageRequest,
|
||||||
PatchMessageRequestBody,
|
PatchMessageRequestBody,
|
||||||
ReplyMessageRequest,
|
ReplyMessageRequest,
|
||||||
@@ -89,6 +102,7 @@ class FeishuChannel(Channel):
|
|||||||
self._CreateFileRequestBody = CreateFileRequestBody
|
self._CreateFileRequestBody = CreateFileRequestBody
|
||||||
self._CreateImageRequest = CreateImageRequest
|
self._CreateImageRequest = CreateImageRequest
|
||||||
self._CreateImageRequestBody = CreateImageRequestBody
|
self._CreateImageRequestBody = CreateImageRequestBody
|
||||||
|
self._GetMessageResourceRequest = GetMessageResourceRequest
|
||||||
|
|
||||||
app_id = self.config.get("app_id", "")
|
app_id = self.config.get("app_id", "")
|
||||||
app_secret = self.config.get("app_secret", "")
|
app_secret = self.config.get("app_secret", "")
|
||||||
@@ -199,7 +213,9 @@ class FeishuChannel(Channel):
|
|||||||
await asyncio.sleep(delay)
|
await asyncio.sleep(delay)
|
||||||
|
|
||||||
logger.error("[Feishu] send failed after %d attempts: %s", _max_retries, last_exc)
|
logger.error("[Feishu] send failed after %d attempts: %s", _max_retries, last_exc)
|
||||||
raise last_exc # type: ignore[misc]
|
if last_exc is None:
|
||||||
|
raise RuntimeError("Feishu send failed without an exception from any attempt")
|
||||||
|
raise last_exc
|
||||||
|
|
||||||
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
||||||
if not self._api_client:
|
if not self._api_client:
|
||||||
@@ -266,6 +282,112 @@ class FeishuChannel(Channel):
|
|||||||
raise RuntimeError(f"Feishu file upload failed: code={response.code}, msg={response.msg}")
|
raise RuntimeError(f"Feishu file upload failed: code={response.code}, msg={response.msg}")
|
||||||
return response.data.file_key
|
return response.data.file_key
|
||||||
|
|
||||||
|
async def receive_file(self, msg: InboundMessage, thread_id: str) -> InboundMessage:
|
||||||
|
"""Download a Feishu file into the thread uploads directory.
|
||||||
|
|
||||||
|
Returns the sandbox virtual path when the image is persisted successfully.
|
||||||
|
"""
|
||||||
|
if not msg.thread_ts:
|
||||||
|
logger.warning("[Feishu] received file message without thread_ts, cannot associate with conversation: %s", msg)
|
||||||
|
return msg
|
||||||
|
files = msg.files
|
||||||
|
if not files:
|
||||||
|
logger.warning("[Feishu] received message with no files: %s", msg)
|
||||||
|
return msg
|
||||||
|
text = msg.text
|
||||||
|
for file in files:
|
||||||
|
if file.get("image_key"):
|
||||||
|
virtual_path = await self._receive_single_file(msg.thread_ts, file["image_key"], "image", thread_id)
|
||||||
|
text = text.replace("[image]", virtual_path, 1)
|
||||||
|
elif file.get("file_key"):
|
||||||
|
virtual_path = await self._receive_single_file(msg.thread_ts, file["file_key"], "file", thread_id)
|
||||||
|
text = text.replace("[file]", virtual_path, 1)
|
||||||
|
msg.text = text
|
||||||
|
return msg
|
||||||
|
|
||||||
|
async def _receive_single_file(self, message_id: str, file_key: str, type: Literal["image", "file"], thread_id: str) -> str:
|
||||||
|
request = self._GetMessageResourceRequest.builder().message_id(message_id).file_key(file_key).type(type).build()
|
||||||
|
|
||||||
|
def inner():
|
||||||
|
return self._api_client.im.v1.message_resource.get(request)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = await asyncio.to_thread(inner)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Feishu] resource get request failed for resource_key=%s type=%s", file_key, type)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
if not response.success():
|
||||||
|
logger.warning(
|
||||||
|
"[Feishu] resource get failed: resource_key=%s, type=%s, code=%s, msg=%s, log_id=%s ",
|
||||||
|
file_key,
|
||||||
|
type,
|
||||||
|
response.code,
|
||||||
|
response.msg,
|
||||||
|
response.get_log_id(),
|
||||||
|
)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
image_stream = getattr(response, "file", None)
|
||||||
|
if image_stream is None:
|
||||||
|
logger.warning("[Feishu] resource get returned no file stream: resource_key=%s, type=%s", file_key, type)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
try:
|
||||||
|
content: bytes = await asyncio.to_thread(image_stream.read)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Feishu] failed to read resource stream: resource_key=%s, type=%s", file_key, type)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
if not content:
|
||||||
|
logger.warning("[Feishu] empty resource content: resource_key=%s, type=%s", file_key, type)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
paths = get_paths()
|
||||||
|
paths.ensure_thread_dirs(thread_id)
|
||||||
|
uploads_dir = paths.sandbox_uploads_dir(thread_id).resolve()
|
||||||
|
|
||||||
|
ext = "png" if type == "image" else "bin"
|
||||||
|
raw_filename = getattr(response, "file_name", "") or f"feishu_{file_key[-12:]}.{ext}"
|
||||||
|
|
||||||
|
# Sanitize filename: preserve extension, replace path chars in name part
|
||||||
|
if "." in raw_filename:
|
||||||
|
name_part, ext = raw_filename.rsplit(".", 1)
|
||||||
|
name_part = re.sub(r"[./\\]", "_", name_part)
|
||||||
|
filename = f"{name_part}.{ext}"
|
||||||
|
else:
|
||||||
|
filename = re.sub(r"[./\\]", "_", raw_filename)
|
||||||
|
resolved_target = uploads_dir / filename
|
||||||
|
|
||||||
|
def down_load():
|
||||||
|
# use thread_lock to avoid filename conflicts when writing
|
||||||
|
with self._thread_lock:
|
||||||
|
resolved_target.write_bytes(content)
|
||||||
|
|
||||||
|
try:
|
||||||
|
await asyncio.to_thread(down_load)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Feishu] failed to persist downloaded resource: %s, type=%s", resolved_target, type)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
virtual_path = f"{VIRTUAL_PATH_PREFIX}/uploads/{resolved_target.name}"
|
||||||
|
|
||||||
|
try:
|
||||||
|
sandbox_provider = get_sandbox_provider()
|
||||||
|
sandbox_id = sandbox_provider.acquire(thread_id)
|
||||||
|
if sandbox_id != "local":
|
||||||
|
sandbox = sandbox_provider.get(sandbox_id)
|
||||||
|
if sandbox is None:
|
||||||
|
logger.warning("[Feishu] sandbox not found for thread_id=%s", thread_id)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
sandbox.update_file(virtual_path, content)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Feishu] failed to sync resource into non-local sandbox: %s", virtual_path)
|
||||||
|
return f"Failed to obtain the [{type}]"
|
||||||
|
|
||||||
|
logger.info("[Feishu] downloaded resource mapped: file_key=%s -> %s", file_key, virtual_path)
|
||||||
|
return virtual_path
|
||||||
|
|
||||||
# -- message formatting ------------------------------------------------
|
# -- message formatting ------------------------------------------------
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
@@ -470,9 +592,28 @@ class FeishuChannel(Channel):
|
|||||||
# Parse message content
|
# Parse message content
|
||||||
content = json.loads(message.content)
|
content = json.loads(message.content)
|
||||||
|
|
||||||
|
# files_list store the any-file-key in feishu messages, which can be used to download the file content later
|
||||||
|
# In Feishu channel, image_keys are independent of file_keys.
|
||||||
|
# The file_key includes files, videos, and audio, but does not include stickers.
|
||||||
|
files_list = []
|
||||||
|
|
||||||
if "text" in content:
|
if "text" in content:
|
||||||
# Handle plain text messages
|
# Handle plain text messages
|
||||||
text = content["text"]
|
text = content["text"]
|
||||||
|
elif "file_key" in content:
|
||||||
|
file_key = content.get("file_key")
|
||||||
|
if isinstance(file_key, str) and file_key:
|
||||||
|
files_list.append({"file_key": file_key})
|
||||||
|
text = "[file]"
|
||||||
|
else:
|
||||||
|
text = ""
|
||||||
|
elif "image_key" in content:
|
||||||
|
image_key = content.get("image_key")
|
||||||
|
if isinstance(image_key, str) and image_key:
|
||||||
|
files_list.append({"image_key": image_key})
|
||||||
|
text = "[image]"
|
||||||
|
else:
|
||||||
|
text = ""
|
||||||
elif "content" in content and isinstance(content["content"], list):
|
elif "content" in content and isinstance(content["content"], list):
|
||||||
# Handle rich-text messages with a top-level "content" list (e.g., topic groups/posts)
|
# Handle rich-text messages with a top-level "content" list (e.g., topic groups/posts)
|
||||||
text_paragraphs: list[str] = []
|
text_paragraphs: list[str] = []
|
||||||
@@ -486,6 +627,16 @@ class FeishuChannel(Channel):
|
|||||||
text_value = element.get("text", "")
|
text_value = element.get("text", "")
|
||||||
if text_value:
|
if text_value:
|
||||||
paragraph_text_parts.append(text_value)
|
paragraph_text_parts.append(text_value)
|
||||||
|
elif element.get("tag") == "img":
|
||||||
|
image_key = element.get("image_key")
|
||||||
|
if isinstance(image_key, str) and image_key:
|
||||||
|
files_list.append({"image_key": image_key})
|
||||||
|
paragraph_text_parts.append("[image]")
|
||||||
|
elif element.get("tag") in ("file", "media"):
|
||||||
|
file_key = element.get("file_key")
|
||||||
|
if isinstance(file_key, str) and file_key:
|
||||||
|
files_list.append({"file_key": file_key})
|
||||||
|
paragraph_text_parts.append("[file]")
|
||||||
if paragraph_text_parts:
|
if paragraph_text_parts:
|
||||||
# Join text segments within a paragraph with spaces to avoid "helloworld"
|
# Join text segments within a paragraph with spaces to avoid "helloworld"
|
||||||
text_paragraphs.append(" ".join(paragraph_text_parts))
|
text_paragraphs.append(" ".join(paragraph_text_parts))
|
||||||
@@ -505,12 +656,13 @@ class FeishuChannel(Channel):
|
|||||||
text[:100] if text else "",
|
text[:100] if text else "",
|
||||||
)
|
)
|
||||||
|
|
||||||
if not text:
|
if not (text or files_list):
|
||||||
logger.info("[Feishu] empty text, ignoring message")
|
logger.info("[Feishu] empty text, ignoring message")
|
||||||
return
|
return
|
||||||
|
|
||||||
# Check if it's a command
|
# Only treat known slash commands as commands; absolute paths and
|
||||||
if text.startswith("/"):
|
# other slash-prefixed text should be handled as normal chat.
|
||||||
|
if _is_feishu_command(text):
|
||||||
msg_type = InboundMessageType.COMMAND
|
msg_type = InboundMessageType.COMMAND
|
||||||
else:
|
else:
|
||||||
msg_type = InboundMessageType.CHAT
|
msg_type = InboundMessageType.CHAT
|
||||||
@@ -524,6 +676,7 @@ class FeishuChannel(Channel):
|
|||||||
text=text,
|
text=text,
|
||||||
msg_type=msg_type,
|
msg_type=msg_type,
|
||||||
thread_ts=msg_id,
|
thread_ts=msg_id,
|
||||||
|
files=files_list,
|
||||||
metadata={"message_id": msg_id, "root_id": root_id},
|
metadata={"message_id": msg_id, "root_id": root_id},
|
||||||
)
|
)
|
||||||
inbound.topic_id = topic_id
|
inbound.topic_id = topic_id
|
||||||
|
|||||||
@@ -7,11 +7,14 @@ import logging
|
|||||||
import mimetypes
|
import mimetypes
|
||||||
import re
|
import re
|
||||||
import time
|
import time
|
||||||
from collections.abc import Mapping
|
from collections.abc import Awaitable, Callable, Mapping
|
||||||
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
import httpx
|
||||||
from langgraph_sdk.errors import ConflictError
|
from langgraph_sdk.errors import ConflictError
|
||||||
|
|
||||||
|
from app.channels.commands import KNOWN_CHANNEL_COMMANDS
|
||||||
from app.channels.message_bus import InboundMessage, InboundMessageType, MessageBus, OutboundMessage, ResolvedAttachment
|
from app.channels.message_bus import InboundMessage, InboundMessageType, MessageBus, OutboundMessage, ResolvedAttachment
|
||||||
from app.channels.store import ChannelStore
|
from app.channels.store import ChannelStore
|
||||||
|
|
||||||
@@ -35,8 +38,67 @@ CHANNEL_CAPABILITIES = {
|
|||||||
"feishu": {"supports_streaming": True},
|
"feishu": {"supports_streaming": True},
|
||||||
"slack": {"supports_streaming": False},
|
"slack": {"supports_streaming": False},
|
||||||
"telegram": {"supports_streaming": False},
|
"telegram": {"supports_streaming": False},
|
||||||
|
"wechat": {"supports_streaming": False},
|
||||||
|
"wecom": {"supports_streaming": True},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
InboundFileReader = Callable[[dict[str, Any], httpx.AsyncClient], Awaitable[bytes | None]]
|
||||||
|
|
||||||
|
|
||||||
|
INBOUND_FILE_READERS: dict[str, InboundFileReader] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def register_inbound_file_reader(channel_name: str, reader: InboundFileReader) -> None:
|
||||||
|
INBOUND_FILE_READERS[channel_name] = reader
|
||||||
|
|
||||||
|
|
||||||
|
async def _read_http_inbound_file(file_info: dict[str, Any], client: httpx.AsyncClient) -> bytes | None:
|
||||||
|
url = file_info.get("url")
|
||||||
|
if not isinstance(url, str) or not url:
|
||||||
|
return None
|
||||||
|
|
||||||
|
resp = await client.get(url)
|
||||||
|
resp.raise_for_status()
|
||||||
|
return resp.content
|
||||||
|
|
||||||
|
|
||||||
|
async def _read_wecom_inbound_file(file_info: dict[str, Any], client: httpx.AsyncClient) -> bytes | None:
|
||||||
|
data = await _read_http_inbound_file(file_info, client)
|
||||||
|
if data is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
aeskey = file_info.get("aeskey") if isinstance(file_info.get("aeskey"), str) else None
|
||||||
|
if not aeskey:
|
||||||
|
return data
|
||||||
|
|
||||||
|
try:
|
||||||
|
from aibot.crypto_utils import decrypt_file
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Manager] failed to import WeCom decrypt_file")
|
||||||
|
return None
|
||||||
|
|
||||||
|
return decrypt_file(data, aeskey)
|
||||||
|
|
||||||
|
|
||||||
|
async def _read_wechat_inbound_file(file_info: dict[str, Any], client: httpx.AsyncClient) -> bytes | None:
|
||||||
|
raw_path = file_info.get("path")
|
||||||
|
if isinstance(raw_path, str) and raw_path.strip():
|
||||||
|
try:
|
||||||
|
return await asyncio.to_thread(Path(raw_path).read_bytes)
|
||||||
|
except OSError:
|
||||||
|
logger.exception("[Manager] failed to read WeChat inbound file from local path: %s", raw_path)
|
||||||
|
return None
|
||||||
|
|
||||||
|
full_url = file_info.get("full_url")
|
||||||
|
if isinstance(full_url, str) and full_url.strip():
|
||||||
|
return await _read_http_inbound_file({"url": full_url}, client)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
register_inbound_file_reader("wecom", _read_wecom_inbound_file)
|
||||||
|
register_inbound_file_reader("wechat", _read_wechat_inbound_file)
|
||||||
|
|
||||||
|
|
||||||
class InvalidChannelSessionConfigError(ValueError):
|
class InvalidChannelSessionConfigError(ValueError):
|
||||||
"""Raised when IM channel session overrides contain invalid agent config."""
|
"""Raised when IM channel session overrides contain invalid agent config."""
|
||||||
@@ -341,6 +403,105 @@ def _prepare_artifact_delivery(
|
|||||||
return response_text, attachments
|
return response_text, attachments
|
||||||
|
|
||||||
|
|
||||||
|
async def _ingest_inbound_files(thread_id: str, msg: InboundMessage) -> list[dict[str, Any]]:
|
||||||
|
if not msg.files:
|
||||||
|
return []
|
||||||
|
|
||||||
|
from deerflow.uploads.manager import claim_unique_filename, ensure_uploads_dir, normalize_filename
|
||||||
|
|
||||||
|
uploads_dir = ensure_uploads_dir(thread_id)
|
||||||
|
seen_names = {entry.name for entry in uploads_dir.iterdir() if entry.is_file()}
|
||||||
|
|
||||||
|
created: list[dict[str, Any]] = []
|
||||||
|
file_reader = INBOUND_FILE_READERS.get(msg.channel_name, _read_http_inbound_file)
|
||||||
|
async with httpx.AsyncClient(timeout=httpx.Timeout(20.0)) as client:
|
||||||
|
for idx, f in enumerate(msg.files):
|
||||||
|
if not isinstance(f, dict):
|
||||||
|
continue
|
||||||
|
|
||||||
|
ftype = f.get("type") if isinstance(f.get("type"), str) else "file"
|
||||||
|
filename = f.get("filename") if isinstance(f.get("filename"), str) else ""
|
||||||
|
|
||||||
|
try:
|
||||||
|
data = await file_reader(f, client)
|
||||||
|
except Exception:
|
||||||
|
logger.exception(
|
||||||
|
"[Manager] failed to read inbound file: channel=%s, file=%s",
|
||||||
|
msg.channel_name,
|
||||||
|
f.get("url") or filename or idx,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
if data is None:
|
||||||
|
logger.warning(
|
||||||
|
"[Manager] inbound file reader returned no data: channel=%s, file=%s",
|
||||||
|
msg.channel_name,
|
||||||
|
f.get("url") or filename or idx,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
if not filename:
|
||||||
|
ext = ".bin"
|
||||||
|
if ftype == "image":
|
||||||
|
ext = ".png"
|
||||||
|
filename = f"{msg.thread_ts or 'msg'}_{idx}{ext}"
|
||||||
|
|
||||||
|
try:
|
||||||
|
safe_name = claim_unique_filename(normalize_filename(filename), seen_names)
|
||||||
|
except ValueError:
|
||||||
|
logger.warning(
|
||||||
|
"[Manager] skipping inbound file with unsafe filename: channel=%s, file=%r",
|
||||||
|
msg.channel_name,
|
||||||
|
filename,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
dest = uploads_dir / safe_name
|
||||||
|
try:
|
||||||
|
dest.write_bytes(data)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[Manager] failed to write inbound file: %s", dest)
|
||||||
|
continue
|
||||||
|
|
||||||
|
created.append(
|
||||||
|
{
|
||||||
|
"filename": safe_name,
|
||||||
|
"size": len(data),
|
||||||
|
"path": f"/mnt/user-data/uploads/{safe_name}",
|
||||||
|
"is_image": ftype == "image",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return created
|
||||||
|
|
||||||
|
|
||||||
|
def _format_uploaded_files_block(files: list[dict[str, Any]]) -> str:
|
||||||
|
lines = [
|
||||||
|
"<uploaded_files>",
|
||||||
|
"The following files were uploaded in this message:",
|
||||||
|
"",
|
||||||
|
]
|
||||||
|
if not files:
|
||||||
|
lines.append("(empty)")
|
||||||
|
else:
|
||||||
|
for f in files:
|
||||||
|
filename = f.get("filename", "")
|
||||||
|
size = int(f.get("size") or 0)
|
||||||
|
size_kb = size / 1024 if size else 0
|
||||||
|
size_str = f"{size_kb:.1f} KB" if size_kb < 1024 else f"{size_kb / 1024:.1f} MB"
|
||||||
|
path = f.get("path", "")
|
||||||
|
is_image = bool(f.get("is_image"))
|
||||||
|
file_kind = "image" if is_image else "file"
|
||||||
|
lines.append(f"- {filename} ({size_str})")
|
||||||
|
lines.append(f" Type: {file_kind}")
|
||||||
|
lines.append(f" Path: {path}")
|
||||||
|
lines.append("")
|
||||||
|
lines.append("Use `read_file` for text-based files and documents.")
|
||||||
|
lines.append("Use `view_image` for image files (jpg, jpeg, png, webp) so the model can inspect the image content.")
|
||||||
|
lines.append("</uploaded_files>")
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
|
||||||
class ChannelManager:
|
class ChannelManager:
|
||||||
"""Core dispatcher that bridges IM channels to the DeerFlow agent.
|
"""Core dispatcher that bridges IM channels to the DeerFlow agent.
|
||||||
|
|
||||||
@@ -533,8 +694,25 @@ class ChannelManager:
|
|||||||
thread_id = await self._create_thread(client, msg)
|
thread_id = await self._create_thread(client, msg)
|
||||||
|
|
||||||
assistant_id, run_config, run_context = self._resolve_run_params(msg, thread_id)
|
assistant_id, run_config, run_context = self._resolve_run_params(msg, thread_id)
|
||||||
|
|
||||||
|
# If the inbound message contains file attachments, let the channel
|
||||||
|
# materialize (download) them and update msg.text to include sandbox file paths.
|
||||||
|
# This enables downstream models to access user-uploaded files by path.
|
||||||
|
# Channels that do not support file download will simply return the original message.
|
||||||
|
if msg.files:
|
||||||
|
from .service import get_channel_service
|
||||||
|
|
||||||
|
service = get_channel_service()
|
||||||
|
channel = service.get_channel(msg.channel_name) if service else None
|
||||||
|
logger.info("[Manager] preparing receive file context for %d attachments", len(msg.files))
|
||||||
|
msg = await channel.receive_file(msg, thread_id) if channel else msg
|
||||||
if extra_context:
|
if extra_context:
|
||||||
run_context.update(extra_context)
|
run_context.update(extra_context)
|
||||||
|
|
||||||
|
uploaded = await _ingest_inbound_files(thread_id, msg)
|
||||||
|
if uploaded:
|
||||||
|
msg.text = f"{_format_uploaded_files_block(uploaded)}\n\n{msg.text}".strip()
|
||||||
|
|
||||||
if self._channel_supports_streaming(msg.channel_name):
|
if self._channel_supports_streaming(msg.channel_name):
|
||||||
await self._handle_streaming_chat(
|
await self._handle_streaming_chat(
|
||||||
client,
|
client,
|
||||||
@@ -735,7 +913,8 @@ class ChannelManager:
|
|||||||
"/help — Show this help"
|
"/help — Show this help"
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
reply = f"Unknown command: /{command}. Type /help for available commands."
|
available = " | ".join(sorted(KNOWN_CHANNEL_COMMANDS))
|
||||||
|
reply = f"Unknown command: /{command}. Available commands: {available}"
|
||||||
|
|
||||||
outbound = OutboundMessage(
|
outbound = OutboundMessage(
|
||||||
channel_name=msg.channel_name,
|
channel_name=msg.channel_name,
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import logging
|
|||||||
import os
|
import os
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
from app.channels.base import Channel
|
||||||
from app.channels.manager import DEFAULT_GATEWAY_URL, DEFAULT_LANGGRAPH_URL, ChannelManager
|
from app.channels.manager import DEFAULT_GATEWAY_URL, DEFAULT_LANGGRAPH_URL, ChannelManager
|
||||||
from app.channels.message_bus import MessageBus
|
from app.channels.message_bus import MessageBus
|
||||||
from app.channels.store import ChannelStore
|
from app.channels.store import ChannelStore
|
||||||
@@ -17,6 +18,8 @@ _CHANNEL_REGISTRY: dict[str, str] = {
|
|||||||
"feishu": "app.channels.feishu:FeishuChannel",
|
"feishu": "app.channels.feishu:FeishuChannel",
|
||||||
"slack": "app.channels.slack:SlackChannel",
|
"slack": "app.channels.slack:SlackChannel",
|
||||||
"telegram": "app.channels.telegram:TelegramChannel",
|
"telegram": "app.channels.telegram:TelegramChannel",
|
||||||
|
"wechat": "app.channels.wechat:WechatChannel",
|
||||||
|
"wecom": "app.channels.wecom:WeComChannel",
|
||||||
}
|
}
|
||||||
|
|
||||||
_CHANNELS_LANGGRAPH_URL_ENV = "DEER_FLOW_CHANNELS_LANGGRAPH_URL"
|
_CHANNELS_LANGGRAPH_URL_ENV = "DEER_FLOW_CHANNELS_LANGGRAPH_URL"
|
||||||
@@ -163,6 +166,10 @@ class ChannelService:
|
|||||||
"channels": channels_status,
|
"channels": channels_status,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
def get_channel(self, name: str) -> Channel | None:
|
||||||
|
"""Return a running channel instance by name when available."""
|
||||||
|
return self._channels.get(name)
|
||||||
|
|
||||||
|
|
||||||
# -- singleton access -------------------------------------------------------
|
# -- singleton access -------------------------------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ class SlackChannel(Channel):
|
|||||||
self._socket_client = None
|
self._socket_client = None
|
||||||
self._web_client = None
|
self._web_client = None
|
||||||
self._loop: asyncio.AbstractEventLoop | None = None
|
self._loop: asyncio.AbstractEventLoop | None = None
|
||||||
self._allowed_users: set[str] = set(config.get("allowed_users", []))
|
self._allowed_users: set[str] = {str(user_id) for user_id in config.get("allowed_users", [])}
|
||||||
|
|
||||||
async def start(self) -> None:
|
async def start(self) -> None:
|
||||||
if self._running:
|
if self._running:
|
||||||
@@ -126,7 +126,9 @@ class SlackChannel(Channel):
|
|||||||
)
|
)
|
||||||
except Exception:
|
except Exception:
|
||||||
pass
|
pass
|
||||||
raise last_exc # type: ignore[misc]
|
if last_exc is None:
|
||||||
|
raise RuntimeError("Slack send failed without an exception from any attempt")
|
||||||
|
raise last_exc
|
||||||
|
|
||||||
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
||||||
if not self._web_client:
|
if not self._web_client:
|
||||||
|
|||||||
@@ -125,7 +125,9 @@ class TelegramChannel(Channel):
|
|||||||
await asyncio.sleep(delay)
|
await asyncio.sleep(delay)
|
||||||
|
|
||||||
logger.error("[Telegram] send failed after %d attempts: %s", _max_retries, last_exc)
|
logger.error("[Telegram] send failed after %d attempts: %s", _max_retries, last_exc)
|
||||||
raise last_exc # type: ignore[misc]
|
if last_exc is None:
|
||||||
|
raise RuntimeError("Telegram send failed without an exception from any attempt")
|
||||||
|
raise last_exc
|
||||||
|
|
||||||
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
||||||
if not self._application:
|
if not self._application:
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,394 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import base64
|
||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
from collections.abc import Awaitable, Callable
|
||||||
|
from typing import Any, cast
|
||||||
|
|
||||||
|
from app.channels.base import Channel
|
||||||
|
from app.channels.message_bus import (
|
||||||
|
InboundMessageType,
|
||||||
|
MessageBus,
|
||||||
|
OutboundMessage,
|
||||||
|
ResolvedAttachment,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class WeComChannel(Channel):
|
||||||
|
def __init__(self, bus: MessageBus, config: dict[str, Any]) -> None:
|
||||||
|
super().__init__(name="wecom", bus=bus, config=config)
|
||||||
|
self._bot_id: str | None = None
|
||||||
|
self._bot_secret: str | None = None
|
||||||
|
self._ws_client = None
|
||||||
|
self._ws_task: asyncio.Task | None = None
|
||||||
|
self._ws_frames: dict[str, dict[str, Any]] = {}
|
||||||
|
self._ws_stream_ids: dict[str, str] = {}
|
||||||
|
self._working_message = "Working on it..."
|
||||||
|
|
||||||
|
def _clear_ws_context(self, thread_ts: str | None) -> None:
|
||||||
|
if not thread_ts:
|
||||||
|
return
|
||||||
|
self._ws_frames.pop(thread_ts, None)
|
||||||
|
self._ws_stream_ids.pop(thread_ts, None)
|
||||||
|
|
||||||
|
async def _send_ws_upload_command(self, req_id: str, body: dict[str, Any], cmd: str) -> dict[str, Any]:
|
||||||
|
if not self._ws_client:
|
||||||
|
raise RuntimeError("WeCom WebSocket client is not available")
|
||||||
|
|
||||||
|
ws_manager = getattr(self._ws_client, "_ws_manager", None)
|
||||||
|
send_reply = getattr(ws_manager, "send_reply", None)
|
||||||
|
if not callable(send_reply):
|
||||||
|
raise RuntimeError("Installed wecom-aibot-python-sdk does not expose the WebSocket media upload API expected by DeerFlow. Use wecom-aibot-python-sdk==0.1.6 or update the adapter.")
|
||||||
|
|
||||||
|
send_reply_async = cast(Callable[[str, dict[str, Any], str], Awaitable[dict[str, Any]]], send_reply)
|
||||||
|
return await send_reply_async(req_id, body, cmd)
|
||||||
|
|
||||||
|
async def start(self) -> None:
|
||||||
|
if self._running:
|
||||||
|
return
|
||||||
|
|
||||||
|
bot_id = self.config.get("bot_id")
|
||||||
|
bot_secret = self.config.get("bot_secret")
|
||||||
|
working_message = self.config.get("working_message")
|
||||||
|
|
||||||
|
self._bot_id = bot_id if isinstance(bot_id, str) and bot_id else None
|
||||||
|
self._bot_secret = bot_secret if isinstance(bot_secret, str) and bot_secret else None
|
||||||
|
self._working_message = working_message if isinstance(working_message, str) and working_message else "Working on it..."
|
||||||
|
|
||||||
|
if not self._bot_id or not self._bot_secret:
|
||||||
|
logger.error("WeCom channel requires bot_id and bot_secret")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
from aibot import WSClient, WSClientOptions
|
||||||
|
except ImportError:
|
||||||
|
logger.error("wecom-aibot-python-sdk is not installed. Install it with: uv add wecom-aibot-python-sdk")
|
||||||
|
return
|
||||||
|
else:
|
||||||
|
self._ws_client = WSClient(WSClientOptions(bot_id=self._bot_id, secret=self._bot_secret, logger=logger))
|
||||||
|
self._ws_client.on("message.text", self._on_ws_text)
|
||||||
|
self._ws_client.on("message.mixed", self._on_ws_mixed)
|
||||||
|
self._ws_client.on("message.image", self._on_ws_image)
|
||||||
|
self._ws_client.on("message.file", self._on_ws_file)
|
||||||
|
self._ws_task = asyncio.create_task(self._ws_client.connect())
|
||||||
|
|
||||||
|
self._running = True
|
||||||
|
self.bus.subscribe_outbound(self._on_outbound)
|
||||||
|
logger.info("WeCom channel started")
|
||||||
|
|
||||||
|
async def stop(self) -> None:
|
||||||
|
self._running = False
|
||||||
|
self.bus.unsubscribe_outbound(self._on_outbound)
|
||||||
|
if self._ws_task:
|
||||||
|
try:
|
||||||
|
self._ws_task.cancel()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
self._ws_task = None
|
||||||
|
if self._ws_client:
|
||||||
|
try:
|
||||||
|
self._ws_client.disconnect()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
self._ws_client = None
|
||||||
|
self._ws_frames.clear()
|
||||||
|
self._ws_stream_ids.clear()
|
||||||
|
logger.info("WeCom channel stopped")
|
||||||
|
|
||||||
|
async def send(self, msg: OutboundMessage, *, _max_retries: int = 3) -> None:
|
||||||
|
if self._ws_client:
|
||||||
|
await self._send_ws(msg, _max_retries=_max_retries)
|
||||||
|
return
|
||||||
|
logger.warning("[WeCom] send called but WebSocket client is not available")
|
||||||
|
|
||||||
|
async def _on_outbound(self, msg: OutboundMessage) -> None:
|
||||||
|
if msg.channel_name != self.name:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self.send(msg)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Failed to send outbound message on channel %s", self.name)
|
||||||
|
if msg.is_final:
|
||||||
|
self._clear_ws_context(msg.thread_ts)
|
||||||
|
return
|
||||||
|
|
||||||
|
for attachment in msg.attachments:
|
||||||
|
try:
|
||||||
|
success = await self.send_file(msg, attachment)
|
||||||
|
if not success:
|
||||||
|
logger.warning("[%s] file upload skipped for %s", self.name, attachment.filename)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[%s] failed to upload file %s", self.name, attachment.filename)
|
||||||
|
|
||||||
|
if msg.is_final:
|
||||||
|
self._clear_ws_context(msg.thread_ts)
|
||||||
|
|
||||||
|
async def send_file(self, msg: OutboundMessage, attachment: ResolvedAttachment) -> bool:
|
||||||
|
if not msg.is_final:
|
||||||
|
return True
|
||||||
|
if not self._ws_client:
|
||||||
|
return False
|
||||||
|
if not msg.thread_ts:
|
||||||
|
return False
|
||||||
|
frame = self._ws_frames.get(msg.thread_ts)
|
||||||
|
if not frame:
|
||||||
|
return False
|
||||||
|
|
||||||
|
media_type = "image" if attachment.is_image else "file"
|
||||||
|
size_limit = 2 * 1024 * 1024 if attachment.is_image else 20 * 1024 * 1024
|
||||||
|
if attachment.size > size_limit:
|
||||||
|
logger.warning(
|
||||||
|
"[WeCom] %s too large (%d bytes), skipping: %s",
|
||||||
|
media_type,
|
||||||
|
attachment.size,
|
||||||
|
attachment.filename,
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
try:
|
||||||
|
media_id = await self._upload_media_ws(
|
||||||
|
media_type=media_type,
|
||||||
|
filename=attachment.filename,
|
||||||
|
path=str(attachment.actual_path),
|
||||||
|
size=attachment.size,
|
||||||
|
)
|
||||||
|
if not media_id:
|
||||||
|
return False
|
||||||
|
|
||||||
|
body = {media_type: {"media_id": media_id}, "msgtype": media_type}
|
||||||
|
await self._ws_client.reply(frame, body)
|
||||||
|
logger.debug("[WeCom] %s sent via ws: %s", media_type, attachment.filename)
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
logger.exception("[WeCom] failed to upload/send file via ws: %s", attachment.filename)
|
||||||
|
return False
|
||||||
|
|
||||||
|
async def _on_ws_text(self, frame: dict[str, Any]) -> None:
|
||||||
|
body = frame.get("body", {}) or {}
|
||||||
|
text = ((body.get("text") or {}).get("content") or "").strip()
|
||||||
|
quote = body.get("quote", {}).get("text", {}).get("content", "").strip()
|
||||||
|
if not text and not quote:
|
||||||
|
return
|
||||||
|
await self._publish_ws_inbound(frame, text + (f"\nQuote message: {quote}" if quote else ""))
|
||||||
|
|
||||||
|
async def _on_ws_mixed(self, frame: dict[str, Any]) -> None:
|
||||||
|
body = frame.get("body", {}) or {}
|
||||||
|
mixed = body.get("mixed") or {}
|
||||||
|
items = mixed.get("msg_item") or []
|
||||||
|
parts: list[str] = []
|
||||||
|
files: list[dict[str, Any]] = []
|
||||||
|
for item in items:
|
||||||
|
item_type = (item or {}).get("msgtype")
|
||||||
|
if item_type == "text":
|
||||||
|
content = (((item or {}).get("text") or {}).get("content") or "").strip()
|
||||||
|
if content:
|
||||||
|
parts.append(content)
|
||||||
|
elif item_type in ("image", "file"):
|
||||||
|
payload = (item or {}).get(item_type) or {}
|
||||||
|
url = payload.get("url")
|
||||||
|
aeskey = payload.get("aeskey")
|
||||||
|
if isinstance(url, str) and url:
|
||||||
|
files.append(
|
||||||
|
{
|
||||||
|
"type": item_type,
|
||||||
|
"url": url,
|
||||||
|
"aeskey": (aeskey if isinstance(aeskey, str) and aeskey else None),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
text = "\n\n".join(parts).strip()
|
||||||
|
if not text and not files:
|
||||||
|
return
|
||||||
|
if not text:
|
||||||
|
text = "(receive image/file)"
|
||||||
|
await self._publish_ws_inbound(frame, text, files=files)
|
||||||
|
|
||||||
|
async def _on_ws_image(self, frame: dict[str, Any]) -> None:
|
||||||
|
body = frame.get("body", {}) or {}
|
||||||
|
image = body.get("image") or {}
|
||||||
|
url = image.get("url")
|
||||||
|
aeskey = image.get("aeskey")
|
||||||
|
if not isinstance(url, str) or not url:
|
||||||
|
return
|
||||||
|
await self._publish_ws_inbound(
|
||||||
|
frame,
|
||||||
|
"(receive image )",
|
||||||
|
files=[
|
||||||
|
{
|
||||||
|
"type": "image",
|
||||||
|
"url": url,
|
||||||
|
"aeskey": aeskey if isinstance(aeskey, str) and aeskey else None,
|
||||||
|
}
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _on_ws_file(self, frame: dict[str, Any]) -> None:
|
||||||
|
body = frame.get("body", {}) or {}
|
||||||
|
file_obj = body.get("file") or {}
|
||||||
|
url = file_obj.get("url")
|
||||||
|
aeskey = file_obj.get("aeskey")
|
||||||
|
if not isinstance(url, str) or not url:
|
||||||
|
return
|
||||||
|
await self._publish_ws_inbound(
|
||||||
|
frame,
|
||||||
|
"(receive file)",
|
||||||
|
files=[
|
||||||
|
{
|
||||||
|
"type": "file",
|
||||||
|
"url": url,
|
||||||
|
"aeskey": aeskey if isinstance(aeskey, str) and aeskey else None,
|
||||||
|
}
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _publish_ws_inbound(
|
||||||
|
self,
|
||||||
|
frame: dict[str, Any],
|
||||||
|
text: str,
|
||||||
|
*,
|
||||||
|
files: list[dict[str, Any]] | None = None,
|
||||||
|
) -> None:
|
||||||
|
if not self._ws_client:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
from aibot import generate_req_id
|
||||||
|
except Exception:
|
||||||
|
return
|
||||||
|
|
||||||
|
body = frame.get("body", {}) or {}
|
||||||
|
msg_id = body.get("msgid")
|
||||||
|
if not msg_id:
|
||||||
|
return
|
||||||
|
|
||||||
|
user_id = (body.get("from") or {}).get("userid")
|
||||||
|
|
||||||
|
inbound_type = InboundMessageType.COMMAND if text.startswith("/") else InboundMessageType.CHAT
|
||||||
|
inbound = self._make_inbound(
|
||||||
|
chat_id=user_id, # keep user's conversation in memory
|
||||||
|
user_id=user_id,
|
||||||
|
text=text,
|
||||||
|
msg_type=inbound_type,
|
||||||
|
thread_ts=msg_id,
|
||||||
|
files=files or [],
|
||||||
|
metadata={"aibotid": body.get("aibotid"), "chattype": body.get("chattype")},
|
||||||
|
)
|
||||||
|
inbound.topic_id = user_id # keep the same thread
|
||||||
|
|
||||||
|
stream_id = generate_req_id("stream")
|
||||||
|
self._ws_frames[msg_id] = frame
|
||||||
|
self._ws_stream_ids[msg_id] = stream_id
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self._ws_client.reply_stream(frame, stream_id, self._working_message, False)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
await self.bus.publish_inbound(inbound)
|
||||||
|
|
||||||
|
async def _send_ws(self, msg: OutboundMessage, *, _max_retries: int = 3) -> None:
|
||||||
|
if not self._ws_client:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
from aibot import generate_req_id
|
||||||
|
except Exception:
|
||||||
|
generate_req_id = None
|
||||||
|
|
||||||
|
if msg.thread_ts and msg.thread_ts in self._ws_frames:
|
||||||
|
frame = self._ws_frames[msg.thread_ts]
|
||||||
|
stream_id = self._ws_stream_ids.get(msg.thread_ts)
|
||||||
|
if not stream_id and generate_req_id:
|
||||||
|
stream_id = generate_req_id("stream")
|
||||||
|
self._ws_stream_ids[msg.thread_ts] = stream_id
|
||||||
|
if not stream_id:
|
||||||
|
return
|
||||||
|
|
||||||
|
last_exc: Exception | None = None
|
||||||
|
for attempt in range(_max_retries):
|
||||||
|
try:
|
||||||
|
await self._ws_client.reply_stream(frame, stream_id, msg.text, bool(msg.is_final))
|
||||||
|
return
|
||||||
|
except Exception as exc:
|
||||||
|
last_exc = exc
|
||||||
|
if attempt < _max_retries - 1:
|
||||||
|
await asyncio.sleep(2**attempt)
|
||||||
|
if last_exc:
|
||||||
|
raise last_exc
|
||||||
|
|
||||||
|
body = {"msgtype": "markdown", "markdown": {"content": msg.text}}
|
||||||
|
last_exc = None
|
||||||
|
for attempt in range(_max_retries):
|
||||||
|
try:
|
||||||
|
await self._ws_client.send_message(msg.chat_id, body)
|
||||||
|
return
|
||||||
|
except Exception as exc:
|
||||||
|
last_exc = exc
|
||||||
|
if attempt < _max_retries - 1:
|
||||||
|
await asyncio.sleep(2**attempt)
|
||||||
|
if last_exc:
|
||||||
|
raise last_exc
|
||||||
|
|
||||||
|
async def _upload_media_ws(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
media_type: str,
|
||||||
|
filename: str,
|
||||||
|
path: str,
|
||||||
|
size: int,
|
||||||
|
) -> str | None:
|
||||||
|
if not self._ws_client:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
from aibot import generate_req_id
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
chunk_size = 512 * 1024
|
||||||
|
total_chunks = (size + chunk_size - 1) // chunk_size
|
||||||
|
if total_chunks < 1 or total_chunks > 100:
|
||||||
|
logger.warning("[WeCom] invalid total_chunks=%d for %s", total_chunks, filename)
|
||||||
|
return None
|
||||||
|
|
||||||
|
md5_hasher = hashlib.md5()
|
||||||
|
with open(path, "rb") as f:
|
||||||
|
for chunk in iter(lambda: f.read(1024 * 1024), b""):
|
||||||
|
md5_hasher.update(chunk)
|
||||||
|
md5 = md5_hasher.hexdigest()
|
||||||
|
|
||||||
|
init_req_id = generate_req_id("aibot_upload_media_init")
|
||||||
|
init_body = {
|
||||||
|
"type": media_type,
|
||||||
|
"filename": filename,
|
||||||
|
"total_size": int(size),
|
||||||
|
"total_chunks": int(total_chunks),
|
||||||
|
"md5": md5,
|
||||||
|
}
|
||||||
|
init_ack = await self._send_ws_upload_command(init_req_id, init_body, "aibot_upload_media_init")
|
||||||
|
upload_id = (init_ack.get("body") or {}).get("upload_id")
|
||||||
|
if not upload_id:
|
||||||
|
logger.warning("[WeCom] upload init returned no upload_id: %s", init_ack)
|
||||||
|
return None
|
||||||
|
|
||||||
|
with open(path, "rb") as f:
|
||||||
|
for idx in range(total_chunks):
|
||||||
|
data = f.read(chunk_size)
|
||||||
|
if not data:
|
||||||
|
break
|
||||||
|
chunk_req_id = generate_req_id("aibot_upload_media_chunk")
|
||||||
|
chunk_body = {
|
||||||
|
"upload_id": upload_id,
|
||||||
|
"chunk_index": int(idx),
|
||||||
|
"base64_data": base64.b64encode(data).decode("utf-8"),
|
||||||
|
}
|
||||||
|
await self._send_ws_upload_command(chunk_req_id, chunk_body, "aibot_upload_media_chunk")
|
||||||
|
|
||||||
|
finish_req_id = generate_req_id("aibot_upload_media_finish")
|
||||||
|
finish_ack = await self._send_ws_upload_command(finish_req_id, {"upload_id": upload_id}, "aibot_upload_media_finish")
|
||||||
|
media_id = (finish_ack.get("body") or {}).get("media_id")
|
||||||
|
if not media_id:
|
||||||
|
logger.warning("[WeCom] upload finish returned no media_id: %s", finish_ack)
|
||||||
|
return None
|
||||||
|
return media_id
|
||||||
+161
-1
@@ -1,16 +1,23 @@
|
|||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
from collections.abc import AsyncGenerator
|
from collections.abc import AsyncGenerator
|
||||||
from contextlib import asynccontextmanager
|
from contextlib import asynccontextmanager
|
||||||
|
from datetime import UTC
|
||||||
|
|
||||||
from fastapi import FastAPI
|
from fastapi import FastAPI
|
||||||
|
from fastapi.middleware.cors import CORSMiddleware
|
||||||
|
|
||||||
|
from app.gateway.auth_middleware import AuthMiddleware
|
||||||
from app.gateway.config import get_gateway_config
|
from app.gateway.config import get_gateway_config
|
||||||
|
from app.gateway.csrf_middleware import CSRFMiddleware
|
||||||
from app.gateway.deps import langgraph_runtime
|
from app.gateway.deps import langgraph_runtime
|
||||||
from app.gateway.routers import (
|
from app.gateway.routers import (
|
||||||
agents,
|
agents,
|
||||||
artifacts,
|
artifacts,
|
||||||
assistants_compat,
|
assistants_compat,
|
||||||
|
auth,
|
||||||
channels,
|
channels,
|
||||||
|
feedback,
|
||||||
mcp,
|
mcp,
|
||||||
memory,
|
memory,
|
||||||
models,
|
models,
|
||||||
@@ -33,6 +40,125 @@ logging.basicConfig(
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
async def _ensure_admin_user(app: FastAPI) -> None:
|
||||||
|
"""Auto-create the admin user on first boot if no users exist.
|
||||||
|
|
||||||
|
After admin creation, migrate orphan threads from the LangGraph
|
||||||
|
store (metadata.owner_id unset) to the admin account. This is the
|
||||||
|
"no-auth → with-auth" upgrade path: users who ran DeerFlow without
|
||||||
|
authentication have existing LangGraph thread data that needs an
|
||||||
|
owner assigned.
|
||||||
|
|
||||||
|
No SQL persistence migration is needed: the four owner_id columns
|
||||||
|
(threads_meta, runs, run_events, feedback) only come into existence
|
||||||
|
alongside the auth module via create_all, so freshly created tables
|
||||||
|
never contain NULL-owner rows. "Existing persistence DB + new auth"
|
||||||
|
is not a supported upgrade path — fresh install or wipe-and-retry.
|
||||||
|
|
||||||
|
Multi-worker safe: relies on SQLite UNIQUE constraint to resolve
|
||||||
|
races during admin creation. Only the worker that successfully
|
||||||
|
creates/updates the admin prints the password; losers silently skip.
|
||||||
|
"""
|
||||||
|
import secrets
|
||||||
|
|
||||||
|
from app.gateway.auth.credential_file import write_initial_credentials
|
||||||
|
from app.gateway.deps import get_local_provider
|
||||||
|
|
||||||
|
def _announce_credentials(email: str, password: str, *, label: str, headline: str) -> None:
|
||||||
|
"""Write the password to a 0600 file and log the path (never the secret)."""
|
||||||
|
cred_path = write_initial_credentials(email, password, label=label)
|
||||||
|
logger.info("=" * 60)
|
||||||
|
logger.info(" %s", headline)
|
||||||
|
logger.info(" Credentials written to: %s (mode 0600)", cred_path)
|
||||||
|
logger.info(" Change it after login: Settings -> Account")
|
||||||
|
logger.info("=" * 60)
|
||||||
|
|
||||||
|
provider = get_local_provider()
|
||||||
|
user_count = await provider.count_users()
|
||||||
|
|
||||||
|
admin = None
|
||||||
|
|
||||||
|
if user_count == 0:
|
||||||
|
password = secrets.token_urlsafe(16)
|
||||||
|
try:
|
||||||
|
admin = await provider.create_user(email="admin@deerflow.dev", password=password, system_role="admin", needs_setup=True)
|
||||||
|
except ValueError:
|
||||||
|
return # Another worker already created the admin.
|
||||||
|
_announce_credentials(admin.email, password, label="initial", headline="Admin account created on first boot")
|
||||||
|
else:
|
||||||
|
# Admin exists but setup never completed — reset password so operator
|
||||||
|
# can always find it in the console without needing the CLI.
|
||||||
|
# Multi-worker guard: if admin was created less than 30s ago, another
|
||||||
|
# worker just created it and will print the password — skip reset.
|
||||||
|
admin = await provider.get_user_by_email("admin@deerflow.dev")
|
||||||
|
if admin and admin.needs_setup:
|
||||||
|
import time
|
||||||
|
|
||||||
|
age = time.time() - admin.created_at.replace(tzinfo=UTC).timestamp()
|
||||||
|
if age >= 30:
|
||||||
|
from app.gateway.auth.password import hash_password_async
|
||||||
|
|
||||||
|
password = secrets.token_urlsafe(16)
|
||||||
|
admin.password_hash = await hash_password_async(password)
|
||||||
|
admin.token_version += 1
|
||||||
|
await provider.update_user(admin)
|
||||||
|
_announce_credentials(admin.email, password, label="reset", headline="Admin account setup incomplete — password reset")
|
||||||
|
|
||||||
|
if admin is None:
|
||||||
|
return # Nothing to bind orphans to.
|
||||||
|
|
||||||
|
admin_id = str(admin.id)
|
||||||
|
|
||||||
|
# LangGraph store orphan migration — non-fatal.
|
||||||
|
# This covers the "no-auth → with-auth" upgrade path for users
|
||||||
|
# whose existing LangGraph thread metadata has no owner_id set.
|
||||||
|
store = getattr(app.state, "store", None)
|
||||||
|
if store is not None:
|
||||||
|
try:
|
||||||
|
migrated = await _migrate_orphaned_threads(store, admin_id)
|
||||||
|
if migrated:
|
||||||
|
logger.info("Migrated %d orphan LangGraph thread(s) to admin", migrated)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("LangGraph thread migration failed (non-fatal)")
|
||||||
|
|
||||||
|
|
||||||
|
async def _iter_store_items(store, namespace, *, page_size: int = 500):
|
||||||
|
"""Paginated async iterator over a LangGraph store namespace.
|
||||||
|
|
||||||
|
Replaces the old hardcoded ``limit=1000`` call with a cursor-style
|
||||||
|
loop so that environments with more than one page of orphans do
|
||||||
|
not silently lose data. Terminates when a page is empty OR when a
|
||||||
|
short page arrives (indicating the last page).
|
||||||
|
"""
|
||||||
|
offset = 0
|
||||||
|
while True:
|
||||||
|
batch = await store.asearch(namespace, limit=page_size, offset=offset)
|
||||||
|
if not batch:
|
||||||
|
return
|
||||||
|
for item in batch:
|
||||||
|
yield item
|
||||||
|
if len(batch) < page_size:
|
||||||
|
return
|
||||||
|
offset += page_size
|
||||||
|
|
||||||
|
|
||||||
|
async def _migrate_orphaned_threads(store, admin_user_id: str) -> int:
|
||||||
|
"""Migrate LangGraph store threads with no owner_id to the given admin.
|
||||||
|
|
||||||
|
Uses cursor pagination so all orphans are migrated regardless of
|
||||||
|
count. Returns the number of rows migrated.
|
||||||
|
"""
|
||||||
|
migrated = 0
|
||||||
|
async for item in _iter_store_items(store, ("threads",)):
|
||||||
|
metadata = item.value.get("metadata", {})
|
||||||
|
if not metadata.get("owner_id"):
|
||||||
|
metadata["owner_id"] = admin_user_id
|
||||||
|
item.value["metadata"] = metadata
|
||||||
|
await store.aput(("threads",), item.key, item.value)
|
||||||
|
migrated += 1
|
||||||
|
return migrated
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
@asynccontextmanager
|
||||||
async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
|
async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
|
||||||
"""Application lifespan handler."""
|
"""Application lifespan handler."""
|
||||||
@@ -52,6 +178,10 @@ async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
|
|||||||
async with langgraph_runtime(app):
|
async with langgraph_runtime(app):
|
||||||
logger.info("LangGraph runtime initialised")
|
logger.info("LangGraph runtime initialised")
|
||||||
|
|
||||||
|
# Ensure admin user exists (auto-create on first boot)
|
||||||
|
# Must run AFTER langgraph_runtime so app.state.store is available for thread migration
|
||||||
|
await _ensure_admin_user(app)
|
||||||
|
|
||||||
# Start IM channel service if any channels are configured
|
# Start IM channel service if any channels are configured
|
||||||
try:
|
try:
|
||||||
from app.channels.service import start_channel_service
|
from app.channels.service import start_channel_service
|
||||||
@@ -163,7 +293,31 @@ This gateway provides custom endpoints for models, MCP configuration, skills, an
|
|||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
# CORS is handled by nginx - no need for FastAPI middleware
|
# Auth: reject unauthenticated requests to non-public paths (fail-closed safety net)
|
||||||
|
app.add_middleware(AuthMiddleware)
|
||||||
|
|
||||||
|
# CSRF: Double Submit Cookie pattern for state-changing requests
|
||||||
|
app.add_middleware(CSRFMiddleware)
|
||||||
|
|
||||||
|
# CORS: when GATEWAY_CORS_ORIGINS is set (dev without nginx), add CORS middleware.
|
||||||
|
# In production, nginx handles CORS and no middleware is needed.
|
||||||
|
cors_origins_env = os.environ.get("GATEWAY_CORS_ORIGINS", "")
|
||||||
|
if cors_origins_env:
|
||||||
|
cors_origins = [o.strip() for o in cors_origins_env.split(",") if o.strip()]
|
||||||
|
# Validate: wildcard origin with credentials is a security misconfiguration
|
||||||
|
for origin in cors_origins:
|
||||||
|
if origin == "*":
|
||||||
|
logger.error("GATEWAY_CORS_ORIGINS contains wildcard '*' with allow_credentials=True. This is a security misconfiguration — browsers will reject the response. Use explicit scheme://host:port origins instead.")
|
||||||
|
cors_origins = [o for o in cors_origins if o != "*"]
|
||||||
|
break
|
||||||
|
if cors_origins:
|
||||||
|
app.add_middleware(
|
||||||
|
CORSMiddleware,
|
||||||
|
allow_origins=cors_origins,
|
||||||
|
allow_credentials=True,
|
||||||
|
allow_methods=["*"],
|
||||||
|
allow_headers=["*"],
|
||||||
|
)
|
||||||
|
|
||||||
# Include routers
|
# Include routers
|
||||||
# Models API is mounted at /api/models
|
# Models API is mounted at /api/models
|
||||||
@@ -199,6 +353,12 @@ This gateway provides custom endpoints for models, MCP configuration, skills, an
|
|||||||
# Assistants compatibility API (LangGraph Platform stub)
|
# Assistants compatibility API (LangGraph Platform stub)
|
||||||
app.include_router(assistants_compat.router)
|
app.include_router(assistants_compat.router)
|
||||||
|
|
||||||
|
# Auth API is mounted at /api/v1/auth
|
||||||
|
app.include_router(auth.router)
|
||||||
|
|
||||||
|
# Feedback API is mounted at /api/threads/{thread_id}/runs/{run_id}/feedback
|
||||||
|
app.include_router(feedback.router)
|
||||||
|
|
||||||
# Thread Runs API (LangGraph Platform-compatible runs lifecycle)
|
# Thread Runs API (LangGraph Platform-compatible runs lifecycle)
|
||||||
app.include_router(thread_runs.router)
|
app.include_router(thread_runs.router)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
"""Authentication module for DeerFlow.
|
||||||
|
|
||||||
|
This module provides:
|
||||||
|
- JWT-based authentication
|
||||||
|
- Provider Factory pattern for extensible auth methods
|
||||||
|
- UserRepository interface for storage backends (SQLite)
|
||||||
|
"""
|
||||||
|
|
||||||
|
from app.gateway.auth.config import AuthConfig, get_auth_config, set_auth_config
|
||||||
|
from app.gateway.auth.errors import AuthErrorCode, AuthErrorResponse, TokenError
|
||||||
|
from app.gateway.auth.jwt import TokenPayload, create_access_token, decode_token
|
||||||
|
from app.gateway.auth.local_provider import LocalAuthProvider
|
||||||
|
from app.gateway.auth.models import User, UserResponse
|
||||||
|
from app.gateway.auth.password import hash_password, verify_password
|
||||||
|
from app.gateway.auth.providers import AuthProvider
|
||||||
|
from app.gateway.auth.repositories.base import UserRepository
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
# Config
|
||||||
|
"AuthConfig",
|
||||||
|
"get_auth_config",
|
||||||
|
"set_auth_config",
|
||||||
|
# Errors
|
||||||
|
"AuthErrorCode",
|
||||||
|
"AuthErrorResponse",
|
||||||
|
"TokenError",
|
||||||
|
# JWT
|
||||||
|
"TokenPayload",
|
||||||
|
"create_access_token",
|
||||||
|
"decode_token",
|
||||||
|
# Password
|
||||||
|
"hash_password",
|
||||||
|
"verify_password",
|
||||||
|
# Models
|
||||||
|
"User",
|
||||||
|
"UserResponse",
|
||||||
|
# Providers
|
||||||
|
"AuthProvider",
|
||||||
|
"LocalAuthProvider",
|
||||||
|
# Repository
|
||||||
|
"UserRepository",
|
||||||
|
]
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
"""Authentication configuration for DeerFlow."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import secrets
|
||||||
|
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class AuthConfig(BaseModel):
|
||||||
|
"""JWT and auth-related configuration. Parsed once at startup.
|
||||||
|
|
||||||
|
Note: the ``users`` table now lives in the shared persistence
|
||||||
|
database managed by ``deerflow.persistence.engine``. The old
|
||||||
|
``users_db_path`` config key has been removed — user storage is
|
||||||
|
configured through ``config.database`` like every other table.
|
||||||
|
"""
|
||||||
|
|
||||||
|
jwt_secret: str = Field(
|
||||||
|
...,
|
||||||
|
description="Secret key for JWT signing. MUST be set via AUTH_JWT_SECRET.",
|
||||||
|
)
|
||||||
|
token_expiry_days: int = Field(default=7, ge=1, le=30)
|
||||||
|
oauth_github_client_id: str | None = Field(default=None)
|
||||||
|
oauth_github_client_secret: str | None = Field(default=None)
|
||||||
|
|
||||||
|
|
||||||
|
_auth_config: AuthConfig | None = None
|
||||||
|
|
||||||
|
|
||||||
|
def get_auth_config() -> AuthConfig:
|
||||||
|
"""Get the global AuthConfig instance. Parses from env on first call."""
|
||||||
|
global _auth_config
|
||||||
|
if _auth_config is None:
|
||||||
|
jwt_secret = os.environ.get("AUTH_JWT_SECRET")
|
||||||
|
if not jwt_secret:
|
||||||
|
jwt_secret = secrets.token_urlsafe(32)
|
||||||
|
os.environ["AUTH_JWT_SECRET"] = jwt_secret
|
||||||
|
logger.warning(
|
||||||
|
"⚠ AUTH_JWT_SECRET is not set — using an auto-generated ephemeral secret. "
|
||||||
|
"Sessions will be invalidated on restart. "
|
||||||
|
"For production, add AUTH_JWT_SECRET to your .env file: "
|
||||||
|
'python -c "import secrets; print(secrets.token_urlsafe(32))"'
|
||||||
|
)
|
||||||
|
_auth_config = AuthConfig(jwt_secret=jwt_secret)
|
||||||
|
return _auth_config
|
||||||
|
|
||||||
|
|
||||||
|
def set_auth_config(config: AuthConfig) -> None:
|
||||||
|
"""Set the global AuthConfig instance (for testing)."""
|
||||||
|
global _auth_config
|
||||||
|
_auth_config = config
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
"""Write initial admin credentials to a restricted file instead of logs.
|
||||||
|
|
||||||
|
Logging secrets to stdout/stderr is a well-known CodeQL finding
|
||||||
|
(py/clear-text-logging-sensitive-data) — in production those logs
|
||||||
|
get collected into ELK/Splunk/etc and become a secret sprawl
|
||||||
|
source. This helper writes the credential to a 0600 file that only
|
||||||
|
the process user can read, and returns the path so the caller can
|
||||||
|
log **the path** (not the password) for the operator to pick up.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from deerflow.config.paths import get_paths
|
||||||
|
|
||||||
|
_CREDENTIAL_FILENAME = "admin_initial_credentials.txt"
|
||||||
|
|
||||||
|
|
||||||
|
def write_initial_credentials(email: str, password: str, *, label: str = "initial") -> Path:
|
||||||
|
"""Write the admin email + password to ``{base_dir}/admin_initial_credentials.txt``.
|
||||||
|
|
||||||
|
The file is created **atomically** with mode 0600 via ``os.open``
|
||||||
|
so the password is never world-readable, even for the single syscall
|
||||||
|
window between ``write_text`` and ``chmod``.
|
||||||
|
|
||||||
|
``label`` distinguishes "initial" (fresh creation) from "reset"
|
||||||
|
(password reset) in the file header so an operator picking up the
|
||||||
|
file after a restart can tell which event produced it.
|
||||||
|
|
||||||
|
Returns the absolute :class:`Path` to the file.
|
||||||
|
"""
|
||||||
|
target = get_paths().base_dir / _CREDENTIAL_FILENAME
|
||||||
|
target.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
content = (
|
||||||
|
f"# DeerFlow admin {label} credentials\n# This file is generated on first boot or password reset.\n# Change the password after login via Settings -> Account,\n# then delete this file.\n#\nemail: {email}\npassword: {password}\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Atomic 0600 create-or-truncate. O_TRUNC (not O_EXCL) so the
|
||||||
|
# reset-password path can rewrite an existing file without a
|
||||||
|
# separate unlink-then-create dance.
|
||||||
|
fd = os.open(target, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
|
||||||
|
with os.fdopen(fd, "w", encoding="utf-8") as fh:
|
||||||
|
fh.write(content)
|
||||||
|
|
||||||
|
return target.resolve()
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
"""Typed error definitions for auth module.
|
||||||
|
|
||||||
|
AuthErrorCode: exhaustive enum of all auth failure conditions.
|
||||||
|
TokenError: exhaustive enum of JWT decode failures.
|
||||||
|
AuthErrorResponse: structured error payload for HTTP responses.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from enum import StrEnum
|
||||||
|
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
|
||||||
|
class AuthErrorCode(StrEnum):
|
||||||
|
"""Exhaustive list of auth error conditions."""
|
||||||
|
|
||||||
|
INVALID_CREDENTIALS = "invalid_credentials"
|
||||||
|
TOKEN_EXPIRED = "token_expired"
|
||||||
|
TOKEN_INVALID = "token_invalid"
|
||||||
|
USER_NOT_FOUND = "user_not_found"
|
||||||
|
EMAIL_ALREADY_EXISTS = "email_already_exists"
|
||||||
|
PROVIDER_NOT_FOUND = "provider_not_found"
|
||||||
|
NOT_AUTHENTICATED = "not_authenticated"
|
||||||
|
|
||||||
|
|
||||||
|
class TokenError(StrEnum):
|
||||||
|
"""Exhaustive list of JWT decode failure reasons."""
|
||||||
|
|
||||||
|
EXPIRED = "expired"
|
||||||
|
INVALID_SIGNATURE = "invalid_signature"
|
||||||
|
MALFORMED = "malformed"
|
||||||
|
|
||||||
|
|
||||||
|
class AuthErrorResponse(BaseModel):
|
||||||
|
"""Structured error response — replaces bare `detail` strings."""
|
||||||
|
|
||||||
|
code: AuthErrorCode
|
||||||
|
message: str
|
||||||
|
|
||||||
|
|
||||||
|
def token_error_to_code(err: TokenError) -> AuthErrorCode:
|
||||||
|
"""Map TokenError to AuthErrorCode — single source of truth."""
|
||||||
|
if err == TokenError.EXPIRED:
|
||||||
|
return AuthErrorCode.TOKEN_EXPIRED
|
||||||
|
return AuthErrorCode.TOKEN_INVALID
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
"""JWT token creation and verification."""
|
||||||
|
|
||||||
|
from datetime import UTC, datetime, timedelta
|
||||||
|
|
||||||
|
import jwt
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
from app.gateway.auth.config import get_auth_config
|
||||||
|
from app.gateway.auth.errors import TokenError
|
||||||
|
|
||||||
|
|
||||||
|
class TokenPayload(BaseModel):
|
||||||
|
"""JWT token payload."""
|
||||||
|
|
||||||
|
sub: str # user_id
|
||||||
|
exp: datetime
|
||||||
|
iat: datetime | None = None
|
||||||
|
ver: int = 0 # token_version — must match User.token_version
|
||||||
|
|
||||||
|
|
||||||
|
def create_access_token(user_id: str, expires_delta: timedelta | None = None, token_version: int = 0) -> str:
|
||||||
|
"""Create a JWT access token.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id: The user's UUID as string
|
||||||
|
expires_delta: Optional custom expiry, defaults to 7 days
|
||||||
|
token_version: User's current token_version for invalidation
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Encoded JWT string
|
||||||
|
"""
|
||||||
|
config = get_auth_config()
|
||||||
|
expiry = expires_delta or timedelta(days=config.token_expiry_days)
|
||||||
|
|
||||||
|
now = datetime.now(UTC)
|
||||||
|
payload = {"sub": user_id, "exp": now + expiry, "iat": now, "ver": token_version}
|
||||||
|
return jwt.encode(payload, config.jwt_secret, algorithm="HS256")
|
||||||
|
|
||||||
|
|
||||||
|
def decode_token(token: str) -> TokenPayload | TokenError:
|
||||||
|
"""Decode and validate a JWT token.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
TokenPayload if valid, or a specific TokenError variant.
|
||||||
|
"""
|
||||||
|
config = get_auth_config()
|
||||||
|
try:
|
||||||
|
payload = jwt.decode(token, config.jwt_secret, algorithms=["HS256"])
|
||||||
|
return TokenPayload(**payload)
|
||||||
|
except jwt.ExpiredSignatureError:
|
||||||
|
return TokenError.EXPIRED
|
||||||
|
except jwt.InvalidSignatureError:
|
||||||
|
return TokenError.INVALID_SIGNATURE
|
||||||
|
except jwt.PyJWTError:
|
||||||
|
return TokenError.MALFORMED
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
"""Local email/password authentication provider."""
|
||||||
|
|
||||||
|
from app.gateway.auth.models import User
|
||||||
|
from app.gateway.auth.password import hash_password_async, verify_password_async
|
||||||
|
from app.gateway.auth.providers import AuthProvider
|
||||||
|
from app.gateway.auth.repositories.base import UserRepository
|
||||||
|
|
||||||
|
|
||||||
|
class LocalAuthProvider(AuthProvider):
|
||||||
|
"""Email/password authentication provider using local database."""
|
||||||
|
|
||||||
|
def __init__(self, repository: UserRepository):
|
||||||
|
"""Initialize with a UserRepository.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
repository: UserRepository implementation (SQLite)
|
||||||
|
"""
|
||||||
|
self._repo = repository
|
||||||
|
|
||||||
|
async def authenticate(self, credentials: dict) -> User | None:
|
||||||
|
"""Authenticate with email and password.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
credentials: dict with 'email' and 'password' keys
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
User if authentication succeeds, None otherwise
|
||||||
|
"""
|
||||||
|
email = credentials.get("email")
|
||||||
|
password = credentials.get("password")
|
||||||
|
|
||||||
|
if not email or not password:
|
||||||
|
return None
|
||||||
|
|
||||||
|
user = await self._repo.get_user_by_email(email)
|
||||||
|
if user is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if user.password_hash is None:
|
||||||
|
# OAuth user without local password
|
||||||
|
return None
|
||||||
|
|
||||||
|
if not await verify_password_async(password, user.password_hash):
|
||||||
|
return None
|
||||||
|
|
||||||
|
return user
|
||||||
|
|
||||||
|
async def get_user(self, user_id: str) -> User | None:
|
||||||
|
"""Get user by ID."""
|
||||||
|
return await self._repo.get_user_by_id(user_id)
|
||||||
|
|
||||||
|
async def create_user(self, email: str, password: str | None = None, system_role: str = "user", needs_setup: bool = False) -> User:
|
||||||
|
"""Create a new local user.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
email: User email address
|
||||||
|
password: Plain text password (will be hashed)
|
||||||
|
system_role: Role to assign ("admin" or "user")
|
||||||
|
needs_setup: If True, user must complete setup on first login
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Created User instance
|
||||||
|
"""
|
||||||
|
password_hash = await hash_password_async(password) if password else None
|
||||||
|
user = User(
|
||||||
|
email=email,
|
||||||
|
password_hash=password_hash,
|
||||||
|
system_role=system_role,
|
||||||
|
needs_setup=needs_setup,
|
||||||
|
)
|
||||||
|
return await self._repo.create_user(user)
|
||||||
|
|
||||||
|
async def get_user_by_oauth(self, provider: str, oauth_id: str) -> User | None:
|
||||||
|
"""Get user by OAuth provider and ID."""
|
||||||
|
return await self._repo.get_user_by_oauth(provider, oauth_id)
|
||||||
|
|
||||||
|
async def count_users(self) -> int:
|
||||||
|
"""Return total number of registered users."""
|
||||||
|
return await self._repo.count_users()
|
||||||
|
|
||||||
|
async def update_user(self, user: User) -> User:
|
||||||
|
"""Update an existing user."""
|
||||||
|
return await self._repo.update_user(user)
|
||||||
|
|
||||||
|
async def get_user_by_email(self, email: str) -> User | None:
|
||||||
|
"""Get user by email."""
|
||||||
|
return await self._repo.get_user_by_email(email)
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
"""User Pydantic models for authentication."""
|
||||||
|
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from typing import Literal
|
||||||
|
from uuid import UUID, uuid4
|
||||||
|
|
||||||
|
from pydantic import BaseModel, ConfigDict, EmailStr, Field
|
||||||
|
|
||||||
|
|
||||||
|
def _utc_now() -> datetime:
|
||||||
|
"""Return current UTC time (timezone-aware)."""
|
||||||
|
return datetime.now(UTC)
|
||||||
|
|
||||||
|
|
||||||
|
class User(BaseModel):
|
||||||
|
"""Internal user representation."""
|
||||||
|
|
||||||
|
model_config = ConfigDict(from_attributes=True)
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, description="Primary key")
|
||||||
|
email: EmailStr = Field(..., description="Unique email address")
|
||||||
|
password_hash: str | None = Field(None, description="bcrypt hash, nullable for OAuth users")
|
||||||
|
system_role: Literal["admin", "user"] = Field(default="user")
|
||||||
|
created_at: datetime = Field(default_factory=_utc_now)
|
||||||
|
|
||||||
|
# OAuth linkage (optional)
|
||||||
|
oauth_provider: str | None = Field(None, description="e.g. 'github', 'google'")
|
||||||
|
oauth_id: str | None = Field(None, description="User ID from OAuth provider")
|
||||||
|
|
||||||
|
# Auth lifecycle
|
||||||
|
needs_setup: bool = Field(default=False, description="True for auto-created admin until setup completes")
|
||||||
|
token_version: int = Field(default=0, description="Incremented on password change to invalidate old JWTs")
|
||||||
|
|
||||||
|
|
||||||
|
class UserResponse(BaseModel):
|
||||||
|
"""Response model for user info endpoint."""
|
||||||
|
|
||||||
|
id: str
|
||||||
|
email: str
|
||||||
|
system_role: Literal["admin", "user"]
|
||||||
|
needs_setup: bool = False
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
"""Password hashing utilities using bcrypt directly."""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
|
||||||
|
import bcrypt
|
||||||
|
|
||||||
|
|
||||||
|
def hash_password(password: str) -> str:
|
||||||
|
"""Hash a password using bcrypt."""
|
||||||
|
return bcrypt.hashpw(password.encode("utf-8"), bcrypt.gensalt()).decode("utf-8")
|
||||||
|
|
||||||
|
|
||||||
|
def verify_password(plain_password: str, hashed_password: str) -> bool:
|
||||||
|
"""Verify a password against its hash."""
|
||||||
|
return bcrypt.checkpw(plain_password.encode("utf-8"), hashed_password.encode("utf-8"))
|
||||||
|
|
||||||
|
|
||||||
|
async def hash_password_async(password: str) -> str:
|
||||||
|
"""Hash a password using bcrypt (non-blocking).
|
||||||
|
|
||||||
|
Wraps the blocking bcrypt operation in a thread pool to avoid
|
||||||
|
blocking the event loop during password hashing.
|
||||||
|
"""
|
||||||
|
return await asyncio.to_thread(hash_password, password)
|
||||||
|
|
||||||
|
|
||||||
|
async def verify_password_async(plain_password: str, hashed_password: str) -> bool:
|
||||||
|
"""Verify a password against its hash (non-blocking).
|
||||||
|
|
||||||
|
Wraps the blocking bcrypt operation in a thread pool to avoid
|
||||||
|
blocking the event loop during password verification.
|
||||||
|
"""
|
||||||
|
return await asyncio.to_thread(verify_password, plain_password, hashed_password)
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
"""Auth provider abstraction."""
|
||||||
|
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
|
||||||
|
|
||||||
|
class AuthProvider(ABC):
|
||||||
|
"""Abstract base class for authentication providers."""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def authenticate(self, credentials: dict) -> "User | None":
|
||||||
|
"""Authenticate user with given credentials.
|
||||||
|
|
||||||
|
Returns User if authentication succeeds, None otherwise.
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def get_user(self, user_id: str) -> "User | None":
|
||||||
|
"""Retrieve user by ID."""
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
# Import User at runtime to avoid circular imports
|
||||||
|
from app.gateway.auth.models import User # noqa: E402
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
"""User repository interface for abstracting database operations."""
|
||||||
|
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
|
||||||
|
from app.gateway.auth.models import User
|
||||||
|
|
||||||
|
|
||||||
|
class UserNotFoundError(LookupError):
|
||||||
|
"""Raised when a user repository operation targets a non-existent row.
|
||||||
|
|
||||||
|
Subclass of :class:`LookupError` so callers that already catch
|
||||||
|
``LookupError`` for "missing entity" can keep working unchanged,
|
||||||
|
while specific call sites can pin to this class to distinguish
|
||||||
|
"concurrent delete during update" from other lookups.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class UserRepository(ABC):
|
||||||
|
"""Abstract interface for user data storage.
|
||||||
|
|
||||||
|
Implement this interface to support different storage backends
|
||||||
|
(SQLite)
|
||||||
|
"""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def create_user(self, user: User) -> User:
|
||||||
|
"""Create a new user.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user: User object to create
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Created User with ID assigned
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If email already exists
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def get_user_by_id(self, user_id: str) -> User | None:
|
||||||
|
"""Get user by ID.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id: User UUID as string
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
User if found, None otherwise
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def get_user_by_email(self, email: str) -> User | None:
|
||||||
|
"""Get user by email.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
email: User email address
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
User if found, None otherwise
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def update_user(self, user: User) -> User:
|
||||||
|
"""Update an existing user.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user: User object with updated fields
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Updated User
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
UserNotFoundError: If no row exists for ``user.id``. This is
|
||||||
|
a hard failure (not a no-op) so callers cannot mistake a
|
||||||
|
concurrent-delete race for a successful update.
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def count_users(self) -> int:
|
||||||
|
"""Return total number of registered users."""
|
||||||
|
...
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def get_user_by_oauth(self, provider: str, oauth_id: str) -> User | None:
|
||||||
|
"""Get user by OAuth provider and ID.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
provider: OAuth provider name (e.g. 'github', 'google')
|
||||||
|
oauth_id: User ID from the OAuth provider
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
User if found, None otherwise
|
||||||
|
"""
|
||||||
|
...
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
"""SQLAlchemy-backed UserRepository implementation.
|
||||||
|
|
||||||
|
Uses the shared async session factory from
|
||||||
|
``deerflow.persistence.engine`` — the ``users`` table lives in the
|
||||||
|
same database as ``threads_meta``, ``runs``, ``run_events``, and
|
||||||
|
``feedback``.
|
||||||
|
|
||||||
|
Constructor takes the session factory directly (same pattern as the
|
||||||
|
other four repositories in ``deerflow.persistence.*``). Callers
|
||||||
|
construct this after ``init_engine_from_config()`` has run.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import UTC
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
from sqlalchemy import func, select
|
||||||
|
from sqlalchemy.exc import IntegrityError
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker
|
||||||
|
|
||||||
|
from app.gateway.auth.models import User
|
||||||
|
from app.gateway.auth.repositories.base import UserNotFoundError, UserRepository
|
||||||
|
from deerflow.persistence.user.model import UserRow
|
||||||
|
|
||||||
|
|
||||||
|
class SQLiteUserRepository(UserRepository):
|
||||||
|
"""Async user repository backed by the shared SQLAlchemy engine."""
|
||||||
|
|
||||||
|
def __init__(self, session_factory: async_sessionmaker[AsyncSession]) -> None:
|
||||||
|
self._sf = session_factory
|
||||||
|
|
||||||
|
# ── Converters ────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _row_to_user(row: UserRow) -> User:
|
||||||
|
return User(
|
||||||
|
id=UUID(row.id),
|
||||||
|
email=row.email,
|
||||||
|
password_hash=row.password_hash,
|
||||||
|
system_role=row.system_role, # type: ignore[arg-type]
|
||||||
|
# SQLite loses tzinfo on read; reattach UTC so downstream
|
||||||
|
# code can compare timestamps reliably.
|
||||||
|
created_at=row.created_at if row.created_at.tzinfo else row.created_at.replace(tzinfo=UTC),
|
||||||
|
oauth_provider=row.oauth_provider,
|
||||||
|
oauth_id=row.oauth_id,
|
||||||
|
needs_setup=row.needs_setup,
|
||||||
|
token_version=row.token_version,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _user_to_row(user: User) -> UserRow:
|
||||||
|
return UserRow(
|
||||||
|
id=str(user.id),
|
||||||
|
email=user.email,
|
||||||
|
password_hash=user.password_hash,
|
||||||
|
system_role=user.system_role,
|
||||||
|
created_at=user.created_at,
|
||||||
|
oauth_provider=user.oauth_provider,
|
||||||
|
oauth_id=user.oauth_id,
|
||||||
|
needs_setup=user.needs_setup,
|
||||||
|
token_version=user.token_version,
|
||||||
|
)
|
||||||
|
|
||||||
|
# ── CRUD ──────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
async def create_user(self, user: User) -> User:
|
||||||
|
"""Insert a new user. Raises ``ValueError`` on duplicate email."""
|
||||||
|
row = self._user_to_row(user)
|
||||||
|
async with self._sf() as session:
|
||||||
|
session.add(row)
|
||||||
|
try:
|
||||||
|
await session.commit()
|
||||||
|
except IntegrityError as exc:
|
||||||
|
await session.rollback()
|
||||||
|
raise ValueError(f"Email already registered: {user.email}") from exc
|
||||||
|
return user
|
||||||
|
|
||||||
|
async def get_user_by_id(self, user_id: str) -> User | None:
|
||||||
|
async with self._sf() as session:
|
||||||
|
row = await session.get(UserRow, user_id)
|
||||||
|
return self._row_to_user(row) if row is not None else None
|
||||||
|
|
||||||
|
async def get_user_by_email(self, email: str) -> User | None:
|
||||||
|
stmt = select(UserRow).where(UserRow.email == email)
|
||||||
|
async with self._sf() as session:
|
||||||
|
result = await session.execute(stmt)
|
||||||
|
row = result.scalar_one_or_none()
|
||||||
|
return self._row_to_user(row) if row is not None else None
|
||||||
|
|
||||||
|
async def update_user(self, user: User) -> User:
|
||||||
|
async with self._sf() as session:
|
||||||
|
row = await session.get(UserRow, str(user.id))
|
||||||
|
if row is None:
|
||||||
|
# Hard fail on concurrent delete: callers (reset_admin,
|
||||||
|
# password change handlers, _ensure_admin_user) all
|
||||||
|
# fetched the user just before this call, so a missing
|
||||||
|
# row here means the row vanished underneath us. Silent
|
||||||
|
# success would let the caller log "password reset" for
|
||||||
|
# a row that no longer exists.
|
||||||
|
raise UserNotFoundError(f"User {user.id} no longer exists")
|
||||||
|
row.email = user.email
|
||||||
|
row.password_hash = user.password_hash
|
||||||
|
row.system_role = user.system_role
|
||||||
|
row.oauth_provider = user.oauth_provider
|
||||||
|
row.oauth_id = user.oauth_id
|
||||||
|
row.needs_setup = user.needs_setup
|
||||||
|
row.token_version = user.token_version
|
||||||
|
await session.commit()
|
||||||
|
return user
|
||||||
|
|
||||||
|
async def count_users(self) -> int:
|
||||||
|
stmt = select(func.count()).select_from(UserRow)
|
||||||
|
async with self._sf() as session:
|
||||||
|
return await session.scalar(stmt) or 0
|
||||||
|
|
||||||
|
async def get_user_by_oauth(self, provider: str, oauth_id: str) -> User | None:
|
||||||
|
stmt = select(UserRow).where(UserRow.oauth_provider == provider, UserRow.oauth_id == oauth_id)
|
||||||
|
async with self._sf() as session:
|
||||||
|
result = await session.execute(stmt)
|
||||||
|
row = result.scalar_one_or_none()
|
||||||
|
return self._row_to_user(row) if row is not None else None
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
"""CLI tool to reset an admin password.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
python -m app.gateway.auth.reset_admin
|
||||||
|
python -m app.gateway.auth.reset_admin --email admin@example.com
|
||||||
|
|
||||||
|
Writes the new password to ``.deer-flow/admin_initial_credentials.txt``
|
||||||
|
(mode 0600) instead of printing it, so CI / log aggregators never see
|
||||||
|
the cleartext secret.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import asyncio
|
||||||
|
import secrets
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from sqlalchemy import select
|
||||||
|
|
||||||
|
from app.gateway.auth.credential_file import write_initial_credentials
|
||||||
|
from app.gateway.auth.password import hash_password
|
||||||
|
from app.gateway.auth.repositories.sqlite import SQLiteUserRepository
|
||||||
|
from deerflow.persistence.user.model import UserRow
|
||||||
|
|
||||||
|
|
||||||
|
async def _run(email: str | None) -> int:
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
from deerflow.persistence.engine import (
|
||||||
|
close_engine,
|
||||||
|
get_session_factory,
|
||||||
|
init_engine_from_config,
|
||||||
|
)
|
||||||
|
|
||||||
|
config = get_app_config()
|
||||||
|
await init_engine_from_config(config.database)
|
||||||
|
try:
|
||||||
|
sf = get_session_factory()
|
||||||
|
if sf is None:
|
||||||
|
print("Error: persistence engine not available (check config.database).", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
repo = SQLiteUserRepository(sf)
|
||||||
|
|
||||||
|
if email:
|
||||||
|
user = await repo.get_user_by_email(email)
|
||||||
|
else:
|
||||||
|
# Find first admin via direct SELECT — repository does not
|
||||||
|
# expose a "first admin" helper and we do not want to add
|
||||||
|
# one just for this CLI.
|
||||||
|
async with sf() as session:
|
||||||
|
stmt = select(UserRow).where(UserRow.system_role == "admin").limit(1)
|
||||||
|
row = (await session.execute(stmt)).scalar_one_or_none()
|
||||||
|
if row is None:
|
||||||
|
user = None
|
||||||
|
else:
|
||||||
|
user = await repo.get_user_by_id(row.id)
|
||||||
|
|
||||||
|
if user is None:
|
||||||
|
if email:
|
||||||
|
print(f"Error: user '{email}' not found.", file=sys.stderr)
|
||||||
|
else:
|
||||||
|
print("Error: no admin user found.", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
new_password = secrets.token_urlsafe(16)
|
||||||
|
user.password_hash = hash_password(new_password)
|
||||||
|
user.token_version += 1
|
||||||
|
user.needs_setup = True
|
||||||
|
await repo.update_user(user)
|
||||||
|
|
||||||
|
cred_path = write_initial_credentials(user.email, new_password, label="reset")
|
||||||
|
print(f"Password reset for: {user.email}")
|
||||||
|
print(f"Credentials written to: {cred_path} (mode 0600)")
|
||||||
|
print("Next login will require setup (new email + password).")
|
||||||
|
return 0
|
||||||
|
finally:
|
||||||
|
await close_engine()
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> None:
|
||||||
|
parser = argparse.ArgumentParser(description="Reset admin password")
|
||||||
|
parser.add_argument("--email", help="Admin email (default: first admin found)")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
exit_code = asyncio.run(_run(args.email))
|
||||||
|
sys.exit(exit_code)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
"""Global authentication middleware — fail-closed safety net.
|
||||||
|
|
||||||
|
Rejects unauthenticated requests to non-public paths with 401. When a
|
||||||
|
request passes the cookie check, resolves the JWT payload to a real
|
||||||
|
``User`` object and stamps it into both ``request.state.user`` and the
|
||||||
|
``deerflow.runtime.user_context`` contextvar so that repository-layer
|
||||||
|
owner filtering works automatically via the sentinel pattern.
|
||||||
|
|
||||||
|
Fine-grained permission checks remain in authz.py decorators.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from collections.abc import Callable
|
||||||
|
|
||||||
|
from fastapi import HTTPException, Request, Response
|
||||||
|
from starlette.middleware.base import BaseHTTPMiddleware
|
||||||
|
from starlette.responses import JSONResponse
|
||||||
|
from starlette.types import ASGIApp
|
||||||
|
|
||||||
|
from app.gateway.auth.errors import AuthErrorCode, AuthErrorResponse
|
||||||
|
from app.gateway.authz import _ALL_PERMISSIONS, AuthContext
|
||||||
|
from deerflow.runtime.user_context import reset_current_user, set_current_user
|
||||||
|
|
||||||
|
# Paths that never require authentication.
|
||||||
|
_PUBLIC_PATH_PREFIXES: tuple[str, ...] = (
|
||||||
|
"/health",
|
||||||
|
"/docs",
|
||||||
|
"/redoc",
|
||||||
|
"/openapi.json",
|
||||||
|
)
|
||||||
|
|
||||||
|
# Exact auth paths that are public (login/register/status check).
|
||||||
|
# /api/v1/auth/me, /api/v1/auth/change-password etc. are NOT public.
|
||||||
|
_PUBLIC_EXACT_PATHS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"/api/v1/auth/login/local",
|
||||||
|
"/api/v1/auth/register",
|
||||||
|
"/api/v1/auth/logout",
|
||||||
|
"/api/v1/auth/setup-status",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_public(path: str) -> bool:
|
||||||
|
stripped = path.rstrip("/")
|
||||||
|
if stripped in _PUBLIC_EXACT_PATHS:
|
||||||
|
return True
|
||||||
|
return any(path.startswith(prefix) for prefix in _PUBLIC_PATH_PREFIXES)
|
||||||
|
|
||||||
|
|
||||||
|
class AuthMiddleware(BaseHTTPMiddleware):
|
||||||
|
"""Strict auth gate: reject requests without a valid session.
|
||||||
|
|
||||||
|
Two-stage check for non-public paths:
|
||||||
|
|
||||||
|
1. Cookie presence — return 401 NOT_AUTHENTICATED if missing
|
||||||
|
2. JWT validation via ``get_optional_user_from_request`` — return 401
|
||||||
|
TOKEN_INVALID if the token is absent, malformed, expired, or the
|
||||||
|
signed user does not exist / is stale
|
||||||
|
|
||||||
|
On success, stamps ``request.state.user`` and the
|
||||||
|
``deerflow.runtime.user_context`` contextvar so that repository-layer
|
||||||
|
owner filters work downstream without every route needing a
|
||||||
|
``@require_auth`` decorator. Routes that need per-resource
|
||||||
|
authorization (e.g. "user A cannot read user B's thread by guessing
|
||||||
|
the URL") should additionally use ``@require_permission(...,
|
||||||
|
owner_check=True)`` for explicit enforcement — but authentication
|
||||||
|
itself is fully handled here.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, app: ASGIApp) -> None:
|
||||||
|
super().__init__(app)
|
||||||
|
|
||||||
|
async def dispatch(self, request: Request, call_next: Callable) -> Response:
|
||||||
|
if _is_public(request.url.path):
|
||||||
|
return await call_next(request)
|
||||||
|
|
||||||
|
# Non-public path: require session cookie
|
||||||
|
if not request.cookies.get("access_token"):
|
||||||
|
return JSONResponse(
|
||||||
|
status_code=401,
|
||||||
|
content={
|
||||||
|
"detail": AuthErrorResponse(
|
||||||
|
code=AuthErrorCode.NOT_AUTHENTICATED,
|
||||||
|
message="Authentication required",
|
||||||
|
).model_dump()
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# Strict JWT validation: reject junk/expired tokens with 401
|
||||||
|
# right here instead of silently passing through. This closes
|
||||||
|
# the "junk cookie bypass" gap (AUTH_TEST_PLAN test 7.5.8):
|
||||||
|
# without this, non-isolation routes like /api/models would
|
||||||
|
# accept any cookie-shaped string as authentication.
|
||||||
|
#
|
||||||
|
# We call the *strict* resolver so that fine-grained error
|
||||||
|
# codes (token_expired, token_invalid, user_not_found, …)
|
||||||
|
# propagate from AuthErrorCode, not get flattened into one
|
||||||
|
# generic code. BaseHTTPMiddleware doesn't let HTTPException
|
||||||
|
# bubble up, so we catch and render it as JSONResponse here.
|
||||||
|
from app.gateway.deps import get_current_user_from_request
|
||||||
|
|
||||||
|
try:
|
||||||
|
user = await get_current_user_from_request(request)
|
||||||
|
except HTTPException as exc:
|
||||||
|
return JSONResponse(status_code=exc.status_code, content={"detail": exc.detail})
|
||||||
|
|
||||||
|
# Stamp both request.state.user (for the contextvar pattern)
|
||||||
|
# and request.state.auth (so @require_permission's "auth is
|
||||||
|
# None" branch short-circuits instead of running the entire
|
||||||
|
# JWT-decode + DB-lookup pipeline a second time per request).
|
||||||
|
request.state.user = user
|
||||||
|
request.state.auth = AuthContext(user=user, permissions=_ALL_PERMISSIONS)
|
||||||
|
token = set_current_user(user)
|
||||||
|
try:
|
||||||
|
return await call_next(request)
|
||||||
|
finally:
|
||||||
|
reset_current_user(token)
|
||||||
@@ -0,0 +1,262 @@
|
|||||||
|
"""Authorization decorators and context for DeerFlow.
|
||||||
|
|
||||||
|
Inspired by LangGraph Auth system: https://github.com/langchain-ai/langgraph/blob/main/libs/sdk-py/langgraph_sdk/auth/__init__.py
|
||||||
|
|
||||||
|
**Usage:**
|
||||||
|
|
||||||
|
1. Use ``@require_auth`` on routes that need authentication
|
||||||
|
2. Use ``@require_permission("resource", "action", filter_key=...)`` for permission checks
|
||||||
|
3. The decorator chain processes from bottom to top
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
|
||||||
|
@router.get("/{thread_id}")
|
||||||
|
@require_auth
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def get_thread(thread_id: str, request: Request):
|
||||||
|
# User is authenticated and has threads:read permission
|
||||||
|
...
|
||||||
|
|
||||||
|
**Permission Model:**
|
||||||
|
|
||||||
|
- threads:read - View thread
|
||||||
|
- threads:write - Create/update thread
|
||||||
|
- threads:delete - Delete thread
|
||||||
|
- runs:create - Run agent
|
||||||
|
- runs:read - View run
|
||||||
|
- runs:cancel - Cancel run
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import functools
|
||||||
|
from collections.abc import Callable
|
||||||
|
from typing import TYPE_CHECKING, Any, ParamSpec, TypeVar
|
||||||
|
|
||||||
|
from fastapi import HTTPException, Request
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from app.gateway.auth.models import User
|
||||||
|
|
||||||
|
P = ParamSpec("P")
|
||||||
|
T = TypeVar("T")
|
||||||
|
|
||||||
|
|
||||||
|
# Permission constants
|
||||||
|
class Permissions:
|
||||||
|
"""Permission constants for resource:action format."""
|
||||||
|
|
||||||
|
# Threads
|
||||||
|
THREADS_READ = "threads:read"
|
||||||
|
THREADS_WRITE = "threads:write"
|
||||||
|
THREADS_DELETE = "threads:delete"
|
||||||
|
|
||||||
|
# Runs
|
||||||
|
RUNS_CREATE = "runs:create"
|
||||||
|
RUNS_READ = "runs:read"
|
||||||
|
RUNS_CANCEL = "runs:cancel"
|
||||||
|
|
||||||
|
|
||||||
|
class AuthContext:
|
||||||
|
"""Authentication context for the current request.
|
||||||
|
|
||||||
|
Stored in request.state.auth after require_auth decoration.
|
||||||
|
|
||||||
|
Attributes:
|
||||||
|
user: The authenticated user, or None if anonymous
|
||||||
|
permissions: List of permission strings (e.g., "threads:read")
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = ("user", "permissions")
|
||||||
|
|
||||||
|
def __init__(self, user: User | None = None, permissions: list[str] | None = None):
|
||||||
|
self.user = user
|
||||||
|
self.permissions = permissions or []
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_authenticated(self) -> bool:
|
||||||
|
"""Check if user is authenticated."""
|
||||||
|
return self.user is not None
|
||||||
|
|
||||||
|
def has_permission(self, resource: str, action: str) -> bool:
|
||||||
|
"""Check if context has permission for resource:action.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
resource: Resource name (e.g., "threads")
|
||||||
|
action: Action name (e.g., "read")
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
True if user has permission
|
||||||
|
"""
|
||||||
|
permission = f"{resource}:{action}"
|
||||||
|
return permission in self.permissions
|
||||||
|
|
||||||
|
def require_user(self) -> User:
|
||||||
|
"""Get user or raise 401.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
HTTPException 401 if not authenticated
|
||||||
|
"""
|
||||||
|
if not self.user:
|
||||||
|
raise HTTPException(status_code=401, detail="Authentication required")
|
||||||
|
return self.user
|
||||||
|
|
||||||
|
|
||||||
|
def get_auth_context(request: Request) -> AuthContext | None:
|
||||||
|
"""Get AuthContext from request state."""
|
||||||
|
return getattr(request.state, "auth", None)
|
||||||
|
|
||||||
|
|
||||||
|
_ALL_PERMISSIONS: list[str] = [
|
||||||
|
Permissions.THREADS_READ,
|
||||||
|
Permissions.THREADS_WRITE,
|
||||||
|
Permissions.THREADS_DELETE,
|
||||||
|
Permissions.RUNS_CREATE,
|
||||||
|
Permissions.RUNS_READ,
|
||||||
|
Permissions.RUNS_CANCEL,
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
async def _authenticate(request: Request) -> AuthContext:
|
||||||
|
"""Authenticate request and return AuthContext.
|
||||||
|
|
||||||
|
Delegates to deps.get_optional_user_from_request() for the JWT→User pipeline.
|
||||||
|
Returns AuthContext with user=None for anonymous requests.
|
||||||
|
"""
|
||||||
|
from app.gateway.deps import get_optional_user_from_request
|
||||||
|
|
||||||
|
user = await get_optional_user_from_request(request)
|
||||||
|
if user is None:
|
||||||
|
return AuthContext(user=None, permissions=[])
|
||||||
|
|
||||||
|
# In future, permissions could be stored in user record
|
||||||
|
return AuthContext(user=user, permissions=_ALL_PERMISSIONS)
|
||||||
|
|
||||||
|
|
||||||
|
def require_auth[**P, T](func: Callable[P, T]) -> Callable[P, T]:
|
||||||
|
"""Decorator that authenticates the request and sets AuthContext.
|
||||||
|
|
||||||
|
Must be placed ABOVE other decorators (executes after them).
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
@router.get("/{thread_id}")
|
||||||
|
@require_auth # Bottom decorator (executes first after permission check)
|
||||||
|
@require_permission("threads", "read")
|
||||||
|
async def get_thread(thread_id: str, request: Request):
|
||||||
|
auth: AuthContext = request.state.auth
|
||||||
|
...
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If 'request' parameter is missing
|
||||||
|
"""
|
||||||
|
|
||||||
|
@functools.wraps(func)
|
||||||
|
async def wrapper(*args: Any, **kwargs: Any) -> Any:
|
||||||
|
request = kwargs.get("request")
|
||||||
|
if request is None:
|
||||||
|
raise ValueError("require_auth decorator requires 'request' parameter")
|
||||||
|
|
||||||
|
# Authenticate and set context
|
||||||
|
auth_context = await _authenticate(request)
|
||||||
|
request.state.auth = auth_context
|
||||||
|
|
||||||
|
return await func(*args, **kwargs)
|
||||||
|
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
|
||||||
|
def require_permission(
|
||||||
|
resource: str,
|
||||||
|
action: str,
|
||||||
|
owner_check: bool = False,
|
||||||
|
require_existing: bool = False,
|
||||||
|
) -> Callable[[Callable[P, T]], Callable[P, T]]:
|
||||||
|
"""Decorator that checks permission for resource:action.
|
||||||
|
|
||||||
|
Must be used AFTER @require_auth.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
resource: Resource name (e.g., "threads", "runs")
|
||||||
|
action: Action name (e.g., "read", "write", "delete")
|
||||||
|
owner_check: If True, validates that the current user owns the resource.
|
||||||
|
Requires 'thread_id' path parameter and performs ownership check.
|
||||||
|
require_existing: Only meaningful with ``owner_check=True``. If True, a
|
||||||
|
missing ``threads_meta`` row counts as a denial (404)
|
||||||
|
instead of "untracked legacy thread, allow". Use on
|
||||||
|
**destructive / mutating** routes (DELETE, PATCH,
|
||||||
|
state-update) so a deleted thread can't be re-targeted
|
||||||
|
by another user via the missing-row code path.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
# Read-style: legacy untracked threads are allowed
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def get_thread(thread_id: str, request: Request):
|
||||||
|
...
|
||||||
|
|
||||||
|
# Destructive: thread row MUST exist and be owned by caller
|
||||||
|
@require_permission("threads", "delete", owner_check=True, require_existing=True)
|
||||||
|
async def delete_thread(thread_id: str, request: Request):
|
||||||
|
...
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
HTTPException 401: If authentication required but user is anonymous
|
||||||
|
HTTPException 403: If user lacks permission
|
||||||
|
HTTPException 404: If owner_check=True but user doesn't own the thread
|
||||||
|
ValueError: If owner_check=True but 'thread_id' parameter is missing
|
||||||
|
"""
|
||||||
|
|
||||||
|
def decorator(func: Callable[P, T]) -> Callable[P, T]:
|
||||||
|
@functools.wraps(func)
|
||||||
|
async def wrapper(*args: Any, **kwargs: Any) -> Any:
|
||||||
|
request = kwargs.get("request")
|
||||||
|
if request is None:
|
||||||
|
raise ValueError("require_permission decorator requires 'request' parameter")
|
||||||
|
|
||||||
|
auth: AuthContext = getattr(request.state, "auth", None)
|
||||||
|
if auth is None:
|
||||||
|
auth = await _authenticate(request)
|
||||||
|
request.state.auth = auth
|
||||||
|
|
||||||
|
if not auth.is_authenticated:
|
||||||
|
raise HTTPException(status_code=401, detail="Authentication required")
|
||||||
|
|
||||||
|
# Check permission
|
||||||
|
if not auth.has_permission(resource, action):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=403,
|
||||||
|
detail=f"Permission denied: {resource}:{action}",
|
||||||
|
)
|
||||||
|
|
||||||
|
# Owner check for thread-specific resources.
|
||||||
|
#
|
||||||
|
# 2.0-rc moved thread metadata into the SQL persistence layer
|
||||||
|
# (``threads_meta`` table). We verify ownership via
|
||||||
|
# ``ThreadMetaStore.check_access``: it returns True for
|
||||||
|
# missing rows (untracked legacy thread) and for rows whose
|
||||||
|
# ``owner_id`` is NULL (shared / pre-auth data), so this is
|
||||||
|
# strict-deny rather than strict-allow — only an *existing*
|
||||||
|
# row with a *different* owner_id triggers 404.
|
||||||
|
if owner_check:
|
||||||
|
thread_id = kwargs.get("thread_id")
|
||||||
|
if thread_id is None:
|
||||||
|
raise ValueError("require_permission with owner_check=True requires 'thread_id' parameter")
|
||||||
|
|
||||||
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
|
|
||||||
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
|
allowed = await thread_meta_repo.check_access(
|
||||||
|
thread_id,
|
||||||
|
str(auth.user.id),
|
||||||
|
require_existing=require_existing,
|
||||||
|
)
|
||||||
|
if not allowed:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=404,
|
||||||
|
detail=f"Thread {thread_id} not found",
|
||||||
|
)
|
||||||
|
|
||||||
|
return await func(*args, **kwargs)
|
||||||
|
|
||||||
|
return wrapper
|
||||||
|
|
||||||
|
return decorator
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
"""CSRF protection middleware for FastAPI.
|
||||||
|
|
||||||
|
Per RFC-001:
|
||||||
|
State-changing operations require CSRF protection.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import secrets
|
||||||
|
from collections.abc import Callable
|
||||||
|
|
||||||
|
from fastapi import Request, Response
|
||||||
|
from starlette.middleware.base import BaseHTTPMiddleware
|
||||||
|
from starlette.responses import JSONResponse
|
||||||
|
from starlette.types import ASGIApp
|
||||||
|
|
||||||
|
CSRF_COOKIE_NAME = "csrf_token"
|
||||||
|
CSRF_HEADER_NAME = "X-CSRF-Token"
|
||||||
|
CSRF_TOKEN_LENGTH = 64 # bytes
|
||||||
|
|
||||||
|
|
||||||
|
def is_secure_request(request: Request) -> bool:
|
||||||
|
"""Detect whether the original client request was made over HTTPS."""
|
||||||
|
return request.headers.get("x-forwarded-proto", request.url.scheme) == "https"
|
||||||
|
|
||||||
|
|
||||||
|
def generate_csrf_token() -> str:
|
||||||
|
"""Generate a secure random CSRF token."""
|
||||||
|
return secrets.token_urlsafe(CSRF_TOKEN_LENGTH)
|
||||||
|
|
||||||
|
|
||||||
|
def should_check_csrf(request: Request) -> bool:
|
||||||
|
"""Determine if a request needs CSRF validation.
|
||||||
|
|
||||||
|
CSRF is checked for state-changing methods (POST, PUT, DELETE, PATCH).
|
||||||
|
GET, HEAD, OPTIONS, and TRACE are exempt per RFC 7231.
|
||||||
|
"""
|
||||||
|
if request.method not in ("POST", "PUT", "DELETE", "PATCH"):
|
||||||
|
return False
|
||||||
|
|
||||||
|
path = request.url.path.rstrip("/")
|
||||||
|
# Exempt /api/v1/auth/me endpoint
|
||||||
|
if path == "/api/v1/auth/me":
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
_AUTH_EXEMPT_PATHS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"/api/v1/auth/login/local",
|
||||||
|
"/api/v1/auth/logout",
|
||||||
|
"/api/v1/auth/register",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def is_auth_endpoint(request: Request) -> bool:
|
||||||
|
"""Check if the request is to an auth endpoint.
|
||||||
|
|
||||||
|
Auth endpoints don't need CSRF validation on first call (no token).
|
||||||
|
"""
|
||||||
|
return request.url.path.rstrip("/") in _AUTH_EXEMPT_PATHS
|
||||||
|
|
||||||
|
|
||||||
|
class CSRFMiddleware(BaseHTTPMiddleware):
|
||||||
|
"""Middleware that implements CSRF protection using Double Submit Cookie pattern."""
|
||||||
|
|
||||||
|
def __init__(self, app: ASGIApp) -> None:
|
||||||
|
super().__init__(app)
|
||||||
|
|
||||||
|
async def dispatch(self, request: Request, call_next: Callable) -> Response:
|
||||||
|
_is_auth = is_auth_endpoint(request)
|
||||||
|
|
||||||
|
if should_check_csrf(request) and not _is_auth:
|
||||||
|
cookie_token = request.cookies.get(CSRF_COOKIE_NAME)
|
||||||
|
header_token = request.headers.get(CSRF_HEADER_NAME)
|
||||||
|
|
||||||
|
if not cookie_token or not header_token:
|
||||||
|
return JSONResponse(
|
||||||
|
status_code=403,
|
||||||
|
content={"detail": "CSRF token missing. Include X-CSRF-Token header."},
|
||||||
|
)
|
||||||
|
|
||||||
|
if not secrets.compare_digest(cookie_token, header_token):
|
||||||
|
return JSONResponse(
|
||||||
|
status_code=403,
|
||||||
|
content={"detail": "CSRF token mismatch."},
|
||||||
|
)
|
||||||
|
|
||||||
|
response = await call_next(request)
|
||||||
|
|
||||||
|
# For auth endpoints that set up session, also set CSRF cookie
|
||||||
|
if _is_auth and request.method == "POST":
|
||||||
|
# Generate a new CSRF token for the session
|
||||||
|
csrf_token = generate_csrf_token()
|
||||||
|
is_https = is_secure_request(request)
|
||||||
|
response.set_cookie(
|
||||||
|
key=CSRF_COOKIE_NAME,
|
||||||
|
value=csrf_token,
|
||||||
|
httponly=False, # Must be JS-readable for Double Submit Cookie pattern
|
||||||
|
secure=is_https,
|
||||||
|
samesite="strict",
|
||||||
|
)
|
||||||
|
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
def get_csrf_token(request: Request) -> str | None:
|
||||||
|
"""Get the CSRF token from the current request's cookies.
|
||||||
|
|
||||||
|
This is useful for server-side rendering where you need to embed
|
||||||
|
token in forms or headers.
|
||||||
|
"""
|
||||||
|
return request.cookies.get(CSRF_COOKIE_NAME)
|
||||||
+180
-25
@@ -1,7 +1,8 @@
|
|||||||
"""Centralized accessors for singleton objects stored on ``app.state``.
|
"""Centralized accessors for singleton objects stored on ``app.state``.
|
||||||
|
|
||||||
**Getters** (used by routers): raise 503 when a required dependency is
|
**Getters** (used by routers): raise 503 when a required dependency is
|
||||||
missing, except ``get_store`` which returns ``None``.
|
missing, except ``get_store`` and ``get_thread_meta_repo`` which return
|
||||||
|
``None``.
|
||||||
|
|
||||||
Initialization is handled directly in ``app.py`` via :class:`AsyncExitStack`.
|
Initialization is handled directly in ``app.py`` via :class:`AsyncExitStack`.
|
||||||
"""
|
"""
|
||||||
@@ -10,10 +11,15 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from collections.abc import AsyncGenerator
|
from collections.abc import AsyncGenerator
|
||||||
from contextlib import AsyncExitStack, asynccontextmanager
|
from contextlib import AsyncExitStack, asynccontextmanager
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
from fastapi import FastAPI, HTTPException, Request
|
from fastapi import FastAPI, HTTPException, Request
|
||||||
|
|
||||||
from deerflow.runtime import RunManager, StreamBridge
|
from deerflow.runtime import RunContext, RunManager
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from app.gateway.auth.local_provider import LocalAuthProvider
|
||||||
|
from app.gateway.auth.repositories.sqlite import SQLiteUserRepository
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
@asynccontextmanager
|
||||||
@@ -26,45 +32,194 @@ async def langgraph_runtime(app: FastAPI) -> AsyncGenerator[None, None]:
|
|||||||
yield
|
yield
|
||||||
"""
|
"""
|
||||||
from deerflow.agents.checkpointer.async_provider import make_checkpointer
|
from deerflow.agents.checkpointer.async_provider import make_checkpointer
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
from deerflow.persistence.engine import close_engine, get_session_factory, init_engine_from_config
|
||||||
from deerflow.runtime import make_store, make_stream_bridge
|
from deerflow.runtime import make_store, make_stream_bridge
|
||||||
|
from deerflow.runtime.events.store import make_run_event_store
|
||||||
|
|
||||||
async with AsyncExitStack() as stack:
|
async with AsyncExitStack() as stack:
|
||||||
app.state.stream_bridge = await stack.enter_async_context(make_stream_bridge())
|
app.state.stream_bridge = await stack.enter_async_context(make_stream_bridge())
|
||||||
|
|
||||||
|
# Initialize persistence engine BEFORE checkpointer so that
|
||||||
|
# auto-create-database logic runs first (postgres backend).
|
||||||
|
config = get_app_config()
|
||||||
|
await init_engine_from_config(config.database)
|
||||||
|
|
||||||
app.state.checkpointer = await stack.enter_async_context(make_checkpointer())
|
app.state.checkpointer = await stack.enter_async_context(make_checkpointer())
|
||||||
app.state.store = await stack.enter_async_context(make_store())
|
app.state.store = await stack.enter_async_context(make_store())
|
||||||
app.state.run_manager = RunManager()
|
|
||||||
yield
|
# Initialize repositories — one get_session_factory() call for all.
|
||||||
|
sf = get_session_factory()
|
||||||
|
if sf is not None:
|
||||||
|
from deerflow.persistence.feedback import FeedbackRepository
|
||||||
|
from deerflow.persistence.run import RunRepository
|
||||||
|
from deerflow.persistence.thread_meta import ThreadMetaRepository
|
||||||
|
|
||||||
|
app.state.run_store = RunRepository(sf)
|
||||||
|
app.state.feedback_repo = FeedbackRepository(sf)
|
||||||
|
app.state.thread_meta_repo = ThreadMetaRepository(sf)
|
||||||
|
else:
|
||||||
|
from deerflow.persistence.thread_meta import MemoryThreadMetaStore
|
||||||
|
from deerflow.runtime.runs.store.memory import MemoryRunStore
|
||||||
|
|
||||||
|
app.state.run_store = MemoryRunStore()
|
||||||
|
app.state.feedback_repo = None
|
||||||
|
app.state.thread_meta_repo = MemoryThreadMetaStore(app.state.store)
|
||||||
|
|
||||||
|
# Run event store (has its own factory with config-driven backend selection)
|
||||||
|
run_events_config = getattr(config, "run_events", None)
|
||||||
|
app.state.run_event_store = make_run_event_store(run_events_config)
|
||||||
|
|
||||||
|
# RunManager with store backing for persistence
|
||||||
|
app.state.run_manager = RunManager(store=app.state.run_store)
|
||||||
|
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
await close_engine()
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Getters – called by routers per-request
|
# Getters -- called by routers per-request
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
def get_stream_bridge(request: Request) -> StreamBridge:
|
def _require(attr: str, label: str):
|
||||||
"""Return the global :class:`StreamBridge`, or 503."""
|
"""Create a FastAPI dependency that returns ``app.state.<attr>`` or 503."""
|
||||||
bridge = getattr(request.app.state, "stream_bridge", None)
|
|
||||||
if bridge is None:
|
def dep(request: Request):
|
||||||
raise HTTPException(status_code=503, detail="Stream bridge not available")
|
val = getattr(request.app.state, attr, None)
|
||||||
return bridge
|
if val is None:
|
||||||
|
raise HTTPException(status_code=503, detail=f"{label} not available")
|
||||||
|
return val
|
||||||
|
|
||||||
|
dep.__name__ = dep.__qualname__ = f"get_{attr}"
|
||||||
|
return dep
|
||||||
|
|
||||||
|
|
||||||
def get_run_manager(request: Request) -> RunManager:
|
get_stream_bridge = _require("stream_bridge", "Stream bridge")
|
||||||
"""Return the global :class:`RunManager`, or 503."""
|
get_run_manager = _require("run_manager", "Run manager")
|
||||||
mgr = getattr(request.app.state, "run_manager", None)
|
get_checkpointer = _require("checkpointer", "Checkpointer")
|
||||||
if mgr is None:
|
get_run_event_store = _require("run_event_store", "Run event store")
|
||||||
raise HTTPException(status_code=503, detail="Run manager not available")
|
get_feedback_repo = _require("feedback_repo", "Feedback")
|
||||||
return mgr
|
get_run_store = _require("run_store", "Run store")
|
||||||
|
|
||||||
|
|
||||||
def get_checkpointer(request: Request):
|
|
||||||
"""Return the global checkpointer, or 503."""
|
|
||||||
cp = getattr(request.app.state, "checkpointer", None)
|
|
||||||
if cp is None:
|
|
||||||
raise HTTPException(status_code=503, detail="Checkpointer not available")
|
|
||||||
return cp
|
|
||||||
|
|
||||||
|
|
||||||
def get_store(request: Request):
|
def get_store(request: Request):
|
||||||
"""Return the global store (may be ``None`` if not configured)."""
|
"""Return the global store (may be ``None`` if not configured)."""
|
||||||
return getattr(request.app.state, "store", None)
|
return getattr(request.app.state, "store", None)
|
||||||
|
|
||||||
|
|
||||||
|
get_thread_meta_repo = _require("thread_meta_repo", "Thread metadata store")
|
||||||
|
|
||||||
|
|
||||||
|
def get_run_context(request: Request) -> RunContext:
|
||||||
|
"""Build a :class:`RunContext` from ``app.state`` singletons.
|
||||||
|
|
||||||
|
Returns a *base* context with infrastructure dependencies. Callers that
|
||||||
|
need per-run fields (e.g. ``follow_up_to_run_id``) should use
|
||||||
|
``dataclasses.replace(ctx, follow_up_to_run_id=...)`` before passing it
|
||||||
|
to :func:`run_agent`.
|
||||||
|
"""
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
|
||||||
|
return RunContext(
|
||||||
|
checkpointer=get_checkpointer(request),
|
||||||
|
store=get_store(request),
|
||||||
|
event_store=get_run_event_store(request),
|
||||||
|
run_events_config=getattr(get_app_config(), "run_events", None),
|
||||||
|
thread_meta_repo=get_thread_meta_repo(request),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Auth helpers (used by authz.py and auth middleware)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
# Cached singletons to avoid repeated instantiation per request
|
||||||
|
_cached_local_provider: LocalAuthProvider | None = None
|
||||||
|
_cached_repo: SQLiteUserRepository | None = None
|
||||||
|
|
||||||
|
|
||||||
|
def get_local_provider() -> LocalAuthProvider:
|
||||||
|
"""Get or create the cached LocalAuthProvider singleton.
|
||||||
|
|
||||||
|
Must be called after ``init_engine_from_config()`` — the shared
|
||||||
|
session factory is required to construct the user repository.
|
||||||
|
"""
|
||||||
|
global _cached_local_provider, _cached_repo
|
||||||
|
if _cached_repo is None:
|
||||||
|
from app.gateway.auth.repositories.sqlite import SQLiteUserRepository
|
||||||
|
from deerflow.persistence.engine import get_session_factory
|
||||||
|
|
||||||
|
sf = get_session_factory()
|
||||||
|
if sf is None:
|
||||||
|
raise RuntimeError("get_local_provider() called before init_engine_from_config(); cannot access users table")
|
||||||
|
_cached_repo = SQLiteUserRepository(sf)
|
||||||
|
if _cached_local_provider is None:
|
||||||
|
from app.gateway.auth.local_provider import LocalAuthProvider
|
||||||
|
|
||||||
|
_cached_local_provider = LocalAuthProvider(repository=_cached_repo)
|
||||||
|
return _cached_local_provider
|
||||||
|
|
||||||
|
|
||||||
|
async def get_current_user_from_request(request: Request):
|
||||||
|
"""Get the current authenticated user from the request cookie.
|
||||||
|
|
||||||
|
Raises HTTPException 401 if not authenticated.
|
||||||
|
"""
|
||||||
|
from app.gateway.auth import decode_token
|
||||||
|
from app.gateway.auth.errors import AuthErrorCode, AuthErrorResponse, TokenError, token_error_to_code
|
||||||
|
|
||||||
|
access_token = request.cookies.get("access_token")
|
||||||
|
if not access_token:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail=AuthErrorResponse(code=AuthErrorCode.NOT_AUTHENTICATED, message="Not authenticated").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
payload = decode_token(access_token)
|
||||||
|
if isinstance(payload, TokenError):
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail=AuthErrorResponse(code=token_error_to_code(payload), message=f"Token error: {payload.value}").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
provider = get_local_provider()
|
||||||
|
user = await provider.get_user(payload.sub)
|
||||||
|
if user is None:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail=AuthErrorResponse(code=AuthErrorCode.USER_NOT_FOUND, message="User not found").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Token version mismatch → password was changed, token is stale
|
||||||
|
if user.token_version != payload.ver:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail=AuthErrorResponse(code=AuthErrorCode.TOKEN_INVALID, message="Token revoked (password changed)").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
return user
|
||||||
|
|
||||||
|
|
||||||
|
async def get_optional_user_from_request(request: Request):
|
||||||
|
"""Get optional authenticated user from request.
|
||||||
|
|
||||||
|
Returns None if not authenticated.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return await get_current_user_from_request(request)
|
||||||
|
except HTTPException:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
async def get_current_user(request: Request) -> str | None:
|
||||||
|
"""Extract user_id from request cookie, or None if not authenticated.
|
||||||
|
|
||||||
|
Thin adapter that returns the string id for callers that only need
|
||||||
|
identification (e.g., ``feedback.py``). Full-user callers should use
|
||||||
|
``get_current_user_from_request`` or ``get_optional_user_from_request``.
|
||||||
|
"""
|
||||||
|
user = await get_optional_user_from_request(request)
|
||||||
|
return str(user.id) if user else None
|
||||||
|
|||||||
@@ -0,0 +1,106 @@
|
|||||||
|
"""LangGraph Server auth handler — shares JWT logic with Gateway.
|
||||||
|
|
||||||
|
Loaded by LangGraph Server via langgraph.json ``auth.path``.
|
||||||
|
Reuses the same ``decode_token`` / ``get_auth_config`` as Gateway,
|
||||||
|
so both modes validate tokens with the same secret and rules.
|
||||||
|
|
||||||
|
Two layers:
|
||||||
|
1. @auth.authenticate — validates JWT cookie, extracts user_id,
|
||||||
|
and enforces CSRF on state-changing methods (POST/PUT/DELETE/PATCH)
|
||||||
|
2. @auth.on — returns metadata filter so each user only sees own threads
|
||||||
|
"""
|
||||||
|
|
||||||
|
import secrets
|
||||||
|
|
||||||
|
from langgraph_sdk import Auth
|
||||||
|
|
||||||
|
from app.gateway.auth.errors import TokenError
|
||||||
|
from app.gateway.auth.jwt import decode_token
|
||||||
|
from app.gateway.deps import get_local_provider
|
||||||
|
|
||||||
|
auth = Auth()
|
||||||
|
|
||||||
|
# Methods that require CSRF validation (state-changing per RFC 7231).
|
||||||
|
_CSRF_METHODS = frozenset({"POST", "PUT", "DELETE", "PATCH"})
|
||||||
|
|
||||||
|
|
||||||
|
def _check_csrf(request) -> None:
|
||||||
|
"""Enforce Double Submit Cookie CSRF check for state-changing requests.
|
||||||
|
|
||||||
|
Mirrors Gateway's CSRFMiddleware logic so that LangGraph routes
|
||||||
|
proxied directly by nginx have the same CSRF protection.
|
||||||
|
"""
|
||||||
|
method = getattr(request, "method", "") or ""
|
||||||
|
if method.upper() not in _CSRF_METHODS:
|
||||||
|
return
|
||||||
|
|
||||||
|
cookie_token = request.cookies.get("csrf_token")
|
||||||
|
header_token = request.headers.get("x-csrf-token")
|
||||||
|
|
||||||
|
if not cookie_token or not header_token:
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=403,
|
||||||
|
detail="CSRF token missing. Include X-CSRF-Token header.",
|
||||||
|
)
|
||||||
|
|
||||||
|
if not secrets.compare_digest(cookie_token, header_token):
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=403,
|
||||||
|
detail="CSRF token mismatch.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@auth.authenticate
|
||||||
|
async def authenticate(request):
|
||||||
|
"""Validate the session cookie, decode JWT, and check token_version.
|
||||||
|
|
||||||
|
Same validation chain as Gateway's get_current_user_from_request:
|
||||||
|
cookie → decode JWT → DB lookup → token_version match
|
||||||
|
Also enforces CSRF on state-changing methods.
|
||||||
|
"""
|
||||||
|
# CSRF check before authentication so forged cross-site requests
|
||||||
|
# are rejected early, even if the cookie carries a valid JWT.
|
||||||
|
_check_csrf(request)
|
||||||
|
|
||||||
|
token = request.cookies.get("access_token")
|
||||||
|
if not token:
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail="Not authenticated",
|
||||||
|
)
|
||||||
|
|
||||||
|
payload = decode_token(token)
|
||||||
|
if isinstance(payload, TokenError):
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail=f"Token error: {payload.value}",
|
||||||
|
)
|
||||||
|
|
||||||
|
user = await get_local_provider().get_user(payload.sub)
|
||||||
|
if user is None:
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail="User not found",
|
||||||
|
)
|
||||||
|
if user.token_version != payload.ver:
|
||||||
|
raise Auth.exceptions.HTTPException(
|
||||||
|
status_code=401,
|
||||||
|
detail="Token revoked (password changed)",
|
||||||
|
)
|
||||||
|
|
||||||
|
return payload.sub
|
||||||
|
|
||||||
|
|
||||||
|
@auth.on
|
||||||
|
async def add_owner_filter(ctx: Auth.types.AuthContext, value: dict):
|
||||||
|
"""Inject owner_id metadata on writes; filter by owner_id on reads.
|
||||||
|
|
||||||
|
Gateway stores thread ownership as ``metadata.owner_id``.
|
||||||
|
This handler ensures LangGraph Server enforces the same isolation.
|
||||||
|
"""
|
||||||
|
# On create/update: stamp owner_id into metadata
|
||||||
|
metadata = value.setdefault("metadata", {})
|
||||||
|
metadata["owner_id"] = ctx.user.identity
|
||||||
|
|
||||||
|
# Return filter dict — LangGraph applies it to search/read/delete
|
||||||
|
return {"owner_id": ctx.user.identity}
|
||||||
@@ -24,7 +24,7 @@ class AgentResponse(BaseModel):
|
|||||||
description: str = Field(default="", description="Agent description")
|
description: str = Field(default="", description="Agent description")
|
||||||
model: str | None = Field(default=None, description="Optional model override")
|
model: str | None = Field(default=None, description="Optional model override")
|
||||||
tool_groups: list[str] | None = Field(default=None, description="Optional tool group whitelist")
|
tool_groups: list[str] | None = Field(default=None, description="Optional tool group whitelist")
|
||||||
soul: str | None = Field(default=None, description="SOUL.md content (included on GET /{name})")
|
soul: str | None = Field(default=None, description="SOUL.md content")
|
||||||
|
|
||||||
|
|
||||||
class AgentsListResponse(BaseModel):
|
class AgentsListResponse(BaseModel):
|
||||||
@@ -92,17 +92,17 @@ def _agent_config_to_response(agent_cfg: AgentConfig, include_soul: bool = False
|
|||||||
"/agents",
|
"/agents",
|
||||||
response_model=AgentsListResponse,
|
response_model=AgentsListResponse,
|
||||||
summary="List Custom Agents",
|
summary="List Custom Agents",
|
||||||
description="List all custom agents available in the agents directory.",
|
description="List all custom agents available in the agents directory, including their soul content.",
|
||||||
)
|
)
|
||||||
async def list_agents() -> AgentsListResponse:
|
async def list_agents() -> AgentsListResponse:
|
||||||
"""List all custom agents.
|
"""List all custom agents.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
List of all custom agents with their metadata (without soul content).
|
List of all custom agents with their metadata and soul content.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
agents = list_custom_agents()
|
agents = list_custom_agents()
|
||||||
return AgentsListResponse(agents=[_agent_config_to_response(a) for a in agents])
|
return AgentsListResponse(agents=[_agent_config_to_response(a, include_soul=True) for a in agents])
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error(f"Failed to list agents: {e}", exc_info=True)
|
logger.error(f"Failed to list agents: {e}", exc_info=True)
|
||||||
raise HTTPException(status_code=500, detail=f"Failed to list agents: {str(e)}")
|
raise HTTPException(status_code=500, detail=f"Failed to list agents: {str(e)}")
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from urllib.parse import quote
|
|||||||
from fastapi import APIRouter, HTTPException, Request
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
from fastapi.responses import FileResponse, PlainTextResponse, Response
|
from fastapi.responses import FileResponse, PlainTextResponse, Response
|
||||||
|
|
||||||
|
from app.gateway.authz import require_permission
|
||||||
from app.gateway.path_utils import resolve_thread_virtual_path
|
from app.gateway.path_utils import resolve_thread_virtual_path
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -81,6 +82,7 @@ def _extract_file_from_skill_archive(zip_path: Path, internal_path: str) -> byte
|
|||||||
summary="Get Artifact File",
|
summary="Get Artifact File",
|
||||||
description="Retrieve an artifact file generated by the AI agent. Text and binary files can be viewed inline, while active web content is always downloaded.",
|
description="Retrieve an artifact file generated by the AI agent. Text and binary files can be viewed inline, while active web content is always downloaded.",
|
||||||
)
|
)
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
async def get_artifact(thread_id: str, path: str, request: Request, download: bool = False) -> Response:
|
async def get_artifact(thread_id: str, path: str, request: Request, download: bool = False) -> Response:
|
||||||
"""Get an artifact file by its path.
|
"""Get an artifact file by its path.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,418 @@
|
|||||||
|
"""Authentication endpoints."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
from ipaddress import ip_address, ip_network
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends, HTTPException, Request, Response, status
|
||||||
|
from fastapi.security import OAuth2PasswordRequestForm
|
||||||
|
from pydantic import BaseModel, EmailStr, Field, field_validator
|
||||||
|
|
||||||
|
from app.gateway.auth import (
|
||||||
|
UserResponse,
|
||||||
|
create_access_token,
|
||||||
|
)
|
||||||
|
from app.gateway.auth.config import get_auth_config
|
||||||
|
from app.gateway.auth.errors import AuthErrorCode, AuthErrorResponse
|
||||||
|
from app.gateway.csrf_middleware import is_secure_request
|
||||||
|
from app.gateway.deps import get_current_user_from_request, get_local_provider
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/api/v1/auth", tags=["auth"])
|
||||||
|
|
||||||
|
|
||||||
|
# ── Request/Response Models ──────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
class LoginResponse(BaseModel):
|
||||||
|
"""Response model for login — token only lives in HttpOnly cookie."""
|
||||||
|
|
||||||
|
expires_in: int # seconds
|
||||||
|
needs_setup: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
# Top common-password blocklist. Drawn from the public SecLists "10k worst
|
||||||
|
# passwords" set, lowercased + length>=8 only (shorter ones already fail
|
||||||
|
# the min_length check). Kept tight on purpose: this is the **lower bound**
|
||||||
|
# defense, not a full HIBP / passlib check, and runs in-process per request.
|
||||||
|
_COMMON_PASSWORDS: frozenset[str] = frozenset(
|
||||||
|
{
|
||||||
|
"password",
|
||||||
|
"password1",
|
||||||
|
"password12",
|
||||||
|
"password123",
|
||||||
|
"password1234",
|
||||||
|
"12345678",
|
||||||
|
"123456789",
|
||||||
|
"1234567890",
|
||||||
|
"qwerty12",
|
||||||
|
"qwertyui",
|
||||||
|
"qwerty123",
|
||||||
|
"abc12345",
|
||||||
|
"abcd1234",
|
||||||
|
"iloveyou",
|
||||||
|
"letmein1",
|
||||||
|
"welcome1",
|
||||||
|
"welcome123",
|
||||||
|
"admin123",
|
||||||
|
"administrator",
|
||||||
|
"passw0rd",
|
||||||
|
"p@ssw0rd",
|
||||||
|
"monkey12",
|
||||||
|
"trustno1",
|
||||||
|
"sunshine",
|
||||||
|
"princess",
|
||||||
|
"football",
|
||||||
|
"baseball",
|
||||||
|
"superman",
|
||||||
|
"batman123",
|
||||||
|
"starwars",
|
||||||
|
"dragon123",
|
||||||
|
"master123",
|
||||||
|
"shadow12",
|
||||||
|
"michael1",
|
||||||
|
"jennifer",
|
||||||
|
"computer",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _password_is_common(password: str) -> bool:
|
||||||
|
"""Case-insensitive blocklist check.
|
||||||
|
|
||||||
|
Lowercases the input so trivial mutations like ``Password`` /
|
||||||
|
``PASSWORD`` are also rejected. Does not normalize digit substitutions
|
||||||
|
(``p@ssw0rd`` is included as a literal entry instead) — keeping the
|
||||||
|
rule cheap and predictable.
|
||||||
|
"""
|
||||||
|
return password.lower() in _COMMON_PASSWORDS
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_strong_password(value: str) -> str:
|
||||||
|
"""Pydantic field-validator body shared by Register + ChangePassword.
|
||||||
|
|
||||||
|
Constraint = function, not type-level mixin. The two request models
|
||||||
|
have no "is-a" relationship; they only share the password-strength
|
||||||
|
rule. Lifting it into a free function lets each model bind it via
|
||||||
|
``@field_validator(field_name)`` without inheritance gymnastics.
|
||||||
|
"""
|
||||||
|
if _password_is_common(value):
|
||||||
|
raise ValueError("Password is too common; choose a stronger password.")
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
class RegisterRequest(BaseModel):
|
||||||
|
"""Request model for user registration."""
|
||||||
|
|
||||||
|
email: EmailStr
|
||||||
|
password: str = Field(..., min_length=8)
|
||||||
|
|
||||||
|
_strong_password = field_validator("password")(classmethod(lambda cls, v: _validate_strong_password(v)))
|
||||||
|
|
||||||
|
|
||||||
|
class ChangePasswordRequest(BaseModel):
|
||||||
|
"""Request model for password change (also handles setup flow)."""
|
||||||
|
|
||||||
|
current_password: str
|
||||||
|
new_password: str = Field(..., min_length=8)
|
||||||
|
new_email: EmailStr | None = None
|
||||||
|
|
||||||
|
_strong_password = field_validator("new_password")(classmethod(lambda cls, v: _validate_strong_password(v)))
|
||||||
|
|
||||||
|
|
||||||
|
class MessageResponse(BaseModel):
|
||||||
|
"""Generic message response."""
|
||||||
|
|
||||||
|
message: str
|
||||||
|
|
||||||
|
|
||||||
|
# ── Helpers ───────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
def _set_session_cookie(response: Response, token: str, request: Request) -> None:
|
||||||
|
"""Set the access_token HttpOnly cookie on the response."""
|
||||||
|
config = get_auth_config()
|
||||||
|
is_https = is_secure_request(request)
|
||||||
|
response.set_cookie(
|
||||||
|
key="access_token",
|
||||||
|
value=token,
|
||||||
|
httponly=True,
|
||||||
|
secure=is_https,
|
||||||
|
samesite="lax",
|
||||||
|
max_age=config.token_expiry_days * 24 * 3600 if is_https else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ── Rate Limiting ────────────────────────────────────────────────────────
|
||||||
|
# In-process dict — not shared across workers. Sufficient for single-worker deployments.
|
||||||
|
|
||||||
|
_MAX_LOGIN_ATTEMPTS = 5
|
||||||
|
_LOCKOUT_SECONDS = 300 # 5 minutes
|
||||||
|
|
||||||
|
# ip → (fail_count, lock_until_timestamp)
|
||||||
|
_login_attempts: dict[str, tuple[int, float]] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def _trusted_proxies() -> list:
|
||||||
|
"""Parse ``AUTH_TRUSTED_PROXIES`` env var into a list of ip_network objects.
|
||||||
|
|
||||||
|
Comma-separated CIDR or single-IP entries. Empty / unset = no proxy is
|
||||||
|
trusted (direct mode). Invalid entries are skipped with a logger warning.
|
||||||
|
Read live so env-var overrides take effect immediately and tests can
|
||||||
|
``monkeypatch.setenv`` without poking a module-level cache.
|
||||||
|
"""
|
||||||
|
raw = os.getenv("AUTH_TRUSTED_PROXIES", "").strip()
|
||||||
|
if not raw:
|
||||||
|
return []
|
||||||
|
nets = []
|
||||||
|
for entry in raw.split(","):
|
||||||
|
entry = entry.strip()
|
||||||
|
if not entry:
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
nets.append(ip_network(entry, strict=False))
|
||||||
|
except ValueError:
|
||||||
|
logger.warning("AUTH_TRUSTED_PROXIES: ignoring invalid entry %r", entry)
|
||||||
|
return nets
|
||||||
|
|
||||||
|
|
||||||
|
def _get_client_ip(request: Request) -> str:
|
||||||
|
"""Extract the real client IP for rate limiting.
|
||||||
|
|
||||||
|
Trust model:
|
||||||
|
|
||||||
|
- The TCP peer (``request.client.host``) is always the baseline. It is
|
||||||
|
whatever the kernel reports as the connecting socket — unforgeable
|
||||||
|
by the client itself.
|
||||||
|
- ``X-Real-IP`` is **only** honored if the TCP peer is in the
|
||||||
|
``AUTH_TRUSTED_PROXIES`` allowlist (set via env var, comma-separated
|
||||||
|
CIDR or single IPs). When set, the gateway is assumed to be behind a
|
||||||
|
reverse proxy (nginx, Cloudflare, ALB, …) that overwrites
|
||||||
|
``X-Real-IP`` with the original client address.
|
||||||
|
- With no ``AUTH_TRUSTED_PROXIES`` set, ``X-Real-IP`` is silently
|
||||||
|
ignored — closing the bypass where any client could rotate the
|
||||||
|
header to dodge per-IP rate limits in dev / direct-gateway mode.
|
||||||
|
|
||||||
|
``X-Forwarded-For`` is intentionally NOT used because it is naturally
|
||||||
|
client-controlled at the *first* hop and the trust chain is harder to
|
||||||
|
audit per-request.
|
||||||
|
"""
|
||||||
|
peer_host = request.client.host if request.client else None
|
||||||
|
|
||||||
|
trusted = _trusted_proxies()
|
||||||
|
if trusted and peer_host:
|
||||||
|
try:
|
||||||
|
peer_ip = ip_address(peer_host)
|
||||||
|
if any(peer_ip in net for net in trusted):
|
||||||
|
real_ip = request.headers.get("x-real-ip", "").strip()
|
||||||
|
if real_ip:
|
||||||
|
return real_ip
|
||||||
|
except ValueError:
|
||||||
|
# peer_host wasn't a parseable IP (e.g. "unknown") — fall through
|
||||||
|
pass
|
||||||
|
|
||||||
|
return peer_host or "unknown"
|
||||||
|
|
||||||
|
|
||||||
|
def _check_rate_limit(ip: str) -> None:
|
||||||
|
"""Raise 429 if the IP is currently locked out."""
|
||||||
|
record = _login_attempts.get(ip)
|
||||||
|
if record is None:
|
||||||
|
return
|
||||||
|
fail_count, lock_until = record
|
||||||
|
if fail_count >= _MAX_LOGIN_ATTEMPTS:
|
||||||
|
if time.time() < lock_until:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=429,
|
||||||
|
detail="Too many login attempts. Try again later.",
|
||||||
|
)
|
||||||
|
del _login_attempts[ip]
|
||||||
|
|
||||||
|
|
||||||
|
_MAX_TRACKED_IPS = 10000
|
||||||
|
|
||||||
|
|
||||||
|
def _record_login_failure(ip: str) -> None:
|
||||||
|
"""Record a failed login attempt for the given IP."""
|
||||||
|
# Evict expired lockouts when dict grows too large
|
||||||
|
if len(_login_attempts) >= _MAX_TRACKED_IPS:
|
||||||
|
now = time.time()
|
||||||
|
expired = [k for k, (c, t) in _login_attempts.items() if c >= _MAX_LOGIN_ATTEMPTS and now >= t]
|
||||||
|
for k in expired:
|
||||||
|
del _login_attempts[k]
|
||||||
|
# If still too large, evict cheapest-to-lose half: below-threshold
|
||||||
|
# IPs (lock_until=0.0) sort first, then earliest-expiring lockouts.
|
||||||
|
if len(_login_attempts) >= _MAX_TRACKED_IPS:
|
||||||
|
by_time = sorted(_login_attempts.items(), key=lambda kv: kv[1][1])
|
||||||
|
for k, _ in by_time[: len(by_time) // 2]:
|
||||||
|
del _login_attempts[k]
|
||||||
|
|
||||||
|
record = _login_attempts.get(ip)
|
||||||
|
if record is None:
|
||||||
|
_login_attempts[ip] = (1, 0.0)
|
||||||
|
else:
|
||||||
|
new_count = record[0] + 1
|
||||||
|
lock_until = time.time() + _LOCKOUT_SECONDS if new_count >= _MAX_LOGIN_ATTEMPTS else 0.0
|
||||||
|
_login_attempts[ip] = (new_count, lock_until)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_login_success(ip: str) -> None:
|
||||||
|
"""Clear failure counter for the given IP on successful login."""
|
||||||
|
_login_attempts.pop(ip, None)
|
||||||
|
|
||||||
|
|
||||||
|
# ── Endpoints ─────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/login/local", response_model=LoginResponse)
|
||||||
|
async def login_local(
|
||||||
|
request: Request,
|
||||||
|
response: Response,
|
||||||
|
form_data: OAuth2PasswordRequestForm = Depends(),
|
||||||
|
):
|
||||||
|
"""Local email/password login."""
|
||||||
|
client_ip = _get_client_ip(request)
|
||||||
|
_check_rate_limit(client_ip)
|
||||||
|
|
||||||
|
user = await get_local_provider().authenticate({"email": form_data.username, "password": form_data.password})
|
||||||
|
|
||||||
|
if user is None:
|
||||||
|
_record_login_failure(client_ip)
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_401_UNAUTHORIZED,
|
||||||
|
detail=AuthErrorResponse(code=AuthErrorCode.INVALID_CREDENTIALS, message="Incorrect email or password").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
_record_login_success(client_ip)
|
||||||
|
token = create_access_token(str(user.id), token_version=user.token_version)
|
||||||
|
_set_session_cookie(response, token, request)
|
||||||
|
|
||||||
|
return LoginResponse(
|
||||||
|
expires_in=get_auth_config().token_expiry_days * 24 * 3600,
|
||||||
|
needs_setup=user.needs_setup,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/register", response_model=UserResponse, status_code=status.HTTP_201_CREATED)
|
||||||
|
async def register(request: Request, response: Response, body: RegisterRequest):
|
||||||
|
"""Register a new user account (always 'user' role).
|
||||||
|
|
||||||
|
Admin is auto-created on first boot. This endpoint creates regular users.
|
||||||
|
Auto-login by setting the session cookie.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
user = await get_local_provider().create_user(email=body.email, password=body.password, system_role="user")
|
||||||
|
except ValueError:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_400_BAD_REQUEST,
|
||||||
|
detail=AuthErrorResponse(code=AuthErrorCode.EMAIL_ALREADY_EXISTS, message="Email already registered").model_dump(),
|
||||||
|
)
|
||||||
|
|
||||||
|
token = create_access_token(str(user.id), token_version=user.token_version)
|
||||||
|
_set_session_cookie(response, token, request)
|
||||||
|
|
||||||
|
return UserResponse(id=str(user.id), email=user.email, system_role=user.system_role)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/logout", response_model=MessageResponse)
|
||||||
|
async def logout(request: Request, response: Response):
|
||||||
|
"""Logout current user by clearing the cookie."""
|
||||||
|
response.delete_cookie(key="access_token", secure=is_secure_request(request), samesite="lax")
|
||||||
|
return MessageResponse(message="Successfully logged out")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/change-password", response_model=MessageResponse)
|
||||||
|
async def change_password(request: Request, response: Response, body: ChangePasswordRequest):
|
||||||
|
"""Change password for the currently authenticated user.
|
||||||
|
|
||||||
|
Also handles the first-boot setup flow:
|
||||||
|
- If new_email is provided, updates email (checks uniqueness)
|
||||||
|
- If user.needs_setup is True and new_email is given, clears needs_setup
|
||||||
|
- Always increments token_version to invalidate old sessions
|
||||||
|
- Re-issues session cookie with new token_version
|
||||||
|
"""
|
||||||
|
from app.gateway.auth.password import hash_password_async, verify_password_async
|
||||||
|
|
||||||
|
user = await get_current_user_from_request(request)
|
||||||
|
|
||||||
|
if user.password_hash is None:
|
||||||
|
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=AuthErrorResponse(code=AuthErrorCode.INVALID_CREDENTIALS, message="OAuth users cannot change password").model_dump())
|
||||||
|
|
||||||
|
if not await verify_password_async(body.current_password, user.password_hash):
|
||||||
|
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=AuthErrorResponse(code=AuthErrorCode.INVALID_CREDENTIALS, message="Current password is incorrect").model_dump())
|
||||||
|
|
||||||
|
provider = get_local_provider()
|
||||||
|
|
||||||
|
# Update email if provided
|
||||||
|
if body.new_email is not None:
|
||||||
|
existing = await provider.get_user_by_email(body.new_email)
|
||||||
|
if existing and str(existing.id) != str(user.id):
|
||||||
|
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=AuthErrorResponse(code=AuthErrorCode.EMAIL_ALREADY_EXISTS, message="Email already in use").model_dump())
|
||||||
|
user.email = body.new_email
|
||||||
|
|
||||||
|
# Update password + bump version
|
||||||
|
user.password_hash = await hash_password_async(body.new_password)
|
||||||
|
user.token_version += 1
|
||||||
|
|
||||||
|
# Clear setup flag if this is the setup flow
|
||||||
|
if user.needs_setup and body.new_email is not None:
|
||||||
|
user.needs_setup = False
|
||||||
|
|
||||||
|
await provider.update_user(user)
|
||||||
|
|
||||||
|
# Re-issue cookie with new token_version
|
||||||
|
token = create_access_token(str(user.id), token_version=user.token_version)
|
||||||
|
_set_session_cookie(response, token, request)
|
||||||
|
|
||||||
|
return MessageResponse(message="Password changed successfully")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/me", response_model=UserResponse)
|
||||||
|
async def get_me(request: Request):
|
||||||
|
"""Get current authenticated user info."""
|
||||||
|
user = await get_current_user_from_request(request)
|
||||||
|
return UserResponse(id=str(user.id), email=user.email, system_role=user.system_role, needs_setup=user.needs_setup)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/setup-status")
|
||||||
|
async def setup_status():
|
||||||
|
"""Check if admin account exists. Always False after first boot."""
|
||||||
|
user_count = await get_local_provider().count_users()
|
||||||
|
return {"needs_setup": user_count == 0}
|
||||||
|
|
||||||
|
|
||||||
|
# ── OAuth Endpoints (Future/Placeholder) ─────────────────────────────────
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/oauth/{provider}")
|
||||||
|
async def oauth_login(provider: str):
|
||||||
|
"""Initiate OAuth login flow.
|
||||||
|
|
||||||
|
Redirects to the OAuth provider's authorization URL.
|
||||||
|
Currently a placeholder - requires OAuth provider implementation.
|
||||||
|
"""
|
||||||
|
if provider not in ["github", "google"]:
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_400_BAD_REQUEST,
|
||||||
|
detail=f"Unsupported OAuth provider: {provider}",
|
||||||
|
)
|
||||||
|
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_501_NOT_IMPLEMENTED,
|
||||||
|
detail="OAuth login not yet implemented",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/callback/{provider}")
|
||||||
|
async def oauth_callback(provider: str, code: str, state: str):
|
||||||
|
"""OAuth callback endpoint.
|
||||||
|
|
||||||
|
Handles the OAuth provider's callback after user authorization.
|
||||||
|
Currently a placeholder.
|
||||||
|
"""
|
||||||
|
raise HTTPException(
|
||||||
|
status_code=status.HTTP_501_NOT_IMPLEMENTED,
|
||||||
|
detail="OAuth callback not yet implemented",
|
||||||
|
)
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
"""Feedback endpoints — create, list, stats, delete.
|
||||||
|
|
||||||
|
Allows users to submit thumbs-up/down feedback on runs,
|
||||||
|
optionally scoped to a specific message.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from app.gateway.authz import require_permission
|
||||||
|
from app.gateway.deps import get_current_user, get_feedback_repo, get_run_store
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
router = APIRouter(prefix="/api/threads", tags=["feedback"])
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Request / response models
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
class FeedbackCreateRequest(BaseModel):
|
||||||
|
rating: int = Field(..., description="Feedback rating: +1 (positive) or -1 (negative)")
|
||||||
|
comment: str | None = Field(default=None, description="Optional text feedback")
|
||||||
|
message_id: str | None = Field(default=None, description="Optional: scope feedback to a specific message")
|
||||||
|
|
||||||
|
|
||||||
|
class FeedbackResponse(BaseModel):
|
||||||
|
feedback_id: str
|
||||||
|
run_id: str
|
||||||
|
thread_id: str
|
||||||
|
owner_id: str | None = None
|
||||||
|
message_id: str | None = None
|
||||||
|
rating: int
|
||||||
|
comment: str | None = None
|
||||||
|
created_at: str = ""
|
||||||
|
|
||||||
|
|
||||||
|
class FeedbackStatsResponse(BaseModel):
|
||||||
|
run_id: str
|
||||||
|
total: int = 0
|
||||||
|
positive: int = 0
|
||||||
|
negative: int = 0
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Endpoints
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/{thread_id}/runs/{run_id}/feedback", response_model=FeedbackResponse)
|
||||||
|
@require_permission("threads", "write", owner_check=True, require_existing=True)
|
||||||
|
async def create_feedback(
|
||||||
|
thread_id: str,
|
||||||
|
run_id: str,
|
||||||
|
body: FeedbackCreateRequest,
|
||||||
|
request: Request,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Submit feedback (thumbs-up/down) for a run."""
|
||||||
|
if body.rating not in (1, -1):
|
||||||
|
raise HTTPException(status_code=400, detail="rating must be +1 or -1")
|
||||||
|
|
||||||
|
user_id = await get_current_user(request)
|
||||||
|
|
||||||
|
# Validate run exists and belongs to thread
|
||||||
|
run_store = get_run_store(request)
|
||||||
|
run = await run_store.get(run_id)
|
||||||
|
if run is None:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Run {run_id} not found")
|
||||||
|
if run.get("thread_id") != thread_id:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Run {run_id} not found in thread {thread_id}")
|
||||||
|
|
||||||
|
feedback_repo = get_feedback_repo(request)
|
||||||
|
return await feedback_repo.create(
|
||||||
|
run_id=run_id,
|
||||||
|
thread_id=thread_id,
|
||||||
|
rating=body.rating,
|
||||||
|
owner_id=user_id,
|
||||||
|
message_id=body.message_id,
|
||||||
|
comment=body.comment,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/runs/{run_id}/feedback", response_model=list[FeedbackResponse])
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def list_feedback(
|
||||||
|
thread_id: str,
|
||||||
|
run_id: str,
|
||||||
|
request: Request,
|
||||||
|
) -> list[dict[str, Any]]:
|
||||||
|
"""List all feedback for a run."""
|
||||||
|
feedback_repo = get_feedback_repo(request)
|
||||||
|
return await feedback_repo.list_by_run(thread_id, run_id)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/runs/{run_id}/feedback/stats", response_model=FeedbackStatsResponse)
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def feedback_stats(
|
||||||
|
thread_id: str,
|
||||||
|
run_id: str,
|
||||||
|
request: Request,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Get aggregated feedback stats (positive/negative counts) for a run."""
|
||||||
|
feedback_repo = get_feedback_repo(request)
|
||||||
|
return await feedback_repo.aggregate_by_run(thread_id, run_id)
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/{thread_id}/runs/{run_id}/feedback/{feedback_id}")
|
||||||
|
@require_permission("threads", "delete", owner_check=True, require_existing=True)
|
||||||
|
async def delete_feedback(
|
||||||
|
thread_id: str,
|
||||||
|
run_id: str,
|
||||||
|
feedback_id: str,
|
||||||
|
request: Request,
|
||||||
|
) -> dict[str, bool]:
|
||||||
|
"""Delete a feedback record."""
|
||||||
|
feedback_repo = get_feedback_repo(request)
|
||||||
|
# Verify feedback belongs to the specified thread/run before deleting
|
||||||
|
existing = await feedback_repo.get(feedback_id)
|
||||||
|
if existing is None:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Feedback {feedback_id} not found")
|
||||||
|
if existing.get("thread_id") != thread_id or existing.get("run_id") != run_id:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Feedback {feedback_id} not found in run {run_id}")
|
||||||
|
deleted = await feedback_repo.delete(feedback_id)
|
||||||
|
if not deleted:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Feedback {feedback_id} not found")
|
||||||
|
return {"success": True}
|
||||||
@@ -49,6 +49,7 @@ class Fact(BaseModel):
|
|||||||
confidence: float = Field(default=0.5, description="Confidence score (0-1)")
|
confidence: float = Field(default=0.5, description="Confidence score (0-1)")
|
||||||
createdAt: str = Field(default="", description="Creation timestamp")
|
createdAt: str = Field(default="", description="Creation timestamp")
|
||||||
source: str = Field(default="unknown", description="Source thread ID")
|
source: str = Field(default="unknown", description="Source thread ID")
|
||||||
|
sourceError: str | None = Field(default=None, description="Optional description of the prior mistake or wrong approach")
|
||||||
|
|
||||||
|
|
||||||
class MemoryResponse(BaseModel):
|
class MemoryResponse(BaseModel):
|
||||||
@@ -108,6 +109,7 @@ class MemoryStatusResponse(BaseModel):
|
|||||||
@router.get(
|
@router.get(
|
||||||
"/memory",
|
"/memory",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Get Memory Data",
|
summary="Get Memory Data",
|
||||||
description="Retrieve the current global memory data including user context, history, and facts.",
|
description="Retrieve the current global memory data including user context, history, and facts.",
|
||||||
)
|
)
|
||||||
@@ -152,6 +154,7 @@ async def get_memory() -> MemoryResponse:
|
|||||||
@router.post(
|
@router.post(
|
||||||
"/memory/reload",
|
"/memory/reload",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Reload Memory Data",
|
summary="Reload Memory Data",
|
||||||
description="Reload memory data from the storage file, refreshing the in-memory cache.",
|
description="Reload memory data from the storage file, refreshing the in-memory cache.",
|
||||||
)
|
)
|
||||||
@@ -171,6 +174,7 @@ async def reload_memory() -> MemoryResponse:
|
|||||||
@router.delete(
|
@router.delete(
|
||||||
"/memory",
|
"/memory",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Clear All Memory Data",
|
summary="Clear All Memory Data",
|
||||||
description="Delete all saved memory data and reset the memory structure to an empty state.",
|
description="Delete all saved memory data and reset the memory structure to an empty state.",
|
||||||
)
|
)
|
||||||
@@ -187,6 +191,7 @@ async def clear_memory() -> MemoryResponse:
|
|||||||
@router.post(
|
@router.post(
|
||||||
"/memory/facts",
|
"/memory/facts",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Create Memory Fact",
|
summary="Create Memory Fact",
|
||||||
description="Create a single saved memory fact manually.",
|
description="Create a single saved memory fact manually.",
|
||||||
)
|
)
|
||||||
@@ -209,6 +214,7 @@ async def create_memory_fact_endpoint(request: FactCreateRequest) -> MemoryRespo
|
|||||||
@router.delete(
|
@router.delete(
|
||||||
"/memory/facts/{fact_id}",
|
"/memory/facts/{fact_id}",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Delete Memory Fact",
|
summary="Delete Memory Fact",
|
||||||
description="Delete a single saved memory fact by its fact id.",
|
description="Delete a single saved memory fact by its fact id.",
|
||||||
)
|
)
|
||||||
@@ -227,6 +233,7 @@ async def delete_memory_fact_endpoint(fact_id: str) -> MemoryResponse:
|
|||||||
@router.patch(
|
@router.patch(
|
||||||
"/memory/facts/{fact_id}",
|
"/memory/facts/{fact_id}",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Patch Memory Fact",
|
summary="Patch Memory Fact",
|
||||||
description="Partially update a single saved memory fact by its fact id while preserving omitted fields.",
|
description="Partially update a single saved memory fact by its fact id while preserving omitted fields.",
|
||||||
)
|
)
|
||||||
@@ -252,6 +259,7 @@ async def update_memory_fact_endpoint(fact_id: str, request: FactPatchRequest) -
|
|||||||
@router.get(
|
@router.get(
|
||||||
"/memory/export",
|
"/memory/export",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Export Memory Data",
|
summary="Export Memory Data",
|
||||||
description="Export the current global memory data as JSON for backup or transfer.",
|
description="Export the current global memory data as JSON for backup or transfer.",
|
||||||
)
|
)
|
||||||
@@ -264,6 +272,7 @@ async def export_memory() -> MemoryResponse:
|
|||||||
@router.post(
|
@router.post(
|
||||||
"/memory/import",
|
"/memory/import",
|
||||||
response_model=MemoryResponse,
|
response_model=MemoryResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Import Memory Data",
|
summary="Import Memory Data",
|
||||||
description="Import and overwrite the current global memory data from a JSON payload.",
|
description="Import and overwrite the current global memory data from a JSON payload.",
|
||||||
)
|
)
|
||||||
@@ -317,6 +326,7 @@ async def get_memory_config_endpoint() -> MemoryConfigResponse:
|
|||||||
@router.get(
|
@router.get(
|
||||||
"/memory/status",
|
"/memory/status",
|
||||||
response_model=MemoryStatusResponse,
|
response_model=MemoryStatusResponse,
|
||||||
|
response_model_exclude_none=True,
|
||||||
summary="Get Memory Status",
|
summary="Get Memory Status",
|
||||||
description="Retrieve both memory configuration and current data in a single request.",
|
description="Retrieve both memory configuration and current data in a single request.",
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ async def stateless_stream(body: RunCreateRequest, request: Request) -> Streamin
|
|||||||
"Cache-Control": "no-cache",
|
"Cache-Control": "no-cache",
|
||||||
"Connection": "keep-alive",
|
"Connection": "keep-alive",
|
||||||
"X-Accel-Buffering": "no",
|
"X-Accel-Buffering": "no",
|
||||||
|
"Content-Location": f"/api/threads/{thread_id}/runs/{record.run_id}",
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,29 @@
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
import shutil
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from fastapi import APIRouter, HTTPException
|
from fastapi import APIRouter, HTTPException
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
from app.gateway.path_utils import resolve_thread_virtual_path
|
from app.gateway.path_utils import resolve_thread_virtual_path
|
||||||
|
from deerflow.agents.lead_agent.prompt import refresh_skills_system_prompt_cache_async
|
||||||
from deerflow.config.extensions_config import ExtensionsConfig, SkillStateConfig, get_extensions_config, reload_extensions_config
|
from deerflow.config.extensions_config import ExtensionsConfig, SkillStateConfig, get_extensions_config, reload_extensions_config
|
||||||
from deerflow.skills import Skill, load_skills
|
from deerflow.skills import Skill, load_skills
|
||||||
from deerflow.skills.installer import SkillAlreadyExistsError, install_skill_from_archive
|
from deerflow.skills.installer import SkillAlreadyExistsError, install_skill_from_archive
|
||||||
|
from deerflow.skills.manager import (
|
||||||
|
append_history,
|
||||||
|
atomic_write,
|
||||||
|
custom_skill_exists,
|
||||||
|
ensure_custom_skill_is_editable,
|
||||||
|
get_custom_skill_dir,
|
||||||
|
get_custom_skill_file,
|
||||||
|
get_skill_history_file,
|
||||||
|
read_custom_skill_content,
|
||||||
|
read_history,
|
||||||
|
validate_skill_markdown_content,
|
||||||
|
)
|
||||||
|
from deerflow.skills.security_scanner import scan_skill_content
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -52,6 +67,22 @@ class SkillInstallResponse(BaseModel):
|
|||||||
message: str = Field(..., description="Installation result message")
|
message: str = Field(..., description="Installation result message")
|
||||||
|
|
||||||
|
|
||||||
|
class CustomSkillContentResponse(SkillResponse):
|
||||||
|
content: str = Field(..., description="Raw SKILL.md content")
|
||||||
|
|
||||||
|
|
||||||
|
class CustomSkillUpdateRequest(BaseModel):
|
||||||
|
content: str = Field(..., description="Replacement SKILL.md content")
|
||||||
|
|
||||||
|
|
||||||
|
class CustomSkillHistoryResponse(BaseModel):
|
||||||
|
history: list[dict]
|
||||||
|
|
||||||
|
|
||||||
|
class SkillRollbackRequest(BaseModel):
|
||||||
|
history_index: int = Field(default=-1, description="History entry index to restore from, defaulting to the latest change.")
|
||||||
|
|
||||||
|
|
||||||
def _skill_to_response(skill: Skill) -> SkillResponse:
|
def _skill_to_response(skill: Skill) -> SkillResponse:
|
||||||
"""Convert a Skill object to a SkillResponse."""
|
"""Convert a Skill object to a SkillResponse."""
|
||||||
return SkillResponse(
|
return SkillResponse(
|
||||||
@@ -78,6 +109,181 @@ async def list_skills() -> SkillsListResponse:
|
|||||||
raise HTTPException(status_code=500, detail=f"Failed to load skills: {str(e)}")
|
raise HTTPException(status_code=500, detail=f"Failed to load skills: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/skills/install",
|
||||||
|
response_model=SkillInstallResponse,
|
||||||
|
summary="Install Skill",
|
||||||
|
description="Install a skill from a .skill file (ZIP archive) located in the thread's user-data directory.",
|
||||||
|
)
|
||||||
|
async def install_skill(request: SkillInstallRequest) -> SkillInstallResponse:
|
||||||
|
try:
|
||||||
|
skill_file_path = resolve_thread_virtual_path(request.thread_id, request.path)
|
||||||
|
result = install_skill_from_archive(skill_file_path)
|
||||||
|
await refresh_skills_system_prompt_cache_async()
|
||||||
|
return SkillInstallResponse(**result)
|
||||||
|
except FileNotFoundError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except SkillAlreadyExistsError as e:
|
||||||
|
raise HTTPException(status_code=409, detail=str(e))
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Failed to install skill: {e}", exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to install skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/skills/custom", response_model=SkillsListResponse, summary="List Custom Skills")
|
||||||
|
async def list_custom_skills() -> SkillsListResponse:
|
||||||
|
try:
|
||||||
|
skills = [skill for skill in load_skills(enabled_only=False) if skill.category == "custom"]
|
||||||
|
return SkillsListResponse(skills=[_skill_to_response(skill) for skill in skills])
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to list custom skills: %s", e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to list custom skills: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/skills/custom/{skill_name}", response_model=CustomSkillContentResponse, summary="Get Custom Skill Content")
|
||||||
|
async def get_custom_skill(skill_name: str) -> CustomSkillContentResponse:
|
||||||
|
try:
|
||||||
|
skills = load_skills(enabled_only=False)
|
||||||
|
skill = next((s for s in skills if s.name == skill_name and s.category == "custom"), None)
|
||||||
|
if skill is None:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
||||||
|
return CustomSkillContentResponse(**_skill_to_response(skill).model_dump(), content=read_custom_skill_content(skill_name))
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to get custom skill %s: %s", skill_name, e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to get custom skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.put("/skills/custom/{skill_name}", response_model=CustomSkillContentResponse, summary="Edit Custom Skill")
|
||||||
|
async def update_custom_skill(skill_name: str, request: CustomSkillUpdateRequest) -> CustomSkillContentResponse:
|
||||||
|
try:
|
||||||
|
ensure_custom_skill_is_editable(skill_name)
|
||||||
|
validate_skill_markdown_content(skill_name, request.content)
|
||||||
|
scan = await scan_skill_content(request.content, executable=False, location=f"{skill_name}/SKILL.md")
|
||||||
|
if scan.decision == "block":
|
||||||
|
raise HTTPException(status_code=400, detail=f"Security scan blocked the edit: {scan.reason}")
|
||||||
|
skill_file = get_custom_skill_dir(skill_name) / "SKILL.md"
|
||||||
|
prev_content = skill_file.read_text(encoding="utf-8")
|
||||||
|
atomic_write(skill_file, request.content)
|
||||||
|
append_history(
|
||||||
|
skill_name,
|
||||||
|
{
|
||||||
|
"action": "human_edit",
|
||||||
|
"author": "human",
|
||||||
|
"thread_id": None,
|
||||||
|
"file_path": "SKILL.md",
|
||||||
|
"prev_content": prev_content,
|
||||||
|
"new_content": request.content,
|
||||||
|
"scanner": {"decision": scan.decision, "reason": scan.reason},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
await refresh_skills_system_prompt_cache_async()
|
||||||
|
return await get_custom_skill(skill_name)
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except FileNotFoundError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to update custom skill %s: %s", skill_name, e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to update custom skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/skills/custom/{skill_name}", summary="Delete Custom Skill")
|
||||||
|
async def delete_custom_skill(skill_name: str) -> dict[str, bool]:
|
||||||
|
try:
|
||||||
|
ensure_custom_skill_is_editable(skill_name)
|
||||||
|
skill_dir = get_custom_skill_dir(skill_name)
|
||||||
|
prev_content = read_custom_skill_content(skill_name)
|
||||||
|
append_history(
|
||||||
|
skill_name,
|
||||||
|
{
|
||||||
|
"action": "human_delete",
|
||||||
|
"author": "human",
|
||||||
|
"thread_id": None,
|
||||||
|
"file_path": "SKILL.md",
|
||||||
|
"prev_content": prev_content,
|
||||||
|
"new_content": None,
|
||||||
|
"scanner": {"decision": "allow", "reason": "Deletion requested."},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
shutil.rmtree(skill_dir)
|
||||||
|
await refresh_skills_system_prompt_cache_async()
|
||||||
|
return {"success": True}
|
||||||
|
except FileNotFoundError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to delete custom skill %s: %s", skill_name, e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to delete custom skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/skills/custom/{skill_name}/history", response_model=CustomSkillHistoryResponse, summary="Get Custom Skill History")
|
||||||
|
async def get_custom_skill_history(skill_name: str) -> CustomSkillHistoryResponse:
|
||||||
|
try:
|
||||||
|
if not custom_skill_exists(skill_name) and not get_skill_history_file(skill_name).exists():
|
||||||
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
||||||
|
return CustomSkillHistoryResponse(history=read_history(skill_name))
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to read history for %s: %s", skill_name, e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to read history: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/skills/custom/{skill_name}/rollback", response_model=CustomSkillContentResponse, summary="Rollback Custom Skill")
|
||||||
|
async def rollback_custom_skill(skill_name: str, request: SkillRollbackRequest) -> CustomSkillContentResponse:
|
||||||
|
try:
|
||||||
|
if not custom_skill_exists(skill_name) and not get_skill_history_file(skill_name).exists():
|
||||||
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
||||||
|
history = read_history(skill_name)
|
||||||
|
if not history:
|
||||||
|
raise HTTPException(status_code=400, detail=f"Custom skill '{skill_name}' has no history")
|
||||||
|
record = history[request.history_index]
|
||||||
|
target_content = record.get("prev_content")
|
||||||
|
if target_content is None:
|
||||||
|
raise HTTPException(status_code=400, detail="Selected history entry has no previous content to roll back to")
|
||||||
|
validate_skill_markdown_content(skill_name, target_content)
|
||||||
|
scan = await scan_skill_content(target_content, executable=False, location=f"{skill_name}/SKILL.md")
|
||||||
|
skill_file = get_custom_skill_file(skill_name)
|
||||||
|
current_content = skill_file.read_text(encoding="utf-8") if skill_file.exists() else None
|
||||||
|
history_entry = {
|
||||||
|
"action": "rollback",
|
||||||
|
"author": "human",
|
||||||
|
"thread_id": None,
|
||||||
|
"file_path": "SKILL.md",
|
||||||
|
"prev_content": current_content,
|
||||||
|
"new_content": target_content,
|
||||||
|
"rollback_from_ts": record.get("ts"),
|
||||||
|
"scanner": {"decision": scan.decision, "reason": scan.reason},
|
||||||
|
}
|
||||||
|
if scan.decision == "block":
|
||||||
|
append_history(skill_name, history_entry)
|
||||||
|
raise HTTPException(status_code=400, detail=f"Rollback blocked by security scanner: {scan.reason}")
|
||||||
|
atomic_write(skill_file, target_content)
|
||||||
|
append_history(skill_name, history_entry)
|
||||||
|
await refresh_skills_system_prompt_cache_async()
|
||||||
|
return await get_custom_skill(skill_name)
|
||||||
|
except HTTPException:
|
||||||
|
raise
|
||||||
|
except IndexError:
|
||||||
|
raise HTTPException(status_code=400, detail="history_index is out of range")
|
||||||
|
except FileNotFoundError as e:
|
||||||
|
raise HTTPException(status_code=404, detail=str(e))
|
||||||
|
except ValueError as e:
|
||||||
|
raise HTTPException(status_code=400, detail=str(e))
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to roll back custom skill %s: %s", skill_name, e, exc_info=True)
|
||||||
|
raise HTTPException(status_code=500, detail=f"Failed to roll back custom skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
@router.get(
|
@router.get(
|
||||||
"/skills/{skill_name}",
|
"/skills/{skill_name}",
|
||||||
response_model=SkillResponse,
|
response_model=SkillResponse,
|
||||||
@@ -132,6 +338,7 @@ async def update_skill(skill_name: str, request: SkillUpdateRequest) -> SkillRes
|
|||||||
|
|
||||||
logger.info(f"Skills configuration updated and saved to: {config_path}")
|
logger.info(f"Skills configuration updated and saved to: {config_path}")
|
||||||
reload_extensions_config()
|
reload_extensions_config()
|
||||||
|
await refresh_skills_system_prompt_cache_async()
|
||||||
|
|
||||||
skills = load_skills(enabled_only=False)
|
skills = load_skills(enabled_only=False)
|
||||||
updated_skill = next((s for s in skills if s.name == skill_name), None)
|
updated_skill = next((s for s in skills if s.name == skill_name), None)
|
||||||
@@ -147,27 +354,3 @@ async def update_skill(skill_name: str, request: SkillUpdateRequest) -> SkillRes
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error(f"Failed to update skill {skill_name}: {e}", exc_info=True)
|
logger.error(f"Failed to update skill {skill_name}: {e}", exc_info=True)
|
||||||
raise HTTPException(status_code=500, detail=f"Failed to update skill: {str(e)}")
|
raise HTTPException(status_code=500, detail=f"Failed to update skill: {str(e)}")
|
||||||
|
|
||||||
|
|
||||||
@router.post(
|
|
||||||
"/skills/install",
|
|
||||||
response_model=SkillInstallResponse,
|
|
||||||
summary="Install Skill",
|
|
||||||
description="Install a skill from a .skill file (ZIP archive) located in the thread's user-data directory.",
|
|
||||||
)
|
|
||||||
async def install_skill(request: SkillInstallRequest) -> SkillInstallResponse:
|
|
||||||
try:
|
|
||||||
skill_file_path = resolve_thread_virtual_path(request.thread_id, request.path)
|
|
||||||
result = install_skill_from_archive(skill_file_path)
|
|
||||||
return SkillInstallResponse(**result)
|
|
||||||
except FileNotFoundError as e:
|
|
||||||
raise HTTPException(status_code=404, detail=str(e))
|
|
||||||
except SkillAlreadyExistsError as e:
|
|
||||||
raise HTTPException(status_code=409, detail=str(e))
|
|
||||||
except ValueError as e:
|
|
||||||
raise HTTPException(status_code=400, detail=str(e))
|
|
||||||
except HTTPException:
|
|
||||||
raise
|
|
||||||
except Exception as e:
|
|
||||||
logger.error(f"Failed to install skill: {e}", exc_info=True)
|
|
||||||
raise HTTPException(status_code=500, detail=f"Failed to install skill: {str(e)}")
|
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from fastapi import APIRouter
|
from fastapi import APIRouter, Request
|
||||||
|
from langchain_core.messages import HumanMessage, SystemMessage
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
from app.gateway.authz import require_permission
|
||||||
from deerflow.models import create_chat_model
|
from deerflow.models import create_chat_model
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@@ -97,31 +99,31 @@ def _format_conversation(messages: list[SuggestionMessage]) -> str:
|
|||||||
summary="Generate Follow-up Questions",
|
summary="Generate Follow-up Questions",
|
||||||
description="Generate short follow-up questions a user might ask next, based on recent conversation context.",
|
description="Generate short follow-up questions a user might ask next, based on recent conversation context.",
|
||||||
)
|
)
|
||||||
async def generate_suggestions(thread_id: str, request: SuggestionsRequest) -> SuggestionsResponse:
|
@require_permission("threads", "read", owner_check=True)
|
||||||
if not request.messages:
|
async def generate_suggestions(thread_id: str, body: SuggestionsRequest, request: Request) -> SuggestionsResponse:
|
||||||
|
if not body.messages:
|
||||||
return SuggestionsResponse(suggestions=[])
|
return SuggestionsResponse(suggestions=[])
|
||||||
|
|
||||||
n = request.n
|
n = body.n
|
||||||
conversation = _format_conversation(request.messages)
|
conversation = _format_conversation(body.messages)
|
||||||
if not conversation:
|
if not conversation:
|
||||||
return SuggestionsResponse(suggestions=[])
|
return SuggestionsResponse(suggestions=[])
|
||||||
|
|
||||||
prompt = (
|
system_instruction = (
|
||||||
"You are generating follow-up questions to help the user continue the conversation.\n"
|
"You are generating follow-up questions to help the user continue the conversation.\n"
|
||||||
f"Based on the conversation below, produce EXACTLY {n} short questions the user might ask next.\n"
|
f"Based on the conversation below, produce EXACTLY {n} short questions the user might ask next.\n"
|
||||||
"Requirements:\n"
|
"Requirements:\n"
|
||||||
"- Questions must be relevant to the conversation.\n"
|
"- Questions must be relevant to the preceding conversation.\n"
|
||||||
"- Questions must be written in the same language as the user.\n"
|
"- Questions must be written in the same language as the user.\n"
|
||||||
"- Keep each question concise (ideally <= 20 words / <= 40 Chinese characters).\n"
|
"- Keep each question concise (ideally <= 20 words / <= 40 Chinese characters).\n"
|
||||||
"- Do NOT include numbering, markdown, or any extra text.\n"
|
"- Do NOT include numbering, markdown, or any extra text.\n"
|
||||||
"- Output MUST be a JSON array of strings only.\n\n"
|
"- Output MUST be a JSON array of strings only.\n"
|
||||||
"Conversation:\n"
|
|
||||||
f"{conversation}\n"
|
|
||||||
)
|
)
|
||||||
|
user_content = f"Conversation Context:\n{conversation}\n\nGenerate {n} follow-up questions"
|
||||||
|
|
||||||
try:
|
try:
|
||||||
model = create_chat_model(name=request.model_name, thinking_enabled=False)
|
model = create_chat_model(name=body.model_name, thinking_enabled=False)
|
||||||
response = model.invoke(prompt)
|
response = await model.ainvoke([SystemMessage(content=system_instruction), HumanMessage(content=user_content)])
|
||||||
raw = _extract_response_text(response.content)
|
raw = _extract_response_text(response.content)
|
||||||
suggestions = _parse_json_string_list(raw) or []
|
suggestions = _parse_json_string_list(raw) or []
|
||||||
cleaned = [s.replace("\n", " ").strip() for s in suggestions if s.strip()]
|
cleaned = [s.replace("\n", " ").strip() for s in suggestions if s.strip()]
|
||||||
|
|||||||
@@ -19,7 +19,8 @@ from fastapi import APIRouter, HTTPException, Query, Request
|
|||||||
from fastapi.responses import Response, StreamingResponse
|
from fastapi.responses import Response, StreamingResponse
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
from app.gateway.deps import get_checkpointer, get_run_manager, get_stream_bridge
|
from app.gateway.authz import require_permission
|
||||||
|
from app.gateway.deps import get_checkpointer, get_run_event_store, get_run_manager, get_run_store, get_stream_bridge
|
||||||
from app.gateway.services import sse_consumer, start_run
|
from app.gateway.services import sse_consumer, start_run
|
||||||
from deerflow.runtime import RunRecord, serialize_channel_values
|
from deerflow.runtime import RunRecord, serialize_channel_values
|
||||||
|
|
||||||
@@ -38,6 +39,7 @@ class RunCreateRequest(BaseModel):
|
|||||||
command: dict[str, Any] | None = Field(default=None, description="LangGraph Command")
|
command: dict[str, Any] | None = Field(default=None, description="LangGraph Command")
|
||||||
metadata: dict[str, Any] | None = Field(default=None, description="Run metadata")
|
metadata: dict[str, Any] | None = Field(default=None, description="Run metadata")
|
||||||
config: dict[str, Any] | None = Field(default=None, description="RunnableConfig overrides")
|
config: dict[str, Any] | None = Field(default=None, description="RunnableConfig overrides")
|
||||||
|
context: dict[str, Any] | None = Field(default=None, description="DeerFlow context overrides (model_name, thinking_enabled, etc.)")
|
||||||
webhook: str | None = Field(default=None, description="Completion callback URL")
|
webhook: str | None = Field(default=None, description="Completion callback URL")
|
||||||
checkpoint_id: str | None = Field(default=None, description="Resume from checkpoint")
|
checkpoint_id: str | None = Field(default=None, description="Resume from checkpoint")
|
||||||
checkpoint: dict[str, Any] | None = Field(default=None, description="Full checkpoint object")
|
checkpoint: dict[str, Any] | None = Field(default=None, description="Full checkpoint object")
|
||||||
@@ -52,6 +54,7 @@ class RunCreateRequest(BaseModel):
|
|||||||
after_seconds: float | None = Field(default=None, description="Delayed execution")
|
after_seconds: float | None = Field(default=None, description="Delayed execution")
|
||||||
if_not_exists: Literal["reject", "create"] = Field(default="create", description="Thread creation policy")
|
if_not_exists: Literal["reject", "create"] = Field(default="create", description="Thread creation policy")
|
||||||
feedback_keys: list[str] | None = Field(default=None, description="LangSmith feedback keys")
|
feedback_keys: list[str] | None = Field(default=None, description="LangSmith feedback keys")
|
||||||
|
follow_up_to_run_id: str | None = Field(default=None, description="Run ID this message follows up on. Auto-detected from latest successful run if not provided.")
|
||||||
|
|
||||||
|
|
||||||
class RunResponse(BaseModel):
|
class RunResponse(BaseModel):
|
||||||
@@ -91,6 +94,7 @@ def _record_to_response(record: RunRecord) -> RunResponse:
|
|||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/runs", response_model=RunResponse)
|
@router.post("/{thread_id}/runs", response_model=RunResponse)
|
||||||
|
@require_permission("runs", "create", owner_check=True, require_existing=True)
|
||||||
async def create_run(thread_id: str, body: RunCreateRequest, request: Request) -> RunResponse:
|
async def create_run(thread_id: str, body: RunCreateRequest, request: Request) -> RunResponse:
|
||||||
"""Create a background run (returns immediately)."""
|
"""Create a background run (returns immediately)."""
|
||||||
record = await start_run(body, thread_id, request)
|
record = await start_run(body, thread_id, request)
|
||||||
@@ -98,6 +102,7 @@ async def create_run(thread_id: str, body: RunCreateRequest, request: Request) -
|
|||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/runs/stream")
|
@router.post("/{thread_id}/runs/stream")
|
||||||
|
@require_permission("runs", "create", owner_check=True, require_existing=True)
|
||||||
async def stream_run(thread_id: str, body: RunCreateRequest, request: Request) -> StreamingResponse:
|
async def stream_run(thread_id: str, body: RunCreateRequest, request: Request) -> StreamingResponse:
|
||||||
"""Create a run and stream events via SSE.
|
"""Create a run and stream events via SSE.
|
||||||
|
|
||||||
@@ -117,13 +122,15 @@ async def stream_run(thread_id: str, body: RunCreateRequest, request: Request) -
|
|||||||
"Connection": "keep-alive",
|
"Connection": "keep-alive",
|
||||||
"X-Accel-Buffering": "no",
|
"X-Accel-Buffering": "no",
|
||||||
# LangGraph Platform includes run metadata in this header.
|
# LangGraph Platform includes run metadata in this header.
|
||||||
# The SDK's _get_run_metadata_from_response() parses it.
|
# The SDK uses a greedy regex to extract the run id from this path,
|
||||||
"Content-Location": (f"/api/threads/{thread_id}/runs/{record.run_id}/stream?thread_id={thread_id}&run_id={record.run_id}"),
|
# so it must point at the canonical run resource without extra suffixes.
|
||||||
|
"Content-Location": f"/api/threads/{thread_id}/runs/{record.run_id}",
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/runs/wait", response_model=dict)
|
@router.post("/{thread_id}/runs/wait", response_model=dict)
|
||||||
|
@require_permission("runs", "create", owner_check=True, require_existing=True)
|
||||||
async def wait_run(thread_id: str, body: RunCreateRequest, request: Request) -> dict:
|
async def wait_run(thread_id: str, body: RunCreateRequest, request: Request) -> dict:
|
||||||
"""Create a run and block until it completes, returning the final state."""
|
"""Create a run and block until it completes, returning the final state."""
|
||||||
record = await start_run(body, thread_id, request)
|
record = await start_run(body, thread_id, request)
|
||||||
@@ -149,6 +156,7 @@ async def wait_run(thread_id: str, body: RunCreateRequest, request: Request) ->
|
|||||||
|
|
||||||
|
|
||||||
@router.get("/{thread_id}/runs", response_model=list[RunResponse])
|
@router.get("/{thread_id}/runs", response_model=list[RunResponse])
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
async def list_runs(thread_id: str, request: Request) -> list[RunResponse]:
|
async def list_runs(thread_id: str, request: Request) -> list[RunResponse]:
|
||||||
"""List all runs for a thread."""
|
"""List all runs for a thread."""
|
||||||
run_mgr = get_run_manager(request)
|
run_mgr = get_run_manager(request)
|
||||||
@@ -157,6 +165,7 @@ async def list_runs(thread_id: str, request: Request) -> list[RunResponse]:
|
|||||||
|
|
||||||
|
|
||||||
@router.get("/{thread_id}/runs/{run_id}", response_model=RunResponse)
|
@router.get("/{thread_id}/runs/{run_id}", response_model=RunResponse)
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
async def get_run(thread_id: str, run_id: str, request: Request) -> RunResponse:
|
async def get_run(thread_id: str, run_id: str, request: Request) -> RunResponse:
|
||||||
"""Get details of a specific run."""
|
"""Get details of a specific run."""
|
||||||
run_mgr = get_run_manager(request)
|
run_mgr = get_run_manager(request)
|
||||||
@@ -167,6 +176,7 @@ async def get_run(thread_id: str, run_id: str, request: Request) -> RunResponse:
|
|||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/runs/{run_id}/cancel")
|
@router.post("/{thread_id}/runs/{run_id}/cancel")
|
||||||
|
@require_permission("runs", "cancel", owner_check=True, require_existing=True)
|
||||||
async def cancel_run(
|
async def cancel_run(
|
||||||
thread_id: str,
|
thread_id: str,
|
||||||
run_id: str,
|
run_id: str,
|
||||||
@@ -204,6 +214,7 @@ async def cancel_run(
|
|||||||
|
|
||||||
|
|
||||||
@router.get("/{thread_id}/runs/{run_id}/join")
|
@router.get("/{thread_id}/runs/{run_id}/join")
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
async def join_run(thread_id: str, run_id: str, request: Request) -> StreamingResponse:
|
async def join_run(thread_id: str, run_id: str, request: Request) -> StreamingResponse:
|
||||||
"""Join an existing run's SSE stream."""
|
"""Join an existing run's SSE stream."""
|
||||||
bridge = get_stream_bridge(request)
|
bridge = get_stream_bridge(request)
|
||||||
@@ -224,6 +235,7 @@ async def join_run(thread_id: str, run_id: str, request: Request) -> StreamingRe
|
|||||||
|
|
||||||
|
|
||||||
@router.api_route("/{thread_id}/runs/{run_id}/stream", methods=["GET", "POST"], response_model=None)
|
@router.api_route("/{thread_id}/runs/{run_id}/stream", methods=["GET", "POST"], response_model=None)
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
async def stream_existing_run(
|
async def stream_existing_run(
|
||||||
thread_id: str,
|
thread_id: str,
|
||||||
run_id: str,
|
run_id: str,
|
||||||
@@ -263,3 +275,54 @@ async def stream_existing_run(
|
|||||||
"X-Accel-Buffering": "no",
|
"X-Accel-Buffering": "no",
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Messages / Events / Token usage endpoints
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/messages")
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
|
async def list_thread_messages(
|
||||||
|
thread_id: str,
|
||||||
|
request: Request,
|
||||||
|
limit: int = Query(default=50, le=200),
|
||||||
|
before_seq: int | None = Query(default=None),
|
||||||
|
after_seq: int | None = Query(default=None),
|
||||||
|
) -> list[dict]:
|
||||||
|
"""Return displayable messages for a thread (across all runs)."""
|
||||||
|
event_store = get_run_event_store(request)
|
||||||
|
return await event_store.list_messages(thread_id, limit=limit, before_seq=before_seq, after_seq=after_seq)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/runs/{run_id}/messages")
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
|
async def list_run_messages(thread_id: str, run_id: str, request: Request) -> list[dict]:
|
||||||
|
"""Return displayable messages for a specific run."""
|
||||||
|
event_store = get_run_event_store(request)
|
||||||
|
return await event_store.list_messages_by_run(thread_id, run_id)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/runs/{run_id}/events")
|
||||||
|
@require_permission("runs", "read", owner_check=True)
|
||||||
|
async def list_run_events(
|
||||||
|
thread_id: str,
|
||||||
|
run_id: str,
|
||||||
|
request: Request,
|
||||||
|
event_types: str | None = Query(default=None),
|
||||||
|
limit: int = Query(default=500, le=2000),
|
||||||
|
) -> list[dict]:
|
||||||
|
"""Return the full event stream for a run (debug/audit)."""
|
||||||
|
event_store = get_run_event_store(request)
|
||||||
|
types = event_types.split(",") if event_types else None
|
||||||
|
return await event_store.list_events(thread_id, run_id, event_types=types, limit=limit)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/{thread_id}/token-usage")
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def thread_token_usage(thread_id: str, request: Request) -> dict:
|
||||||
|
"""Thread-level token usage aggregation."""
|
||||||
|
run_store = get_run_store(request)
|
||||||
|
agg = await run_store.aggregate_tokens_by_thread(thread_id)
|
||||||
|
return {"thread_id": thread_id, **agg}
|
||||||
|
|||||||
@@ -18,23 +18,34 @@ import uuid
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from fastapi import APIRouter, HTTPException, Request
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field, field_validator
|
||||||
|
|
||||||
from app.gateway.deps import get_checkpointer, get_store
|
from app.gateway.authz import require_permission
|
||||||
|
from app.gateway.deps import get_checkpointer
|
||||||
|
from app.gateway.utils import sanitize_log_param
|
||||||
from deerflow.config.paths import Paths, get_paths
|
from deerflow.config.paths import Paths, get_paths
|
||||||
from deerflow.runtime import serialize_channel_values
|
from deerflow.runtime import serialize_channel_values
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Store namespace
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
THREADS_NS: tuple[str, ...] = ("threads",)
|
|
||||||
"""Namespace used by the Store for thread metadata records."""
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
router = APIRouter(prefix="/api/threads", tags=["threads"])
|
router = APIRouter(prefix="/api/threads", tags=["threads"])
|
||||||
|
|
||||||
|
|
||||||
|
# Metadata keys that the server controls; clients are not allowed to set
|
||||||
|
# them. Pydantic ``@field_validator("metadata")`` strips them on every
|
||||||
|
# inbound model below so a malicious client cannot reflect a forged
|
||||||
|
# owner identity through the API surface. Defense-in-depth — the
|
||||||
|
# row-level invariant is still ``threads_meta.owner_id`` populated from
|
||||||
|
# the auth contextvar; this list closes the metadata-blob echo gap.
|
||||||
|
_SERVER_RESERVED_METADATA_KEYS: frozenset[str] = frozenset({"owner_id", "user_id"})
|
||||||
|
|
||||||
|
|
||||||
|
def _strip_reserved_metadata(metadata: dict[str, Any] | None) -> dict[str, Any]:
|
||||||
|
"""Return ``metadata`` with server-controlled keys removed."""
|
||||||
|
if not metadata:
|
||||||
|
return metadata or {}
|
||||||
|
return {k: v for k, v in metadata.items() if k not in _SERVER_RESERVED_METADATA_KEYS}
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Response / request models
|
# Response / request models
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -63,8 +74,11 @@ class ThreadCreateRequest(BaseModel):
|
|||||||
"""Request body for creating a thread."""
|
"""Request body for creating a thread."""
|
||||||
|
|
||||||
thread_id: str | None = Field(default=None, description="Optional thread ID (auto-generated if omitted)")
|
thread_id: str | None = Field(default=None, description="Optional thread ID (auto-generated if omitted)")
|
||||||
|
assistant_id: str | None = Field(default=None, description="Associate thread with an assistant")
|
||||||
metadata: dict[str, Any] = Field(default_factory=dict, description="Initial metadata")
|
metadata: dict[str, Any] = Field(default_factory=dict, description="Initial metadata")
|
||||||
|
|
||||||
|
_strip_reserved = field_validator("metadata")(classmethod(lambda cls, v: _strip_reserved_metadata(v)))
|
||||||
|
|
||||||
|
|
||||||
class ThreadSearchRequest(BaseModel):
|
class ThreadSearchRequest(BaseModel):
|
||||||
"""Request body for searching threads."""
|
"""Request body for searching threads."""
|
||||||
@@ -93,6 +107,8 @@ class ThreadPatchRequest(BaseModel):
|
|||||||
|
|
||||||
metadata: dict[str, Any] = Field(default_factory=dict, description="Metadata to merge")
|
metadata: dict[str, Any] = Field(default_factory=dict, description="Metadata to merge")
|
||||||
|
|
||||||
|
_strip_reserved = field_validator("metadata")(classmethod(lambda cls, v: _strip_reserved_metadata(v)))
|
||||||
|
|
||||||
|
|
||||||
class ThreadStateUpdateRequest(BaseModel):
|
class ThreadStateUpdateRequest(BaseModel):
|
||||||
"""Request body for updating thread state (human-in-the-loop resume)."""
|
"""Request body for updating thread state (human-in-the-loop resume)."""
|
||||||
@@ -135,61 +151,16 @@ def _delete_thread_data(thread_id: str, paths: Paths | None = None) -> ThreadDel
|
|||||||
raise HTTPException(status_code=422, detail=str(exc)) from exc
|
raise HTTPException(status_code=422, detail=str(exc)) from exc
|
||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
# Not critical — thread data may not exist on disk
|
# Not critical — thread data may not exist on disk
|
||||||
logger.debug("No local thread data to delete for %s", thread_id)
|
logger.debug("No local thread data to delete for %s", sanitize_log_param(thread_id))
|
||||||
return ThreadDeleteResponse(success=True, message=f"No local data for {thread_id}")
|
return ThreadDeleteResponse(success=True, message=f"No local data for {thread_id}")
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
logger.exception("Failed to delete thread data for %s", thread_id)
|
logger.exception("Failed to delete thread data for %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to delete local thread data.") from exc
|
raise HTTPException(status_code=500, detail="Failed to delete local thread data.") from exc
|
||||||
|
|
||||||
logger.info("Deleted local thread data for %s", thread_id)
|
logger.info("Deleted local thread data for %s", sanitize_log_param(thread_id))
|
||||||
return ThreadDeleteResponse(success=True, message=f"Deleted local thread data for {thread_id}")
|
return ThreadDeleteResponse(success=True, message=f"Deleted local thread data for {thread_id}")
|
||||||
|
|
||||||
|
|
||||||
async def _store_get(store, thread_id: str) -> dict | None:
|
|
||||||
"""Fetch a thread record from the Store; returns ``None`` if absent."""
|
|
||||||
item = await store.aget(THREADS_NS, thread_id)
|
|
||||||
return item.value if item is not None else None
|
|
||||||
|
|
||||||
|
|
||||||
async def _store_put(store, record: dict) -> None:
|
|
||||||
"""Write a thread record to the Store."""
|
|
||||||
await store.aput(THREADS_NS, record["thread_id"], record)
|
|
||||||
|
|
||||||
|
|
||||||
async def _store_upsert(store, thread_id: str, *, metadata: dict | None = None, values: dict | None = None) -> None:
|
|
||||||
"""Create or refresh a thread record in the Store.
|
|
||||||
|
|
||||||
On creation the record is written with ``status="idle"``. On update only
|
|
||||||
``updated_at`` (and optionally ``metadata`` / ``values``) are changed so
|
|
||||||
that existing fields are preserved.
|
|
||||||
|
|
||||||
``values`` carries the agent-state snapshot exposed to the frontend
|
|
||||||
(currently just ``{"title": "..."}``).
|
|
||||||
"""
|
|
||||||
now = time.time()
|
|
||||||
existing = await _store_get(store, thread_id)
|
|
||||||
if existing is None:
|
|
||||||
await _store_put(
|
|
||||||
store,
|
|
||||||
{
|
|
||||||
"thread_id": thread_id,
|
|
||||||
"status": "idle",
|
|
||||||
"created_at": now,
|
|
||||||
"updated_at": now,
|
|
||||||
"metadata": metadata or {},
|
|
||||||
"values": values or {},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
val = dict(existing)
|
|
||||||
val["updated_at"] = now
|
|
||||||
if metadata:
|
|
||||||
val.setdefault("metadata", {}).update(metadata)
|
|
||||||
if values:
|
|
||||||
val.setdefault("values", {}).update(values)
|
|
||||||
await _store_put(store, val)
|
|
||||||
|
|
||||||
|
|
||||||
def _derive_thread_status(checkpoint_tuple) -> str:
|
def _derive_thread_status(checkpoint_tuple) -> str:
|
||||||
"""Derive thread status from checkpoint metadata."""
|
"""Derive thread status from checkpoint metadata."""
|
||||||
if checkpoint_tuple is None:
|
if checkpoint_tuple is None:
|
||||||
@@ -215,23 +186,19 @@ def _derive_thread_status(checkpoint_tuple) -> str:
|
|||||||
|
|
||||||
|
|
||||||
@router.delete("/{thread_id}", response_model=ThreadDeleteResponse)
|
@router.delete("/{thread_id}", response_model=ThreadDeleteResponse)
|
||||||
|
@require_permission("threads", "delete", owner_check=True, require_existing=True)
|
||||||
async def delete_thread_data(thread_id: str, request: Request) -> ThreadDeleteResponse:
|
async def delete_thread_data(thread_id: str, request: Request) -> ThreadDeleteResponse:
|
||||||
"""Delete local persisted filesystem data for a thread.
|
"""Delete local persisted filesystem data for a thread.
|
||||||
|
|
||||||
Cleans DeerFlow-managed thread directories, removes checkpoint data,
|
Cleans DeerFlow-managed thread directories, removes checkpoint data,
|
||||||
and removes the thread record from the Store.
|
and removes the thread_meta row from the configured ThreadMetaStore
|
||||||
|
(sqlite or memory).
|
||||||
"""
|
"""
|
||||||
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
|
|
||||||
# Clean local filesystem
|
# Clean local filesystem
|
||||||
response = _delete_thread_data(thread_id)
|
response = _delete_thread_data(thread_id)
|
||||||
|
|
||||||
# Remove from Store (best-effort)
|
|
||||||
store = get_store(request)
|
|
||||||
if store is not None:
|
|
||||||
try:
|
|
||||||
await store.adelete(THREADS_NS, thread_id)
|
|
||||||
except Exception:
|
|
||||||
logger.debug("Could not delete store record for thread %s (not critical)", thread_id)
|
|
||||||
|
|
||||||
# Remove checkpoints (best-effort)
|
# Remove checkpoints (best-effort)
|
||||||
checkpointer = getattr(request.app.state, "checkpointer", None)
|
checkpointer = getattr(request.app.state, "checkpointer", None)
|
||||||
if checkpointer is not None:
|
if checkpointer is not None:
|
||||||
@@ -239,7 +206,15 @@ async def delete_thread_data(thread_id: str, request: Request) -> ThreadDeleteRe
|
|||||||
if hasattr(checkpointer, "adelete_thread"):
|
if hasattr(checkpointer, "adelete_thread"):
|
||||||
await checkpointer.adelete_thread(thread_id)
|
await checkpointer.adelete_thread(thread_id)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.debug("Could not delete checkpoints for thread %s (not critical)", thread_id)
|
logger.debug("Could not delete checkpoints for thread %s (not critical)", sanitize_log_param(thread_id))
|
||||||
|
|
||||||
|
# Remove thread_meta row (best-effort) — required for sqlite backend
|
||||||
|
# so the deleted thread no longer appears in /threads/search.
|
||||||
|
try:
|
||||||
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
|
await thread_meta_repo.delete(thread_id)
|
||||||
|
except Exception:
|
||||||
|
logger.debug("Could not delete thread_meta for %s (not critical)", sanitize_log_param(thread_id))
|
||||||
|
|
||||||
return response
|
return response
|
||||||
|
|
||||||
@@ -248,43 +223,40 @@ async def delete_thread_data(thread_id: str, request: Request) -> ThreadDeleteRe
|
|||||||
async def create_thread(body: ThreadCreateRequest, request: Request) -> ThreadResponse:
|
async def create_thread(body: ThreadCreateRequest, request: Request) -> ThreadResponse:
|
||||||
"""Create a new thread.
|
"""Create a new thread.
|
||||||
|
|
||||||
The thread record is written to the Store (for fast listing) and an
|
Writes a thread_meta record (so the thread appears in /threads/search)
|
||||||
empty checkpoint is written to the checkpointer (for state reads).
|
and an empty checkpoint (so state endpoints work immediately).
|
||||||
Idempotent: returns the existing record when ``thread_id`` already exists.
|
Idempotent: returns the existing record when ``thread_id`` already exists.
|
||||||
"""
|
"""
|
||||||
store = get_store(request)
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
|
|
||||||
checkpointer = get_checkpointer(request)
|
checkpointer = get_checkpointer(request)
|
||||||
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
thread_id = body.thread_id or str(uuid.uuid4())
|
thread_id = body.thread_id or str(uuid.uuid4())
|
||||||
now = time.time()
|
now = time.time()
|
||||||
|
# ``body.metadata`` is already stripped of server-reserved keys by
|
||||||
|
# ``ThreadCreateRequest._strip_reserved`` — see the model definition.
|
||||||
|
|
||||||
# Idempotency: return existing record from Store when already present
|
# Idempotency: return existing record when already present
|
||||||
if store is not None:
|
existing_record = await thread_meta_repo.get(thread_id)
|
||||||
existing_record = await _store_get(store, thread_id)
|
if existing_record is not None:
|
||||||
if existing_record is not None:
|
return ThreadResponse(
|
||||||
return ThreadResponse(
|
thread_id=thread_id,
|
||||||
thread_id=thread_id,
|
status=existing_record.get("status", "idle"),
|
||||||
status=existing_record.get("status", "idle"),
|
created_at=str(existing_record.get("created_at", "")),
|
||||||
created_at=str(existing_record.get("created_at", "")),
|
updated_at=str(existing_record.get("updated_at", "")),
|
||||||
updated_at=str(existing_record.get("updated_at", "")),
|
metadata=existing_record.get("metadata", {}),
|
||||||
metadata=existing_record.get("metadata", {}),
|
)
|
||||||
)
|
|
||||||
|
|
||||||
# Write thread record to Store
|
# Write thread_meta so the thread appears in /threads/search immediately
|
||||||
if store is not None:
|
try:
|
||||||
try:
|
await thread_meta_repo.create(
|
||||||
await _store_put(
|
thread_id,
|
||||||
store,
|
assistant_id=getattr(body, "assistant_id", None),
|
||||||
{
|
metadata=body.metadata,
|
||||||
"thread_id": thread_id,
|
)
|
||||||
"status": "idle",
|
except Exception:
|
||||||
"created_at": now,
|
logger.exception("Failed to write thread_meta for %s", sanitize_log_param(thread_id))
|
||||||
"updated_at": now,
|
raise HTTPException(status_code=500, detail="Failed to create thread")
|
||||||
"metadata": body.metadata,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
except Exception:
|
|
||||||
logger.exception("Failed to write thread %s to store", thread_id)
|
|
||||||
raise HTTPException(status_code=500, detail="Failed to create thread")
|
|
||||||
|
|
||||||
# Write an empty checkpoint so state endpoints work immediately
|
# Write an empty checkpoint so state endpoints work immediately
|
||||||
config = {"configurable": {"thread_id": thread_id, "checkpoint_ns": ""}}
|
config = {"configurable": {"thread_id": thread_id, "checkpoint_ns": ""}}
|
||||||
@@ -301,10 +273,10 @@ async def create_thread(body: ThreadCreateRequest, request: Request) -> ThreadRe
|
|||||||
}
|
}
|
||||||
await checkpointer.aput(config, empty_checkpoint(), ckpt_metadata, {})
|
await checkpointer.aput(config, empty_checkpoint(), ckpt_metadata, {})
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to create checkpoint for thread %s", thread_id)
|
logger.exception("Failed to create checkpoint for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to create thread")
|
raise HTTPException(status_code=500, detail="Failed to create thread")
|
||||||
|
|
||||||
logger.info("Thread created: %s", thread_id)
|
logger.info("Thread created: %s", sanitize_log_param(thread_id))
|
||||||
return ThreadResponse(
|
return ThreadResponse(
|
||||||
thread_id=thread_id,
|
thread_id=thread_id,
|
||||||
status="idle",
|
status="idle",
|
||||||
@@ -318,166 +290,91 @@ async def create_thread(body: ThreadCreateRequest, request: Request) -> ThreadRe
|
|||||||
async def search_threads(body: ThreadSearchRequest, request: Request) -> list[ThreadResponse]:
|
async def search_threads(body: ThreadSearchRequest, request: Request) -> list[ThreadResponse]:
|
||||||
"""Search and list threads.
|
"""Search and list threads.
|
||||||
|
|
||||||
Two-phase approach:
|
Delegates to the configured ThreadMetaStore implementation
|
||||||
|
(SQL-backed for sqlite/postgres, Store-backed for memory mode).
|
||||||
**Phase 1 — Store (fast path, O(threads))**: returns threads that were
|
|
||||||
created or run through this Gateway. Store records are tiny metadata
|
|
||||||
dicts so fetching all of them at once is cheap.
|
|
||||||
|
|
||||||
**Phase 2 — Checkpointer supplement (lazy migration)**: threads that
|
|
||||||
were created directly by LangGraph Server (and therefore absent from the
|
|
||||||
Store) are discovered here by iterating the shared checkpointer. Any
|
|
||||||
newly found thread is immediately written to the Store so that the next
|
|
||||||
search skips Phase 2 for that thread — the Store converges to a full
|
|
||||||
index over time without a one-shot migration job.
|
|
||||||
"""
|
"""
|
||||||
store = get_store(request)
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
checkpointer = get_checkpointer(request)
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------
|
repo = get_thread_meta_repo(request)
|
||||||
# Phase 1: Store
|
rows = await repo.search(
|
||||||
# -----------------------------------------------------------------------
|
metadata=body.metadata or None,
|
||||||
merged: dict[str, ThreadResponse] = {}
|
status=body.status,
|
||||||
|
limit=body.limit,
|
||||||
if store is not None:
|
offset=body.offset,
|
||||||
try:
|
)
|
||||||
items = await store.asearch(THREADS_NS, limit=10_000)
|
return [
|
||||||
except Exception:
|
ThreadResponse(
|
||||||
logger.warning("Store search failed — falling back to checkpointer only", exc_info=True)
|
thread_id=r["thread_id"],
|
||||||
items = []
|
status=r.get("status", "idle"),
|
||||||
|
created_at=r.get("created_at", ""),
|
||||||
for item in items:
|
updated_at=r.get("updated_at", ""),
|
||||||
val = item.value
|
metadata=r.get("metadata", {}),
|
||||||
merged[val["thread_id"]] = ThreadResponse(
|
values={"title": r["display_name"]} if r.get("display_name") else {},
|
||||||
thread_id=val["thread_id"],
|
interrupts={},
|
||||||
status=val.get("status", "idle"),
|
)
|
||||||
created_at=str(val.get("created_at", "")),
|
for r in rows
|
||||||
updated_at=str(val.get("updated_at", "")),
|
]
|
||||||
metadata=val.get("metadata", {}),
|
|
||||||
values=val.get("values", {}),
|
|
||||||
)
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------
|
|
||||||
# Phase 2: Checkpointer supplement
|
|
||||||
# Discovers threads not yet in the Store (e.g. created by LangGraph
|
|
||||||
# Server) and lazily migrates them so future searches skip this phase.
|
|
||||||
# -----------------------------------------------------------------------
|
|
||||||
try:
|
|
||||||
async for checkpoint_tuple in checkpointer.alist(None):
|
|
||||||
cfg = getattr(checkpoint_tuple, "config", {})
|
|
||||||
thread_id = cfg.get("configurable", {}).get("thread_id")
|
|
||||||
if not thread_id or thread_id in merged:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Skip sub-graph checkpoints (checkpoint_ns is non-empty for those)
|
|
||||||
if cfg.get("configurable", {}).get("checkpoint_ns", ""):
|
|
||||||
continue
|
|
||||||
|
|
||||||
ckpt_meta = getattr(checkpoint_tuple, "metadata", {}) or {}
|
|
||||||
# Strip LangGraph internal keys from the user-visible metadata dict
|
|
||||||
user_meta = {k: v for k, v in ckpt_meta.items() if k not in ("created_at", "updated_at", "step", "source", "writes", "parents")}
|
|
||||||
|
|
||||||
# Extract state values (title) from the checkpoint's channel_values
|
|
||||||
checkpoint_data = getattr(checkpoint_tuple, "checkpoint", {}) or {}
|
|
||||||
channel_values = checkpoint_data.get("channel_values", {})
|
|
||||||
ckpt_values = {}
|
|
||||||
if title := channel_values.get("title"):
|
|
||||||
ckpt_values["title"] = title
|
|
||||||
|
|
||||||
thread_resp = ThreadResponse(
|
|
||||||
thread_id=thread_id,
|
|
||||||
status=_derive_thread_status(checkpoint_tuple),
|
|
||||||
created_at=str(ckpt_meta.get("created_at", "")),
|
|
||||||
updated_at=str(ckpt_meta.get("updated_at", ckpt_meta.get("created_at", ""))),
|
|
||||||
metadata=user_meta,
|
|
||||||
values=ckpt_values,
|
|
||||||
)
|
|
||||||
merged[thread_id] = thread_resp
|
|
||||||
|
|
||||||
# Lazy migration — write to Store so the next search finds it there
|
|
||||||
if store is not None:
|
|
||||||
try:
|
|
||||||
await _store_upsert(store, thread_id, metadata=user_meta, values=ckpt_values or None)
|
|
||||||
except Exception:
|
|
||||||
logger.debug("Failed to migrate thread %s to store (non-fatal)", thread_id)
|
|
||||||
except Exception:
|
|
||||||
logger.exception("Checkpointer scan failed during thread search")
|
|
||||||
# Don't raise — return whatever was collected from Store + partial scan
|
|
||||||
|
|
||||||
# -----------------------------------------------------------------------
|
|
||||||
# Phase 3: Filter → sort → paginate
|
|
||||||
# -----------------------------------------------------------------------
|
|
||||||
results = list(merged.values())
|
|
||||||
|
|
||||||
if body.metadata:
|
|
||||||
results = [r for r in results if all(r.metadata.get(k) == v for k, v in body.metadata.items())]
|
|
||||||
|
|
||||||
if body.status:
|
|
||||||
results = [r for r in results if r.status == body.status]
|
|
||||||
|
|
||||||
results.sort(key=lambda r: r.updated_at, reverse=True)
|
|
||||||
return results[body.offset : body.offset + body.limit]
|
|
||||||
|
|
||||||
|
|
||||||
@router.patch("/{thread_id}", response_model=ThreadResponse)
|
@router.patch("/{thread_id}", response_model=ThreadResponse)
|
||||||
|
@require_permission("threads", "write", owner_check=True, require_existing=True)
|
||||||
async def patch_thread(thread_id: str, body: ThreadPatchRequest, request: Request) -> ThreadResponse:
|
async def patch_thread(thread_id: str, body: ThreadPatchRequest, request: Request) -> ThreadResponse:
|
||||||
"""Merge metadata into a thread record."""
|
"""Merge metadata into a thread record."""
|
||||||
store = get_store(request)
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
if store is None:
|
|
||||||
raise HTTPException(status_code=503, detail="Store not available")
|
|
||||||
|
|
||||||
record = await _store_get(store, thread_id)
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
|
record = await thread_meta_repo.get(thread_id)
|
||||||
if record is None:
|
if record is None:
|
||||||
raise HTTPException(status_code=404, detail=f"Thread {thread_id} not found")
|
raise HTTPException(status_code=404, detail=f"Thread {thread_id} not found")
|
||||||
|
|
||||||
now = time.time()
|
# ``body.metadata`` already stripped by ``ThreadPatchRequest._strip_reserved``.
|
||||||
updated = dict(record)
|
|
||||||
updated.setdefault("metadata", {}).update(body.metadata)
|
|
||||||
updated["updated_at"] = now
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
await _store_put(store, updated)
|
await thread_meta_repo.update_metadata(thread_id, body.metadata)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to patch thread %s", thread_id)
|
logger.exception("Failed to patch thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to update thread")
|
raise HTTPException(status_code=500, detail="Failed to update thread")
|
||||||
|
|
||||||
|
# Re-read to get the merged metadata + refreshed updated_at
|
||||||
|
record = await thread_meta_repo.get(thread_id) or record
|
||||||
return ThreadResponse(
|
return ThreadResponse(
|
||||||
thread_id=thread_id,
|
thread_id=thread_id,
|
||||||
status=updated.get("status", "idle"),
|
status=record.get("status", "idle"),
|
||||||
created_at=str(updated.get("created_at", "")),
|
created_at=str(record.get("created_at", "")),
|
||||||
updated_at=str(now),
|
updated_at=str(record.get("updated_at", "")),
|
||||||
metadata=updated.get("metadata", {}),
|
metadata=record.get("metadata", {}),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@router.get("/{thread_id}", response_model=ThreadResponse)
|
@router.get("/{thread_id}", response_model=ThreadResponse)
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
async def get_thread(thread_id: str, request: Request) -> ThreadResponse:
|
async def get_thread(thread_id: str, request: Request) -> ThreadResponse:
|
||||||
"""Get thread info.
|
"""Get thread info.
|
||||||
|
|
||||||
Reads metadata from the Store and derives the accurate execution
|
Reads metadata from the ThreadMetaStore and derives the accurate
|
||||||
status from the checkpointer. Falls back to the checkpointer alone
|
execution status from the checkpointer. Falls back to the checkpointer
|
||||||
for threads that pre-date Store adoption (backward compat).
|
alone for threads that pre-date ThreadMetaStore adoption (backward compat).
|
||||||
"""
|
"""
|
||||||
store = get_store(request)
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
|
|
||||||
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
checkpointer = get_checkpointer(request)
|
checkpointer = get_checkpointer(request)
|
||||||
|
|
||||||
record: dict | None = None
|
record: dict | None = await thread_meta_repo.get(thread_id)
|
||||||
if store is not None:
|
|
||||||
record = await _store_get(store, thread_id)
|
|
||||||
|
|
||||||
# Derive accurate status from the checkpointer
|
# Derive accurate status from the checkpointer
|
||||||
config = {"configurable": {"thread_id": thread_id, "checkpoint_ns": ""}}
|
config = {"configurable": {"thread_id": thread_id, "checkpoint_ns": ""}}
|
||||||
try:
|
try:
|
||||||
checkpoint_tuple = await checkpointer.aget_tuple(config)
|
checkpoint_tuple = await checkpointer.aget_tuple(config)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to get checkpoint for thread %s", thread_id)
|
logger.exception("Failed to get checkpoint for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to get thread")
|
raise HTTPException(status_code=500, detail="Failed to get thread")
|
||||||
|
|
||||||
if record is None and checkpoint_tuple is None:
|
if record is None and checkpoint_tuple is None:
|
||||||
raise HTTPException(status_code=404, detail=f"Thread {thread_id} not found")
|
raise HTTPException(status_code=404, detail=f"Thread {thread_id} not found")
|
||||||
|
|
||||||
# If the thread exists in the checkpointer but not the store (e.g. legacy
|
# If the thread exists in the checkpointer but not in thread_meta (e.g.
|
||||||
# data), synthesize a minimal store record from the checkpoint metadata.
|
# legacy data created before thread_meta adoption), synthesize a minimal
|
||||||
|
# record from the checkpoint metadata.
|
||||||
if record is None and checkpoint_tuple is not None:
|
if record is None and checkpoint_tuple is not None:
|
||||||
ckpt_meta = getattr(checkpoint_tuple, "metadata", {}) or {}
|
ckpt_meta = getattr(checkpoint_tuple, "metadata", {}) or {}
|
||||||
record = {
|
record = {
|
||||||
@@ -488,21 +385,25 @@ async def get_thread(thread_id: str, request: Request) -> ThreadResponse:
|
|||||||
"metadata": {k: v for k, v in ckpt_meta.items() if k not in ("created_at", "updated_at", "step", "source", "writes", "parents")},
|
"metadata": {k: v for k, v in ckpt_meta.items() if k not in ("created_at", "updated_at", "step", "source", "writes", "parents")},
|
||||||
}
|
}
|
||||||
|
|
||||||
status = _derive_thread_status(checkpoint_tuple) if checkpoint_tuple is not None else record.get("status", "idle") # type: ignore[union-attr]
|
if record is None:
|
||||||
|
raise HTTPException(status_code=404, detail=f"Thread {thread_id} not found")
|
||||||
|
|
||||||
|
status = _derive_thread_status(checkpoint_tuple) if checkpoint_tuple is not None else record.get("status", "idle")
|
||||||
checkpoint = getattr(checkpoint_tuple, "checkpoint", {}) or {} if checkpoint_tuple is not None else {}
|
checkpoint = getattr(checkpoint_tuple, "checkpoint", {}) or {} if checkpoint_tuple is not None else {}
|
||||||
channel_values = checkpoint.get("channel_values", {})
|
channel_values = checkpoint.get("channel_values", {})
|
||||||
|
|
||||||
return ThreadResponse(
|
return ThreadResponse(
|
||||||
thread_id=thread_id,
|
thread_id=thread_id,
|
||||||
status=status,
|
status=status,
|
||||||
created_at=str(record.get("created_at", "")), # type: ignore[union-attr]
|
created_at=str(record.get("created_at", "")),
|
||||||
updated_at=str(record.get("updated_at", "")), # type: ignore[union-attr]
|
updated_at=str(record.get("updated_at", "")),
|
||||||
metadata=record.get("metadata", {}), # type: ignore[union-attr]
|
metadata=record.get("metadata", {}),
|
||||||
values=serialize_channel_values(channel_values),
|
values=serialize_channel_values(channel_values),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@router.get("/{thread_id}/state", response_model=ThreadStateResponse)
|
@router.get("/{thread_id}/state", response_model=ThreadStateResponse)
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
async def get_thread_state(thread_id: str, request: Request) -> ThreadStateResponse:
|
async def get_thread_state(thread_id: str, request: Request) -> ThreadStateResponse:
|
||||||
"""Get the latest state snapshot for a thread.
|
"""Get the latest state snapshot for a thread.
|
||||||
|
|
||||||
@@ -515,7 +416,7 @@ async def get_thread_state(thread_id: str, request: Request) -> ThreadStateRespo
|
|||||||
try:
|
try:
|
||||||
checkpoint_tuple = await checkpointer.aget_tuple(config)
|
checkpoint_tuple = await checkpointer.aget_tuple(config)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to get state for thread %s", thread_id)
|
logger.exception("Failed to get state for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to get thread state")
|
raise HTTPException(status_code=500, detail="Failed to get thread state")
|
||||||
|
|
||||||
if checkpoint_tuple is None:
|
if checkpoint_tuple is None:
|
||||||
@@ -552,15 +453,19 @@ async def get_thread_state(thread_id: str, request: Request) -> ThreadStateRespo
|
|||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/state", response_model=ThreadStateResponse)
|
@router.post("/{thread_id}/state", response_model=ThreadStateResponse)
|
||||||
|
@require_permission("threads", "write", owner_check=True, require_existing=True)
|
||||||
async def update_thread_state(thread_id: str, body: ThreadStateUpdateRequest, request: Request) -> ThreadStateResponse:
|
async def update_thread_state(thread_id: str, body: ThreadStateUpdateRequest, request: Request) -> ThreadStateResponse:
|
||||||
"""Update thread state (e.g. for human-in-the-loop resume or title rename).
|
"""Update thread state (e.g. for human-in-the-loop resume or title rename).
|
||||||
|
|
||||||
Writes a new checkpoint that merges *body.values* into the latest
|
Writes a new checkpoint that merges *body.values* into the latest
|
||||||
channel values, then syncs any updated ``title`` field back to the Store
|
channel values, then syncs any updated ``title`` field through the
|
||||||
so that ``/threads/search`` reflects the change immediately.
|
ThreadMetaStore abstraction so that ``/threads/search`` reflects the
|
||||||
|
change immediately in both sqlite and memory backends.
|
||||||
"""
|
"""
|
||||||
|
from app.gateway.deps import get_thread_meta_repo
|
||||||
|
|
||||||
checkpointer = get_checkpointer(request)
|
checkpointer = get_checkpointer(request)
|
||||||
store = get_store(request)
|
thread_meta_repo = get_thread_meta_repo(request)
|
||||||
|
|
||||||
# checkpoint_ns must be present in the config for aput — default to ""
|
# checkpoint_ns must be present in the config for aput — default to ""
|
||||||
# (the root graph namespace). checkpoint_id is optional; omitting it
|
# (the root graph namespace). checkpoint_id is optional; omitting it
|
||||||
@@ -577,7 +482,7 @@ async def update_thread_state(thread_id: str, body: ThreadStateUpdateRequest, re
|
|||||||
try:
|
try:
|
||||||
checkpoint_tuple = await checkpointer.aget_tuple(read_config)
|
checkpoint_tuple = await checkpointer.aget_tuple(read_config)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to get state for thread %s", thread_id)
|
logger.exception("Failed to get state for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to get thread state")
|
raise HTTPException(status_code=500, detail="Failed to get thread state")
|
||||||
|
|
||||||
if checkpoint_tuple is None:
|
if checkpoint_tuple is None:
|
||||||
@@ -611,19 +516,22 @@ async def update_thread_state(thread_id: str, body: ThreadStateUpdateRequest, re
|
|||||||
try:
|
try:
|
||||||
new_config = await checkpointer.aput(write_config, checkpoint, metadata, {})
|
new_config = await checkpointer.aput(write_config, checkpoint, metadata, {})
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to update state for thread %s", thread_id)
|
logger.exception("Failed to update state for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to update thread state")
|
raise HTTPException(status_code=500, detail="Failed to update thread state")
|
||||||
|
|
||||||
new_checkpoint_id: str | None = None
|
new_checkpoint_id: str | None = None
|
||||||
if isinstance(new_config, dict):
|
if isinstance(new_config, dict):
|
||||||
new_checkpoint_id = new_config.get("configurable", {}).get("checkpoint_id")
|
new_checkpoint_id = new_config.get("configurable", {}).get("checkpoint_id")
|
||||||
|
|
||||||
# Sync title changes to the Store so /threads/search reflects them immediately.
|
# Sync title changes through the ThreadMetaStore abstraction so /threads/search
|
||||||
if store is not None and body.values and "title" in body.values:
|
# reflects them immediately in both sqlite and memory backends.
|
||||||
try:
|
if body.values and "title" in body.values:
|
||||||
await _store_upsert(store, thread_id, values={"title": body.values["title"]})
|
new_title = body.values["title"]
|
||||||
except Exception:
|
if new_title: # Skip empty strings and None
|
||||||
logger.debug("Failed to sync title to store for thread %s (non-fatal)", thread_id)
|
try:
|
||||||
|
await thread_meta_repo.update_display_name(thread_id, new_title)
|
||||||
|
except Exception:
|
||||||
|
logger.debug("Failed to sync title to thread_meta for %s (non-fatal)", sanitize_log_param(thread_id))
|
||||||
|
|
||||||
return ThreadStateResponse(
|
return ThreadStateResponse(
|
||||||
values=serialize_channel_values(channel_values),
|
values=serialize_channel_values(channel_values),
|
||||||
@@ -635,8 +543,16 @@ async def update_thread_state(thread_id: str, body: ThreadStateUpdateRequest, re
|
|||||||
|
|
||||||
|
|
||||||
@router.post("/{thread_id}/history", response_model=list[HistoryEntry])
|
@router.post("/{thread_id}/history", response_model=list[HistoryEntry])
|
||||||
|
@require_permission("threads", "read", owner_check=True)
|
||||||
async def get_thread_history(thread_id: str, body: ThreadHistoryRequest, request: Request) -> list[HistoryEntry]:
|
async def get_thread_history(thread_id: str, body: ThreadHistoryRequest, request: Request) -> list[HistoryEntry]:
|
||||||
"""Get checkpoint history for a thread."""
|
"""Get checkpoint history for a thread.
|
||||||
|
|
||||||
|
Messages are read from the checkpointer's channel values (the
|
||||||
|
authoritative source) and serialized via
|
||||||
|
:func:`~deerflow.runtime.serialization.serialize_channel_values`.
|
||||||
|
Only the latest (first) checkpoint carries the ``messages`` key to
|
||||||
|
avoid duplicating them across every entry.
|
||||||
|
"""
|
||||||
checkpointer = get_checkpointer(request)
|
checkpointer = get_checkpointer(request)
|
||||||
|
|
||||||
config: dict[str, Any] = {"configurable": {"thread_id": thread_id}}
|
config: dict[str, Any] = {"configurable": {"thread_id": thread_id}}
|
||||||
@@ -644,6 +560,7 @@ async def get_thread_history(thread_id: str, body: ThreadHistoryRequest, request
|
|||||||
config["configurable"]["checkpoint_id"] = body.before
|
config["configurable"]["checkpoint_id"] = body.before
|
||||||
|
|
||||||
entries: list[HistoryEntry] = []
|
entries: list[HistoryEntry] = []
|
||||||
|
is_latest_checkpoint = True
|
||||||
try:
|
try:
|
||||||
async for checkpoint_tuple in checkpointer.alist(config, limit=body.limit):
|
async for checkpoint_tuple in checkpointer.alist(config, limit=body.limit):
|
||||||
ckpt_config = getattr(checkpoint_tuple, "config", {})
|
ckpt_config = getattr(checkpoint_tuple, "config", {})
|
||||||
@@ -658,22 +575,42 @@ async def get_thread_history(thread_id: str, body: ThreadHistoryRequest, request
|
|||||||
|
|
||||||
channel_values = checkpoint.get("channel_values", {})
|
channel_values = checkpoint.get("channel_values", {})
|
||||||
|
|
||||||
|
# Build values from checkpoint channel_values
|
||||||
|
values: dict[str, Any] = {}
|
||||||
|
if title := channel_values.get("title"):
|
||||||
|
values["title"] = title
|
||||||
|
if thread_data := channel_values.get("thread_data"):
|
||||||
|
values["thread_data"] = thread_data
|
||||||
|
|
||||||
|
# Attach messages from checkpointer only for the latest checkpoint
|
||||||
|
if is_latest_checkpoint:
|
||||||
|
messages = channel_values.get("messages")
|
||||||
|
if messages:
|
||||||
|
values["messages"] = serialize_channel_values({"messages": messages}).get("messages", [])
|
||||||
|
is_latest_checkpoint = False
|
||||||
|
|
||||||
# Derive next tasks
|
# Derive next tasks
|
||||||
tasks_raw = getattr(checkpoint_tuple, "tasks", []) or []
|
tasks_raw = getattr(checkpoint_tuple, "tasks", []) or []
|
||||||
next_tasks = [t.name for t in tasks_raw if hasattr(t, "name")]
|
next_tasks = [t.name for t in tasks_raw if hasattr(t, "name")]
|
||||||
|
|
||||||
|
# Strip LangGraph internal keys from metadata
|
||||||
|
user_meta = {k: v for k, v in metadata.items() if k not in ("created_at", "updated_at", "step", "source", "writes", "parents")}
|
||||||
|
# Keep step for ordering context
|
||||||
|
if "step" in metadata:
|
||||||
|
user_meta["step"] = metadata["step"]
|
||||||
|
|
||||||
entries.append(
|
entries.append(
|
||||||
HistoryEntry(
|
HistoryEntry(
|
||||||
checkpoint_id=checkpoint_id,
|
checkpoint_id=checkpoint_id,
|
||||||
parent_checkpoint_id=parent_id,
|
parent_checkpoint_id=parent_id,
|
||||||
metadata=metadata,
|
metadata=user_meta,
|
||||||
values=serialize_channel_values(channel_values),
|
values=values,
|
||||||
created_at=str(metadata.get("created_at", "")),
|
created_at=str(metadata.get("created_at", "")),
|
||||||
next=next_tasks,
|
next=next_tasks,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to get history for thread %s", thread_id)
|
logger.exception("Failed to get history for thread %s", sanitize_log_param(thread_id))
|
||||||
raise HTTPException(status_code=500, detail="Failed to get thread history")
|
raise HTTPException(status_code=500, detail="Failed to get thread history")
|
||||||
|
|
||||||
return entries
|
return entries
|
||||||
|
|||||||
@@ -4,9 +4,10 @@ import logging
|
|||||||
import os
|
import os
|
||||||
import stat
|
import stat
|
||||||
|
|
||||||
from fastapi import APIRouter, File, HTTPException, UploadFile
|
from fastapi import APIRouter, File, HTTPException, Request, UploadFile
|
||||||
from pydantic import BaseModel
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
from app.gateway.authz import require_permission
|
||||||
from deerflow.config.paths import get_paths
|
from deerflow.config.paths import get_paths
|
||||||
from deerflow.sandbox.sandbox_provider import get_sandbox_provider
|
from deerflow.sandbox.sandbox_provider import get_sandbox_provider
|
||||||
from deerflow.uploads.manager import (
|
from deerflow.uploads.manager import (
|
||||||
@@ -54,8 +55,10 @@ def _make_file_sandbox_writable(file_path: os.PathLike[str] | str) -> None:
|
|||||||
|
|
||||||
|
|
||||||
@router.post("", response_model=UploadResponse)
|
@router.post("", response_model=UploadResponse)
|
||||||
|
@require_permission("threads", "write", owner_check=True, require_existing=True)
|
||||||
async def upload_files(
|
async def upload_files(
|
||||||
thread_id: str,
|
thread_id: str,
|
||||||
|
request: Request,
|
||||||
files: list[UploadFile] = File(...),
|
files: list[UploadFile] = File(...),
|
||||||
) -> UploadResponse:
|
) -> UploadResponse:
|
||||||
"""Upload multiple files to a thread's uploads directory."""
|
"""Upload multiple files to a thread's uploads directory."""
|
||||||
@@ -133,7 +136,8 @@ async def upload_files(
|
|||||||
|
|
||||||
|
|
||||||
@router.get("/list", response_model=dict)
|
@router.get("/list", response_model=dict)
|
||||||
async def list_uploaded_files(thread_id: str) -> dict:
|
@require_permission("threads", "read", owner_check=True)
|
||||||
|
async def list_uploaded_files(thread_id: str, request: Request) -> dict:
|
||||||
"""List all files in a thread's uploads directory."""
|
"""List all files in a thread's uploads directory."""
|
||||||
try:
|
try:
|
||||||
uploads_dir = get_uploads_dir(thread_id)
|
uploads_dir = get_uploads_dir(thread_id)
|
||||||
@@ -151,7 +155,8 @@ async def list_uploaded_files(thread_id: str) -> dict:
|
|||||||
|
|
||||||
|
|
||||||
@router.delete("/{filename}")
|
@router.delete("/{filename}")
|
||||||
async def delete_uploaded_file(thread_id: str, filename: str) -> dict:
|
@require_permission("threads", "delete", owner_check=True, require_existing=True)
|
||||||
|
async def delete_uploaded_file(thread_id: str, filename: str, request: Request) -> dict:
|
||||||
"""Delete a file from a thread's uploads directory."""
|
"""Delete a file from a thread's uploads directory."""
|
||||||
try:
|
try:
|
||||||
uploads_dir = get_uploads_dir(thread_id)
|
uploads_dir = get_uploads_dir(thread_id)
|
||||||
|
|||||||
+122
-93
@@ -8,15 +8,17 @@ frames, and consuming stream bridge events. Router modules
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
import dataclasses
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import time
|
import re
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from fastapi import HTTPException, Request
|
from fastapi import HTTPException, Request
|
||||||
from langchain_core.messages import HumanMessage
|
from langchain_core.messages import HumanMessage
|
||||||
|
|
||||||
from app.gateway.deps import get_checkpointer, get_run_manager, get_store, get_stream_bridge
|
from app.gateway.deps import get_run_context, get_run_manager, get_run_store, get_stream_bridge
|
||||||
|
from app.gateway.utils import sanitize_log_param
|
||||||
from deerflow.runtime import (
|
from deerflow.runtime import (
|
||||||
END_SENTINEL,
|
END_SENTINEL,
|
||||||
HEARTBEAT_SENTINEL,
|
HEARTBEAT_SENTINEL,
|
||||||
@@ -93,25 +95,73 @@ def normalize_input(raw_input: dict[str, Any] | None) -> dict[str, Any]:
|
|||||||
return raw_input
|
return raw_input
|
||||||
|
|
||||||
|
|
||||||
|
_DEFAULT_ASSISTANT_ID = "lead_agent"
|
||||||
|
|
||||||
|
|
||||||
def resolve_agent_factory(assistant_id: str | None):
|
def resolve_agent_factory(assistant_id: str | None):
|
||||||
"""Resolve the agent factory callable from config."""
|
"""Resolve the agent factory callable from config.
|
||||||
|
|
||||||
|
Custom agents are implemented as ``lead_agent`` + an ``agent_name``
|
||||||
|
injected into ``configurable`` — see :func:`build_run_config`. All
|
||||||
|
``assistant_id`` values therefore map to the same factory; the routing
|
||||||
|
happens inside ``make_lead_agent`` when it reads ``cfg["agent_name"]``.
|
||||||
|
"""
|
||||||
from deerflow.agents.lead_agent.agent import make_lead_agent
|
from deerflow.agents.lead_agent.agent import make_lead_agent
|
||||||
|
|
||||||
if assistant_id and assistant_id != "lead_agent":
|
|
||||||
logger.info("assistant_id=%s requested; falling back to lead_agent", assistant_id)
|
|
||||||
return make_lead_agent
|
return make_lead_agent
|
||||||
|
|
||||||
|
|
||||||
def build_run_config(thread_id: str, request_config: dict[str, Any] | None, metadata: dict[str, Any] | None) -> dict[str, Any]:
|
def build_run_config(
|
||||||
"""Build a RunnableConfig dict for the agent."""
|
thread_id: str,
|
||||||
configurable = {"thread_id": thread_id}
|
request_config: dict[str, Any] | None,
|
||||||
if request_config:
|
metadata: dict[str, Any] | None,
|
||||||
configurable.update(request_config.get("configurable", {}))
|
*,
|
||||||
config: dict[str, Any] = {"configurable": configurable, "recursion_limit": 100}
|
assistant_id: str | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Build a RunnableConfig dict for the agent.
|
||||||
|
|
||||||
|
When *assistant_id* refers to a custom agent (anything other than
|
||||||
|
``"lead_agent"`` / ``None``), the name is forwarded as
|
||||||
|
``configurable["agent_name"]``. ``make_lead_agent`` reads this key to
|
||||||
|
load the matching ``agents/<name>/SOUL.md`` and per-agent config —
|
||||||
|
without it the agent silently runs as the default lead agent.
|
||||||
|
|
||||||
|
This mirrors the channel manager's ``_resolve_run_params`` logic so that
|
||||||
|
the LangGraph Platform-compatible HTTP API and the IM channel path behave
|
||||||
|
identically.
|
||||||
|
"""
|
||||||
|
config: dict[str, Any] = {"recursion_limit": 100}
|
||||||
if request_config:
|
if request_config:
|
||||||
|
# LangGraph >= 0.6.0 introduced ``context`` as the preferred way to
|
||||||
|
# pass thread-level data and rejects requests that include both
|
||||||
|
# ``configurable`` and ``context``. If the caller already sends
|
||||||
|
# ``context``, honour it and skip our own ``configurable`` dict.
|
||||||
|
if "context" in request_config:
|
||||||
|
if "configurable" in request_config:
|
||||||
|
logger.warning(
|
||||||
|
"build_run_config: client sent both 'context' and 'configurable'; preferring 'context' (LangGraph >= 0.6.0). thread_id=%s, caller_configurable keys=%s",
|
||||||
|
thread_id,
|
||||||
|
list(request_config.get("configurable", {}).keys()),
|
||||||
|
)
|
||||||
|
config["context"] = request_config["context"]
|
||||||
|
else:
|
||||||
|
configurable = {"thread_id": thread_id}
|
||||||
|
configurable.update(request_config.get("configurable", {}))
|
||||||
|
config["configurable"] = configurable
|
||||||
for k, v in request_config.items():
|
for k, v in request_config.items():
|
||||||
if k != "configurable":
|
if k not in ("configurable", "context"):
|
||||||
config[k] = v
|
config[k] = v
|
||||||
|
else:
|
||||||
|
config["configurable"] = {"thread_id": thread_id}
|
||||||
|
|
||||||
|
# Inject custom agent name when the caller specified a non-default assistant.
|
||||||
|
# Honour an explicit configurable["agent_name"] in the request if already set.
|
||||||
|
if assistant_id and assistant_id != _DEFAULT_ASSISTANT_ID and "configurable" in config:
|
||||||
|
if "agent_name" not in config["configurable"]:
|
||||||
|
normalized = assistant_id.strip().lower().replace("_", "-")
|
||||||
|
if not normalized or not re.fullmatch(r"[a-z0-9-]+", normalized):
|
||||||
|
raise ValueError(f"Invalid assistant_id {assistant_id!r}: must contain only letters, digits, and hyphens after normalization.")
|
||||||
|
config["configurable"]["agent_name"] = normalized
|
||||||
if metadata:
|
if metadata:
|
||||||
config.setdefault("metadata", {}).update(metadata)
|
config.setdefault("metadata", {}).update(metadata)
|
||||||
return config
|
return config
|
||||||
@@ -122,71 +172,6 @@ def build_run_config(thread_id: str, request_config: dict[str, Any] | None, meta
|
|||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
async def _upsert_thread_in_store(store, thread_id: str, metadata: dict | None) -> None:
|
|
||||||
"""Create or refresh the thread record in the Store.
|
|
||||||
|
|
||||||
Called from :func:`start_run` so that threads created via the stateless
|
|
||||||
``/runs/stream`` endpoint (which never calls ``POST /threads``) still
|
|
||||||
appear in ``/threads/search`` results.
|
|
||||||
"""
|
|
||||||
# Deferred import to avoid circular import with the threads router module.
|
|
||||||
from app.gateway.routers.threads import _store_upsert
|
|
||||||
|
|
||||||
try:
|
|
||||||
await _store_upsert(store, thread_id, metadata=metadata)
|
|
||||||
except Exception:
|
|
||||||
logger.warning("Failed to upsert thread %s in store (non-fatal)", thread_id)
|
|
||||||
|
|
||||||
|
|
||||||
async def _sync_thread_title_after_run(
|
|
||||||
run_task: asyncio.Task,
|
|
||||||
thread_id: str,
|
|
||||||
checkpointer: Any,
|
|
||||||
store: Any,
|
|
||||||
) -> None:
|
|
||||||
"""Wait for *run_task* to finish, then persist the generated title to the Store.
|
|
||||||
|
|
||||||
TitleMiddleware writes the generated title to the LangGraph agent state
|
|
||||||
(checkpointer) but the Gateway's Store record is not updated automatically.
|
|
||||||
This coroutine closes that gap by reading the final checkpoint after the
|
|
||||||
run completes and syncing ``values.title`` into the Store record so that
|
|
||||||
subsequent ``/threads/search`` responses include the correct title.
|
|
||||||
|
|
||||||
Runs as a fire-and-forget :func:`asyncio.create_task`; failures are
|
|
||||||
logged at DEBUG level and never propagate.
|
|
||||||
"""
|
|
||||||
# Wait for the background run task to complete (any outcome).
|
|
||||||
# asyncio.wait does not propagate task exceptions — it just returns
|
|
||||||
# when the task is done, cancelled, or failed.
|
|
||||||
await asyncio.wait({run_task})
|
|
||||||
|
|
||||||
# Deferred import to avoid circular import with the threads router module.
|
|
||||||
from app.gateway.routers.threads import _store_get, _store_put
|
|
||||||
|
|
||||||
try:
|
|
||||||
ckpt_config = {"configurable": {"thread_id": thread_id, "checkpoint_ns": ""}}
|
|
||||||
ckpt_tuple = await checkpointer.aget_tuple(ckpt_config)
|
|
||||||
if ckpt_tuple is None:
|
|
||||||
return
|
|
||||||
|
|
||||||
channel_values = ckpt_tuple.checkpoint.get("channel_values", {})
|
|
||||||
title = channel_values.get("title")
|
|
||||||
if not title:
|
|
||||||
return
|
|
||||||
|
|
||||||
existing = await _store_get(store, thread_id)
|
|
||||||
if existing is None:
|
|
||||||
return
|
|
||||||
|
|
||||||
updated = dict(existing)
|
|
||||||
updated.setdefault("values", {})["title"] = title
|
|
||||||
updated["updated_at"] = time.time()
|
|
||||||
await _store_put(store, updated)
|
|
||||||
logger.debug("Synced title %r for thread %s", title, thread_id)
|
|
||||||
except Exception:
|
|
||||||
logger.debug("Failed to sync title for thread %s (non-fatal)", thread_id, exc_info=True)
|
|
||||||
|
|
||||||
|
|
||||||
async def start_run(
|
async def start_run(
|
||||||
body: Any,
|
body: Any,
|
||||||
thread_id: str,
|
thread_id: str,
|
||||||
@@ -206,11 +191,25 @@ async def start_run(
|
|||||||
"""
|
"""
|
||||||
bridge = get_stream_bridge(request)
|
bridge = get_stream_bridge(request)
|
||||||
run_mgr = get_run_manager(request)
|
run_mgr = get_run_manager(request)
|
||||||
checkpointer = get_checkpointer(request)
|
run_ctx = get_run_context(request)
|
||||||
store = get_store(request)
|
|
||||||
|
|
||||||
disconnect = DisconnectMode.cancel if body.on_disconnect == "cancel" else DisconnectMode.continue_
|
disconnect = DisconnectMode.cancel if body.on_disconnect == "cancel" else DisconnectMode.continue_
|
||||||
|
|
||||||
|
# Resolve follow_up_to_run_id: explicit from request, or auto-detect from latest successful run
|
||||||
|
follow_up_to_run_id = getattr(body, "follow_up_to_run_id", None)
|
||||||
|
if follow_up_to_run_id is None:
|
||||||
|
run_store = get_run_store(request)
|
||||||
|
try:
|
||||||
|
recent_runs = await run_store.list_by_thread(thread_id, limit=1)
|
||||||
|
if recent_runs and recent_runs[0].get("status") == "success":
|
||||||
|
follow_up_to_run_id = recent_runs[0]["run_id"]
|
||||||
|
except Exception:
|
||||||
|
pass # Don't block run creation
|
||||||
|
|
||||||
|
# Enrich base context with per-run field
|
||||||
|
if follow_up_to_run_id:
|
||||||
|
run_ctx = dataclasses.replace(run_ctx, follow_up_to_run_id=follow_up_to_run_id)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
record = await run_mgr.create_or_reject(
|
record = await run_mgr.create_or_reject(
|
||||||
thread_id,
|
thread_id,
|
||||||
@@ -219,21 +218,53 @@ async def start_run(
|
|||||||
metadata=body.metadata or {},
|
metadata=body.metadata or {},
|
||||||
kwargs={"input": body.input, "config": body.config},
|
kwargs={"input": body.input, "config": body.config},
|
||||||
multitask_strategy=body.multitask_strategy,
|
multitask_strategy=body.multitask_strategy,
|
||||||
|
follow_up_to_run_id=follow_up_to_run_id,
|
||||||
)
|
)
|
||||||
except ConflictError as exc:
|
except ConflictError as exc:
|
||||||
raise HTTPException(status_code=409, detail=str(exc)) from exc
|
raise HTTPException(status_code=409, detail=str(exc)) from exc
|
||||||
except UnsupportedStrategyError as exc:
|
except UnsupportedStrategyError as exc:
|
||||||
raise HTTPException(status_code=501, detail=str(exc)) from exc
|
raise HTTPException(status_code=501, detail=str(exc)) from exc
|
||||||
|
|
||||||
# Ensure the thread is visible in /threads/search, even for threads that
|
# Upsert thread metadata so the thread appears in /threads/search,
|
||||||
# were never explicitly created via POST /threads (e.g. stateless runs).
|
# even for threads that were never explicitly created via POST /threads
|
||||||
store = get_store(request)
|
# (e.g. stateless runs).
|
||||||
if store is not None:
|
try:
|
||||||
await _upsert_thread_in_store(store, thread_id, body.metadata)
|
existing = await run_ctx.thread_meta_repo.get(thread_id)
|
||||||
|
if existing is None:
|
||||||
|
await run_ctx.thread_meta_repo.create(
|
||||||
|
thread_id,
|
||||||
|
assistant_id=body.assistant_id,
|
||||||
|
metadata=body.metadata,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
await run_ctx.thread_meta_repo.update_status(thread_id, "running")
|
||||||
|
except Exception:
|
||||||
|
logger.warning("Failed to upsert thread_meta for %s (non-fatal)", sanitize_log_param(thread_id))
|
||||||
|
|
||||||
agent_factory = resolve_agent_factory(body.assistant_id)
|
agent_factory = resolve_agent_factory(body.assistant_id)
|
||||||
graph_input = normalize_input(body.input)
|
graph_input = normalize_input(body.input)
|
||||||
config = build_run_config(thread_id, body.config, body.metadata)
|
config = build_run_config(thread_id, body.config, body.metadata, assistant_id=body.assistant_id)
|
||||||
|
|
||||||
|
# Merge DeerFlow-specific context overrides into configurable.
|
||||||
|
# The ``context`` field is a custom extension for the langgraph-compat layer
|
||||||
|
# that carries agent configuration (model_name, thinking_enabled, etc.).
|
||||||
|
# Only agent-relevant keys are forwarded; unknown keys (e.g. thread_id) are ignored.
|
||||||
|
context = getattr(body, "context", None)
|
||||||
|
if context:
|
||||||
|
_CONTEXT_CONFIGURABLE_KEYS = {
|
||||||
|
"model_name",
|
||||||
|
"mode",
|
||||||
|
"thinking_enabled",
|
||||||
|
"reasoning_effort",
|
||||||
|
"is_plan_mode",
|
||||||
|
"subagent_enabled",
|
||||||
|
"max_concurrent_subagents",
|
||||||
|
}
|
||||||
|
configurable = config.setdefault("configurable", {})
|
||||||
|
for key in _CONTEXT_CONFIGURABLE_KEYS:
|
||||||
|
if key in context:
|
||||||
|
configurable.setdefault(key, context[key])
|
||||||
|
|
||||||
stream_modes = normalize_stream_modes(body.stream_mode)
|
stream_modes = normalize_stream_modes(body.stream_mode)
|
||||||
|
|
||||||
task = asyncio.create_task(
|
task = asyncio.create_task(
|
||||||
@@ -241,8 +272,7 @@ async def start_run(
|
|||||||
bridge,
|
bridge,
|
||||||
run_mgr,
|
run_mgr,
|
||||||
record,
|
record,
|
||||||
checkpointer=checkpointer,
|
ctx=run_ctx,
|
||||||
store=store,
|
|
||||||
agent_factory=agent_factory,
|
agent_factory=agent_factory,
|
||||||
graph_input=graph_input,
|
graph_input=graph_input,
|
||||||
config=config,
|
config=config,
|
||||||
@@ -254,11 +284,9 @@ async def start_run(
|
|||||||
)
|
)
|
||||||
record.task = task
|
record.task = task
|
||||||
|
|
||||||
# After the run completes, sync the title generated by TitleMiddleware from
|
# Title sync is handled by worker.py's finally block which reads the
|
||||||
# the checkpointer into the Store record so that /threads/search returns the
|
# title from the checkpoint and calls thread_meta_repo.update_display_name
|
||||||
# correct title instead of an empty values dict.
|
# after the run completes.
|
||||||
if store is not None:
|
|
||||||
asyncio.create_task(_sync_thread_title_after_run(task, thread_id, checkpointer, store))
|
|
||||||
|
|
||||||
return record
|
return record
|
||||||
|
|
||||||
@@ -275,8 +303,9 @@ async def sse_consumer(
|
|||||||
- ``cancel``: abort the background task on client disconnect.
|
- ``cancel``: abort the background task on client disconnect.
|
||||||
- ``continue``: let the task run; events are discarded.
|
- ``continue``: let the task run; events are discarded.
|
||||||
"""
|
"""
|
||||||
|
last_event_id = request.headers.get("Last-Event-ID")
|
||||||
try:
|
try:
|
||||||
async for entry in bridge.subscribe(record.run_id):
|
async for entry in bridge.subscribe(record.run_id, last_event_id=last_event_id):
|
||||||
if await request.is_disconnected():
|
if await request.is_disconnected():
|
||||||
break
|
break
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
"""Shared utility helpers for the Gateway layer."""
|
||||||
|
|
||||||
|
|
||||||
|
def sanitize_log_param(value: str) -> str:
|
||||||
|
"""Strip control characters to prevent log injection."""
|
||||||
|
return value.replace("\n", "").replace("\r", "").replace("\x00", "")
|
||||||
+25
-1
@@ -86,6 +86,7 @@ Content-Type: application/json
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"config": {
|
"config": {
|
||||||
|
"recursion_limit": 100,
|
||||||
"configurable": {
|
"configurable": {
|
||||||
"model_name": "gpt-4",
|
"model_name": "gpt-4",
|
||||||
"thinking_enabled": false,
|
"thinking_enabled": false,
|
||||||
@@ -100,6 +101,21 @@ Content-Type: application/json
|
|||||||
- Use: `values`, `messages-tuple`, `custom`, `updates`, `events`, `debug`, `tasks`, `checkpoints`
|
- Use: `values`, `messages-tuple`, `custom`, `updates`, `events`, `debug`, `tasks`, `checkpoints`
|
||||||
- Do not use: `tools` (deprecated/invalid in current `langgraph-api` and will trigger schema validation errors)
|
- Do not use: `tools` (deprecated/invalid in current `langgraph-api` and will trigger schema validation errors)
|
||||||
|
|
||||||
|
**Recursion Limit:**
|
||||||
|
|
||||||
|
`config.recursion_limit` caps the number of graph steps LangGraph will execute
|
||||||
|
in a single run. The `/api/langgraph/*` endpoints go straight to the LangGraph
|
||||||
|
server and therefore inherit LangGraph's native default of **25**, which is
|
||||||
|
too low for plan-mode or subagent-heavy runs — the agent typically errors out
|
||||||
|
with `GraphRecursionError` after the first round of subagent results comes
|
||||||
|
back, before the lead agent can synthesize the final answer.
|
||||||
|
|
||||||
|
DeerFlow's own Gateway and IM-channel paths mitigate this by defaulting to
|
||||||
|
`100` in `build_run_config` (see `backend/app/gateway/services.py`), but
|
||||||
|
clients calling the LangGraph API directly must set `recursion_limit`
|
||||||
|
explicitly in the request body. `100` matches the Gateway default and is a
|
||||||
|
safe starting point; increase it if you run deeply nested subagent graphs.
|
||||||
|
|
||||||
**Configurable Options:**
|
**Configurable Options:**
|
||||||
- `model_name` (string): Override the default model
|
- `model_name` (string): Override the default model
|
||||||
- `thinking_enabled` (boolean): Enable extended thinking for supported models
|
- `thinking_enabled` (boolean): Enable extended thinking for supported models
|
||||||
@@ -626,6 +642,14 @@ curl -X POST http://localhost:2026/api/langgraph/threads/abc123/runs \
|
|||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{
|
-d '{
|
||||||
"input": {"messages": [{"role": "user", "content": "Hello"}]},
|
"input": {"messages": [{"role": "user", "content": "Hello"}]},
|
||||||
"config": {"configurable": {"model_name": "gpt-4"}}
|
"config": {
|
||||||
|
"recursion_limit": 100,
|
||||||
|
"configurable": {"model_name": "gpt-4"}
|
||||||
|
}
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> The `/api/langgraph/*` endpoints bypass DeerFlow's Gateway and inherit
|
||||||
|
> LangGraph's native `recursion_limit` default of 25, which is too low for
|
||||||
|
> plan-mode or subagent runs. Set `config.recursion_limit` explicitly — see
|
||||||
|
> the [Create Run](#create-run) section for details.
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# Docker Test Gap (Section 七 7.4)
|
||||||
|
|
||||||
|
This file documents the only **un-executed** test cases from
|
||||||
|
`backend/docs/AUTH_TEST_PLAN.md` after the full release validation pass.
|
||||||
|
|
||||||
|
## Why this gap exists
|
||||||
|
|
||||||
|
The release validation environment (sg_dev: `10.251.229.92`) **does not have
|
||||||
|
a Docker daemon installed**. The TC-DOCKER cases are container-runtime
|
||||||
|
behavior tests that need an actual Docker engine to spin up
|
||||||
|
`docker/docker-compose.yaml` services.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ ssh sg_dev "which docker; docker --version"
|
||||||
|
# (empty)
|
||||||
|
# bash: docker: command not found
|
||||||
|
```
|
||||||
|
|
||||||
|
All other test plan sections were executed against either:
|
||||||
|
- The local dev box (Mac, all services running locally), or
|
||||||
|
- The deployed sg_dev instance (gateway + frontend + nginx via SSH tunnel)
|
||||||
|
|
||||||
|
## Cases not executed
|
||||||
|
|
||||||
|
| Case | Title | What it covers | Why not run |
|
||||||
|
|---|---|---|---|
|
||||||
|
| TC-DOCKER-01 | `users.db` volume persistence | Verify the `DEER_FLOW_HOME` bind mount survives container restart | needs `docker compose up` |
|
||||||
|
| TC-DOCKER-02 | Session persistence across container restart | `AUTH_JWT_SECRET` env var keeps cookies valid after `docker compose down && up` | needs `docker compose down/up` |
|
||||||
|
| TC-DOCKER-03 | Per-worker rate limiter divergence | Confirms in-process `_login_attempts` dict doesn't share state across `gunicorn` workers (4 by default in the compose file); known limitation, documented | needs multi-worker container |
|
||||||
|
| TC-DOCKER-04 | IM channels skip AuthMiddleware | Verify Feishu/Slack/Telegram dispatchers run in-container against `http://langgraph:2024` without going through nginx | needs `docker logs` |
|
||||||
|
| TC-DOCKER-05 | Admin credentials surfacing | **Updated post-simplify** — was "log scrape", now "0600 credential file in `DEER_FLOW_HOME`". The file-based behavior is already validated by TC-1.1 + TC-UPG-13 on sg_dev (non-Docker), so the only Docker-specific gap is verifying the volume mount carries the file out to the host | needs container + host volume |
|
||||||
|
| TC-DOCKER-06 | Gateway-mode Docker deploy | `./scripts/deploy.sh --gateway` produces a 3-container topology (no `langgraph` container); same auth flow as standard mode | needs `docker compose --profile gateway` |
|
||||||
|
|
||||||
|
## Coverage already provided by non-Docker tests
|
||||||
|
|
||||||
|
The **auth-relevant** behavior in each Docker case is already exercised by
|
||||||
|
the test cases that ran on sg_dev or local:
|
||||||
|
|
||||||
|
| Docker case | Auth behavior covered by |
|
||||||
|
|---|---|
|
||||||
|
| TC-DOCKER-01 (volume persistence) | TC-REENT-01 on sg_dev (admin row survives gateway restart) — same SQLite file, just no container layer between |
|
||||||
|
| TC-DOCKER-02 (session persistence) | TC-API-02/03/06 (cookie roundtrip), plus TC-REENT-04 (multi-cookie) — JWT verification is process-state-free, container restart is equivalent to `pkill uvicorn && uv run uvicorn` |
|
||||||
|
| TC-DOCKER-03 (per-worker rate limit) | TC-GW-04 + TC-REENT-09 (single-worker rate limit + 5min expiry). The cross-worker divergence is an architectural property of the in-memory dict; no auth code path differs |
|
||||||
|
| TC-DOCKER-04 (IM channels skip auth) | Code-level only: `app/channels/manager.py` uses `langgraph_sdk` directly with no cookie handling. The langgraph_auth handler is bypassed by going through SDK, not HTTP |
|
||||||
|
| TC-DOCKER-05 (credential surfacing) | TC-1.1 on sg_dev (file at `~/deer-flow/backend/.deer-flow/admin_initial_credentials.txt`, mode 0600, password 22 chars) — the only Docker-unique step is whether the bind mount projects this path onto the host, which is a `docker compose` config check, not a runtime behavior change |
|
||||||
|
| TC-DOCKER-06 (gateway-mode container) | Section 七 7.2 covered by TC-GW-01..05 + Section 二 (gateway-mode auth flow on sg_dev) — same Gateway code, container is just a packaging change |
|
||||||
|
|
||||||
|
## Reproduction steps when Docker becomes available
|
||||||
|
|
||||||
|
Anyone with `docker` + `docker compose` installed can reproduce the gap by
|
||||||
|
running the test plan section verbatim. Pre-flight:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Required on the host
|
||||||
|
docker --version # >=24.x
|
||||||
|
docker compose version # plugin >=2.x
|
||||||
|
|
||||||
|
# Required env var (otherwise sessions reset on every container restart)
|
||||||
|
echo "AUTH_JWT_SECRET=$(python3 -c 'import secrets; print(secrets.token_urlsafe(32))')" \
|
||||||
|
>> .env
|
||||||
|
|
||||||
|
# Optional: pin DEER_FLOW_HOME to a stable host path
|
||||||
|
echo "DEER_FLOW_HOME=$HOME/deer-flow-data" >> .env
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run TC-DOCKER-01..06 from the test plan as written.
|
||||||
|
|
||||||
|
## Decision log
|
||||||
|
|
||||||
|
- **Not blocking the release.** The auth-relevant behavior in every Docker
|
||||||
|
case has an already-validated equivalent on bare metal. The gap is purely
|
||||||
|
about *container packaging* details (bind mounts, multi-worker, log
|
||||||
|
collection), not about whether the auth code paths work.
|
||||||
|
- **TC-DOCKER-05 was updated in place** in `AUTH_TEST_PLAN.md` to reflect
|
||||||
|
the post-simplify reality (credentials file → 0600 file, no log leak).
|
||||||
|
The old "grep 'Password:' in docker logs" expectation would have failed
|
||||||
|
silently and given a false sense of coverage.
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,129 @@
|
|||||||
|
# Authentication Upgrade Guide
|
||||||
|
|
||||||
|
DeerFlow 内置了认证模块。本文档面向从无认证版本升级的用户。
|
||||||
|
|
||||||
|
## 核心概念
|
||||||
|
|
||||||
|
认证模块采用**始终强制**策略:
|
||||||
|
|
||||||
|
- 首次启动时自动创建 admin 账号,随机密码打印到控制台日志
|
||||||
|
- 认证从一开始就是强制的,无竞争窗口
|
||||||
|
- 历史对话(升级前创建的 thread)自动迁移到 admin 名下
|
||||||
|
|
||||||
|
## 升级步骤
|
||||||
|
|
||||||
|
### 1. 更新代码
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull origin main
|
||||||
|
cd backend && make install
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. 首次启动
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make dev
|
||||||
|
```
|
||||||
|
|
||||||
|
控制台会输出:
|
||||||
|
|
||||||
|
```
|
||||||
|
============================================================
|
||||||
|
Admin account created on first boot
|
||||||
|
Email: admin@deerflow.dev
|
||||||
|
Password: aB3xK9mN_pQ7rT2w
|
||||||
|
Change it after login: Settings → Account
|
||||||
|
============================================================
|
||||||
|
```
|
||||||
|
|
||||||
|
如果未登录就重启了服务,不用担心——只要 setup 未完成,每次启动都会重置密码并重新打印到控制台。
|
||||||
|
|
||||||
|
### 3. 登录
|
||||||
|
|
||||||
|
访问 `http://localhost:2026/login`,使用控制台输出的邮箱和密码登录。
|
||||||
|
|
||||||
|
### 4. 修改密码
|
||||||
|
|
||||||
|
登录后进入 Settings → Account → Change Password。
|
||||||
|
|
||||||
|
### 5. 添加用户(可选)
|
||||||
|
|
||||||
|
其他用户通过 `/login` 页面注册,自动获得 **user** 角色。每个用户只能看到自己的对话。
|
||||||
|
|
||||||
|
## 安全机制
|
||||||
|
|
||||||
|
| 机制 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| JWT HttpOnly Cookie | Token 不暴露给 JavaScript,防止 XSS 窃取 |
|
||||||
|
| CSRF Double Submit Cookie | 所有 POST/PUT/DELETE 请求需携带 `X-CSRF-Token` |
|
||||||
|
| bcrypt 密码哈希 | 密码不以明文存储 |
|
||||||
|
| 多租户隔离 | 用户只能访问自己的 thread |
|
||||||
|
| HTTPS 自适应 | 检测 `x-forwarded-proto`,自动设置 `Secure` cookie 标志 |
|
||||||
|
|
||||||
|
## 常见操作
|
||||||
|
|
||||||
|
### 忘记密码
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
|
||||||
|
# 重置 admin 密码
|
||||||
|
python -m app.gateway.auth.reset_admin
|
||||||
|
|
||||||
|
# 重置指定用户密码
|
||||||
|
python -m app.gateway.auth.reset_admin --email user@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
会输出新的随机密码。
|
||||||
|
|
||||||
|
### 完全重置
|
||||||
|
|
||||||
|
删除用户数据库,重启后自动创建新 admin:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm -f backend/.deer-flow/users.db
|
||||||
|
# 重启服务,控制台输出新密码
|
||||||
|
```
|
||||||
|
|
||||||
|
## 数据存储
|
||||||
|
|
||||||
|
| 文件 | 内容 |
|
||||||
|
|------|------|
|
||||||
|
| `.deer-flow/users.db` | SQLite 用户数据库(密码哈希、角色) |
|
||||||
|
| `.env` 中的 `AUTH_JWT_SECRET` | JWT 签名密钥(未设置时自动生成临时密钥,重启后 session 失效) |
|
||||||
|
|
||||||
|
### 生产环境建议
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 生成持久化 JWT 密钥,避免重启后所有用户需重新登录
|
||||||
|
python -c "import secrets; print(secrets.token_urlsafe(32))"
|
||||||
|
# 将输出添加到 .env:
|
||||||
|
# AUTH_JWT_SECRET=<生成的密钥>
|
||||||
|
```
|
||||||
|
|
||||||
|
## API 端点
|
||||||
|
|
||||||
|
| 端点 | 方法 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `/api/v1/auth/login/local` | POST | 邮箱密码登录(OAuth2 form) |
|
||||||
|
| `/api/v1/auth/register` | POST | 注册新用户(user 角色) |
|
||||||
|
| `/api/v1/auth/logout` | POST | 登出(清除 cookie) |
|
||||||
|
| `/api/v1/auth/me` | GET | 获取当前用户信息 |
|
||||||
|
| `/api/v1/auth/change-password` | POST | 修改密码 |
|
||||||
|
| `/api/v1/auth/setup-status` | GET | 检查 admin 是否存在 |
|
||||||
|
|
||||||
|
## 兼容性
|
||||||
|
|
||||||
|
- **标准模式**(`make dev`):完全兼容,admin 自动创建
|
||||||
|
- **Gateway 模式**(`make dev-pro`):完全兼容
|
||||||
|
- **Docker 部署**:完全兼容,`.deer-flow/users.db` 需持久化卷挂载
|
||||||
|
- **IM 渠道**(Feishu/Slack/Telegram):通过 LangGraph SDK 通信,不经过认证层
|
||||||
|
- **DeerFlowClient**(嵌入式):不经过 HTTP,不受认证影响
|
||||||
|
|
||||||
|
## 故障排查
|
||||||
|
|
||||||
|
| 症状 | 原因 | 解决 |
|
||||||
|
|------|------|------|
|
||||||
|
| 启动后没看到密码 | admin 已存在(非首次启动) | 用 `reset_admin` 重置,或删 `users.db` |
|
||||||
|
| 登录后 POST 返回 403 | CSRF token 缺失 | 确认前端已更新 |
|
||||||
|
| 重启后需要重新登录 | `AUTH_JWT_SECRET` 未持久化 | 在 `.env` 中设置固定密钥 |
|
||||||
@@ -248,7 +248,7 @@ def after_agent(self, state: TitleMiddlewareState, runtime: Runtime) -> dict | N
|
|||||||
- [`packages/harness/deerflow/agents/thread_state.py`](../packages/harness/deerflow/agents/thread_state.py) - ThreadState 定义
|
- [`packages/harness/deerflow/agents/thread_state.py`](../packages/harness/deerflow/agents/thread_state.py) - ThreadState 定义
|
||||||
- [`packages/harness/deerflow/agents/middlewares/title_middleware.py`](../packages/harness/deerflow/agents/middlewares/title_middleware.py) - TitleMiddleware 实现
|
- [`packages/harness/deerflow/agents/middlewares/title_middleware.py`](../packages/harness/deerflow/agents/middlewares/title_middleware.py) - TitleMiddleware 实现
|
||||||
- [`packages/harness/deerflow/config/title_config.py`](../packages/harness/deerflow/config/title_config.py) - 配置管理
|
- [`packages/harness/deerflow/config/title_config.py`](../packages/harness/deerflow/config/title_config.py) - 配置管理
|
||||||
- [`config.yaml`](../config.yaml) - 配置文件
|
- [`config.yaml`](../../config.example.yaml) - 配置文件
|
||||||
- [`packages/harness/deerflow/agents/lead_agent/agent.py`](../packages/harness/deerflow/agents/lead_agent/agent.py) - Middleware 注册
|
- [`packages/harness/deerflow/agents/lead_agent/agent.py`](../packages/harness/deerflow/agents/lead_agent/agent.py) - Middleware 注册
|
||||||
|
|
||||||
## 参考资料
|
## 参考资料
|
||||||
|
|||||||
@@ -192,8 +192,8 @@ tools:
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Built-in Tools**:
|
**Built-in Tools**:
|
||||||
- `web_search` - Search the web (Tavily)
|
- `web_search` - Search the web (DuckDuckGo, Tavily, Exa, InfoQuest, Firecrawl)
|
||||||
- `web_fetch` - Fetch web pages (Jina AI)
|
- `web_fetch` - Fetch web pages (Jina AI, Exa, InfoQuest, Firecrawl)
|
||||||
- `ls` - List directory contents
|
- `ls` - List directory contents
|
||||||
- `read_file` - Read file contents
|
- `read_file` - Read file contents
|
||||||
- `write_file` - Write file contents
|
- `write_file` - Write file contents
|
||||||
@@ -257,6 +257,8 @@ sandbox:
|
|||||||
read_only: false
|
read_only: false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
When you configure `sandbox.mounts`, DeerFlow exposes those `container_path` values in the agent prompt so the agent can discover and operate on mounted directories directly instead of assuming everything must live under `/mnt/user-data`.
|
||||||
|
|
||||||
### Skills
|
### Skills
|
||||||
|
|
||||||
Configure the skills directory for specialized workflows:
|
Configure the skills directory for specialized workflows:
|
||||||
@@ -276,6 +278,12 @@ skills:
|
|||||||
- Skills are automatically discovered and loaded
|
- Skills are automatically discovered and loaded
|
||||||
- Available in both local and Docker sandbox via path mapping
|
- Available in both local and Docker sandbox via path mapping
|
||||||
|
|
||||||
|
**Per-Agent Skill Filtering**:
|
||||||
|
Custom agents can restrict which skills they load by defining a `skills` field in their `config.yaml` (located at `workspace/agents/<agent_name>/config.yaml`):
|
||||||
|
- **Omitted or `null`**: Loads all globally enabled skills (default fallback).
|
||||||
|
- **`[]` (empty list)**: Disables all skills for this specific agent.
|
||||||
|
- **`["skill-name"]`**: Loads only the explicitly specified skills.
|
||||||
|
|
||||||
### Title Generation
|
### Title Generation
|
||||||
|
|
||||||
Automatic conversation title generation:
|
Automatic conversation title generation:
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ This directory contains detailed documentation for the DeerFlow backend.
|
|||||||
|
|
||||||
| Document | Description |
|
| Document | Description |
|
||||||
|----------|-------------|
|
|----------|-------------|
|
||||||
|
| [STREAMING.md](STREAMING.md) | Token-level streaming design: Gateway vs DeerFlowClient paths, `stream_mode` semantics, per-id dedup |
|
||||||
| [FILE_UPLOAD.md](FILE_UPLOAD.md) | File upload functionality |
|
| [FILE_UPLOAD.md](FILE_UPLOAD.md) | File upload functionality |
|
||||||
| [PATH_EXAMPLES.md](PATH_EXAMPLES.md) | Path types and usage examples |
|
| [PATH_EXAMPLES.md](PATH_EXAMPLES.md) | Path types and usage examples |
|
||||||
| [summarization.md](summarization.md) | Context summarization feature |
|
| [summarization.md](summarization.md) | Context summarization feature |
|
||||||
@@ -47,6 +48,7 @@ docs/
|
|||||||
├── PATH_EXAMPLES.md # Path usage examples
|
├── PATH_EXAMPLES.md # Path usage examples
|
||||||
├── summarization.md # Summarization feature
|
├── summarization.md # Summarization feature
|
||||||
├── plan_mode_usage.md # Plan mode feature
|
├── plan_mode_usage.md # Plan mode feature
|
||||||
|
├── STREAMING.md # Token-level streaming design
|
||||||
├── AUTO_TITLE_GENERATION.md # Title generation
|
├── AUTO_TITLE_GENERATION.md # Title generation
|
||||||
├── TITLE_GENERATION_IMPLEMENTATION.md # Title implementation details
|
├── TITLE_GENERATION_IMPLEMENTATION.md # Title implementation details
|
||||||
└── TODO.md # Roadmap and issues
|
└── TODO.md # Roadmap and issues
|
||||||
|
|||||||
@@ -0,0 +1,351 @@
|
|||||||
|
# DeerFlow 流式输出设计
|
||||||
|
|
||||||
|
本文档解释 DeerFlow 是如何把 LangGraph agent 的事件流端到端送到两类消费者(HTTP 客户端、嵌入式 Python 调用方)的:两条路径为什么**必须**并存、它们各自的契约是什么、以及设计里那些 non-obvious 的不变式。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## TL;DR
|
||||||
|
|
||||||
|
- DeerFlow 有**两条并行**的流式路径:**Gateway 路径**(async / HTTP SSE / JSON 序列化)服务浏览器和 IM 渠道;**DeerFlowClient 路径**(sync / in-process / 原生 LangChain 对象)服务 Jupyter、脚本、测试。它们**无法合并**——消费者模型不同。
|
||||||
|
- 两条路径都从 `create_agent()` 工厂出发,核心都是订阅 LangGraph 的 `stream_mode=["values", "messages", "custom"]`。`values` 是节点级 state 快照,`messages` 是 LLM token 级 delta,`custom` 是显式 `StreamWriter` 事件。**这三种模式不是详细程度的梯度,是三个独立的事件源**,要 token 流就必须显式订阅 `messages`。
|
||||||
|
- 嵌入式 client 为每个 `stream()` 调用维护三个 `set[str]`:`seen_ids` / `streamed_ids` / `counted_usage_ids`。三者看起来相似但管理**三个独立的不变式**,不能合并。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 为什么有两条流式路径
|
||||||
|
|
||||||
|
两条路径服务的消费者模型根本不同:
|
||||||
|
|
||||||
|
| 维度 | Gateway 路径 | DeerFlowClient 路径 |
|
||||||
|
|---|---|---|
|
||||||
|
| 入口 | FastAPI `/runs/stream` endpoint | `DeerFlowClient.stream(message)` |
|
||||||
|
| 触发层 | `runtime/runs/worker.py::run_agent` | `packages/harness/deerflow/client.py::DeerFlowClient.stream` |
|
||||||
|
| 执行模型 | `async def` + `agent.astream()` | sync generator + `agent.stream()` |
|
||||||
|
| 事件传输 | `StreamBridge`(asyncio Queue)+ `sse_consumer` | 直接 `yield` |
|
||||||
|
| 序列化 | `serialize(chunk)` → 纯 JSON dict,匹配 LangGraph Platform wire 格式 | `StreamEvent.data`,携带原生 LangChain 对象 |
|
||||||
|
| 消费者 | 前端 `useStream` React hook、飞书/Slack/Telegram channel、LangGraph SDK 客户端 | Jupyter notebook、集成测试、内部 Python 脚本 |
|
||||||
|
| 生命周期管理 | `RunManager`:run_id 跟踪、disconnect 语义、multitask 策略、heartbeat | 无;函数返回即结束 |
|
||||||
|
| 断连恢复 | `Last-Event-ID` SSE 重连 | 无需要 |
|
||||||
|
|
||||||
|
**两条路径的存在是 DRY 的刻意妥协**:Gateway 的全部基础设施(async + Queue + JSON + RunManager)**都是为了跨网络边界把事件送给 HTTP 消费者**。当生产者(agent)和消费者(Python 调用栈)在同一个进程时,这整套东西都是纯开销。
|
||||||
|
|
||||||
|
### 为什么不能让 DeerFlowClient 复用 Gateway
|
||||||
|
|
||||||
|
曾经考虑过三种复用方案,都被否决:
|
||||||
|
|
||||||
|
1. **让 `client.stream()` 变成 `async def client.astream()`**
|
||||||
|
breaking change。用户用不上的 `async for` / `asyncio.run()` 要硬塞进 Jupyter notebook 和同步脚本。DeerFlowClient 的一大卖点("把 agent 当普通函数调用")直接消失。
|
||||||
|
|
||||||
|
2. **在 `client.stream()` 内部起一个独立事件循环线程,用 `StreamBridge` 在 sync/async 之间做桥接**
|
||||||
|
引入线程池、队列、信号量。为了"消除重复",把**复杂度**代替代码行数引进来。是典型的"wrong abstraction"——开销高于复用收益。
|
||||||
|
|
||||||
|
3. **让 `run_agent` 自己兼容 sync mode**
|
||||||
|
给 Gateway 加一条用不到的死分支,污染 worker.py 的焦点。
|
||||||
|
|
||||||
|
所以两条路径的事件处理逻辑会**相似但不共享**。这是刻意设计,不是疏忽。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## LangGraph `stream_mode` 三层语义
|
||||||
|
|
||||||
|
LangGraph 的 `agent.stream(stream_mode=[...])` 是**多路复用**接口:一次订阅多个 mode,每个 mode 是一个独立的事件源。三种核心 mode:
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
classDef values fill:#B8C5D1,stroke:#5A6B7A,color:#2C3E50
|
||||||
|
classDef messages fill:#C9B8A8,stroke:#7A6B5A,color:#2C3E50
|
||||||
|
classDef custom fill:#B5C4B1,stroke:#5A7A5A,color:#2C3E50
|
||||||
|
|
||||||
|
subgraph LG["LangGraph agent graph"]
|
||||||
|
direction TB
|
||||||
|
Node1["node: LLM call"]
|
||||||
|
Node2["node: tool call"]
|
||||||
|
Node3["node: reducer"]
|
||||||
|
end
|
||||||
|
|
||||||
|
LG -->|"每个节点完成后"| V["values: 完整 state 快照"]
|
||||||
|
Node1 -->|"LLM 每产生一个 token"| M["messages: (AIMessageChunk, meta)"]
|
||||||
|
Node1 -->|"StreamWriter.write()"| C["custom: 任意 dict"]
|
||||||
|
|
||||||
|
class V values
|
||||||
|
class M messages
|
||||||
|
class C custom
|
||||||
|
```
|
||||||
|
|
||||||
|
| Mode | 发射时机 | Payload | 粒度 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `values` | 每个 graph 节点完成后 | 完整 state dict(title、messages、artifacts)| 节点级 |
|
||||||
|
| `messages` | LLM 每次 yield 一个 chunk;tool 节点完成时 | `(AIMessageChunk \| ToolMessage, metadata_dict)` | token 级 |
|
||||||
|
| `custom` | 用户代码显式调用 `StreamWriter.write()` | 任意 dict | 应用定义 |
|
||||||
|
|
||||||
|
### 两套命名的由来
|
||||||
|
|
||||||
|
同一件事在**三个协议层**有三个名字:
|
||||||
|
|
||||||
|
```
|
||||||
|
Application HTTP / SSE LangGraph Graph
|
||||||
|
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
|
||||||
|
│ frontend │ │ LangGraph │ │ agent.astream│
|
||||||
|
│ useStream │──"messages- │ Platform SDK │──"messages"──│ graph.astream│
|
||||||
|
│ Feishu IM │ tuple"──────│ HTTP wire │ │ │
|
||||||
|
└──────────────┘ └──────────────┘ └──────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Graph 层**(`agent.stream` / `agent.astream`):LangGraph Python 直接 API,mode 叫 **`"messages"`**。
|
||||||
|
- **Platform SDK 层**(`langgraph-sdk` HTTP client):跨进程 HTTP 契约,mode 叫 **`"messages-tuple"`**。
|
||||||
|
- **Gateway worker** 显式做翻译:`if m == "messages-tuple": lg_modes.append("messages")`(`runtime/runs/worker.py:117-121`)。
|
||||||
|
|
||||||
|
**后果**:`DeerFlowClient.stream()` 直接调 `agent.stream()`(Graph 层),所以必须传 `"messages"`。`app/channels/manager.py` 通过 `langgraph-sdk` 走 HTTP SDK,所以传 `"messages-tuple"`。**这两个字符串不能互相替代**,也不能抽成"一个共享常量"——它们是不同协议层的 type alias,共享只会让某一层说不是它母语的话。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Gateway 路径:async + HTTP SSE
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant Client as HTTP Client
|
||||||
|
participant API as FastAPI<br/>thread_runs.py
|
||||||
|
participant Svc as services.py<br/>start_run
|
||||||
|
participant Worker as worker.py<br/>run_agent (async)
|
||||||
|
participant Bridge as StreamBridge<br/>(asyncio.Queue)
|
||||||
|
participant Agent as LangGraph<br/>agent.astream
|
||||||
|
participant SSE as sse_consumer
|
||||||
|
|
||||||
|
Client->>API: POST /runs/stream
|
||||||
|
API->>Svc: start_run(body)
|
||||||
|
Svc->>Bridge: create bridge
|
||||||
|
Svc->>Worker: asyncio.create_task(run_agent(...))
|
||||||
|
Svc-->>API: StreamingResponse(sse_consumer)
|
||||||
|
API-->>Client: event-stream opens
|
||||||
|
|
||||||
|
par worker (producer)
|
||||||
|
Worker->>Agent: astream(stream_mode=lg_modes)
|
||||||
|
loop 每个 chunk
|
||||||
|
Agent-->>Worker: (mode, chunk)
|
||||||
|
Worker->>Bridge: publish(run_id, event, serialize(chunk))
|
||||||
|
end
|
||||||
|
Worker->>Bridge: publish_end(run_id)
|
||||||
|
and sse_consumer (consumer)
|
||||||
|
SSE->>Bridge: subscribe(run_id)
|
||||||
|
loop 每个 event
|
||||||
|
Bridge-->>SSE: StreamEvent
|
||||||
|
SSE-->>Client: "event: <name>\ndata: <json>\n\n"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
关键组件:
|
||||||
|
|
||||||
|
- `runtime/runs/worker.py::run_agent` — 在 `asyncio.Task` 里跑 `agent.astream()`,把每个 chunk 通过 `serialize(chunk, mode=mode)` 转成 JSON,再 `bridge.publish()`。
|
||||||
|
- `runtime/stream_bridge` — 抽象 Queue。`publish/subscribe` 解耦生产者和消费者,支持 `Last-Event-ID` 重连、心跳、多订阅者 fan-out。
|
||||||
|
- `app/gateway/services.py::sse_consumer` — 从 bridge 订阅,格式化为 SSE wire 帧。
|
||||||
|
- `runtime/serialization.py::serialize` — mode-aware 序列化;`messages` mode 下 `serialize_messages_tuple` 把 `(chunk, metadata)` 转成 `[chunk.model_dump(), metadata]`。
|
||||||
|
|
||||||
|
**`StreamBridge` 的存在价值**:当生产者(`run_agent` 任务)和消费者(HTTP 连接)在不同的 asyncio task 里运行时,需要一个可以跨 task 传递事件的中介。Queue 同时还承担断连重连的 buffer 和多订阅者的 fan-out。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## DeerFlowClient 路径:sync + in-process
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant User as Python caller
|
||||||
|
participant Client as DeerFlowClient.stream
|
||||||
|
participant Agent as LangGraph<br/>agent.stream (sync)
|
||||||
|
|
||||||
|
User->>Client: for event in client.stream("hi"):
|
||||||
|
Client->>Agent: stream(stream_mode=["values","messages","custom"])
|
||||||
|
loop 每个 chunk
|
||||||
|
Agent-->>Client: (mode, chunk)
|
||||||
|
Client->>Client: 分发 mode<br/>构建 StreamEvent
|
||||||
|
Client-->>User: yield StreamEvent
|
||||||
|
end
|
||||||
|
Client-->>User: yield StreamEvent(type="end")
|
||||||
|
```
|
||||||
|
|
||||||
|
对比之下,sync 路径的每个环节都是显著更少的移动部件:
|
||||||
|
|
||||||
|
- 没有 `RunManager` —— 一次 `stream()` 调用对应一次生命周期,无需 run_id。
|
||||||
|
- 没有 `StreamBridge` —— 直接 `yield`,生产和消费在同一个 Python 调用栈,不需要跨 task 中介。
|
||||||
|
- 没有 JSON 序列化 —— `StreamEvent.data` 直接装原生 LangChain 对象(`AIMessage.content`、`usage_metadata` 的 `UsageMetadata` TypedDict)。Jupyter 用户拿到的是真正的类型,不是匿名 dict。
|
||||||
|
- 没有 asyncio —— 调用者可以直接 `for event in ...`,不必写 `async for`。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 消费语义:delta vs cumulative
|
||||||
|
|
||||||
|
LangGraph `messages` mode 给出的是 **delta**:每个 `AIMessageChunk.content` 只包含这一次新 yield 的 token,**不是**从头的累计文本。
|
||||||
|
|
||||||
|
这个语义和 LangChain 的 `fs2 Stream` 风格一致:**上游发增量,下游负责累加**。Gateway 路径里前端 `useStream` React hook 自己维护累加器;DeerFlowClient 路径里 `chat()` 方法替调用者做累加。
|
||||||
|
|
||||||
|
### `DeerFlowClient.chat()` 的 O(n) 累加器
|
||||||
|
|
||||||
|
```python
|
||||||
|
chunks: dict[str, list[str]] = {}
|
||||||
|
last_id: str = ""
|
||||||
|
for event in self.stream(message, thread_id=thread_id, **kwargs):
|
||||||
|
if event.type == "messages-tuple" and event.data.get("type") == "ai":
|
||||||
|
msg_id = event.data.get("id") or ""
|
||||||
|
delta = event.data.get("content", "")
|
||||||
|
if delta:
|
||||||
|
chunks.setdefault(msg_id, []).append(delta)
|
||||||
|
last_id = msg_id
|
||||||
|
return "".join(chunks.get(last_id, ()))
|
||||||
|
```
|
||||||
|
|
||||||
|
**为什么不是 `buffers[id] = buffers.get(id,"") + delta`**:CPython 的字符串 in-place concat 优化仅在 refcount=1 且 LHS 是 local name 时生效;这里字符串存在 dict 里被 reassign,优化失效,每次都是 O(n) 拷贝 → 总体 O(n²)。实测 50 KB / 5000 chunk 的回复要 100-300ms 纯拷贝开销。用 `list` + `"".join()` 是 O(n)。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 三个 id set 为什么不能合并
|
||||||
|
|
||||||
|
`DeerFlowClient.stream()` 在一次调用生命周期内维护三个 `set[str]`:
|
||||||
|
|
||||||
|
```python
|
||||||
|
seen_ids: set[str] = set() # values 路径内部 dedup
|
||||||
|
streamed_ids: set[str] = set() # messages → values 跨模式 dedup
|
||||||
|
counted_usage_ids: set[str] = set() # usage_metadata 幂等计数
|
||||||
|
```
|
||||||
|
|
||||||
|
乍看像是"三份几乎一样的东西",实际每个管**不同的不变式**。
|
||||||
|
|
||||||
|
| Set | 负责的不变式 | 被谁填充 | 被谁查询 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| `seen_ids` | 连续两个 `values` 快照里同一条 message 只生成一个 `messages-tuple` 事件 | values 分支每处理一条消息就加入 | values 分支处理下一条消息前检查 |
|
||||||
|
| `streamed_ids` | 如果一条消息已经通过 `messages` 模式 token 级流过,values 快照到达时**不要**再合成一次完整 `messages-tuple` | messages 分支每发一个 AI/tool 事件就加入 | values 分支看到消息时检查 |
|
||||||
|
| `counted_usage_ids` | 同一个 `usage_metadata` 在 messages 末尾 chunk 和 values 快照的 final AIMessage 里各带一份,**累计总量只算一次** | `_account_usage()` 每次接受 usage 就加入 | `_account_usage()` 每次调用时检查 |
|
||||||
|
|
||||||
|
### 为什么不能只用一个 set
|
||||||
|
|
||||||
|
关键观察:**同一个 message id 在这三个 set 里的加入时机不同**。
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant M as messages mode
|
||||||
|
participant V as values mode
|
||||||
|
participant SS as streamed_ids
|
||||||
|
participant SU as counted_usage_ids
|
||||||
|
participant SE as seen_ids
|
||||||
|
|
||||||
|
Note over M: 第一个 AI text chunk 到达
|
||||||
|
M->>SS: add(msg_id)
|
||||||
|
Note over M: 最后一个 chunk 带 usage
|
||||||
|
M->>SU: add(msg_id)
|
||||||
|
Note over V: snapshot 到达,包含同一条 AI message
|
||||||
|
V->>SE: add(msg_id)
|
||||||
|
V->>SS: 查询 → 已存在,跳过文本合成
|
||||||
|
V->>SU: 查询 → 已存在,不重复计数
|
||||||
|
```
|
||||||
|
|
||||||
|
- `seen_ids` **永远在 values 快照到达时**加入,所以它是 "values 已处理" 的标记。一条只出现在 messages 流里的消息(罕见但可能),`seen_ids` 里永远没有它。
|
||||||
|
- `streamed_ids` **在 messages 流的第一个有效事件时**加入。一条只通过 values 快照到达的非 AI 消息(HumanMessage、被 truncate 的 tool 消息),`streamed_ids` 里永远没有它。
|
||||||
|
- `counted_usage_ids` **只在看到非空 `usage_metadata` 时**加入。一条完全没有 usage 的消息(tool message、错误消息)永远不会进去。
|
||||||
|
|
||||||
|
**集合包含关系**:`counted_usage_ids ⊆ (streamed_ids ∪ seen_ids)` 大致成立,但**不是严格子集**,因为一条消息可以在 messages 模式流完 text 但**在最后那个带 usage 的 chunk 之前**就被 values snapshot 赶上——此时它已经在 `streamed_ids` 里,但还不在 `counted_usage_ids` 里。把它们合并成一个 dict-of-flags 会让这个微妙的时序依赖**从类型系统里消失**,变成注释里的一句话。三个独立的 set 把不变式显式化了:每个 set 名对应一个可以口头回答的问题。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 端到端:一次真实对话的事件时序
|
||||||
|
|
||||||
|
假设调用 `client.stream("Count from 1 to 15")`,LLM 给出 "one\ntwo\n...\nfifteen"(88 字符),tokenizer 把它拆成 ~35 个 BPE chunk。下面是事件到达序列的精简版:
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
sequenceDiagram
|
||||||
|
participant U as User
|
||||||
|
participant C as DeerFlowClient
|
||||||
|
participant A as LangGraph<br/>agent.stream
|
||||||
|
|
||||||
|
U->>C: stream("Count ... 15")
|
||||||
|
C->>A: stream(mode=["values","messages","custom"])
|
||||||
|
|
||||||
|
A-->>C: ("values", {messages: [HumanMessage]})
|
||||||
|
C-->>U: StreamEvent(type="values", ...)
|
||||||
|
|
||||||
|
Note over A,C: LLM 开始 yield token
|
||||||
|
loop 35 次,约 476ms
|
||||||
|
A-->>C: ("messages", (AIMessageChunk(content="ele"), meta))
|
||||||
|
C->>C: streamed_ids.add(ai-1)
|
||||||
|
C-->>U: StreamEvent(type="messages-tuple",<br/>data={type:ai, content:"ele", id:ai-1})
|
||||||
|
end
|
||||||
|
|
||||||
|
Note over A: LLM finish_reason=stop,最后一个 chunk 带 usage
|
||||||
|
A-->>C: ("messages", (AIMessageChunk(content="", usage_metadata={...}), meta))
|
||||||
|
C->>C: counted_usage_ids.add(ai-1)<br/>(无文本,不 yield)
|
||||||
|
|
||||||
|
A-->>C: ("values", {messages: [..., AIMessage(complete)]})
|
||||||
|
C->>C: ai-1 in streamed_ids → 跳过合成
|
||||||
|
C->>C: 捕获 usage (已在 counted_usage_ids,no-op)
|
||||||
|
C-->>U: StreamEvent(type="values", ...)
|
||||||
|
|
||||||
|
C-->>U: StreamEvent(type="end", data={usage:{...}})
|
||||||
|
```
|
||||||
|
|
||||||
|
关键观察:
|
||||||
|
|
||||||
|
1. 用户看到 **35 个 messages-tuple 事件**,跨越约 476ms,每个事件带一个 token delta 和同一个 `id=ai-1`。
|
||||||
|
2. 最后一个 `values` 快照里的 `AIMessage` **不会**再触发一个完整的 `messages-tuple` 事件——因为 `ai-1 in streamed_ids` 跳过了合成。
|
||||||
|
3. `end` 事件里的 `usage` 正好等于那一份 cumulative usage,**不是它的两倍**——`counted_usage_ids` 在 messages 末尾 chunk 上已经吸收了,values 分支的重复访问是 no-op。
|
||||||
|
4. 消费者拿到的 `content` 是**增量**:"ele" 只包含 3 个字符,不是 "one\ntwo\n...ele"。想要完整文本要按 `id` 累加,`chat()` 已经帮你做了。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 为什么这个设计容易出 bug,以及测试策略
|
||||||
|
|
||||||
|
本文档的直接起因是 bytedance/deer-flow#1969:`DeerFlowClient.stream()` 原本只订阅 `["values", "custom"]`,**漏了 `"messages"`**。结果 `client.stream("hello")` 等价于一次性返回,视觉上和 `chat()` 没区别。
|
||||||
|
|
||||||
|
这类 bug 有三个结构性原因:
|
||||||
|
|
||||||
|
1. **多协议层命名**:`messages` / `messages-tuple` / HTTP SSE `messages` 是同一概念的三个名字。在其中一层出错不会在另外两层报错。
|
||||||
|
2. **多消费者模型**:Gateway 和 DeerFlowClient 是两套独立实现,**没有单一的"订阅哪些 mode"的 single source of truth**。前者订阅对了不代表后者也订阅对了。
|
||||||
|
3. **mock 测试绕开了真实路径**:老测试用 `agent.stream.return_value = iter([dict_chunk, ...])` 喂 values 形状的 dict 模拟 state 快照。这样构造的输入**永远不会进入 `messages` mode 分支**,所以即使 `stream_mode` 里少一个元素,CI 依然全绿。
|
||||||
|
|
||||||
|
### 防御手段
|
||||||
|
|
||||||
|
真正的防线是**显式断言 "messages" mode 被订阅 + 用真实 chunk shape mock**:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# tests/test_client.py::test_messages_mode_emits_token_deltas
|
||||||
|
agent.stream.return_value = iter([
|
||||||
|
("messages", (AIMessageChunk(content="Hel", id="ai-1"), {})),
|
||||||
|
("messages", (AIMessageChunk(content="lo ", id="ai-1"), {})),
|
||||||
|
("messages", (AIMessageChunk(content="world!", id="ai-1"), {})),
|
||||||
|
("values", {"messages": [HumanMessage(...), AIMessage(content="Hello world!", id="ai-1")]}),
|
||||||
|
])
|
||||||
|
# ...
|
||||||
|
assert [e.data["content"] for e in ai_text_events] == ["Hel", "lo ", "world!"]
|
||||||
|
assert len(ai_text_events) == 3 # values snapshot must NOT re-synthesize
|
||||||
|
assert "messages" in agent.stream.call_args.kwargs["stream_mode"]
|
||||||
|
```
|
||||||
|
|
||||||
|
**为什么这比"抽一个共享常量"更有效**:共享常量只能保证"用它的人写对字符串",但新增消费者的人可能根本不知道常量在哪。行为断言强制任何改动都要穿过**实际执行路径**,改回 `["values", "custom"]` 会立刻让 `assert "messages" in ...` 失败。
|
||||||
|
|
||||||
|
### 活体信号:BPE 子词边界
|
||||||
|
|
||||||
|
回归的最终验证是让真实 LLM 数 1-15,然后看是否能在输出里看到 tokenizer 的子词切分:
|
||||||
|
|
||||||
|
```
|
||||||
|
[5.460s] 'ele' / 'ven' eleven 被拆成两个 token
|
||||||
|
[5.508s] 'tw' / 'elve' twelve 拆两个
|
||||||
|
[5.568s] 'th' / 'irteen' thirteen 拆两个
|
||||||
|
[5.623s] 'four'/ 'teen' fourteen 拆两个
|
||||||
|
[5.677s] 'f' / 'if' / 'teen' fifteen 拆三个
|
||||||
|
```
|
||||||
|
|
||||||
|
子词切分是 tokenizer 的外部事实,**无法伪造**。能看到它就说明数据流**逐 chunk** 地穿过了整条管道,没有被任何中间层缓冲成整段。这种"活体信号"在流式系统里是比单元测试更高置信度的证据。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 相关源码定位
|
||||||
|
|
||||||
|
| 关心什么 | 看这里 |
|
||||||
|
|---|---|
|
||||||
|
| DeerFlowClient 嵌入式流 | `packages/harness/deerflow/client.py::DeerFlowClient.stream` |
|
||||||
|
| `chat()` 的 delta 累加器 | `packages/harness/deerflow/client.py::DeerFlowClient.chat` |
|
||||||
|
| Gateway async 流 | `packages/harness/deerflow/runtime/runs/worker.py::run_agent` |
|
||||||
|
| HTTP SSE 帧输出 | `app/gateway/services.py::sse_consumer` / `format_sse` |
|
||||||
|
| 序列化到 wire 格式 | `packages/harness/deerflow/runtime/serialization.py` |
|
||||||
|
| LangGraph mode 命名翻译 | `packages/harness/deerflow/runtime/runs/worker.py:117-121` |
|
||||||
|
| 飞书渠道的增量卡片更新 | `app/channels/manager.py::_handle_streaming_chat` |
|
||||||
|
| Channels 自带的 delta/cumulative 防御性累加 | `app/channels/manager.py::_merge_stream_text` |
|
||||||
|
| Frontend useStream 支持的 mode 集合 | `frontend/src/core/api/stream-mode.ts` |
|
||||||
|
| 核心回归测试 | `backend/tests/test_client.py::TestStream::test_messages_mode_emits_token_deltas` |
|
||||||
@@ -30,7 +30,7 @@
|
|||||||
|
|
||||||
### 2. 配置文件
|
### 2. 配置文件
|
||||||
|
|
||||||
#### [`config.yaml`](../config.yaml)
|
#### [`config.yaml`](../../config.example.yaml)
|
||||||
- ✅ 添加 title 配置段:
|
- ✅ 添加 title 配置段:
|
||||||
```yaml
|
```yaml
|
||||||
title:
|
title:
|
||||||
@@ -51,7 +51,7 @@ title:
|
|||||||
- ✅ 故障排查指南
|
- ✅ 故障排查指南
|
||||||
- ✅ State vs Metadata 对比
|
- ✅ State vs Metadata 对比
|
||||||
|
|
||||||
#### [`BACKEND_TODO.md`](../BACKEND_TODO.md)
|
#### [`TODO.md`](TODO.md)
|
||||||
- ✅ 添加功能完成记录
|
- ✅ 添加功能完成记录
|
||||||
|
|
||||||
### 4. 测试
|
### 4. 测试
|
||||||
|
|||||||
@@ -0,0 +1,446 @@
|
|||||||
|
# [RFC] 在 DeerFlow 中增加 `grep` 与 `glob` 文件搜索工具
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
我认为这个方向是对的,而且值得做。
|
||||||
|
|
||||||
|
如果 DeerFlow 想更接近 Claude Code 这类 coding agent 的实际工作流,仅有 `ls` / `read_file` / `write_file` / `str_replace` 还不够。模型在进入修改前,通常还需要两类能力:
|
||||||
|
|
||||||
|
- `glob`: 快速按路径模式找文件
|
||||||
|
- `grep`: 快速按内容模式找候选位置
|
||||||
|
|
||||||
|
这两类工具的价值,不是“功能上 bash 也能做”,而是它们能以更低 token 成本、更强约束、更稳定的输出格式,替代模型频繁走 `bash find` / `bash grep` / `rg` 的习惯。
|
||||||
|
|
||||||
|
但前提是实现方式要对:**它们应该是只读、结构化、受限、可审计的原生工具,而不是对 shell 命令的简单包装。**
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
当前 DeerFlow 的文件工具层主要覆盖:
|
||||||
|
|
||||||
|
- `ls`: 浏览目录结构
|
||||||
|
- `read_file`: 读取文件内容
|
||||||
|
- `write_file`: 写文件
|
||||||
|
- `str_replace`: 做局部字符串替换
|
||||||
|
- `bash`: 兜底执行命令
|
||||||
|
|
||||||
|
这套能力能完成任务,但在代码库探索阶段效率不高。
|
||||||
|
|
||||||
|
典型问题:
|
||||||
|
|
||||||
|
1. 模型想找 “所有 `*.tsx` 的 page 文件” 时,只能反复 `ls` 多层目录,或者退回 `bash find`
|
||||||
|
2. 模型想找 “某个 symbol / 文案 / 配置键在哪里出现” 时,只能逐文件 `read_file`,或者退回 `bash grep` / `rg`
|
||||||
|
3. 一旦退回 `bash`,工具调用就失去结构化输出,结果也更难做裁剪、分页、审计和跨 sandbox 一致化
|
||||||
|
4. 对没有开启 host bash 的本地模式,`bash` 甚至可能不可用,此时缺少足够强的只读检索能力
|
||||||
|
|
||||||
|
结论:DeerFlow 现在缺的不是“再多一个 shell 命令”,而是**文件系统检索层**。
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
- 为 agent 提供稳定的路径搜索和内容搜索能力
|
||||||
|
- 减少对 `bash` 的依赖,特别是在仓库探索阶段
|
||||||
|
- 保持与现有 sandbox 安全模型一致
|
||||||
|
- 输出格式结构化,便于模型后续串联 `read_file` / `str_replace`
|
||||||
|
- 让本地 sandbox、容器 sandbox、未来 MCP 文件系统工具都能遵守同一语义
|
||||||
|
|
||||||
|
## Non-Goals
|
||||||
|
|
||||||
|
- 不做通用 shell 兼容层
|
||||||
|
- 不暴露完整 grep/find/rg CLI 语法
|
||||||
|
- 不在第一版支持二进制检索、复杂 PCRE 特性、上下文窗口高亮渲染等重功能
|
||||||
|
- 不把它做成“任意磁盘搜索”,仍然只允许在 DeerFlow 已授权的路径内执行
|
||||||
|
|
||||||
|
## Why This Is Worth Doing
|
||||||
|
|
||||||
|
参考 Claude Code 这一类 agent 的设计思路,`glob` 和 `grep` 的核心价值不是新能力本身,而是把“探索代码库”的常见动作从开放式 shell 降到受控工具层。
|
||||||
|
|
||||||
|
这样有几个直接收益:
|
||||||
|
|
||||||
|
1. **更低的模型负担**
|
||||||
|
模型不需要自己拼 `find`, `grep`, `rg`, `xargs`, quoting 等命令细节。
|
||||||
|
|
||||||
|
2. **更稳定的跨环境行为**
|
||||||
|
本地、Docker、AIO sandbox 不必依赖容器里是否装了 `rg`,也不会因为 shell 差异导致行为漂移。
|
||||||
|
|
||||||
|
3. **更强的安全与审计**
|
||||||
|
调用参数就是“搜索什么、在哪搜、最多返回多少”,天然比任意命令更容易审计和限流。
|
||||||
|
|
||||||
|
4. **更好的 token 效率**
|
||||||
|
`grep` 返回的是命中摘要而不是整段文件,模型只对少数候选路径再调用 `read_file`。
|
||||||
|
|
||||||
|
5. **对 `tool_search` 友好**
|
||||||
|
当 DeerFlow 持续扩展工具集时,`grep` / `glob` 会成为非常高频的基础工具,值得保留为 built-in,而不是让模型总是退回通用 bash。
|
||||||
|
|
||||||
|
## Proposal
|
||||||
|
|
||||||
|
增加两个 built-in sandbox tools:
|
||||||
|
|
||||||
|
- `glob`
|
||||||
|
- `grep`
|
||||||
|
|
||||||
|
推荐继续放在:
|
||||||
|
|
||||||
|
- `backend/packages/harness/deerflow/sandbox/tools.py`
|
||||||
|
|
||||||
|
并在 `config.example.yaml` 中默认加入 `file:read` 组。
|
||||||
|
|
||||||
|
### 1. `glob` 工具
|
||||||
|
|
||||||
|
用途:按路径模式查找文件或目录。
|
||||||
|
|
||||||
|
建议 schema:
|
||||||
|
|
||||||
|
```python
|
||||||
|
@tool("glob", parse_docstring=True)
|
||||||
|
def glob_tool(
|
||||||
|
runtime: ToolRuntime[ContextT, ThreadState],
|
||||||
|
description: str,
|
||||||
|
pattern: str,
|
||||||
|
path: str,
|
||||||
|
include_dirs: bool = False,
|
||||||
|
max_results: int = 200,
|
||||||
|
) -> str:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
参数语义:
|
||||||
|
|
||||||
|
- `description`: 与现有工具保持一致
|
||||||
|
- `pattern`: glob 模式,例如 `**/*.py`、`src/**/test_*.ts`
|
||||||
|
- `path`: 搜索根目录,必须是绝对路径
|
||||||
|
- `include_dirs`: 是否返回目录
|
||||||
|
- `max_results`: 最大返回条数,防止一次性打爆上下文
|
||||||
|
|
||||||
|
建议返回格式:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Found 3 paths under /mnt/user-data/workspace
|
||||||
|
1. /mnt/user-data/workspace/backend/app.py
|
||||||
|
2. /mnt/user-data/workspace/backend/tests/test_app.py
|
||||||
|
3. /mnt/user-data/workspace/scripts/build.py
|
||||||
|
```
|
||||||
|
|
||||||
|
如果后续想更适合前端消费,也可以改成 JSON 字符串;但第一版为了兼容现有工具风格,返回可读文本即可。
|
||||||
|
|
||||||
|
### 2. `grep` 工具
|
||||||
|
|
||||||
|
用途:按内容模式搜索文件,返回命中位置摘要。
|
||||||
|
|
||||||
|
建议 schema:
|
||||||
|
|
||||||
|
```python
|
||||||
|
@tool("grep", parse_docstring=True)
|
||||||
|
def grep_tool(
|
||||||
|
runtime: ToolRuntime[ContextT, ThreadState],
|
||||||
|
description: str,
|
||||||
|
pattern: str,
|
||||||
|
path: str,
|
||||||
|
glob: str | None = None,
|
||||||
|
literal: bool = False,
|
||||||
|
case_sensitive: bool = False,
|
||||||
|
max_results: int = 100,
|
||||||
|
) -> str:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
参数语义:
|
||||||
|
|
||||||
|
- `pattern`: 搜索词或正则
|
||||||
|
- `path`: 搜索根目录,必须是绝对路径
|
||||||
|
- `glob`: 可选路径过滤,例如 `**/*.py`
|
||||||
|
- `literal`: 为 `True` 时按普通字符串匹配,不解释为正则
|
||||||
|
- `case_sensitive`: 是否大小写敏感
|
||||||
|
- `max_results`: 最大返回命中数,不是文件数
|
||||||
|
|
||||||
|
建议返回格式:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Found 4 matches under /mnt/user-data/workspace
|
||||||
|
/mnt/user-data/workspace/backend/config.py:12: TOOL_GROUPS = [...]
|
||||||
|
/mnt/user-data/workspace/backend/config.py:48: def load_tool_config(...):
|
||||||
|
/mnt/user-data/workspace/backend/tools.py:91: "tool_groups"
|
||||||
|
/mnt/user-data/workspace/backend/tests/test_config.py:22: assert "tool_groups" in data
|
||||||
|
```
|
||||||
|
|
||||||
|
第一版建议只返回:
|
||||||
|
|
||||||
|
- 文件路径
|
||||||
|
- 行号
|
||||||
|
- 命中行摘要
|
||||||
|
|
||||||
|
不返回上下文块,避免结果过大。模型如果需要上下文,再调用 `read_file(path, start_line, end_line)`。
|
||||||
|
|
||||||
|
## Design Principles
|
||||||
|
|
||||||
|
### A. 不做 shell wrapper
|
||||||
|
|
||||||
|
不建议把 `grep` 实现为:
|
||||||
|
|
||||||
|
```python
|
||||||
|
subprocess.run("grep ...")
|
||||||
|
```
|
||||||
|
|
||||||
|
也不建议在容器里直接拼 `find` / `rg` 命令。
|
||||||
|
|
||||||
|
原因:
|
||||||
|
|
||||||
|
- 会引入 shell quoting 和注入面
|
||||||
|
- 会依赖不同 sandbox 内镜像是否安装同一套命令
|
||||||
|
- Windows / macOS / Linux 行为不一致
|
||||||
|
- 很难稳定控制输出条数与格式
|
||||||
|
|
||||||
|
正确方向是:
|
||||||
|
|
||||||
|
- `glob` 使用 Python 标准库路径遍历
|
||||||
|
- `grep` 使用 Python 逐文件扫描
|
||||||
|
- 输出由 DeerFlow 自己格式化
|
||||||
|
|
||||||
|
如果未来为了性能考虑要优先调用 `rg`,也应该封装在 provider 内部,并保证外部语义不变,而不是把 CLI 暴露给模型。
|
||||||
|
|
||||||
|
### B. 继续沿用 DeerFlow 的路径权限模型
|
||||||
|
|
||||||
|
这两个工具必须复用当前 `ls` / `read_file` 的路径校验逻辑:
|
||||||
|
|
||||||
|
- 本地模式走 `validate_local_tool_path(..., read_only=True)`
|
||||||
|
- 支持 `/mnt/skills/...`
|
||||||
|
- 支持 `/mnt/acp-workspace/...`
|
||||||
|
- 支持 thread workspace / uploads / outputs 的虚拟路径解析
|
||||||
|
- 明确拒绝越权路径与 path traversal
|
||||||
|
|
||||||
|
也就是说,它们属于 **file:read**,不是 `bash` 的替代越权入口。
|
||||||
|
|
||||||
|
### C. 结果必须硬限制
|
||||||
|
|
||||||
|
没有硬限制的 `glob` / `grep` 很容易炸上下文。
|
||||||
|
|
||||||
|
建议第一版至少限制:
|
||||||
|
|
||||||
|
- `glob.max_results` 默认 200,最大 1000
|
||||||
|
- `grep.max_results` 默认 100,最大 500
|
||||||
|
- 单行摘要最大长度,例如 200 字符
|
||||||
|
- 二进制文件跳过
|
||||||
|
- 超大文件跳过,例如单文件大于 1 MB 或按配置控制
|
||||||
|
|
||||||
|
此外,命中数超过阈值时应返回:
|
||||||
|
|
||||||
|
- 已展示的条数
|
||||||
|
- 被截断的事实
|
||||||
|
- 建议用户缩小搜索范围
|
||||||
|
|
||||||
|
例如:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Found more than 100 matches, showing first 100. Narrow the path or add a glob filter.
|
||||||
|
```
|
||||||
|
|
||||||
|
### D. 工具语义要彼此互补
|
||||||
|
|
||||||
|
推荐模型工作流应该是:
|
||||||
|
|
||||||
|
1. `glob` 找候选文件
|
||||||
|
2. `grep` 找候选位置
|
||||||
|
3. `read_file` 读局部上下文
|
||||||
|
4. `str_replace` / `write_file` 执行修改
|
||||||
|
|
||||||
|
这样工具边界清晰,也更利于 prompt 中教模型形成稳定习惯。
|
||||||
|
|
||||||
|
## Implementation Approach
|
||||||
|
|
||||||
|
## Option A: 直接在 `sandbox/tools.py` 实现第一版
|
||||||
|
|
||||||
|
这是我推荐的起步方案。
|
||||||
|
|
||||||
|
做法:
|
||||||
|
|
||||||
|
- 在 `sandbox/tools.py` 新增 `glob_tool` 与 `grep_tool`
|
||||||
|
- 在 local sandbox 场景直接使用 Python 文件系统 API
|
||||||
|
- 在非 local sandbox 场景,优先也通过 DeerFlow 自己控制的路径访问层实现
|
||||||
|
|
||||||
|
优点:
|
||||||
|
|
||||||
|
- 改动小
|
||||||
|
- 能尽快验证 agent 效果
|
||||||
|
- 不需要先改 `Sandbox` 抽象
|
||||||
|
|
||||||
|
缺点:
|
||||||
|
|
||||||
|
- `tools.py` 会继续变胖
|
||||||
|
- 如果未来想在 provider 侧做性能优化,需要再抽象一次
|
||||||
|
|
||||||
|
## Option B: 先扩展 `Sandbox` 抽象
|
||||||
|
|
||||||
|
例如新增:
|
||||||
|
|
||||||
|
```python
|
||||||
|
class Sandbox(ABC):
|
||||||
|
def glob(self, path: str, pattern: str, include_dirs: bool = False, max_results: int = 200) -> list[str]:
|
||||||
|
...
|
||||||
|
|
||||||
|
def grep(
|
||||||
|
self,
|
||||||
|
path: str,
|
||||||
|
pattern: str,
|
||||||
|
*,
|
||||||
|
glob: str | None = None,
|
||||||
|
literal: bool = False,
|
||||||
|
case_sensitive: bool = False,
|
||||||
|
max_results: int = 100,
|
||||||
|
) -> list[GrepMatch]:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
优点:
|
||||||
|
|
||||||
|
- 抽象更干净
|
||||||
|
- 容器 / 远程 sandbox 可以各自优化
|
||||||
|
|
||||||
|
缺点:
|
||||||
|
|
||||||
|
- 首次引入成本更高
|
||||||
|
- 需要同步改所有 sandbox provider
|
||||||
|
|
||||||
|
结论:
|
||||||
|
|
||||||
|
**第一版建议走 Option A,等工具价值验证后再下沉到 `Sandbox` 抽象层。**
|
||||||
|
|
||||||
|
## Detailed Behavior
|
||||||
|
|
||||||
|
### `glob` 行为
|
||||||
|
|
||||||
|
- 输入根目录不存在:返回清晰错误
|
||||||
|
- 根路径不是目录:返回清晰错误
|
||||||
|
- 模式非法:返回清晰错误
|
||||||
|
- 结果为空:返回 `No files matched`
|
||||||
|
- 默认忽略项应尽量与当前 `list_dir` 对齐,例如:
|
||||||
|
- `.git`
|
||||||
|
- `node_modules`
|
||||||
|
- `__pycache__`
|
||||||
|
- `.venv`
|
||||||
|
- 构建产物目录
|
||||||
|
|
||||||
|
这里建议抽一个共享 ignore 集,避免 `ls` 与 `glob` 结果风格不一致。
|
||||||
|
|
||||||
|
### `grep` 行为
|
||||||
|
|
||||||
|
- 默认只扫描文本文件
|
||||||
|
- 检测到二进制文件直接跳过
|
||||||
|
- 对超大文件直接跳过或只扫前 N KB
|
||||||
|
- regex 编译失败时返回参数错误
|
||||||
|
- 输出中的路径继续使用虚拟路径,而不是暴露宿主真实路径
|
||||||
|
- 建议默认按文件路径、行号排序,保持稳定输出
|
||||||
|
|
||||||
|
## Prompting Guidance
|
||||||
|
|
||||||
|
如果引入这两个工具,建议同步更新系统提示中的文件操作建议:
|
||||||
|
|
||||||
|
- 查找文件名模式时优先用 `glob`
|
||||||
|
- 查找代码符号、配置项、文案时优先用 `grep`
|
||||||
|
- 只有在工具不足以完成目标时才退回 `bash`
|
||||||
|
|
||||||
|
否则模型仍会习惯性先调用 `bash`。
|
||||||
|
|
||||||
|
## Risks
|
||||||
|
|
||||||
|
### 1. 与 `bash` 能力重叠
|
||||||
|
|
||||||
|
这是事实,但不是问题。
|
||||||
|
|
||||||
|
`ls` 和 `read_file` 也都能被 `bash` 替代,但我们仍然保留它们,因为结构化工具更适合 agent。
|
||||||
|
|
||||||
|
### 2. 性能问题
|
||||||
|
|
||||||
|
在大仓库上,纯 Python `grep` 可能比 `rg` 慢。
|
||||||
|
|
||||||
|
缓解方式:
|
||||||
|
|
||||||
|
- 第一版先加结果上限和文件大小上限
|
||||||
|
- 路径上强制要求 root path
|
||||||
|
- 提供 `glob` 过滤缩小扫描范围
|
||||||
|
- 后续如有必要,在 provider 内部做 `rg` 优化,但保持同一 schema
|
||||||
|
|
||||||
|
### 3. 忽略规则不一致
|
||||||
|
|
||||||
|
如果 `ls` 能看到的路径,`glob` 却看不到,模型会困惑。
|
||||||
|
|
||||||
|
缓解方式:
|
||||||
|
|
||||||
|
- 统一 ignore 规则
|
||||||
|
- 在文档里明确“默认跳过常见依赖和构建目录”
|
||||||
|
|
||||||
|
### 4. 正则搜索过于复杂
|
||||||
|
|
||||||
|
如果第一版就支持大量 grep 方言,边界会很乱。
|
||||||
|
|
||||||
|
缓解方式:
|
||||||
|
|
||||||
|
- 第一版只支持 Python `re`
|
||||||
|
- 并提供 `literal=True` 的简单模式
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### A. 不增加工具,完全依赖 `bash`
|
||||||
|
|
||||||
|
不推荐。
|
||||||
|
|
||||||
|
这会让 DeerFlow 在代码探索体验上持续落后,也削弱无 bash 或受限 bash 场景下的能力。
|
||||||
|
|
||||||
|
### B. 只加 `glob`,不加 `grep`
|
||||||
|
|
||||||
|
不推荐。
|
||||||
|
|
||||||
|
只解决“找文件”,没有解决“找位置”。模型最终还是会退回 `bash grep`。
|
||||||
|
|
||||||
|
### C. 只加 `grep`,不加 `glob`
|
||||||
|
|
||||||
|
也不推荐。
|
||||||
|
|
||||||
|
`grep` 缺少路径模式过滤时,扫描范围经常太大;`glob` 是它的天然前置工具。
|
||||||
|
|
||||||
|
### D. 直接接入 MCP filesystem server 的搜索能力
|
||||||
|
|
||||||
|
短期不推荐作为主路径。
|
||||||
|
|
||||||
|
MCP 可以是补充,但 `glob` / `grep` 作为 DeerFlow 的基础 coding tool,最好仍然是 built-in,这样才能在默认安装中稳定可用。
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- `config.example.yaml` 中可默认启用 `glob` 与 `grep`
|
||||||
|
- 两个工具归属 `file:read` 组
|
||||||
|
- 本地 sandbox 下严格遵守现有路径权限
|
||||||
|
- 输出不泄露宿主机真实路径
|
||||||
|
- 大结果集会被截断并明确提示
|
||||||
|
- 模型可以通过 `glob -> grep -> read_file -> str_replace` 完成典型改码流
|
||||||
|
- 在禁用 host bash 的本地模式下,仓库探索能力明显提升
|
||||||
|
|
||||||
|
## Rollout Plan
|
||||||
|
|
||||||
|
1. 在 `sandbox/tools.py` 中实现 `glob_tool` 与 `grep_tool`
|
||||||
|
2. 抽取与 `list_dir` 一致的 ignore 规则,避免行为漂移
|
||||||
|
3. 在 `config.example.yaml` 默认加入工具配置
|
||||||
|
4. 为本地路径校验、虚拟路径映射、结果截断、二进制跳过补测试
|
||||||
|
5. 更新 README / backend docs / prompt guidance
|
||||||
|
6. 收集实际 agent 调用数据,再决定是否下沉到 `Sandbox` 抽象
|
||||||
|
|
||||||
|
## Suggested Config
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
tools:
|
||||||
|
- name: glob
|
||||||
|
group: file:read
|
||||||
|
use: deerflow.sandbox.tools:glob_tool
|
||||||
|
|
||||||
|
- name: grep
|
||||||
|
group: file:read
|
||||||
|
use: deerflow.sandbox.tools:grep_tool
|
||||||
|
```
|
||||||
|
|
||||||
|
## Final Recommendation
|
||||||
|
|
||||||
|
结论是:**可以加,而且应该加。**
|
||||||
|
|
||||||
|
但我会明确卡三个边界:
|
||||||
|
|
||||||
|
1. `grep` / `glob` 必须是 built-in 的只读结构化工具
|
||||||
|
2. 第一版不要做 shell wrapper,不要把 CLI 方言直接暴露给模型
|
||||||
|
3. 先在 `sandbox/tools.py` 验证价值,再考虑是否下沉到 `Sandbox` provider 抽象
|
||||||
|
|
||||||
|
如果按这个方向做,它会明显提升 DeerFlow 在 coding / repo exploration 场景下的可用性,而且风险可控。
|
||||||
@@ -8,6 +8,9 @@
|
|||||||
"graphs": {
|
"graphs": {
|
||||||
"lead_agent": "deerflow.agents:make_lead_agent"
|
"lead_agent": "deerflow.agents:make_lead_agent"
|
||||||
},
|
},
|
||||||
|
"auth": {
|
||||||
|
"path": "./app/gateway/langgraph_auth.py:auth"
|
||||||
|
},
|
||||||
"checkpointer": {
|
"checkpointer": {
|
||||||
"path": "./packages/harness/deerflow/agents/checkpointer/async_provider.py:make_checkpointer"
|
"path": "./packages/harness/deerflow/agents/checkpointer/async_provider.py:make_checkpointer"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,8 +2,14 @@ from .checkpointer import get_checkpointer, make_checkpointer, reset_checkpointe
|
|||||||
from .factory import create_deerflow_agent
|
from .factory import create_deerflow_agent
|
||||||
from .features import Next, Prev, RuntimeFeatures
|
from .features import Next, Prev, RuntimeFeatures
|
||||||
from .lead_agent import make_lead_agent
|
from .lead_agent import make_lead_agent
|
||||||
|
from .lead_agent.prompt import prime_enabled_skills_cache
|
||||||
from .thread_state import SandboxState, ThreadState
|
from .thread_state import SandboxState, ThreadState
|
||||||
|
|
||||||
|
# LangGraph imports deerflow.agents when registering the graph. Prime the
|
||||||
|
# enabled-skills cache here so the request path can usually read a warm cache
|
||||||
|
# without forcing synchronous filesystem work during prompt module import.
|
||||||
|
prime_enabled_skills_cache()
|
||||||
|
|
||||||
__all__ = [
|
__all__ = [
|
||||||
"create_deerflow_agent",
|
"create_deerflow_agent",
|
||||||
"RuntimeFeatures",
|
"RuntimeFeatures",
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ For sync usage see :mod:`deerflow.agents.checkpointer.provider`.
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
import contextlib
|
import contextlib
|
||||||
import logging
|
import logging
|
||||||
from collections.abc import AsyncIterator
|
from collections.abc import AsyncIterator
|
||||||
@@ -54,7 +55,7 @@ async def _async_checkpointer(config) -> AsyncIterator[Checkpointer]:
|
|||||||
raise ImportError(SQLITE_INSTALL) from exc
|
raise ImportError(SQLITE_INSTALL) from exc
|
||||||
|
|
||||||
conn_str = resolve_sqlite_conn_str(config.connection_string or "store.db")
|
conn_str = resolve_sqlite_conn_str(config.connection_string or "store.db")
|
||||||
ensure_sqlite_parent_dir(conn_str)
|
await asyncio.to_thread(ensure_sqlite_parent_dir, conn_str)
|
||||||
async with AsyncSqliteSaver.from_conn_string(conn_str) as saver:
|
async with AsyncSqliteSaver.from_conn_string(conn_str) as saver:
|
||||||
await saver.setup()
|
await saver.setup()
|
||||||
yield saver
|
yield saver
|
||||||
@@ -83,23 +84,76 @@ async def _async_checkpointer(config) -> AsyncIterator[Checkpointer]:
|
|||||||
|
|
||||||
|
|
||||||
@contextlib.asynccontextmanager
|
@contextlib.asynccontextmanager
|
||||||
async def make_checkpointer() -> AsyncIterator[Checkpointer]:
|
async def _async_checkpointer_from_database(db_config) -> AsyncIterator[Checkpointer]:
|
||||||
"""Async context manager that yields a checkpointer for the caller's lifetime.
|
"""Async context manager that constructs a checkpointer from unified DatabaseConfig."""
|
||||||
Resources are opened on enter and closed on exit — no global state::
|
if db_config.backend == "memory":
|
||||||
|
|
||||||
async with make_checkpointer() as checkpointer:
|
|
||||||
app.state.checkpointer = checkpointer
|
|
||||||
|
|
||||||
Yields an ``InMemorySaver`` when no checkpointer is configured in *config.yaml*.
|
|
||||||
"""
|
|
||||||
|
|
||||||
config = get_app_config()
|
|
||||||
|
|
||||||
if config.checkpointer is None:
|
|
||||||
from langgraph.checkpoint.memory import InMemorySaver
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
yield InMemorySaver()
|
yield InMemorySaver()
|
||||||
return
|
return
|
||||||
|
|
||||||
async with _async_checkpointer(config.checkpointer) as saver:
|
if db_config.backend == "sqlite":
|
||||||
yield saver
|
try:
|
||||||
|
from langgraph.checkpoint.sqlite.aio import AsyncSqliteSaver
|
||||||
|
except ImportError as exc:
|
||||||
|
raise ImportError(SQLITE_INSTALL) from exc
|
||||||
|
|
||||||
|
conn_str = db_config.checkpointer_sqlite_path
|
||||||
|
ensure_sqlite_parent_dir(conn_str)
|
||||||
|
async with AsyncSqliteSaver.from_conn_string(conn_str) as saver:
|
||||||
|
await saver.setup()
|
||||||
|
yield saver
|
||||||
|
return
|
||||||
|
|
||||||
|
if db_config.backend == "postgres":
|
||||||
|
try:
|
||||||
|
from langgraph.checkpoint.postgres.aio import AsyncPostgresSaver
|
||||||
|
except ImportError as exc:
|
||||||
|
raise ImportError(POSTGRES_INSTALL) from exc
|
||||||
|
|
||||||
|
if not db_config.postgres_url:
|
||||||
|
raise ValueError("database.postgres_url is required for the postgres backend")
|
||||||
|
|
||||||
|
async with AsyncPostgresSaver.from_conn_string(db_config.postgres_url) as saver:
|
||||||
|
await saver.setup()
|
||||||
|
yield saver
|
||||||
|
return
|
||||||
|
|
||||||
|
raise ValueError(f"Unknown database backend: {db_config.backend!r}")
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.asynccontextmanager
|
||||||
|
async def make_checkpointer() -> AsyncIterator[Checkpointer]:
|
||||||
|
"""Async context manager that yields a checkpointer for the caller's lifetime.
|
||||||
|
Resources are opened on enter and closed on exit -- no global state::
|
||||||
|
|
||||||
|
async with make_checkpointer() as checkpointer:
|
||||||
|
app.state.checkpointer = checkpointer
|
||||||
|
|
||||||
|
Yields an ``InMemorySaver`` when no checkpointer is configured in *config.yaml*.
|
||||||
|
|
||||||
|
Priority:
|
||||||
|
1. Legacy ``checkpointer:`` config section (backward compatible)
|
||||||
|
2. Unified ``database:`` config section
|
||||||
|
3. Default InMemorySaver
|
||||||
|
"""
|
||||||
|
|
||||||
|
config = get_app_config()
|
||||||
|
|
||||||
|
# Legacy: standalone checkpointer config takes precedence
|
||||||
|
if config.checkpointer is not None:
|
||||||
|
async with _async_checkpointer(config.checkpointer) as saver:
|
||||||
|
yield saver
|
||||||
|
return
|
||||||
|
|
||||||
|
# Unified database config
|
||||||
|
db_config = getattr(config, "database", None)
|
||||||
|
if db_config is not None and db_config.backend != "memory":
|
||||||
|
async with _async_checkpointer_from_database(db_config) as saver:
|
||||||
|
yield saver
|
||||||
|
return
|
||||||
|
|
||||||
|
# Default: in-memory
|
||||||
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
yield InMemorySaver()
|
||||||
|
|||||||
@@ -56,13 +56,15 @@ def _create_summarization_middleware() -> SummarizationMiddleware | None:
|
|||||||
# Prepare keep parameter
|
# Prepare keep parameter
|
||||||
keep = config.keep.to_tuple()
|
keep = config.keep.to_tuple()
|
||||||
|
|
||||||
# Prepare model parameter
|
# Prepare model parameter.
|
||||||
|
# Bind "middleware:summarize" tag so RunJournal identifies these LLM calls
|
||||||
|
# as middleware rather than lead_agent (SummarizationMiddleware is a
|
||||||
|
# LangChain built-in, so we tag the model at creation time).
|
||||||
if config.model_name:
|
if config.model_name:
|
||||||
model = create_chat_model(name=config.model_name, thinking_enabled=False)
|
model = create_chat_model(name=config.model_name, thinking_enabled=False)
|
||||||
else:
|
else:
|
||||||
# Use a lightweight model for summarization to save costs
|
|
||||||
# Falls back to default model if not explicitly specified
|
|
||||||
model = create_chat_model(thinking_enabled=False)
|
model = create_chat_model(thinking_enabled=False)
|
||||||
|
model = model.with_config(tags=["middleware:summarize"])
|
||||||
|
|
||||||
# Prepare kwargs
|
# Prepare kwargs
|
||||||
kwargs = {
|
kwargs = {
|
||||||
@@ -287,14 +289,14 @@ def make_lead_agent(config: RunnableConfig):
|
|||||||
agent_name = cfg.get("agent_name")
|
agent_name = cfg.get("agent_name")
|
||||||
|
|
||||||
agent_config = load_agent_config(agent_name) if not is_bootstrap else None
|
agent_config = load_agent_config(agent_name) if not is_bootstrap else None
|
||||||
# Custom agent model or fallback to global/default model resolution
|
# Custom agent model from agent config (if any), or None to let _resolve_model_name pick the default
|
||||||
agent_model_name = agent_config.model if agent_config and agent_config.model else _resolve_model_name()
|
agent_model_name = agent_config.model if agent_config and agent_config.model else None
|
||||||
|
|
||||||
# Final model name resolution with request override, then agent config, then global default
|
# Final model name resolution: request → agent config → global default, with fallback for unknown names
|
||||||
model_name = requested_model_name or agent_model_name
|
model_name = _resolve_model_name(requested_model_name or agent_model_name)
|
||||||
|
|
||||||
app_config = get_app_config()
|
app_config = get_app_config()
|
||||||
model_config = app_config.get_model_config(model_name) if model_name else None
|
model_config = app_config.get_model_config(model_name)
|
||||||
|
|
||||||
if model_config is None:
|
if model_config is None:
|
||||||
raise ValueError("No chat model could be resolved. Please configure at least one model in config.yaml or provide a valid 'model_name'/'model' in the request.")
|
raise ValueError("No chat model could be resolved. Please configure at least one model in config.yaml or provide a valid 'model_name'/'model' in the request.")
|
||||||
@@ -343,6 +345,8 @@ def make_lead_agent(config: RunnableConfig):
|
|||||||
model=create_chat_model(name=model_name, thinking_enabled=thinking_enabled, reasoning_effort=reasoning_effort),
|
model=create_chat_model(name=model_name, thinking_enabled=thinking_enabled, reasoning_effort=reasoning_effort),
|
||||||
tools=get_available_tools(model_name=model_name, groups=agent_config.tool_groups if agent_config else None, subagent_enabled=subagent_enabled),
|
tools=get_available_tools(model_name=model_name, groups=agent_config.tool_groups if agent_config else None, subagent_enabled=subagent_enabled),
|
||||||
middleware=_build_middlewares(config, model_name=model_name, agent_name=agent_name),
|
middleware=_build_middlewares(config, model_name=model_name, agent_name=agent_name),
|
||||||
system_prompt=apply_prompt_template(subagent_enabled=subagent_enabled, max_concurrent_subagents=max_concurrent_subagents, agent_name=agent_name),
|
system_prompt=apply_prompt_template(
|
||||||
|
subagent_enabled=subagent_enabled, max_concurrent_subagents=max_concurrent_subagents, agent_name=agent_name, available_skills=set(agent_config.skills) if agent_config and agent_config.skills is not None else None
|
||||||
|
),
|
||||||
state_schema=ThreadState,
|
state_schema=ThreadState,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,12 +1,168 @@
|
|||||||
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
|
import threading
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
from functools import lru_cache
|
||||||
|
|
||||||
from deerflow.config.agents_config import load_agent_soul
|
from deerflow.config.agents_config import load_agent_soul
|
||||||
from deerflow.skills import load_skills
|
from deerflow.skills import load_skills
|
||||||
|
from deerflow.skills.types import Skill
|
||||||
from deerflow.subagents import get_available_subagent_names
|
from deerflow.subagents import get_available_subagent_names
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_ENABLED_SKILLS_REFRESH_WAIT_TIMEOUT_SECONDS = 5.0
|
||||||
|
_enabled_skills_lock = threading.Lock()
|
||||||
|
_enabled_skills_cache: list[Skill] | None = None
|
||||||
|
_enabled_skills_refresh_active = False
|
||||||
|
_enabled_skills_refresh_version = 0
|
||||||
|
_enabled_skills_refresh_event = threading.Event()
|
||||||
|
|
||||||
|
|
||||||
|
def _load_enabled_skills_sync() -> list[Skill]:
|
||||||
|
return list(load_skills(enabled_only=True))
|
||||||
|
|
||||||
|
|
||||||
|
def _start_enabled_skills_refresh_thread() -> None:
|
||||||
|
threading.Thread(
|
||||||
|
target=_refresh_enabled_skills_cache_worker,
|
||||||
|
name="deerflow-enabled-skills-loader",
|
||||||
|
daemon=True,
|
||||||
|
).start()
|
||||||
|
|
||||||
|
|
||||||
|
def _refresh_enabled_skills_cache_worker() -> None:
|
||||||
|
global _enabled_skills_cache, _enabled_skills_refresh_active
|
||||||
|
|
||||||
|
while True:
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
target_version = _enabled_skills_refresh_version
|
||||||
|
|
||||||
|
try:
|
||||||
|
skills = _load_enabled_skills_sync()
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Failed to load enabled skills for prompt injection")
|
||||||
|
skills = []
|
||||||
|
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
if _enabled_skills_refresh_version == target_version:
|
||||||
|
_enabled_skills_cache = skills
|
||||||
|
_enabled_skills_refresh_active = False
|
||||||
|
_enabled_skills_refresh_event.set()
|
||||||
|
return
|
||||||
|
|
||||||
|
# A newer invalidation happened while loading. Keep the worker alive
|
||||||
|
# and loop again so the cache always converges on the latest version.
|
||||||
|
_enabled_skills_cache = None
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_enabled_skills_cache() -> threading.Event:
|
||||||
|
global _enabled_skills_refresh_active
|
||||||
|
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
if _enabled_skills_cache is not None:
|
||||||
|
_enabled_skills_refresh_event.set()
|
||||||
|
return _enabled_skills_refresh_event
|
||||||
|
if _enabled_skills_refresh_active:
|
||||||
|
return _enabled_skills_refresh_event
|
||||||
|
_enabled_skills_refresh_active = True
|
||||||
|
_enabled_skills_refresh_event.clear()
|
||||||
|
|
||||||
|
_start_enabled_skills_refresh_thread()
|
||||||
|
return _enabled_skills_refresh_event
|
||||||
|
|
||||||
|
|
||||||
|
def _invalidate_enabled_skills_cache() -> threading.Event:
|
||||||
|
global _enabled_skills_cache, _enabled_skills_refresh_active, _enabled_skills_refresh_version
|
||||||
|
|
||||||
|
_get_cached_skills_prompt_section.cache_clear()
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
_enabled_skills_cache = None
|
||||||
|
_enabled_skills_refresh_version += 1
|
||||||
|
_enabled_skills_refresh_event.clear()
|
||||||
|
if _enabled_skills_refresh_active:
|
||||||
|
return _enabled_skills_refresh_event
|
||||||
|
_enabled_skills_refresh_active = True
|
||||||
|
|
||||||
|
_start_enabled_skills_refresh_thread()
|
||||||
|
return _enabled_skills_refresh_event
|
||||||
|
|
||||||
|
|
||||||
|
def prime_enabled_skills_cache() -> None:
|
||||||
|
_ensure_enabled_skills_cache()
|
||||||
|
|
||||||
|
|
||||||
|
def warm_enabled_skills_cache(timeout_seconds: float = _ENABLED_SKILLS_REFRESH_WAIT_TIMEOUT_SECONDS) -> bool:
|
||||||
|
if _ensure_enabled_skills_cache().wait(timeout=timeout_seconds):
|
||||||
|
return True
|
||||||
|
|
||||||
|
logger.warning("Timed out waiting %.1fs for enabled skills cache warm-up", timeout_seconds)
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _get_enabled_skills():
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
cached = _enabled_skills_cache
|
||||||
|
|
||||||
|
if cached is not None:
|
||||||
|
return list(cached)
|
||||||
|
|
||||||
|
_ensure_enabled_skills_cache()
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def _skill_mutability_label(category: str) -> str:
|
||||||
|
return "[custom, editable]" if category == "custom" else "[built-in]"
|
||||||
|
|
||||||
|
|
||||||
|
def clear_skills_system_prompt_cache() -> None:
|
||||||
|
_invalidate_enabled_skills_cache()
|
||||||
|
|
||||||
|
|
||||||
|
async def refresh_skills_system_prompt_cache_async() -> None:
|
||||||
|
await asyncio.to_thread(_invalidate_enabled_skills_cache().wait)
|
||||||
|
|
||||||
|
|
||||||
|
def _reset_skills_system_prompt_cache_state() -> None:
|
||||||
|
global _enabled_skills_cache, _enabled_skills_refresh_active, _enabled_skills_refresh_version
|
||||||
|
|
||||||
|
_get_cached_skills_prompt_section.cache_clear()
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
_enabled_skills_cache = None
|
||||||
|
_enabled_skills_refresh_active = False
|
||||||
|
_enabled_skills_refresh_version = 0
|
||||||
|
_enabled_skills_refresh_event.clear()
|
||||||
|
|
||||||
|
|
||||||
|
def _refresh_enabled_skills_cache() -> None:
|
||||||
|
"""Backward-compatible test helper for direct synchronous reload."""
|
||||||
|
try:
|
||||||
|
skills = _load_enabled_skills_sync()
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Failed to load enabled skills for prompt injection")
|
||||||
|
skills = []
|
||||||
|
|
||||||
|
with _enabled_skills_lock:
|
||||||
|
_enabled_skills_cache = skills
|
||||||
|
_enabled_skills_refresh_active = False
|
||||||
|
_enabled_skills_refresh_event.set()
|
||||||
|
|
||||||
|
|
||||||
|
def _build_skill_evolution_section(skill_evolution_enabled: bool) -> str:
|
||||||
|
if not skill_evolution_enabled:
|
||||||
|
return ""
|
||||||
|
return """
|
||||||
|
## Skill Self-Evolution
|
||||||
|
After completing a task, consider creating or updating a skill when:
|
||||||
|
- The task required 5+ tool calls to resolve
|
||||||
|
- You overcame non-obvious errors or pitfalls
|
||||||
|
- The user corrected your approach and the corrected version worked
|
||||||
|
- You discovered a non-trivial, recurring workflow
|
||||||
|
If you used a skill and encountered issues not covered by it, patch it immediately.
|
||||||
|
Prefer patch over edit. Before creating a new skill, confirm with the user first.
|
||||||
|
Skip simple one-off tasks.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
def _build_subagent_section(max_concurrent: int) -> str:
|
def _build_subagent_section(max_concurrent: int) -> str:
|
||||||
"""Build the subagent system prompt section with dynamic concurrency limit.
|
"""Build the subagent system prompt section with dynamic concurrency limit.
|
||||||
@@ -261,6 +417,9 @@ You: "Deploying to staging..." [proceed]
|
|||||||
- Use `read_file` tool to read uploaded files using their paths from the list
|
- Use `read_file` tool to read uploaded files using their paths from the list
|
||||||
- For PDF, PPT, Excel, and Word files, converted Markdown versions (*.md) are available alongside originals
|
- For PDF, PPT, Excel, and Word files, converted Markdown versions (*.md) are available alongside originals
|
||||||
- All temporary work happens in `/mnt/user-data/workspace`
|
- All temporary work happens in `/mnt/user-data/workspace`
|
||||||
|
- Treat `/mnt/user-data/workspace` as your default current working directory for coding and file-editing tasks
|
||||||
|
- When writing scripts or commands that create/read files from the workspace, prefer relative paths such as `hello.txt`, `../uploads/data.csv`, and `../outputs/report.md`
|
||||||
|
- Avoid hardcoding `/mnt/user-data/...` inside generated scripts when a relative path from the workspace is enough
|
||||||
- Final deliverables must be copied to `/mnt/user-data/outputs` and presented using `present_file` tool
|
- Final deliverables must be copied to `/mnt/user-data/outputs` and presented using `present_file` tool
|
||||||
{acp_section}
|
{acp_section}
|
||||||
</working_directory>
|
</working_directory>
|
||||||
@@ -380,33 +539,21 @@ def _get_memory_context(agent_name: str | None = None) -> str:
|
|||||||
return ""
|
return ""
|
||||||
|
|
||||||
|
|
||||||
def get_skills_prompt_section(available_skills: set[str] | None = None) -> str:
|
@lru_cache(maxsize=32)
|
||||||
"""Generate the skills prompt section with available skills list.
|
def _get_cached_skills_prompt_section(
|
||||||
|
skill_signature: tuple[tuple[str, str, str, str], ...],
|
||||||
Returns the <skill_system>...</skill_system> block listing all enabled skills,
|
available_skills_key: tuple[str, ...] | None,
|
||||||
suitable for injection into any agent's system prompt.
|
container_base_path: str,
|
||||||
"""
|
skill_evolution_section: str,
|
||||||
skills = load_skills(enabled_only=True)
|
) -> str:
|
||||||
|
filtered = [(name, description, category, location) for name, description, category, location in skill_signature if available_skills_key is None or name in available_skills_key]
|
||||||
try:
|
skills_list = ""
|
||||||
from deerflow.config import get_app_config
|
if filtered:
|
||||||
|
skill_items = "\n".join(
|
||||||
config = get_app_config()
|
f" <skill>\n <name>{name}</name>\n <description>{description} {_skill_mutability_label(category)}</description>\n <location>{location}</location>\n </skill>"
|
||||||
container_base_path = config.skills.container_path
|
for name, description, category, location in filtered
|
||||||
except Exception:
|
)
|
||||||
container_base_path = "/mnt/skills"
|
skills_list = f"<available_skills>\n{skill_items}\n</available_skills>"
|
||||||
|
|
||||||
if not skills:
|
|
||||||
return ""
|
|
||||||
|
|
||||||
if available_skills is not None:
|
|
||||||
skills = [skill for skill in skills if skill.name in available_skills]
|
|
||||||
|
|
||||||
skill_items = "\n".join(
|
|
||||||
f" <skill>\n <name>{skill.name}</name>\n <description>{skill.description}</description>\n <location>{skill.get_container_file_path(container_base_path)}</location>\n </skill>" for skill in skills
|
|
||||||
)
|
|
||||||
skills_list = f"<available_skills>\n{skill_items}\n</available_skills>"
|
|
||||||
|
|
||||||
return f"""<skill_system>
|
return f"""<skill_system>
|
||||||
You have access to skills that provide optimized workflows for specific tasks. Each skill contains best practices, frameworks, and references to additional resources.
|
You have access to skills that provide optimized workflows for specific tasks. Each skill contains best practices, frameworks, and references to additional resources.
|
||||||
|
|
||||||
@@ -418,12 +565,40 @@ You have access to skills that provide optimized workflows for specific tasks. E
|
|||||||
5. Follow the skill's instructions precisely
|
5. Follow the skill's instructions precisely
|
||||||
|
|
||||||
**Skills are located at:** {container_base_path}
|
**Skills are located at:** {container_base_path}
|
||||||
|
{skill_evolution_section}
|
||||||
{skills_list}
|
{skills_list}
|
||||||
|
|
||||||
</skill_system>"""
|
</skill_system>"""
|
||||||
|
|
||||||
|
|
||||||
|
def get_skills_prompt_section(available_skills: set[str] | None = None) -> str:
|
||||||
|
"""Generate the skills prompt section with available skills list."""
|
||||||
|
skills = _get_enabled_skills()
|
||||||
|
|
||||||
|
try:
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
|
||||||
|
config = get_app_config()
|
||||||
|
container_base_path = config.skills.container_path
|
||||||
|
skill_evolution_enabled = config.skill_evolution.enabled
|
||||||
|
except Exception:
|
||||||
|
container_base_path = "/mnt/skills"
|
||||||
|
skill_evolution_enabled = False
|
||||||
|
|
||||||
|
if not skills and not skill_evolution_enabled:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
if available_skills is not None and not any(skill.name in available_skills for skill in skills):
|
||||||
|
return ""
|
||||||
|
|
||||||
|
skill_signature = tuple((skill.name, skill.description, skill.category, skill.get_container_file_path(container_base_path)) for skill in skills)
|
||||||
|
available_key = tuple(sorted(available_skills)) if available_skills is not None else None
|
||||||
|
if not skill_signature and available_key is not None:
|
||||||
|
return ""
|
||||||
|
skill_evolution_section = _build_skill_evolution_section(skill_evolution_enabled)
|
||||||
|
return _get_cached_skills_prompt_section(skill_signature, available_key, container_base_path, skill_evolution_section)
|
||||||
|
|
||||||
|
|
||||||
def get_agent_soul(agent_name: str | None) -> str:
|
def get_agent_soul(agent_name: str | None) -> str:
|
||||||
# Append SOUL.md (agent personality) if present
|
# Append SOUL.md (agent personality) if present
|
||||||
soul = load_agent_soul(agent_name)
|
soul = load_agent_soul(agent_name)
|
||||||
@@ -446,7 +621,7 @@ def get_deferred_tools_prompt_section() -> str:
|
|||||||
|
|
||||||
if not get_app_config().tool_search.enabled:
|
if not get_app_config().tool_search.enabled:
|
||||||
return ""
|
return ""
|
||||||
except FileNotFoundError:
|
except Exception:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
registry = get_deferred_registry()
|
registry = get_deferred_registry()
|
||||||
@@ -477,6 +652,28 @@ def _build_acp_section() -> str:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _build_custom_mounts_section() -> str:
|
||||||
|
"""Build a prompt section for explicitly configured sandbox mounts."""
|
||||||
|
try:
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
|
||||||
|
mounts = get_app_config().sandbox.mounts or []
|
||||||
|
except Exception:
|
||||||
|
logger.exception("Failed to load configured sandbox mounts for the lead-agent prompt")
|
||||||
|
return ""
|
||||||
|
|
||||||
|
if not mounts:
|
||||||
|
return ""
|
||||||
|
|
||||||
|
lines = []
|
||||||
|
for mount in mounts:
|
||||||
|
access = "read-only" if mount.read_only else "read-write"
|
||||||
|
lines.append(f"- Custom mount: `{mount.container_path}` - Host directory mapped into the sandbox ({access})")
|
||||||
|
|
||||||
|
mounts_list = "\n".join(lines)
|
||||||
|
return f"\n**Custom Mounted Directories:**\n{mounts_list}\n- If the user needs files outside `/mnt/user-data`, use these absolute container paths directly when they match the requested directory"
|
||||||
|
|
||||||
|
|
||||||
def apply_prompt_template(subagent_enabled: bool = False, max_concurrent_subagents: int = 3, *, agent_name: str | None = None, available_skills: set[str] | None = None) -> str:
|
def apply_prompt_template(subagent_enabled: bool = False, max_concurrent_subagents: int = 3, *, agent_name: str | None = None, available_skills: set[str] | None = None) -> str:
|
||||||
# Get memory context
|
# Get memory context
|
||||||
memory_context = _get_memory_context(agent_name)
|
memory_context = _get_memory_context(agent_name)
|
||||||
@@ -511,6 +708,8 @@ def apply_prompt_template(subagent_enabled: bool = False, max_concurrent_subagen
|
|||||||
|
|
||||||
# Build ACP agent section only if ACP agents are configured
|
# Build ACP agent section only if ACP agents are configured
|
||||||
acp_section = _build_acp_section()
|
acp_section = _build_acp_section()
|
||||||
|
custom_mounts_section = _build_custom_mounts_section()
|
||||||
|
acp_and_mounts_section = "\n".join(section for section in (acp_section, custom_mounts_section) if section)
|
||||||
|
|
||||||
# Format the prompt with dynamic skills and memory
|
# Format the prompt with dynamic skills and memory
|
||||||
prompt = SYSTEM_PROMPT_TEMPLATE.format(
|
prompt = SYSTEM_PROMPT_TEMPLATE.format(
|
||||||
@@ -522,7 +721,7 @@ def apply_prompt_template(subagent_enabled: bool = False, max_concurrent_subagen
|
|||||||
subagent_section=subagent_section,
|
subagent_section=subagent_section,
|
||||||
subagent_reminder=subagent_reminder,
|
subagent_reminder=subagent_reminder,
|
||||||
subagent_thinking=subagent_thinking,
|
subagent_thinking=subagent_thinking,
|
||||||
acp_section=acp_section,
|
acp_section=acp_and_mounts_section,
|
||||||
)
|
)
|
||||||
|
|
||||||
return prompt + f"\n<current_date>{datetime.now().strftime('%Y-%m-%d, %A')}</current_date>"
|
return prompt + f"\n<current_date>{datetime.now().strftime('%Y-%m-%d, %A')}</current_date>"
|
||||||
|
|||||||
@@ -29,6 +29,17 @@ Instructions:
|
|||||||
2. Extract relevant facts, preferences, and context with specific details (numbers, names, technologies)
|
2. Extract relevant facts, preferences, and context with specific details (numbers, names, technologies)
|
||||||
3. Update the memory sections as needed following the detailed length guidelines below
|
3. Update the memory sections as needed following the detailed length guidelines below
|
||||||
|
|
||||||
|
Before extracting facts, perform a structured reflection on the conversation:
|
||||||
|
1. Error/Retry Detection: Did the agent encounter errors, require retries, or produce incorrect results?
|
||||||
|
If yes, record the root cause and correct approach as a high-confidence fact with category "correction".
|
||||||
|
2. User Correction Detection: Did the user correct the agent's direction, understanding, or output?
|
||||||
|
If yes, record the correct interpretation or approach as a high-confidence fact with category "correction".
|
||||||
|
Include what went wrong in "sourceError" only when category is "correction" and the mistake is explicit in the conversation.
|
||||||
|
3. Project Constraint Discovery: Were any project-specific constraints discovered during the conversation?
|
||||||
|
If yes, record them as facts with the most appropriate category and confidence.
|
||||||
|
|
||||||
|
{correction_hint}
|
||||||
|
|
||||||
Memory Section Guidelines:
|
Memory Section Guidelines:
|
||||||
|
|
||||||
**User Context** (Current state - concise summaries):
|
**User Context** (Current state - concise summaries):
|
||||||
@@ -62,6 +73,7 @@ Memory Section Guidelines:
|
|||||||
* context: Background facts (job title, projects, locations, languages)
|
* context: Background facts (job title, projects, locations, languages)
|
||||||
* behavior: Working patterns, communication habits, problem-solving approaches
|
* behavior: Working patterns, communication habits, problem-solving approaches
|
||||||
* goal: Stated objectives, learning targets, project ambitions
|
* goal: Stated objectives, learning targets, project ambitions
|
||||||
|
* correction: Explicit agent mistakes or user corrections, including the correct approach
|
||||||
- Confidence levels:
|
- Confidence levels:
|
||||||
* 0.9-1.0: Explicitly stated facts ("I work on X", "My role is Y")
|
* 0.9-1.0: Explicitly stated facts ("I work on X", "My role is Y")
|
||||||
* 0.7-0.8: Strongly implied from actions/discussions
|
* 0.7-0.8: Strongly implied from actions/discussions
|
||||||
@@ -94,7 +106,7 @@ Output Format (JSON):
|
|||||||
"longTermBackground": {{ "summary": "...", "shouldUpdate": true/false }}
|
"longTermBackground": {{ "summary": "...", "shouldUpdate": true/false }}
|
||||||
}},
|
}},
|
||||||
"newFacts": [
|
"newFacts": [
|
||||||
{{ "content": "...", "category": "preference|knowledge|context|behavior|goal", "confidence": 0.0-1.0 }}
|
{{ "content": "...", "category": "preference|knowledge|context|behavior|goal|correction", "confidence": 0.0-1.0 }}
|
||||||
],
|
],
|
||||||
"factsToRemove": ["fact_id_1", "fact_id_2"]
|
"factsToRemove": ["fact_id_1", "fact_id_2"]
|
||||||
}}
|
}}
|
||||||
@@ -104,6 +116,8 @@ Important Rules:
|
|||||||
- Follow length guidelines: workContext/personalContext are concise (1-3 sentences), topOfMind and history sections are detailed (paragraphs)
|
- Follow length guidelines: workContext/personalContext are concise (1-3 sentences), topOfMind and history sections are detailed (paragraphs)
|
||||||
- Include specific metrics, version numbers, and proper nouns in facts
|
- Include specific metrics, version numbers, and proper nouns in facts
|
||||||
- Only add facts that are clearly stated (0.9+) or strongly implied (0.7+)
|
- Only add facts that are clearly stated (0.9+) or strongly implied (0.7+)
|
||||||
|
- Use category "correction" for explicit agent mistakes or user corrections; assign confidence >= 0.95 when the correction is explicit
|
||||||
|
- Include "sourceError" only for explicit correction facts when the prior mistake or wrong approach is clearly stated; omit it otherwise
|
||||||
- Remove facts that are contradicted by new information
|
- Remove facts that are contradicted by new information
|
||||||
- When updating topOfMind, integrate new focus areas while removing completed/abandoned ones
|
- When updating topOfMind, integrate new focus areas while removing completed/abandoned ones
|
||||||
Keep 3-5 concurrent focus themes that are still active and relevant
|
Keep 3-5 concurrent focus themes that are still active and relevant
|
||||||
@@ -126,7 +140,7 @@ Message:
|
|||||||
Extract facts in this JSON format:
|
Extract facts in this JSON format:
|
||||||
{{
|
{{
|
||||||
"facts": [
|
"facts": [
|
||||||
{{ "content": "...", "category": "preference|knowledge|context|behavior|goal", "confidence": 0.0-1.0 }}
|
{{ "content": "...", "category": "preference|knowledge|context|behavior|goal|correction", "confidence": 0.0-1.0 }}
|
||||||
]
|
]
|
||||||
}}
|
}}
|
||||||
|
|
||||||
@@ -136,6 +150,7 @@ Categories:
|
|||||||
- context: Background context (location, job, projects)
|
- context: Background context (location, job, projects)
|
||||||
- behavior: Behavioral patterns
|
- behavior: Behavioral patterns
|
||||||
- goal: User's goals or objectives
|
- goal: User's goals or objectives
|
||||||
|
- correction: Explicit corrections or mistakes to avoid repeating
|
||||||
|
|
||||||
Rules:
|
Rules:
|
||||||
- Only extract clear, specific facts
|
- Only extract clear, specific facts
|
||||||
@@ -231,6 +246,10 @@ def format_memory_for_injection(memory_data: dict[str, Any], max_tokens: int = 2
|
|||||||
if earlier.get("summary"):
|
if earlier.get("summary"):
|
||||||
history_sections.append(f"Earlier: {earlier['summary']}")
|
history_sections.append(f"Earlier: {earlier['summary']}")
|
||||||
|
|
||||||
|
background = history_data.get("longTermBackground", {})
|
||||||
|
if background.get("summary"):
|
||||||
|
history_sections.append(f"Background: {background['summary']}")
|
||||||
|
|
||||||
if history_sections:
|
if history_sections:
|
||||||
sections.append("History:\n" + "\n".join(f"- {s}" for s in history_sections))
|
sections.append("History:\n" + "\n".join(f"- {s}" for s in history_sections))
|
||||||
|
|
||||||
@@ -262,7 +281,11 @@ def format_memory_for_injection(memory_data: dict[str, Any], max_tokens: int = 2
|
|||||||
continue
|
continue
|
||||||
category = str(fact.get("category", "context")).strip() or "context"
|
category = str(fact.get("category", "context")).strip() or "context"
|
||||||
confidence = _coerce_confidence(fact.get("confidence"), default=0.0)
|
confidence = _coerce_confidence(fact.get("confidence"), default=0.0)
|
||||||
line = f"- [{category} | {confidence:.2f}] {content}"
|
source_error = fact.get("sourceError")
|
||||||
|
if category == "correction" and isinstance(source_error, str) and source_error.strip():
|
||||||
|
line = f"- [{category} | {confidence:.2f}] {content} (avoid: {source_error.strip()})"
|
||||||
|
else:
|
||||||
|
line = f"- [{category} | {confidence:.2f}] {content}"
|
||||||
|
|
||||||
# Each additional line is preceded by a newline (except the first).
|
# Each additional line is preceded by a newline (except the first).
|
||||||
line_text = ("\n" + line) if fact_lines else line
|
line_text = ("\n" + line) if fact_lines else line
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import logging
|
|||||||
import threading
|
import threading
|
||||||
import time
|
import time
|
||||||
from dataclasses import dataclass, field
|
from dataclasses import dataclass, field
|
||||||
from datetime import datetime
|
from datetime import UTC, datetime
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from deerflow.config.memory_config import get_memory_config
|
from deerflow.config.memory_config import get_memory_config
|
||||||
@@ -18,8 +18,10 @@ class ConversationContext:
|
|||||||
|
|
||||||
thread_id: str
|
thread_id: str
|
||||||
messages: list[Any]
|
messages: list[Any]
|
||||||
timestamp: datetime = field(default_factory=datetime.utcnow)
|
timestamp: datetime = field(default_factory=lambda: datetime.now(UTC))
|
||||||
agent_name: str | None = None
|
agent_name: str | None = None
|
||||||
|
correction_detected: bool = False
|
||||||
|
reinforcement_detected: bool = False
|
||||||
|
|
||||||
|
|
||||||
class MemoryUpdateQueue:
|
class MemoryUpdateQueue:
|
||||||
@@ -37,25 +39,42 @@ class MemoryUpdateQueue:
|
|||||||
self._timer: threading.Timer | None = None
|
self._timer: threading.Timer | None = None
|
||||||
self._processing = False
|
self._processing = False
|
||||||
|
|
||||||
def add(self, thread_id: str, messages: list[Any], agent_name: str | None = None) -> None:
|
def add(
|
||||||
|
self,
|
||||||
|
thread_id: str,
|
||||||
|
messages: list[Any],
|
||||||
|
agent_name: str | None = None,
|
||||||
|
correction_detected: bool = False,
|
||||||
|
reinforcement_detected: bool = False,
|
||||||
|
) -> None:
|
||||||
"""Add a conversation to the update queue.
|
"""Add a conversation to the update queue.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
thread_id: The thread ID.
|
thread_id: The thread ID.
|
||||||
messages: The conversation messages.
|
messages: The conversation messages.
|
||||||
agent_name: If provided, memory is stored per-agent. If None, uses global memory.
|
agent_name: If provided, memory is stored per-agent. If None, uses global memory.
|
||||||
|
correction_detected: Whether recent turns include an explicit correction signal.
|
||||||
|
reinforcement_detected: Whether recent turns include a positive reinforcement signal.
|
||||||
"""
|
"""
|
||||||
config = get_memory_config()
|
config = get_memory_config()
|
||||||
if not config.enabled:
|
if not config.enabled:
|
||||||
return
|
return
|
||||||
|
|
||||||
context = ConversationContext(
|
|
||||||
thread_id=thread_id,
|
|
||||||
messages=messages,
|
|
||||||
agent_name=agent_name,
|
|
||||||
)
|
|
||||||
|
|
||||||
with self._lock:
|
with self._lock:
|
||||||
|
existing_context = next(
|
||||||
|
(context for context in self._queue if context.thread_id == thread_id),
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
merged_correction_detected = correction_detected or (existing_context.correction_detected if existing_context is not None else False)
|
||||||
|
merged_reinforcement_detected = reinforcement_detected or (existing_context.reinforcement_detected if existing_context is not None else False)
|
||||||
|
context = ConversationContext(
|
||||||
|
thread_id=thread_id,
|
||||||
|
messages=messages,
|
||||||
|
agent_name=agent_name,
|
||||||
|
correction_detected=merged_correction_detected,
|
||||||
|
reinforcement_detected=merged_reinforcement_detected,
|
||||||
|
)
|
||||||
|
|
||||||
# Check if this thread already has a pending update
|
# Check if this thread already has a pending update
|
||||||
# If so, replace it with the newer one
|
# If so, replace it with the newer one
|
||||||
self._queue = [c for c in self._queue if c.thread_id != thread_id]
|
self._queue = [c for c in self._queue if c.thread_id != thread_id]
|
||||||
@@ -115,6 +134,8 @@ class MemoryUpdateQueue:
|
|||||||
messages=context.messages,
|
messages=context.messages,
|
||||||
thread_id=context.thread_id,
|
thread_id=context.thread_id,
|
||||||
agent_name=context.agent_name,
|
agent_name=context.agent_name,
|
||||||
|
correction_detected=context.correction_detected,
|
||||||
|
reinforcement_detected=context.reinforcement_detected,
|
||||||
)
|
)
|
||||||
if success:
|
if success:
|
||||||
logger.info("Memory updated successfully for thread %s", context.thread_id)
|
logger.info("Memory updated successfully for thread %s", context.thread_id)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import abc
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import threading
|
import threading
|
||||||
from datetime import datetime
|
from datetime import UTC, datetime
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
@@ -15,11 +15,16 @@ from deerflow.config.paths import get_paths
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def utc_now_iso_z() -> str:
|
||||||
|
"""Current UTC time as ISO-8601 with ``Z`` suffix (matches prior naive-UTC output)."""
|
||||||
|
return datetime.now(UTC).isoformat().removesuffix("+00:00") + "Z"
|
||||||
|
|
||||||
|
|
||||||
def create_empty_memory() -> dict[str, Any]:
|
def create_empty_memory() -> dict[str, Any]:
|
||||||
"""Create an empty memory structure."""
|
"""Create an empty memory structure."""
|
||||||
return {
|
return {
|
||||||
"version": "1.0",
|
"version": "1.0",
|
||||||
"lastUpdated": datetime.utcnow().isoformat() + "Z",
|
"lastUpdated": utc_now_iso_z(),
|
||||||
"user": {
|
"user": {
|
||||||
"workContext": {"summary": "", "updatedAt": ""},
|
"workContext": {"summary": "", "updatedAt": ""},
|
||||||
"personalContext": {"summary": "", "updatedAt": ""},
|
"personalContext": {"summary": "", "updatedAt": ""},
|
||||||
@@ -137,7 +142,7 @@ class FileMemoryStorage(MemoryStorage):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
file_path.parent.mkdir(parents=True, exist_ok=True)
|
file_path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
memory_data["lastUpdated"] = datetime.utcnow().isoformat() + "Z"
|
memory_data["lastUpdated"] = utc_now_iso_z()
|
||||||
|
|
||||||
temp_path = file_path.with_suffix(".tmp")
|
temp_path = file_path.with_suffix(".tmp")
|
||||||
with open(temp_path, "w", encoding="utf-8") as f:
|
with open(temp_path, "w", encoding="utf-8") as f:
|
||||||
|
|||||||
@@ -5,14 +5,17 @@ import logging
|
|||||||
import math
|
import math
|
||||||
import re
|
import re
|
||||||
import uuid
|
import uuid
|
||||||
from datetime import datetime
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from deerflow.agents.memory.prompt import (
|
from deerflow.agents.memory.prompt import (
|
||||||
MEMORY_UPDATE_PROMPT,
|
MEMORY_UPDATE_PROMPT,
|
||||||
format_conversation_for_update,
|
format_conversation_for_update,
|
||||||
)
|
)
|
||||||
from deerflow.agents.memory.storage import create_empty_memory, get_memory_storage
|
from deerflow.agents.memory.storage import (
|
||||||
|
create_empty_memory,
|
||||||
|
get_memory_storage,
|
||||||
|
utc_now_iso_z,
|
||||||
|
)
|
||||||
from deerflow.config.memory_config import get_memory_config
|
from deerflow.config.memory_config import get_memory_config
|
||||||
from deerflow.models import create_chat_model
|
from deerflow.models import create_chat_model
|
||||||
|
|
||||||
@@ -86,7 +89,7 @@ def create_memory_fact(
|
|||||||
|
|
||||||
normalized_category = category.strip() or "context"
|
normalized_category = category.strip() or "context"
|
||||||
validated_confidence = _validate_confidence(confidence)
|
validated_confidence = _validate_confidence(confidence)
|
||||||
now = datetime.utcnow().isoformat() + "Z"
|
now = utc_now_iso_z()
|
||||||
memory_data = get_memory_data(agent_name)
|
memory_data = get_memory_data(agent_name)
|
||||||
updated_memory = dict(memory_data)
|
updated_memory = dict(memory_data)
|
||||||
facts = list(memory_data.get("facts", []))
|
facts = list(memory_data.get("facts", []))
|
||||||
@@ -246,7 +249,7 @@ def _fact_content_key(content: Any) -> str | None:
|
|||||||
stripped = content.strip()
|
stripped = content.strip()
|
||||||
if not stripped:
|
if not stripped:
|
||||||
return None
|
return None
|
||||||
return stripped
|
return stripped.casefold()
|
||||||
|
|
||||||
|
|
||||||
class MemoryUpdater:
|
class MemoryUpdater:
|
||||||
@@ -266,13 +269,22 @@ class MemoryUpdater:
|
|||||||
model_name = self._model_name or config.model_name
|
model_name = self._model_name or config.model_name
|
||||||
return create_chat_model(name=model_name, thinking_enabled=False)
|
return create_chat_model(name=model_name, thinking_enabled=False)
|
||||||
|
|
||||||
def update_memory(self, messages: list[Any], thread_id: str | None = None, agent_name: str | None = None) -> bool:
|
def update_memory(
|
||||||
|
self,
|
||||||
|
messages: list[Any],
|
||||||
|
thread_id: str | None = None,
|
||||||
|
agent_name: str | None = None,
|
||||||
|
correction_detected: bool = False,
|
||||||
|
reinforcement_detected: bool = False,
|
||||||
|
) -> bool:
|
||||||
"""Update memory based on conversation messages.
|
"""Update memory based on conversation messages.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
messages: List of conversation messages.
|
messages: List of conversation messages.
|
||||||
thread_id: Optional thread ID for tracking source.
|
thread_id: Optional thread ID for tracking source.
|
||||||
agent_name: If provided, updates per-agent memory. If None, updates global memory.
|
agent_name: If provided, updates per-agent memory. If None, updates global memory.
|
||||||
|
correction_detected: Whether recent turns include an explicit correction signal.
|
||||||
|
reinforcement_detected: Whether recent turns include a positive reinforcement signal.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
True if update was successful, False otherwise.
|
True if update was successful, False otherwise.
|
||||||
@@ -295,9 +307,27 @@ class MemoryUpdater:
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
# Build prompt
|
# Build prompt
|
||||||
|
correction_hint = ""
|
||||||
|
if correction_detected:
|
||||||
|
correction_hint = (
|
||||||
|
"IMPORTANT: Explicit correction signals were detected in this conversation. "
|
||||||
|
"Pay special attention to what the agent got wrong, what the user corrected, "
|
||||||
|
"and record the correct approach as a fact with category "
|
||||||
|
'"correction" and confidence >= 0.95 when appropriate.'
|
||||||
|
)
|
||||||
|
if reinforcement_detected:
|
||||||
|
reinforcement_hint = (
|
||||||
|
"IMPORTANT: Positive reinforcement signals were detected in this conversation. "
|
||||||
|
"The user explicitly confirmed the agent's approach was correct or helpful. "
|
||||||
|
"Record the confirmed approach, style, or preference as a fact with category "
|
||||||
|
'"preference" or "behavior" and confidence >= 0.9 when appropriate.'
|
||||||
|
)
|
||||||
|
correction_hint = (correction_hint + "\n" + reinforcement_hint).strip() if correction_hint else reinforcement_hint
|
||||||
|
|
||||||
prompt = MEMORY_UPDATE_PROMPT.format(
|
prompt = MEMORY_UPDATE_PROMPT.format(
|
||||||
current_memory=json.dumps(current_memory, indent=2),
|
current_memory=json.dumps(current_memory, indent=2),
|
||||||
conversation=conversation_text,
|
conversation=conversation_text,
|
||||||
|
correction_hint=correction_hint,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Call LLM
|
# Call LLM
|
||||||
@@ -349,7 +379,7 @@ class MemoryUpdater:
|
|||||||
Updated memory data.
|
Updated memory data.
|
||||||
"""
|
"""
|
||||||
config = get_memory_config()
|
config = get_memory_config()
|
||||||
now = datetime.utcnow().isoformat() + "Z"
|
now = utc_now_iso_z()
|
||||||
|
|
||||||
# Update user sections
|
# Update user sections
|
||||||
user_updates = update_data.get("user", {})
|
user_updates = update_data.get("user", {})
|
||||||
@@ -383,6 +413,8 @@ class MemoryUpdater:
|
|||||||
confidence = fact.get("confidence", 0.5)
|
confidence = fact.get("confidence", 0.5)
|
||||||
if confidence >= config.fact_confidence_threshold:
|
if confidence >= config.fact_confidence_threshold:
|
||||||
raw_content = fact.get("content", "")
|
raw_content = fact.get("content", "")
|
||||||
|
if not isinstance(raw_content, str):
|
||||||
|
continue
|
||||||
normalized_content = raw_content.strip()
|
normalized_content = raw_content.strip()
|
||||||
fact_key = _fact_content_key(normalized_content)
|
fact_key = _fact_content_key(normalized_content)
|
||||||
if fact_key is not None and fact_key in existing_fact_keys:
|
if fact_key is not None and fact_key in existing_fact_keys:
|
||||||
@@ -396,6 +428,11 @@ class MemoryUpdater:
|
|||||||
"createdAt": now,
|
"createdAt": now,
|
||||||
"source": thread_id or "unknown",
|
"source": thread_id or "unknown",
|
||||||
}
|
}
|
||||||
|
source_error = fact.get("sourceError")
|
||||||
|
if isinstance(source_error, str):
|
||||||
|
normalized_source_error = source_error.strip()
|
||||||
|
if normalized_source_error:
|
||||||
|
fact_entry["sourceError"] = normalized_source_error
|
||||||
current_memory["facts"].append(fact_entry)
|
current_memory["facts"].append(fact_entry)
|
||||||
if fact_key is not None:
|
if fact_key is not None:
|
||||||
existing_fact_keys.add(fact_key)
|
existing_fact_keys.add(fact_key)
|
||||||
@@ -412,16 +449,24 @@ class MemoryUpdater:
|
|||||||
return current_memory
|
return current_memory
|
||||||
|
|
||||||
|
|
||||||
def update_memory_from_conversation(messages: list[Any], thread_id: str | None = None, agent_name: str | None = None) -> bool:
|
def update_memory_from_conversation(
|
||||||
|
messages: list[Any],
|
||||||
|
thread_id: str | None = None,
|
||||||
|
agent_name: str | None = None,
|
||||||
|
correction_detected: bool = False,
|
||||||
|
reinforcement_detected: bool = False,
|
||||||
|
) -> bool:
|
||||||
"""Convenience function to update memory from a conversation.
|
"""Convenience function to update memory from a conversation.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
messages: List of conversation messages.
|
messages: List of conversation messages.
|
||||||
thread_id: Optional thread ID.
|
thread_id: Optional thread ID.
|
||||||
agent_name: If provided, updates per-agent memory. If None, updates global memory.
|
agent_name: If provided, updates per-agent memory. If None, updates global memory.
|
||||||
|
correction_detected: Whether recent turns include an explicit correction signal.
|
||||||
|
reinforcement_detected: Whether recent turns include a positive reinforcement signal.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
True if successful, False otherwise.
|
True if successful, False otherwise.
|
||||||
"""
|
"""
|
||||||
updater = MemoryUpdater()
|
updater = MemoryUpdater()
|
||||||
return updater.update_memory(messages, thread_id, agent_name)
|
return updater.update_memory(messages, thread_id, agent_name, correction_detected, reinforcement_detected)
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
"""Middleware for intercepting clarification requests and presenting them to the user."""
|
"""Middleware for intercepting clarification requests and presenting them to the user."""
|
||||||
|
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from typing import override
|
from typing import override
|
||||||
@@ -60,6 +61,20 @@ class ClarificationMiddleware(AgentMiddleware[ClarificationMiddlewareState]):
|
|||||||
context = args.get("context")
|
context = args.get("context")
|
||||||
options = args.get("options", [])
|
options = args.get("options", [])
|
||||||
|
|
||||||
|
# Some models (e.g. Qwen3-Max) serialize array parameters as JSON strings
|
||||||
|
# instead of native arrays. Deserialize and normalize so `options`
|
||||||
|
# is always a list for the rendering logic below.
|
||||||
|
if isinstance(options, str):
|
||||||
|
try:
|
||||||
|
options = json.loads(options)
|
||||||
|
except (json.JSONDecodeError, TypeError):
|
||||||
|
options = [options]
|
||||||
|
|
||||||
|
if options is None:
|
||||||
|
options = []
|
||||||
|
elif not isinstance(options, list):
|
||||||
|
options = [options]
|
||||||
|
|
||||||
# Type-specific icons
|
# Type-specific icons
|
||||||
type_icons = {
|
type_icons = {
|
||||||
"missing_info": "❓",
|
"missing_info": "❓",
|
||||||
|
|||||||
+275
@@ -0,0 +1,275 @@
|
|||||||
|
"""LLM error handling middleware with retry/backoff and user-facing fallbacks."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
import time
|
||||||
|
from collections.abc import Awaitable, Callable
|
||||||
|
from email.utils import parsedate_to_datetime
|
||||||
|
from typing import Any, override
|
||||||
|
|
||||||
|
from langchain.agents import AgentState
|
||||||
|
from langchain.agents.middleware import AgentMiddleware
|
||||||
|
from langchain.agents.middleware.types import (
|
||||||
|
ModelCallResult,
|
||||||
|
ModelRequest,
|
||||||
|
ModelResponse,
|
||||||
|
)
|
||||||
|
from langchain_core.messages import AIMessage
|
||||||
|
from langgraph.errors import GraphBubbleUp
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_RETRIABLE_STATUS_CODES = {408, 409, 425, 429, 500, 502, 503, 504}
|
||||||
|
_BUSY_PATTERNS = (
|
||||||
|
"server busy",
|
||||||
|
"temporarily unavailable",
|
||||||
|
"try again later",
|
||||||
|
"please retry",
|
||||||
|
"please try again",
|
||||||
|
"overloaded",
|
||||||
|
"high demand",
|
||||||
|
"rate limit",
|
||||||
|
"负载较高",
|
||||||
|
"服务繁忙",
|
||||||
|
"稍后重试",
|
||||||
|
"请稍后重试",
|
||||||
|
)
|
||||||
|
_QUOTA_PATTERNS = (
|
||||||
|
"insufficient_quota",
|
||||||
|
"quota",
|
||||||
|
"billing",
|
||||||
|
"credit",
|
||||||
|
"payment",
|
||||||
|
"余额不足",
|
||||||
|
"超出限额",
|
||||||
|
"额度不足",
|
||||||
|
"欠费",
|
||||||
|
)
|
||||||
|
_AUTH_PATTERNS = (
|
||||||
|
"authentication",
|
||||||
|
"unauthorized",
|
||||||
|
"invalid api key",
|
||||||
|
"invalid_api_key",
|
||||||
|
"permission",
|
||||||
|
"forbidden",
|
||||||
|
"access denied",
|
||||||
|
"无权",
|
||||||
|
"未授权",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class LLMErrorHandlingMiddleware(AgentMiddleware[AgentState]):
|
||||||
|
"""Retry transient LLM errors and surface graceful assistant messages."""
|
||||||
|
|
||||||
|
retry_max_attempts: int = 3
|
||||||
|
retry_base_delay_ms: int = 1000
|
||||||
|
retry_cap_delay_ms: int = 8000
|
||||||
|
|
||||||
|
def _classify_error(self, exc: BaseException) -> tuple[bool, str]:
|
||||||
|
detail = _extract_error_detail(exc)
|
||||||
|
lowered = detail.lower()
|
||||||
|
error_code = _extract_error_code(exc)
|
||||||
|
status_code = _extract_status_code(exc)
|
||||||
|
|
||||||
|
if _matches_any(lowered, _QUOTA_PATTERNS) or _matches_any(str(error_code).lower(), _QUOTA_PATTERNS):
|
||||||
|
return False, "quota"
|
||||||
|
if _matches_any(lowered, _AUTH_PATTERNS):
|
||||||
|
return False, "auth"
|
||||||
|
|
||||||
|
exc_name = exc.__class__.__name__
|
||||||
|
if exc_name in {
|
||||||
|
"APITimeoutError",
|
||||||
|
"APIConnectionError",
|
||||||
|
"InternalServerError",
|
||||||
|
}:
|
||||||
|
return True, "transient"
|
||||||
|
if status_code in _RETRIABLE_STATUS_CODES:
|
||||||
|
return True, "transient"
|
||||||
|
if _matches_any(lowered, _BUSY_PATTERNS):
|
||||||
|
return True, "busy"
|
||||||
|
|
||||||
|
return False, "generic"
|
||||||
|
|
||||||
|
def _build_retry_delay_ms(self, attempt: int, exc: BaseException) -> int:
|
||||||
|
retry_after = _extract_retry_after_ms(exc)
|
||||||
|
if retry_after is not None:
|
||||||
|
return retry_after
|
||||||
|
backoff = self.retry_base_delay_ms * (2 ** max(0, attempt - 1))
|
||||||
|
return min(backoff, self.retry_cap_delay_ms)
|
||||||
|
|
||||||
|
def _build_retry_message(self, attempt: int, wait_ms: int, reason: str) -> str:
|
||||||
|
seconds = max(1, round(wait_ms / 1000))
|
||||||
|
reason_text = "provider is busy" if reason == "busy" else "provider request failed temporarily"
|
||||||
|
return f"LLM request retry {attempt}/{self.retry_max_attempts}: {reason_text}. Retrying in {seconds}s."
|
||||||
|
|
||||||
|
def _build_user_message(self, exc: BaseException, reason: str) -> str:
|
||||||
|
detail = _extract_error_detail(exc)
|
||||||
|
if reason == "quota":
|
||||||
|
return "The configured LLM provider rejected the request because the account is out of quota, billing is unavailable, or usage is restricted. Please fix the provider account and try again."
|
||||||
|
if reason == "auth":
|
||||||
|
return "The configured LLM provider rejected the request because authentication or access is invalid. Please check the provider credentials and try again."
|
||||||
|
if reason in {"busy", "transient"}:
|
||||||
|
return "The configured LLM provider is temporarily unavailable after multiple retries. Please wait a moment and continue the conversation."
|
||||||
|
return f"LLM request failed: {detail}"
|
||||||
|
|
||||||
|
def _emit_retry_event(self, attempt: int, wait_ms: int, reason: str) -> None:
|
||||||
|
try:
|
||||||
|
from langgraph.config import get_stream_writer
|
||||||
|
|
||||||
|
writer = get_stream_writer()
|
||||||
|
writer(
|
||||||
|
{
|
||||||
|
"type": "llm_retry",
|
||||||
|
"attempt": attempt,
|
||||||
|
"max_attempts": self.retry_max_attempts,
|
||||||
|
"wait_ms": wait_ms,
|
||||||
|
"reason": reason,
|
||||||
|
"message": self._build_retry_message(attempt, wait_ms, reason),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
logger.debug("Failed to emit llm_retry event", exc_info=True)
|
||||||
|
|
||||||
|
@override
|
||||||
|
def wrap_model_call(
|
||||||
|
self,
|
||||||
|
request: ModelRequest,
|
||||||
|
handler: Callable[[ModelRequest], ModelResponse],
|
||||||
|
) -> ModelCallResult:
|
||||||
|
attempt = 1
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
return handler(request)
|
||||||
|
except GraphBubbleUp:
|
||||||
|
# Preserve LangGraph control-flow signals (interrupt/pause/resume).
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
retriable, reason = self._classify_error(exc)
|
||||||
|
if retriable and attempt < self.retry_max_attempts:
|
||||||
|
wait_ms = self._build_retry_delay_ms(attempt, exc)
|
||||||
|
logger.warning(
|
||||||
|
"Transient LLM error on attempt %d/%d; retrying in %dms: %s",
|
||||||
|
attempt,
|
||||||
|
self.retry_max_attempts,
|
||||||
|
wait_ms,
|
||||||
|
_extract_error_detail(exc),
|
||||||
|
)
|
||||||
|
self._emit_retry_event(attempt, wait_ms, reason)
|
||||||
|
time.sleep(wait_ms / 1000)
|
||||||
|
attempt += 1
|
||||||
|
continue
|
||||||
|
logger.warning(
|
||||||
|
"LLM call failed after %d attempt(s): %s",
|
||||||
|
attempt,
|
||||||
|
_extract_error_detail(exc),
|
||||||
|
exc_info=exc,
|
||||||
|
)
|
||||||
|
return AIMessage(content=self._build_user_message(exc, reason))
|
||||||
|
|
||||||
|
@override
|
||||||
|
async def awrap_model_call(
|
||||||
|
self,
|
||||||
|
request: ModelRequest,
|
||||||
|
handler: Callable[[ModelRequest], Awaitable[ModelResponse]],
|
||||||
|
) -> ModelCallResult:
|
||||||
|
attempt = 1
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
return await handler(request)
|
||||||
|
except GraphBubbleUp:
|
||||||
|
# Preserve LangGraph control-flow signals (interrupt/pause/resume).
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
retriable, reason = self._classify_error(exc)
|
||||||
|
if retriable and attempt < self.retry_max_attempts:
|
||||||
|
wait_ms = self._build_retry_delay_ms(attempt, exc)
|
||||||
|
logger.warning(
|
||||||
|
"Transient LLM error on attempt %d/%d; retrying in %dms: %s",
|
||||||
|
attempt,
|
||||||
|
self.retry_max_attempts,
|
||||||
|
wait_ms,
|
||||||
|
_extract_error_detail(exc),
|
||||||
|
)
|
||||||
|
self._emit_retry_event(attempt, wait_ms, reason)
|
||||||
|
await asyncio.sleep(wait_ms / 1000)
|
||||||
|
attempt += 1
|
||||||
|
continue
|
||||||
|
logger.warning(
|
||||||
|
"LLM call failed after %d attempt(s): %s",
|
||||||
|
attempt,
|
||||||
|
_extract_error_detail(exc),
|
||||||
|
exc_info=exc,
|
||||||
|
)
|
||||||
|
return AIMessage(content=self._build_user_message(exc, reason))
|
||||||
|
|
||||||
|
|
||||||
|
def _matches_any(detail: str, patterns: tuple[str, ...]) -> bool:
|
||||||
|
return any(pattern in detail for pattern in patterns)
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_error_code(exc: BaseException) -> Any:
|
||||||
|
for attr in ("code", "error_code"):
|
||||||
|
value = getattr(exc, attr, None)
|
||||||
|
if value not in (None, ""):
|
||||||
|
return value
|
||||||
|
|
||||||
|
body = getattr(exc, "body", None)
|
||||||
|
if isinstance(body, dict):
|
||||||
|
error = body.get("error")
|
||||||
|
if isinstance(error, dict):
|
||||||
|
for key in ("code", "type"):
|
||||||
|
value = error.get(key)
|
||||||
|
if value not in (None, ""):
|
||||||
|
return value
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_status_code(exc: BaseException) -> int | None:
|
||||||
|
for attr in ("status_code", "status"):
|
||||||
|
value = getattr(exc, attr, None)
|
||||||
|
if isinstance(value, int):
|
||||||
|
return value
|
||||||
|
response = getattr(exc, "response", None)
|
||||||
|
status = getattr(response, "status_code", None)
|
||||||
|
return status if isinstance(status, int) else None
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_retry_after_ms(exc: BaseException) -> int | None:
|
||||||
|
response = getattr(exc, "response", None)
|
||||||
|
headers = getattr(response, "headers", None)
|
||||||
|
if headers is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
raw = None
|
||||||
|
header_name = ""
|
||||||
|
for key in ("retry-after-ms", "Retry-After-Ms", "retry-after", "Retry-After"):
|
||||||
|
header_name = key
|
||||||
|
if hasattr(headers, "get"):
|
||||||
|
raw = headers.get(key)
|
||||||
|
if raw:
|
||||||
|
break
|
||||||
|
if not raw:
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
multiplier = 1 if "ms" in header_name.lower() else 1000
|
||||||
|
return max(0, int(float(raw) * multiplier))
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
try:
|
||||||
|
target = parsedate_to_datetime(str(raw))
|
||||||
|
delta = target.timestamp() - time.time()
|
||||||
|
return max(0, int(delta * 1000))
|
||||||
|
except (TypeError, ValueError, OverflowError):
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_error_detail(exc: BaseException) -> str:
|
||||||
|
detail = str(exc).strip()
|
||||||
|
if detail:
|
||||||
|
return detail
|
||||||
|
message = getattr(exc, "message", None)
|
||||||
|
if isinstance(message, str) and message.strip():
|
||||||
|
return message.strip()
|
||||||
|
return exc.__class__.__name__
|
||||||
@@ -33,30 +33,92 @@ _DEFAULT_WINDOW_SIZE = 20 # track last N tool calls
|
|||||||
_DEFAULT_MAX_TRACKED_THREADS = 100 # LRU eviction limit
|
_DEFAULT_MAX_TRACKED_THREADS = 100 # LRU eviction limit
|
||||||
|
|
||||||
|
|
||||||
|
def _normalize_tool_call_args(raw_args: object) -> tuple[dict, str | None]:
|
||||||
|
"""Normalize tool call args to a dict plus an optional fallback key.
|
||||||
|
|
||||||
|
Some providers serialize ``args`` as a JSON string instead of a dict.
|
||||||
|
We defensively parse those cases so loop detection does not crash while
|
||||||
|
still preserving a stable fallback key for non-dict payloads.
|
||||||
|
"""
|
||||||
|
if isinstance(raw_args, dict):
|
||||||
|
return raw_args, None
|
||||||
|
|
||||||
|
if isinstance(raw_args, str):
|
||||||
|
try:
|
||||||
|
parsed = json.loads(raw_args)
|
||||||
|
except (TypeError, ValueError, json.JSONDecodeError):
|
||||||
|
return {}, raw_args
|
||||||
|
|
||||||
|
if isinstance(parsed, dict):
|
||||||
|
return parsed, None
|
||||||
|
return {}, json.dumps(parsed, sort_keys=True, default=str)
|
||||||
|
|
||||||
|
if raw_args is None:
|
||||||
|
return {}, None
|
||||||
|
|
||||||
|
return {}, json.dumps(raw_args, sort_keys=True, default=str)
|
||||||
|
|
||||||
|
|
||||||
|
def _stable_tool_key(name: str, args: dict, fallback_key: str | None) -> str:
|
||||||
|
"""Derive a stable key from salient args without overfitting to noise."""
|
||||||
|
if name == "read_file" and fallback_key is None:
|
||||||
|
path = args.get("path") or ""
|
||||||
|
start_line = args.get("start_line")
|
||||||
|
end_line = args.get("end_line")
|
||||||
|
|
||||||
|
bucket_size = 200
|
||||||
|
try:
|
||||||
|
start_line = int(start_line) if start_line is not None else 1
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
start_line = 1
|
||||||
|
try:
|
||||||
|
end_line = int(end_line) if end_line is not None else start_line
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
end_line = start_line
|
||||||
|
|
||||||
|
start_line, end_line = sorted((start_line, end_line))
|
||||||
|
bucket_start = max(start_line, 1)
|
||||||
|
bucket_end = max(end_line, 1)
|
||||||
|
bucket_start = (bucket_start - 1) // bucket_size
|
||||||
|
bucket_end = (bucket_end - 1) // bucket_size
|
||||||
|
return f"{path}:{bucket_start}-{bucket_end}"
|
||||||
|
|
||||||
|
# write_file / str_replace are content-sensitive: same path may be updated
|
||||||
|
# with different payloads during iteration. Using only salient fields (path)
|
||||||
|
# can collapse distinct calls, so we hash full args to reduce false positives.
|
||||||
|
if name in {"write_file", "str_replace"}:
|
||||||
|
if fallback_key is not None:
|
||||||
|
return fallback_key
|
||||||
|
return json.dumps(args, sort_keys=True, default=str)
|
||||||
|
|
||||||
|
salient_fields = ("path", "url", "query", "command", "pattern", "glob", "cmd")
|
||||||
|
stable_args = {field: args[field] for field in salient_fields if args.get(field) is not None}
|
||||||
|
if stable_args:
|
||||||
|
return json.dumps(stable_args, sort_keys=True, default=str)
|
||||||
|
|
||||||
|
if fallback_key is not None:
|
||||||
|
return fallback_key
|
||||||
|
|
||||||
|
return json.dumps(args, sort_keys=True, default=str)
|
||||||
|
|
||||||
|
|
||||||
def _hash_tool_calls(tool_calls: list[dict]) -> str:
|
def _hash_tool_calls(tool_calls: list[dict]) -> str:
|
||||||
"""Deterministic hash of a set of tool calls (name + args).
|
"""Deterministic hash of a set of tool calls (name + stable key).
|
||||||
|
|
||||||
This is intended to be order-independent: the same multiset of tool calls
|
This is intended to be order-independent: the same multiset of tool calls
|
||||||
should always produce the same hash, regardless of their input order.
|
should always produce the same hash, regardless of their input order.
|
||||||
"""
|
"""
|
||||||
# First normalize each tool call to a minimal (name, args) structure.
|
# Normalize each tool call to a stable (name, key) structure.
|
||||||
normalized: list[dict] = []
|
normalized: list[str] = []
|
||||||
for tc in tool_calls:
|
for tc in tool_calls:
|
||||||
normalized.append(
|
name = tc.get("name", "")
|
||||||
{
|
args, fallback_key = _normalize_tool_call_args(tc.get("args", {}))
|
||||||
"name": tc.get("name", ""),
|
key = _stable_tool_key(name, args, fallback_key)
|
||||||
"args": tc.get("args", {}),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
# Sort by both name and a deterministic serialization of args so that
|
normalized.append(f"{name}:{key}")
|
||||||
# permutations of the same multiset of calls yield the same ordering.
|
|
||||||
normalized.sort(
|
# Sort so permutations of the same multiset of calls yield the same ordering.
|
||||||
key=lambda tc: (
|
normalized.sort()
|
||||||
tc["name"],
|
|
||||||
json.dumps(tc["args"], sort_keys=True, default=str),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
blob = json.dumps(normalized, sort_keys=True, default=str)
|
blob = json.dumps(normalized, sort_keys=True, default=str)
|
||||||
return hashlib.md5(blob.encode()).hexdigest()[:12]
|
return hashlib.md5(blob.encode()).hexdigest()[:12]
|
||||||
|
|
||||||
@@ -182,6 +244,23 @@ class LoopDetectionMiddleware(AgentMiddleware[AgentState]):
|
|||||||
|
|
||||||
return None, False
|
return None, False
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _append_text(content: str | list | None, text: str) -> str | list:
|
||||||
|
"""Append *text* to AIMessage content, handling str, list, and None.
|
||||||
|
|
||||||
|
When content is a list of content blocks (e.g. Anthropic thinking mode),
|
||||||
|
we append a new ``{"type": "text", ...}`` block instead of concatenating
|
||||||
|
a string to a list, which would raise ``TypeError``.
|
||||||
|
"""
|
||||||
|
if content is None:
|
||||||
|
return text
|
||||||
|
if isinstance(content, list):
|
||||||
|
return [*content, {"type": "text", "text": f"\n\n{text}"}]
|
||||||
|
if isinstance(content, str):
|
||||||
|
return content + f"\n\n{text}"
|
||||||
|
# Fallback: coerce unexpected types to str to avoid TypeError
|
||||||
|
return str(content) + f"\n\n{text}"
|
||||||
|
|
||||||
def _apply(self, state: AgentState, runtime: Runtime) -> dict | None:
|
def _apply(self, state: AgentState, runtime: Runtime) -> dict | None:
|
||||||
warning, hard_stop = self._track_and_check(state, runtime)
|
warning, hard_stop = self._track_and_check(state, runtime)
|
||||||
|
|
||||||
@@ -192,7 +271,7 @@ class LoopDetectionMiddleware(AgentMiddleware[AgentState]):
|
|||||||
stripped_msg = last_msg.model_copy(
|
stripped_msg = last_msg.model_copy(
|
||||||
update={
|
update={
|
||||||
"tool_calls": [],
|
"tool_calls": [],
|
||||||
"content": (last_msg.content or "") + f"\n\n{_HARD_STOP_MSG}",
|
"content": self._append_text(last_msg.content, _HARD_STOP_MSG),
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
return {"messages": [stripped_msg]}
|
return {"messages": [stripped_msg]}
|
||||||
|
|||||||
@@ -14,6 +14,37 @@ from deerflow.config.memory_config import get_memory_config
|
|||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_UPLOAD_BLOCK_RE = re.compile(r"<uploaded_files>[\s\S]*?</uploaded_files>\n*", re.IGNORECASE)
|
||||||
|
_CORRECTION_PATTERNS = (
|
||||||
|
re.compile(r"\bthat(?:'s| is) (?:wrong|incorrect)\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\byou misunderstood\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\btry again\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bredo\b", re.IGNORECASE),
|
||||||
|
re.compile(r"不对"),
|
||||||
|
re.compile(r"你理解错了"),
|
||||||
|
re.compile(r"你理解有误"),
|
||||||
|
re.compile(r"重试"),
|
||||||
|
re.compile(r"重新来"),
|
||||||
|
re.compile(r"换一种"),
|
||||||
|
re.compile(r"改用"),
|
||||||
|
)
|
||||||
|
|
||||||
|
_REINFORCEMENT_PATTERNS = (
|
||||||
|
re.compile(r"\byes[,.]?\s+(?:exactly|perfect|that(?:'s| is) (?:right|correct|it))\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bperfect(?:[.!?]|$)", re.IGNORECASE),
|
||||||
|
re.compile(r"\bexactly\s+(?:right|correct)\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bthat(?:'s| is)\s+(?:exactly\s+)?(?:right|correct|what i (?:wanted|needed|meant))\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bkeep\s+(?:doing\s+)?that\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bjust\s+(?:like\s+)?(?:that|this)\b", re.IGNORECASE),
|
||||||
|
re.compile(r"\bthis is (?:great|helpful)\b(?:[.!?]|$)", re.IGNORECASE),
|
||||||
|
re.compile(r"\bthis is what i wanted\b(?:[.!?]|$)", re.IGNORECASE),
|
||||||
|
re.compile(r"对[,,]?\s*就是这样(?:[。!?!?.]|$)"),
|
||||||
|
re.compile(r"完全正确(?:[。!?!?.]|$)"),
|
||||||
|
re.compile(r"(?:对[,,]?\s*)?就是这个意思(?:[。!?!?.]|$)"),
|
||||||
|
re.compile(r"正是我想要的(?:[。!?!?.]|$)"),
|
||||||
|
re.compile(r"继续保持(?:[。!?!?.]|$)"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class MemoryMiddlewareState(AgentState):
|
class MemoryMiddlewareState(AgentState):
|
||||||
"""Compatible with the `ThreadState` schema."""
|
"""Compatible with the `ThreadState` schema."""
|
||||||
@@ -21,6 +52,22 @@ class MemoryMiddlewareState(AgentState):
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_message_text(message: Any) -> str:
|
||||||
|
"""Extract plain text from message content for filtering and signal detection."""
|
||||||
|
content = getattr(message, "content", "")
|
||||||
|
if isinstance(content, list):
|
||||||
|
text_parts: list[str] = []
|
||||||
|
for part in content:
|
||||||
|
if isinstance(part, str):
|
||||||
|
text_parts.append(part)
|
||||||
|
elif isinstance(part, dict):
|
||||||
|
text_val = part.get("text")
|
||||||
|
if isinstance(text_val, str):
|
||||||
|
text_parts.append(text_val)
|
||||||
|
return " ".join(text_parts)
|
||||||
|
return str(content)
|
||||||
|
|
||||||
|
|
||||||
def _filter_messages_for_memory(messages: list[Any]) -> list[Any]:
|
def _filter_messages_for_memory(messages: list[Any]) -> list[Any]:
|
||||||
"""Filter messages to keep only user inputs and final assistant responses.
|
"""Filter messages to keep only user inputs and final assistant responses.
|
||||||
|
|
||||||
@@ -44,18 +91,13 @@ def _filter_messages_for_memory(messages: list[Any]) -> list[Any]:
|
|||||||
Returns:
|
Returns:
|
||||||
Filtered list containing only user inputs and final assistant responses.
|
Filtered list containing only user inputs and final assistant responses.
|
||||||
"""
|
"""
|
||||||
_UPLOAD_BLOCK_RE = re.compile(r"<uploaded_files>[\s\S]*?</uploaded_files>\n*", re.IGNORECASE)
|
|
||||||
|
|
||||||
filtered = []
|
filtered = []
|
||||||
skip_next_ai = False
|
skip_next_ai = False
|
||||||
for msg in messages:
|
for msg in messages:
|
||||||
msg_type = getattr(msg, "type", None)
|
msg_type = getattr(msg, "type", None)
|
||||||
|
|
||||||
if msg_type == "human":
|
if msg_type == "human":
|
||||||
content = getattr(msg, "content", "")
|
content_str = _extract_message_text(msg)
|
||||||
if isinstance(content, list):
|
|
||||||
content = " ".join(p.get("text", "") for p in content if isinstance(p, dict))
|
|
||||||
content_str = str(content)
|
|
||||||
if "<uploaded_files>" in content_str:
|
if "<uploaded_files>" in content_str:
|
||||||
# Strip the ephemeral upload block; keep the user's real question.
|
# Strip the ephemeral upload block; keep the user's real question.
|
||||||
stripped = _UPLOAD_BLOCK_RE.sub("", content_str).strip()
|
stripped = _UPLOAD_BLOCK_RE.sub("", content_str).strip()
|
||||||
@@ -87,6 +129,48 @@ def _filter_messages_for_memory(messages: list[Any]) -> list[Any]:
|
|||||||
return filtered
|
return filtered
|
||||||
|
|
||||||
|
|
||||||
|
def detect_correction(messages: list[Any]) -> bool:
|
||||||
|
"""Detect explicit user corrections in recent conversation turns.
|
||||||
|
|
||||||
|
The queue keeps only one pending context per thread, so callers pass the
|
||||||
|
latest filtered message list. Checking only recent user turns keeps signal
|
||||||
|
detection conservative while avoiding stale corrections from long histories.
|
||||||
|
"""
|
||||||
|
recent_user_msgs = [msg for msg in messages[-6:] if getattr(msg, "type", None) == "human"]
|
||||||
|
|
||||||
|
for msg in recent_user_msgs:
|
||||||
|
content = _extract_message_text(msg).strip()
|
||||||
|
if not content:
|
||||||
|
continue
|
||||||
|
if any(pattern.search(content) for pattern in _CORRECTION_PATTERNS):
|
||||||
|
return True
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def detect_reinforcement(messages: list[Any]) -> bool:
|
||||||
|
"""Detect explicit positive reinforcement signals in recent conversation turns.
|
||||||
|
|
||||||
|
Complements detect_correction() by identifying when the user confirms the
|
||||||
|
agent's approach was correct. This allows the memory system to record what
|
||||||
|
worked well, not just what went wrong.
|
||||||
|
|
||||||
|
The queue keeps only one pending context per thread, so callers pass the
|
||||||
|
latest filtered message list. Checking only recent user turns keeps signal
|
||||||
|
detection conservative while avoiding stale signals from long histories.
|
||||||
|
"""
|
||||||
|
recent_user_msgs = [msg for msg in messages[-6:] if getattr(msg, "type", None) == "human"]
|
||||||
|
|
||||||
|
for msg in recent_user_msgs:
|
||||||
|
content = _extract_message_text(msg).strip()
|
||||||
|
if not content:
|
||||||
|
continue
|
||||||
|
if any(pattern.search(content) for pattern in _REINFORCEMENT_PATTERNS):
|
||||||
|
return True
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
class MemoryMiddleware(AgentMiddleware[MemoryMiddlewareState]):
|
class MemoryMiddleware(AgentMiddleware[MemoryMiddlewareState]):
|
||||||
"""Middleware that queues conversation for memory update after agent execution.
|
"""Middleware that queues conversation for memory update after agent execution.
|
||||||
|
|
||||||
@@ -150,7 +234,15 @@ class MemoryMiddleware(AgentMiddleware[MemoryMiddlewareState]):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
# Queue the filtered conversation for memory update
|
# Queue the filtered conversation for memory update
|
||||||
|
correction_detected = detect_correction(filtered_messages)
|
||||||
|
reinforcement_detected = not correction_detected and detect_reinforcement(filtered_messages)
|
||||||
queue = get_memory_queue()
|
queue = get_memory_queue()
|
||||||
queue.add(thread_id=thread_id, messages=filtered_messages, agent_name=self._agent_name)
|
queue.add(
|
||||||
|
thread_id=thread_id,
|
||||||
|
messages=filtered_messages,
|
||||||
|
agent_name=self._agent_name,
|
||||||
|
correction_detected=correction_detected,
|
||||||
|
reinforcement_detected=reinforcement_detected,
|
||||||
|
)
|
||||||
|
|
||||||
return None
|
return None
|
||||||
|
|||||||
@@ -23,25 +23,119 @@ logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
# Each pattern is compiled once at import time.
|
# Each pattern is compiled once at import time.
|
||||||
_HIGH_RISK_PATTERNS: list[re.Pattern[str]] = [
|
_HIGH_RISK_PATTERNS: list[re.Pattern[str]] = [
|
||||||
re.compile(r"rm\s+-[^\s]*r[^\s]*\s+(/\*?|~/?\*?|/home\b|/root\b)\s*$"), # rm -rf / /* ~ /home /root
|
# --- original rules (retained) ---
|
||||||
re.compile(r"(curl|wget).+\|\s*(ba)?sh"), # curl|sh, wget|sh
|
re.compile(r"rm\s+-[^\s]*r[^\s]*\s+(/\*?|~/?\*?|/home\b|/root\b)\s*$"),
|
||||||
re.compile(r"dd\s+if="),
|
re.compile(r"dd\s+if="),
|
||||||
re.compile(r"mkfs"),
|
re.compile(r"mkfs"),
|
||||||
re.compile(r"cat\s+/etc/shadow"),
|
re.compile(r"cat\s+/etc/shadow"),
|
||||||
re.compile(r">\s*/etc/"), # overwrite /etc/ files
|
re.compile(r">+\s*/etc/"),
|
||||||
|
# --- pipe to sh/bash (generalised, replaces old curl|sh rule) ---
|
||||||
|
re.compile(r"\|\s*(ba)?sh\b"),
|
||||||
|
# --- command substitution (targeted – only dangerous executables) ---
|
||||||
|
re.compile(r"[`$]\(?\s*(curl|wget|bash|sh|python|ruby|perl|base64)"),
|
||||||
|
# --- base64 decode piped to execution ---
|
||||||
|
re.compile(r"base64\s+.*-d.*\|"),
|
||||||
|
# --- overwrite system binaries ---
|
||||||
|
re.compile(r">+\s*(/usr/bin/|/bin/|/sbin/)"),
|
||||||
|
# --- overwrite shell startup files ---
|
||||||
|
re.compile(r">+\s*~/?\.(bashrc|profile|zshrc|bash_profile)"),
|
||||||
|
# --- process environment leakage ---
|
||||||
|
re.compile(r"/proc/[^/]+/environ"),
|
||||||
|
# --- dynamic linker hijack (one-step escalation) ---
|
||||||
|
re.compile(r"\b(LD_PRELOAD|LD_LIBRARY_PATH)\s*="),
|
||||||
|
# --- bash built-in networking (bypasses tool allowlists) ---
|
||||||
|
re.compile(r"/dev/tcp/"),
|
||||||
|
# --- fork bomb ---
|
||||||
|
re.compile(r"\S+\(\)\s*\{[^}]*\|\s*\S+\s*&"), # :(){ :|:& };:
|
||||||
|
re.compile(r"while\s+true.*&\s*done"), # while true; do bash & done
|
||||||
]
|
]
|
||||||
|
|
||||||
_MEDIUM_RISK_PATTERNS: list[re.Pattern[str]] = [
|
_MEDIUM_RISK_PATTERNS: list[re.Pattern[str]] = [
|
||||||
re.compile(r"chmod\s+777"), # overly permissive, but reversible
|
re.compile(r"chmod\s+777"),
|
||||||
re.compile(r"pip\s+install"),
|
re.compile(r"pip3?\s+install"),
|
||||||
re.compile(r"pip3\s+install"),
|
|
||||||
re.compile(r"apt(-get)?\s+install"),
|
re.compile(r"apt(-get)?\s+install"),
|
||||||
|
# sudo/su: no-op under Docker root; warn so LLM is aware
|
||||||
|
re.compile(r"\b(sudo|su)\b"),
|
||||||
|
# PATH modification: long attack chain, warn rather than block
|
||||||
|
re.compile(r"\bPATH\s*="),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def _classify_command(command: str) -> str:
|
def _split_compound_command(command: str) -> list[str]:
|
||||||
"""Return 'block', 'warn', or 'pass'."""
|
"""Split a compound command into sub-commands (quote-aware).
|
||||||
# Normalize for matching (collapse whitespace)
|
|
||||||
|
Scans the raw command string so unquoted shell control operators are
|
||||||
|
recognised even when they are not surrounded by whitespace
|
||||||
|
(e.g. ``safe;rm -rf /`` or ``rm -rf /&&echo ok``). Operators inside
|
||||||
|
quotes are ignored. If the command ends with an unclosed quote or a
|
||||||
|
dangling escape, return the whole command unchanged (fail-closed —
|
||||||
|
safer to classify the unsplit string than silently drop parts).
|
||||||
|
"""
|
||||||
|
parts: list[str] = []
|
||||||
|
current: list[str] = []
|
||||||
|
in_single_quote = False
|
||||||
|
in_double_quote = False
|
||||||
|
escaping = False
|
||||||
|
index = 0
|
||||||
|
|
||||||
|
while index < len(command):
|
||||||
|
char = command[index]
|
||||||
|
|
||||||
|
if escaping:
|
||||||
|
current.append(char)
|
||||||
|
escaping = False
|
||||||
|
index += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if char == "\\" and not in_single_quote:
|
||||||
|
current.append(char)
|
||||||
|
escaping = True
|
||||||
|
index += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if char == "'" and not in_double_quote:
|
||||||
|
in_single_quote = not in_single_quote
|
||||||
|
current.append(char)
|
||||||
|
index += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if char == '"' and not in_single_quote:
|
||||||
|
in_double_quote = not in_double_quote
|
||||||
|
current.append(char)
|
||||||
|
index += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
if not in_single_quote and not in_double_quote:
|
||||||
|
if command.startswith("&&", index) or command.startswith("||", index):
|
||||||
|
part = "".join(current).strip()
|
||||||
|
if part:
|
||||||
|
parts.append(part)
|
||||||
|
current = []
|
||||||
|
index += 2
|
||||||
|
continue
|
||||||
|
if char == ";":
|
||||||
|
part = "".join(current).strip()
|
||||||
|
if part:
|
||||||
|
parts.append(part)
|
||||||
|
current = []
|
||||||
|
index += 1
|
||||||
|
continue
|
||||||
|
|
||||||
|
current.append(char)
|
||||||
|
index += 1
|
||||||
|
|
||||||
|
# Unclosed quote or dangling escape → fail-closed, return whole command
|
||||||
|
if in_single_quote or in_double_quote or escaping:
|
||||||
|
return [command]
|
||||||
|
|
||||||
|
part = "".join(current).strip()
|
||||||
|
if part:
|
||||||
|
parts.append(part)
|
||||||
|
return parts if parts else [command]
|
||||||
|
|
||||||
|
|
||||||
|
def _classify_single_command(command: str) -> str:
|
||||||
|
"""Classify a single (non-compound) command. Return 'block', 'warn', or 'pass'."""
|
||||||
normalized = " ".join(command.split())
|
normalized = " ".join(command.split())
|
||||||
|
|
||||||
for pattern in _HIGH_RISK_PATTERNS:
|
for pattern in _HIGH_RISK_PATTERNS:
|
||||||
@@ -66,6 +160,35 @@ def _classify_command(command: str) -> str:
|
|||||||
return "pass"
|
return "pass"
|
||||||
|
|
||||||
|
|
||||||
|
def _classify_command(command: str) -> str:
|
||||||
|
"""Return 'block', 'warn', or 'pass'.
|
||||||
|
|
||||||
|
Strategy:
|
||||||
|
1. First scan the *whole* raw command against high-risk patterns. This
|
||||||
|
catches structural attacks like ``while true; do bash & done`` or
|
||||||
|
``:(){ :|:& };:`` that span multiple shell statements — splitting them
|
||||||
|
on ``;`` would destroy the pattern context.
|
||||||
|
2. Then split compound commands (e.g. ``cmd1 && cmd2 ; cmd3``) and
|
||||||
|
classify each sub-command independently. The most severe verdict wins.
|
||||||
|
"""
|
||||||
|
# Pass 1: whole-command high-risk scan (catches multi-statement patterns)
|
||||||
|
normalized = " ".join(command.split())
|
||||||
|
for pattern in _HIGH_RISK_PATTERNS:
|
||||||
|
if pattern.search(normalized):
|
||||||
|
return "block"
|
||||||
|
|
||||||
|
# Pass 2: per-sub-command classification
|
||||||
|
sub_commands = _split_compound_command(command)
|
||||||
|
worst = "pass"
|
||||||
|
for sub in sub_commands:
|
||||||
|
verdict = _classify_single_command(sub)
|
||||||
|
if verdict == "block":
|
||||||
|
return "block" # short-circuit: can't get worse
|
||||||
|
if verdict == "warn":
|
||||||
|
worst = "warn"
|
||||||
|
return worst
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Middleware
|
# Middleware
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -105,11 +228,16 @@ class SandboxAuditMiddleware(AgentMiddleware[ThreadState]):
|
|||||||
thread_id = cfg.get("configurable", {}).get("thread_id")
|
thread_id = cfg.get("configurable", {}).get("thread_id")
|
||||||
return thread_id
|
return thread_id
|
||||||
|
|
||||||
def _write_audit(self, thread_id: str | None, command: str, verdict: str) -> None:
|
_AUDIT_COMMAND_LIMIT = 200
|
||||||
|
|
||||||
|
def _write_audit(self, thread_id: str | None, command: str, verdict: str, *, truncate: bool = False) -> None:
|
||||||
|
audited_command = command
|
||||||
|
if truncate and len(command) > self._AUDIT_COMMAND_LIMIT:
|
||||||
|
audited_command = f"{command[: self._AUDIT_COMMAND_LIMIT]}... ({len(command)} chars)"
|
||||||
record = {
|
record = {
|
||||||
"timestamp": datetime.now(UTC).isoformat(),
|
"timestamp": datetime.now(UTC).isoformat(),
|
||||||
"thread_id": thread_id or "unknown",
|
"thread_id": thread_id or "unknown",
|
||||||
"command": command,
|
"command": audited_command,
|
||||||
"verdict": verdict,
|
"verdict": verdict,
|
||||||
}
|
}
|
||||||
logger.info("[SandboxAudit] %s", json.dumps(record, ensure_ascii=False))
|
logger.info("[SandboxAudit] %s", json.dumps(record, ensure_ascii=False))
|
||||||
@@ -139,23 +267,52 @@ class SandboxAuditMiddleware(AgentMiddleware[ThreadState]):
|
|||||||
status=result.status,
|
status=result.status,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# Input sanitisation
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
# Normal bash commands rarely exceed a few hundred characters. 10 000 is
|
||||||
|
# well above any legitimate use case yet a tiny fraction of Linux ARG_MAX.
|
||||||
|
# Anything longer is almost certainly a payload injection or base64-encoded
|
||||||
|
# attack string.
|
||||||
|
_MAX_COMMAND_LENGTH = 10_000
|
||||||
|
|
||||||
|
def _validate_input(self, command: str) -> str | None:
|
||||||
|
"""Return ``None`` if *command* is acceptable, else a rejection reason."""
|
||||||
|
if not command.strip():
|
||||||
|
return "empty command"
|
||||||
|
if len(command) > self._MAX_COMMAND_LENGTH:
|
||||||
|
return "command too long"
|
||||||
|
if "\x00" in command:
|
||||||
|
return "null byte detected"
|
||||||
|
return None
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Core logic (shared between sync and async paths)
|
# Core logic (shared between sync and async paths)
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
def _pre_process(self, request: ToolCallRequest) -> tuple[str, str | None, str]:
|
def _pre_process(self, request: ToolCallRequest) -> tuple[str, str | None, str, str | None]:
|
||||||
"""
|
"""
|
||||||
Returns (command, thread_id, verdict).
|
Returns (command, thread_id, verdict, reject_reason).
|
||||||
verdict is 'block', 'warn', or 'pass'.
|
verdict is 'block', 'warn', or 'pass'.
|
||||||
|
reject_reason is non-None only for input sanitisation rejections.
|
||||||
"""
|
"""
|
||||||
args = request.tool_call.get("args", {})
|
args = request.tool_call.get("args", {})
|
||||||
command: str = args.get("command", "")
|
raw_command = args.get("command")
|
||||||
|
command = raw_command if isinstance(raw_command, str) else ""
|
||||||
thread_id = self._get_thread_id(request)
|
thread_id = self._get_thread_id(request)
|
||||||
|
|
||||||
# ① classify command
|
# ① input sanitisation — reject malformed input before regex analysis
|
||||||
|
reject_reason = self._validate_input(command)
|
||||||
|
if reject_reason:
|
||||||
|
self._write_audit(thread_id, command, "block", truncate=True)
|
||||||
|
logger.warning("[SandboxAudit] INVALID INPUT thread=%s reason=%s", thread_id, reject_reason)
|
||||||
|
return command, thread_id, "block", reject_reason
|
||||||
|
|
||||||
|
# ② classify command
|
||||||
verdict = _classify_command(command)
|
verdict = _classify_command(command)
|
||||||
|
|
||||||
# ② audit log
|
# ③ audit log
|
||||||
self._write_audit(thread_id, command, verdict)
|
self._write_audit(thread_id, command, verdict)
|
||||||
|
|
||||||
if verdict == "block":
|
if verdict == "block":
|
||||||
@@ -163,7 +320,7 @@ class SandboxAuditMiddleware(AgentMiddleware[ThreadState]):
|
|||||||
elif verdict == "warn":
|
elif verdict == "warn":
|
||||||
logger.warning("[SandboxAudit] WARN (medium-risk) thread=%s cmd=%r", thread_id, command)
|
logger.warning("[SandboxAudit] WARN (medium-risk) thread=%s cmd=%r", thread_id, command)
|
||||||
|
|
||||||
return command, thread_id, verdict
|
return command, thread_id, verdict, None
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# wrap_tool_call hooks
|
# wrap_tool_call hooks
|
||||||
@@ -178,9 +335,10 @@ class SandboxAuditMiddleware(AgentMiddleware[ThreadState]):
|
|||||||
if request.tool_call.get("name") != "bash":
|
if request.tool_call.get("name") != "bash":
|
||||||
return handler(request)
|
return handler(request)
|
||||||
|
|
||||||
command, _, verdict = self._pre_process(request)
|
command, _, verdict, reject_reason = self._pre_process(request)
|
||||||
if verdict == "block":
|
if verdict == "block":
|
||||||
return self._build_block_message(request, "security violation detected")
|
reason = reject_reason or "security violation detected"
|
||||||
|
return self._build_block_message(request, reason)
|
||||||
result = handler(request)
|
result = handler(request)
|
||||||
if verdict == "warn":
|
if verdict == "warn":
|
||||||
result = self._append_warn_to_result(result, command)
|
result = self._append_warn_to_result(result, command)
|
||||||
@@ -195,9 +353,10 @@ class SandboxAuditMiddleware(AgentMiddleware[ThreadState]):
|
|||||||
if request.tool_call.get("name") != "bash":
|
if request.tool_call.get("name") != "bash":
|
||||||
return await handler(request)
|
return await handler(request)
|
||||||
|
|
||||||
command, _, verdict = self._pre_process(request)
|
command, _, verdict, reject_reason = self._pre_process(request)
|
||||||
if verdict == "block":
|
if verdict == "block":
|
||||||
return self._build_block_message(request, "security violation detected")
|
reason = reject_reason or "security violation detected"
|
||||||
|
return self._build_block_message(request, reason)
|
||||||
result = await handler(request)
|
result = await handler(request)
|
||||||
if verdict == "warn":
|
if verdict == "warn":
|
||||||
result = self._append_warn_to_result(result, command)
|
result = self._append_warn_to_result(result, command)
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
"""Middleware for automatic thread title generation."""
|
"""Middleware for automatic thread title generation."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import NotRequired, override
|
from typing import Any, NotRequired, override
|
||||||
|
|
||||||
from langchain.agents import AgentState
|
from langchain.agents import AgentState
|
||||||
from langchain.agents.middleware import AgentMiddleware
|
from langchain.agents.middleware import AgentMiddleware
|
||||||
|
from langgraph.config import get_config
|
||||||
from langgraph.runtime import Runtime
|
from langgraph.runtime import Runtime
|
||||||
|
|
||||||
from deerflow.config.title_config import get_title_config
|
from deerflow.config.title_config import get_title_config
|
||||||
@@ -100,45 +101,48 @@ class TitleMiddleware(AgentMiddleware[TitleMiddlewareState]):
|
|||||||
return user_msg[:fallback_chars].rstrip() + "..."
|
return user_msg[:fallback_chars].rstrip() + "..."
|
||||||
return user_msg if user_msg else "New Conversation"
|
return user_msg if user_msg else "New Conversation"
|
||||||
|
|
||||||
|
def _get_runnable_config(self) -> dict[str, Any]:
|
||||||
|
"""Inherit the parent RunnableConfig and add middleware tag.
|
||||||
|
|
||||||
|
This ensures RunJournal identifies LLM calls from this middleware
|
||||||
|
as ``middleware:title`` instead of ``lead_agent``.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
parent = get_config()
|
||||||
|
except Exception:
|
||||||
|
parent = {}
|
||||||
|
config = {**parent}
|
||||||
|
config["tags"] = [*(config.get("tags") or []), "middleware:title"]
|
||||||
|
return config
|
||||||
|
|
||||||
def _generate_title_result(self, state: TitleMiddlewareState) -> dict | None:
|
def _generate_title_result(self, state: TitleMiddlewareState) -> dict | None:
|
||||||
"""Synchronously generate a title. Returns state update or None."""
|
"""Generate a local fallback title without blocking on an LLM call."""
|
||||||
if not self._should_generate_title(state):
|
if not self._should_generate_title(state):
|
||||||
return None
|
return None
|
||||||
|
|
||||||
prompt, user_msg = self._build_title_prompt(state)
|
_, user_msg = self._build_title_prompt(state)
|
||||||
config = get_title_config()
|
return {"title": self._fallback_title(user_msg)}
|
||||||
model = create_chat_model(name=config.model_name, thinking_enabled=False)
|
|
||||||
|
|
||||||
try:
|
|
||||||
response = model.invoke(prompt)
|
|
||||||
title = self._parse_title(response.content)
|
|
||||||
if not title:
|
|
||||||
title = self._fallback_title(user_msg)
|
|
||||||
except Exception:
|
|
||||||
logger.exception("Failed to generate title (sync)")
|
|
||||||
title = self._fallback_title(user_msg)
|
|
||||||
|
|
||||||
return {"title": title}
|
|
||||||
|
|
||||||
async def _agenerate_title_result(self, state: TitleMiddlewareState) -> dict | None:
|
async def _agenerate_title_result(self, state: TitleMiddlewareState) -> dict | None:
|
||||||
"""Asynchronously generate a title. Returns state update or None."""
|
"""Generate a title asynchronously and fall back locally on failure."""
|
||||||
if not self._should_generate_title(state):
|
if not self._should_generate_title(state):
|
||||||
return None
|
return None
|
||||||
|
|
||||||
prompt, user_msg = self._build_title_prompt(state)
|
|
||||||
config = get_title_config()
|
config = get_title_config()
|
||||||
model = create_chat_model(name=config.model_name, thinking_enabled=False)
|
prompt, user_msg = self._build_title_prompt(state)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
response = await model.ainvoke(prompt)
|
if config.model_name:
|
||||||
|
model = create_chat_model(name=config.model_name, thinking_enabled=False)
|
||||||
|
else:
|
||||||
|
model = create_chat_model(thinking_enabled=False)
|
||||||
|
response = await model.ainvoke(prompt, config=self._get_runnable_config())
|
||||||
title = self._parse_title(response.content)
|
title = self._parse_title(response.content)
|
||||||
if not title:
|
if title:
|
||||||
title = self._fallback_title(user_msg)
|
return {"title": title}
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.exception("Failed to generate title (async)")
|
logger.debug("Failed to generate async title; falling back to local title", exc_info=True)
|
||||||
title = self._fallback_title(user_msg)
|
return {"title": self._fallback_title(user_msg)}
|
||||||
|
|
||||||
return {"title": title}
|
|
||||||
|
|
||||||
@override
|
@override
|
||||||
def after_model(self, state: TitleMiddlewareState, runtime: Runtime) -> dict | None:
|
def after_model(self, state: TitleMiddlewareState, runtime: Runtime) -> dict | None:
|
||||||
|
|||||||
+4
-1
@@ -72,6 +72,7 @@ def _build_runtime_middlewares(
|
|||||||
lazy_init: bool = True,
|
lazy_init: bool = True,
|
||||||
) -> list[AgentMiddleware]:
|
) -> list[AgentMiddleware]:
|
||||||
"""Build shared base middlewares for agent execution."""
|
"""Build shared base middlewares for agent execution."""
|
||||||
|
from deerflow.agents.middlewares.llm_error_handling_middleware import LLMErrorHandlingMiddleware
|
||||||
from deerflow.agents.middlewares.thread_data_middleware import ThreadDataMiddleware
|
from deerflow.agents.middlewares.thread_data_middleware import ThreadDataMiddleware
|
||||||
from deerflow.sandbox.middleware import SandboxMiddleware
|
from deerflow.sandbox.middleware import SandboxMiddleware
|
||||||
|
|
||||||
@@ -90,6 +91,8 @@ def _build_runtime_middlewares(
|
|||||||
|
|
||||||
middlewares.append(DanglingToolCallMiddleware())
|
middlewares.append(DanglingToolCallMiddleware())
|
||||||
|
|
||||||
|
middlewares.append(LLMErrorHandlingMiddleware())
|
||||||
|
|
||||||
# Guardrail middleware (if configured)
|
# Guardrail middleware (if configured)
|
||||||
from deerflow.config.guardrails_config import get_guardrails_config
|
from deerflow.config.guardrails_config import get_guardrails_config
|
||||||
|
|
||||||
@@ -135,6 +138,6 @@ def build_subagent_runtime_middlewares(*, lazy_init: bool = True) -> list[AgentM
|
|||||||
"""Middlewares shared by subagent runtime before subagent-only middlewares."""
|
"""Middlewares shared by subagent runtime before subagent-only middlewares."""
|
||||||
return _build_runtime_middlewares(
|
return _build_runtime_middlewares(
|
||||||
include_uploads=False,
|
include_uploads=False,
|
||||||
include_dangling_tool_call_patch=False,
|
include_dangling_tool_call_patch=True,
|
||||||
lazy_init=lazy_init,
|
lazy_init=lazy_init,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -10,10 +10,52 @@ from langchain_core.messages import HumanMessage
|
|||||||
from langgraph.runtime import Runtime
|
from langgraph.runtime import Runtime
|
||||||
|
|
||||||
from deerflow.config.paths import Paths, get_paths
|
from deerflow.config.paths import Paths, get_paths
|
||||||
|
from deerflow.utils.file_conversion import extract_outline
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
_OUTLINE_PREVIEW_LINES = 5
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_outline_for_file(file_path: Path) -> tuple[list[dict], list[str]]:
|
||||||
|
"""Return the document outline and fallback preview for *file_path*.
|
||||||
|
|
||||||
|
Looks for a sibling ``<stem>.md`` file produced by the upload conversion
|
||||||
|
pipeline.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
(outline, preview) where:
|
||||||
|
- outline: list of ``{title, line}`` dicts (plus optional sentinel).
|
||||||
|
Empty when no headings are found or no .md exists.
|
||||||
|
- preview: first few non-empty lines of the .md, used as a content
|
||||||
|
anchor when outline is empty so the agent has some context.
|
||||||
|
Empty when outline is non-empty (no fallback needed).
|
||||||
|
"""
|
||||||
|
md_path = file_path.with_suffix(".md")
|
||||||
|
if not md_path.is_file():
|
||||||
|
return [], []
|
||||||
|
|
||||||
|
outline = extract_outline(md_path)
|
||||||
|
if outline:
|
||||||
|
logger.debug("Extracted %d outline entries from %s", len(outline), file_path.name)
|
||||||
|
return outline, []
|
||||||
|
|
||||||
|
# outline is empty — read the first few non-empty lines as a content preview
|
||||||
|
preview: list[str] = []
|
||||||
|
try:
|
||||||
|
with md_path.open(encoding="utf-8") as f:
|
||||||
|
for line in f:
|
||||||
|
stripped = line.strip()
|
||||||
|
if stripped:
|
||||||
|
preview.append(stripped)
|
||||||
|
if len(preview) >= _OUTLINE_PREVIEW_LINES:
|
||||||
|
break
|
||||||
|
except Exception:
|
||||||
|
logger.debug("Failed to read preview lines from %s", md_path, exc_info=True)
|
||||||
|
return [], preview
|
||||||
|
|
||||||
|
|
||||||
class UploadsMiddlewareState(AgentState):
|
class UploadsMiddlewareState(AgentState):
|
||||||
"""State schema for uploads middleware."""
|
"""State schema for uploads middleware."""
|
||||||
|
|
||||||
@@ -39,12 +81,38 @@ class UploadsMiddleware(AgentMiddleware[UploadsMiddlewareState]):
|
|||||||
super().__init__()
|
super().__init__()
|
||||||
self._paths = Paths(base_dir) if base_dir else get_paths()
|
self._paths = Paths(base_dir) if base_dir else get_paths()
|
||||||
|
|
||||||
|
def _format_file_entry(self, file: dict, lines: list[str]) -> None:
|
||||||
|
"""Append a single file entry (name, size, path, optional outline) to lines."""
|
||||||
|
size_kb = file["size"] / 1024
|
||||||
|
size_str = f"{size_kb:.1f} KB" if size_kb < 1024 else f"{size_kb / 1024:.1f} MB"
|
||||||
|
lines.append(f"- {file['filename']} ({size_str})")
|
||||||
|
lines.append(f" Path: {file['path']}")
|
||||||
|
outline = file.get("outline") or []
|
||||||
|
if outline:
|
||||||
|
truncated = outline[-1].get("truncated", False)
|
||||||
|
visible = [e for e in outline if not e.get("truncated")]
|
||||||
|
lines.append(" Document outline (use `read_file` with line ranges to read sections):")
|
||||||
|
for entry in visible:
|
||||||
|
lines.append(f" L{entry['line']}: {entry['title']}")
|
||||||
|
if truncated:
|
||||||
|
lines.append(f" ... (showing first {len(visible)} headings; use `read_file` to explore further)")
|
||||||
|
else:
|
||||||
|
preview = file.get("outline_preview") or []
|
||||||
|
if preview:
|
||||||
|
lines.append(" No structural headings detected. Document begins with:")
|
||||||
|
for text in preview:
|
||||||
|
lines.append(f" > {text}")
|
||||||
|
lines.append(" Use `grep` to search for keywords (e.g. `grep(pattern='keyword', path='/mnt/user-data/uploads/')`).")
|
||||||
|
lines.append("")
|
||||||
|
|
||||||
def _create_files_message(self, new_files: list[dict], historical_files: list[dict]) -> str:
|
def _create_files_message(self, new_files: list[dict], historical_files: list[dict]) -> str:
|
||||||
"""Create a formatted message listing uploaded files.
|
"""Create a formatted message listing uploaded files.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
new_files: Files uploaded in the current message.
|
new_files: Files uploaded in the current message.
|
||||||
historical_files: Files uploaded in previous messages.
|
historical_files: Files uploaded in previous messages.
|
||||||
|
Each file dict may contain an optional ``outline`` key — a list of
|
||||||
|
``{title, line}`` dicts extracted from the converted Markdown file.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Formatted string inside <uploaded_files> tags.
|
Formatted string inside <uploaded_files> tags.
|
||||||
@@ -55,25 +123,24 @@ class UploadsMiddleware(AgentMiddleware[UploadsMiddlewareState]):
|
|||||||
lines.append("")
|
lines.append("")
|
||||||
if new_files:
|
if new_files:
|
||||||
for file in new_files:
|
for file in new_files:
|
||||||
size_kb = file["size"] / 1024
|
self._format_file_entry(file, lines)
|
||||||
size_str = f"{size_kb:.1f} KB" if size_kb < 1024 else f"{size_kb / 1024:.1f} MB"
|
|
||||||
lines.append(f"- {file['filename']} ({size_str})")
|
|
||||||
lines.append(f" Path: {file['path']}")
|
|
||||||
lines.append("")
|
|
||||||
else:
|
else:
|
||||||
lines.append("(empty)")
|
lines.append("(empty)")
|
||||||
|
lines.append("")
|
||||||
|
|
||||||
if historical_files:
|
if historical_files:
|
||||||
lines.append("The following files were uploaded in previous messages and are still available:")
|
lines.append("The following files were uploaded in previous messages and are still available:")
|
||||||
lines.append("")
|
lines.append("")
|
||||||
for file in historical_files:
|
for file in historical_files:
|
||||||
size_kb = file["size"] / 1024
|
self._format_file_entry(file, lines)
|
||||||
size_str = f"{size_kb:.1f} KB" if size_kb < 1024 else f"{size_kb / 1024:.1f} MB"
|
|
||||||
lines.append(f"- {file['filename']} ({size_str})")
|
|
||||||
lines.append(f" Path: {file['path']}")
|
|
||||||
lines.append("")
|
|
||||||
|
|
||||||
lines.append("You can read these files using the `read_file` tool with the paths shown above.")
|
lines.append("To work with these files:")
|
||||||
|
lines.append("- Read from the file first — use the outline line numbers and `read_file` to locate relevant sections.")
|
||||||
|
lines.append("- Use `grep` to search for keywords when you are not sure which section to look at")
|
||||||
|
lines.append(" (e.g. `grep(pattern='revenue', path='/mnt/user-data/uploads/')`).")
|
||||||
|
lines.append("- Use `glob` to find files by name pattern")
|
||||||
|
lines.append(" (e.g. `glob(pattern='**/*.md', path='/mnt/user-data/uploads/')`).")
|
||||||
|
lines.append("- Only fall back to web search if the file content is clearly insufficient to answer the question.")
|
||||||
lines.append("</uploaded_files>")
|
lines.append("</uploaded_files>")
|
||||||
|
|
||||||
return "\n".join(lines)
|
return "\n".join(lines)
|
||||||
@@ -147,6 +214,13 @@ class UploadsMiddleware(AgentMiddleware[UploadsMiddlewareState]):
|
|||||||
|
|
||||||
# Resolve uploads directory for existence checks
|
# Resolve uploads directory for existence checks
|
||||||
thread_id = (runtime.context or {}).get("thread_id")
|
thread_id = (runtime.context or {}).get("thread_id")
|
||||||
|
if thread_id is None:
|
||||||
|
try:
|
||||||
|
from langgraph.config import get_config
|
||||||
|
|
||||||
|
thread_id = get_config().get("configurable", {}).get("thread_id")
|
||||||
|
except RuntimeError:
|
||||||
|
pass # get_config() raises outside a runnable context (e.g. unit tests)
|
||||||
uploads_dir = self._paths.sandbox_uploads_dir(thread_id) if thread_id else None
|
uploads_dir = self._paths.sandbox_uploads_dir(thread_id) if thread_id else None
|
||||||
|
|
||||||
# Get newly uploaded files from the current message's additional_kwargs.files
|
# Get newly uploaded files from the current message's additional_kwargs.files
|
||||||
@@ -159,15 +233,26 @@ class UploadsMiddleware(AgentMiddleware[UploadsMiddlewareState]):
|
|||||||
for file_path in sorted(uploads_dir.iterdir()):
|
for file_path in sorted(uploads_dir.iterdir()):
|
||||||
if file_path.is_file() and file_path.name not in new_filenames:
|
if file_path.is_file() and file_path.name not in new_filenames:
|
||||||
stat = file_path.stat()
|
stat = file_path.stat()
|
||||||
|
outline, preview = _extract_outline_for_file(file_path)
|
||||||
historical_files.append(
|
historical_files.append(
|
||||||
{
|
{
|
||||||
"filename": file_path.name,
|
"filename": file_path.name,
|
||||||
"size": stat.st_size,
|
"size": stat.st_size,
|
||||||
"path": f"/mnt/user-data/uploads/{file_path.name}",
|
"path": f"/mnt/user-data/uploads/{file_path.name}",
|
||||||
"extension": file_path.suffix,
|
"extension": file_path.suffix,
|
||||||
|
"outline": outline,
|
||||||
|
"outline_preview": preview,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Attach outlines to new files as well
|
||||||
|
if uploads_dir:
|
||||||
|
for file in new_files:
|
||||||
|
phys_path = uploads_dir / file["filename"]
|
||||||
|
outline, preview = _extract_outline_for_file(phys_path)
|
||||||
|
file["outline"] = outline
|
||||||
|
file["outline_preview"] = preview
|
||||||
|
|
||||||
if not new_files and not historical_files:
|
if not new_files and not historical_files:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|||||||
@@ -1,22 +1,19 @@
|
|||||||
"""Middleware for injecting image details into conversation before LLM call."""
|
"""Middleware for injecting image details into conversation before LLM call."""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
from typing import NotRequired, override
|
from typing import override
|
||||||
|
|
||||||
from langchain.agents import AgentState
|
|
||||||
from langchain.agents.middleware import AgentMiddleware
|
from langchain.agents.middleware import AgentMiddleware
|
||||||
from langchain_core.messages import AIMessage, HumanMessage, ToolMessage
|
from langchain_core.messages import AIMessage, HumanMessage, ToolMessage
|
||||||
from langgraph.runtime import Runtime
|
from langgraph.runtime import Runtime
|
||||||
|
|
||||||
from deerflow.agents.thread_state import ViewedImageData
|
from deerflow.agents.thread_state import ThreadState
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class ViewImageMiddlewareState(AgentState):
|
class ViewImageMiddlewareState(ThreadState):
|
||||||
"""Compatible with the `ThreadState` schema."""
|
"""Reuse the thread state so reducer-backed keys keep their annotations."""
|
||||||
|
|
||||||
viewed_images: NotRequired[dict[str, ViewedImageData] | None]
|
|
||||||
|
|
||||||
|
|
||||||
class ViewImageMiddleware(AgentMiddleware[ViewImageMiddlewareState]):
|
class ViewImageMiddleware(AgentMiddleware[ViewImageMiddlewareState]):
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ import uuid
|
|||||||
from collections.abc import Generator, Sequence
|
from collections.abc import Generator, Sequence
|
||||||
from dataclasses import dataclass, field
|
from dataclasses import dataclass, field
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any, Literal
|
||||||
|
|
||||||
from langchain.agents import create_agent
|
from langchain.agents import create_agent
|
||||||
from langchain.agents.middleware import AgentMiddleware
|
from langchain.agents.middleware import AgentMiddleware
|
||||||
@@ -55,6 +55,9 @@ from deerflow.uploads.manager import (
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
StreamEventType = Literal["values", "messages-tuple", "custom", "end"]
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
class StreamEvent:
|
class StreamEvent:
|
||||||
"""A single event from the streaming agent response.
|
"""A single event from the streaming agent response.
|
||||||
@@ -69,7 +72,7 @@ class StreamEvent:
|
|||||||
data: Event payload. Contents vary by type.
|
data: Event payload. Contents vary by type.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
type: str
|
type: StreamEventType
|
||||||
data: dict[str, Any] = field(default_factory=dict)
|
data: dict[str, Any] = field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
@@ -117,6 +120,7 @@ class DeerFlowClient:
|
|||||||
subagent_enabled: bool = False,
|
subagent_enabled: bool = False,
|
||||||
plan_mode: bool = False,
|
plan_mode: bool = False,
|
||||||
agent_name: str | None = None,
|
agent_name: str | None = None,
|
||||||
|
available_skills: set[str] | None = None,
|
||||||
middlewares: Sequence[AgentMiddleware] | None = None,
|
middlewares: Sequence[AgentMiddleware] | None = None,
|
||||||
):
|
):
|
||||||
"""Initialize the client.
|
"""Initialize the client.
|
||||||
@@ -133,6 +137,7 @@ class DeerFlowClient:
|
|||||||
subagent_enabled: Enable subagent delegation.
|
subagent_enabled: Enable subagent delegation.
|
||||||
plan_mode: Enable TodoList middleware for plan mode.
|
plan_mode: Enable TodoList middleware for plan mode.
|
||||||
agent_name: Name of the agent to use.
|
agent_name: Name of the agent to use.
|
||||||
|
available_skills: Optional set of skill names to make available. If None (default), all scanned skills are available.
|
||||||
middlewares: Optional list of custom middlewares to inject into the agent.
|
middlewares: Optional list of custom middlewares to inject into the agent.
|
||||||
"""
|
"""
|
||||||
if config_path is not None:
|
if config_path is not None:
|
||||||
@@ -148,6 +153,7 @@ class DeerFlowClient:
|
|||||||
self._subagent_enabled = subagent_enabled
|
self._subagent_enabled = subagent_enabled
|
||||||
self._plan_mode = plan_mode
|
self._plan_mode = plan_mode
|
||||||
self._agent_name = agent_name
|
self._agent_name = agent_name
|
||||||
|
self._available_skills = set(available_skills) if available_skills is not None else None
|
||||||
self._middlewares = list(middlewares) if middlewares else []
|
self._middlewares = list(middlewares) if middlewares else []
|
||||||
|
|
||||||
# Lazy agent — created on first call, recreated when config changes.
|
# Lazy agent — created on first call, recreated when config changes.
|
||||||
@@ -208,6 +214,8 @@ class DeerFlowClient:
|
|||||||
cfg.get("thinking_enabled"),
|
cfg.get("thinking_enabled"),
|
||||||
cfg.get("is_plan_mode"),
|
cfg.get("is_plan_mode"),
|
||||||
cfg.get("subagent_enabled"),
|
cfg.get("subagent_enabled"),
|
||||||
|
self._agent_name,
|
||||||
|
frozenset(self._available_skills) if self._available_skills is not None else None,
|
||||||
)
|
)
|
||||||
|
|
||||||
if self._agent is not None and self._agent_config_key == key:
|
if self._agent is not None and self._agent_config_key == key:
|
||||||
@@ -226,6 +234,7 @@ class DeerFlowClient:
|
|||||||
subagent_enabled=subagent_enabled,
|
subagent_enabled=subagent_enabled,
|
||||||
max_concurrent_subagents=max_concurrent_subagents,
|
max_concurrent_subagents=max_concurrent_subagents,
|
||||||
agent_name=self._agent_name,
|
agent_name=self._agent_name,
|
||||||
|
available_skills=self._available_skills,
|
||||||
),
|
),
|
||||||
"state_schema": ThreadState,
|
"state_schema": ThreadState,
|
||||||
}
|
}
|
||||||
@@ -248,13 +257,53 @@ class DeerFlowClient:
|
|||||||
|
|
||||||
return get_available_tools(model_name=model_name, subagent_enabled=subagent_enabled)
|
return get_available_tools(model_name=model_name, subagent_enabled=subagent_enabled)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _serialize_tool_calls(tool_calls) -> list[dict]:
|
||||||
|
"""Reshape LangChain tool_calls into the wire format used in events."""
|
||||||
|
return [{"name": tc["name"], "args": tc["args"], "id": tc.get("id")} for tc in tool_calls]
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _ai_text_event(msg_id: str | None, text: str, usage: dict | None) -> "StreamEvent":
|
||||||
|
"""Build a ``messages-tuple`` AI text event, attaching usage when present."""
|
||||||
|
data: dict[str, Any] = {"type": "ai", "content": text, "id": msg_id}
|
||||||
|
if usage:
|
||||||
|
data["usage_metadata"] = usage
|
||||||
|
return StreamEvent(type="messages-tuple", data=data)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _ai_tool_calls_event(msg_id: str | None, tool_calls) -> "StreamEvent":
|
||||||
|
"""Build a ``messages-tuple`` AI tool-calls event."""
|
||||||
|
return StreamEvent(
|
||||||
|
type="messages-tuple",
|
||||||
|
data={
|
||||||
|
"type": "ai",
|
||||||
|
"content": "",
|
||||||
|
"id": msg_id,
|
||||||
|
"tool_calls": DeerFlowClient._serialize_tool_calls(tool_calls),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _tool_message_event(msg: ToolMessage) -> "StreamEvent":
|
||||||
|
"""Build a ``messages-tuple`` tool-result event from a ToolMessage."""
|
||||||
|
return StreamEvent(
|
||||||
|
type="messages-tuple",
|
||||||
|
data={
|
||||||
|
"type": "tool",
|
||||||
|
"content": DeerFlowClient._extract_text(msg.content),
|
||||||
|
"name": msg.name,
|
||||||
|
"tool_call_id": msg.tool_call_id,
|
||||||
|
"id": msg.id,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _serialize_message(msg) -> dict:
|
def _serialize_message(msg) -> dict:
|
||||||
"""Serialize a LangChain message to a plain dict for values events."""
|
"""Serialize a LangChain message to a plain dict for values events."""
|
||||||
if isinstance(msg, AIMessage):
|
if isinstance(msg, AIMessage):
|
||||||
d: dict[str, Any] = {"type": "ai", "content": msg.content, "id": getattr(msg, "id", None)}
|
d: dict[str, Any] = {"type": "ai", "content": msg.content, "id": getattr(msg, "id", None)}
|
||||||
if msg.tool_calls:
|
if msg.tool_calls:
|
||||||
d["tool_calls"] = [{"name": tc["name"], "args": tc["args"], "id": tc.get("id")} for tc in msg.tool_calls]
|
d["tool_calls"] = DeerFlowClient._serialize_tool_calls(msg.tool_calls)
|
||||||
if getattr(msg, "usage_metadata", None):
|
if getattr(msg, "usage_metadata", None):
|
||||||
d["usage_metadata"] = msg.usage_metadata
|
d["usage_metadata"] = msg.usage_metadata
|
||||||
return d
|
return d
|
||||||
@@ -309,6 +358,108 @@ class DeerFlowClient:
|
|||||||
return "\n".join(pieces) if pieces else ""
|
return "\n".join(pieces) if pieces else ""
|
||||||
return str(content)
|
return str(content)
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
# Public API — threads
|
||||||
|
# ------------------------------------------------------------------
|
||||||
|
|
||||||
|
def list_threads(self, limit: int = 10) -> dict:
|
||||||
|
"""List the recent N threads.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
limit: Maximum number of threads to return. Default is 10.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dict with "thread_list" key containing list of thread info dicts,
|
||||||
|
sorted by thread creation time descending.
|
||||||
|
"""
|
||||||
|
checkpointer = self._checkpointer
|
||||||
|
if checkpointer is None:
|
||||||
|
from deerflow.agents.checkpointer.provider import get_checkpointer
|
||||||
|
|
||||||
|
checkpointer = get_checkpointer()
|
||||||
|
|
||||||
|
thread_info_map = {}
|
||||||
|
|
||||||
|
for cp in checkpointer.list(config=None, limit=limit):
|
||||||
|
cfg = cp.config.get("configurable", {})
|
||||||
|
thread_id = cfg.get("thread_id")
|
||||||
|
if not thread_id:
|
||||||
|
continue
|
||||||
|
|
||||||
|
ts = cp.checkpoint.get("ts")
|
||||||
|
checkpoint_id = cfg.get("checkpoint_id")
|
||||||
|
|
||||||
|
if thread_id not in thread_info_map:
|
||||||
|
channel_values = cp.checkpoint.get("channel_values", {})
|
||||||
|
thread_info_map[thread_id] = {
|
||||||
|
"thread_id": thread_id,
|
||||||
|
"created_at": ts,
|
||||||
|
"updated_at": ts,
|
||||||
|
"latest_checkpoint_id": checkpoint_id,
|
||||||
|
"title": channel_values.get("title"),
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
# Explicitly compare timestamps to ensure accuracy when iterating over unordered namespaces.
|
||||||
|
# Treat None as "missing" and only compare when existing values are non-None.
|
||||||
|
if ts is not None:
|
||||||
|
current_created = thread_info_map[thread_id]["created_at"]
|
||||||
|
if current_created is None or ts < current_created:
|
||||||
|
thread_info_map[thread_id]["created_at"] = ts
|
||||||
|
|
||||||
|
current_updated = thread_info_map[thread_id]["updated_at"]
|
||||||
|
if current_updated is None or ts > current_updated:
|
||||||
|
thread_info_map[thread_id]["updated_at"] = ts
|
||||||
|
thread_info_map[thread_id]["latest_checkpoint_id"] = checkpoint_id
|
||||||
|
channel_values = cp.checkpoint.get("channel_values", {})
|
||||||
|
thread_info_map[thread_id]["title"] = channel_values.get("title")
|
||||||
|
|
||||||
|
threads = list(thread_info_map.values())
|
||||||
|
threads.sort(key=lambda x: x.get("created_at") or "", reverse=True)
|
||||||
|
|
||||||
|
return {"thread_list": threads[:limit]}
|
||||||
|
|
||||||
|
def get_thread(self, thread_id: str) -> dict:
|
||||||
|
"""Get the complete thread record, including all node execution records.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
thread_id: Thread ID.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dict containing the thread's full checkpoint history.
|
||||||
|
"""
|
||||||
|
checkpointer = self._checkpointer
|
||||||
|
if checkpointer is None:
|
||||||
|
from deerflow.agents.checkpointer.provider import get_checkpointer
|
||||||
|
|
||||||
|
checkpointer = get_checkpointer()
|
||||||
|
|
||||||
|
config = {"configurable": {"thread_id": thread_id}}
|
||||||
|
checkpoints = []
|
||||||
|
|
||||||
|
for cp in checkpointer.list(config):
|
||||||
|
channel_values = dict(cp.checkpoint.get("channel_values", {}))
|
||||||
|
if "messages" in channel_values:
|
||||||
|
channel_values["messages"] = [self._serialize_message(m) if hasattr(m, "content") else m for m in channel_values["messages"]]
|
||||||
|
|
||||||
|
cfg = cp.config.get("configurable", {})
|
||||||
|
parent_cfg = cp.parent_config.get("configurable", {}) if cp.parent_config else {}
|
||||||
|
|
||||||
|
checkpoints.append(
|
||||||
|
{
|
||||||
|
"checkpoint_id": cfg.get("checkpoint_id"),
|
||||||
|
"parent_checkpoint_id": parent_cfg.get("checkpoint_id"),
|
||||||
|
"ts": cp.checkpoint.get("ts"),
|
||||||
|
"metadata": cp.metadata,
|
||||||
|
"values": channel_values,
|
||||||
|
"pending_writes": [{"task_id": w[0], "channel": w[1], "value": w[2]} for w in getattr(cp, "pending_writes", [])],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
# Sort globally by timestamp to prevent partial ordering issues caused by different namespaces (e.g., subgraphs)
|
||||||
|
checkpoints.sort(key=lambda x: x["ts"] if x["ts"] else "")
|
||||||
|
|
||||||
|
return {"thread_id": thread_id, "checkpoints": checkpoints}
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Public API — conversation
|
# Public API — conversation
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
@@ -330,6 +481,53 @@ class DeerFlowClient:
|
|||||||
consumers can switch between HTTP streaming and embedded mode
|
consumers can switch between HTTP streaming and embedded mode
|
||||||
without changing their event-handling logic.
|
without changing their event-handling logic.
|
||||||
|
|
||||||
|
Token-level streaming
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
This method subscribes to LangGraph's ``messages`` stream mode, so
|
||||||
|
``messages-tuple`` events for AI text are emitted as **deltas** as
|
||||||
|
the model generates tokens, not as one cumulative dump at node
|
||||||
|
completion. Each delta carries a stable ``id`` — consumers that
|
||||||
|
want the full text must accumulate ``content`` per ``id``.
|
||||||
|
``chat()`` already does this for you.
|
||||||
|
|
||||||
|
Tool calls and tool results are still emitted once per logical
|
||||||
|
message. ``values`` events continue to carry full state snapshots
|
||||||
|
after each graph node finishes; AI text already delivered via the
|
||||||
|
``messages`` stream is **not** re-synthesized from the snapshot to
|
||||||
|
avoid duplicate deliveries.
|
||||||
|
|
||||||
|
Why not reuse Gateway's ``run_agent``?
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Gateway (``runtime/runs/worker.py``) has a complete streaming
|
||||||
|
pipeline: ``run_agent`` → ``StreamBridge`` → ``sse_consumer``. It
|
||||||
|
looks like this client duplicates that work, but the two paths
|
||||||
|
serve different audiences and **cannot** share execution:
|
||||||
|
|
||||||
|
* ``run_agent`` is ``async def`` and uses ``agent.astream()``;
|
||||||
|
this method is a sync generator using ``agent.stream()`` so
|
||||||
|
callers can write ``for event in client.stream(...)`` without
|
||||||
|
touching asyncio. Bridging the two would require spinning up
|
||||||
|
an event loop + thread per call.
|
||||||
|
* Gateway events are JSON-serialized by ``serialize()`` for SSE
|
||||||
|
wire transmission. This client yields in-process stream event
|
||||||
|
payloads directly as Python data structures (``StreamEvent``
|
||||||
|
with ``data`` as a plain ``dict``), without the extra
|
||||||
|
JSON/SSE serialization layer used for HTTP delivery.
|
||||||
|
* ``StreamBridge`` is an asyncio-queue decoupling producers from
|
||||||
|
consumers across an HTTP boundary (``Last-Event-ID`` replay,
|
||||||
|
heartbeats, multi-subscriber fan-out). A single in-process
|
||||||
|
caller with a direct iterator needs none of that.
|
||||||
|
|
||||||
|
So ``DeerFlowClient.stream()`` is a parallel, sync, in-process
|
||||||
|
consumer of the same ``create_agent()`` factory — not a wrapper
|
||||||
|
around Gateway. The two paths **should** stay in sync on which
|
||||||
|
LangGraph stream modes they subscribe to; that invariant is
|
||||||
|
enforced by ``tests/test_client.py::test_messages_mode_emits_token_deltas``
|
||||||
|
rather than by a shared constant, because the three layers
|
||||||
|
(Graph, Platform SDK, HTTP) each use their own naming
|
||||||
|
(``messages`` vs ``messages-tuple``) and cannot literally share
|
||||||
|
a string.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
message: User message text.
|
message: User message text.
|
||||||
thread_id: Thread ID for conversation context. Auto-generated if None.
|
thread_id: Thread ID for conversation context. Auto-generated if None.
|
||||||
@@ -339,8 +537,9 @@ class DeerFlowClient:
|
|||||||
Yields:
|
Yields:
|
||||||
StreamEvent with one of:
|
StreamEvent with one of:
|
||||||
- type="values" data={"title": str|None, "messages": [...], "artifacts": [...]}
|
- type="values" data={"title": str|None, "messages": [...], "artifacts": [...]}
|
||||||
- type="messages-tuple" data={"type": "ai", "content": str, "id": str}
|
- type="custom" data={...}
|
||||||
- type="messages-tuple" data={"type": "ai", "content": str, "id": str, "usage_metadata": {...}}
|
- type="messages-tuple" data={"type": "ai", "content": <delta>, "id": str}
|
||||||
|
- type="messages-tuple" data={"type": "ai", "content": <delta>, "id": str, "usage_metadata": {...}}
|
||||||
- type="messages-tuple" data={"type": "ai", "content": "", "id": str, "tool_calls": [...]}
|
- type="messages-tuple" data={"type": "ai", "content": "", "id": str, "tool_calls": [...]}
|
||||||
- type="messages-tuple" data={"type": "tool", "content": str, "name": str, "tool_call_id": str, "id": str}
|
- type="messages-tuple" data={"type": "tool", "content": str, "name": str, "tool_call_id": str, "id": str}
|
||||||
- type="end" data={"usage": {"input_tokens": int, "output_tokens": int, "total_tokens": int}}
|
- type="end" data={"usage": {"input_tokens": int, "output_tokens": int, "total_tokens": int}}
|
||||||
@@ -357,9 +556,88 @@ class DeerFlowClient:
|
|||||||
context["agent_name"] = self._agent_name
|
context["agent_name"] = self._agent_name
|
||||||
|
|
||||||
seen_ids: set[str] = set()
|
seen_ids: set[str] = set()
|
||||||
|
# Cross-mode handoff: ids already streamed via LangGraph ``messages``
|
||||||
|
# mode so the ``values`` path skips re-synthesis of the same message.
|
||||||
|
streamed_ids: set[str] = set()
|
||||||
|
# The same message id carries identical cumulative ``usage_metadata``
|
||||||
|
# in both the final ``messages`` chunk and the values snapshot —
|
||||||
|
# count it only on whichever arrives first.
|
||||||
|
counted_usage_ids: set[str] = set()
|
||||||
cumulative_usage: dict[str, int] = {"input_tokens": 0, "output_tokens": 0, "total_tokens": 0}
|
cumulative_usage: dict[str, int] = {"input_tokens": 0, "output_tokens": 0, "total_tokens": 0}
|
||||||
|
|
||||||
for chunk in self._agent.stream(state, config=config, context=context, stream_mode="values"):
|
def _account_usage(msg_id: str | None, usage: Any) -> dict | None:
|
||||||
|
"""Add *usage* to cumulative totals if this id has not been counted.
|
||||||
|
|
||||||
|
``usage`` is a ``langchain_core.messages.UsageMetadata`` TypedDict
|
||||||
|
or ``None``; typed as ``Any`` because TypedDicts are not
|
||||||
|
structurally assignable to plain ``dict`` under strict type
|
||||||
|
checking. Returns the normalized usage dict (for attaching
|
||||||
|
to an event) when we accepted it, otherwise ``None``.
|
||||||
|
"""
|
||||||
|
if not usage:
|
||||||
|
return None
|
||||||
|
if msg_id and msg_id in counted_usage_ids:
|
||||||
|
return None
|
||||||
|
if msg_id:
|
||||||
|
counted_usage_ids.add(msg_id)
|
||||||
|
input_tokens = usage.get("input_tokens", 0) or 0
|
||||||
|
output_tokens = usage.get("output_tokens", 0) or 0
|
||||||
|
total_tokens = usage.get("total_tokens", 0) or 0
|
||||||
|
cumulative_usage["input_tokens"] += input_tokens
|
||||||
|
cumulative_usage["output_tokens"] += output_tokens
|
||||||
|
cumulative_usage["total_tokens"] += total_tokens
|
||||||
|
return {
|
||||||
|
"input_tokens": input_tokens,
|
||||||
|
"output_tokens": output_tokens,
|
||||||
|
"total_tokens": total_tokens,
|
||||||
|
}
|
||||||
|
|
||||||
|
for item in self._agent.stream(
|
||||||
|
state,
|
||||||
|
config=config,
|
||||||
|
context=context,
|
||||||
|
stream_mode=["values", "messages", "custom"],
|
||||||
|
):
|
||||||
|
if isinstance(item, tuple) and len(item) == 2:
|
||||||
|
mode, chunk = item
|
||||||
|
mode = str(mode)
|
||||||
|
else:
|
||||||
|
mode, chunk = "values", item
|
||||||
|
|
||||||
|
if mode == "custom":
|
||||||
|
yield StreamEvent(type="custom", data=chunk)
|
||||||
|
continue
|
||||||
|
|
||||||
|
if mode == "messages":
|
||||||
|
# LangGraph ``messages`` mode emits ``(message_chunk, metadata)``.
|
||||||
|
if isinstance(chunk, tuple) and len(chunk) == 2:
|
||||||
|
msg_chunk, _metadata = chunk
|
||||||
|
else:
|
||||||
|
msg_chunk = chunk
|
||||||
|
|
||||||
|
msg_id = getattr(msg_chunk, "id", None)
|
||||||
|
|
||||||
|
if isinstance(msg_chunk, AIMessage):
|
||||||
|
text = self._extract_text(msg_chunk.content)
|
||||||
|
counted_usage = _account_usage(msg_id, msg_chunk.usage_metadata)
|
||||||
|
|
||||||
|
if text:
|
||||||
|
if msg_id:
|
||||||
|
streamed_ids.add(msg_id)
|
||||||
|
yield self._ai_text_event(msg_id, text, counted_usage)
|
||||||
|
|
||||||
|
if msg_chunk.tool_calls:
|
||||||
|
if msg_id:
|
||||||
|
streamed_ids.add(msg_id)
|
||||||
|
yield self._ai_tool_calls_event(msg_id, msg_chunk.tool_calls)
|
||||||
|
|
||||||
|
elif isinstance(msg_chunk, ToolMessage):
|
||||||
|
if msg_id:
|
||||||
|
streamed_ids.add(msg_id)
|
||||||
|
yield self._tool_message_event(msg_chunk)
|
||||||
|
continue
|
||||||
|
|
||||||
|
# mode == "values"
|
||||||
messages = chunk.get("messages", [])
|
messages = chunk.get("messages", [])
|
||||||
|
|
||||||
for msg in messages:
|
for msg in messages:
|
||||||
@@ -369,47 +647,25 @@ class DeerFlowClient:
|
|||||||
if msg_id:
|
if msg_id:
|
||||||
seen_ids.add(msg_id)
|
seen_ids.add(msg_id)
|
||||||
|
|
||||||
|
# Already streamed via ``messages`` mode; only (defensively)
|
||||||
|
# capture usage here and skip re-synthesizing the event.
|
||||||
|
if msg_id and msg_id in streamed_ids:
|
||||||
|
if isinstance(msg, AIMessage):
|
||||||
|
_account_usage(msg_id, getattr(msg, "usage_metadata", None))
|
||||||
|
continue
|
||||||
|
|
||||||
if isinstance(msg, AIMessage):
|
if isinstance(msg, AIMessage):
|
||||||
# Track token usage from AI messages
|
counted_usage = _account_usage(msg_id, msg.usage_metadata)
|
||||||
usage = getattr(msg, "usage_metadata", None)
|
|
||||||
if usage:
|
|
||||||
cumulative_usage["input_tokens"] += usage.get("input_tokens", 0) or 0
|
|
||||||
cumulative_usage["output_tokens"] += usage.get("output_tokens", 0) or 0
|
|
||||||
cumulative_usage["total_tokens"] += usage.get("total_tokens", 0) or 0
|
|
||||||
|
|
||||||
if msg.tool_calls:
|
if msg.tool_calls:
|
||||||
yield StreamEvent(
|
yield self._ai_tool_calls_event(msg_id, msg.tool_calls)
|
||||||
type="messages-tuple",
|
|
||||||
data={
|
|
||||||
"type": "ai",
|
|
||||||
"content": "",
|
|
||||||
"id": msg_id,
|
|
||||||
"tool_calls": [{"name": tc["name"], "args": tc["args"], "id": tc.get("id")} for tc in msg.tool_calls],
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
text = self._extract_text(msg.content)
|
text = self._extract_text(msg.content)
|
||||||
if text:
|
if text:
|
||||||
event_data: dict[str, Any] = {"type": "ai", "content": text, "id": msg_id}
|
yield self._ai_text_event(msg_id, text, counted_usage)
|
||||||
if usage:
|
|
||||||
event_data["usage_metadata"] = {
|
|
||||||
"input_tokens": usage.get("input_tokens", 0) or 0,
|
|
||||||
"output_tokens": usage.get("output_tokens", 0) or 0,
|
|
||||||
"total_tokens": usage.get("total_tokens", 0) or 0,
|
|
||||||
}
|
|
||||||
yield StreamEvent(type="messages-tuple", data=event_data)
|
|
||||||
|
|
||||||
elif isinstance(msg, ToolMessage):
|
elif isinstance(msg, ToolMessage):
|
||||||
yield StreamEvent(
|
yield self._tool_message_event(msg)
|
||||||
type="messages-tuple",
|
|
||||||
data={
|
|
||||||
"type": "tool",
|
|
||||||
"content": self._extract_text(msg.content),
|
|
||||||
"name": getattr(msg, "name", None),
|
|
||||||
"tool_call_id": getattr(msg, "tool_call_id", None),
|
|
||||||
"id": msg_id,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
# Emit a values event for each state snapshot
|
# Emit a values event for each state snapshot
|
||||||
yield StreamEvent(
|
yield StreamEvent(
|
||||||
@@ -426,10 +682,12 @@ class DeerFlowClient:
|
|||||||
def chat(self, message: str, *, thread_id: str | None = None, **kwargs) -> str:
|
def chat(self, message: str, *, thread_id: str | None = None, **kwargs) -> str:
|
||||||
"""Send a message and return the final text response.
|
"""Send a message and return the final text response.
|
||||||
|
|
||||||
Convenience wrapper around :meth:`stream` that returns only the
|
Convenience wrapper around :meth:`stream` that accumulates delta
|
||||||
**last** AI text from ``messages-tuple`` events. If the agent emits
|
``messages-tuple`` events per ``id`` and returns the text of the
|
||||||
multiple text segments in one turn, intermediate segments are
|
**last** AI message to complete. Intermediate AI messages (e.g.
|
||||||
discarded. Use :meth:`stream` directly to capture all events.
|
planner drafts) are discarded — only the final id's accumulated
|
||||||
|
text is returned. Use :meth:`stream` directly if you need every
|
||||||
|
delta as it arrives.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
message: User message text.
|
message: User message text.
|
||||||
@@ -437,15 +695,21 @@ class DeerFlowClient:
|
|||||||
**kwargs: Override client defaults (same as stream()).
|
**kwargs: Override client defaults (same as stream()).
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
The last AI message text, or empty string if no response.
|
The accumulated text of the last AI message, or empty string
|
||||||
|
if no AI text was produced.
|
||||||
"""
|
"""
|
||||||
last_text = ""
|
# Per-id delta lists joined once at the end — avoids the O(n²) cost
|
||||||
|
# of repeated ``str + str`` on a growing buffer for long responses.
|
||||||
|
chunks: dict[str, list[str]] = {}
|
||||||
|
last_id: str = ""
|
||||||
for event in self.stream(message, thread_id=thread_id, **kwargs):
|
for event in self.stream(message, thread_id=thread_id, **kwargs):
|
||||||
if event.type == "messages-tuple" and event.data.get("type") == "ai":
|
if event.type == "messages-tuple" and event.data.get("type") == "ai":
|
||||||
content = event.data.get("content", "")
|
msg_id = event.data.get("id") or ""
|
||||||
if content:
|
delta = event.data.get("content", "")
|
||||||
last_text = content
|
if delta:
|
||||||
return last_text
|
chunks.setdefault(msg_id, []).append(delta)
|
||||||
|
last_id = msg_id
|
||||||
|
return "".join(chunks.get(last_id, ()))
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
# ------------------------------------------------------------------
|
||||||
# Public API — configuration queries
|
# Public API — configuration queries
|
||||||
|
|||||||
@@ -1,17 +1,25 @@
|
|||||||
import base64
|
import base64
|
||||||
import logging
|
import logging
|
||||||
|
import shlex
|
||||||
|
import threading
|
||||||
|
import uuid
|
||||||
|
|
||||||
from agent_sandbox import Sandbox as AioSandboxClient
|
from agent_sandbox import Sandbox as AioSandboxClient
|
||||||
|
|
||||||
from deerflow.sandbox.sandbox import Sandbox
|
from deerflow.sandbox.sandbox import Sandbox
|
||||||
|
from deerflow.sandbox.search import GrepMatch, path_matches, should_ignore_path, truncate_line
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_ERROR_OBSERVATION_SIGNATURE = "'ErrorObservation' object has no attribute 'exit_code'"
|
||||||
|
|
||||||
|
|
||||||
class AioSandbox(Sandbox):
|
class AioSandbox(Sandbox):
|
||||||
"""Sandbox implementation using the agent-infra/sandbox Docker container.
|
"""Sandbox implementation using the agent-infra/sandbox Docker container.
|
||||||
|
|
||||||
This sandbox connects to a running AIO sandbox container via HTTP API.
|
This sandbox connects to a running AIO sandbox container via HTTP API.
|
||||||
|
A threading lock serializes shell commands to prevent concurrent requests
|
||||||
|
from corrupting the container's single persistent session (see #1433).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, id: str, base_url: str, home_dir: str | None = None):
|
def __init__(self, id: str, base_url: str, home_dir: str | None = None):
|
||||||
@@ -26,6 +34,7 @@ class AioSandbox(Sandbox):
|
|||||||
self._base_url = base_url
|
self._base_url = base_url
|
||||||
self._client = AioSandboxClient(base_url=base_url, timeout=600)
|
self._client = AioSandboxClient(base_url=base_url, timeout=600)
|
||||||
self._home_dir = home_dir
|
self._home_dir = home_dir
|
||||||
|
self._lock = threading.Lock()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def base_url(self) -> str:
|
def base_url(self) -> str:
|
||||||
@@ -42,19 +51,34 @@ class AioSandbox(Sandbox):
|
|||||||
def execute_command(self, command: str) -> str:
|
def execute_command(self, command: str) -> str:
|
||||||
"""Execute a shell command in the sandbox.
|
"""Execute a shell command in the sandbox.
|
||||||
|
|
||||||
|
Uses a lock to serialize concurrent requests. The AIO sandbox
|
||||||
|
container maintains a single persistent shell session that
|
||||||
|
corrupts when hit with concurrent exec_command calls (returns
|
||||||
|
``ErrorObservation`` instead of real output). If corruption is
|
||||||
|
detected despite the lock (e.g. multiple processes sharing a
|
||||||
|
sandbox), the command is retried on a fresh session.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
command: The command to execute.
|
command: The command to execute.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
The output of the command.
|
The output of the command.
|
||||||
"""
|
"""
|
||||||
try:
|
with self._lock:
|
||||||
result = self._client.shell.exec_command(command=command)
|
try:
|
||||||
output = result.data.output if result.data else ""
|
result = self._client.shell.exec_command(command=command)
|
||||||
return output if output else "(no output)"
|
output = result.data.output if result.data else ""
|
||||||
except Exception as e:
|
|
||||||
logger.error(f"Failed to execute command in sandbox: {e}")
|
if output and _ERROR_OBSERVATION_SIGNATURE in output:
|
||||||
return f"Error: {e}"
|
logger.warning("ErrorObservation detected in sandbox output, retrying with a fresh session")
|
||||||
|
fresh_id = str(uuid.uuid4())
|
||||||
|
result = self._client.shell.exec_command(command=command, id=fresh_id)
|
||||||
|
output = result.data.output if result.data else ""
|
||||||
|
|
||||||
|
return output if output else "(no output)"
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"Failed to execute command in sandbox: {e}")
|
||||||
|
return f"Error: {e}"
|
||||||
|
|
||||||
def read_file(self, path: str) -> str:
|
def read_file(self, path: str) -> str:
|
||||||
"""Read the content of a file in the sandbox.
|
"""Read the content of a file in the sandbox.
|
||||||
@@ -82,17 +106,16 @@ class AioSandbox(Sandbox):
|
|||||||
Returns:
|
Returns:
|
||||||
The contents of the directory.
|
The contents of the directory.
|
||||||
"""
|
"""
|
||||||
try:
|
with self._lock:
|
||||||
# Use shell command to list directory with depth limit
|
try:
|
||||||
# The -L flag limits the depth for the tree command
|
result = self._client.shell.exec_command(command=f"find {shlex.quote(path)} -maxdepth {max_depth} -type f -o -type d 2>/dev/null | head -500")
|
||||||
result = self._client.shell.exec_command(command=f"find {path} -maxdepth {max_depth} -type f -o -type d 2>/dev/null | head -500")
|
output = result.data.output if result.data else ""
|
||||||
output = result.data.output if result.data else ""
|
if output:
|
||||||
if output:
|
return [line.strip() for line in output.strip().split("\n") if line.strip()]
|
||||||
return [line.strip() for line in output.strip().split("\n") if line.strip()]
|
return []
|
||||||
return []
|
except Exception as e:
|
||||||
except Exception as e:
|
logger.error(f"Failed to list directory in sandbox: {e}")
|
||||||
logger.error(f"Failed to list directory in sandbox: {e}")
|
return []
|
||||||
return []
|
|
||||||
|
|
||||||
def write_file(self, path: str, content: str, append: bool = False) -> None:
|
def write_file(self, path: str, content: str, append: bool = False) -> None:
|
||||||
"""Write content to a file in the sandbox.
|
"""Write content to a file in the sandbox.
|
||||||
@@ -102,16 +125,96 @@ class AioSandbox(Sandbox):
|
|||||||
content: The text content to write to the file.
|
content: The text content to write to the file.
|
||||||
append: Whether to append the content to the file.
|
append: Whether to append the content to the file.
|
||||||
"""
|
"""
|
||||||
try:
|
with self._lock:
|
||||||
if append:
|
try:
|
||||||
# Read existing content first and append
|
if append:
|
||||||
existing = self.read_file(path)
|
existing = self.read_file(path)
|
||||||
if not existing.startswith("Error:"):
|
if not existing.startswith("Error:"):
|
||||||
content = existing + content
|
content = existing + content
|
||||||
self._client.file.write_file(file=path, content=content)
|
self._client.file.write_file(file=path, content=content)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error(f"Failed to write file in sandbox: {e}")
|
logger.error(f"Failed to write file in sandbox: {e}")
|
||||||
raise
|
raise
|
||||||
|
|
||||||
|
def glob(self, path: str, pattern: str, *, include_dirs: bool = False, max_results: int = 200) -> tuple[list[str], bool]:
|
||||||
|
if not include_dirs:
|
||||||
|
result = self._client.file.find_files(path=path, glob=pattern)
|
||||||
|
files = result.data.files if result.data and result.data.files else []
|
||||||
|
filtered = [file_path for file_path in files if not should_ignore_path(file_path)]
|
||||||
|
truncated = len(filtered) > max_results
|
||||||
|
return filtered[:max_results], truncated
|
||||||
|
|
||||||
|
result = self._client.file.list_path(path=path, recursive=True, show_hidden=False)
|
||||||
|
entries = result.data.files if result.data and result.data.files else []
|
||||||
|
matches: list[str] = []
|
||||||
|
root_path = path.rstrip("/") or "/"
|
||||||
|
root_prefix = root_path if root_path == "/" else f"{root_path}/"
|
||||||
|
for entry in entries:
|
||||||
|
if entry.path != root_path and not entry.path.startswith(root_prefix):
|
||||||
|
continue
|
||||||
|
if should_ignore_path(entry.path):
|
||||||
|
continue
|
||||||
|
rel_path = entry.path[len(root_path) :].lstrip("/")
|
||||||
|
if path_matches(pattern, rel_path):
|
||||||
|
matches.append(entry.path)
|
||||||
|
if len(matches) >= max_results:
|
||||||
|
return matches, True
|
||||||
|
return matches, False
|
||||||
|
|
||||||
|
def grep(
|
||||||
|
self,
|
||||||
|
path: str,
|
||||||
|
pattern: str,
|
||||||
|
*,
|
||||||
|
glob: str | None = None,
|
||||||
|
literal: bool = False,
|
||||||
|
case_sensitive: bool = False,
|
||||||
|
max_results: int = 100,
|
||||||
|
) -> tuple[list[GrepMatch], bool]:
|
||||||
|
import re as _re
|
||||||
|
|
||||||
|
regex_source = _re.escape(pattern) if literal else pattern
|
||||||
|
# Validate the pattern locally so an invalid regex raises re.error
|
||||||
|
# (caught by grep_tool's except re.error handler) rather than a
|
||||||
|
# generic remote API error.
|
||||||
|
_re.compile(regex_source, 0 if case_sensitive else _re.IGNORECASE)
|
||||||
|
regex = regex_source if case_sensitive else f"(?i){regex_source}"
|
||||||
|
|
||||||
|
if glob is not None:
|
||||||
|
find_result = self._client.file.find_files(path=path, glob=glob)
|
||||||
|
candidate_paths = find_result.data.files if find_result.data and find_result.data.files else []
|
||||||
|
else:
|
||||||
|
list_result = self._client.file.list_path(path=path, recursive=True, show_hidden=False)
|
||||||
|
entries = list_result.data.files if list_result.data and list_result.data.files else []
|
||||||
|
candidate_paths = [entry.path for entry in entries if not entry.is_directory]
|
||||||
|
|
||||||
|
matches: list[GrepMatch] = []
|
||||||
|
truncated = False
|
||||||
|
|
||||||
|
for file_path in candidate_paths:
|
||||||
|
if should_ignore_path(file_path):
|
||||||
|
continue
|
||||||
|
|
||||||
|
search_result = self._client.file.search_in_file(file=file_path, regex=regex)
|
||||||
|
data = search_result.data
|
||||||
|
if data is None:
|
||||||
|
continue
|
||||||
|
|
||||||
|
line_numbers = data.line_numbers or []
|
||||||
|
matched_lines = data.matches or []
|
||||||
|
for line_number, line in zip(line_numbers, matched_lines):
|
||||||
|
matches.append(
|
||||||
|
GrepMatch(
|
||||||
|
path=file_path,
|
||||||
|
line_number=line_number if isinstance(line_number, int) else 0,
|
||||||
|
line=truncate_line(line),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if len(matches) >= max_results:
|
||||||
|
truncated = True
|
||||||
|
return matches, truncated
|
||||||
|
|
||||||
|
return matches, truncated
|
||||||
|
|
||||||
def update_file(self, path: str, content: bytes) -> None:
|
def update_file(self, path: str, content: bytes) -> None:
|
||||||
"""Update a file with binary content in the sandbox.
|
"""Update a file with binary content in the sandbox.
|
||||||
@@ -120,9 +223,10 @@ class AioSandbox(Sandbox):
|
|||||||
path: The absolute path of the file to update.
|
path: The absolute path of the file to update.
|
||||||
content: The binary content to write to the file.
|
content: The binary content to write to the file.
|
||||||
"""
|
"""
|
||||||
try:
|
with self._lock:
|
||||||
base64_content = base64.b64encode(content).decode("utf-8")
|
try:
|
||||||
self._client.file.write_file(file=path, content=base64_content, encoding="base64")
|
base64_content = base64.b64encode(content).decode("utf-8")
|
||||||
except Exception as e:
|
self._client.file.write_file(file=path, content=base64_content, encoding="base64")
|
||||||
logger.error(f"Failed to update file in sandbox: {e}")
|
except Exception as e:
|
||||||
raise
|
logger.error(f"Failed to update file in sandbox: {e}")
|
||||||
|
raise
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ except ImportError: # pragma: no cover - Windows fallback
|
|||||||
import msvcrt
|
import msvcrt
|
||||||
|
|
||||||
from deerflow.config import get_app_config
|
from deerflow.config import get_app_config
|
||||||
from deerflow.config.paths import VIRTUAL_PATH_PREFIX, Paths, get_paths
|
from deerflow.config.paths import VIRTUAL_PATH_PREFIX, get_paths
|
||||||
from deerflow.sandbox.sandbox import Sandbox
|
from deerflow.sandbox.sandbox import Sandbox
|
||||||
from deerflow.sandbox.sandbox_provider import SandboxProvider
|
from deerflow.sandbox.sandbox_provider import SandboxProvider
|
||||||
|
|
||||||
@@ -112,6 +112,9 @@ class AioSandboxProvider(SandboxProvider):
|
|||||||
atexit.register(self.shutdown)
|
atexit.register(self.shutdown)
|
||||||
self._register_signal_handlers()
|
self._register_signal_handlers()
|
||||||
|
|
||||||
|
# Reconcile orphaned containers from previous process lifecycles
|
||||||
|
self._reconcile_orphans()
|
||||||
|
|
||||||
# Start idle checker if enabled
|
# Start idle checker if enabled
|
||||||
if self._config.get("idle_timeout", DEFAULT_IDLE_TIMEOUT) > 0:
|
if self._config.get("idle_timeout", DEFAULT_IDLE_TIMEOUT) > 0:
|
||||||
self._start_idle_checker()
|
self._start_idle_checker()
|
||||||
@@ -175,6 +178,51 @@ class AioSandboxProvider(SandboxProvider):
|
|||||||
resolved[key] = str(value)
|
resolved[key] = str(value)
|
||||||
return resolved
|
return resolved
|
||||||
|
|
||||||
|
# ── Startup reconciliation ────────────────────────────────────────────
|
||||||
|
|
||||||
|
def _reconcile_orphans(self) -> None:
|
||||||
|
"""Reconcile orphaned containers left by previous process lifecycles.
|
||||||
|
|
||||||
|
On startup, enumerate all running containers matching our prefix
|
||||||
|
and adopt them all into the warm pool. The idle checker will reclaim
|
||||||
|
containers that nobody re-acquires within ``idle_timeout``.
|
||||||
|
|
||||||
|
All containers are adopted unconditionally because we cannot
|
||||||
|
distinguish "orphaned" from "actively used by another process"
|
||||||
|
based on age alone — ``idle_timeout`` represents inactivity, not
|
||||||
|
uptime. Adopting into the warm pool and letting the idle checker
|
||||||
|
decide avoids destroying containers that a concurrent process may
|
||||||
|
still be using.
|
||||||
|
|
||||||
|
This closes the fundamental gap where in-memory state loss (process
|
||||||
|
restart, crash, SIGKILL) leaves Docker containers running forever.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
running = self._backend.list_running()
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning(f"Failed to enumerate running containers during startup reconciliation: {e}")
|
||||||
|
return
|
||||||
|
|
||||||
|
if not running:
|
||||||
|
return
|
||||||
|
|
||||||
|
current_time = time.time()
|
||||||
|
adopted = 0
|
||||||
|
|
||||||
|
for info in running:
|
||||||
|
age = current_time - info.created_at if info.created_at > 0 else float("inf")
|
||||||
|
# Single lock acquisition per container: atomic check-and-insert.
|
||||||
|
# Avoids a TOCTOU window between the "already tracked?" check and
|
||||||
|
# the warm-pool insert.
|
||||||
|
with self._lock:
|
||||||
|
if info.sandbox_id in self._sandboxes or info.sandbox_id in self._warm_pool:
|
||||||
|
continue
|
||||||
|
self._warm_pool[info.sandbox_id] = (info, current_time)
|
||||||
|
adopted += 1
|
||||||
|
logger.info(f"Adopted container {info.sandbox_id} into warm pool (age: {age:.0f}s)")
|
||||||
|
|
||||||
|
logger.info(f"Startup reconciliation complete: {adopted} adopted into warm pool, {len(running)} total found")
|
||||||
|
|
||||||
# ── Deterministic ID ─────────────────────────────────────────────────
|
# ── Deterministic ID ─────────────────────────────────────────────────
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
@@ -214,17 +262,13 @@ class AioSandboxProvider(SandboxProvider):
|
|||||||
paths = get_paths()
|
paths = get_paths()
|
||||||
paths.ensure_thread_dirs(thread_id)
|
paths.ensure_thread_dirs(thread_id)
|
||||||
|
|
||||||
# host_paths resolves to the host-side base dir when DEER_FLOW_HOST_BASE_DIR
|
|
||||||
# is set, otherwise falls back to the container's own base dir (native mode).
|
|
||||||
host_paths = Paths(base_dir=paths.host_base_dir)
|
|
||||||
|
|
||||||
return [
|
return [
|
||||||
(str(host_paths.sandbox_work_dir(thread_id)), f"{VIRTUAL_PATH_PREFIX}/workspace", False),
|
(paths.host_sandbox_work_dir(thread_id), f"{VIRTUAL_PATH_PREFIX}/workspace", False),
|
||||||
(str(host_paths.sandbox_uploads_dir(thread_id)), f"{VIRTUAL_PATH_PREFIX}/uploads", False),
|
(paths.host_sandbox_uploads_dir(thread_id), f"{VIRTUAL_PATH_PREFIX}/uploads", False),
|
||||||
(str(host_paths.sandbox_outputs_dir(thread_id)), f"{VIRTUAL_PATH_PREFIX}/outputs", False),
|
(paths.host_sandbox_outputs_dir(thread_id), f"{VIRTUAL_PATH_PREFIX}/outputs", False),
|
||||||
# ACP workspace: read-only inside the sandbox (lead agent reads results;
|
# ACP workspace: read-only inside the sandbox (lead agent reads results;
|
||||||
# the ACP subprocess writes from the host side, not from within the container).
|
# the ACP subprocess writes from the host side, not from within the container).
|
||||||
(str(host_paths.acp_workspace_dir(thread_id)), "/mnt/acp-workspace", True),
|
(paths.host_acp_workspace_dir(thread_id), "/mnt/acp-workspace", True),
|
||||||
]
|
]
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
@@ -320,13 +364,23 @@ class AioSandboxProvider(SandboxProvider):
|
|||||||
# ── Signal handling ──────────────────────────────────────────────────
|
# ── Signal handling ──────────────────────────────────────────────────
|
||||||
|
|
||||||
def _register_signal_handlers(self) -> None:
|
def _register_signal_handlers(self) -> None:
|
||||||
"""Register signal handlers for graceful shutdown."""
|
"""Register signal handlers for graceful shutdown.
|
||||||
|
|
||||||
|
Handles SIGTERM, SIGINT, and SIGHUP (terminal close) to ensure
|
||||||
|
sandbox containers are cleaned up even when the user closes the terminal.
|
||||||
|
"""
|
||||||
self._original_sigterm = signal.getsignal(signal.SIGTERM)
|
self._original_sigterm = signal.getsignal(signal.SIGTERM)
|
||||||
self._original_sigint = signal.getsignal(signal.SIGINT)
|
self._original_sigint = signal.getsignal(signal.SIGINT)
|
||||||
|
self._original_sighup = signal.getsignal(signal.SIGHUP) if hasattr(signal, "SIGHUP") else None
|
||||||
|
|
||||||
def signal_handler(signum, frame):
|
def signal_handler(signum, frame):
|
||||||
self.shutdown()
|
self.shutdown()
|
||||||
original = self._original_sigterm if signum == signal.SIGTERM else self._original_sigint
|
if signum == signal.SIGTERM:
|
||||||
|
original = self._original_sigterm
|
||||||
|
elif hasattr(signal, "SIGHUP") and signum == signal.SIGHUP:
|
||||||
|
original = self._original_sighup
|
||||||
|
else:
|
||||||
|
original = self._original_sigint
|
||||||
if callable(original):
|
if callable(original):
|
||||||
original(signum, frame)
|
original(signum, frame)
|
||||||
elif original == signal.SIG_DFL:
|
elif original == signal.SIG_DFL:
|
||||||
@@ -336,6 +390,8 @@ class AioSandboxProvider(SandboxProvider):
|
|||||||
try:
|
try:
|
||||||
signal.signal(signal.SIGTERM, signal_handler)
|
signal.signal(signal.SIGTERM, signal_handler)
|
||||||
signal.signal(signal.SIGINT, signal_handler)
|
signal.signal(signal.SIGINT, signal_handler)
|
||||||
|
if hasattr(signal, "SIGHUP"):
|
||||||
|
signal.signal(signal.SIGHUP, signal_handler)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
logger.debug("Could not register signal handlers (not main thread)")
|
logger.debug("Could not register signal handlers (not main thread)")
|
||||||
|
|
||||||
|
|||||||
@@ -96,3 +96,19 @@ class SandboxBackend(ABC):
|
|||||||
SandboxInfo if found and healthy, None otherwise.
|
SandboxInfo if found and healthy, None otherwise.
|
||||||
"""
|
"""
|
||||||
...
|
...
|
||||||
|
|
||||||
|
def list_running(self) -> list[SandboxInfo]:
|
||||||
|
"""Enumerate all running sandboxes managed by this backend.
|
||||||
|
|
||||||
|
Used for startup reconciliation: when the process restarts, it needs
|
||||||
|
to discover containers started by previous processes so they can be
|
||||||
|
adopted into the warm pool or destroyed if idle too long.
|
||||||
|
|
||||||
|
The default implementation returns an empty list, which is correct
|
||||||
|
for backends that don't manage local containers (e.g., RemoteSandboxBackend
|
||||||
|
delegates lifecycle to the provisioner which handles its own cleanup).
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A list of SandboxInfo for all currently running sandboxes.
|
||||||
|
"""
|
||||||
|
return []
|
||||||
|
|||||||
@@ -6,9 +6,11 @@ Handles container lifecycle, port allocation, and cross-process container discov
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import subprocess
|
import subprocess
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
from deerflow.utils.network import get_free_port, release_port
|
from deerflow.utils.network import get_free_port, release_port
|
||||||
|
|
||||||
@@ -18,6 +20,72 @@ from .sandbox_info import SandboxInfo
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_docker_timestamp(raw: str) -> float:
|
||||||
|
"""Parse Docker's ISO 8601 timestamp into a Unix epoch float.
|
||||||
|
|
||||||
|
Docker returns timestamps with nanosecond precision and a trailing ``Z``
|
||||||
|
(e.g. ``2026-04-08T01:22:50.123456789Z``). Python's ``fromisoformat``
|
||||||
|
accepts at most microseconds and (pre-3.11) does not accept ``Z``, so the
|
||||||
|
string is normalized before parsing. Returns ``0.0`` on empty input or
|
||||||
|
parse failure so callers can use ``0.0`` as a sentinel for "unknown age".
|
||||||
|
"""
|
||||||
|
if not raw:
|
||||||
|
return 0.0
|
||||||
|
try:
|
||||||
|
s = raw.strip()
|
||||||
|
if "." in s:
|
||||||
|
dot_pos = s.index(".")
|
||||||
|
tz_start = dot_pos + 1
|
||||||
|
while tz_start < len(s) and s[tz_start].isdigit():
|
||||||
|
tz_start += 1
|
||||||
|
frac = s[dot_pos + 1 : tz_start][:6] # truncate to microseconds
|
||||||
|
tz_suffix = s[tz_start:]
|
||||||
|
s = s[: dot_pos + 1] + frac + tz_suffix
|
||||||
|
if s.endswith("Z"):
|
||||||
|
s = s[:-1] + "+00:00"
|
||||||
|
return datetime.fromisoformat(s).timestamp()
|
||||||
|
except (ValueError, TypeError) as e:
|
||||||
|
logger.debug(f"Could not parse docker timestamp {raw!r}: {e}")
|
||||||
|
return 0.0
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_host_port(inspect_entry: dict, container_port: int) -> int | None:
|
||||||
|
"""Extract the host port mapped to ``container_port/tcp`` from a docker inspect entry.
|
||||||
|
|
||||||
|
Returns None if the container has no port mapping for that port.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
ports = (inspect_entry.get("NetworkSettings") or {}).get("Ports") or {}
|
||||||
|
bindings = ports.get(f"{container_port}/tcp") or []
|
||||||
|
if bindings:
|
||||||
|
host_port = bindings[0].get("HostPort")
|
||||||
|
if host_port:
|
||||||
|
return int(host_port)
|
||||||
|
except (ValueError, TypeError, AttributeError):
|
||||||
|
pass
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _format_container_mount(runtime: str, host_path: str, container_path: str, read_only: bool) -> list[str]:
|
||||||
|
"""Format a bind-mount argument for the selected runtime.
|
||||||
|
|
||||||
|
Docker's ``-v host:container`` syntax is ambiguous for Windows drive-letter
|
||||||
|
paths like ``D:/...`` because ``:`` is both the drive separator and the
|
||||||
|
volume separator. Use ``--mount type=bind,...`` for Docker to avoid that
|
||||||
|
parsing ambiguity. Apple Container keeps using ``-v``.
|
||||||
|
"""
|
||||||
|
if runtime == "docker":
|
||||||
|
mount_spec = f"type=bind,src={host_path},dst={container_path}"
|
||||||
|
if read_only:
|
||||||
|
mount_spec += ",readonly"
|
||||||
|
return ["--mount", mount_spec]
|
||||||
|
|
||||||
|
mount_spec = f"{host_path}:{container_path}"
|
||||||
|
if read_only:
|
||||||
|
mount_spec += ":ro"
|
||||||
|
return ["-v", mount_spec]
|
||||||
|
|
||||||
|
|
||||||
class LocalContainerBackend(SandboxBackend):
|
class LocalContainerBackend(SandboxBackend):
|
||||||
"""Backend that manages sandbox containers locally using Docker or Apple Container.
|
"""Backend that manages sandbox containers locally using Docker or Apple Container.
|
||||||
|
|
||||||
@@ -152,8 +220,12 @@ class LocalContainerBackend(SandboxBackend):
|
|||||||
|
|
||||||
def destroy(self, info: SandboxInfo) -> None:
|
def destroy(self, info: SandboxInfo) -> None:
|
||||||
"""Stop the container and release its port."""
|
"""Stop the container and release its port."""
|
||||||
if info.container_id:
|
# Prefer container_id, fall back to container_name (both accepted by docker stop).
|
||||||
self._stop_container(info.container_id)
|
# This ensures containers discovered via list_running() (which only has the name)
|
||||||
|
# can also be stopped.
|
||||||
|
stop_target = info.container_id or info.container_name
|
||||||
|
if stop_target:
|
||||||
|
self._stop_container(stop_target)
|
||||||
# Extract port from sandbox_url for release
|
# Extract port from sandbox_url for release
|
||||||
try:
|
try:
|
||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
@@ -202,6 +274,129 @@ class LocalContainerBackend(SandboxBackend):
|
|||||||
container_name=container_name,
|
container_name=container_name,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def list_running(self) -> list[SandboxInfo]:
|
||||||
|
"""Enumerate all running containers matching the configured prefix.
|
||||||
|
|
||||||
|
Uses a single ``docker ps`` call to list container names, then a
|
||||||
|
single batched ``docker inspect`` call to retrieve creation timestamp
|
||||||
|
and port mapping for all containers at once. Total subprocess calls:
|
||||||
|
2 (down from 2N+1 in the naive per-container approach).
|
||||||
|
|
||||||
|
Note: Docker's ``--filter name=`` performs *substring* matching,
|
||||||
|
so a secondary ``startswith`` check is applied to ensure only
|
||||||
|
containers with the exact prefix are included.
|
||||||
|
|
||||||
|
Containers without port mappings are still included (with empty
|
||||||
|
sandbox_url) so that startup reconciliation can adopt orphans
|
||||||
|
regardless of their port state.
|
||||||
|
"""
|
||||||
|
# Step 1: enumerate container names via docker ps
|
||||||
|
try:
|
||||||
|
result = subprocess.run(
|
||||||
|
[
|
||||||
|
self._runtime,
|
||||||
|
"ps",
|
||||||
|
"--filter",
|
||||||
|
f"name={self._container_prefix}-",
|
||||||
|
"--format",
|
||||||
|
"{{.Names}}",
|
||||||
|
],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=10,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
stderr = (result.stderr or "").strip()
|
||||||
|
logger.warning(
|
||||||
|
"Failed to list running containers with %s ps (returncode=%s, stderr=%s)",
|
||||||
|
self._runtime,
|
||||||
|
result.returncode,
|
||||||
|
stderr or "<empty>",
|
||||||
|
)
|
||||||
|
return []
|
||||||
|
if not result.stdout.strip():
|
||||||
|
return []
|
||||||
|
except (subprocess.CalledProcessError, subprocess.TimeoutExpired, FileNotFoundError, OSError) as e:
|
||||||
|
logger.warning(f"Failed to list running containers: {e}")
|
||||||
|
return []
|
||||||
|
|
||||||
|
# Filter to names matching our exact prefix (docker filter is substring-based)
|
||||||
|
container_names = [name.strip() for name in result.stdout.strip().splitlines() if name.strip().startswith(self._container_prefix + "-")]
|
||||||
|
if not container_names:
|
||||||
|
return []
|
||||||
|
|
||||||
|
# Step 2: batched docker inspect — single subprocess call for all containers
|
||||||
|
inspections = self._batch_inspect(container_names)
|
||||||
|
|
||||||
|
infos: list[SandboxInfo] = []
|
||||||
|
sandbox_host = os.environ.get("DEER_FLOW_SANDBOX_HOST", "localhost")
|
||||||
|
for container_name in container_names:
|
||||||
|
data = inspections.get(container_name)
|
||||||
|
if data is None:
|
||||||
|
# Container disappeared between ps and inspect, or inspect failed
|
||||||
|
continue
|
||||||
|
created_at, host_port = data
|
||||||
|
sandbox_id = container_name[len(self._container_prefix) + 1 :]
|
||||||
|
sandbox_url = f"http://{sandbox_host}:{host_port}" if host_port else ""
|
||||||
|
|
||||||
|
infos.append(
|
||||||
|
SandboxInfo(
|
||||||
|
sandbox_id=sandbox_id,
|
||||||
|
sandbox_url=sandbox_url,
|
||||||
|
container_name=container_name,
|
||||||
|
created_at=created_at,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(f"Found {len(infos)} running sandbox container(s)")
|
||||||
|
return infos
|
||||||
|
|
||||||
|
def _batch_inspect(self, container_names: list[str]) -> dict[str, tuple[float, int | None]]:
|
||||||
|
"""Batch-inspect containers in a single subprocess call.
|
||||||
|
|
||||||
|
Returns a mapping of ``container_name -> (created_at, host_port)``.
|
||||||
|
Missing containers or parse failures are silently dropped from the result.
|
||||||
|
"""
|
||||||
|
if not container_names:
|
||||||
|
return {}
|
||||||
|
try:
|
||||||
|
result = subprocess.run(
|
||||||
|
[self._runtime, "inspect", *container_names],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=15,
|
||||||
|
)
|
||||||
|
except (subprocess.CalledProcessError, subprocess.TimeoutExpired, FileNotFoundError, OSError) as e:
|
||||||
|
logger.warning(f"Failed to batch-inspect containers: {e}")
|
||||||
|
return {}
|
||||||
|
|
||||||
|
if result.returncode != 0:
|
||||||
|
stderr = (result.stderr or "").strip()
|
||||||
|
logger.warning(
|
||||||
|
"Failed to batch-inspect containers with %s inspect (returncode=%s, stderr=%s)",
|
||||||
|
self._runtime,
|
||||||
|
result.returncode,
|
||||||
|
stderr or "<empty>",
|
||||||
|
)
|
||||||
|
return {}
|
||||||
|
|
||||||
|
try:
|
||||||
|
payload = json.loads(result.stdout or "[]")
|
||||||
|
except json.JSONDecodeError as e:
|
||||||
|
logger.warning(f"Failed to parse docker inspect output as JSON: {e}")
|
||||||
|
return {}
|
||||||
|
|
||||||
|
out: dict[str, tuple[float, int | None]] = {}
|
||||||
|
for entry in payload:
|
||||||
|
# ``Name`` is prefixed with ``/`` in the docker inspect response
|
||||||
|
name = (entry.get("Name") or "").lstrip("/")
|
||||||
|
if not name:
|
||||||
|
continue
|
||||||
|
created_at = _parse_docker_timestamp(entry.get("Created", ""))
|
||||||
|
host_port = _extract_host_port(entry, 8080)
|
||||||
|
out[name] = (created_at, host_port)
|
||||||
|
return out
|
||||||
|
|
||||||
# ── Container operations ─────────────────────────────────────────────
|
# ── Container operations ─────────────────────────────────────────────
|
||||||
|
|
||||||
def _start_container(
|
def _start_container(
|
||||||
@@ -246,18 +441,26 @@ class LocalContainerBackend(SandboxBackend):
|
|||||||
|
|
||||||
# Config-level volume mounts
|
# Config-level volume mounts
|
||||||
for mount in self._config_mounts:
|
for mount in self._config_mounts:
|
||||||
mount_spec = f"{mount.host_path}:{mount.container_path}"
|
cmd.extend(
|
||||||
if mount.read_only:
|
_format_container_mount(
|
||||||
mount_spec += ":ro"
|
self._runtime,
|
||||||
cmd.extend(["-v", mount_spec])
|
mount.host_path,
|
||||||
|
mount.container_path,
|
||||||
|
mount.read_only,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
# Extra mounts (thread-specific, skills, etc.)
|
# Extra mounts (thread-specific, skills, etc.)
|
||||||
if extra_mounts:
|
if extra_mounts:
|
||||||
for host_path, container_path, read_only in extra_mounts:
|
for host_path, container_path, read_only in extra_mounts:
|
||||||
mount_spec = f"{host_path}:{container_path}"
|
cmd.extend(
|
||||||
if read_only:
|
_format_container_mount(
|
||||||
mount_spec += ":ro"
|
self._runtime,
|
||||||
cmd.extend(["-v", mount_spec])
|
host_path,
|
||||||
|
container_path,
|
||||||
|
read_only,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
cmd.append(self._image)
|
cmd.append(self._image)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,79 @@
|
|||||||
|
import json
|
||||||
|
|
||||||
|
from exa_py import Exa
|
||||||
|
from langchain.tools import tool
|
||||||
|
|
||||||
|
from deerflow.config import get_app_config
|
||||||
|
|
||||||
|
|
||||||
|
def _get_exa_client(tool_name: str = "web_search") -> Exa:
|
||||||
|
config = get_app_config().get_tool_config(tool_name)
|
||||||
|
api_key = None
|
||||||
|
if config is not None and "api_key" in config.model_extra:
|
||||||
|
api_key = config.model_extra.get("api_key")
|
||||||
|
return Exa(api_key=api_key)
|
||||||
|
|
||||||
|
|
||||||
|
@tool("web_search", parse_docstring=True)
|
||||||
|
def web_search_tool(query: str) -> str:
|
||||||
|
"""Search the web.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
query: The query to search for.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
config = get_app_config().get_tool_config("web_search")
|
||||||
|
max_results = 5
|
||||||
|
search_type = "auto"
|
||||||
|
contents_max_characters = 1000
|
||||||
|
if config is not None:
|
||||||
|
max_results = config.model_extra.get("max_results", max_results)
|
||||||
|
search_type = config.model_extra.get("search_type", search_type)
|
||||||
|
contents_max_characters = config.model_extra.get("contents_max_characters", contents_max_characters)
|
||||||
|
|
||||||
|
client = _get_exa_client()
|
||||||
|
res = client.search(
|
||||||
|
query,
|
||||||
|
type=search_type,
|
||||||
|
num_results=max_results,
|
||||||
|
contents={"highlights": {"max_characters": contents_max_characters}},
|
||||||
|
)
|
||||||
|
|
||||||
|
normalized_results = [
|
||||||
|
{
|
||||||
|
"title": result.title or "",
|
||||||
|
"url": result.url or "",
|
||||||
|
"snippet": "\n".join(result.highlights) if result.highlights else "",
|
||||||
|
}
|
||||||
|
for result in res.results
|
||||||
|
]
|
||||||
|
json_results = json.dumps(normalized_results, indent=2, ensure_ascii=False)
|
||||||
|
return json_results
|
||||||
|
except Exception as e:
|
||||||
|
return f"Error: {str(e)}"
|
||||||
|
|
||||||
|
|
||||||
|
@tool("web_fetch", parse_docstring=True)
|
||||||
|
def web_fetch_tool(url: str) -> str:
|
||||||
|
"""Fetch the contents of a web page at a given URL.
|
||||||
|
Only fetch EXACT URLs that have been provided directly by the user or have been returned in results from the web_search and web_fetch tools.
|
||||||
|
This tool can NOT access content that requires authentication, such as private Google Docs or pages behind login walls.
|
||||||
|
Do NOT add www. to URLs that do NOT have them.
|
||||||
|
URLs must include the schema: https://example.com is a valid URL while example.com is an invalid URL.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
url: The URL to fetch the contents of.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
client = _get_exa_client("web_fetch")
|
||||||
|
res = client.get_contents([url], text={"max_characters": 4096})
|
||||||
|
|
||||||
|
if res.results:
|
||||||
|
result = res.results[0]
|
||||||
|
title = result.title or "Untitled"
|
||||||
|
text = result.text or ""
|
||||||
|
return f"# {title}\n\n{text[:4096]}"
|
||||||
|
else:
|
||||||
|
return "Error: No results found"
|
||||||
|
except Exception as e:
|
||||||
|
return f"Error: {str(e)}"
|
||||||
@@ -6,10 +6,10 @@ from langchain.tools import tool
|
|||||||
from deerflow.config import get_app_config
|
from deerflow.config import get_app_config
|
||||||
|
|
||||||
|
|
||||||
def _get_firecrawl_client() -> FirecrawlApp:
|
def _get_firecrawl_client(tool_name: str = "web_search") -> FirecrawlApp:
|
||||||
config = get_app_config().get_tool_config("web_search")
|
config = get_app_config().get_tool_config(tool_name)
|
||||||
api_key = None
|
api_key = None
|
||||||
if config is not None:
|
if config is not None and "api_key" in config.model_extra:
|
||||||
api_key = config.model_extra.get("api_key")
|
api_key = config.model_extra.get("api_key")
|
||||||
return FirecrawlApp(api_key=api_key) # type: ignore[arg-type]
|
return FirecrawlApp(api_key=api_key) # type: ignore[arg-type]
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@ def web_search_tool(query: str) -> str:
|
|||||||
if config is not None:
|
if config is not None:
|
||||||
max_results = config.model_extra.get("max_results", max_results)
|
max_results = config.model_extra.get("max_results", max_results)
|
||||||
|
|
||||||
client = _get_firecrawl_client()
|
client = _get_firecrawl_client("web_search")
|
||||||
result = client.search(query, limit=max_results)
|
result = client.search(query, limit=max_results)
|
||||||
|
|
||||||
# result.web contains list of SearchResultWeb objects
|
# result.web contains list of SearchResultWeb objects
|
||||||
@@ -58,7 +58,7 @@ def web_fetch_tool(url: str) -> str:
|
|||||||
url: The URL to fetch the contents of.
|
url: The URL to fetch the contents of.
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
client = _get_firecrawl_client()
|
client = _get_firecrawl_client("web_fetch")
|
||||||
result = client.scrape(url, formats=["markdown"])
|
result = client.scrape(url, formats=["markdown"])
|
||||||
|
|
||||||
markdown_content = result.markdown or ""
|
markdown_content = result.markdown or ""
|
||||||
|
|||||||
@@ -1,13 +1,16 @@
|
|||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import requests
|
import httpx
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_api_key_warned = False
|
||||||
|
|
||||||
|
|
||||||
class JinaClient:
|
class JinaClient:
|
||||||
def crawl(self, url: str, return_format: str = "html", timeout: int = 10) -> str:
|
async def crawl(self, url: str, return_format: str = "html", timeout: int = 10) -> str:
|
||||||
|
global _api_key_warned
|
||||||
headers = {
|
headers = {
|
||||||
"Content-Type": "application/json",
|
"Content-Type": "application/json",
|
||||||
"X-Return-Format": return_format,
|
"X-Return-Format": return_format,
|
||||||
@@ -15,11 +18,13 @@ class JinaClient:
|
|||||||
}
|
}
|
||||||
if os.getenv("JINA_API_KEY"):
|
if os.getenv("JINA_API_KEY"):
|
||||||
headers["Authorization"] = f"Bearer {os.getenv('JINA_API_KEY')}"
|
headers["Authorization"] = f"Bearer {os.getenv('JINA_API_KEY')}"
|
||||||
else:
|
elif not _api_key_warned:
|
||||||
|
_api_key_warned = True
|
||||||
logger.warning("Jina API key is not set. Provide your own key to access a higher rate limit. See https://jina.ai/reader for more information.")
|
logger.warning("Jina API key is not set. Provide your own key to access a higher rate limit. See https://jina.ai/reader for more information.")
|
||||||
data = {"url": url}
|
data = {"url": url}
|
||||||
try:
|
try:
|
||||||
response = requests.post("https://r.jina.ai/", headers=headers, json=data)
|
async with httpx.AsyncClient() as client:
|
||||||
|
response = await client.post("https://r.jina.ai/", headers=headers, json=data, timeout=timeout)
|
||||||
|
|
||||||
if response.status_code != 200:
|
if response.status_code != 200:
|
||||||
error_message = f"Jina API returned status {response.status_code}: {response.text}"
|
error_message = f"Jina API returned status {response.status_code}: {response.text}"
|
||||||
@@ -34,5 +39,5 @@ class JinaClient:
|
|||||||
return response.text
|
return response.text
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
error_message = f"Request to Jina API failed: {str(e)}"
|
error_message = f"Request to Jina API failed: {str(e)}"
|
||||||
logger.error(error_message)
|
logger.exception(error_message)
|
||||||
return f"Error: {error_message}"
|
return f"Error: {error_message}"
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user