-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(drive): handlers error codes (#1394)
Co-authored-by: Ivan Shumkov <[email protected]> Co-authored-by: QuantumExplorer <[email protected]>
- Loading branch information
3 people
authored
Oct 3, 2023
1 parent
da77043
commit f32d415
Showing
8 changed files
with
348 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| use crate::error::query::QueryError; | ||
| use crate::error::Error; | ||
| use dpp::platform_value::platform_value; | ||
| use dpp::platform_value::string_encoding::{encode, Encoding}; | ||
| use tenderdash_abci::proto::abci::ResponseException; | ||
|
|
||
| /// ABCI handlers errors | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum HandlerError { | ||
| /// ABCI Handler error (Cancelled) | ||
| #[error("{0}")] | ||
| Cancelled(String), | ||
| /// ABCI Handler error (Unknown) | ||
| #[error("{0}")] | ||
| Unknown(String), | ||
| /// ABCI Handler error (InvalidArgument) | ||
| #[error("{0}")] | ||
| InvalidArgument(String), | ||
| /// ABCI Handler error (DeadlineExceeded) | ||
| #[error("{0}")] | ||
| DeadlineExceeded(String), | ||
| /// ABCI Handler error (NotFound) | ||
| #[error("{0}")] | ||
| NotFound(String), | ||
| /// ABCI Handler error (AlreadyExists) | ||
| #[error("{0}")] | ||
| AlreadyExists(String), | ||
| /// ABCI Handler error (PermissionDenied) | ||
| #[error("{0}")] | ||
| PermissionDenied(String), | ||
| /// ABCI Handler error (ResourceExhausted) | ||
| #[error("{0}")] | ||
| ResourceExhausted(String), | ||
| /// ABCI Handler error (FailedPrecondition) | ||
| #[error("{0}")] | ||
| FailedPrecondition(String), | ||
| /// ABCI Handler error (Aborted) | ||
| #[error("{0}")] | ||
| Aborted(String), | ||
| /// ABCI Handler error (OutOfRange) | ||
| #[error("{0}")] | ||
| OutOfRange(String), | ||
| /// ABCI Handler error (Unimplemented) | ||
| #[error("{0}")] | ||
| Unimplemented(String), | ||
| /// ABCI Handler error (Internal) | ||
| #[error("{0}")] | ||
| Internal(String), | ||
| /// ABCI Handler error (Unavailable) | ||
| #[error("{0}")] | ||
| Unavailable(String), | ||
| /// ABCI Handler error (DataLoss) | ||
| #[error("{0}")] | ||
| DataLoss(String), | ||
| /// ABCI Handler error (Unauthenticated) | ||
| #[error("{0}")] | ||
| Unauthenticated(String), | ||
| } | ||
|
|
||
| /// Error codes for ABCI handlers | ||
| #[repr(u32)] | ||
| pub enum HandlerErrorCode { | ||
| /// ABCI Handler error (Cancelled) | ||
| Cancelled = 1, | ||
| /// ABCI Handler error (Unknown) | ||
| Unknown = 2, | ||
| /// ABCI Handler error (InvalidArgument) | ||
| InvalidArgument = 3, | ||
| /// ABCI Handler error (DeadlineExceeded) | ||
| DeadlineExceeded = 4, | ||
| /// ABCI Handler error (NotFound) | ||
| NotFound = 5, | ||
| /// ABCI Handler error (AlreadyExists) | ||
| AlreadyExists = 6, | ||
| /// ABCI Handler error (PermissionDenied) | ||
| PermissionDenied = 7, | ||
| /// ABCI Handler error (ResourceExhausted) | ||
| ResourceExhausted = 8, | ||
| /// ABCI Handler error (FailedPrecondition) | ||
| FailedPrecondition = 9, | ||
| /// ABCI Handler error (Aborted) | ||
| Aborted = 10, | ||
| /// ABCI Handler error (OutOfRange) | ||
| OutOfRange = 11, | ||
| /// ABCI Handler error (Unimplemented) | ||
| Unimplemented = 12, | ||
| /// ABCI Handler error (Internal) | ||
| Internal = 13, | ||
| /// ABCI Handler error (Unavailable) | ||
| Unavailable = 14, | ||
| /// ABCI Handler error (DataLoss) | ||
| DataLoss = 15, | ||
| /// ABCI Handler error (Unauthenticated) | ||
| Unauthenticated = 16, | ||
| } | ||
|
|
||
| impl HandlerError { | ||
| /// Returns ABCI handler error code | ||
| pub fn code(&self) -> u32 { | ||
| let code = match self { | ||
| HandlerError::Cancelled(_) => HandlerErrorCode::Cancelled, | ||
| HandlerError::Unknown(_) => HandlerErrorCode::Unknown, | ||
| HandlerError::InvalidArgument(_) => HandlerErrorCode::InvalidArgument, | ||
| HandlerError::DeadlineExceeded(_) => HandlerErrorCode::DeadlineExceeded, | ||
| HandlerError::NotFound(_) => HandlerErrorCode::NotFound, | ||
| HandlerError::AlreadyExists(_) => HandlerErrorCode::AlreadyExists, | ||
| HandlerError::PermissionDenied(_) => HandlerErrorCode::PermissionDenied, | ||
| HandlerError::ResourceExhausted(_) => HandlerErrorCode::ResourceExhausted, | ||
| HandlerError::FailedPrecondition(_) => HandlerErrorCode::FailedPrecondition, | ||
| HandlerError::Aborted(_) => HandlerErrorCode::Aborted, | ||
| HandlerError::OutOfRange(_) => HandlerErrorCode::OutOfRange, | ||
| HandlerError::Unimplemented(_) => HandlerErrorCode::Unimplemented, | ||
| HandlerError::Internal(_) => HandlerErrorCode::Internal, | ||
| HandlerError::Unavailable(_) => HandlerErrorCode::Unavailable, | ||
| HandlerError::DataLoss(_) => HandlerErrorCode::DataLoss, | ||
| HandlerError::Unauthenticated(_) => HandlerErrorCode::Unauthenticated, | ||
| }; | ||
|
|
||
| code as u32 | ||
| } | ||
|
|
||
| /// Returns error message | ||
| pub fn message(&self) -> &str { | ||
| match self { | ||
| HandlerError::Cancelled(message) => message, | ||
| HandlerError::Unknown(message) => message, | ||
| HandlerError::InvalidArgument(message) => message, | ||
| HandlerError::DeadlineExceeded(message) => message, | ||
| HandlerError::NotFound(message) => message, | ||
| HandlerError::AlreadyExists(message) => message, | ||
| HandlerError::PermissionDenied(message) => message, | ||
| HandlerError::ResourceExhausted(message) => message, | ||
| HandlerError::FailedPrecondition(message) => message, | ||
| HandlerError::Aborted(message) => message, | ||
| HandlerError::OutOfRange(message) => message, | ||
| HandlerError::Unimplemented(message) => message, | ||
| HandlerError::Internal(message) => message, | ||
| HandlerError::Unavailable(message) => message, | ||
| HandlerError::DataLoss(message) => message, | ||
| HandlerError::Unauthenticated(message) => message, | ||
| } | ||
| } | ||
|
|
||
| /// Returns base64-encoded message for info field of ABCI handler responses | ||
| pub fn response_info(&self) -> Result<String, ResponseException> { | ||
| let error_data_buffer = platform_value!({ | ||
| "message": self.message().to_string(), | ||
| // TODO: consider capturing stack with one of the libs | ||
| // and send it to the client | ||
| //"stack": "..." | ||
| }) | ||
| .to_cbor_buffer() | ||
| .map_err(|e| ResponseException::from(Error::Protocol(e.into())))?; | ||
|
|
||
| let error_data_base64 = encode(&error_data_buffer, Encoding::Base64); | ||
|
|
||
| Ok(error_data_base64) | ||
| } | ||
| } | ||
|
|
||
| impl From<&QueryError> for HandlerError { | ||
| fn from(value: &QueryError) -> Self { | ||
| match value { | ||
| QueryError::NotFound(message) => HandlerError::NotFound(message.to_owned()), | ||
| QueryError::InvalidArgument(message) => { | ||
| HandlerError::InvalidArgument(message.to_owned()) | ||
| } | ||
| QueryError::Query(error) => HandlerError::InvalidArgument(error.to_string()), | ||
| _ => HandlerError::Unknown(value.to_string()), | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.