Merge pull request #7678 from drmingdrmer/7-forward-err

refactor(meta): remove MetaError::Fatal.

Author: drmingdrmer

src/meta/api/src/lib.rs

@@ -20,7 +20,6 @@ mod id_generator;
 mod kv_api;
 mod kv_api_key;
 mod kv_api_test_suite;
-mod kv_api_utils;
 mod schema_api;
 mod schema_api_impl;
 mod schema_api_keys;
@@ -29,6 +28,8 @@ mod share_api;
 mod share_api_impl;
 mod share_api_keys;
 mod share_api_test_suite;
+pub(crate) mod testing;
+pub(crate) mod util;
 
 pub use id::Id;
 pub(crate) use id_generator::IdGenerator;
@@ -40,34 +41,32 @@ pub use kv_api::KVApi;
 pub use kv_api_key::KVApiKey;
 pub use kv_api_key::KVApiKeyError;
 pub use kv_api_test_suite::KVApiTestSuite;
-pub use kv_api_utils::db_has_to_exist;
-pub use kv_api_utils::deserialize_struct;
-pub use kv_api_utils::deserialize_u64;
-pub use kv_api_utils::fetch_id;
-pub use kv_api_utils::get_kv_data;
-pub use kv_api_utils::get_object_shared_by_share_ids;
-pub use kv_api_utils::get_share_account_meta_or_err;
-pub use kv_api_utils::get_share_database_id_and_privilege;
-pub use kv_api_utils::get_share_id_to_name_or_err;
-pub use kv_api_utils::get_share_meta_by_id_or_err;
-pub use kv_api_utils::get_share_or_err;
-pub use kv_api_utils::get_struct_value;
-pub use kv_api_utils::get_u64_value;
-pub use kv_api_utils::is_all_db_data_removed;
-pub use kv_api_utils::is_db_need_to_be_remove;
-pub use kv_api_utils::list_keys;
-pub use kv_api_utils::list_u64_value;
-pub use kv_api_utils::send_txn;
-pub use kv_api_utils::serialize_struct;
-pub use kv_api_utils::serialize_u64;
-pub use kv_api_utils::table_has_to_exist;
-pub use kv_api_utils::txn_cond_seq;
-pub use kv_api_utils::txn_op_del;
-pub use kv_api_utils::txn_op_put;
-pub use kv_api_utils::txn_op_put_with_expire;
-pub use kv_api_utils::TXN_MAX_RETRY_TIMES;
 pub use schema_api::SchemaApi;
 pub(crate) use schema_api_impl::get_db_or_err;
 pub use schema_api_test_suite::SchemaApiTestSuite;
 pub use share_api::ShareApi;
 pub use share_api_test_suite::ShareApiTestSuite;
+pub use util::db_has_to_exist;
+pub use util::deserialize_struct;
+pub use util::fetch_id;
+pub use util::get_object_shared_by_share_ids;
+pub use util::get_share_account_meta_or_err;
+pub use util::get_share_database_id_and_privilege;
+pub use util::get_share_id_to_name_or_err;
+pub use util::get_share_meta_by_id_or_err;
+pub use util::get_share_or_err;
+pub use util::get_struct_value;
+pub use util::get_u64_value;
+pub use util::is_all_db_data_removed;
+pub use util::is_db_need_to_be_remove;
+pub use util::list_keys;
+pub use util::list_u64_value;
+pub use util::send_txn;
+pub use util::serialize_struct;
+pub use util::serialize_u64;
+pub use util::table_has_to_exist;
+pub use util::txn_cond_seq;
+pub use util::txn_op_del;
+pub use util::txn_op_put;
+pub use util::txn_op_put_with_expire;
+pub use util::TXN_MAX_RETRY_TIMES;

src/meta/api/src/schema_api_test_suite.rs

@@ -74,9 +74,9 @@ use common_meta_types::UpsertKVReq;
 use tracing::debug;
 use tracing::info;
 
-use crate::get_kv_data;
 use crate::is_all_db_data_removed;
 use crate::serialize_struct;
+use crate::testing::get_kv_data;
 use crate::ApiBuilder;
 use crate::AsKVApi;
 use crate::KVApi;

src/meta/api/src/share_api_test_suite.rs

@@ -25,13 +25,13 @@ use common_meta_types::MetaError;
 use enumflags2::BitFlags;
 use tracing::info;
 
-use crate::get_kv_data;
 use crate::get_object_shared_by_share_ids;
 use crate::get_share_account_meta_or_err;
 use crate::get_share_id_to_name_or_err;
 use crate::get_share_meta_by_id_or_err;
 use crate::get_share_or_err;
 use crate::is_all_db_data_removed;
+use crate::testing::get_kv_data;
 use crate::ApiBuilder;
 use crate::AsKVApi;
 use crate::KVApi;

src/meta/api/src/testing.rs

@@ -0,0 +1,49 @@
+//  Copyright 2022 Datafuse Labs.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+//! Supporting utilities for tests.
+
+use common_meta_types::anyerror::AnyError;
+use common_meta_types::MetaAPIError;
+use common_meta_types::MetaDataError;
+use common_meta_types::MetaDataReadError;
+use common_meta_types::MetaError;
+use common_proto_conv::FromToProto;
+
+use crate::KVApi;
+use crate::KVApiKey;
+
+/// Get existing value by key. Panic if key is absent.
+pub(crate) async fn get_kv_data<T>(
+    kv_api: &(impl KVApi + ?Sized),
+    key: &impl KVApiKey,
+) -> Result<T, MetaError>
+where
+    T: FromToProto,
+    T::PB: common_protos::prost::Message + Default,
+{
+    let res = kv_api.get_kv(&key.to_key()).await?;
+    if let Some(res) = res {
+        let s = crate::deserialize_struct(&res.data)?;
+        return Ok(s);
+    };
+
+    Err(MetaError::APIError(MetaAPIError::DataError(
+        MetaDataError::ReadError(MetaDataReadError::new(
+            "get_kv_data",
+            "not found",
+            &AnyError::error(""),
+        )),
+    )))
+}

src/meta/api/src/kv_api_utils.rs renamed to src/meta/api/src/util.rs

@@ -20,7 +20,6 @@ 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::anyerror::AnyError;
 use common_meta_types::app_error::AppError;
 use common_meta_types::app_error::ShareHasNoGrantedDatabase;
 use common_meta_types::app_error::UnknownDatabase;
@@ -525,28 +524,6 @@ where
     Ok((false, None))
 }
 
