Streaming introduced a correctness regression: if the event stream ended without a terminal frame (idle timeout, dead publishing worker), run_draft synthesised status="failed" with an empty dify_run_id. A run that had in fact SUCCEEDED would then be reported as a failed build and sent into the repair loop. The blocking path would have waited and returned the truth. The stream is the fast path, not the authority. Every non-ping frame is stamped with workflow_run_id by convert_stream_full_response, so the run id is known from the first frame onwards -- long before the terminal frame that may never arrive. run_draft now captures it from any frame and, when no terminal frame arrives, reads the run's real status from the workflow-run row instead of inventing one. Note that data["id"] is the node-execution id on node frames, not the run id, so it is only read as a run id on workflow-level frames. When even the row cannot settle it -- no run id, no row, or a row still marked running because the worker died mid-run -- the result is reported as status="running" with an explicit Run.error, which is what Run.status already documents for "not over / not known". A truncated stream is now either the truth or a visible unknown, never a fabricated failure. Co-Authored-By: Claude Opus 5 (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 AGENTS.mdContinue in the
apidirectory from the previous step.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