Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edo1z/rust-rocket-sqlx-sample
A clean architecture style Sample using Rust's Rocket, sqlx and PostgreSQL.
https://github.com/edo1z/rust-rocket-sqlx-sample
clean-architecture postgresql rocket rust sqlx
Last synced: 8 days ago
JSON representation
A clean architecture style Sample using Rust's Rocket, sqlx and PostgreSQL.
- Host: GitHub
- URL: https://github.com/edo1z/rust-rocket-sqlx-sample
- Owner: edo1z
- License: mit
- Created: 2023-09-17T11:14:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T14:07:08.000Z (10 months ago)
- Last Synced: 2024-09-21T12:02:12.766Z (12 days ago)
- Topics: clean-architecture, postgresql, rocket, rust, sqlx
- Language: Rust
- Homepage:
- Size: 116 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rust-rocket-sqlx-sample
A clean architecture style Sample using Rust's [Rocket](https://rocket.rs/)(v0.5), [sqlx](https://github.com/launchbadge/sqlx)(v0.6) and PostgreSQL.
## How to Use
```shell
git clone https://github.com/edo1z/rust-rocket-sqlx-sample
cd rust-rocket-sqlx-sample
docker-compose up -d
cp .env.example .env
sh migrate.sh
cargo test
cargo run
```
## Features
- Tests for controller, use_case, and repository are created using [mockall](https://github.com/asomers/mockall).
- In the repository integration tests, transactions are created and rolled back in each function, enabling parallel execution of tests.
- In the repository, `DbRepoError` is returned and converted to `AppError` in use_case. `AppError` corresponds to Rocket's [responder](https://api.rocket.rs/v0.5/rocket/response/trait.Responder.html), so it can be used as a response as is.
- When an error occurs in the repository, an error log is output. Error log output uses [tracing](https://github.com/tokio-rs/tracing/tree/v0.1.x), and outputs the circumstances leading up to the log, file path, and line number. Also, the values of each function's arguments can be logged.
- When logging, the conversion from `sqlx::Error` etc. to `DbRepoError` is also performed, so the dedicated macro `log_into!` is used.
- AppError also has error creation macros like anyhow, `app_err!`, `app_err_bail!`, `app_err_ensure!`.
## Error Log Output
By using the features of [tracing](https://github.com/tokio-rs/tracing/tree/v0.1.x) and adding the [instrument attribute](https://docs.rs/tracing/latest/tracing/attr.instrument.html) to the function you want to output, the function will be output in the course of error occurrence. The arguments of the function can also be output. To prevent important information from leaking into the log, we generally use [skip_all](https://docs.rs/tracing/latest/tracing/attr.instrument.html#skipping-fields) to hide all arguments and explicitly display the arguments you want to show. Also, by using the `log_into!` macro, the file name and line number of the error occurrence are also output.
```rust
#[instrument(name = "user_repo/update", skip_all, fields(id = %id))]
```
### Example of Error Log Output
```log
2023-12-05T07:43:24.644738Z ERROR user_controller/update{id=12}:user_use_case/update{id=12}:user_repo/update{id=12}: rust_rocket_sqlx_sample::repositories::user_repo: [DbRepoError::SqlxError] no rows returned by a query that expected to return at least one row (src/repositories/user_repo.rs:85)
```