Refactor error handling and update options#77
Conversation
Summary of ChangesHello @whereisfarukk, 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 enhancing the robustness and user experience of the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
There was a problem hiding this comment.
Code Review
This pull request refactors error handling to use NodeOperationError for better user feedback and reorders some UI options for clarity. The changes are generally good and improve consistency. I've pointed out one area in the error handling logic where a small refactoring could further improve the clarity of error messages presented to the user by separating parsing errors from validation errors.
| throw new NodeOperationError( | ||
| this.getNode(), | ||
| 'Schema is required when type is "json_schema"', | ||
| ); |
There was a problem hiding this comment.
While replacing Error with NodeOperationError is a good step for consistency, placing this validation logic inside the try...catch block (lines 866-921) leads to a confusing experience for the user. This catch block is designed for JSON parsing errors, but it will also catch this validation error and wrap it with the misleading message Invalid JSON format for response_format.... At this stage, the JSON is structurally valid, but semantically incorrect.
This issue also affects the validation on lines 911-914.
To provide clearer error messages, I recommend moving all semantic validation logic outside the try...catch block, which should only be responsible for parsing the JSON string.
Here's a suggested structure:
let parsed: any;
try {
// ... parsing logic for responseFormatParam
} catch (error) {
throw new NodeOperationError(
this.getNode(),
`Invalid JSON format for response_format: ${error instanceof Error ? error.message : String(error)}`
);
}
// Perform semantic validation on the 'parsed' object here
if (parsed && typeof parsed === 'object') {
// ...
if (userDefinedResponseFormat.type === 'json_schema' && !userDefinedResponseFormat.schema) {
throw new NodeOperationError(
this.getNode(),
'Schema is required when type is "json_schema"',
);
}
// ...
} else if (parsed !== undefined) {
throw new NodeOperationError(
this.getNode(),
'Response format must be an object',
);
}
No description provided.