Skip to content

Yank out Bigtable hbase dependency for one ApiFutureUtils class #184

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 2 commits into from
Jan 9, 2025

Conversation

piyush-zlai
Copy link
Contributor

@piyush-zlai piyush-zlai commented Jan 8, 2025

Summary

Been working through a number of issues trying to successfully run Flink jobs on our DataProc cluster due to class / version conflicts. A number of these seem to stem from this library that brings in a lot of dependencies like hadoop ipc libs etc. We pulled in this lib for one class (ApiFutureUtils) that allows us to convert from BigTable's ApiFuture to Java's ListenableFutures. I've chosen to fork this class and yank out the lib dependency.

Checklist

  • Added Unit Tests
  • Covered by existing CI - Our bigTableKVStoreTest runs tests for the various async apis which leverage this class
  • Integration tested
  • Documentation update

Summary by CodeRabbit

Release Notes

  • Dependency Management

    • Removed Google Cloud Bigtable HBase library dependency from project configuration
  • New Features

    • Added utility method to convert Google Cloud API futures to Java CompletableFutures
  • Refactor

    • Removed specific Bigtable API utility import from implementation

Copy link

coderabbitai bot commented Jan 8, 2025

Walkthrough

This pull request involves removing the Google Cloud Bigtable HBase library dependency from the build.sbt file and introducing a new utility object ApiFutureUtils in the cloud_gcp project. The changes suggest a refactoring of how Bigtable-related asynchronous operations are handled, with a custom implementation for converting API futures to completable futures.

Changes

File Change Summary
build.sbt Removed Bigtable HBase library dependency "com.google.cloud.bigtable" % "bigtable-hbase-2.x" % "2.14.2"
cloud_gcp/.../ApiFutureUtils.scala Added new utility object with toCompletableFuture method for converting ApiFuture to CompletableFuture
cloud_gcp/.../BigTableKVStoreImpl.scala Removed import for com.google.cloud.bigtable.hbase2_x.ApiFutureUtils

Sequence Diagram

sequenceDiagram
    participant Client
    participant ApiFutureUtils
    participant ApiFuture
    participant CompletableFuture
    
    Client->>ApiFutureUtils: toCompletableFuture(apiFuture)
    ApiFutureUtils->>CompletableFuture: Create new instance
    ApiFutureUtils->>ApiFuture: Add callback
    ApiFuture-->>CompletableFuture: Complete with result/error
Loading

Possibly related PRs

Suggested reviewers

  • nikhil-zlai
  • tchow-zlai

Poem

🌐 Bigtable's dance, a library's last stance,
Futures transformed with coding's new glance,
Dependency stripped, utility born bright,
In cloud's embrace, a refactored delight! 🚀

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.


🪧 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: 0

🧹 Nitpick comments (1)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/ApiFutureUtils.scala (1)

