https://github.com/geofmureithi-zz/apalis
Efficient and reliable background processing for Rust using Actix and Redis
https://github.com/geofmureithi-zz/apalis
actix background-processing jobs queue redis-queue scheduling
Last synced: 3 months ago
JSON representation
Efficient and reliable background processing for Rust using Actix and Redis
- Host: GitHub
- URL: https://github.com/geofmureithi-zz/apalis
- Owner: geofmureithi-zz
- Created: 2020-04-22T15:09:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-11T03:50:15.000Z (over 3 years ago)
- Last Synced: 2025-03-05T04:36:13.531Z (4 months ago)
- Topics: actix, background-processing, jobs, queue, redis-queue, scheduling
- Language: Rust
- Size: 102 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apalis [](https://travis-ci.org/geofmureithi/apalis)
Simple and reliable background processing for Rust using Actix actors. Apalis currently supports Redis as a store, with SQlite, PostgresSQL and MySQL in the pipeline.
## Getting Started
To get started, just add to Cargo.toml
```toml
[dependencies]
apalis = { version = "0.2", features = ["redis"] }
```
### Prerequisites
A running redis server is required.
You can quickly use docker:
```bash
docker run --name some-redis -d redis
```
## Usage
```rust
use actix::prelude::*;
use apalis::{
redis::{RedisConsumer, RedisProducer, RedisStorage}
Job, JobContext, JobFuture, JobHandler, Queue, Worker
};
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use std::sync::Mutex;
#[derive(Debug)]
pub enum MathError {
InternalError,
}
#[derive(Serialize, Deserialize)]
pub enum Math {
Add(u64, u64),
Fibonacci(u64),
}
impl Job for Math {
type Result = Result;
}
impl JobHandler> for Math {
type Result = JobFuture>;
fn handle(
self,
ctx: &mut JobContext>,
) -> JobFuture> {
let data = ctx.data_opt::>>().unwrap();
let mut data = data.lock().unwrap();
data.counter += 1;
match self {
Math::Add(first, second) => Box::pin(async move { Ok(first + second) }),
Math::Fibonacci(num) => {
let addr = ctx.data_opt::>().unwrap().clone();
Box::pin(async move {
addr.send(Fibonacci(num))
.await
.map_err(|_e| MathError::InternalError)?
})
}
}
}
}
fn produce_jobs(queue: &Queue) {
let producer = RedisProducer::start(queue);
producer.do_send(Math::Add(1, 2).into());
producer.do_send(Math::Fibonacci(9).into());
}
#[actix_rt::main]
async fn main() {
std::env::set_var("RUST_LOG", "info");
env_logger::init();
let storage = RedisStorage::new("redis://127.0.0.1/").unwrap();
let queue = Queue::::new(&storage);
//This can be in another part of the program
produce_jobs(&queue);
let counter = Arc::new(Mutex::new(MathCounter { counter: 0 }));
let addr = SyncArbiter::start(2, || FibonacciActor); //Get the address of another actor
Worker::new()
.register_with_threads(2, move || {
RedisConsumer::new(&queue)
.data(counter.clone())
.data(addr.clone())
})
.run()
.await;
}
```
## Built On
- [actix](https://actix.rs) - Actor framework for Rust
- [redis-rs](https://github.com/mitsuhiko/redis-rs) - Redis library for rust
- [sqlx](https://github.com/launchbadge/sqlx) - The Rust SQL Toolkit
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/geofmureithi/apalis/tags).
## Authors
- **Njuguna Mureithi** - _Initial work_ - [Njuguna Mureithi](https://github.com/geofmureithi)
See also the list of [contributors](https://github.com/geofmureithi/apalis/contributors) who participated in this project.
It was formally `actix-redis-jobs` and if you want to use the crate name please contact me.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
- Inspiration: The redis part of this project is heavily inspired by [Curlyq](https://github.com/mcmathja/curlyq) which is written in GoLang