Merge pull request #7695 from drmingdrmer/9-explain-meta-err

docs(meta/errors): explain relationship between various error types in meta-store

Author: Xuanwo

src/meta/api/src/schema_api_impl.rs

@@ -77,27 +77,27 @@ use common_meta_app::share::ShareGrantObject;
 use common_meta_app::share::ShareGrantObjectPrivilege;
 use common_meta_app::share::ShareId;
 use common_meta_app::share::ShareNameIdent;
-use common_meta_types::app_error::AppError;
-use common_meta_types::app_error::CreateDatabaseWithDropTime;
-use common_meta_types::app_error::CreateTableWithDropTime;
-use common_meta_types::app_error::DatabaseAlreadyExists;
-use common_meta_types::app_error::DropDbWithDropTime;
-use common_meta_types::app_error::DropTableWithDropTime;
-use common_meta_types::app_error::ShareHasNoGrantedDatabase;
-use common_meta_types::app_error::ShareHasNoGrantedPrivilege;
-use common_meta_types::app_error::TableAlreadyExists;
-use common_meta_types::app_error::TableVersionMismatched;
-use common_meta_types::app_error::TxnRetryMaxTimes;
-use common_meta_types::app_error::UndropDbHasNoHistory;
-use common_meta_types::app_error::UndropDbWithNoDropTime;
-use common_meta_types::app_error::UndropTableAlreadyExists;
-use common_meta_types::app_error::UndropTableHasNoHistory;
-use common_meta_types::app_error::UndropTableWithNoDropTime;
-use common_meta_types::app_error::UnknownShareAccounts;
-use common_meta_types::app_error::UnknownTable;
-use common_meta_types::app_error::UnknownTableId;
-use common_meta_types::app_error::WrongShare;
-use common_meta_types::app_error::WrongShareObject;
+use common_meta_types::errors::app_error::AppError;
+use common_meta_types::errors::app_error::CreateDatabaseWithDropTime;
+use common_meta_types::errors::app_error::CreateTableWithDropTime;
+use common_meta_types::errors::app_error::DatabaseAlreadyExists;
+use common_meta_types::errors::app_error::DropDbWithDropTime;
+use common_meta_types::errors::app_error::DropTableWithDropTime;
+use common_meta_types::errors::app_error::ShareHasNoGrantedDatabase;
+use common_meta_types::errors::app_error::ShareHasNoGrantedPrivilege;
+use common_meta_types::errors::app_error::TableAlreadyExists;
+use common_meta_types::errors::app_error::TableVersionMismatched;
+use common_meta_types::errors::app_error::TxnRetryMaxTimes;
+use common_meta_types::errors::app_error::UndropDbHasNoHistory;
+use common_meta_types::errors::app_error::UndropDbWithNoDropTime;
+use common_meta_types::errors::app_error::UndropTableAlreadyExists;
+use common_meta_types::errors::app_error::UndropTableHasNoHistory;
+use common_meta_types::errors::app_error::UndropTableWithNoDropTime;
+use common_meta_types::errors::app_error::UnknownShareAccounts;
+use common_meta_types::errors::app_error::UnknownTable;
+use common_meta_types::errors::app_error::UnknownTableId;
+use common_meta_types::errors::app_error::WrongShare;
+use common_meta_types::errors::app_error::WrongShareObject;
 use common_meta_types::ConditionResult;
 use common_meta_types::GCDroppedDataReply;
 use common_meta_types::GCDroppedDataReq;

src/meta/api/src/share_api_impl.rs

@@ -21,15 +21,15 @@ use common_meta_app::schema::TableIdToName;
 use common_meta_app::schema::TableMeta;
 use common_meta_app::schema::TableNameIdent;
 use common_meta_app::share::*;
