Move common table info from TableDependency to a separate struct

[kumar-zlai]

Summary

Minor refactor to move common table info from TableDependency to a separate struct so that we can associate it to a node in the orchestrator.

Checklist

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

Summary by CodeRabbit

• Refactor
  • Improved the handling of table dependency information by consolidating table metadata into a dedicated structure.
  • Adjusted various data workflows to integrate the updated dependency management approach, enhancing consistency and reliability.

[coderabbitai]

Walkthrough

The pull request refactors the data model in api/thrift/common.thrift by removing the old TableDependency struct and introducing a new TableInfo struct. The redefined TableDependency now references TableInfo and preserves its offset and cutoff fields. Additionally, ExecutionInfo is updated with an optional outputTableInfo. Corresponding Scala files (JoinBackfill.scala, StagingQueryNode.scala, and DependencyResolver.scala) are modified to set table properties via the nested tableInfo object instead of directly modifying the TableDependency instance.

Changes

File(s)	Change Summary
api/thrift/common.thrift	Removed the original TableDependency struct, added new TableInfo struct, redefined TableDependency to include an optional tableInfo, and updated ExecutionInfo with an optional outputTableInfo.
orchestration/.../JoinBackfill.scala, orchestration/.../StagingQueryNode.scala, orchestration/.../DependencyResolver.scala	Updated property assignments to use the nested tableInfo (e.g., setting cumulative status and table name) instead of direct modifications on TableDependency.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Scala Function
    participant TD as TableDependency
    participant TI as TableInfo
    Client->>TD: Create dependency instance
    TD->>TI: Access nested tableInfo
    Client->>TI: Set table name & cumulative flag

Loading

Possibly related PRs

• table metadata #442: Refactors TableDependency structure similar to these changes with a focus on the tableInfo encapsulation.
• feat: read and write date types #192: Involves restructuring to update property access via tableInfo, directly aligning with the modifications here.
• Drop Spark BigTable version to unlock DataProc submission #167: Updates the TableDependency struct's property handling, reflecting a similar design shift for nested encapsulation.

Suggested reviewers

• nikhil-zlai
• piyush-zlai
• varant-zlai

Poem

In refactored code we trust,
New structs emerge from dust.
TableInfo now leads the way,
Guiding data through the fray.
A code dance ✨ in every byte!
Enjoy the shift with pure delight.

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: 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.

---

📜 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 36a32cb and 0fadb96.

📒 Files selected for processing (4)

• api/thrift/common.thrift (3 hunks)
• orchestration/src/main/scala/ai/chronon/orchestration/physical/JoinBackfill.scala (1 hunks)
• orchestration/src/main/scala/ai/chronon/orchestration/physical/StagingQueryNode.scala (1 hunks)
• orchestration/src/main/scala/ai/chronon/orchestration/utils/DependencyResolver.scala (2 hunks)

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

• GitHub Check: non_spark_tests
• GitHub Check: non_spark_tests
• GitHub Check: scala_compile_fmt_fix

🔇 Additional comments (7)

api/thrift/common.thrift (3)

66-80: Clean separation of table metadata.

New TableInfo struct effectively isolates common table properties from dependency-specific fields.

---

82-96: Refactored TableDependency with proper encapsulation.

TableDependency now references TableInfo while maintaining its offset and cutoff fields, improving separation of concerns.

---

133-133: Appropriate addition to ExecutionInfo.

Adding outputTableInfo field to ExecutionInfo aligns with the refactoring goals.

orchestration/src/main/scala/ai/chronon/orchestration/physical/JoinBackfill.scala (1)

37-38: Updated property access through tableInfo.

Correctly using the encapsulated tableInfo object for setting properties.

orchestration/src/main/scala/ai/chronon/orchestration/physical/StagingQueryNode.scala (1)

26-27: Updated property access through tableInfo.

Correctly using the encapsulated tableInfo object for setting properties.

orchestration/src/main/scala/ai/chronon/orchestration/utils/DependencyResolver.scala (2)

62-63: Updated property access through tableInfo.

Correctly using the encapsulated tableInfo object for setting properties.

---

90-90: Updated condition check using tableInfo.

Property access through tableInfo object is consistent with the refactoring.

---

🪧 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.