feat(puffin): complete dir support

zhongzc commented 3 days ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

close #4193

What's changed and what's your intention?

as @coderabbitai

Checklist

[x] I have written the necessary rustdoc comments.
[x] I have added the necessary unit tests and integration tests.
[ ] This PR requires documentation updates.

Summary by CodeRabbit

New Features
- Introduced CachedPuffinManager for managing cached readers and writers.
- Added FsPuffinManager for handling puffin data in the filesystem.
- Introduced test functionalities for CachedPuffinManager with various compression codecs.
Bug Fixes
- Updated comments for better clarity in reader functions.
Refactor
- Renamed CachedPuffinReader to FsPuffinReader.
- Renamed CachedPuffinWriter to FsPuffinWriter.
- Improved compression handling logic.
Documentation
- Enhanced comments for public methods to improve understanding.
Chores
- Removed unused DELETE_QUEUE_SIZE constant.

coderabbitai[bot] commented 3 days ago

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

The changes to the Puffin repository revolve around enhancing the PuffinManager by introducing directory support and data compression mechanisms. This includes updating reader and writer structures, implementing a cache manager, and adding comprehensive test cases. These modifications ensure efficient file handling, caching, and compression capabilities within the Puffin system.

Changes

File(s)	Change Summary
`src/puffin/src/file_format/reader.rs`, `.../fs_puffin_manager/reader.rs`, `.../fs_puffin_manager/writer.rs`	Updated comments for clarity, added data compression comment, and renamed structs/functions to establish uniform naming.
`.../puffin_manager/cached_puffin_manager/cached_puffin_manager.rs`, `.../cache_manager/moka_cache_manager.rs`	Introduced `CachedPuffinManager`, removed `DELETE_QUEUE_SIZE` constant, implemented new struct methods and trait extensions.
`src/puffin/src/puffin_manager/tests.rs`	Added new test functions for `CachedPuffinManager` covering directory and file operations with various compression codecs.
`src/puffin/src/puffin_manager.rs`	Introduced new test module and updated `BlobGuard` trait to include the `Unpin` requirement for `Reader`.
`src/puffin/src/puffin_manager/fs_puffin_manager.rs`	Introduced `FsPuffinManager`, providing filesystem-oriented puffin data management with reading and writing functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CachedPuffinManager
    participant Cache
    participant FsPuffinWriter
    participant FsPuffinReader

    User->>CachedPuffinManager: Put directory
    CachedPuffinManager->>FsPuffinWriter: Write data with compression
    FsPuffinWriter->>Cache: Store compressed data
    User->>CachedPuffinManager: Get directory
    CachedPuffinManager->>Cache: Retrieve data
    Cache->>FsPuffinReader: Fetch compressed data
    FsPuffinReader->>cachedPuffinManager: Read data
    CachedPuffinManager->>User: Return data

Assessment against linked issues

Objective	Addressed	Explanation
Support footer lz4 compression (#4193)	✅
Introduce puffin manager trait (#4193)	✅
Introduce writer for puffin manager (#4193)	✅
Introduce cache manager (#4193)	✅
Introduce reader for puffin manager (#4193)	✅

Poem

In a warren of code so tight,
Puffin files now take flight,
With caches swift and data compressed,
Our changes stand the test,
Bringing joy, both day and night.
🐇✨

[!TIP]

Early access features: enabled
We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 3 days ago

Codecov Report

Attention: Patch coverage is 98.82629% with 5 lines in your changes missing coverage. Please review.

Project coverage is 84.73%. Comparing base (e531326) to head (aaa5ea1). Report is 3 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4240 +/- ## ========================================== - Coverage 84.84% 84.73% -0.11% ========================================== Files 1049 1051 +2 Lines 186267 186627 +360 ========================================== + Hits 158029 158134 +105 - Misses 28238 28493 +255 ```

evenyag commented 3 days ago

https://github.com/GreptimeTeam/greptimedb/actions/runs/9755006232/job/26922900846?pr=4240

Is this related to https://github.com/GreptimeTeam/greptimedb/pull/4243? @WenyXu

thread '<unnamed>' panicked at tests-fuzz/targets/fuzz_insert_logical_table.rs:307:35:
fuzz test must be succeed: 0: Failed to execute query: CREATE TABLE `CupidiTaTE`(
ts TIMESTAMP(3) TIME INDEX,
val DOUBLE,
`eT` STRING,
`VoLUPTaTe` STRING,
`ASPerNatur` STRING,
`ExPLiCabo` STRING,
PRIMARY KEY(`VoLUPTaTe`, `ASPerNatur`, `eT`, `ExPLiCabo`)
)
ENGINE=metric with ("on_physical_table" = "doLORuM");, at tests-fuzz/targets/fuzz_insert_logical_table.rs:256:14
1: Database(MySqlDatabaseError { code: Some("HY000"), number: 1815, message: "Region `4647154614272(1082, 0)` already exists" })

WenyXu commented 2 days ago

https://github.com/GreptimeTeam/greptimedb/actions/runs/9755006232/job/26922900846?pr=4240

Is this related to #4243? @WenyXu

thread '<unnamed>' panicked at tests-fuzz/targets/fuzz_insert_logical_table.rs:307:35:
fuzz test must be succeed: 0: Failed to execute query: CREATE TABLE `CupidiTaTE`(
ts TIMESTAMP(3) TIME INDEX,
val DOUBLE,
`eT` STRING,
`VoLUPTaTe` STRING,
`ASPerNatur` STRING,
`ExPLiCabo` STRING,
PRIMARY KEY(`VoLUPTaTe`, `ASPerNatur`, `eT`, `ExPLiCabo`)
)
ENGINE=metric with ("on_physical_table" = "doLORuM");, at tests-fuzz/targets/fuzz_insert_logical_table.rs:256:14
1: Database(MySqlDatabaseError { code: Some("HY000"), number: 1815, message: "Region `4647154614272(1082, 0)` already exists" })

No, it seems something else. Please trigger test again, and I’ll check the failed action ASAP.

evenyag commented 2 days ago

@coderabbitai pause

coderabbitai[bot] commented 2 days ago

Actions performed

Reviews paused.

GreptimeTeam / greptimedb