13-32: Consider adding safety checks and documentation.

  1. Add null check for apiFuture
  2. Document thread safety implications of directExecutor
 object ApiFutureUtils {
+  /** Converts Google Cloud ApiFuture to CompletableFuture.
+   * Note: Callbacks execute in the same thread using directExecutor.
+   * @throws NullPointerException if apiFuture is null
+   */
   def toCompletableFuture[T](apiFuture: ApiFuture[T]): CompletableFuture[T] = {
+    if (apiFuture == null) throw new NullPointerException("apiFuture must not be null")
     val completableFuture: CompletableFuture[T] = new CompletableFuture[T]() {
📜 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 db26196 and 953f40c.

📒 Files selected for processing (3)
  • build.sbt (0 hunks)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/ApiFutureUtils.scala (1 hunks)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigTableKVStoreImpl.scala (0 hunks)
💤 Files with no reviewable changes (2)
  • cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/BigTableKVStoreImpl.scala
  • build.sbt
⏰ 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: fetcher_spark_tests
  • GitHub Check: join_spark_tests
  • GitHub Check: no_spark_scala_tests
  • GitHub Check: scala_compile_fmt_fix
  • GitHub Check: mutation_spark_tests
🔇 Additional comments (3)
cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/ApiFutureUtils.scala (3)

1-9: LGTM! Clean and well-organized imports.


10-11: Clear explanation of the fork's purpose.


13-32: Implementation looks correct.

Clean conversion between future types with proper error handling.

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.

🥳

@piyush-zlai piyush-zlai merged commit 30eee10 into main Jan 9, 2025
10 checks passed
@piyush-zlai piyush-zlai deleted the piyush/bigtable_hbase_yank branch January 9, 2025 02:47
tchow-zlai pushed a commit that referenced this pull request Jan 9, 2025
## Summary
Been working through a number of issues trying to successfully run Flink
jobs on our DataProc cluster due to class / version conflicts. A number
of these seem to stem from this library that brings in a lot of
dependencies like hadoop ipc libs etc. We pulled in this lib for one
class (ApiFutureUtils) that allows us to convert from BigTable's
ApiFuture to Java's ListenableFutures. I've chosen to fork this class
and yank out the lib dependency.

## Checklist
- [ ] Added Unit Tests
- [X] Covered by existing CI - Our bigTableKVStoreTest runs tests for
the various async apis which leverage this class
- [ ] Integration tested
- [ ] Documentation update



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

## Summary by CodeRabbit

## Release Notes

- **Dependency Management**
- Removed Google Cloud Bigtable HBase library dependency from project
configuration

- **New Features**
- Added utility method to convert Google Cloud API futures to Java
CompletableFutures

- **Refactor**
  - Removed specific Bigtable API utility import from implementation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Thomas Chow <[email protected]>
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary
Been working through a number of issues trying to successfully run Flink
jobs on our DataProc cluster due to class / version conflicts. A number
of these seem to stem from this library that brings in a lot of
dependencies like hadoop ipc libs etc. We pulled in this lib for one
class (ApiFutureUtils) that allows us to convert from BigTable's
ApiFuture to Java's ListenableFutures. I've chosen to fork this class
and yank out the lib dependency.

## Checklist
- [ ] Added Unit Tests
- [X] Covered by existing CI - Our bigTableKVStoreTest runs tests for
the various async apis which leverage this class
- [ ] Integration tested
- [ ] Documentation update



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

## Summary by CodeRabbit

## Release Notes

- **Dependency Management**
- Removed Google Cloud Bigtable HBase library dependency from project
configuration

- **New Features**
- Added utility method to convert Google Cloud API futures to Java
CompletableFutures

- **Refactor**
  - Removed specific Bigtable API utility import from implementation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## Summary
Been working through a number of issues trying to successfully run Flink
jobs on our DataProc cluster due to class / version conflicts. A number
of these seem to stem from this library that brings in a lot of
dependencies like hadoop ipc libs etc. We pulled in this lib for one
class (ApiFutureUtils) that allows us to convert from BigTable's
ApiFuture to Java's ListenableFutures. I've chosen to fork this class
and yank out the lib dependency.

## Checklist
- [ ] Added Unit Tests
- [X] Covered by existing CI - Our bigTableKVStoreTest runs tests for
the various async apis which leverage this class
- [ ] Integration tested
- [ ] Documentation update



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

## Summary by CodeRabbit

## Release Notes

- **Dependency Management**
- Removed Google Cloud Bigtable HBase library dependency from project
configuration

- **New Features**
- Added utility method to convert Google Cloud API futures to Java
CompletableFutures

- **Refactor**
  - Removed specific Bigtable API utility import from implementation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary
Been working through a number of issues trying to successfully run Flink
jobs on our DataProc cluster due to class / version conflicts. A number
of these seem to stem from this library that brings in a lot of
dependencies like hadoop ipc libs etc. We pulled in this lib for one
class (ApiFutureUtils) that allows us to convert from BigTable's
ApiFuture to Java's ListenableFutures. I've chosen to fork this class
and yank out the lib dependency.

## Checklist
- [ ] Added Unit Tests
- [X] Covered by existing CI - Our bigTableKVStoreTest runs tests for
the various async apis which leverage this class
- [ ] Integration tested
- [ ] Documentation update



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

## Summary by CodeRabbit

## Release Notes

- **Dependency Management**
- Removed Google Cloud Bigtable HBase library dependency from project
configuration

- **New Features**
- Added utility method to convert Google Cloud API futures to Java
CompletableFutures

- **Refactor**
  - Removed specific Bigtable API utility import from implementation

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary
Been working through a number of issues trying to successfully run Flink
jobs on our DataProc cluster due to class / version conflicts. A number
of these seem to stem from this library that brings in a lot of
dependencies like hadoop ipc libs etc. We pulled in this lib for one
class (ApiFutureUtils) that allows us to convert from BigTable's
ApiFuture to Java's ListenableFutures. I've chosen to fork this class
and yank out the lib dependency.

## Cheour clientslist
- [ ] Added Unit Tests
- [X] Covered by existing CI - Our bigTableKVStoreTest runs tests for
the various async apis which leverage this class
- [ ] Integration tested
- [ ] Documentation update



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

## Summary by CodeRabbit

## Release Notes

- **Dependency Management**
- Removed Google Cloud Bigtable HBase library dependency from project
configuration

- **New Features**
- Added utility method to convert Google Cloud API futures to Java
CompletableFutures

- **Refactor**
  - Removed specific Bigtable API utility import from implementation

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

3 participants