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

chore: use random partitions #2388

Merged
merged 1 commit into from
Mar 7, 2025
Merged

chore: use random partitions #2388

merged 1 commit into from
Mar 7, 2025

Conversation

turip
Copy link
Contributor

@turip turip commented Mar 7, 2025

Overview

Fixes #(issue)

Notes for reviewer

Summary by CodeRabbit

  • Chores
    • Modified internal event processing logic to streamline data handling and set the stage for upcoming enhancements. End-user functionality remains unchanged.

@turip turip requested a review from a team as a code owner March 7, 2025 16:44
Copy link

coderabbitai bot commented Mar 7, 2025

Walkthrough

The change modifies the EventMetadata method in the EventBatchedIngest struct within the events file. Specifically, the line assigning the Subject field in the returned metadata structure is commented out, accompanied by a TODO note for future review regarding partition distribution. The implementation of the Source field remains unchanged, still utilizing the metadata.ComposeResourcePathRaw function with the EventSubsystem string. No alterations were made to the declarations of exported or public entities.

Changes

File Change Summary
openmeter/sink/…/events/events.go In the EventMetadata method, the assignment to the Subject field has been commented out with a TODO note; the Source field logic remains unchanged.
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@turip turip requested review from tothandras and GAlexIHU March 7, 2025 16:45
@turip turip added the release-note/ignore Ignore this change when generating release notes label Mar 7, 2025
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d742455 and 22275f4.

📒 Files selected for processing (1)
  • openmeter/sink/flushhandler/ingestnotification/events/events.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: CI
  • GitHub Check: Analyze (go)

Comment on lines +59 to +61
Source: metadata.ComposeResourcePathRaw(string(EventSubsystem)),
// TODO[later]: let's check why we don't have uniform distribution of partitions
// Subject: metadata.ComposeResourcePath(b.Namespace.ID, metadata.EntitySubjectKey, b.SubjectKey),
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Consider documenting the expected behavior change without the Subject field

By commenting out the Subject field assignment, you're likely changing how events get partitioned in your messaging system (possibly Kafka). The TODO comment suggests you're addressing partition distribution issues, which aligns with the PR title "chore: use random partitions".

However, it would be helpful to:

  1. Document the expected behavior change (e.g., "This will cause events to use random partitioning instead of subject-based partitioning")
  2. Mention any potential side effects (e.g., ordering guarantees that might be affected)
  3. Add ticket references if there's a plan to revisit this later

This will help future maintainers understand the reasoning behind this change beyond just the TODO comment.

@turip turip merged commit 70064a1 into main Mar 7, 2025
25 of 26 checks passed
@turip turip deleted the chore/use-random-partitions branch March 7, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/ignore Ignore this change when generating release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants