feat(puffin): introduce puffin manager trait

[zhongzc]

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

#4193

What's changed and what's your intention?

Add PuffinManager to unify puffin file reading and writing blob and directory

Checklist

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

[coderabbitai]

Walkthrough

This update introduces a new module puffin_manager to the Puffin library, which provides enhanced capabilities for managing, reading, and writing Puffin files. It defines traits for creating readers and writers, handling data compression, and organizing file structures efficiently.

Changes

Files	Change Summary
src/puffin/src/lib.rs	Introduced puffin_manager module to the library.
src/puffin/src/puffin_manager.rs	Added traits PuffinManager, PuffinWriter, and PuffinReader, and a struct PutOptions for compression options.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PuffinManager
    participant PuffinWriter
    participant PuffinReader

    Client->>+PuffinManager: create writer()
    PuffinManager->>+PuffinWriter: initialize
    PuffinWriter-->>-PuffinManager: writer instance

    Client->>+PuffinWriter: put_blob(data, options)
    PuffinWriter-->>-Client: confirmation
    
    Client->>+PuffinWriter: finalize()
    PuffinWriter-->>-Client: EOF

    Client->>+PuffinManager: create reader()
    PuffinManager->>+PuffinReader: initialize
    PuffinReader-->>-PuffinManager: reader instance

    Client->>+PuffinReader: read_blob(key)
    PuffinReader-->>-Client: data

Loading

Possibly related issues

• GreptimeTeam/greptimedb#4193: This update addresses the requirements to support directory put operations and compression in the Puffin library.

Poem

In the realm of Puffin's plume,
New managers and readers bloom,
Compression so tight,
Directory delight,
Libraries gain more room.
A cycle complete,
Writing and reading meet,
Efficiency, now our tune.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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 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.

[coderabbitai]

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

src/puffin/src/puffin_manager.rs (1)

23-34: Consider enhancing the documentation for PuffinManager.

The current documentation is minimal. Providing more detailed descriptions of what constitutes a PuffinReader and PuffinWriter, and how they interact with puffin_file_name could improve clarity and usability.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 07cbaba and 1949510.

Files selected for processing (2)

• src/puffin/src/lib.rs (1 hunks)
• src/puffin/src/puffin_manager.rs (1 hunks)

Files skipped from review due to trivial changes (1)

• src/puffin/src/lib.rs

Additional comments not posted (1)

src/puffin/src/puffin_manager.rs (1)

62-73: Validate the error handling in PuffinReader.

Ensure that the error handling strategy in blob and dir methods is robust, especially considering they interact with file systems which are prone to various errors.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.81%. Comparing base (07cbaba) to head (1949510).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4195      +/-   ##
==========================================
- Coverage   85.11%   84.81%   -0.30%     
==========================================
  Files        1028     1028              
  Lines      180903   180903              
==========================================
- Hits       153970   153436     -534     
- Misses      26933    27467     +534