-
Notifications
You must be signed in to change notification settings - Fork 322
feat: Adding stand-alone support for RESTful API serving #297
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 @pstephengoogle, 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 the capability to serve the A2A RESTful API as a standalone service, offering an alternative to gRPC-based serving with Envoy transcoding. It achieves this by adding new application and request handler components that directly process REST (JSON+HTTP) requests, map them to the core A2A logic, and manage responses, including Server-Sent Events.
Highlights
- Standalone REST API Support: Introduces new
RESTApplicationandA2ARESTFastAPIApplicationclasses to enable serving the A2A RESTful API independently, without reliance on gRPC or Envoy transcoding. - REST Request Handling: Adds a dedicated
RESTHandlerthat maps incoming REST (JSON+HTTP) requests to the appropriate underlying A2A request handler methods, ensuring consistency with existing gRPC service definitions by leveraging protobuf for data serialization/deserialization. - FastAPI Integration: Implements
A2ARESTFastAPIApplicationto build a FastAPI application, providing concrete endpoints for A2A operations such as message sending (including streaming), task retrieval, and push notification management.
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
This pull request introduces stand-alone support for serving the RESTful API. Several critical and high-severity issues concerning attribute access, routing logic, error handling, and type safety were identified.
holtskinner
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.
Can you also add tests for these new handlers?
|
|
||
| def build( | ||
| self, | ||
| agent_card_url: str = '/.well-known/agent.json', |
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.
| agent_card_url: str = '/.well-known/agent.json', | |
| agent_card_url: str = AGENT_CARD_WELL_KNOWN_PATH, |
Also add import:
from a2a.utils.constants import AGENT_CARD_WELL_KNOWN_PATH| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class RESTApplication: |
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.
Should this be called A2ARESTApplication?
| def __init__( | ||
| self, | ||
| agent_card: AgentCard, | ||
| http_handler: RequestHandler, |
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.
nit: this param should be called request_handler, right? As it is the base request handler, there's nothing related to HTTP.
| ) | ||
| return JSONResponse( | ||
| '{"message": ' + error.message + '}', | ||
| status_code=404, |
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 would not be 404. Default value would be 500. But we should check for error and attach 4XX or 5XX HTTP error codes.
|
Not sure why, but this PR seems to have Krishna's persistence store changes as well. |
I think the git history doesn't match up and includes a few of these extra commits. |
|
Merging this PR into restful. As directed by Phil, the improvements as suggested in the comments will be taken up in a subsequent PR. |
# Adding stand-alone support for RESTful API serving Though the RESTful API (JSON+HTTP) can be served from an envoy transcoding of the gRPC service that may not always make sense in all cases. Instead, this PR also adds the ability to serve the RESTful API stand-alone, without needing to also setup the gRPC service. --------- Co-authored-by: Holt Skinner <[email protected]> Co-authored-by: swapydapy <[email protected]>
Adding stand-alone support for RESTful API serving
Though the RESTful API (JSON+HTTP) can be served from an envoy transcoding of the gRPC service that may not always make sense in all cases. Instead, this PR also adds the ability to serve the RESTful API stand-alone, without needing to also setup the gRPC service.