Skip to content

Add additional sub partitions to wait for in query API #752

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

Merged
merged 4 commits into from
May 8, 2025

Conversation

david-zlai
Copy link
Contributor

@david-zlai david-zlai commented May 8, 2025

Summary

Add additional sub partitions to wait for in Query to ultimately compile into GroupBy and Join

Checklist

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

Summary by CodeRabbit

  • New Features
    • Added support for specifying additional sub-partitions when defining data dependencies, allowing for more granular detection of data arrival.
  • Documentation
    • Updated function and parameter documentation to reflect new options for specifying sub-partitions in queries.

Copy link

coderabbitai bot commented May 8, 2025

Walkthrough

This update introduces support for specifying additional partition dependencies in Airflow by extending the Query struct and related functions. The changes propagate the new subPartitionsToWaitFor field from the Thrift API through the Python interface and Airflow dependency helper logic, enabling more granular partition-based dependency tracking.

Changes

File(s) Change Summary
api/python/ai/chronon/airflow_helpers.py Added support for additional partitions in dependency creation; updated function signatures and logic.
api/python/ai/chronon/group_by.py Added a blank line before metadata creation (stylistic).
api/python/ai/chronon/query.py Extended Query function to accept sub_partitions_to_wait_for; updated docstring and call style.
api/thrift/api.thrift Added optional subPartitionsToWaitFor field to Query struct.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PythonAPI
    participant ThriftAPI
    participant AirflowHelpers

    User->>PythonAPI: Call Query(..., sub_partitions_to_wait_for)
    PythonAPI->>ThriftAPI: Construct Query with subPartitionsToWaitFor
    PythonAPI->>AirflowHelpers: Pass additional_partitions to create_airflow_dependency
    AirflowHelpers-->>AirflowHelpers: Append additional_partitions to dependency spec
Loading

Poem

New partitions now join the dance,
Airflow dependencies get a chance.
From Thrift to Python, the flow is neat,
Extra keys make tracking complete.
With code aligned and logic tight,
Data’s arrival is now in sight!
🎉🗝️

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent 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 aac4fe3 and f164608.

📒 Files selected for processing (1)
  • api/python/ai/chronon/group_by.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • api/python/ai/chronon/group_by.py
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: service_tests
  • GitHub Check: service_commons_tests
  • GitHub Check: service_tests
  • GitHub Check: online_tests
  • GitHub Check: api_tests
  • GitHub Check: flink_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: api_tests
  • GitHub Check: aggregator_tests
  • GitHub Check: enforce_triggered_workflows

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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.

@david-zlai david-zlai force-pushed the vz/add_additional_parts_to_gb branch 2 times, most recently from 5feadc3 to 2936e3d Compare May 8, 2025 04:11
@david-zlai david-zlai force-pushed the vz/add_additional_parts_to_gb branch from 2936e3d to a4a32d3 Compare May 8, 2025 04:28
@david-zlai david-zlai marked this pull request as ready for review May 8, 2025 04:35
@david-zlai david-zlai changed the title Vz/add additional parts to gb Add additional sub partitions to wait for in query API May 8, 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: 2

🧹 Nitpick comments (2)
api/python/ai/chronon/airflow_helpers.py (2)

51-56: Simplify function name for consistency.

Current name is unnecessarily verbose.

-def _get_additional_subPartitionsToWaitFor_from_query(query):
+def _get_sub_partitions_from_query(query):
     """Gets additional subPartitionsToWaitFor from query if available"""
     if query:
         return query.subPartitionsToWaitFor
     return None

75-77: Improve tuple assignment readability.

The current format packs unrelated values together in a confusing way.

# For the events case:
-        source_partition_column, additional_partitions = (
-            _get_partition_col_from_query(source.events.query) or partition_column, _get_additional_subPartitionsToWaitFor_from_query(source.events.query)
-        )
+        source_partition_column = _get_partition_col_from_query(source.events.query) or partition_column
+        additional_partitions = _get_additional_subPartitionsToWaitFor_from_query(source.events.query)

# And similar change for the entities case

Also applies to: 84-86

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3779e99 and a4a32d3.

📒 Files selected for processing (4)
  • api/python/ai/chronon/airflow_helpers.py (4 hunks)
  • api/python/ai/chronon/group_by.py (2 hunks)
  • api/python/ai/chronon/query.py (2 hunks)
  • api/thrift/api.thrift (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
api/python/ai/chronon/airflow_helpers.py (1)
api/src/main/scala/ai/chronon/api/Extensions.scala (1)
  • query (382-390)
🪛 Ruff (0.8.2)
api/python/ai/chronon/group_by.py

21-21: ai.chronon.airflow_helpers imported but unused

Remove unused import: ai.chronon.airflow_helpers

(F401)

🔇 Additional comments (4)
api/thrift/api.thrift (1)

43-47: New field added for additional partition wait conditions.

The new subPartitionsToWaitFor field allows specifying multiple partition dependencies.

api/python/ai/chronon/query.py (2)

31-31: New parameter added to support sub-partitions.

This parameter correctly exposes the new Thrift field.


85-95: Improved function call with named parameters.

Converting to named parameters enhances readability.

api/python/ai/chronon/airflow_helpers.py (1)

8-42: Enhanced dependency creation with additional partitions.

Function now supports multiple partition dependencies.

Comment on lines +79 to +81
:param sub_partitions_to_wait_for:
Additional partitions to be used in sensing that the source data has landed. Should be a full partition string, such as `hr=23:00'
:type partition_column: List[str], optional
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix parameter type documentation.

The type annotation references the wrong parameter.

 :param sub_partitions_to_wait_for:
     Additional partitions to be used in sensing that the source data has landed. Should be a full partition string, such as `hr=23:00'
-:type partition_column: List[str], optional
+:type sub_partitions_to_wait_for: List[str], optional
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:param sub_partitions_to_wait_for:
Additional partitions to be used in sensing that the source data has landed. Should be a full partition string, such as `hr=23:00'
:type partition_column: List[str], optional
:param sub_partitions_to_wait_for:
Additional partitions to be used in sensing that the source data has landed. Should be a full partition string, such as `hr=23:00'
:type sub_partitions_to_wait_for: List[str], optional

@david-zlai david-zlai requested a review from tchow-zlai May 8, 2025 04:37
@david-zlai david-zlai merged commit b7b804d into main May 8, 2025
20 checks passed
@david-zlai david-zlai deleted the vz/add_additional_parts_to_gb branch May 8, 2025 17:51
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

Add additional sub partitions to wait for in Query to ultimately compile
into GroupBy and Join

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [x] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added support for specifying additional sub-partitions when defining
data dependencies, allowing for more granular detection of data arrival.
- **Documentation**
- Updated function and parameter documentation to reflect new options
for specifying sub-partitions in queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: ezvz <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

Add additional sub partitions to wait for in Query to ultimately compile
into GroupBy and Join

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [x] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added support for specifying additional sub-partitions when defining
data dependencies, allowing for more granular detection of data arrival.
- **Documentation**
- Updated function and parameter documentation to reflect new options
for specifying sub-partitions in queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: ezvz <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary

Add additional sub partitions to wait for in Query to ultimately compile
into GroupBy and Join

## Cheour clientslist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [x] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added support for specifying additional sub-partitions when defining
data dependencies, allowing for more granular detection of data arrival.
- **Documentation**
- Updated function and parameter documentation to reflect new options
for specifying sub-partitions in queries.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: ezvz <[email protected]>
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.

3 participants