Skip to content

Cache table permission check #377

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

Closed
wants to merge 2 commits into from

Conversation

david-zlai
Copy link
Contributor

@david-zlai david-zlai commented Feb 14, 2025

Summary

Checklist

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

Summary by CodeRabbit

  • Refactor
    • Improved the internal handling of data during permission checks, resulting in enhanced system efficiency and reliability without affecting the user experience.

nikhil-zlai and others added 2 commits February 13, 2025 00:41
## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



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

- **New Features**
- Enhanced the table creation process to return clear, detailed
statuses, improving feedback during table building.
- Introduced a new method for generating table builders that integrates
with BigQuery, including error handling for partitioning.
- Streamlined data writing operations to cloud storage with automatic
path configuration and Parquet integration.
- Added explicit partitioning for DataFrame saves in Hive, Delta, and
Iceberg formats.
  
- **Refactor**
- Overhauled logic to enforce partition restrictions and incorporate
robust error handling for a smoother user experience.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: tchow-zlai <[email protected]>
Co-authored-by: Thomas Chow <[email protected]>
Copy link

coderabbitai bot commented Feb 14, 2025

Walkthrough

The changes modify the checkTablePermission method in TableUtils.scala. The DataFrame loaded by the spark session is now assigned to a variable (df) and explicitly cached before calling collect(). Error handling and control flow remain the same, with no alterations to the method signature.

Changes

File Change Summary
spark/src/main/scala/ai/chronon/spark/…/TableUtils.scala Modified checkTablePermission: DataFrame is now assigned to df, cached, then collected. Internal logic updated; error handling unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant T as checkTablePermission
    participant S as SparkSession
    participant DF as DataFrame
    U->>T: Invoke checkTablePermission
    T->>S: load(tableName)
    S-->>T: Return DataFrame
    T->>DF: cache()
    T->>DF: collect()
    alt Exception Occurs
        DF-->>T: Throw error
        T->>T: Log error
    end
    T-->>U: Return Boolean
Loading

Poem

⚡ In our code, a spark is caught,
A DataFrame now takes a well-earned spot.
Cached and collected with a graceful shift,
Errors still logged as a steady gift.
Cheers to the flow that gives our code a lift!

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.

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

📜 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 2010a0b and ff48144.

📒 Files selected for processing (1)
  • spark/src/main/scala/ai/chronon/spark/TableUtils.scala (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: spark_tests
  • GitHub Check: enforce_triggered_workflows

Comment on lines +267 to +272
val df = sparkSession.read
.load(DataPointer.from(tableName, sparkSession))
.where(s"$partitionColumn='$partitionFilter'")
.limit(1)
.collect()
df.cache
df.collect()
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Clear the cache after use to prevent memory leaks.

The DataFrame is cached but never uncached, which could lead to memory pressure.

Apply this diff:

-      val df = sparkSession.read
-        .load(DataPointer.from(tableName, sparkSession))
-        .where(s"$partitionColumn='$partitionFilter'")
-        .limit(1)
-      df.cache
-      df.collect()
+      val df = sparkSession.read
+        .load(DataPointer.from(tableName, sparkSession))
+        .where(s"$partitionColumn='$partitionFilter'")
+        .limit(1)
+      try {
+        df.cache()
+        df.collect()
+      } finally {
+        df.unpersist()
+      }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
val df = sparkSession.read
.load(DataPointer.from(tableName, sparkSession))
.where(s"$partitionColumn='$partitionFilter'")
.limit(1)
.collect()
df.cache
df.collect()
val df = sparkSession.read
.load(DataPointer.from(tableName, sparkSession))
.where(s"$partitionColumn='$partitionFilter'")
.limit(1)
try {
df.cache()
df.collect()
} finally {
df.unpersist()
}

.load(DataPointer.from(tableName, sparkSession))
.where(s"$partitionColumn='$partitionFilter'")
.limit(1)
.collect()
df.cache
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's combine with #376

@nikhil-zlai
Copy link
Contributor

i think @tchow-zlai removed them

Copy link
Collaborator

@tchow-zlai tchow-zlai left a comment

Choose a reason for hiding this comment

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

Removed the permissions checks altogether

@david-zlai david-zlai closed this Mar 13, 2025
@david-zlai david-zlai deleted the davidhan/cache_check_table_permission branch May 12, 2025 19:35
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.

3 participants