Apalis

Apalis is a simple, extensible multithreaded background job processing library for Rust.

Features

• Simple and predictable job handling model.
• Jobs handlers with a macro free API.
• Take full advantage of the [tower] ecosystem of middleware, services, and utilities.
• Takes full of the [actix] actors with each queue being an [Actor].

Apalis job processing is powered by [tower::Service] which means you have access to the [tower] and [tower-http] middleware.

Apalis has support for Redis, SQlite, PostgresSQL and MySQL.

Getting Started

To get started, just add to Cargo.toml

toml [dependencies] apalis = { version = "0.3.0-beta.0", features = ["redis"] }

Usage

```rust use apalis::{redis::RedisStorage, JobError, JobRequest, JobResult, QueueBuilder, Storage, Worker}; use serde::{Deserialize, Serialize};

[derive(Debug, Deserialize, Serialize)]

struct Email { to: String, }

async fn email_service(job: JobRequest) -> Result { Ok(JobResult::Success) }

[actix_rt::main]

async fn main() -> std::io::Result<()> { std::env::setvar("RUSTLOG", "debug"); envlogger::init(); let redis = std::env::var("REDISURL").expect("Missing env variable REDISURL"); let storage = RedisStorage::new(redis).await.unwrap(); Worker::new() .registerwithcount(2, move || { QueueBuilder::new(storage.clone()) .buildfn(email_service) .start() }) .run() .await }

```

Then

```rust //This can be in another part of the program or another application async fn produceroutejobs(storage: &RedisStorage) { let mut storage = storage.clone(); storage .push(Email { to: "test@example.com".to_string(), }) .await .unwrap(); }

```

Storage Comparison

Since we provide a few storage solutions, here is a table comparing them:

| Feature | Redis | Sqlite | Postgres | Sled | Mysql | Mongo | | :------------- | :---: | :----: | :------: | :--: | ----- | ----- | | Priorities | | | | | | | | Scheduled jobs | ✓ | ✓ | ✓ | ✓ | ✓ | - | | Retryable jobs | ✓ | ✓ | ✓ | | ✓ | - | | Persistence | ✓ | ✓ | ✓ | ✓ | ✓ | - |

Built On

• [actix] - Actor framework for Rust
• redis-rs - Redis library for rust
• sqlx - The Rust SQL Toolkit

Roadmap

v 0.3

• [x] Standardize API (Storage, Worker, Data, Middleware, Context )
• [x] Introduce SQL
• [ ] Implement layers for sentry and tracing.
• [ ] Improve documentation
• [ ] Organized modules and features.
• [ ] Basic Web API Interface
• [x] Sql Examples

v 0.2

• [x] Redis Example
• [x] Actix Web Example

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Njuguna Mureithi - Initial work - Njuguna Mureithi

See also the list of contributors who participated in this project.

It was formerly 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 file for details

Acknowledgments

• Inspiration: The redis part of this project is heavily inspired by Curlyq which is written in GoLang