Skip to content

refactor tableutils into its own module catalog #679

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
Apr 21, 2025

Conversation

tchow-zlai
Copy link
Collaborator

@tchow-zlai tchow-zlai commented Apr 21, 2025

Summary

  • Creates a catalog module to replace the format one we had.
  • Add a new bazel lib target for the catalog module
  • Move TableUtils there, it should live alongside the formatprovider stuff.
  • Rename imports
  • Followup is to remove the dependency on the main spark lib. This requires decoupling with Extensions. Then we can drastically slim the deps down in cloud gcp.

Checklist

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

Copy link

coderabbitai bot commented Apr 21, 2025

Walkthrough

This change reorganizes the codebase by moving TableUtils, Format, FormatProvider, DefaultFormatProvider, Iceberg, and related classes from their original packages (such as ai.chronon.spark and ai.chronon.spark.format) into a new subpackage, ai.chronon.spark.catalog. All import statements throughout the project are updated to reference this new package structure. No functional code logic, control flow, or error handling is altered; only import paths and package declarations are changed to reflect this restructuring. Additionally, Bazel build files are updated to include the new catalog library.

Changes

Files/Paths Change Summary
spark/src/main/scala/ai/chronon/spark/catalog/*.scala Changed package declarations from ai.chronon.spark.format or ai.chronon.spark to ai.chronon.spark.catalog.
spark/src/main/scala/ai/chronon/spark/*.scala Updated imports for TableUtils, Format, etc., to use ai.chronon.spark.catalog.
spark/src/main/scala/ai/chronon/spark/batch/*.scala Updated imports for TableUtils to ai.chronon.spark.catalog.TableUtils.
spark/src/main/scala/ai/chronon/spark/stats/*, .../drift/*.scala Updated imports for TableUtils to ai.chronon.spark.catalog.TableUtils.
spark/src/main/scala/ai/chronon/spark/interactive/LocalWarehouse.scala Updated import for TableUtils.
spark/src/main/scala/ai/chronon/spark/utils/*.scala Updated import for TableUtils.
spark/src/main/scala/ai/chronon/spark/scripts/*.scala Updated import for TableUtils.
spark/src/main/scala/ai/chronon/spark/streaming/JoinSourceRunner.scala Split imports: GenericRowHandler from ai.chronon.spark, TableUtils from ai.chronon.spark.catalog.
cloud_aws/src/test/scala/ai/chronon/integrations/aws/*.scala Updated import for TableUtils.
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/*.scala Updated imports for TableUtils, Format, FormatProvider, etc., to ai.chronon.spark.catalog.
cloud_gcp/src/test/scala/ai/chronon/integrations/cloud_gcp/*.scala Updated imports for TableUtils, FormatProvider, Iceberg to new package.
spark/src/test/scala/ai/chronon/spark/test/**/*.scala, *.java Updated imports for TableUtils, FormatProvider, etc., to ai.chronon.spark.catalog.
spark/BUILD.bazel Added new scala_library target catalog_lib for ai.chronon.spark.catalog sources and dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant UserCode
    participant CatalogLib
    participant TableUtils

    UserCode->>CatalogLib: import ai.chronon.spark.catalog.TableUtils
    CatalogLib->>TableUtils: Provide table utility methods
    UserCode->>TableUtils: Call utility methods as before
Loading

Possibly related PRs

Suggested reviewers

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

Poem

In catalog halls, the utils now dwell,
Imports realigned, all is well.
No logic disturbed, just paths anew,
Bazel knows what to do!
From format to catalog, the journey’s complete,
Code rabbits rejoice—refactor is neat!
🐇✨

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

@@ -14,30 +14,28 @@
* limitations under the License.
*/

package ai.chronon.spark
package ai.chronon.spark.catalog
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

adding a new catalog module.

@tchow-zlai tchow-zlai merged commit 5f297bd into main Apr 21, 2025
36 checks passed
@tchow-zlai tchow-zlai deleted the tchow/refactor-tableutils branch April 21, 2025 23:10
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary

- Creates a `catalog` module to replace the `format` one we had. 
- Add a new bazel lib target for the `catalog` module
- Move TableUtils there, it should live alongside the formatprovider
stuff.
- Rename imports
- Followup is to remove the dependency on the main `spark` lib. This
requires decoupling with `Extensions`. Then we can drastically slim the
deps down in cloud gcp.

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


<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":""}
```
-->

Co-authored-by: Thomas Chow <[email protected]>
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## Summary

- Creates a `catalog` module to replace the `format` one we had. 
- Add a new bazel lib target for the `catalog` module
- Move TableUtils there, it should live alongside the formatprovider
stuff.
- Rename imports
- Followup is to remove the dependency on the main `spark` lib. This
requires decoupling with `Extensions`. Then we can drastically slim the
deps down in cloud gcp.

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


<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":""}
```
-->

Co-authored-by: Thomas Chow <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request May 1, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 9, 2025
4 tasks
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

- Creates a `catalog` module to replace the `format` one we had. 
- Add a new bazel lib target for the `catalog` module
- Move TableUtils there, it should live alongside the formatprovider
stuff.
- Rename imports
- Followup is to remove the dependency on the main `spark` lib. This
requires decoupling with `Extensions`. Then we can drastically slim the
deps down in cloud gcp.

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


<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":""}
```
-->

Co-authored-by: Thomas Chow <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

- Creates a `catalog` module to replace the `format` one we had. 
- Add a new bazel lib target for the `catalog` module
- Move TableUtils there, it should live alongside the formatprovider
stuff.
- Rename imports
- Followup is to remove the dependency on the main `spark` lib. This
requires decoupling with `Extensions`. Then we can drastically slim the
deps down in cloud gcp.

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


<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":""}
```
-->

Co-authored-by: Thomas Chow <[email protected]>
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary

- Creates a `catalog` module to replace the `format` one we had. 
- Add a new bazel lib target for the `catalog` module
- Move TableUtils there, it should live alongside the formatprovider
stuff.
- Rename imports
- Followup is to remove the dependency on the main `spark` lib. This
requires decoupling with `Extensions`. Then we can drastically slim the
deps down in cloud gcp.

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


<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to traour clients
the status of staour clientss when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":""}
```
-->

Co-authored-by: Thomas Chow <[email protected]>
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