-use common_meta_types::app_error::AppError;
-use common_meta_types::app_error::ShareAccountsAlreadyExists;
-use common_meta_types::app_error::ShareAlreadyExists;
-use common_meta_types::app_error::TxnRetryMaxTimes;
-use common_meta_types::app_error::UnknownShare;
-use common_meta_types::app_error::UnknownShareAccounts;
-use common_meta_types::app_error::UnknownTable;
-use common_meta_types::app_error::WrongShare;
-use common_meta_types::app_error::WrongShareObject;
+use common_meta_types::errors::app_error::AppError;
+use common_meta_types::errors::app_error::ShareAccountsAlreadyExists;
+use common_meta_types::errors::app_error::ShareAlreadyExists;
+use common_meta_types::errors::app_error::TxnRetryMaxTimes;
+use common_meta_types::errors::app_error::UnknownShare;
+use common_meta_types::errors::app_error::UnknownShareAccounts;
+use common_meta_types::errors::app_error::UnknownTable;
+use common_meta_types::errors::app_error::WrongShare;
+use common_meta_types::errors::app_error::WrongShareObject;
 use common_meta_types::ConditionResult::Eq;
 use common_meta_types::KVAppError;
 use common_meta_types::TxnCondition;

src/meta/api/src/util.rs

@@ -20,13 +20,13 @@ use common_meta_app::schema::DatabaseMeta;
 use common_meta_app::schema::DatabaseNameIdent;
 use common_meta_app::schema::TableNameIdent;
 use common_meta_app::share::*;
-use common_meta_types::app_error::AppError;
-use common_meta_types::app_error::ShareHasNoGrantedDatabase;
-use common_meta_types::app_error::UnknownDatabase;
-use common_meta_types::app_error::UnknownShare;
-use common_meta_types::app_error::UnknownShareAccounts;
-use common_meta_types::app_error::UnknownShareId;
-use common_meta_types::app_error::UnknownTable;
+use common_meta_types::errors::app_error::AppError;
+use common_meta_types::errors::app_error::ShareHasNoGrantedDatabase;
+use common_meta_types::errors::app_error::UnknownDatabase;
+use common_meta_types::errors::app_error::UnknownShare;
+use common_meta_types::errors::app_error::UnknownShareAccounts;
+use common_meta_types::errors::app_error::UnknownShareId;
+use common_meta_types::errors::app_error::UnknownTable;
 use common_meta_types::txn_condition::Target;
 use common_meta_types::txn_op::Request;
 use common_meta_types::ConditionResult;

src/meta/app/src/share/share.rs

@@ -20,8 +20,8 @@ use std::fmt::Formatter;
 
 use common_datavalues::chrono::DateTime;
 use common_datavalues::chrono::Utc;
-use common_meta_types::app_error::AppError;
-use common_meta_types::app_error::WrongShareObject;
+use common_meta_types::errors::app_error::AppError;
+use common_meta_types::errors::app_error::WrongShareObject;
 use common_meta_types::KVAppError;
 use enumflags2::bitflags;
 use enumflags2::BitFlags;

src/meta/types/src/app_error.rs renamed to src/meta/types/src/errors/app_error.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+use common_exception::ErrorCode;
 use serde::Deserialize;
 use serde::Serialize;
 use thiserror::Error;
@@ -39,3 +40,21 @@ pub enum MetaError {
 }
 
 pub type MetaResult<T> = Result<T, MetaError>;
+
+impl From<MetaError> for ErrorCode {
+    fn from(e: MetaError) -> Self {
+        match e {
+            MetaError::NetworkError(net_err) => net_err.into(),
+            MetaError::StorageError(sto_err) => sto_err.into(),
+            MetaError::ClientError(ce) => ce.into(),
+            MetaError::APIError(e) => e.into(),
+        }
+    }
+}
+
+impl From<tonic::Status> for MetaError {
+    fn from(status: tonic::Status) -> Self {
+        let net_err = MetaNetworkError::from(status);
+        MetaError::NetworkError(net_err)
+    }
+}