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

refactor: process ain't async #1180

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

refactor: process ain't async #1180

wants to merge 2 commits into from

Conversation

de-sh
Copy link
Contributor

@de-sh de-sh commented Feb 9, 2025

Fixes #XXXX.

Description


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

  • Refactor
    • Streamlined the event processing flow by converting operations from asynchronous to synchronous execution.
    • Enhanced error management to simplify control flow and improve overall system responsiveness.

This update refines internal event handling, potentially contributing to better system stability and performance.

Copy link

coderabbitai bot commented Feb 12, 2025

Walkthrough

This pull request simplifies error handling and processing by consolidating the asynchronous calls into a more concise, synchronous flow. The changes include merging two await statements into a single chained call in the Kafka processor, altering the Event::process method in the event module from asynchronous to synchronous, and updating the corresponding calls in the HTTP handlers to remove unnecessary awaits. There are no modifications to public API declarations.

Changes

File Path(s) Change Summary
src/connectors/kafka/processor.rs Combined separate awaits for build_event_from_chunk(&records) and subsequent .process() call into a single chained call to streamline error handling in the processor.
src/event/mod.rs Changed the process method signature from asynchronous (async fn) to synchronous (fn), without altering its internal logic.
src/handlers/http/ingest.rs, src/handlers/http/modal/utils/ingest_utils.rs Updated calls to the process() method by removing the await keyword, in line with the synchronous change made to Event::process.

Sequence Diagram(s)

sequenceDiagram
    participant Handler as Ingest Handler
    participant Event as Event Module
    participant Kafka as Kafka Processor

    Handler->>Event: process() (sync call)
    Event-->>Handler: Return Result/Error

    Kafka->>Event: build_event_from_chunk(&records)
    Event-->>Kafka: Constructed Event
    Kafka->>Event: process() (sync call)
    Event-->>Kafka: Return Result/Error
Loading

Suggested reviewers

  • nitisht

Poem

I hopped through lines of code so bright,
Sync calls replacing async delays right.
Combining awaits to keep things neat,
My rabbit heart skips a rhythmic beat.
Joyful hops in every byte! 🐇

Cheers to changes and smoother flight!


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

Copy link

@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/event/mod.rs (1)

49-85: LGTM! Consider adding documentation.

The change from async to sync is appropriate as the method doesn't perform any asynchronous operations. All operations (schema key generation, partition handling, and stats updates) are synchronous.

Consider adding documentation to explain:

  • The purpose of the method
  • The significance of the schema key
  • The impact of time and custom partitions
  • The relationship with process_unchecked
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 20e66a4 and f7b8c2b.

📒 Files selected for processing (4)
  • src/connectors/kafka/processor.rs (1 hunks)
  • src/event/mod.rs (1 hunks)
  • src/handlers/http/ingest.rs (1 hunks)
  • src/handlers/http/modal/utils/ingest_utils.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • 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 aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
🔇 Additional comments (3)
src/connectors/kafka/processor.rs (1)

112-112: LGTM! Code is more concise while maintaining error handling.

The change simplifies the code by combining the async build_event_from_chunk with the now-synchronous process call, while preserving proper error propagation.

src/handlers/http/modal/utils/ingest_utils.rs (1)

141-141: LGTM! Change aligns with the Event struct modifications.

The synchronous process call is consistent with the Event struct changes and maintains proper error handling.

src/handlers/http/ingest.rs (1)

107-107: LGTM! Change maintains consistency with Event struct modifications.

The synchronous process call aligns with the Event struct changes while preserving proper error handling and the surrounding async context.

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