8bc347c7bb
API unit tests on PR #36724 failed because the lifecycle commit eagerly called ``create_agent_backend_run_client(base_url=dify_config.AGENT_BACKEND_BASE_URL)`` inside the workflow + advanced-chat app runners. The factory raises ``ValueError("base_url is required when creating a real Agent backend client")`` whenever both ``AGENT_BACKEND_BASE_URL`` and ``AGENT_BACKEND_USE_FAKE`` are unset, which is the default for any unit test that doesn't actually exercise an Agent node — so previously-green tests started failing as soon as the cleanup layer was attached. * Factor the construction into ``build_workflow_agent_session_cleanup_layer``. When neither base_url nor use_fake is configured the helper passes ``agent_backend_client=None``; with ``_HTTP_CLEANUP_SUPPORTED = False`` (production default) the layer's local-retire branch never touches the client anyway. * Relax ``WorkflowAgentSessionCleanupLayer.__init__`` to accept ``AgentBackendRunClient | None`` and add a defensive warning + early return in the HTTP-cleanup branch if the client is missing, so that flipping the switch in a deployment without backend config does not crash. Verified: 520 unit tests in agent_v2 + agent_backend + app/apps pass; ruff clean; pyrefly clean on the touched files. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Dify Backend API
Setup and Run
Important
In the v1.3.0 release,
poetryhas been replaced withuvas the package manager for Dify API backend service.
uv and pnpm are required to run the setup and development commands below.
Using scripts (recommended)
The scripts resolve paths relative to their location, so you can run them from anywhere.
-
Run setup (copies env files and installs dependencies).
./dev/setup -
Review
api/.env,web/.env.local, anddocker/middleware.envvalues (see theSECRET_KEYnote below). -
Start middleware (PostgreSQL/Redis/Weaviate).
./dev/start-docker-compose -
Start backend (runs migrations first).
./dev/start-api -
Start Dify web service.
./dev/start-web./dev/setupand./dev/start-webinstall JavaScript dependencies through the repository root workspace, so you do not need a separatecd web && pnpm installstep. -
Set up your application by visiting
http://localhost:3000. -
Start the worker service (async and scheduler tasks, runs from
api)../dev/start-worker -
Optional: start Celery Beat (scheduled tasks).
./dev/start-beat
Environment notes
Important
When the frontend and backend run on different subdomains, set COOKIE_DOMAIN to the site’s top-level domain (e.g.,
example.com). The frontend and backend must be under the same top-level domain in order to share authentication cookies.
-
Generate a
SECRET_KEYin the.envfile.bash for Linux
sed -i "/^SECRET_KEY=/c\\SECRET_KEY=$(openssl rand -base64 42)" .envbash for Mac
secret_key=$(openssl rand -base64 42) sed -i '' "/^SECRET_KEY=/c\\ SECRET_KEY=${secret_key}" .env
Testing
-
Install dependencies for both the backend and the test environment
cd api uv sync --group dev -
Run the tests locally with mocked system environment variables in
tool.pytest_envsection inpyproject.toml, more can check Claude.mdcd api uv run pytest # Run all tests uv run pytest tests/unit_tests/ # Unit tests only uv run pytest tests/integration_tests/ # Integration tests # Code quality ./dev/reformat # Run all formatters and linters uv run ruff check --fix ./ # Fix linting issues uv run ruff format ./ # Format code uv run pyrefly check # Type checking
Generate TS stub
uv run dev/generate_swagger_specs.py --output-dir openapi
use https://jsontotable.org/openapi-to-typescript to convert to typescript