feat(clp-s): Add support for ingestion from S3 in the kv-ir ingestion flow; Improve error messages in the kv-ir ingestion flow. by gibber9809 · Pull Request #706 · y-scope/clp

gibber9809 · 2025-01-30T21:14:25Z

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 the decompressor.
- Streamlined input handling mechanism.
Bug Fixes
- Broadened exception handling to improve error reporting and diagnostics during runtime.

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

… for kv-ir ingestion flow

coderabbitai · 2025-01-30T21:14:33Z

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 in clp-s.cpp broaden the scope of exception handling during decompression.

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`
`components/core/src/clp_s/clp-s.cpp`	- Modified exception handling to catch `std::exception` for broader error reporting during decompression

Possibly related PRs

feat(clp-s): Add support for ingesting logs from S3. #639: The changes in the main PR, particularly the refactoring of the JsonParser class and the introduction of the check_and_log_curl_error method, are directly related to the modifications in the retrieved PR, which also involves enhancements to the JsonParser for handling network resources and error management.

Suggested reviewers

haiqi96
wraymo
kirkrodrigues

📜 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 87393d5 and 25bbb1f.

📒 Files selected for processing (1)

components/core/src/clp_s/clp-s.cpp (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ...

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

components/core/src/clp_s/clp-s.cpp

⏰ Context from checks skipped due to timeout of 90000ms (12)

GitHub Check: centos-stream-9-static-linked-bins
GitHub Check: ubuntu-jammy-static-linked-bins
GitHub Check: ubuntu-focal-static-linked-bins
GitHub Check: centos-stream-9-dynamic-linked-bins
GitHub Check: ubuntu-jammy-dynamic-linked-bins
GitHub Check: ubuntu-focal-dynamic-linked-bins
GitHub Check: build-macos (macos-14, false)
GitHub Check: lint-check (ubuntu-latest)
GitHub Check: build-macos (macos-13, false)
GitHub Check: lint-check (macos-latest)
GitHub Check: build-macos (macos-13, true)
GitHub Check: build (macos-latest)

🔇 Additional comments (3)

components/core/src/clp_s/clp-s.cpp (3)

211-214: LGTM! Broadened exception handling as discussed.

The change from clp_s::TraceableException to std::exception aligns with the previous discussion and improves error handling by catching a wider range of exceptions.

255-258: LGTM! Error message provides clear context.

The change to std::exception is consistent with other changes, and the error message clearly indicates both the operation that failed and the reason.

326-328: LGTM! Improved error message clarity in decompression.

The change to std::exception with a clear error message directly supports the PR objective of improving error messages in the ingestion flow.

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

coderabbitai

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:

Safely checks if the reader is a NetworkReader

Properly extracts and logs both error code and message

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:

wraymo

Great PR! I just have one quick question

wraymo · 2025-02-19T02:32:27Z

            }
-        } catch (clp_s::TraceableException& e) {
-            SPDLOG_ERROR("{}", e.what());
+        } catch (std::exception const& e) {


Do we want to change clp_s::TraceableException to std::exception for the search path?

For the two places that still use it in the search flow? Sure.

…in clp-s.cpp

… flow; Improve error messages in the kv-ir ingestion flow. (y-scope#706)

Allow kv-ir ingestion from network sources and improve error messages…

9cbe279

… for kv-ir ingestion flow

gibber9809 requested a review from wraymo January 30, 2025 21:14

Fix macos build issue

0f99287

coderabbitai Bot reviewed Jan 30, 2025

View reviewed changes

gibber9809 added 3 commits February 14, 2025 20:18

Merge remote-tracking branch 'upstream/main' into kvir-s3-ingestion

4e33f00

Fix build warning in JsonParser.cpp

a75ed90

Improve error logging and catching in clp-s.cpp

87393d5

wraymo reviewed Feb 19, 2025

View reviewed changes

Replace remaining clp_s::TraceableException uses with std::exception …

25bbb1f

…in clp-s.cpp

gibber9809 requested a review from wraymo February 19, 2025 14:26

wraymo approved these changes Feb 21, 2025

View reviewed changes

kirkrodrigues approved these changes Feb 21, 2025

View reviewed changes

gibber9809 merged commit 7130fdf into y-scope:main Feb 21, 2025

coderabbitai Bot mentioned this pull request Mar 7, 2025

feat(clp-s): Change behaviour for kv-ir ingestion to warn and continue on error #733

Merged

3 tasks

junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026

feat(clp-s): Add support for ingestion from S3 in the kv-ir ingestion…

8a1a7db

… flow; Improve error messages in the kv-ir ingestion flow. (y-scope#706)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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
gibber9809 merged 6 commits into
y-scope:mainfrom
gibber9809:kvir-s3-ingestion

gibber9809 commented Jan 30, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jan 30, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

wraymo left a comment

Uh oh!

wraymo Feb 19, 2025

Uh oh!

gibber9809 Feb 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gibber9809 commented Jan 30, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

wraymo left a comment

Choose a reason for hiding this comment

Uh oh!

wraymo Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

gibber9809 Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gibber9809 commented Jan 30, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jan 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)