mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-09-05 08:02:18 +00:00
Ruben FiszelandClaude Opus 4.6
44143e7576
* fix: replace leftover common:: references in dependency_map test Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: add missing deno_core/mcp features and gate dead code in permissions test Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
69 lines
2.5 KiB
Markdown
69 lines
2.5 KiB
Markdown
# Backend Development (Rust)
|
|
|
|
## Project Structure
|
|
|
|
Windmill uses a workspace-based architecture with multiple crates:
|
|
|
|
- **windmill-api**: API server functionality
|
|
- **windmill-worker**: Job execution
|
|
- **windmill-common**: Shared code used by all crates
|
|
- **windmill-queue**: Job & flow queuing
|
|
- **windmill-audit**: Audit logging
|
|
- Other specialized crates (git-sync, autoscaling, etc.)
|
|
|
|
## Key References (MUST FOLLOW THESE)
|
|
|
|
- You MUST follow best-practices by using the `rust-backend` skill, everytime you write RUST code.
|
|
- When working with the database: read `summarized_schema.txt` before starting
|
|
- When working with the API routes: you can read `windmill-api/src/lib.rs` to get started
|
|
|
|
## Adding New Code
|
|
|
|
### Module Organization
|
|
|
|
- Place new code in the appropriate crate based on functionality
|
|
- For API endpoints, create or modify files in `windmill-api/src/` organized by domain
|
|
- For shared functionality, use `windmill-common/src/`
|
|
- Follow existing patterns for file structure and organization
|
|
|
|
### API Endpoints
|
|
|
|
- Follow existing patterns in the `windmill-api` crate
|
|
- Use axum's routing system and extractors
|
|
- Update `backend/windmill-api/openapi.yaml` after modifying API endpoints
|
|
|
|
### Database Changes
|
|
|
|
- Update database schema with migration if necessary
|
|
- Use `sqlx` for database operations with prepared statements
|
|
- Use transactions for multi-step operations
|
|
- To apply pending migrations: `sqlx migrate run` (never manually run .sql files)
|
|
- **Never use `SQLX_OFFLINE=true`** — a live database is always available for compilation
|
|
- After all code changes are done, run `./update-sqlx` to regenerate the offline query cache
|
|
|
|
## Enterprise Features
|
|
|
|
- Enterprise files use the `*_ee.rs` suffix
|
|
- Enterprise source is in `windmill-ee-private` folder (sibling directory at `../../windmill-ee-private`), symlinked into each crate's `src/`
|
|
- You can and should modify `windmill-ee-private` directly when needed (e.g., when creating new crates that need EE code, mirror the package structure there)
|
|
- Use feature flags: `#[cfg(feature = "enterprise")]`
|
|
- Isolate enterprise code in separate modules
|
|
|
|
## Git Workflow
|
|
|
|
- **Never push directly to main** — always create a branch and open a pull request
|
|
|
|
## Testing
|
|
|
|
- Write unit tests for core functionality
|
|
- Use the `#[cfg(test)]` module for test code
|
|
- For database tests, use the existing test utilities
|
|
|
|
## Common Crates
|
|
|
|
- **tokio**: Async runtime
|
|
- **axum**: Web server and routing
|
|
- **sqlx**: Database operations
|
|
- **serde**: Serialization/deserialization
|
|
- **tracing**: Logging and diagnostics
|
|
- **reqwest**: HTTP client |