refactor!: simplify code (#2)

daxartio · Feb 13, 2025 · 7425d71 · 7425d71
1 parent 5aa9910
commit 7425d71
Show file tree

Hide file tree

Showing 39 changed files with 352 additions and 1,189 deletions.
diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
diff --git a/Cargo.toml b/Cargo.toml
@@ -17,35 +17,12 @@ all-features = true
 
 [features]
 default = []
-redis = ["dep:redis"]
-json = ["dep:serde", "dep:serde_json"]
-tokio = ["dep:tokio"]
 
 [dependencies]
-async-trait = "0.1"
-redis = { version = "0.28", features=["connection-manager", "tokio-comp"], optional = true }
-serde = { version = "1.0", features = ["serde_derive"], optional = true }
-serde_json = { version = "1.0", optional = true }
-tokio = { version = "1.43", features = ["time"], optional = true }
+redis = { version = "0.28", features=["connection-manager", "tokio-comp"]}
 
 [dev-dependencies]
-tokio = { version = "1.43", features = ["time", "macros", "rt-multi-thread"]}
-redis = { version = "0.28", features=["connection-manager", "tokio-comp"] }
 serde = { version = "1.0", features = ["serde_derive"] }
 serde_json = { version = "1.0" }
-
-[[example]]
-name = "memory"
-required-features = ["tokio"]
-
-[[example]]
-name = "redis"
-required-features = ["redis", "tokio"]
-
-[[example]]
-name = "redis_json"
-required-features = ["redis", "json", "tokio"]
-
-[[example]]
-name = "redis_json_autodelete"
-required-features = ["redis", "json", "tokio"]
+tokio = { version = "1.43", features = ["time", "macros", "rt-multi-thread"]}
+tokio-util = { version = "0.7.13", features = ["full"] }
diff --git a/Justfile b/Justfile
@@ -0,0 +1,11 @@
+all: fmt check test
+
+check:
+	cargo fmt --all -- --check
+	cargo clippy --all-features --all-targets -- -D warnings
+
+test:
+	cargo test --all-features
+
+fmt:
+	cargo fmt --all
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2022 Danil Akhtarov <[email protected]>
+Copyright (c) 2025 Danil Akhtarov <[email protected]>
 
 Permission is hereby granted, free of charge, to any
 person obtaining a copy of this software and associated

diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -5,31 +5,24 @@
 [![Docs.rs](https://docs.rs/taskline/badge.svg)](https://docs.rs/taskline)
 <!-- [![Coverage Status](https://coveralls.io/repos/github/daxartio/taskline/badge.svg?branch=main)](https://coveralls.io/github/daxartio/taskline?branch=main) -->
 
-The library allows for creating scheduled tasks via Redis for Rust.
+Taskline is a Rust library for scheduling tasks via Redis.
 
-```rust
-producer.schedule(&"Hello!".to_string(), &(now() + 30000.)).await;
+## Overview
 
-loop {
-    let tasks = consumer.poll(&now()).await.unwrap();
+Taskline provides a simple way to schedule and process tasks asynchronously. It follows a producer-consumer model, where a producer schedules tasks to be executed at a specific time, and a consumer retrieves and processes them.
 
-    for task in tasks {
-        println!("Consumed {:?}", task);
-    }
-}
-```
-
-That means the Consumed will be printed in 30 seconds.
+## Use Cases
 
-You can customize a format of an event for redis. Write your wrapper over [RedisBackend](src/backends/redis.rs). See [redis_json backend](src/backends/redis_json.rs).
+Taskline is ideal for applications that require deferred execution, such as:
 
-![diagram](diagram.png)
+- Scheduling emails to be sent at a later time.
+- Sending notifications to users at a specific moment.
+- Any background job that needs time-based execution.
 
 ## Features
 
 - [x] Send/receive tasks in Redis
 - [x] Delayed tasks
-- [x] Support json
 - [x] Deleting from a storage after handling
 - [ ] Support Redis Cluster
 - [ ] Metrics
@@ -46,6 +39,22 @@ You can customize a format of an event for redis. Write your wrapper over [Redis
 cargo add taskline
 ```
 
+## Task Auto-Deletion
+
+### Default Behavior
+
+By default, Taskline automatically deletes tasks from storage after they are processed. This is the recommended approach for most use cases, as it ensures tasks are not executed multiple read.
+
+### Disabling Auto-Deletion
+
+If you prefer to manually manage task deletion, you can disable auto-delete by setting `autodelete=false`. However, this should only be used with a single consumer to avoid duplicate processing. If multiple consumers are involved, consider using a distributed lock mechanism like [redlock](https://redis.com/glossary/redlock/). For more details, see [Distributed Locks with Redis](https://redis.io/docs/manual/patterns/distributed-locks/).
+
+To manually remove a processed task, use: `Taskline::delete`.
+
+### Recommendation
+
+If your use case allows, it is recommended to keep `autodelete=true`, as it simplifies task management and reduces configuration overhead. However, be aware that in the event of an application crash, tasks may be lost before they are processed.
+
 ## License
 
 * [MIT LICENSE](LICENSE)

diff --git a/book.toml b/book.toml
diff --git a/diagram.d2 b/diagram.d2
diff --git a/diagram.png b/diagram.png
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/additional-resources.md b/docs/additional-resources.md
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/introduction.md b/docs/introduction.md
diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
diff --git a/docs/user-guide/autodelete.md b/docs/user-guide/autodelete.md
diff --git a/docs/user-guide/format.md b/docs/user-guide/format.md