feat(remote-wal): introduce TopicRegionManager #5407

CookiePieWw · 2025-01-20T07:14:55Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

Waiting for #5351...

What's changed and what's your intention?

As title. Maps topic to region in kvbackend.

PR Checklist

Please convert it to a draft if some of the following conditions are not met.

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.
API changes are backward compatible.
Schema or data changes are backward compatible.

coderabbitai · 2025-01-20T07:15:02Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

src/common/meta/src/key.rs

WenyXu · 2025-01-21T03:17:01Z

src/common/meta/src/key.rs

+//! 13. Topic name to region map key `__topic_region/{topic_name}/{region_id}`
+//!     - The key is used to map a pair of topic name and region id.


Suggested change

//! 13. Topic name to region map key `__topic_region/{topic_name}/{region_id}`

//! - The key is used to map a pair of topic name and region id.

//! 13. Topic name to region key `__topic_region/{topic_name}/{region_id}`

//! - Mapping {topic_name} to {region_id}

WenyXu · 2025-01-21T03:17:13Z

src/common/meta/src/key.rs

@@ -105,6 +108,7 @@ pub mod table_route;
 pub mod test_utils;
 mod tombstone;
 pub mod topic_name;
+pub mod topic_region_map;


Suggested change

pub mod topic_region_map;

pub mod topic_region;

WenyXu · 2025-01-21T03:17:22Z

src/common/meta/src/key/topic_region_map.rs

+pub struct TopicRegionMapKey<'a> {
+    pub region_id: RegionId,
+    pub topic: &'a str,
+}


Suggested change

pub struct TopicRegionMapKey<'a> {

pub region_id: RegionId,

pub topic: &'a str,

}

pub struct TopicRegionKey<'a> {

pub region_id: RegionId,

pub topic: &'a str,

}

WenyXu · 2025-01-21T03:17:45Z

src/common/meta/src/key/topic_region_map.rs