-/// Get existing value by key. Panic if key is absent.
-/// This function is only used for testing.
-pub async fn get_kv_data<T>(
-    kv_api: &(impl KVApi + ?Sized),
-    key: &impl KVApiKey,
-) -> Result<T, MetaError>
-where
-    T: FromToProto,
-    T::PB: common_protos::prost::Message + Default,
-{
-    let res = kv_api.get_kv(&key.to_key()).await?;
-    if let Some(res) = res {
-        let s = deserialize_struct(&res.data)?;
-        return Ok(s);
-    };
-
-    Err(MetaError::Fatal(AnyError::error(format!(
-        "failed to get {}",
-        key.to_key()
-    ))))
-}
-
 pub async fn get_object_shared_by_share_ids(
     kv_api: &(impl KVApi + ?Sized),
     object: &ShareGrantObject,

src/meta/client/src/grpc_client.rs

@@ -171,9 +171,10 @@ impl ClientHandle {
         label_increment_gauge_with_val_and_labels(META_GRPC_CLIENT_REQUEST_INFLIGHT, vec![], 1.0);
 
         let res = self.req_tx.send(req).await.map_err(|e| {
-            MetaError::Fatal(
+            let cli_err = MetaClientError::ClientRuntimeError(
                 AnyError::new(&e).add_context(|| "when sending req to MetaGrpcClient worker"),
-            )
+            );
+            MetaError::ClientError(cli_err)
         });
 
         if let Err(err) = res {
@@ -193,9 +194,10 @@ impl ClientHandle {
                 1.0,
             );
 
-            MetaError::Fatal(
+            let cli_err = MetaClientError::ClientRuntimeError(
                 AnyError::new(&e).add_context(|| "when recv resp from MetaGrpcClient worker"),
-            )
+            );
+            MetaError::ClientError(cli_err)
         })?;
 
         label_decrement_gauge_with_val_and_labels(META_GRPC_CLIENT_REQUEST_INFLIGHT, vec![], 1.0);

src/meta/service/src/meta_service/raftmeta.rs

@@ -58,7 +58,6 @@ use common_meta_types::MetaStartupError;
 use common_meta_types::MetaStorageError;
 use common_meta_types::Node;
 use common_meta_types::NodeId;
-use common_meta_types::ToMetaError;
 use openraft::Config;
 use openraft::LogId;
 use openraft::Raft;
@@ -132,7 +131,7 @@ pub struct MetaNode {
     pub raft: MetaRaft,
     pub running_tx: watch::Sender<()>,
     pub running_rx: watch::Receiver<()>,
-    pub join_handles: Mutex<Vec<JoinHandle<MetaResult<()>>>>,
+    pub join_handles: Mutex<Vec<JoinHandle<Result<(), AnyError>>>>,
     pub joined_tasks: AtomicI32,
 }
 
@@ -322,12 +321,11 @@ impl MetaNode {
                 );
             })
             .await
-            .map_error_to_meta_error(
-                |s| MetaError::Fatal(AnyError::error(s)),
-                || "fail to serve",
-            )?;
+            .map_err(|e| {
+                AnyError::new(&e).add_context(|| "when serving meta-service grpc service")
+            })?;
 
-            Ok::<(), MetaError>(())
+            Ok::<(), AnyError>(())
         });
 
         let mut jh = mn.join_handles.lock().await;
@@ -484,12 +482,17 @@ impl MetaNode {
                 set_meta_metrics_current_term(mm.current_term);
                 set_meta_metrics_last_log_index(mm.last_log_index.unwrap_or_default());
                 set_meta_metrics_proposals_applied(mm.last_applied.unwrap_or_default().index);
-                set_meta_metrics_last_seq(meta_node.get_last_seq().await?);
+                set_meta_metrics_last_seq(
+                    meta_node
+                        .get_last_seq()
+                        .await
+                        .map_err(|e| AnyError::new(&e))?,
+                );
 
                 last_leader = mm.current_leader;
             }
 
-            Ok::<(), MetaError>(())
+            Ok::<(), AnyError>(())
         };
 
         let span = tracing::span!(tracing::Level::INFO, "watch-metrics");

src/meta/types/src/meta_errors.rs

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use anyerror::AnyError;
 use serde::Deserialize;
 use serde::Serialize;
 use thiserror::Error;
@@ -40,11 +39,6 @@ pub enum MetaError {
 
     #[error(transparent)]
     AppError(#[from] AppError),
-
-    /// Any other unclassified error.
-    /// Other crate may return general error such as ErrorCode or anyhow::Error, which can not be classified by type.
-    #[error(transparent)]
-    Fatal(AnyError),
 }
 
 pub type MetaResult<T> = Result<T, MetaError>;

src/meta/types/src/meta_errors_into.rs

@@ -32,9 +32,6 @@ impl From<MetaError> for ErrorCode {
             MetaError::StorageError(sto_err) => {
                 ErrorCode::MetaServiceError(sto_err.to_string()).set_backtrace(sto_err.backtrace())
             }
-            MetaError::Fatal(ae) => {
-                ErrorCode::MetaServiceError(ae.to_string()).set_backtrace(ae.backtrace())
-            }
             MetaError::ClientError(ce) => ce.into(),
             MetaError::APIError(e) => e.into(),
         }