-
Notifications
You must be signed in to change notification settings - Fork 3
Backport to branch(3) : Add ClientService and CLI for Table Store #235
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
Conversation
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @feeblefakie, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces significant new client-side capabilities for the Table Store, focusing on both programmatic interaction and command-line utility. It adds a dedicated ClientService
and its factory to streamline API calls to the Table Store. Concurrently, a new set of CLI tools are provided, enabling users to perform key operations like contract registration, statement execution, and ledger validation directly from the command line. These changes aim to improve the usability and accessibility of the Table Store by offering robust client-side interfaces and tools.
Highlights
- New Table Store Client Service: A new
ClientService
andClientServiceFactory
have been introduced, providing a programmatic interface for interacting with the Table Store. This includes functionalities for registering certificates/secrets, registering predefined contracts, executing PartiQL statements, and validating ledger data. - New Table Store Command Line Interface (CLI): A comprehensive Command Line Interface (CLI) for the Table Store has been developed. This CLI includes dedicated tools for registering contracts (
ContractsRegistration
), executing PartiQL statements (StatementExecution
), and validating ledger assets (LedgerValidation
), all accessible via the mainTableStoreCommandLine
entry point. - Expanded Table Store Contract Functionality: New contract types,
CONTRACT_SHOW_TABLES
andCONTRACT_GET_HISTORY
, have been added to the generic contracts for the Table Store, expanding the range of operations that can be performed. - Refactoring and Improved Modularity: Common client utilities and test fixtures have been refactored and moved to
testFixtures
to improve modularity and reusability across different modules, particularly for testing the new CLI tools. - Enhanced Error Handling: Error handling has been enhanced with the addition of new error codes, such as
CLASS_FILE_LOAD_FAILED
andMULTIPLE_STATEMENTS_NOT_SUPPORTED
, providing more specific feedback for various operational issues.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request backports the addition of a ClientService
and a Command Line Interface (CLI) for a new Table Store feature. The changes are extensive, introducing new services, models, CLI tools using picocli, and associated tests. The overall architecture is well-thought-out, with a good separation of concerns. The code quality is high, demonstrating good practices like immutability and proper exception handling in most cases. I have one suggestion to improve exception consistency in one of the utility methods.
throw new RuntimeException( | ||
ClientError.CLASS_FILE_LOAD_FAILED.buildMessage(clazz.getName()), e); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better consistency and error handling, it's preferable to throw a ClientException
here instead of a generic RuntimeException
. The rest of the client code, including the fileToBytes
method in this same class, uses ClientException
for expected error conditions. This allows callers to handle specific errors more gracefully rather than catching a broad RuntimeException
.
throw new ClientException(ClientError.CLASS_FILE_LOAD_FAILED, e, clazz.getName());
This is an automated backport of the following:
Please merge this PR after all checks have passed.