-
Notifications
You must be signed in to change notification settings - Fork 105
chore: Re-organize sub-modules to extract the client part from core #149
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
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 @brasseld, 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 focuses on improving the project's modularity by extracting the client-specific parts from the core module. This change aims to facilitate the addition of alternative client implementations in the future without significantly impacting the existing API or requiring major changes to the main README.
Highlights
- Module Reorganization: The core module has been reorganized to separate the client specification (model) from the client implementation. This mirrors the existing structure for the server part.
- New Modules: Two new modules,
a2a-java-sdk-commonanda2a-java-sdk-model, have been introduced to house common utilities and the data model, respectively. - Dependency Updates: Dependencies within the modules have been updated to reflect the new module structure. For example, the
a2a-java-sdk-clientnow depends ona2a-java-sdk-commonanda2a-java-sdk-model. - Package Changes: The package
io.a2a.spechas been moved to themodelmodule, and theio.a2apackage in thecoremodule has been moved to theclientmodule. - Code Modernization: The source and target maven compiler plugins have been updated to Java 21.
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 is currently in preview and 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 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request reorganizes the project's modules for better structure and future extensibility by extracting client, model, and common functionalities from the core module. I've provided suggestions to enhance code quality and maintainability, including documenting the Java version upgrade, removing code duplication, correcting an import, and improving code clarity.
sdk-server-common/src/main/java/io/a2a/server/events/EventConsumer.java
Outdated
Show resolved
Hide resolved
model/src/main/java/io/a2a/spec/ContentTypeNotSupportedError.java
Outdated
Show resolved
Hide resolved
f79e392 to
8389879
Compare
kabir
left a comment
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.
Hi @brasseld thanks for the PR!
I have a few comments mostly about:
- using wildcard imports - we like those to be explicit
- Removing the static import of Utils.OBJECT_MAPPER - this is more of a nit, but at the same time it seems like a pointless change.
I don't think there is much point in keeping the core package just for JSONRPCErrorSerializationTest. Can that test be moved to model/ or client? This might not be in your branch actually, but I see the file there after rebasing on main. So please rebase and you will see what I mean
model/src/main/java/io/a2a/spec/GetTaskPushNotificationConfigRequest.java
Outdated
Show resolved
Hide resolved
sdk-jakarta/src/main/java/io/a2a/server/apps/jakarta/A2ARequestFilter.java
Outdated
Show resolved
Hide resolved
sdk-server-common/src/test/java/io/a2a/server/requesthandlers/JSONRPCHandlerTest.java
Outdated
Show resolved
Hide resolved
tests/server-common/src/test/java/io/a2a/server/apps/common/AbstractA2AServerTest.java
Outdated
Show resolved
Hide resolved
2a2fd3a to
f497213
Compare
kabir
left a comment
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.
Thanks @brasseld I think it looks better now. Sadly there are some conflicts that need to be resolved before we can merge it.
|
Fixed @kabir |
| <dependency> | ||
| <groupId>io.a2a.sdk</groupId> | ||
| <artifactId>a2a-java-sdk-core</artifactId> | ||
| <artifactId>a2a-java-sdk-client</artifactId> |
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.
This should be a2a-java-sdk-spec
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.
In the README, the "Add the A2A Java SDK Core Maven dependency to your project" should be reworded to "Add the A2A Java SDK Spec Maven dependency to your project"
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.
Hum not sure about this one tbh.
Now that we splitted client and server modules, there should be two different imports:
- One for
a2a-java-sdk-clientif you want to use the client part of the SDK - One for
a2a-java-sdk-server-commonif you want to use the server part of the SDK
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.
This part of the README goes through the steps for creating an A2A server agent. In this first step, the a2a-java-sdk-spec dependency needs to be added in order to be able to create the AgentCard producer and AgentExecutor producer. A later step shows how to add the a2a-java-sdk-server-quarkus or a2a-java-sdk-server-jakarta dependency to expose the A2A server endpoint. The client dependency shouldn't be needed for creating a server agent.
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.
I guess the dependency on a2a-java-sdk-server-quarkus or a2a-java-sdk-server-jakarta would also bring in the dependency on a2a-java-sdk-spec. So I guess the question is if we want to be explicit about it or not.
Let's see what @kabir thinks.
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.
I think transitive dependencies are fine in this case.
|
Fixed @fjuma |
| <dependency> | ||
| <groupId>io.a2a.sdk</groupId> | ||
| <artifactId>a2a-java-sdk-core</artifactId> | ||
| <artifactId>a2a-java-sdk-client</artifactId> |
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.
Same here, we also need a dependency on a2a-java-sdk-spec.
d88ecb3 to
3c77069
Compare
…re to ease client extensibility with new implementation
fjuma
left a comment
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.
# 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) Follows up on #149
Description
This PR is made for better organize the different sub-modules, essentially the core one by extracing the specification (the model) from the client, in a similar way as what as been done for the server part.
The goal for this split is to make it easier to provide other client implementation in a near future.
Although code as been spread across new modules, it does not impact the way it is used as the same packages as been kept. Therefore, it does not impact much the main readme
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> 🦕