feat: StagingQuery param

[tchow-zlai]

Summary

• Supporting StagingQueries for configurable compute engines. To support BigQuery, the simplest way is to just write bigquery sql and run it on bq to create the final table. Let's first make the API change.

Checklist

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

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Added an option for users to specify the compute engine when processing queries, offering choices such as Spark and BigQuery.
  • Introduced validation to ensure that queries run only with the designated engine.

• Style

  • Streamlined code organization for enhanced readability.
  • Consolidated and reordered import statements for improved clarity.

[coderabbitai]

Walkthrough

This pull request updates the StagingQuery API by adding an engineType parameter (defaulting to EngineType.SPARK) to the apply method and incorporating a corresponding field in the Thrift definition. An EngineType enum with values SPARK and BIGQUERY is introduced, and a runtime check is added in the Spark implementation to ensure only compatible queries are processed. Additionally, import formatting improvements are applied in one of the Spark source files.

Changes

File(s)	Change Summary
api/.../Builders.scala, api/.../api.thrift, spark/.../StagingQuery.scala	Added engineType parameter to StagingQuery (default SPARK), defined EngineType enum (values SPARK and BIGQUERY), and added engine check.
spark/.../TableUtils.scala	Reordered and consolidated import statements for clarity and consistency.

Possibly related PRs

• fix: write to gcs parquet instead of bq native #371: Related to adding an engineType to StagingQuery with similar modifications.
• fix: Do BigQuery indirect writes #357: Involves changes to the StagingQuery struct, introducing an engineType field.
• feat: support Format specific createTable  #261: Introduces an EngineType enum and an engineType field in the StagingQuery struct.

Suggested reviewers

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

Poem

In our code, a new parameter takes flight,
Engines align in the soft morning light.
With SPARK and BIGQUERY in elegant dance,
Our queries now stand enhanced at a glance.
Here's to clean code and upgrades so bright! 🚀✨

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 (3)

spark/src/main/scala/ai/chronon/spark/StagingQuery.scala (3)

48-51: Enhance error message.

Add supported engine types to the error message.

-        s"Engine type ${stagingQueryConf.getEngineType} is not supported for Staging Query")
+        s"Engine type ${stagingQueryConf.getEngineType} is not supported. Use ${EngineType.SPARK} for Staging Query")

---

53-55: Add null check for outputTable.

Validate outputTable before saving.

+      if (outputTable == null) {
+        throw new IllegalArgumentException("Output table name cannot be null")
+      }
       tableUtils.sql(stagingQueryConf.query).saveUnPartitioned(outputTable)

---

97-105: Create custom exception for better error handling.

Define StagingQueryException for clearer error classification.

case class StagingQueryException(messages: Seq[String]) extends Exception(
  messages.zipWithIndex.map { case (msg, idx) => 
    s"[${idx + 1}/${messages.length}] $msg"
  }.mkString("\n")
)

📜 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 2ad3039 and 010b11d.

📒 Files selected for processing (1)

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

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

• GitHub Check: streaming_tests
• GitHub Check: streaming_tests
• GitHub Check: spark_tests
• GitHub Check: join_tests
• GitHub Check: analyzer_tests
• GitHub Check: groupby_tests
• GitHub Check: join_tests
• GitHub Check: analyzer_tests
• GitHub Check: scala_compile_fmt_fix
• GitHub Check: non_spark_tests
• GitHub Check: groupby_tests
• GitHub Check: fetcher_tests
• GitHub Check: fetcher_tests
• GitHub Check: non_spark_tests
• GitHub Check: spark_tests
• GitHub Check: enforce_triggered_workflows
• GitHub Check: enforce_triggered_workflows

🔇 Additional comments (1)

spark/src/main/scala/ai/chronon/spark/StagingQuery.scala (1)

21-21: Clean import changes.

Also applies to: 25-25