Skip to content

fix: home api #1273

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

Conversation

nikhilsinhaparseable
Copy link
Contributor

@nikhilsinhaparseable nikhilsinhaparseable commented Mar 27, 2025

get log_source from memory map
instead of checking stream.json from storage
as there may be stream.json of an ingestor which is offline and has never migrated to a newer version

Summary by CodeRabbit

  • Refactor
    • Enhanced the home experience by refining the data retrieval process.
    • Updated the error handling approach to manage unexpected issues more gracefully, resulting in improved system stability and a smoother user experience.

get log_source from memory map
instead of checking stream.json from storage
as there may be stream.json of an ingestor which is offline
and has never migrated to a newer version
Copy link
Contributor

coderabbitai bot commented Mar 27, 2025

Walkthrough

This pull request updates the generate_home_response function in src/prism/home/mod.rs. The change replaces the direct access to the log_source from the first element of stream_jsons with a call to PARSEABLE.get_stream(&stream). This method now handles potential errors by mapping them to PrismHomeError::Anyhow and then retrieves the log_source through the stream's get_log_source() method. No public API or exported entity declarations are modified.

Changes

File Change Summary
src/prism/.../mod.rs Modified generate_home_response: now retrieves the stream via PARSEABLE.get_stream(&stream) with error mapping to PrismHomeError::Anyhow, then calls get_log_source().

Sequence Diagram(s)

sequenceDiagram
    participant F as generate_home_response
    participant P as PARSEABLE
    participant S as Stream

    F->>P: Call get_stream(&stream)
    alt Stream Retrieval Successful
        P-->>F: Returns stream instance
        F->>S: Calls get_log_source()
    else Retrieval Error
        P-->>F: Returns error
        F->>F: Map error to PrismHomeError::Anyhow
    end
Loading

Possibly related PRs

Suggested labels

for next release

Suggested reviewers

  • de-sh

Poem

I'm a sprightly rabbit with a clever code hop,
Bounding over streams until no errors pop.
I nibble on log_source with a thoughtful glance,
Mapping errors smoothly in this new dance.
Hop along with changes—together we advance!
🐰✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between af096e4 and a942cb1.

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

207-210: Improved log source retrieval implementation

This change correctly implements the PR objective by retrieving the log source from the in-memory map (PARSEABLE.get_stream()) rather than directly from the stream.json files. This approach ensures that the home API uses the most up-to-date log source information, even if some ingestors are offline with outdated stream.json files.

The error handling is also properly implemented with the appropriate mapping to PrismHomeError::Anyhow.

✨ 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 plan to trigger planning for file edits and PR creation.
  • @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.

@nikhilsinhaparseable nikhilsinhaparseable merged commit 9cd3809 into parseablehq:main Mar 27, 2025
14 checks passed
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.

1 participant