Refer to a related PR or issue link (optional)

4193

What's changed and what's your intention?

Mainly implement put_blob and put_dir.

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 support for compression codecs in various operations, enabling enhanced data handling capabilities.
- Added cache management functionality to efficiently handle puffin files.
Bug Fixes
- Improved error handling for file operations, unsupported compression, and duplicate blob writes.
Improvements
- Standardized byte count handling by changing types from usize to u64, enhancing consistency.
- Enhanced the Blob struct by introducing a compression_codec field and renaming data to compressed_data.
Dependency Updates
- Added async-compression and async-walkdir as dependencies.
- Moved uuid from development to regular dependencies.

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes involve significant updates across various files in the codebase, such as altering method return types from usize to u64, adding a compression_codec field to the Blob struct, and changing dependency listings in Cargo.toml. Additionally, new modules and error variants are introduced, enhancing functionality related to file handling, compression, and cache management.

Changes

Files	Change Summary
`src/mito2/src/sst/index.rs`	Changed return type of the `finish` method from `usize` to `u64` in the `Indexer` struct.
`src/mito2/src/sst/index/...`	Updated `Blob` struct by adding `compression_codec` field and renaming `data` to `compressed_data`. Altered `ByteCount` type and error handling in `SstIndexCreator`.
`src/mito2/src/sst/parquet/writer.rs`	Removed type conversion to `u64` in assignment of `index_file_size`.
`src/puffin/Cargo.toml`	Added `async-compression` and `async-walkdir` dependencies. Moved `uuid` from dev-dependencies to regular dependencies.
`src/puffin/src/blob_metadata.rs`	Changed `CompressionCodec` enum's derive attributes from `Clone` to `Copy`.
`src/puffin/src/error.rs`	Added new error variants for file operations and updated `ErrorExt` implementation to handle them.
`src/puffin/src/file_format/writer.rs`	Added `compression_codec` to `Blob`, modified `add_blob` and `finish` methods’ return types to `u64` for `PuffinSyncWriter` and `PuffinAsyncWriter` traits.
`src/puffin/src/file_format/writer/file.rs`	Updated `PuffinFileWriter` to change return types of `add_blob` and `finish` methods to `u64` and reference `compressed_data`.
`src/puffin/src/lib.rs`	Added `#![feature(trait_alias)]` attribute.
`src/puffin/src/puffin_manager.rs`	Added new module declarations for `cache_manager` and `cached_puffin_manager`.
`src/puffin/src/puffin_manager/cache_manager.rs`	Introduced `CacheManager` and `DirWriterProvider` traits, and new type aliases for cache operations.
`src/puffin/src/puffin_manager/cached_puffin_manager.rs`	Added `DirMetadata`, `DirFileMetadata` structs, and `CachedPuffinWriter` implementing `PuffinWriter`.
`src/puffin/src/tests.rs`	Renamed `data` to `compressed_data` in `Blob` struct and added `compression_codec` field in test functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PuffinFileWriter
    participant Blob
    participant CacheManager

    User->>PuffinFileWriter: add_blob()
    PuffinFileWriter-->>Blob: Write compressed_data
    PuffinFileWriter-->>User: Return u64 (byte count)

    User->>PuffinFileWriter: finish()
    PuffinFileWriter-->>CacheManager: Cache directory
    PuffinFileWriter-->>User: Return u64 (total bytes)

Poem

In the code where bytes do flow,
Changes came, updates did grow.
Compression codecs now in sight,
File sizes altered to new height.
Dependencies lined up in a row, For Puffin's features to smoothly blow.
🎉 🐇 Here's to the future, set aglow! 🚀

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 1 week ago

Codecov Report

Attention: Patch coverage is 17.90123% with 133 lines in your changes missing coverage. Please review.

Project coverage is 84.70%. Comparing base (cdd4baf) to head (b0a4f29). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4203 +/- ## ========================================== - Coverage 85.05% 84.70% -0.35% ========================================== Files 1031 1033 +2 Lines 181276 181442 +166 ========================================== - Hits 154176 153692 -484 - Misses 27100 27750 +650 ```

GreptimeTeam / greptimedb

feat(puffin): implement CachedPuffinWriter #4203