This commit is contained in:
2026-07-29 16:25:12 +02:00
parent 9b705f0d96
commit 98050bb770
3 changed files with 76 additions and 11 deletions
+71
View File
@@ -0,0 +1,71 @@
---
sessionId: session-260729-161736-1psq
---
# Requirements
### Overview & Goals
Migrate all DTOs (Data Transfer Objects) currently located in `src/routes/<module>/dto.rs` into the `src/domain/` directory. This aligns the project architecture by separating domain types and DTOs from HTTP routing and handler implementation details.
### Scope
- **In Scope**:
- Moving all DTO files from `src/routes/<module>/dto.rs` to `src/domain/<module>/dto.rs` (or equivalent domain submodules).
- Updating all imports across the codebase (`src/routes/...`, handlers, mappers, etc.) to reference the new domain locations.
- Re-exporting or organizing modules cleanly in `src/domain/mod.rs`.
- **Out of Scope**:
- Modifying business logic or changing DTO field definitions.
- Changing database models (`src/models/`).
### Functional Requirements
- Every DTO previously defined in `src/routes/*/dto.rs` must be accessible under `src/domain/`.
- All handlers, mappers, and services must compile successfully after updating their imports.
- OpenAPI schema generation via `utoipa` must continue to function correctly with the relocated DTOs.
# Technical Design
### Current Implementation
Currently, each feature module in `src/routes/<module>/` contains a `dto.rs` file (along with `handlers.rs`, `mapper.rs`, `routes.rs`, `service.rs`, `domain.rs`). Meanwhile, `src/domain/` currently only contains `events/` and `mod.rs`.
### Key Decisions
- **Domain DTO Folder Organization**: Centralize all DTOs into a dedicated `src/domain/dto/` folder (e.g., `src/domain/dto/auth.rs`, `src/domain/dto/user.rs`, etc., declared in `src/domain/dto/mod.rs` and re-exported or accessed via `crate::domain::dto::<module>::*`).
- **Import Path Updates**: Update all `use crate::routes::<module>::dto::*` imports to `use crate::domain::dto::<module>::*` (or via `crate::domain::dto::*`).
### Proposed Changes
1. Create a `src/domain/dto/` directory with individual module files (e.g., `auth.rs`, `user.rs`, etc.) and a `src/domain/dto/mod.rs`.
2. Move the contents of `src/routes/<module>/dto.rs` to `src/domain/dto/<module>.rs`.
3. Update `src/domain/mod.rs` to declare `pub mod dto;` and configure `src/domain/dto/mod.rs`.
4. Update all files referencing `src/routes/<module>::dto` to point to `src/domain::dto::<module>` (or `crate::domain::dto::<module>`).
5. Remove `dto.rs` from each `src/routes/<module>/` directory and update `src/routes/<module>/mod.rs`.
### File Structure Changes
- **Added**:
- `src/domain/dto/mod.rs`
- `src/domain/dto/auth.rs` (and other DTO files like user, channel, message, category, role, attachment, core, etc.)
- **Modified**:
- `src/domain/mod.rs`
- `src/routes/<module>/mod.rs` for each migrated module (removing `pub mod dto;`)
- All handler, mapper, and route files importing the old DTO paths.
- **Removed**:
- `src/routes/<module>/dto.rs` for all modules.
# Testing
### Validation Approach
- Run `cargo check` to verify that all type references and module paths compile correctly.
- Run `cargo test` to ensure tests pass and there are no runtime regressions.
- Inspect OpenAPI generation / documentation endpoints to ensure `utoipa` correctly registers all DTO schemas.
# Delivery Steps
### Step 1: Create domain DTO directory and module structure
- Create `src/domain/dto/` directory along with `src/domain/dto/mod.rs`.
- Set up module declarations for each DTO file (auth, user, channel, message, category, role, attachment, core, etc.) under `src/domain/dto/`.
- Expose `pub mod dto;` in `src/domain/mod.rs`.
### Step 2: Migrate DTO files to `src/domain/dto/` and update imports
- Move each `dto.rs` file from `src/routes/<module>/dto.rs` into `src/domain/dto/<module>.rs`.
- Update all import statements across handlers, mappers, services, and route files in `src/routes/` and elsewhere to reference `crate::domain::dto::<module>::*`.
- Remove the old `dto.rs` files from `src/routes/<module>/` and remove `pub mod dto;` from `src/routes/<module>/mod.rs`.
### Step 3: Verify compilation and test suite
- Run `cargo check` and `cargo test` to ensure all DTO types resolve correctly and there are no broken imports or compilation errors.\n- Verify OpenAPI schema generation (`utoipa`) correctly picks up the migrated DTO schemas.
+3 -9
View File
@@ -1,12 +1,12 @@
pub mod state; pub mod state;
use crate::config::AppConfig; use crate::config::AppConfig;
use crate::core::state::Services;
use crate::database::Database; use crate::database::Database;
use crate::http::server::HttpServer; use crate::http::server::HttpServer;
use crate::metrics::{AppMetrics, reporter}; use crate::metrics::{AppMetrics, reporter};
use crate::repositories::Repositories; use crate::repositories::Repositories;
use crate::routes::gateway::GatewayManager; use crate::routes::gateway::GatewayManager;
use crate::services::Services;
use crate::udp::server::UdpServer; use crate::udp::server::UdpServer;
use event_bus::EventBus; use event_bus::EventBus;
use migration::{Migrator, MigratorTrait}; use migration::{Migrator, MigratorTrait};
@@ -17,7 +17,6 @@ use uuid::Uuid;
pub struct App { pub struct App {
pub state: AppState, pub state: AppState,
pub services: Services,
} }
impl App { impl App {
@@ -70,8 +69,6 @@ impl App {
let services = Arc::new(Services::new(repositories.clone(), event_bus.clone())); let services = Arc::new(Services::new(repositories.clone(), event_bus.clone()));
let permission_sync = PermissionSyncService::new(repositories.clone(), event_bus.clone());
let state = AppState { let state = AppState {
db, db,
config: Arc::new(config), config: Arc::new(config),
@@ -81,13 +78,10 @@ impl App {
metrics, metrics,
gateway, gateway,
event_bus, event_bus,
services,
}; };
let services = Services { Ok(Self { state })
permission_sync: Arc::new(permission_sync),
};
Ok(Self { state, services })
} }
pub async fn run(self) -> Result<(), Box<dyn std::error::Error>> { pub async fn run(self) -> Result<(), Box<dyn std::error::Error>> {
+2 -2
View File
@@ -16,8 +16,8 @@ pub struct ServicesContext {
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct Services { pub struct Services {
permission_sync: Arc<PermissionSyncService>, pub permission_sync: Arc<PermissionSyncService>,
server_order: Arc<ServerOrderService>, pub server_order: Arc<ServerOrderService>,
} }
impl Services { impl Services {