Code review finding: handle_goal_analysis built its own ProgressReporter (build-review-requirements/build-draft-plan) and finish()ed it, then tail-called _discover_and_offer_resources, which built a SECOND reporter under the SAME env.operation_id. ProgressReporter's revision counter starts at 0 per instance, so the second reporter's activate/finish calls restarted revision at 1 -- two progress events with revision 1 (and 2, and 3) under one operation_id. contract.py's ProgressEventData docstring states revision is monotonic within an operation_id; every other handler across the three handler files uses exactly one reporter per step -- this was the sole exception, on the most-travelled build path. Fix: _discover_and_offer_resources now takes an optional `progress` parameter. handle_goal_analysis passes its live (still-open) reporter through instead of finishing it early; the helper adds the discovery steps onto that SAME reporter via add_steps() and is the one that finish()es it. handle_initial_plan (the continue_adjusting/retry_after_revert loop-back, which has no reporter of its own -- a separate CAS commit/operation) still gets progress=None and the helper builds a fresh one, unchanged. Added test_submitting_requirements_progress_is_one_operation_with_monotonic_ revisions: drives the real Runner with submit_requirements, captures every emitted ProgressEventData, and asserts a single operation_id with strictly increasing, non-repeating revisions across all four progress steps. 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