chore!: refactor split the transports into different packages #214
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @kabir, 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 performs a significant architectural refactoring of the project's modular structure. The primary goal is to improve the organization and maintainability of the codebase by isolating transport-specific implementations (gRPC and JSON-RPC) into their own dedicated Maven modules. This also includes a reorganization of the reference server implementations and a refinement of the gRPC specification module.
Highlights
- Restructuring Reference Implementations: The reference server implementations for gRPC and JSON-RPC have been reorganized under a new
reference/parent directory, now residing inreference/grpcandreference/jsonrpc. - Refined gRPC Specification Module: A new
spec-grpcmodule has been introduced, likely to contain gRPC-specific interfaces or definitions, further separating them from the core gRPC transport logic. - Dependency and Package Updates: Numerous
pom.xmlfiles and Java source files have been updated to reflect the new module names, artifact IDs, and package structures across the codebase. - Test Infrastructure Improvements: The
sdk-server-commonmodule now produces atest-jarto share common test utilities, and test classes have been updated to use JUnit 5Assertionsand adjusted field visibility for better test inheritance.
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 or fill out our survey to provide feedback.
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.
Code Review
This pull request is a significant and well-executed refactoring that splits the transport-specific logic for gRPC and JSON-RPC into separate modules. This greatly improves the project's structure, modularity, and separation of concerns. The new module organization is much clearer and more logical. The changes are consistent across all modified files. I've added a couple of minor comments for code cleanup, but overall, this is a fantastic improvement.
| <artifactId>grpc-testing</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> |
There was a problem hiding this comment.
It's a good practice to end files with a newline character. This file is missing one, which can cause issues with some tools and file concatenation.
transport/grpc/pom.xml
Outdated
| <!-- | ||
| <dependency> | ||
| <groupId>jakarta.ws.rs</groupId> | ||
| <artifactId>jakarta.ws.rs-api</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> |
There was a problem hiding this comment.
This dependency is commented out. To keep the pom.xml clean and avoid confusion, it's best to remove any commented-out code that is no longer needed.
pom.xml
Outdated
| <module>examples/helloworld</module> | ||
| <module>reference/grpc</module> | ||
| <module>reference/jsonrpc</module> | ||
| <module>sdk-server-common</module> |
There was a problem hiding this comment.
Would it make sense to rename sdk-server-common to just server-common to match the format being used for the other modules?
| <dependency> | ||
| <groupId>io.github.a2asdk</groupId> | ||
| <artifactId>a2a-java-reference-server</artifactId> | ||
| <artifactId>a2a-java-sdk-reference-jsonrpc</artifactId> |
There was a problem hiding this comment.
It would be good to add something about the grpc dep to the README too. That could be addressed in a follow-up issue instead though.
|
@fjuma I think I've addressed all your points and Gemini's. Also added a few more commits to clean up some things after rebasing on main |
…ject#214) # Description Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [x] Follow the [`CONTRIBUTING` Guide](../CONTRIBUTING.md). - [x] Make your Pull Request title in the <https://www.conventionalcommits.org/> specification. - Important Prefixes for [release-please](https://github.com/googleapis/release-please): - `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/) patch. - `feat:` represents a new feature, and correlates to a SemVer minor. - `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change (indicated by the `!`) and will result in a SemVer major. - [x] Ensure the tests pass - [x] Appropriate READMEs were updated (if necessary) Fixes #<issue_number_goes_here> 🦕
2 participants
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.fix:which represents bug fixes, and correlates to a SemVer patch.feat:represents a new feature, and correlates to a SemVer minor.feat!:, orfix!:,refactor!:, etc., which represent a breaking change (indicated by the!) and will result in a SemVer major.Fixes #<issue_number_goes_here> 🦕