fix(sdk): fork extension to prevent leaking data#1066
Conversation
Signed-off-by: Radek Ježek <radek.jezek@ibm.com>
There was a problem hiding this comment.
Summary of Changes
Hello @jezekra1, 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 addresses a critical issue within the SDK's extension mechanism by ensuring proper data isolation. The core change involves modifying the BaseExtension class to prevent data leakage between requests. This is achieved by introducing a mechanism to create a fresh, isolated instance of an extension for each incoming request, rather than reusing a single instance. A new end-to-end test has also been added to validate this behavior, confirming that data remains distinct and secure across concurrent operations.
Highlights
- Enhanced Constructor: The
BaseExtensionclass's__init__method now accepts and stores*argsand**kwargs, enabling the preservation of initial configuration for new instances. - Instance Forking Mechanism: A new
_forkmethod has been added toBaseExtension, allowing the creation of a new, identical instance of the extension. This is crucial for ensuring that each request is processed by a fresh, isolated object. - Request Isolation: The
__call__method ofBaseExtensionhas been updated to utilize the new_forkmethod. This ensures that every time an extension is invoked for a request, a new instance is created, preventing data from one request from affecting subsequent ones. - New E2E Test for Isolation: A new end-to-end test,
test_extension_is_not_reused, has been added to explicitly verify that extension instances are not inadvertently reused across multiple concurrent requests, confirming the effectiveness of the data isolation fix.
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.
Code Review
This pull request effectively addresses a critical data leakage vulnerability in BaseExtensionServer that could occur during concurrent request processing. The introduction of a _fork method to create request-specific instances is a robust solution. The accompanying end-to-end test successfully validates this fix by simulating concurrent requests. My review includes a couple of minor suggestions for the new test file to improve its robustness and maintainability.
| async def chunked_artifact_producer( | ||
| llm_ext: Annotated[LLMServiceExtensionServer, LLMServiceExtensionSpec.single_demand()], | ||
| ) -> AsyncGenerator[RunYield, Message]: | ||
| # Agent producing chunked artifacts | ||
| await asyncio.sleep(random() * 0.5) | ||
| api_key = next(iter(llm_ext.data.llm_fulfillments.values())).api_key | ||
| yield api_key | ||
|
|
||
| async with create_server_with_agent(chunked_artifact_producer) as (server, test_client): |
There was a problem hiding this comment.
The agent function is named chunked_artifact_producer and its docstring says "Agent producing chunked artifacts", but it actually just extracts an API key and yields it. This is misleading and harms maintainability. The name and docstring should be updated to reflect its actual behavior.
| async def chunked_artifact_producer( | |
| llm_ext: Annotated[LLMServiceExtensionServer, LLMServiceExtensionSpec.single_demand()], | |
| ) -> AsyncGenerator[RunYield, Message]: | |
| # Agent producing chunked artifacts | |
| await asyncio.sleep(random() * 0.5) | |
| api_key = next(iter(llm_ext.data.llm_fulfillments.values())).api_key | |
| yield api_key | |
| async with create_server_with_agent(chunked_artifact_producer) as (server, test_client): | |
| async def api_key_producer( | |
| llm_ext: Annotated[LLMServiceExtensionServer, LLMServiceExtensionSpec.single_demand()], | |
| ) -> AsyncGenerator[RunYield, Message]: | |
| # Agent producing an api_key from the extension | |
| await asyncio.sleep(random() * 0.5) | |
| api_key = next(iter(llm_ext.data.llm_fulfillments.values())).api_key | |
| yield api_key | |
| async with create_server_with_agent(api_key_producer) as (server, test_client): |
No description provided.