cherry pick Don't request null keys from KVStore #774

[varant-zlai]

Summary

Cherry pick: https://github.com/airbnb/chronon/pull/774/files

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested
• Documentation update

Summary by CodeRabbit

• New Features

  • Enhanced group-by request processing with improved key validation
  • Added a new method for parsing group-by responses with more robust error handling

• Tests

  • Added comprehensive test cases for new response parsing method
  • Verified handling of scenarios with null keys and missing keys

[coderabbitai]

Walkthrough

The changes focus on enhancing the group-by request processing in the FetcherBase class. The primary modifications involve adding a new parseGroupByResponse method that improves request validation and response handling. The implementation now filters out invalid requests with null keys and provides a more robust mechanism for processing group-by responses, centralizing the logic for key prefixing and error management.

Changes

File	Change Summary
online/src/main/scala/ai/chronon/online/FetcherBase.scala	Added parseGroupByResponse method to handle group-by request responses with improved validation and error handling
online/src/test/scala/ai/chronon/online/test/FetcherBaseTest.scala	Added test cases for parseGroupByResponse method, covering scenarios with valid, null, and missing keys

Sequence Diagram

sequenceDiagram
    participant Fetcher as FetcherBase
    participant KVStore as Key-Value Store
    participant Validator as Request Validator

    Fetcher->>Validator: Validate Group-By Requests
    Validator-->>Fetcher: Filter Valid Requests
    Fetcher->>KVStore: Fetch Group-By Data
    KVStore-->>Fetcher: Return Responses
    Fetcher->>Fetcher: Parse Group-By Responses

Loading

Poem

🔍 Fetching data with grace and might,
Null keys filtered, responses bright
Group-by magic, errors kept at bay
CodeRabbit's logic finds its way!
🚀 Robust and clean, our code takes flight

Warning

Review ran into problems

🔥 Problems

GitHub Actions: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

🪧 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 (4)

online/src/test/scala/ai/chronon/online/test/FetcherBaseTest.scala (2)

242-255: Rename test to follow Scala naming conventions.

Rename "Not fetch with null keys" to "should not fetch with null keys".

---

257-270: Rename test to follow Scala naming conventions.

Rename "parse with missing keys" to "should handle missing keys".

online/src/main/scala/ai/chronon/online/FetcherBase.scala (2)

326-382: Simplify the filter condition.

The current condition is complex and can be simplified:

-  .filter(r => r.keys == null || r.keys.values == null || r.keys.values.exists(_ != null))
+  .filter(r => Option(r.keys).exists(_.values.exists(_ != null)))

---

638-640: Use a logging rate limiter instead of random sampling.

Replace random sampling with a proper rate limiter for debug logging.

-if (debug || Math.random() < 0.001) {
+if (debug || RateLimiter.shouldLog("parseGroupByResponse", 0.001)) {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 16c05a8 and 7abd1ce.

📒 Files selected for processing (2)

• online/src/main/scala/ai/chronon/online/FetcherBase.scala (3 hunks)
• online/src/test/scala/ai/chronon/online/test/FetcherBaseTest.scala (2 hunks)

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

• GitHub Check: no_spark_scala_tests
• GitHub Check: scala_compile_fmt_fix
• GitHub Check: enforce_triggered_workflows

🔇 Additional comments (1)

online/src/test/scala/ai/chronon/online/test/FetcherBaseTest.scala (1)

229-240: LGTM!

Test verifies the happy path for parseGroupByResponse.