fix: Deserialize Node thrift ZIP-774

[tchow-zlai]

Summary

• Complement to https://github.com/zipline-ai/platform/pull/133 need to thrift deserialize the Node object whihc contains acurate metadata.

Checklist

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

Summary by CodeRabbit

• Refactor
  • Streamlined configuration loading by consolidating metadata and content retrieval into a single step, improving internal processing without impacting user experience.

[coderabbitai]

Walkthrough

The change removes the loadNodeContent method from both BatchNodeRunner and KVUploadNodeRunner. Both now load the entire Node object directly from JSON, accessing metadata and content fields from the deserialized Node. Logging and method calls are updated accordingly to use the new structure.

Changes

File	Change Summary
spark/src/main/scala/ai/chronon/spark/batch/BatchNodeRunner.scala	Removed loadNodeContent; now loads Node directly from JSON; updated references and logging to use node.metaData.
spark/src/main/scala/ai/chronon/spark/kv_store/KVUploadNodeRunner.scala	Refactored runFromArgs to load Node directly; removed loadNodeContent and extractMetadata; updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BatchNodeRunner
    participant KVUploadNodeRunner
    participant ThriftJsonCodec

    User->>BatchNodeRunner: runFromArgs(confPath)
    BatchNodeRunner->>ThriftJsonCodec: fromJsonFile[Node](confPath)
    ThriftJsonCodec-->>BatchNodeRunner: Node object
    BatchNodeRunner->>BatchNodeRunner: Use node.metaData, node.content
    BatchNodeRunner->>User: Run batch node

    User->>KVUploadNodeRunner: runFromArgs(confPath, endDs, onlineClass, props)
    KVUploadNodeRunner->>ThriftJsonCodec: fromJsonFile[Node](confPath)
    ThriftJsonCodec-->>KVUploadNodeRunner: Node object
    KVUploadNodeRunner->>KVUploadNodeRunner: Use node.metaData, node.content
    KVUploadNodeRunner->>KVUploadNodeRunner: run(metadata, content, partitionRange)
    KVUploadNodeRunner->>User: Complete run

Loading

Possibly related PRs

• Add a node runner for upload to kv and join metadata upload nodes #956: Similar simplification of node loading by deserializing Node directly in both runners.
• feat: batch node runner #870: Earlier refactor of BatchNodeRunner's run interface related to metadata and content handling.
• feat: use NodeContent on the BatchNodeRunner side #900: Alternative approach to simplifying loadNodeContent in BatchNodeRunner.

Suggested reviewers

• varant-zlai
• piyush-zlai
• david-zlai

Poem

Gone the method, neat and clean,
Nodes now load as one machine.
Metadata and content blend,
Simpler code from start to end.
Runner’s path now smooth and bright,
JSON shines with pure delight!
✨🐇🚀

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1067727 and 65cd7f1.

📒 Files selected for processing (1)

• spark/src/main/scala/ai/chronon/spark/batch/BatchNodeRunner.scala (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• spark/src/main/scala/ai/chronon/spark/batch/BatchNodeRunner.scala

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: streaming_tests
• GitHub Check: batch_tests
• GitHub Check: analyzer_tests
• GitHub Check: join_tests
• GitHub Check: groupby_tests
• GitHub Check: fetcher_tests
• GitHub Check: spark_tests
• GitHub Check: scala_compile_fmt_fix
• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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 docstrings to generate docstrings for this 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.