Skip to content

fix: datasets API edgecase where stream is not hottiered #1252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

de-sh
Copy link
Contributor

@de-sh de-sh commented Mar 19, 2025

Fixes #XXXX.

Description

Handles the circumstance where hottier is not configured at the stream level, but hottier is enabled at instance level


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced error handling for data retrieval ensures more graceful responses when information is missing, resulting in a smoother and more reliable experience for users.

Copy link
Contributor

coderabbitai bot commented Mar 19, 2025

Walkthrough

The changes update the error handling in the get_datasets method of PrismDatasetRequest. A match statement is now used to process the result from the get_hot_tier call in the HotTierManager. If the call is successful, the statistics are wrapped in Some(stats); if a NotFound error occurs, it returns None; and other errors are propagated via Err(err.into()). Additionally, the HotTierValidationError import has been added.

Changes

File Change Summary
src/prism/logstream/mod.rs Updated error handling in get_datasets with a match statement on get_hot_tier result: returns Some(stats) on success, None for NotFound, and propagates other errors. Added import for HotTierValidationError.

Sequence Diagram(s)

sequenceDiagram
  participant C as Client
  participant D as PrismDatasetRequest
  participant H as HotTierManager

  C->>D: Call get_datasets()
  D->>H: Call get_hot_tier()
  alt Success
    H-->>D: Ok(stats)
    D-->>C: Some(stats)
  else NotFound Error
    H-->>D: Err(NotFound)
    D-->>C: None
  else Other Error
    H-->>D: Err(error)
    D-->>C: Error propagated
  end
Loading

Possibly related PRs

Suggested labels

for next release

Suggested reviewers

  • praveen5959
  • parmesant

Poem

I'm a rabbit hopping with delight,
Code paths now clearer, shining so bright.
Errors and stats dance in a seamless flow,
With match arms guiding where they should go.
Celebrate these changes with a joyful glow! 🐇✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

CodeRabbit Configuration 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.

@de-sh de-sh requested a review from praveen5959 March 19, 2025 06:52
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/prism/logstream/mod.rs (1)

277-283: Improved error handling for hottier edge case

The implementation now properly handles the edge case where the hottier is not configured at the stream level but is enabled at the instance level. By explicitly handling the NotFound error, the code now returns None for streams without hottier configuration instead of propagating the error.

Consider adding a comment explaining this specific edge case for future maintainers:

 let hottier = match HotTierManager::global() {
+    // Handle case where hottier is enabled at instance level but not configured for this stream
     Some(manager) => match manager.get_hot_tier(stream).await {
         Ok(stats) => Some(stats),
         Err(HotTierError::HotTierValidationError(
             HotTierValidationError::NotFound(_),
         )) => None,
         Err(err) => return Err(err.into()),
     },
     _ => None,
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6919a5c and c6d7963.

📒 Files selected for processing (1)
  • src/prism/logstream/mod.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
🔇 Additional comments (1)
src/prism/logstream/mod.rs (1)

48-48: LGTM: Import added for new error handling

This import is correctly added to support the more granular error handling in the match statement below.

Copy link
Contributor

@nikhilsinhaparseable nikhilsinhaparseable left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@nitisht nitisht merged commit 9287d55 into parseablehq:main Mar 19, 2025
14 checks passed
@de-sh de-sh deleted the hottier-fix branch March 19, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants