Skip to content

feat(fortuna): allow filtering callback failing logs #2932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/fortuna/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fortuna"
version = "9.0.0"
version = "9.1.0"
edition = "2021"

[lib]
Expand Down
15 changes: 3 additions & 12 deletions apps/fortuna/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,12 @@ mod revelation;
pub type ChainId = String;
pub type NetworkId = u64;

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, utoipa::ToSchema, sqlx::Type)]
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, utoipa::ToSchema)]
pub enum StateTag {
Pending,
Completed,
Failed,
}

impl std::fmt::Display for StateTag {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
StateTag::Pending => write!(f, "Pending"),
StateTag::Completed => write!(f, "Completed"),
StateTag::Failed => write!(f, "Failed"),
}
}
Completed,
CallbackErrored,
}

#[derive(Clone, Debug, Hash, PartialEq, Eq, EncodeLabelSet)]
Expand Down
112 changes: 108 additions & 4 deletions apps/fortuna/src/history.rs
Original file line number Diff line number Diff line change
Expand Up @@ -533,9 +533,15 @@ impl<'a> RequestQueryBuilder<'a> {
sql.push_str(&format!(" AND network_id = ${param_count}"));
}

if self.state.is_some() {
if let Some(state) = &self.state {
param_count += 1;
sql.push_str(&format!(" AND state = ${param_count}"));

if *state == StateTag::Completed {
sql.push_str(" AND NOT callback_failed");
} else if *state == StateTag::CallbackErrored {
sql.push_str(" AND callback_failed");
}
}

sql.push_str(" ORDER BY created_at DESC");
Expand Down Expand Up @@ -570,7 +576,11 @@ impl<'a> RequestQueryBuilder<'a> {
}

if let Some(state) = &self.state {
query = query.bind(state.to_string());
query = query.bind(match state {
StateTag::Pending => "Pending",
StateTag::Failed => "Failed",
StateTag::Completed | StateTag::CallbackErrored => "Completed",
})
}

query = query.bind(self.limit).bind(self.offset);
Expand Down Expand Up @@ -612,9 +622,15 @@ impl<'a> RequestQueryBuilder<'a> {
sql.push_str(&format!(" AND network_id = ${param_count}"));
}

if self.state.is_some() {
if let Some(state) = &self.state {
param_count += 1;
sql.push_str(&format!(" AND state = ${param_count}"));

if *state == StateTag::Completed {
sql.push_str(" AND NOT callback_failed");
} else if *state == StateTag::CallbackErrored {
sql.push_str(" AND callback_failed");
}
}

// Now bind all parameters in order
Expand Down Expand Up @@ -642,7 +658,11 @@ impl<'a> RequestQueryBuilder<'a> {
}

if let Some(state) = &self.state {
query = query.bind(state.to_string());
query = query.bind(match state {
StateTag::Pending => "Pending",
StateTag::Failed => "Failed",
StateTag::Completed | StateTag::CallbackErrored => "Completed",
})
}

query.fetch_one(self.pool).await.map_err(|err| err.into())
Expand Down Expand Up @@ -1088,6 +1108,90 @@ mod test {
}
}

#[tokio::test]
async fn test_history_state_filter() {
let history = History::new_in_memory().await.unwrap();
let reveal_tx_hash = TxHash::random();

let pending_status = get_random_request_status();
History::update_request_status(&history.pool, pending_status.clone()).await;

let mut failed_status = get_random_request_status();
History::update_request_status(&history.pool, failed_status.clone()).await;
failed_status.state = RequestEntryState::Failed {
reason: "Failed".to_string(),
provider_random_number: None,
};
History::update_request_status(&history.pool, failed_status.clone()).await;

let mut completed_status = get_random_request_status();
History::update_request_status(&history.pool, completed_status.clone()).await;
completed_status.state = RequestEntryState::Completed {
reveal_block_number: 1,
reveal_tx_hash,
provider_random_number: [40; 32],
gas_used: U256::from(567890),
combined_random_number: RequestStatus::generate_combined_random_number(
&completed_status.user_random_number,
&[40; 32],
),
callback_failed: false,
callback_return_value: Default::default(),
callback_gas_used: 100_000,
};
History::update_request_status(&history.pool, completed_status.clone()).await;

let reveal_tx_hash = TxHash::random();
let mut callback_errored_status = get_random_request_status();
History::update_request_status(&history.pool, callback_errored_status.clone()).await;
callback_errored_status.state = RequestEntryState::Completed {
reveal_block_number: 1,
reveal_tx_hash,
provider_random_number: [40; 32],
gas_used: U256::from(567890),
combined_random_number: RequestStatus::generate_combined_random_number(
&callback_errored_status.user_random_number,
&[40; 32],
),
callback_failed: true,
callback_return_value: Default::default(),
callback_gas_used: 100_000,
};
History::update_request_status(&history.pool, callback_errored_status.clone()).await;

let logs = history
.query()
.state(StateTag::Pending)
.execute()
.await
.unwrap();
assert_eq!(logs, vec![pending_status.clone()]);

let logs = history
.query()
.state(StateTag::Failed)
.execute()
.await
.unwrap();
assert_eq!(logs, vec![failed_status.clone()]);

let logs = history
.query()
.state(StateTag::Completed)
.execute()
.await
.unwrap();
assert_eq!(logs, vec![completed_status.clone()]);

let logs = history
.query()
.state(StateTag::CallbackErrored)
.execute()
.await
.unwrap();
assert_eq!(logs, vec![callback_errored_status.clone()]);
}

#[tokio::test(flavor = "multi_thread")]
async fn test_writer_thread() {
let history = History::new_in_memory().await.unwrap();
Expand Down