Skip to content
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

feat(clp-s): Add support for ingestion from S3 in the kv-ir ingestion flow; Improve error messages in the kv-ir ingestion flow. #706

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gibber9809
Copy link
Contributor

@gibber9809 gibber9809 commented Jan 30, 2025

Description

This PR adds support for ingesting kv-ir data from S3 by using the same ReaderUtils::try_create_reader flow used by most of the rest of clp-s.

While touching this code we also add extra log messages for errors encountered while deserializing kv-ir.

Checklist

  • The PR satisfies the [contribution guidelines][yscope-contrib-guidelines].
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Validated that error messages are logged when trying to ingest invalid kv-ir
  • Validated that ingestion of simple kv-ir file from S3 succeeds

Summary by CodeRabbit

  • Refactor

    • Improved error handling for CURL operations in JSON parsing.
    • Simplified error checking logic in parsing methods.
    • Introduced a dedicated method for logging CURL-related errors.
  • Performance

    • Enhanced buffer management for decompressor.
    • Streamlined input handling mechanism.

These changes enhance the robustness and maintainability of the JSON parsing process by centralizing error detection and logging.

Copy link
Contributor

coderabbitai bot commented Jan 30, 2025

Walkthrough

The pull request introduces a refactoring of error handling in the JsonParser class, specifically focusing on CURL operations. A new method check_and_log_curl_error has been added to encapsulate CURL error checking and logging logic. This method simplifies error handling in the parse and parse_from_ir methods by centralizing error detection and reporting for network readers. Additionally, a new constant cDecompressorReadBufferCapacity is introduced, and the decompressor's open method is updated to use a reader instead of a path string.

Changes

File Change Summary
components/core/src/clp_s/JsonParser.cpp - Added check_and_log_curl_error method for centralized CURL error handling
- Updated parse and parse_from_ir methods to use new error checking method
- Introduced cDecompressorReadBufferCapacity constant
- Modified decompressor open method to use reader
components/core/src/clp_s/JsonParser.hpp - Added static method declaration for check_and_log_curl_error

Sequence Diagram

sequenceDiagram
    participant Parser as JsonParser
    participant Reader as NetworkReader
    participant Logger as ErrorLogger

    Parser->>Reader: check_and_log_curl_error()
    Reader-->>Parser: CURL return code
    alt CURL error detected
        Parser->>Logger: Log error details
        Parser-->>Parser: Return false
    else No error
        Parser-->>Parser: Return true
    end
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 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. (Beta)
  • @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.

@gibber9809 gibber9809 requested a review from wraymo January 30, 2025 21:14
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)
components/core/src/clp_s/JsonParser.cpp (1)

904-907: Fix typo in error message.

There's a typo in the error message: "unkown" should be "unknown".

-                        "Encountered unkown IR unit type ({}) during deserialization.",
+                        "Encountered unknown IR unit type ({}) during deserialization.",
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9cbe279 and 0f99287.

📒 Files selected for processing (1)
  • components/core/src/clp_s/JsonParser.cpp (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/core/src/clp_s/JsonParser.cpp (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: ubuntu-jammy-static-linked-bins
  • GitHub Check: ubuntu-jammy-dynamic-linked-bins
  • GitHub Check: ubuntu-focal-static-linked-bins
  • GitHub Check: centos-stream-9-static-linked-bins
  • GitHub Check: ubuntu-focal-dynamic-linked-bins
  • GitHub Check: centos-stream-9-dynamic-linked-bins
  • GitHub Check: build-macos (macos-14, false)
  • GitHub Check: build-macos (macos-14, true)
  • GitHub Check: lint-check (ubuntu-latest)
  • GitHub Check: build-macos (macos-13, false)
  • GitHub Check: build-macos (macos-13, true)
  • GitHub Check: build (macos-latest)
🔇 Additional comments (6)
components/core/src/clp_s/JsonParser.cpp (6)

808-808: LGTM! Good choice of buffer size.

The 64KB buffer size is a reasonable default that balances memory usage with performance.


810-815: LGTM! Proper error handling for reader creation.

The code correctly handles the case where reader creation fails and ensures proper cleanup.


824-831: LGTM! Comprehensive error handling for deserializer creation.

Good error handling with detailed logging that includes both error code and message. The code also ensures proper cleanup of resources.


850-858: LGTM! Proper error handling for deserialization failures.

The code properly handles deserialization errors with detailed logging and cleanup.


931-952: LGTM! Well-structured CURL error handling.

The new method check_and_log_curl_error effectively centralizes CURL error handling logic. It:

  1. Safely checks if the reader is a NetworkReader
  2. Properly extracts and logs both error code and message
  3. Handles the case where error message might be unavailable

815-819: Consider adding error handling for decompressor.open.

The decompressor.open call could potentially fail, but there's no error handling for this case.

Run this script to check if decompressor.open can fail:

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