refactor: move define_into_tonic_status to common-error (#4095)

* chore: finish cherry-pick

* chore: remove unused code

src/common/error/Cargo.toml

@@ -10,3 +10,4 @@ workspace = true
 [dependencies]
 snafu.workspace = true
 strum.workspace = true
+tonic.workspace = true

src/common/error/src/status_code.rs

@@ -15,6 +15,7 @@
 use std::fmt;
 
 use strum::{AsRefStr, EnumIter, EnumString, FromRepr};
+use tonic::Code;
 
 /// Common status code for public API.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, EnumString, AsRefStr, EnumIter, FromRepr)]
@@ -202,6 +203,75 @@ impl fmt::Display for StatusCode {
  }
 }
 
+#[macro_export]
+macro_rules! define_into_tonic_status {
+ ($Error: ty) => {
+ impl From<$Error> for tonic::Status {
+ fn from(err: $Error) -> Self {
+ use tonic::codegen::http::{HeaderMap, HeaderValue};
+ use tonic::metadata::MetadataMap;
+ use $crate::GREPTIME_DB_HEADER_ERROR_CODE;
+
+ let mut headers = HeaderMap::<HeaderValue>::with_capacity(2);
+
+ // If either of the status_code or error msg cannot convert to valid HTTP header value
+ // (which is a very rare case), just ignore. Client will use Tonic status code and message.
+ let status_code = err.status_code();
+ headers.insert(
+ GREPTIME_DB_HEADER_ERROR_CODE,
+ HeaderValue::from(status_code as u32),
+ );
+ let root_error = err.output_msg();
+
+ let metadata = MetadataMap::from_headers(headers);
+ tonic::Status::with_metadata(
+ $crate::status_code::status_to_tonic_code(status_code),
+ root_error,
+ metadata,
+ )
+ }
+ }
+ };
+}
+
+/// Returns the tonic [Code] of a [StatusCode].
+pub fn status_to_tonic_code(status_code: StatusCode) -> Code {
+ match status_code {
+ StatusCode::Success => Code::Ok,
+ StatusCode::Unknown => Code::Unknown,
+ StatusCode::Unsupported => Code::Unimplemented,
+ StatusCode::Unexpected
+ | StatusCode::Internal
+ | StatusCode::PlanQuery
+ | StatusCode::EngineExecuteQuery => Code::Internal,
+ StatusCode::InvalidArguments | StatusCode::InvalidSyntax | StatusCode::RequestOutdated => {
+ Code::InvalidArgument
+ }
+ StatusCode::Cancelled => Code::Cancelled,
+ StatusCode::TableAlreadyExists
+ | StatusCode::TableColumnExists
+ | StatusCode::RegionAlreadyExists
+ | StatusCode::FlowAlreadyExists => Code::AlreadyExists,
+ StatusCode::TableNotFound
+ | StatusCode::RegionNotFound
+ | StatusCode::TableColumnNotFound
+ | StatusCode::DatabaseNotFound
+ | StatusCode::UserNotFound
+ | StatusCode::FlowNotFound => Code::NotFound,
+ StatusCode::StorageUnavailable | StatusCode::RegionNotReady => Code::Unavailable,
+ StatusCode::RuntimeResourcesExhausted
+ | StatusCode::RateLimited
+ | StatusCode::RegionBusy => Code::ResourceExhausted,
+ StatusCode::UnsupportedPasswordType
+ | StatusCode::UserPasswordMismatch
+ | StatusCode::AuthHeaderNotFound
+ | StatusCode::InvalidAuthHeader => Code::Unauthenticated,
+ StatusCode::AccessDenied | StatusCode::PermissionDenied | StatusCode::RegionReadonly => {
+ Code::PermissionDenied
+ }
+ }
+}
+
 #[cfg(test)]
 mod tests {
  use strum::IntoEnumIterator;

src/datanode/src/error.rs

@@ -15,10 +15,10 @@
 use std::any::Any;
 use std::sync::Arc;
 
+use common_error::define_into_tonic_status;
 use common_error::ext::{BoxedError, ErrorExt};
 use common_error::status_code::StatusCode;
 use common_macro::stack_trace_debug;
-use servers::define_into_tonic_status;
 use snafu::{Location, Snafu};
 use store_api::storage::RegionId;
 use table::error::Error as TableError;

src/flow/src/adapter/error.rs

@@ -16,12 +16,12 @@
 
 use std::any::Any;
 
+use common_error::define_into_tonic_status;
 use common_error::ext::BoxedError;
 use common_macro::stack_trace_debug;
 use common_telemetry::common_error::ext::ErrorExt;
 use common_telemetry::common_error::status_code::StatusCode;
 use datatypes::value::Value;
-use servers::define_into_tonic_status;
 use snafu::{Location, Snafu};
 
 use crate::adapter::FlowId;

src/frontend/src/error.rs

@@ -15,10 +15,10 @@
 use std::any::Any;
 
 use common_datasource::file_format::Format;
+use common_error::define_into_tonic_status;
 use common_error::ext::{BoxedError, ErrorExt};
 use common_error::status_code::StatusCode;
 use common_macro::stack_trace_debug;
-use servers::define_into_tonic_status;
 use snafu::{Location, Snafu};
 use store_api::storage::RegionNumber;
 

src/meta-srv/src/error.rs

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use common_error::define_into_tonic_status;
 use common_error::ext::{BoxedError, ErrorExt};
 use common_error::status_code::StatusCode;
 use common_macro::stack_trace_debug;
 use common_meta::peer::Peer;
 use common_meta::DatanodeId;
 use common_runtime::JoinError;
 use rand::distributions::WeightedError;
-use servers::define_into_tonic_status;
 use snafu::{Location, Snafu};
 use store_api::storage::RegionId;
 use table::metadata::TableId;

src/operator/Cargo.toml

@@ -47,7 +47,6 @@ prometheus.workspace = true
 query.workspace = true
 regex.workspace = true
 serde_json.workspace = true
-servers.workspace = true
 session.workspace = true
 snafu.workspace = true
 sql.workspace = true

src/operator/src/error.rs

@@ -15,12 +15,12 @@
 use std::any::Any;
 
 use common_datasource::file_format::Format;
+use common_error::define_into_tonic_status;
 use common_error::ext::{BoxedError, ErrorExt};
 use common_error::status_code::StatusCode;
 use common_macro::stack_trace_debug;
 use datafusion::parquet;
 use datatypes::arrow::error::ArrowError;
-use servers::define_into_tonic_status;
 use snafu::{Location, Snafu};
 
 #[derive(Snafu)]

src/servers/src/error.rs

@@ -21,6 +21,7 @@ use axum::response::{IntoResponse, Response};
 use axum::{http, Json};
 use base64::DecodeError;
 use catalog;
+use common_error::define_into_tonic_status;
 use common_error::ext::{BoxedError, ErrorExt};
 use common_error::status_code::StatusCode;
 use common_macro::stack_trace_debug;
@@ -29,7 +30,6 @@ use datatypes::prelude::ConcreteDataType;
 use query::parser::PromQuery;
 use serde_json::json;
 use snafu::{Location, Snafu};
-use tonic::Code;
 
 #[derive(Snafu)]
 #[snafu(visibility(pub))]
@@ -695,75 +695,6 @@ impl ErrorExt for Error {
  }
 }
 
-/// Returns the tonic [Code] of a [StatusCode].
-pub fn status_to_tonic_code(status_code: StatusCode) -> Code {
- match status_code {
- StatusCode::Success => Code::Ok,
- StatusCode::Unknown => Code::Unknown,
- StatusCode::Unsupported => Code::Unimplemented,
- StatusCode::Unexpected
- | StatusCode::Internal
- | StatusCode::PlanQuery
- | StatusCode::EngineExecuteQuery => Code::Internal,
- StatusCode::InvalidArguments | StatusCode::InvalidSyntax | StatusCode::RequestOutdated => {
- Code::InvalidArgument
- }
- StatusCode::Cancelled => Code::Cancelled,
- StatusCode::TableAlreadyExists
- | StatusCode::TableColumnExists
- | StatusCode::RegionAlreadyExists
- | StatusCode::FlowAlreadyExists => Code::AlreadyExists,
- StatusCode::TableNotFound
- | StatusCode::RegionNotFound
- | StatusCode::TableColumnNotFound
- | StatusCode::DatabaseNotFound
- | StatusCode::UserNotFound
- | StatusCode::FlowNotFound => Code::NotFound,
- StatusCode::StorageUnavailable | StatusCode::RegionNotReady => Code::Unavailable,
- StatusCode::RuntimeResourcesExhausted
- | StatusCode::RateLimited
- | StatusCode::RegionBusy => Code::ResourceExhausted,
- StatusCode::UnsupportedPasswordType
- | StatusCode::UserPasswordMismatch
- | StatusCode::AuthHeaderNotFound
- | StatusCode::InvalidAuthHeader => Code::Unauthenticated,
- StatusCode::AccessDenied | StatusCode::PermissionDenied | StatusCode::RegionReadonly => {
- Code::PermissionDenied
- }
- }
-}
-
-#[macro_export]
-macro_rules! define_into_tonic_status {
- ($Error: ty) => {
- impl From<$Error> for tonic::Status {
- fn from(err: $Error) -> Self {
- use tonic::codegen::http::{HeaderMap, HeaderValue};
- use tonic::metadata::MetadataMap;
- use $crate::http::header::constants::GREPTIME_DB_HEADER_ERROR_CODE;
-
- let mut headers = HeaderMap::<HeaderValue>::with_capacity(2);
-
- // If either of the status_code or error msg cannot convert to valid HTTP header value
- // (which is a very rare case), just ignore. Client will use Tonic status code and message.
- let status_code = err.status_code();
- headers.insert(
- GREPTIME_DB_HEADER_ERROR_CODE,
- HeaderValue::from(status_code as u32),
- );
- let root_error = err.output_msg();
-
- let metadata = MetadataMap::from_headers(headers);
- tonic::Status::with_metadata(
- $crate::error::status_to_tonic_code(status_code),
- root_error,
- metadata,
- )
- }
- }
- };
-}
-
 define_into_tonic_status!(Error);
 
 impl From<std::io::Error> for Error {