Skip to content

eval query support and a few fixes #258

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 1 commit into from
Jan 22, 2025
Merged

Conversation

nikhil-zlai
Copy link
Contributor

@nikhil-zlai nikhil-zlai commented Jan 22, 2025

Summary

eval("select ... from ... where ...") is now supported. easier for exploration.

Checklist

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

Summary by CodeRabbit

  • Documentation

    • Updated setup instructions for Chronon Python interactive runner
    • Modified environment variable paths and gateway service instructions
  • New Features

    • Added ability to specify result limit when evaluating queries
    • Enhanced SQL query evaluation with error handling
  • Bug Fixes

    • Simplified interactive usage example
    • Updated Spark session method in DataFrame creation

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces enhancements to Chronon's interactive runner, focusing on updating documentation, improving the eval function, and adding a new evalQuery method in the Evaluator class. The changes streamline the setup process, provide more flexible query evaluation, and add better error handling for SQL query execution. The modifications aim to make the interactive runner more user-friendly and robust.

Changes

File Change Summary
api/py/ai/chronon/repo/interactive.md - Updated CHRONON_ROOT environment variable path
- Added CHRONON_SPARK_JAR environment variable instruction
- Simplified gateway service startup command
- Refined interactive usage example
api/py/ai/chronon/repo/interactive.py - Added limit parameter to eval function (default 5)
- Improved error handling for unsupported object types
- Updated DataFrame session retrieval method
spark/src/main/scala/ai/chronon/spark/interactive/Evaluator.scala - Added new evalQuery method
- Supports SQL query execution with result limit
- Implements error handling for query execution

Sequence Diagram

sequenceDiagram
    participant User
    participant Interactive as Interactive Runner
    participant Evaluator
    participant Spark

    User->>Interactive: eval(source, limit=5)
    Interactive->>Evaluator: evalQuery(source, limit)
    Evaluator->>Spark: Execute SQL Query
    Spark-->>Evaluator: Return DataFrame
    Evaluator-->>Interactive: Return Evaluation Result
    Interactive-->>User: Display Results
Loading

Possibly related PRs

Suggested reviewers

  • piyush-zlai
  • chewy-zlai
  • david-zlai

Poem

🚀 Code flows like a river's might,
Chronon's runner, now burning bright
Limits set, queries dance with grace
Interactive magic leaves no trace
Simplicity wins the coding fight! 🌟

Warning

Review ran into problems

🔥 Problems

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

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

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: 1

🧹 Nitpick comments (4)
api/py/ai/chronon/repo/interactive.py (1)

44-46: Add type hints

-def eval(obj, limit=5):
+def eval(obj: Union[str, thrift.Source, thrift.GroupBy, thrift.Join, thrift.StagingQuery, thrift.Model], limit: int = 5):
api/py/ai/chronon/repo/interactive.md (3)

25-25: Use placeholder paths in documentation

Replace hard-coded paths with placeholders like <SPARK_HOME> and <CHRONON_ROOT>.

Also applies to: 31-31


29-32: Add language specifier to code block

Add 'bash' or 'shell' to the code block fence.

🧰 Tools
🪛 Markdownlint (0.37.0)

29-29: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


46-46: Fix typographical error

Replace .. with .

🧰 Tools
🪛 LanguageTool

[typographical] ~46-~46: Two consecutive dots
Context: ... objects in vscode in a notebook like so.. ```py # import source, I do this by r...

(DOUBLE_PUNCTUATION)

📜 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 e805fcb and c5ccf64.

📒 Files selected for processing (3)
  • api/py/ai/chronon/repo/interactive.md (1 hunks)
  • api/py/ai/chronon/repo/interactive.py (4 hunks)
  • spark/src/main/scala/ai/chronon/spark/interactive/Evaluator.scala (1 hunks)
🧰 Additional context used
🪛 LanguageTool
api/py/ai/chronon/repo/interactive.md

[typographical] ~46-~46: Two consecutive dots
Context: ... objects in vscode in a notebook like so.. ```py # import source, I do this by r...

