When a session crashes mid working-step (e.g. build.publish; the async advance raised and released the lock), it was a locked dead-end: working states surface no UI actions and the composer locked with no way forward. - Surface a RecoveryRef offer (can_continue=Retry, can_restart=Start over, recovery_class="") on an interrupted working-state view -- built directly so a real drift class still wins. - Allow recovery_continue / recovery_restart at an interrupted working state in _internal_action_allowed. recovery_continue returns the working state (non-settled) so the runner re-runs the stalled handler; recovery_restart resets working fields and re-enters the entry state -- both reuse existing recovery machinery, no new action kinds / no runner change. Adds unit tests (offer surfaced, allowance) + regression tests (recovery_continue re-runs handle_publish and advances; recovery_restart resets to entry state; repeat-failure re-surfaces the offer with no wedge). This reconciler was reviewed as a standalone plan on the pre-merge base; here it is re-applied onto feat/dify-builder after PR #41677 merged in the reworked service.py + _internal_action_allowed gate (which makes the allowance necessary). The apply_repair idempotency + delete-guard commits (safe fix.apply Retry) land alongside it. Co-Authored-By: Claude Opus 4.8 <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