Add physicalType to NodeKey struct

[sean-zlai]

Summary

Based on Slack discussion

Checklist

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

Summary by CodeRabbit

• New Features
  • Introduced an optional attribute to enhance node classification with more detailed physical characteristics for improved metadata representation.

[coderabbitai]

Walkthrough

The change introduces a new optional field, physicalType, into the NodeKey struct within the api/thrift/orchestration.thrift file. This field is of type PhysicalNodeType, a union that can represent different physical node types such as GroupByNodeType, JoinNodeType, StagingQueryNodeType, ModelNodeType, and TableNodeType. No other changes to existing structures were made.

Changes

File	Change Summary
api/thrift/orchestration.thrift	Added optional field 3: optional PhysicalNodeType physicalType to NodeKey.

Poem

In lines of code a new field blooms,
Adding flair among the node rooms.
physicalType joins the crew,
With varied types to rendezvous.
The code now sings in unioned tune!

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.

---

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

api/thrift/orchestration.thrift (1)

41-52: Addition aligns with architecture.

The new field creates symmetry with PhysicalNodeKey and supports the documented N:1 relationship between logical and physical nodes.

Also applies to: 153-155

📜 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 9c9bee2 and 70dbc23.

📒 Files selected for processing (1)

• api/thrift/orchestration.thrift (1 hunks)

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

• GitHub Check: non_spark_tests
• GitHub Check: enforce_triggered_workflows

🔇 Additional comments (2)

api/thrift/orchestration.thrift (2)

45-45: LGTM! Field addition is well-placed.

The new optional field follows logical sequencing and uses appropriate modifiers.

---

142-148: Verify backward compatibility.

The change is backward compatible as it:

1. Uses optional field
2. Reuses existing PhysicalNodeType union
3. Follows Thrift field numbering