(DOUBLE_PUNCTUATION)

🪛 Markdownlint (0.37.0)
api/py/ai/chronon/repo/interactive.md

29-29: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


40-40: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: table_utils_delta_format_spark_tests
  • GitHub Check: other_spark_tests
  • GitHub Check: mutation_spark_tests
  • GitHub Check: fetcher_spark_tests
  • GitHub Check: no_spark_scala_tests
  • GitHub Check: join_spark_tests
  • GitHub Check: scala_compile_fmt_fix
🔇 Additional comments (2)
api/py/ai/chronon/repo/interactive.py (1)

64-64: LGTM! Modern SparkSession usage

spark/src/main/scala/ai/chronon/spark/interactive/Evaluator.scala (1)

36-48: ⚠️ Potential issue

Protect against SQL injection

Direct string execution is unsafe. Consider using prepared statements or query parameters.

@@ -4,7 +4,7 @@
import ai.chronon.api.ttypes as thrift


def eval(obj):
def eval(obj, limit=5):
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add input validation for limit parameter

 def eval(obj, limit=5):
+    if not isinstance(limit, int) or limit <= 0:
+        raise ValueError("limit must be a positive integer")

Also applies to: 25-25

@nikhil-zlai nikhil-zlai merged commit cf70119 into main Jan 22, 2025
11 checks passed
@nikhil-zlai nikhil-zlai deleted the evaluator_query_support branch January 22, 2025 18:22
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary
eval("select ... from ... where ...") is now supported. easier for
exploration.

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



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

## Summary by CodeRabbit

- **Documentation**
	- Updated setup instructions for Chronon Python interactive runner
	- Modified environment variable paths and gateway service instructions

- **New Features**
	- Added ability to specify result limit when evaluating queries
	- Enhanced SQL query evaluation with error handling

- **Bug Fixes**
	- Simplified interactive usage example
	- Updated Spark session method in DataFrame creation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## Summary
eval("select ... from ... where ...") is now supported. easier for
exploration.

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



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

## Summary by CodeRabbit

- **Documentation**
	- Updated setup instructions for Chronon Python interactive runner
	- Modified environment variable paths and gateway service instructions

- **New Features**
	- Added ability to specify result limit when evaluating queries
	- Enhanced SQL query evaluation with error handling

- **Bug Fixes**
	- Simplified interactive usage example
	- Updated Spark session method in DataFrame creation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary
eval("select ... from ... where ...") is now supported. easier for
exploration.

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



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

## Summary by CodeRabbit

- **Documentation**
	- Updated setup instructions for Chronon Python interactive runner
	- Modified environment variable paths and gateway service instructions

- **New Features**
	- Added ability to specify result limit when evaluating queries
	- Enhanced SQL query evaluation with error handling

- **Bug Fixes**
	- Simplified interactive usage example
	- Updated Spark session method in DataFrame creation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary
eval("select ... from ... where ...") is now supported. easier for
exploration.

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



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

## Summary by CodeRabbit

- **Documentation**
	- Updated setup instructions for Chronon Python interactive runner
	- Modified environment variable paths and gateway service instructions

- **New Features**
	- Added ability to specify result limit when evaluating queries
	- Enhanced SQL query evaluation with error handling

- **Bug Fixes**
	- Simplified interactive usage example
	- Updated Spark session method in DataFrame creation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary
eval("select ... from ... where ...") is now supported. easier for
exploration.

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



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

## Summary by CodeRabbit

- **Documentation**
	- Updated setup instructions for Chronon Python interactive runner
	- Modified environment variable paths and gateway service instructions

- **New Features**
	- Added ability to specify result limit when evaluating queries
	- Enhanced SQL query evaluation with error handling

- **Bug Fixes**
	- Simplified interactive usage example
	- Updated Spark session method in DataFrame creation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.

2 participants