chore: refactor metadata key value trait (#4664)

GreptimeTeam · Sep 3, 2024 · 9b03940 · 9b03940
1 parent 8d6cd8a
commit 9b03940
Show file tree

Hide file tree

Showing 18 changed files with 94 additions and 96 deletions.
diff --git a/src/common/meta/src/cache_invalidator.rs b/src/common/meta/src/cache_invalidator.rs
@@ -24,7 +24,7 @@ use crate::key::table_info::TableInfoKey;
 use crate::key::table_name::TableNameKey;
 use crate::key::table_route::TableRouteKey;
 use crate::key::view_info::ViewInfoKey;
-use crate::key::MetaKey;
+use crate::key::MetadataKey;
 
 /// KvBackend cache invalidator
 #[async_trait::async_trait]

diff --git a/src/common/meta/src/error.rs b/src/common/meta/src/error.rs
@@ -392,8 +392,8 @@ pub enum Error {
         location: Location,
     },
 
-    #[snafu(display("Invalid table metadata, err: {}", err_msg))]
-    InvalidTableMetadata {
+    #[snafu(display("Invalid metadata, err: {}", err_msg))]
+    InvalidMetadata {
         err_msg: String,
         #[snafu(implicit)]
         location: Location,
@@ -702,7 +702,7 @@ impl ErrorExt for Error {
             | ParseOption { .. }
             | RouteInfoCorrupted { .. }
             | InvalidProtoMsg { .. }
-            | InvalidTableMetadata { .. }
+            | InvalidMetadata { .. }
             | MoveRegion { .. }
             | Unexpected { .. }
             | TableInfoNotFound { .. }

diff --git a/src/common/meta/src/key.rs b/src/common/meta/src/key.rs
@@ -211,7 +211,7 @@ lazy_static! {
 }
 
 /// The key of metadata.
-pub trait MetaKey<'a, T> {
+pub trait MetadataKey<'a, T> {
     fn to_bytes(&self) -> Vec<u8>;
 
     fn from_bytes(bytes: &'a [u8]) -> Result<T>;
@@ -226,7 +226,7 @@ impl From<Vec<u8>> for BytesAdapter {
     }
 }
 
-impl<'a> MetaKey<'a, BytesAdapter> for BytesAdapter {
+impl<'a> MetadataKey<'a, BytesAdapter> for BytesAdapter {
     fn to_bytes(&self) -> Vec<u8> {
         self.0.clone()
     }
@@ -236,7 +236,7 @@ impl<'a> MetaKey<'a, BytesAdapter> for BytesAdapter {
     }
 }
 
-pub(crate) trait TableMetaKeyGetTxnOp {
+pub(crate) trait MetadataKeyGetTxnOp {
     fn build_get_op(
         &self,
     ) -> (
@@ -245,7 +245,7 @@ pub(crate) trait TableMetaKeyGetTxnOp {
     );
 }
 
-pub trait TableMetaValue {
+pub trait MetadataValue {
     fn try_from_raw_value(raw_value: &[u8]) -> Result<Self>
     where
         Self: Sized;
@@ -330,7 +330,7 @@ impl<T: DeserializeOwned + Serialize> Serialize for DeserializedValueWithBytes<T
     }
 }
 
-impl<'de, T: DeserializeOwned + Serialize + TableMetaValue> Deserialize<'de>
+impl<'de, T: DeserializeOwned + Serialize + MetadataValue> Deserialize<'de>
     for DeserializedValueWithBytes<T>
 {
     /// - Deserialize behaviors:
@@ -359,7 +359,7 @@ impl<T: Serialize + DeserializeOwned + Clone> Clone for DeserializedValueWithByt
     }
 }
 
-impl<T: Serialize + DeserializeOwned + TableMetaValue> DeserializedValueWithBytes<T> {
+impl<T: Serialize + DeserializeOwned + MetadataValue> DeserializedValueWithBytes<T> {
     /// Returns a struct containing a deserialized value and an original `bytes`.
     /// It accepts original bytes of inner.
     pub fn from_inner_bytes(bytes: Bytes) -> Result<Self> {
@@ -1156,10 +1156,10 @@ impl TableMetadataManager {
 }
 
 #[macro_export]
-macro_rules! impl_table_meta_value {
+macro_rules! impl_metadata_value {
     ($($val_ty: ty), *) => {
         $(
-            impl $crate::key::TableMetaValue for $val_ty {
+            impl $crate::key::MetadataValue for $val_ty {
                 fn try_from_raw_value(raw_value: &[u8]) -> Result<Self> {
                     serde_json::from_slice(raw_value).context(SerdeJsonSnafu)
                 }
@@ -1172,10 +1172,10 @@ macro_rules! impl_table_meta_value {
     }
 }
 
-macro_rules! impl_meta_key_get_txn_op {
+macro_rules! impl_metadata_key_get_txn_op {
     ($($key: ty), *) => {
         $(
-            impl $crate::key::TableMetaKeyGetTxnOp for $key {
+            impl $crate::key::MetadataKeyGetTxnOp for $key {
                 /// Returns a [TxnOp] to retrieve the corresponding value
                 /// and a filter to retrieve the value from the [TxnOpGetResponseSet]
                 fn build_get_op(
@@ -1197,7 +1197,7 @@ macro_rules! impl_meta_key_get_txn_op {
     }
 }
 
-impl_meta_key_get_txn_op! {
+impl_metadata_key_get_txn_op! {
     TableNameKey<'_>,
     TableInfoKey,
     ViewInfoKey,
@@ -1206,7 +1206,7 @@ impl_meta_key_get_txn_op! {
 }
 
 #[macro_export]
-macro_rules! impl_optional_meta_value {
+macro_rules! impl_optional_metadata_value {
     ($($val_ty: ty), *) => {
         $(
             impl $val_ty {
@@ -1222,7 +1222,7 @@ macro_rules! impl_optional_meta_value {
     }
 }
 
-impl_table_meta_value! {
+impl_metadata_value! {
     TableNameValue,
     TableInfoValue,
     ViewInfoValue,
@@ -1233,7 +1233,7 @@ impl_table_meta_value! {
     TableFlowValue
 }
 
-impl_optional_meta_value! {
+impl_optional_metadata_value! {
     CatalogNameValue,
     SchemaNameValue
 }

diff --git a/src/common/meta/src/key/catalog_name.rs b/src/common/meta/src/key/catalog_name.rs
@@ -20,8 +20,8 @@ use futures::stream::BoxStream;
 use serde::{Deserialize, Serialize};
 use snafu::{OptionExt, ResultExt};
 
-use crate::error::{self, Error, InvalidTableMetadataSnafu, Result};
-use crate::key::{MetaKey, CATALOG_NAME_KEY_PATTERN, CATALOG_NAME_KEY_PREFIX};
+use crate::error::{self, Error, InvalidMetadataSnafu, Result};
+use crate::key::{MetadataKey, CATALOG_NAME_KEY_PATTERN, CATALOG_NAME_KEY_PREFIX};
 use crate::kv_backend::KvBackendRef;
 use crate::range_stream::{PaginationStream, DEFAULT_PAGE_SIZE};
 use crate::rpc::store::RangeRequest;
@@ -56,14 +56,14 @@ impl<'a> CatalogNameKey<'a> {
     }
 }
 
-impl<'a> MetaKey<'a, CatalogNameKey<'a>> for CatalogNameKey<'_> {
+impl<'a> MetadataKey<'a, CatalogNameKey<'a>> for CatalogNameKey<'_> {
     fn to_bytes(&self) -> Vec<u8> {
         self.to_string().into_bytes()
     }
 
     fn from_bytes(bytes: &'a [u8]) -> Result<CatalogNameKey<'a>> {
         let key = std::str::from_utf8(bytes).map_err(|e| {
-            InvalidTableMetadataSnafu {
+            InvalidMetadataSnafu {
                 err_msg: format!(
                     "CatalogNameKey '{}' is not a valid UTF8 string: {e}",
                     String::from_utf8_lossy(bytes)
@@ -87,7 +87,7 @@ impl<'a> TryFrom<&'a str> for CatalogNameKey<'a> {
     fn try_from(s: &'a str) -> Result<Self> {
         let captures = CATALOG_NAME_KEY_PATTERN
             .captures(s)
-            .context(InvalidTableMetadataSnafu {
+            .context(InvalidMetadataSnafu {
                 err_msg: format!("Illegal CatalogNameKey format: '{s}'"),
             })?;
 

diff --git a/src/common/meta/src/key/datanode_table.rs b/src/common/meta/src/key/datanode_table.rs
@@ -22,10 +22,10 @@ use snafu::OptionExt;
 use store_api::storage::RegionNumber;
 use table::metadata::TableId;
 
-use super::MetaKey;
-use crate::error::{InvalidTableMetadataSnafu, Result};
+use super::MetadataKey;
+use crate::error::{InvalidMetadataSnafu, Result};
 use crate::key::{
-    RegionDistribution, TableMetaValue, DATANODE_TABLE_KEY_PATTERN, DATANODE_TABLE_KEY_PREFIX,
+    MetadataValue, RegionDistribution, DATANODE_TABLE_KEY_PATTERN, DATANODE_TABLE_KEY_PREFIX,
 };
 use crate::kv_backend::txn::{Txn, TxnOp};
 use crate::kv_backend::KvBackendRef;
@@ -77,27 +77,26 @@ impl DatanodeTableKey {
     }
 }
 
-impl<'a> MetaKey<'a, DatanodeTableKey> for DatanodeTableKey {
+impl<'a> MetadataKey<'a, DatanodeTableKey> for DatanodeTableKey {
     fn to_bytes(&self) -> Vec<u8> {
         self.to_string().into_bytes()
     }
 
     fn from_bytes(bytes: &[u8]) -> Result<DatanodeTableKey> {
         let key = std::str::from_utf8(bytes).map_err(|e| {
-            InvalidTableMetadataSnafu {
+            InvalidMetadataSnafu {
                 err_msg: format!(
                     "DatanodeTableKey '{}' is not a valid UTF8 string: {e}",
                     String::from_utf8_lossy(bytes)
                 ),
             }
             .build()
         })?;
-        let captures =
-            DATANODE_TABLE_KEY_PATTERN
-                .captures(key)
-                .context(InvalidTableMetadataSnafu {
-                    err_msg: format!("Invalid DatanodeTableKey '{key}'"),
-                })?;
+        let captures = DATANODE_TABLE_KEY_PATTERN
+            .captures(key)
+            .context(InvalidMetadataSnafu {
+                err_msg: format!("Invalid DatanodeTableKey '{key}'"),
+            })?;
         // Safety: pass the regex check above
         let datanode_id = captures[1].parse::<DatanodeId>().unwrap();
         let table_id = captures[2].parse::<TableId>().unwrap();

diff --git a/src/common/meta/src/key/flow.rs b/src/common/meta/src/key/flow.rs
@@ -38,7 +38,7 @@ use crate::key::flow::flow_name::FlowNameManager;
 use crate::key::flow::flownode_flow::FlownodeFlowManager;
 pub use crate::key::flow::table_flow::{TableFlowManager, TableFlowManagerRef};
 use crate::key::txn_helper::TxnOpGetResponseSet;
-use crate::key::{FlowId, MetaKey};
+use crate::key::{FlowId, MetadataKey};
 use crate::kv_backend::txn::Txn;
 use crate::kv_backend::KvBackendRef;
 use crate::rpc::store::BatchDeleteRequest;
@@ -66,7 +66,7 @@ impl<T> FlowScoped<T> {
     }
 }
 
-impl<'a, T: MetaKey<'a, T>> MetaKey<'a, FlowScoped<T>> for FlowScoped<T> {
+impl<'a, T: MetadataKey<'a, T>> MetadataKey<'a, FlowScoped<T>> for FlowScoped<T> {
     fn to_bytes(&self) -> Vec<u8> {
         let prefix = FlowScoped::<T>::PREFIX.as_bytes();
         let inner = self.inner.to_bytes();
@@ -295,7 +295,7 @@ mod tests {
         inner: Vec<u8>,
     }
 
-    impl<'a> MetaKey<'a, MockKey> for MockKey {
+    impl<'a> MetadataKey<'a, MockKey> for MockKey {
         fn to_bytes(&self) -> Vec<u8> {
             self.inner.clone()
         }

diff --git a/src/common/meta/src/key/flow/flow_info.rs b/src/common/meta/src/key/flow/flow_info.rs
@@ -25,7 +25,7 @@ use table::table_name::TableName;
 use crate::error::{self, Result};
 use crate::key::flow::FlowScoped;
 use crate::key::txn_helper::TxnOpGetResponseSet;
-use crate::key::{DeserializedValueWithBytes, FlowId, FlowPartitionId, MetaKey, TableMetaValue};
+use crate::key::{DeserializedValueWithBytes, FlowId, FlowPartitionId, MetadataKey, MetadataValue};
 use crate::kv_backend::txn::Txn;
 use crate::kv_backend::KvBackendRef;
 use crate::FlownodeId;
@@ -42,7 +42,7 @@ lazy_static! {
 /// The layout: `__flow/info/{flow_id}`.
 pub struct FlowInfoKey(FlowScoped<FlowInfoKeyInner>);
 
-impl<'a> MetaKey<'a, FlowInfoKey> for FlowInfoKey {
+impl<'a> MetadataKey<'a, FlowInfoKey> for FlowInfoKey {
     fn to_bytes(&self) -> Vec<u8> {
         self.0.to_bytes()
     }
@@ -80,14 +80,14 @@ impl FlowInfoKeyInner {
     }
 }
 
-impl<'a> MetaKey<'a, FlowInfoKeyInner> for FlowInfoKeyInner {
+impl<'a> MetadataKey<'a, FlowInfoKeyInner> for FlowInfoKeyInner {
     fn to_bytes(&self) -> Vec<u8> {
         format!("{FLOW_INFO_KEY_PREFIX}/{}", self.flow_id).into_bytes()
     }
 
     fn from_bytes(bytes: &'a [u8]) -> Result<FlowInfoKeyInner> {
         let key = std::str::from_utf8(bytes).map_err(|e| {
-            error::InvalidTableMetadataSnafu {
+            error::InvalidMetadataSnafu {
                 err_msg: format!(
                     "FlowInfoKeyInner '{}' is not a valid UTF8 string: {e}",
                     String::from_utf8_lossy(bytes)
@@ -98,7 +98,7 @@ impl<'a> MetaKey<'a, FlowInfoKeyInner> for FlowInfoKeyInner {
         let captures =
             FLOW_INFO_KEY_PATTERN
                 .captures(key)
-                .context(error::InvalidTableMetadataSnafu {
+                .context(error::InvalidMetadataSnafu {
                     err_msg: format!("Invalid FlowInfoKeyInner '{key}'"),
                 })?;
         // Safety: pass the regex check above

diff --git a/src/common/meta/src/key/flow/flow_name.rs b/src/common/meta/src/key/flow/flow_name.rs
@@ -24,7 +24,7 @@ use crate::error::{self, Result};
 use crate::key::flow::FlowScoped;
 use crate::key::txn_helper::TxnOpGetResponseSet;
 use crate::key::{
-    BytesAdapter, DeserializedValueWithBytes, FlowId, MetaKey, TableMetaValue, NAME_PATTERN,
+    BytesAdapter, DeserializedValueWithBytes, FlowId, MetadataKey, MetadataValue, NAME_PATTERN,
 };
 use crate::kv_backend::txn::Txn;
 use crate::kv_backend::KvBackendRef;
@@ -76,7 +76,7 @@ impl<'a> FlowNameKey<'a> {
     }
 }
 
-impl<'a> MetaKey<'a, FlowNameKey<'a>> for FlowNameKey<'a> {
+impl<'a> MetadataKey<'a, FlowNameKey<'a>> for FlowNameKey<'a> {
     fn to_bytes(&self) -> Vec<u8> {
         self.0.to_bytes()
     }
@@ -95,7 +95,7 @@ pub struct FlowNameKeyInner<'a> {
     pub flow_name: &'a str,
 }
 
-impl<'a> MetaKey<'a, FlowNameKeyInner<'a>> for FlowNameKeyInner<'_> {
+impl<'a> MetadataKey<'a, FlowNameKeyInner<'a>> for FlowNameKeyInner<'_> {
     fn to_bytes(&self) -> Vec<u8> {
         format!(
             "{FLOW_NAME_KEY_PREFIX}/{}/{}",
@@ -106,7 +106,7 @@ impl<'a> MetaKey<'a, FlowNameKeyInner<'a>> for FlowNameKeyInner<'_> {
 
     fn from_bytes(bytes: &'a [u8]) -> Result<FlowNameKeyInner> {
         let key = std::str::from_utf8(bytes).map_err(|e| {
-            error::InvalidTableMetadataSnafu {
+            error::InvalidMetadataSnafu {
                 err_msg: format!(
                     "FlowNameKeyInner '{}' is not a valid UTF8 string: {e}",
                     String::from_utf8_lossy(bytes)
@@ -117,7 +117,7 @@ impl<'a> MetaKey<'a, FlowNameKeyInner<'a>> for FlowNameKeyInner<'_> {
         let captures =
             FLOW_NAME_KEY_PATTERN
                 .captures(key)
-                .context(error::InvalidTableMetadataSnafu {
+                .context(error::InvalidMetadataSnafu {
                     err_msg: format!("Invalid FlowNameKeyInner '{key}'"),
                 })?;
         // Safety: pass the regex check above