Skip to content
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.

Sign up for GitHub

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

Add error codes to topup #70

Merged
merged 4 commits into from
Oct 13, 2023
Merged

Add error codes to topup #70

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70c76e4
Add error codes to topup
dleutenegger Oct 13, 2023
1c2d6d3
Apply suggestions from code review
dleutenegger Oct 13, 2023
c8d85a6
Remove `from_topup_error`
dleutenegger Oct 13, 2023
672c429
Add unkown error code
dleutenegger Oct 13, 2023
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
171 changes: 169 additions & 2 deletions crow/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,31 @@ pub enum TopupStatus {
SETTLED,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TemporaryFailureCode {
NoRoute,
InvoiceExpired,
Unexpected,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PermanentFailureCode {
ThresholdExceeded,
OrderInactive,
CompaniesUnsupported,
CountryUnsupported,
OtherRiskDetected,
CustomerRequested,
AccountNotMatching,
PayoutExpired,
}

#[derive(PartialEq, Eq, Debug, Clone)]
pub enum TopupError {
TemporaryFailure { code: TemporaryFailureCode },
PermanentFailure { code: PermanentFailureCode },
}

pub struct TopupInfo {
pub id: String,
pub status: TopupStatus,
Expand All @@ -33,6 +58,7 @@ pub struct TopupInfo {

pub expires_at: SystemTime,
pub lnurlw: String,
pub error: Option<TopupError>,
}

pub struct OfferManager {
Expand Down Expand Up @@ -146,6 +172,12 @@ fn to_topup_info(topup: ListUncompletedTopupsTopup) -> graphql::Result<TopupInfo
}
};

let error = match topup.status {
topup_status_enum::FAILED => to_topup_error(topup.additional_info),
topup_status_enum::REFUNDED => to_topup_error(topup.additional_info),
_ => None,
};

Ok(TopupInfo {
id: topup.id,
status,
Expand All @@ -158,14 +190,81 @@ fn to_topup_info(topup: ListUncompletedTopupsTopup) -> graphql::Result<TopupInfo

expires_at,
lnurlw,
error,
})
}

pub fn from_topup_error(error: Option<TopupError>) -> Option<String> {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove it if we do not use it here.
The reason is that imagine we will change the string representations here, but the client is using it to store information in a db, they will not be able to read old records. It is the client responsibility to find a stable way to represent enum values as string.

error.map(|e| {
match e {
TopupError::TemporaryFailure { code } => match code {
TemporaryFailureCode::NoRoute => "no_route",
TemporaryFailureCode::InvoiceExpired => "invoice_expired",
TemporaryFailureCode::Unexpected => "error",
},
TopupError::PermanentFailure { code } => match code {
PermanentFailureCode::ThresholdExceeded => "threshold_exceeded",
PermanentFailureCode::OrderInactive => "order_inactive",
PermanentFailureCode::CompaniesUnsupported => "companies_unsupported",
PermanentFailureCode::CountryUnsupported => "country_unsupported",
PermanentFailureCode::OtherRiskDetected => "other_risk_detected",
PermanentFailureCode::CustomerRequested => "customer_requested",
PermanentFailureCode::AccountNotMatching => "account_not_matching",
PermanentFailureCode::PayoutExpired => "payout_expired",
},
}
.to_string()
})
}

pub fn to_topup_error(code: Option<String>) -> Option<TopupError> {
code.map(|c| match &*c {
"no_route" => TopupError::TemporaryFailure {
code: TemporaryFailureCode::NoRoute,
},
"invoice_expired" => TopupError::TemporaryFailure {
code: TemporaryFailureCode::InvoiceExpired,
},
"error" => TopupError::TemporaryFailure {
code: TemporaryFailureCode::Unexpected,
},
"threshold_exceeded" => TopupError::PermanentFailure {
code: PermanentFailureCode::ThresholdExceeded,
},
"order_inactive" => TopupError::PermanentFailure {
code: PermanentFailureCode::OrderInactive,
},
"companies_unsupported" => TopupError::PermanentFailure {
code: PermanentFailureCode::CompaniesUnsupported,
},
"country_unsupported" => TopupError::PermanentFailure {
code: PermanentFailureCode::CountryUnsupported,
},
"other_risk_detected" => TopupError::PermanentFailure {
code: PermanentFailureCode::OtherRiskDetected,
},
"customer_requested" => TopupError::PermanentFailure {
code: PermanentFailureCode::CustomerRequested,
},
"account_not_matching" => TopupError::PermanentFailure {
code: PermanentFailureCode::AccountNotMatching,
},
"payout_expired" => TopupError::PermanentFailure {
code: PermanentFailureCode::PayoutExpired,
},
_ => TopupError::TemporaryFailure {
code: TemporaryFailureCode::Unexpected,
},
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
_ => TopupError::TemporaryFailure {
code: TemporaryFailureCode::Unexpected,
},
e => TopupError::PermanentFailure {
code: PermanentFailureCode::Unexpected { msg: e.to_string() },
},

})
}

#[cfg(test)]
mod tests {
use std::time::SystemTime;

use crate::{to_topup_info, TopupStatus};
use crate::{
to_topup_info, PermanentFailureCode, TemporaryFailureCode, TopupError, TopupStatus,
};
use graphql::schema::list_uncompleted_topups::{topup_status_enum, ListUncompletedTopupsTopup};

const LNURL: &str = "LNURL1DP68GURN8GHJ7UR0VD4K2ARPWPCZ6EMFWSKHXARPVA5KUEEDWPHKX6M9W3SHQUPWWEJHYCM9DSHXZURS9ASHQ6F0D3H82UNV9AMKJARGV3EXZAE0XVUNQDNYVDJRGTF4XGEKXTF5X56NXTTZX3NRWTT9XDJRJEP4VE3XGD3KXVXTX4LS";
Expand Down Expand Up @@ -215,6 +314,74 @@ mod tests {
assert_eq!(expires_at, 1695314361);
assert_eq!(topup_info.lnurlw, LNURL);

assert_eq!(topup_info.status, TopupStatus::READY)
assert_eq!(topup_info.status, TopupStatus::READY);

let topup = ListUncompletedTopupsTopup {
additional_info: Some("no_route".to_string()),
amount_sat: 42578,
amount_user_currency,
created_at: "2023-07-21T16:39:21.271+00:00".to_string(),
exchange_fee_rate: 0.014999999664723873,
exchange_fee_user_currency: 0.11999999731779099,
exchange_rate: 18507.0,
expires_at: "2023-09-21T16:39:21.919+00:00".to_string(),
id: "1707e09e-ebe1-4004-abd7-7a64604501b3".to_string(),
lightning_fee_user_currency: 0.0,
lnurl: LNURL.to_string(),
node_pub_key: "0233786a3f5c79d25508ed973e7a37506ddab49d41a07fcb3d341ab638000d69cf"
.to_string(),
status: topup_status_enum::FAILED,
user_currency: "eur".to_string(),
};

let topup_info = to_topup_info(topup).unwrap();

match topup_info.error {
None => {
panic!("Expected topup to have error code, was None")
}
Some(e) => match e {
TopupError::TemporaryFailure { code } => {
assert_eq!(code, TemporaryFailureCode::NoRoute)
}
TopupError::PermanentFailure { .. } => {
panic!("Expected topup to have temporary failure, was permanent")
}
},
}
dleutenegger marked this conversation as resolved.
Show resolved Hide resolved

let topup = ListUncompletedTopupsTopup {
additional_info: Some("customer_requested".to_string()),
amount_sat: 42578,
amount_user_currency,
created_at: "2023-07-21T16:39:21.271+00:00".to_string(),
exchange_fee_rate: 0.014999999664723873,
exchange_fee_user_currency: 0.11999999731779099,
exchange_rate: 18507.0,
expires_at: "2023-09-21T16:39:21.919+00:00".to_string(),
id: "1707e09e-ebe1-4004-abd7-7a64604501b3".to_string(),
lightning_fee_user_currency: 0.0,
lnurl: LNURL.to_string(),
node_pub_key: "0233786a3f5c79d25508ed973e7a37506ddab49d41a07fcb3d341ab638000d69cf"
.to_string(),
status: topup_status_enum::REFUNDED,
user_currency: "eur".to_string(),
};

let topup_info = to_topup_info(topup).unwrap();

match topup_info.error {
None => {
panic!("Expected topup to have error code, was None")
}
Some(e) => match e {
TopupError::TemporaryFailure { .. } => {
panic!("Expected topup to have permanent failure, was temporary")
}
TopupError::PermanentFailure { code } => {
assert_eq!(code, PermanentFailureCode::CustomerRequested)
}
},
}
dleutenegger marked this conversation as resolved.
Show resolved Hide resolved
}
}
Loading