-
Notifications
You must be signed in to change notification settings - Fork 114
Handling unknown enum values #807
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
@gemini-code-assist
gemini-code-assist
bot
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.
Summary of Changes
Hello @gcatanese, 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 significantly improves the resilience of the SDK's deserialization process by changing how unknown enum values are handled. Instead of throwing an exception and failing, the system will now log a warning, allowing for graceful degradation and continued operation when new enum values are introduced in API responses. This change was propagated across various API models through updated code generation templates.
Highlights
- Improved Enum Deserialization Robustness: The primary change in this pull request is to enhance the robustness of enum deserialization. Previously, encountering an unknown enum value in a JSON payload would lead to an
InvalidArgumentException, halting the process. This PR modifies the behavior to instead log a warning, allowing the application to continue processing data even if new enum values are introduced in API responses or webhooks. - Template-Driven Code Generation Update: The core logic change was implemented by updating the Mustache templates used for code generation. This ensures that all generated model files across various Adyen APIs (Balance Platform, Checkout, Legal Entity Management, Payments, and Transfers) inherit this new, more resilient enum handling behavior.
- Extensive API Model Regeneration: Following the template updates, numerous API model files were re-generated. This broad impact across the codebase reflects a consistent application of the new enum deserialization strategy, ensuring uniform error handling for unknown enum values throughout the SDK.
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. ↩
Quality Gate Passed Quality Gate passed
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
91.0% Duplication on New Code
@gemini-code-assist
gemini-code-assist
bot
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.
Code Review
This pull request aims to make the SDK more resilient to API changes by handling unknown enum values gracefully during deserialization. Instead of throwing an exception, it now logs a warning. This is a good approach for forward compatibility.
However, the current implementation has a critical issue: it logs the warning but still assigns the unknown value to the model's property. This puts the object into an invalid state, which can lead to unexpected behavior and bugs downstream. I've left a comment on the mustache template with a suggested fix to prevent setting the invalid value, which will resolve this issue across all generated models.
When an unknown enum value is found in the JSON payload (API response, webhook request) the deserialization throws an exception. This PR makes the deserialization logic more robust to be able to handle unknown enum values
The Mustache templates have been update to log a warning, instead of throwing an
IllegalArgumentException.Unit tests have been added to verify the deserialization code.
Several API models have been re-generated.
Implementation Details
When parsing a JSON payload and encountering unknown enumsm we have 2 options:
IllegalArgumentExceptionif the value is unknownWe have adopted the latter as it allows us to be resilient when new enums appear in the API responses.