+    }
+}
+
+impl TopicRegionMapManager {


Suggested change

impl TopicRegionMapManager {

impl TopicRegionManager {

WenyXu · 2025-01-21T03:17:57Z

src/common/meta/src/key/topic_region_map.rs

+impl Default for TopicRegionMapManager {
+    fn default() -> Self {
+        Self::new(Arc::new(MemoryKvBackend::default()))
+    }
+}


Suggested change

impl Default for TopicRegionMapManager {

fn default() -> Self {

Self::new(Arc::new(MemoryKvBackend::default()))

}

}

#[cfg(test)]

impl Default for TopicRegionMapManager {

fn default() -> Self {

Self::new(Arc::new(MemoryKvBackend::default()))

}

}

WenyXu · 2025-01-21T03:19:01Z

src/common/meta/src/wal_options_allocator/topic_manager.rs

+    pub async fn _put_topic_region_map(&self, topic: &str, region_id: RegionId) -> Result<()> {
+        let key = TopicRegionMapKey::new(region_id, topic);
+        self._topic_region_map_manager.put(key).await?;
+        Ok(())
+    }
+
+    /// Stores multiple topic-region mappings in the key-value backend.
+    pub async fn _batch_put_topic_region_map(
+        &self,
+        topic: &str,
+        region_ids: &[RegionId],
+    ) -> Result<()> {
+        let keys = region_ids
+            .iter()
+            .map(|region_id| TopicRegionMapKey::new(*region_id, topic))
+            .collect();
+        self._topic_region_map_manager.batch_put(keys).await?;
+        Ok(())
+    }


Introduce these methods in future PRs

WenyXu · 2025-01-21T03:19:24Z

src/common/meta/src/key/topic_region_map.rs

+impl<'a> TopicRegionMapKey<'a> {
+    pub fn new(region_id: RegionId, topic: &'a str) -> Self {
+        Self { region_id, topic }
+    }
+
+    pub fn range_start_key() -> String {
+        TOPIC_REGION_MAP_PREFIX.to_string()
+    }
+}


Suggested change

impl<'a> TopicRegionMapKey<'a> {

pub fn new(region_id: RegionId, topic: &'a str) -> Self {

Self { region_id, topic }

}

pub fn range_start_key() -> String {

TOPIC_REGION_MAP_PREFIX.to_string()

}

}

impl<'a> TopicRegionKey<'a> {

pub fn new(region_id: RegionId, topic: &'a str) -> Self {

Self { region_id, topic }

}

pub fn range_start_key() -> String {

TOPIC_REGION_MAP_PREFIX.to_string()

}

}

WenyXu · 2025-01-21T03:23:35Z

src/common/meta/src/key.rs

@@ -236,6 +241,13 @@ lazy_static! {
        Regex::new(&format!("^{KAFKA_TOPIC_KEY_PREFIX}/(.*)$")).unwrap();
 }

+lazy_static! {
+    pub static ref TOPIC_REGION_MAP_PATTERN: Regex = Regex::new(&format!(


Suggested change

pub static ref TOPIC_REGION_MAP_PATTERN: Regex = Regex::new(&format!(

pub static ref TOPIC_REGION_PATTERN: Regex = Regex::new(&format!(

WenyXu · 2025-01-21T03:23:49Z

src/common/meta/src/key/topic_region_map.rs

+        let topic = captures
+            .get(1)
+            .map(|m| m.as_str())
+            .context(InvalidMetadataSnafu {
+                err_msg: format!("Invalid topic in region topic map key: {}", value),
+            })?;


It's fine to retrieve the value directly since it has already passed the regex check.

Suggested change

let topic = captures

.get(1)

.map(|m| m.as_str())

.context(InvalidMetadataSnafu {

err_msg: format!("Invalid topic in region topic map key: {}", value),

})?;

let topic = captures[1].as_str();

WenyXu · 2025-01-21T03:28:17Z

src/common/meta/src/key/topic_region_map.rs

+    /// Returns all topic-region mappings to avoid parsing again.
+    pub async fn range(&self) -> Result<Vec<(RegionId, String)>> {
+        let prefix = TopicRegionMapKey::range_start_key();
+        let range_req = RangeRequest::new().with_prefix(prefix.as_bytes());
+        let resp = self.kv_backend.range(range_req).await?;
+        resp.kvs
+            .iter()
+            .map(|kv| {
+                let key = topic_region_map_decoder(kv)?;
+                Ok((key.region_id, key.topic.to_string()))
+            })
+            .collect::<Result<Vec<_>>>()
+    }


let's implement it when we need it

WenyXu · 2025-01-21T03:30:53Z

src/common/meta/src/key.rs

@@ -236,6 +241,13 @@ lazy_static! {
        Regex::new(&format!("^{KAFKA_TOPIC_KEY_PREFIX}/(.*)$")).unwrap();
 }

+lazy_static! {
+    pub static ref TOPIC_REGION_MAP_PATTERN: Regex = Regex::new(&format!(
+        "^{TOPIC_REGION_MAP_PREFIX}/({NAME_PATTERN})/([0-9]+)$"


Validate user configured topic_prefix when the node starts

github-actions bot added the docs-not-required This change does not impact docs. label Jan 20, 2025

feat: add manager to map region to topic

d69c025

CookiePieWw force-pushed the region-topic-map branch from fad133c to d69c025 Compare January 20, 2025 08:18

CookiePieWw marked this pull request as ready for review January 20, 2025 08:24

CookiePieWw requested review from v0y4g3r and MichaelScofield as code owners January 20, 2025 08:24

CookiePieWw requested review from WenyXu and removed request for MichaelScofield and v0y4g3r January 20, 2025 08:24

chore: add a delete

51ee453

CookiePieWw commented Jan 20, 2025

View reviewed changes

src/common/meta/src/key.rs Outdated Show resolved Hide resolved

src/common/meta/src/key.rs Outdated Show resolved Hide resolved

CookiePieWw and others added 2 commits January 20, 2025 17:46

chore: rename keys

6d255c5

chore: update config file

041026f

CookiePieWw requested a review from a team as a code owner January 20, 2025 10:02

CookiePieWw added 3 commits January 20, 2025 18:48

fix: fix unit test

3bb903d

chore: change prefix

79561b0

chore: clean up

26cdfce

WenyXu reviewed Jan 21, 2025

View reviewed changes

WenyXu changed the title ~~feat(wal purge): introduce TopicRegionMapManager~~ feat(remote-wal): introduce TopicRegionManager Jan 21, 2025

CookiePieWw added 2 commits January 21, 2025 12:14

chore: follow review comments

dd6641a

chore: follow review comments

e503c7c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(remote-wal): introduce TopicRegionManager #5407

feat(remote-wal): introduce TopicRegionManager #5407

CookiePieWw commented Jan 20, 2025

coderabbitai bot commented Jan 20, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

WenyXu Jan 21, 2025

		//! 13. Topic name to region map key `__topic_region/{topic_name}/{region_id}`
		//! - The key is used to map a pair of topic name and region id.

	pub static ref TOPIC_REGION_MAP_PATTERN: Regex = Regex::new(&format!(
	pub static ref TOPIC_REGION_PATTERN: Regex = Regex::new(&format!(

feat(remote-wal): introduce TopicRegionManager #5407

Are you sure you want to change the base?

feat(remote-wal): introduce TopicRegionManager #5407

Conversation

CookiePieWw commented Jan 20, 2025

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

PR Checklist

coderabbitai bot commented Jan 20, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment