mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-26 18:06:00 +00:00
AochenShen99
da41701f87
* feat(detectors): add static blocking IO inventory * refactor(detectors): drop superseded runtime probe; clarify static report path - Remove the #2924 custom runtime blocking IO probe entirely: backend/tests/support/detectors/blocking_io.py, backend/tests/test_blocking_io_detector.py, backend/tests/test_blocking_io_probe_integration.py, and the pytest_addoption / pytest_runtest_call / pytest_runtest_teardown / pytest_sessionfinish / pytest_terminal_summary hooks plus the blocking_io_detector fixture from backend/tests/conftest.py. Its narrow DEFAULT_BLOCKING_CALL_SPECS (time.sleep, requests, httpx, os.walk, Path.resolve, Path.read_text, Path.write_text) cannot serve as a CI gate; a Blockbuster-backed runtime detector will land in a separate follow-up PR. Leaving the half-coverage probe alongside the static inventory in this PR added a redundant detect path with no production value. - Address Copilot review comments on backend/README.md and backend/CLAUDE.md by stating explicitly that the JSON report writes to .deer-flow/blocking-io-findings.json at the repository root, whether the target is invoked from the repo root or from backend/. Verified: pytest tests/test_detect_blocking_io_static.py (18 passed), ruff check + format on touched files (passed), make detect-blocking-io from both repo root and backend/ produce the same 105-finding report at <repo-root>/.deer-flow/blocking-io-findings.json. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
192 lines
6.8 KiB
Makefile
192 lines
6.8 KiB
Makefile
# DeerFlow - Unified Development Environment
|
|
|
|
.PHONY: help config config-upgrade check install setup doctor detect-thread-boundaries detect-blocking-io dev dev-daemon start start-daemon stop up down clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway
|
|
|
|
BASH ?= bash
|
|
BACKEND_UV_RUN = cd backend && uv run
|
|
|
|
# Detect OS for Windows compatibility
|
|
ifeq ($(OS),Windows_NT)
|
|
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
|
|
|
|
help:
|
|
@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-upgrade - Merge new fields from config.example.yaml into config.yaml"
|
|
@echo " make check - Check if all required tools are installed"
|
|
@echo " make detect-thread-boundaries - Inventory async/thread boundary points"
|
|
@echo " make detect-blocking-io - Inventory blocking IO that may block the backend event loop"
|
|
@echo " make install - Install all dependencies (frontend + backend + pre-commit hooks)"
|
|
@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-daemon - Start dev services in background (daemon mode)"
|
|
@echo " make start - Start all services in production mode (optimized, no hot-reloading)"
|
|
@echo " make start-daemon - Start prod services in background (daemon mode)"
|
|
@echo " make stop - Stop all running services"
|
|
@echo " make clean - Clean up processes and temporary files"
|
|
@echo ""
|
|
@echo "Docker Production Commands:"
|
|
@echo " make up - Build and start production Docker services (localhost:2026)"
|
|
@echo " make down - Stop and remove production Docker containers"
|
|
@echo ""
|
|
@echo "Docker Development Commands:"
|
|
@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-stop - Stop Docker development services"
|
|
@echo " make docker-logs - View Docker development logs"
|
|
@echo " make docker-logs-frontend - View Docker frontend 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
|
|
|
|
detect-thread-boundaries:
|
|
@$(PYTHON) ./scripts/detect_thread_boundaries.py
|
|
|
|
detect-blocking-io:
|
|
@$(MAKE) -C backend detect-blocking-io
|
|
|
|
config:
|
|
@$(PYTHON) ./scripts/configure.py
|
|
|
|
config-upgrade:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/config-upgrade.sh
|
|
|
|
# Check required tools
|
|
check:
|
|
@$(PYTHON) ./scripts/check.py
|
|
|
|
# Install all dependencies
|
|
install:
|
|
@echo "Installing backend dependencies..."
|
|
@cd backend && uv sync
|
|
@echo "Installing frontend dependencies..."
|
|
@cd frontend && pnpm install
|
|
@echo "Installing pre-commit hooks..."
|
|
@$(BACKEND_UV_RUN) --with pre-commit pre-commit install
|
|
@echo "✓ All dependencies installed"
|
|
@echo ""
|
|
@echo "=========================================="
|
|
@echo " Optional: Pre-pull Sandbox Image"
|
|
@echo "=========================================="
|
|
@echo ""
|
|
@echo "If you plan to use Docker/Container-based sandbox, you can pre-pull the image:"
|
|
@echo " make setup-sandbox"
|
|
@echo ""
|
|
|
|
# Pre-pull sandbox Docker image (optional but recommended)
|
|
setup-sandbox:
|
|
@echo "=========================================="
|
|
@echo " Pre-pulling Sandbox Container Image"
|
|
@echo "=========================================="
|
|
@echo ""
|
|
@IMAGE=$$(grep -A 20 "# sandbox:" config.yaml 2>/dev/null | grep "image:" | awk '{print $$2}' | head -1); \
|
|
if [ -z "$$IMAGE" ]; then \
|
|
IMAGE="enterprise-public-cn-beijing.cr.volces.com/vefaas-public/all-in-one-sandbox:latest"; \
|
|
echo "Using default image: $$IMAGE"; \
|
|
else \
|
|
echo "Using configured image: $$IMAGE"; \
|
|
fi; \
|
|
echo ""; \
|
|
if command -v container >/dev/null 2>&1 && [ "$$(uname)" = "Darwin" ]; then \
|
|
echo "Detected Apple Container on macOS, pulling image..."; \
|
|
container image pull "$$IMAGE" || echo "⚠ Apple Container pull failed, will try Docker"; \
|
|
fi; \
|
|
if command -v docker >/dev/null 2>&1; then \
|
|
echo "Pulling image using Docker..."; \
|
|
if docker pull "$$IMAGE"; then \
|
|
echo ""; \
|
|
echo "✓ Sandbox image pulled successfully"; \
|
|
else \
|
|
echo ""; \
|
|
echo "⚠ Failed to pull sandbox image (this is OK for local sandbox mode)"; \
|
|
fi; \
|
|
else \
|
|
echo "✗ Neither Docker nor Apple Container is available"; \
|
|
echo " Please install Docker: https://docs.docker.com/get-docker/"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
# Start all services in development mode (with hot-reloading)
|
|
dev:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev
|
|
|
|
# Start all services in production mode (with optimizations)
|
|
start:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod
|
|
|
|
# Start all services in daemon mode (background)
|
|
dev-daemon:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev --daemon
|
|
|
|
# Start prod services in daemon mode (background)
|
|
start-daemon:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod --daemon
|
|
|
|
# Stop all services
|
|
stop:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --stop
|
|
|
|
# Clean up
|
|
clean: stop
|
|
@echo "Cleaning up..."
|
|
@-rm -rf backend/.deer-flow 2>/dev/null || true
|
|
@-rm -rf backend/.langgraph_api 2>/dev/null || true
|
|
@-rm -rf logs/*.log 2>/dev/null || true
|
|
@echo "✓ Cleanup complete"
|
|
|
|
# ==========================================
|
|
# Docker Development Commands
|
|
# ==========================================
|
|
|
|
# Initialize Docker containers and install dependencies
|
|
docker-init:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh init
|
|
|
|
# Start Docker development environment
|
|
docker-start:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh start
|
|
|
|
# Stop Docker development environment
|
|
docker-stop:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh stop
|
|
|
|
# View Docker development logs
|
|
docker-logs:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs
|
|
|
|
# View Docker development logs
|
|
docker-logs-frontend:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --frontend
|
|
docker-logs-gateway:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --gateway
|
|
|
|
# ==========================================
|
|
# Production Docker Commands
|
|
# ==========================================
|
|
|
|
# Build and start production services
|
|
up:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh
|
|
|
|
# Stop and remove production containers
|
|
down:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh down
|