mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-13 20:23:47 +00:00
`make dev` ran `uv sync` unconditionally on every restart, wiping any
optional extras the user had installed manually with
`uv sync --all-packages --extra postgres`. The Docker image-build path
already solved this via the `UV_EXTRAS` build-arg in backend/Dockerfile;
the local serve.sh path and the docker-compose-dev startup command
were the remaining outliers.
`scripts/serve.sh` now resolves extras before `uv sync`:
1. honors `UV_EXTRAS` (parity with backend/Dockerfile and
docker/docker-compose.yaml — no new convention introduced);
2. falls back to parsing config.yaml — `database.backend: postgres`
or legacy `checkpointer.type: postgres` auto-pins
`--extra postgres`, so the common case needs zero extra config.
3. detector stderr is no longer suppressed, so whitelist warnings or
crashes surface to the dev terminal (review feedback).
Detection lives in `scripts/detect_uv_extras.py` (stdlib-only — has to
run before the venv exists). Extra names are validated against
`^[A-Za-z][A-Za-z0-9_-]*$` so a stray shell metacharacter in `.env`
cannot reach `uv sync` downstream (defense in depth).
`docker/docker-compose-dev.yaml`'s startup command is now extracted to
`docker/dev-entrypoint.sh` (review feedback — the inline command had
grown to a ~350-char one-liner). The script:
- parses comma/whitespace-separated UV_EXTRAS, applying the same
`^[A-Za-z][A-Za-z0-9_-]*$` whitelist as the local detector;
- emits one `--extra X` flag per token, so `UV_EXTRAS=postgres,ollama`
works in Docker dev too (harmonized with local — review feedback);
- calls `uv sync --all-packages` (PR #2584) so workspace member
extras (deerflow-harness's postgres extra) are installed;
- keeps the existing self-heal `(uv sync || (recreate venv && retry))`
branch;
- exposes `--print-extras` for dry-run testing.
The compose file mounts the script read-only at runtime, so script
edits take effect on `make docker-restart` without an image rebuild.
The `--no-sync` alternative (a separate suggestion in the issue thread)
was considered but rejected for dev paths because it would drop the
self-heal branch and the auto-pickup of new pyproject deps. `--no-sync`
is already in use for the production CMD (`backend/Dockerfile:101`)
where it's appropriate.
Updates the asyncpg-missing error message to include the
`--all-packages` flag (matching #2584) plus the persistent install flow,
and expands `config.example.yaml` so all three install paths
(local / docker dev / docker image build) are documented with their
multi-extra capabilities.
Tests:
- `tests/test_detect_uv_extras.py` (21 tests) — local-path env parsing,
YAML edge cases, env-vs-config precedence, whitelist rejection of
shell metacharacters.
- `tests/test_dev_entrypoint.py` (15 tests) — docker-path validation
via `--print-extras`, multi-extra parsing, metacharacter abort.
- `tests/test_persistence_scaffold.py` (22 tests, unchanged) — passes
with the merged `--all-packages --extra postgres` error message.
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
294 lines
10 KiB
Bash
Executable File
294 lines
10 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# serve.sh — Unified DeerFlow service launcher
|
|
#
|
|
# Usage:
|
|
# ./scripts/serve.sh [--dev|--prod] [--daemon] [--stop|--restart]
|
|
#
|
|
# Modes:
|
|
# --dev Development mode with hot-reload (default)
|
|
# --prod Production mode, pre-built frontend, no hot-reload
|
|
# --daemon Run all services in background (nohup), exit after startup
|
|
#
|
|
# Actions:
|
|
# --skip-install Skip dependency installation (faster restart)
|
|
# --stop Stop all running services and exit
|
|
# --restart Stop all services, then start with the given mode flags
|
|
#
|
|
# Examples:
|
|
# ./scripts/serve.sh --dev # Gateway dev, hot reload
|
|
# ./scripts/serve.sh --prod # Gateway prod
|
|
# ./scripts/serve.sh --dev --daemon # Gateway dev, background
|
|
# ./scripts/serve.sh --stop # Stop all services
|
|
# ./scripts/serve.sh --restart --dev # Restart dev services
|
|
#
|
|
# Must be run from the repo root directory.
|
|
|
|
set -e
|
|
|
|
REPO_ROOT="$(builtin cd "$(dirname "${BASH_SOURCE[0]}")/.." >/dev/null 2>&1 && pwd -P)"
|
|
cd "$REPO_ROOT"
|
|
|
|
# ── Load .env ────────────────────────────────────────────────────────────────
|
|
|
|
if [ -f "$REPO_ROOT/.env" ]; then
|
|
set -a
|
|
source "$REPO_ROOT/.env"
|
|
set +a
|
|
fi
|
|
|
|
# ── Argument parsing ─────────────────────────────────────────────────────────
|
|
|
|
DEV_MODE=true
|
|
DAEMON_MODE=false
|
|
SKIP_INSTALL=false
|
|
ACTION="start" # start | stop | restart
|
|
|
|
for arg in "$@"; do
|
|
case "$arg" in
|
|
--dev) DEV_MODE=true ;;
|
|
--prod) DEV_MODE=false ;;
|
|
--daemon) DAEMON_MODE=true ;;
|
|
--skip-install) SKIP_INSTALL=true ;;
|
|
--stop) ACTION="stop" ;;
|
|
--restart) ACTION="restart" ;;
|
|
*)
|
|
echo "Unknown argument: $arg"
|
|
echo "Usage: $0 [--dev|--prod] [--daemon] [--skip-install] [--stop|--restart]"
|
|
exit 1
|
|
;;
|
|
esac
|
|
done
|
|
|
|
# ── Stop helper ──────────────────────────────────────────────────────────────
|
|
|
|
_kill_port() {
|
|
local port=$1
|
|
local pid
|
|
pid=$(lsof -ti :"$port" 2>/dev/null) || true
|
|
if [ -n "$pid" ]; then
|
|
kill -9 $pid 2>/dev/null || true
|
|
fi
|
|
}
|
|
|
|
stop_all() {
|
|
echo "Stopping all services..."
|
|
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
|
|
nginx -c "$REPO_ROOT/docker/nginx/nginx.local.conf" -p "$REPO_ROOT" -s quit 2>/dev/null || true
|
|
sleep 1
|
|
pkill -9 nginx 2>/dev/null || true
|
|
# Force-kill any survivors still holding the service ports
|
|
_kill_port 8001
|
|
_kill_port 3000
|
|
./scripts/cleanup-containers.sh deer-flow-sandbox 2>/dev/null || true
|
|
echo "✓ All services stopped"
|
|
}
|
|
|
|
# ── Action routing ───────────────────────────────────────────────────────────
|
|
|
|
if [ "$ACTION" = "stop" ]; then
|
|
stop_all
|
|
exit 0
|
|
fi
|
|
|
|
ALREADY_STOPPED=false
|
|
if [ "$ACTION" = "restart" ]; then
|
|
stop_all
|
|
sleep 1
|
|
ALREADY_STOPPED=true
|
|
fi
|
|
|
|
# Mode label for banner
|
|
if $DEV_MODE; then
|
|
MODE_LABEL="DEV (Gateway runtime, hot-reload enabled)"
|
|
else
|
|
MODE_LABEL="PROD (Gateway runtime, optimized)"
|
|
fi
|
|
|
|
if $DAEMON_MODE; then
|
|
MODE_LABEL="$MODE_LABEL [daemon]"
|
|
fi
|
|
|
|
# Frontend command
|
|
if $DEV_MODE; then
|
|
FRONTEND_CMD="pnpm run dev"
|
|
else
|
|
if command -v python3 >/dev/null 2>&1; then
|
|
PYTHON_BIN="python3"
|
|
elif command -v python >/dev/null 2>&1; then
|
|
PYTHON_BIN="python"
|
|
else
|
|
echo "Python is required to generate BETTER_AUTH_SECRET."
|
|
exit 1
|
|
fi
|
|
FRONTEND_CMD="env BETTER_AUTH_SECRET=$($PYTHON_BIN -c 'import secrets; print(secrets.token_hex(16))') pnpm run preview"
|
|
fi
|
|
|
|
# Extra flags for uvicorn
|
|
if $DEV_MODE && ! $DAEMON_MODE; then
|
|
GATEWAY_EXTRA_FLAGS="--reload --reload-include='*.yaml' --reload-include='.env' --reload-exclude='*.pyc' --reload-exclude='__pycache__' --reload-exclude='sandbox/' --reload-exclude='.deer-flow/'"
|
|
else
|
|
GATEWAY_EXTRA_FLAGS=""
|
|
fi
|
|
|
|
# ── Stop existing services (skip if restart already did it) ──────────────────
|
|
|
|
if ! $ALREADY_STOPPED; then
|
|
stop_all
|
|
sleep 1
|
|
fi
|
|
|
|
# ── Config check ─────────────────────────────────────────────────────────────
|
|
|
|
if ! { \
|
|
[ -n "$DEER_FLOW_CONFIG_PATH" ] && [ -f "$DEER_FLOW_CONFIG_PATH" ] || \
|
|
[ -f backend/config.yaml ] || \
|
|
[ -f config.yaml ]; \
|
|
}; then
|
|
echo "✗ No DeerFlow config file found."
|
|
echo " Run 'make setup' (recommended) or 'make config' to generate config.yaml."
|
|
exit 1
|
|
fi
|
|
|
|
"$REPO_ROOT/scripts/config-upgrade.sh"
|
|
|
|
# ── Install dependencies ────────────────────────────────────────────────────
|
|
|
|
# Pick a Python for the extras detector. Falls back to plain `python` for
|
|
# Windows/Git Bash where only `python` is on PATH.
|
|
if command -v python3 >/dev/null 2>&1; then
|
|
DETECT_PYTHON="python3"
|
|
elif command -v python >/dev/null 2>&1; then
|
|
DETECT_PYTHON="python"
|
|
else
|
|
DETECT_PYTHON=""
|
|
fi
|
|
|
|
# Resolve uv extras (postgres, etc.) from UV_EXTRAS or config.yaml so that
|
|
# `uv sync` does not wipe out optional dependencies on every restart. See
|
|
# scripts/detect_uv_extras.py and Issue #2754 for context. The detector
|
|
# whitelists extra names against `^[A-Za-z][A-Za-z0-9_-]*$`, so the unquoted
|
|
# splat below only sees valid uv argument tokens.
|
|
#
|
|
# Stderr is intentionally NOT redirected so the user sees:
|
|
# - whitelist warnings (e.g. "ignoring invalid UV_EXTRAS entry ';'");
|
|
# - detector crashes (e.g. unexpected Python error).
|
|
# `|| true` keeps `set -e` from killing dev startup on a detector failure;
|
|
# the result is just an empty UV_EXTRAS_FLAGS, which means "no extras".
|
|
UV_EXTRAS_FLAGS=""
|
|
if [ -n "$DETECT_PYTHON" ]; then
|
|
UV_EXTRAS_FLAGS=$("$DETECT_PYTHON" "$REPO_ROOT/scripts/detect_uv_extras.py" || { echo "[serve.sh] detect_uv_extras.py failed (exit $?) — proceeding without extras" >&2; echo ""; })
|
|
fi
|
|
|
|
if ! $SKIP_INSTALL; then
|
|
echo "Syncing dependencies..."
|
|
if [ -n "$UV_EXTRAS_FLAGS" ]; then
|
|
echo " • uv extras: $UV_EXTRAS_FLAGS"
|
|
fi
|
|
# `--all-packages` propagates extras into workspace members (deerflow-harness
|
|
# in particular). Required for postgres extras — see PR #2584.
|
|
# Intentionally unquoted to splat multiple `--extra X` pairs.
|
|
(cd backend && uv sync --quiet --all-packages $UV_EXTRAS_FLAGS) || { echo "✗ Backend dependency install failed"; exit 1; }
|
|
(cd frontend && pnpm install --silent) || { echo "✗ Frontend dependency install failed"; exit 1; }
|
|
echo "✓ Dependencies synced"
|
|
else
|
|
echo "⏩ Skipping dependency install (--skip-install)"
|
|
fi
|
|
|
|
# ── Banner ───────────────────────────────────────────────────────────────────
|
|
|
|
echo ""
|
|
echo "=========================================="
|
|
echo " Starting DeerFlow"
|
|
echo "=========================================="
|
|
echo ""
|
|
echo " Mode: $MODE_LABEL"
|
|
echo ""
|
|
echo " Services:"
|
|
echo " Gateway → localhost:8001 (REST API + agent runtime)"
|
|
echo " Frontend → localhost:3000 (Next.js)"
|
|
echo " Nginx → localhost:2026 (reverse proxy)"
|
|
echo ""
|
|
|
|
# ── Cleanup handler ──────────────────────────────────────────────────────────
|
|
|
|
cleanup() {
|
|
trap - INT TERM
|
|
echo ""
|
|
stop_all
|
|
exit 0
|
|
}
|
|
|
|
trap cleanup INT TERM
|
|
|
|
# ── Helper: start a service ──────────────────────────────────────────────────
|
|
|
|
# run_service NAME COMMAND PORT TIMEOUT
|
|
# In daemon mode, wraps with nohup. Waits for port to be ready.
|
|
run_service() {
|
|
local name="$1" cmd="$2" port="$3" timeout="$4"
|
|
|
|
echo "Starting $name..."
|
|
if $DAEMON_MODE; then
|
|
nohup sh -c "$cmd" > /dev/null 2>&1 &
|
|
else
|
|
sh -c "$cmd" &
|
|
fi
|
|
|
|
./scripts/wait-for-port.sh "$port" "$timeout" "$name" || {
|
|
local logfile="logs/$(echo "$name" | tr '[:upper:]' '[:lower:]' | tr ' ' '-').log"
|
|
echo "✗ $name failed to start."
|
|
[ -f "$logfile" ] && tail -20 "$logfile"
|
|
cleanup
|
|
}
|
|
echo "✓ $name started on localhost:$port"
|
|
}
|
|
|
|
# ── Start services ───────────────────────────────────────────────────────────
|
|
|
|
mkdir -p logs
|
|
mkdir -p temp/client_body_temp temp/proxy_temp temp/fastcgi_temp temp/uwsgi_temp temp/scgi_temp
|
|
|
|
# 1. Gateway API
|
|
run_service "Gateway" \
|
|
"cd backend && PYTHONPATH=. uv run uvicorn app.gateway.app:app --host 0.0.0.0 --port 8001 $GATEWAY_EXTRA_FLAGS > ../logs/gateway.log 2>&1" \
|
|
8001 30
|
|
|
|
# 2. Frontend
|
|
run_service "Frontend" \
|
|
"cd frontend && $FRONTEND_CMD > ../logs/frontend.log 2>&1" \
|
|
3000 120
|
|
|
|
# 3. Nginx
|
|
run_service "Nginx" \
|
|
"nginx -g 'daemon off;' -c '$REPO_ROOT/docker/nginx/nginx.local.conf' -p '$REPO_ROOT' > logs/nginx.log 2>&1" \
|
|
2026 10
|
|
|
|
# ── Ready ────────────────────────────────────────────────────────────────────
|
|
|
|
echo ""
|
|
echo "=========================================="
|
|
echo " ✓ DeerFlow is running! [$MODE_LABEL]"
|
|
echo "=========================================="
|
|
echo ""
|
|
echo " 🌐 http://localhost:2026"
|
|
echo ""
|
|
echo " Routing: Frontend → Nginx → Gateway"
|
|
echo " API: /api/langgraph/* → Gateway agent runtime"
|
|
echo " /api/* → Gateway REST API (8001)"
|
|
echo ""
|
|
echo " 📋 Logs: logs/{gateway,frontend,nginx}.log"
|
|
echo ""
|
|
|
|
if $DAEMON_MODE; then
|
|
echo " 🛑 Stop: make stop"
|
|
# Detach — trap is no longer needed
|
|
trap - INT TERM
|
|
else
|
|
echo " Press Ctrl+C to stop all services"
|
|
wait
|
|
fi
|