* fetch task async and renaming every Job/job to Task/task * fixing cargo clippy * Task instead Job in readme * change one task because if not test will fail, redefined all tasks structs * derive feature * deleting schema * changing query * task builder * fix bug enum fang task state * fetch_test based on metadata, good improve testing fetch_task * deleting toSql FromSql derives that are useless for Task * builders and fail_task change
384 lines
13 KiB
Rust
384 lines
13 KiB
Rust
use crate::asynk::AsyncRunnable;
|
|
use bb8_postgres::bb8::Pool;
|
|
use bb8_postgres::bb8::RunError;
|
|
use bb8_postgres::tokio_postgres::row::Row;
|
|
use bb8_postgres::tokio_postgres::tls::MakeTlsConnect;
|
|
use bb8_postgres::tokio_postgres::tls::TlsConnect;
|
|
use bb8_postgres::tokio_postgres::Socket;
|
|
use bb8_postgres::tokio_postgres::Transaction;
|
|
use bb8_postgres::PostgresConnectionManager;
|
|
use chrono::DateTime;
|
|
use chrono::Utc;
|
|
use postgres_types::{FromSql, ToSql};
|
|
use thiserror::Error;
|
|
use typed_builder::TypedBuilder;
|
|
use uuid::Uuid;
|
|
|
|
#[derive(Debug, Eq, PartialEq, Clone, ToSql, FromSql)]
|
|
#[postgres(name = "fang_task_state")]
|
|
pub enum FangTaskState {
|
|
#[postgres(name = "new")]
|
|
New,
|
|
#[postgres(name = "in_progress")]
|
|
InProgress,
|
|
#[postgres(name = "failed")]
|
|
Failed,
|
|
#[postgres(name = "finished")]
|
|
Finished,
|
|
}
|
|
impl Default for FangTaskState {
|
|
fn default() -> Self {
|
|
FangTaskState::New
|
|
}
|
|
}
|
|
#[derive(TypedBuilder, Debug, Eq, PartialEq, Clone)]
|
|
pub struct Task {
|
|
#[builder(setter(into))]
|
|
pub id: Uuid,
|
|
#[builder(setter(into))]
|
|
pub metadata: serde_json::Value,
|
|
#[builder(setter(into))]
|
|
pub error_message: Option<String>,
|
|
#[builder(default, setter(into))]
|
|
pub state: FangTaskState,
|
|
#[builder(setter(into))]
|
|
pub task_type: String,
|
|
#[builder(setter(into))]
|
|
pub created_at: DateTime<Utc>,
|
|
#[builder(setter(into))]
|
|
pub updated_at: DateTime<Utc>,
|
|
}
|
|
|
|
#[derive(TypedBuilder, Debug, Eq, PartialEq, Clone)]
|
|
pub struct PeriodicTask {
|
|
#[builder(setter(into))]
|
|
pub id: Uuid,
|
|
#[builder(setter(into))]
|
|
pub metadata: serde_json::Value,
|
|
#[builder(setter(into))]
|
|
pub period_in_seconds: i32,
|
|
#[builder(setter(into))]
|
|
pub scheduled_at: Option<DateTime<Utc>>,
|
|
#[builder(setter(into))]
|
|
pub created_at: DateTime<Utc>,
|
|
#[builder(setter(into))]
|
|
pub updated_at: DateTime<Utc>,
|
|
}
|
|
|
|
#[derive(TypedBuilder, Debug, Eq, PartialEq, Clone)]
|
|
pub struct NewTask {
|
|
#[builder(setter(into))]
|
|
pub metadata: serde_json::Value,
|
|
#[builder(setter(into))]
|
|
pub task_type: String,
|
|
}
|
|
|
|
#[derive(TypedBuilder, Debug, Eq, PartialEq, Clone)]
|
|
pub struct NewPeriodicTask {
|
|
#[builder(setter(into))]
|
|
pub metadata: serde_json::Value,
|
|
#[builder(setter(into))]
|
|
pub period_in_seconds: i32,
|
|
}
|
|
#[derive(Debug, Error)]
|
|
pub enum AsyncQueueError {
|
|
#[error(transparent)]
|
|
PoolError(#[from] RunError<bb8_postgres::tokio_postgres::Error>),
|
|
#[error(transparent)]
|
|
PgError(#[from] bb8_postgres::tokio_postgres::Error),
|
|
#[error("returned invalid result (expected {expected:?}, found {found:?})")]
|
|
ResultError { expected: u64, found: u64 },
|
|
#[error("Queue doesn't have a connection")]
|
|
PoolAndTransactionEmpty,
|
|
#[error("Need to create a transaction to perform this operation")]
|
|
TransactionEmpty,
|
|
}
|
|
|
|
#[derive(TypedBuilder)]
|
|
pub struct AsyncQueue<'a, Tls>
|
|
where
|
|
Tls: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
|
|
<Tls as MakeTlsConnect<Socket>>::Stream: Send + Sync,
|
|
<Tls as MakeTlsConnect<Socket>>::TlsConnect: Send,
|
|
<<Tls as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
|
|
{
|
|
#[builder(default, setter(into))]
|
|
pool: Option<Pool<PostgresConnectionManager<Tls>>>,
|
|
#[builder(default, setter(into))]
|
|
transaction: Option<Transaction<'a>>,
|
|
}
|
|
|
|
const INSERT_TASK_QUERY: &str = include_str!("queries/insert_task.sql");
|
|
const UPDATE_TASK_STATE_QUERY: &str = include_str!("queries/update_task_state.sql");
|
|
const FAIL_TASK_QUERY: &str = include_str!("queries/fail_task.sql");
|
|
const REMOVE_ALL_TASK_QUERY: &str = include_str!("queries/remove_all_tasks.sql");
|
|
const REMOVE_TASK_QUERY: &str = include_str!("queries/remove_task.sql");
|
|
const REMOVE_TASKS_TYPE_QUERY: &str = include_str!("queries/remove_tasks_type.sql");
|
|
const FETCH_TASK_TYPE_QUERY: &str = include_str!("queries/fetch_task_type.sql");
|
|
|
|
impl<'a, Tls> AsyncQueue<'a, Tls>
|
|
where
|
|
Tls: MakeTlsConnect<Socket> + Clone + Send + Sync + 'static,
|
|
<Tls as MakeTlsConnect<Socket>>::Stream: Send + Sync,
|
|
<Tls as MakeTlsConnect<Socket>>::TlsConnect: Send,
|
|
<<Tls as MakeTlsConnect<Socket>>::TlsConnect as TlsConnect<Socket>>::Future: Send,
|
|
{
|
|
pub fn new(pool: Pool<PostgresConnectionManager<Tls>>) -> Self {
|
|
AsyncQueue::builder().pool(pool).build()
|
|
}
|
|
|
|
pub fn new_with_transaction(transaction: Transaction<'a>) -> Self {
|
|
AsyncQueue::builder().transaction(transaction).build()
|
|
}
|
|
pub async fn rollback(mut self) -> Result<AsyncQueue<'a, Tls>, AsyncQueueError> {
|
|
let transaction = self.transaction;
|
|
self.transaction = None;
|
|
match transaction {
|
|
Some(tr) => {
|
|
tr.rollback().await?;
|
|
Ok(self)
|
|
}
|
|
None => Err(AsyncQueueError::TransactionEmpty),
|
|
}
|
|
}
|
|
pub async fn commit(mut self) -> Result<AsyncQueue<'a, Tls>, AsyncQueueError> {
|
|
let transaction = self.transaction;
|
|
self.transaction = None;
|
|
match transaction {
|
|
Some(tr) => {
|
|
tr.commit().await?;
|
|
Ok(self)
|
|
}
|
|
None => Err(AsyncQueueError::TransactionEmpty),
|
|
}
|
|
}
|
|
pub async fn fetch_task(
|
|
&mut self,
|
|
task_type: &Option<String>,
|
|
) -> Result<Task, AsyncQueueError> {
|
|
let mut task = match task_type {
|
|
None => self.get_task_type("common").await?,
|
|
Some(task_type_str) => self.get_task_type(task_type_str).await?,
|
|
};
|
|
self.update_task_state(&task, FangTaskState::InProgress)
|
|
.await?;
|
|
task.state = FangTaskState::InProgress;
|
|
Ok(task)
|
|
}
|
|
pub async fn get_task_type(&mut self, task_type: &str) -> Result<Task, AsyncQueueError> {
|
|
let row: Row = self.get_row(FETCH_TASK_TYPE_QUERY, &[&task_type]).await?;
|
|
let id: Uuid = row.get("id");
|
|
let metadata: serde_json::Value = row.get("metadata");
|
|
let error_message: Option<String> = match row.try_get("error_message") {
|
|
Ok(error_message) => Some(error_message),
|
|
Err(_) => None,
|
|
};
|
|
let state: FangTaskState = FangTaskState::New;
|
|
let task_type: String = row.get("task_type");
|
|
let created_at: DateTime<Utc> = row.get("created_at");
|
|
let updated_at: DateTime<Utc> = row.get("updated_at");
|
|
let task = Task::builder()
|
|
.id(id)
|
|
.metadata(metadata)
|
|
.error_message(error_message)
|
|
.state(state)
|
|
.task_type(task_type)
|
|
.created_at(created_at)
|
|
.updated_at(updated_at)
|
|
.build();
|
|
Ok(task)
|
|
}
|
|
pub async fn get_row(
|
|
&mut self,
|
|
query: &str,
|
|
params: &[&(dyn ToSql + Sync)],
|
|
) -> Result<Row, AsyncQueueError> {
|
|
let row: Row = if let Some(pool) = &self.pool {
|
|
let connection = pool.get().await?;
|
|
|
|
connection.query_one(query, params).await?
|
|
} else if let Some(transaction) = &self.transaction {
|
|
transaction.query_one(query, params).await?
|
|
} else {
|
|
return Err(AsyncQueueError::PoolAndTransactionEmpty);
|
|
};
|
|
Ok(row)
|
|
}
|
|
pub async fn insert_task(&mut self, task: &dyn AsyncRunnable) -> Result<u64, AsyncQueueError> {
|
|
let metadata = serde_json::to_value(task).unwrap();
|
|
let task_type = task.task_type();
|
|
|
|
self.execute(INSERT_TASK_QUERY, &[&metadata, &task_type], Some(1))
|
|
.await
|
|
}
|
|
pub async fn update_task_state(
|
|
&mut self,
|
|
task: &Task,
|
|
state: FangTaskState,
|
|
) -> Result<u64, AsyncQueueError> {
|
|
let updated_at = Utc::now();
|
|
self.execute(
|
|
UPDATE_TASK_STATE_QUERY,
|
|
&[&state, &updated_at, &task.id],
|
|
Some(1),
|
|
)
|
|
.await
|
|
}
|
|
pub async fn remove_all_tasks(&mut self) -> Result<u64, AsyncQueueError> {
|
|
self.execute(REMOVE_ALL_TASK_QUERY, &[], None).await
|
|
}
|
|
pub async fn remove_task(&mut self, task: &Task) -> Result<u64, AsyncQueueError> {
|
|
self.execute(REMOVE_TASK_QUERY, &[&task.id], Some(1)).await
|
|
}
|
|
pub async fn remove_tasks_type(&mut self, task_type: &str) -> Result<u64, AsyncQueueError> {
|
|
self.execute(REMOVE_TASKS_TYPE_QUERY, &[&task_type], None)
|
|
.await
|
|
}
|
|
pub async fn fail_task(&mut self, task: &Task) -> Result<u64, AsyncQueueError> {
|
|
let updated_at = Utc::now();
|
|
self.execute(
|
|
FAIL_TASK_QUERY,
|
|
&[
|
|
&FangTaskState::Failed,
|
|
&task.error_message,
|
|
&updated_at,
|
|
&task.id,
|
|
],
|
|
Some(1),
|
|
)
|
|
.await
|
|
}
|
|
|
|
async fn execute(
|
|
&mut self,
|
|
query: &str,
|
|
params: &[&(dyn ToSql + Sync)],
|
|
expected_result_count: Option<u64>,
|
|
) -> Result<u64, AsyncQueueError> {
|
|
let result = if let Some(pool) = &self.pool {
|
|
let connection = pool.get().await?;
|
|
|
|
connection.execute(query, params).await?
|
|
} else if let Some(transaction) = &self.transaction {
|
|
transaction.execute(query, params).await?
|
|
} else {
|
|
return Err(AsyncQueueError::PoolAndTransactionEmpty);
|
|
};
|
|
if let Some(expected_result) = expected_result_count {
|
|
if result != expected_result {
|
|
return Err(AsyncQueueError::ResultError {
|
|
expected: expected_result,
|
|
found: result,
|
|
});
|
|
}
|
|
}
|
|
Ok(result)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod async_queue_tests {
|
|
use super::AsyncQueue;
|
|
use crate::asynk::AsyncRunnable;
|
|
use crate::asynk::Error;
|
|
use async_trait::async_trait;
|
|
use bb8_postgres::bb8::Pool;
|
|
use bb8_postgres::tokio_postgres::Client;
|
|
use bb8_postgres::tokio_postgres::NoTls;
|
|
use bb8_postgres::PostgresConnectionManager;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
#[derive(Serialize, Deserialize)]
|
|
struct AsyncTask {
|
|
pub number: u16,
|
|
}
|
|
|
|
#[typetag::serde]
|
|
#[async_trait]
|
|
impl AsyncRunnable for AsyncTask {
|
|
async fn run(&self, _connection: &Client) -> Result<(), Error> {
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn insert_task_creates_new_task() {
|
|
let pool = pool().await;
|
|
let mut connection = pool.get().await.unwrap();
|
|
let transaction = connection.transaction().await.unwrap();
|
|
let mut queue = AsyncQueue::<NoTls>::new_with_transaction(transaction);
|
|
|
|
let result = queue.insert_task(&AsyncTask { number: 1 }).await.unwrap();
|
|
|
|
assert_eq!(1, result);
|
|
queue.rollback().await.unwrap();
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn remove_all_tasks_test() {
|
|
let pool = pool().await;
|
|
let mut connection = pool.get().await.unwrap();
|
|
let transaction = connection.transaction().await.unwrap();
|
|
let mut queue = AsyncQueue::<NoTls>::new_with_transaction(transaction);
|
|
|
|
let result = queue.insert_task(&AsyncTask { number: 1 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let result = queue.insert_task(&AsyncTask { number: 2 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let result = queue.remove_all_tasks().await.unwrap();
|
|
assert_eq!(2, result);
|
|
queue.rollback().await.unwrap();
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn fetch_test() {
|
|
let pool = pool().await;
|
|
let mut connection = pool.get().await.unwrap();
|
|
let transaction = connection.transaction().await.unwrap();
|
|
let mut queue = AsyncQueue::<NoTls>::new_with_transaction(transaction);
|
|
|
|
let result = queue.insert_task(&AsyncTask { number: 1 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let result = queue.insert_task(&AsyncTask { number: 2 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let task = queue.fetch_task(&None).await.unwrap();
|
|
let metadata = task.metadata.as_object().unwrap();
|
|
let number = metadata["number"].as_u64();
|
|
let type_task = metadata["type"].as_str();
|
|
assert_eq!(Some(1), number);
|
|
assert_eq!(Some("AsyncTask"), type_task);
|
|
let task = queue.fetch_task(&None).await.unwrap();
|
|
let metadata = task.metadata.as_object().unwrap();
|
|
let number = metadata["number"].as_u64();
|
|
let type_task = metadata["type"].as_str();
|
|
assert_eq!(Some(2), number);
|
|
assert_eq!(Some("AsyncTask"), type_task);
|
|
queue.rollback().await.unwrap();
|
|
}
|
|
#[tokio::test]
|
|
async fn remove_tasks_type_test() {
|
|
let pool = pool().await;
|
|
let mut connection = pool.get().await.unwrap();
|
|
let transaction = connection.transaction().await.unwrap();
|
|
let mut queue = AsyncQueue::<NoTls>::new_with_transaction(transaction);
|
|
|
|
let result = queue.insert_task(&AsyncTask { number: 1 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let result = queue.insert_task(&AsyncTask { number: 2 }).await.unwrap();
|
|
assert_eq!(1, result);
|
|
let result = queue.remove_tasks_type("common").await.unwrap();
|
|
assert_eq!(2, result);
|
|
queue.rollback().await.unwrap();
|
|
}
|
|
|
|
async fn pool() -> Pool<PostgresConnectionManager<NoTls>> {
|
|
let pg_mgr = PostgresConnectionManager::new_from_stringlike(
|
|
"postgres://postgres:postgres@localhost/fang",
|
|
NoTls,
|
|
)
|
|
.unwrap();
|
|
|
|
Pool::builder().build(pg_mgr).await.unwrap()
|
|
}
|
|
}
|