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.
• Runtime agnostic - Use tokio, smol etc.
• Optional Web interface to help you manage your jobs.

Apalis job processing is powered by tower::Service which means you have access to the tower middleware.

Apalis has support for

• Redis
• SQlite
• PostgresSQL
• MySQL
• Cron Jobs
• Bring Your Own Job Source eg Twitter streams

Getting Started

To get started, just add to Cargo.toml

[dependencies]
apalis = { version = "0.4", features = ["redis"] }

Usage

use apalis::prelude::*;
use apalis::redis::RedisStorage;
use serde::{Deserialize, Serialize};
use anyhow::Result;

#[derive(Debug, Deserialize, Serialize)]
struct Email {
    to: String,
}

async fn email_service(job: Email, ctx: JobContext) {
    info!("Do something");
}

#[tokio::main]
async fn main() -> Result<()> {
    std::env::set_var("RUST_LOG", "debug");
    env_logger::init();
    let redis = std::env::var("REDIS_URL").expect("Missing env variable REDIS_URL");
    let storage = RedisStorage::new(redis).await?;
    Monitor::new()
        .register_with_count(2, move || {
            WorkerBuilder::new("email-worker-1")
                .with_storage(storage.clone())
                .build_fn(email_service)
        })
        .run()
        .await
}

Then

//This can be in another part of the program or another application
async fn produce_route_jobs(storage: &RedisStorage<Email>) -> Result<()> {
    let mut storage = storage.clone();
    storage
        .push(Email {
            to: "test@example.com".to_string(),
        })
        .await?;
}

Web UI

If you are running Apalis Board, you can easily manage your jobs. See a working Rest API here

Feature flags

• tracing (enabled by default) — Support Tracing 👀
• redis — Include redis storage
• postgres — Include Postgres storage
• sqlite — Include SQlite storage
• mysql — Include MySql storage
• cron — Include cron job processing
• sentry — Support for Sentry exception and performance monitoring
• prometheus — Support Prometheus metrics
• retry — Support direct retrying jobs
• timeout — Support timeouts on jobs
• limit — 💪 Limit the amount of jobs
• filter — Support filtering jobs based on a predicate
• extensions — Add a global extensions to jobs

Storage Comparison

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

Feature	Redis	Sqlite	Postgres	Sled	Mysql	Mongo	Cron
Scheduled jobs	✓	✓	✓	x	✓	x	✓
Retry jobs	✓	✓	✓	x	✓	x	✓
Persistence	✓	✓	✓	x	✓	x	BYO
Rerun Dead jobs	✓	✓	✓	x	✓	x	x

How Apalis works (Draft)

sequenceDiagram
    participant App
    participant Worker
    participant Postgres

    App->>+Worker: Add job to queue
    Worker->>+Postgres: Poll queue for job
    Postgres-->>-Worker: Job data
    Worker->>+Postgres: Update job status to 'running'
    Postgres-->>-Worker: Confirmation
    Worker->>+App: Notify job started
    loop job execution
        Worker-->>-App: Report job progress
    end
    Worker->>+Postgres: Update job status to 'completed'
    Postgres-->>-Worker: Confirmation
    Worker->>+App: Notify job completed

Thanks to

• tower - Tower is a library of modular and reusable components for building robust networking clients and servers.
• redis-rs - Redis library for rust
• sqlx - The Rust SQL Toolkit

Roadmap

v 0.4

• Move from actor based to layer based processing
• Graceful Shutdown
• Allow other types of executors apart from Tokio
• Mock/Test Worker
• Improve monitoring
• Improve Apalis Board
• Add job progress via layer
• Add more sources

v 0.3

• Standardize API (Storage, Worker, Data, Middleware, Context )
• Introduce SQL
• Implement layers for Sentry and Tracing.
• Improve documentation
• Organized modules and features.
• Basic Web API Interface
• Sql Examples
• Sqlx migrations

v 0.2

• Redis Example
• Actix Web Example

Resources

• Background job processing with rust using actix and redis

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