-
Notifications
You must be signed in to change notification settings - Fork 111
updates extneded process queue with same error messages as normal pro… #684
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
base: master
Are you sure you want to change the base?
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 @ehdunbar, 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 primarily focuses on refining the error handling and logging mechanisms within the application's inter-process communication (IPC) queues. The changes aim to provide more informative and consistent error messages, particularly for the extended process queue, by improving how raw error objects are converted into human-readable strings for logging and reporting.
Highlights
- Improved Error Message Extraction: Enhanced the logic within the
extended_execute_process
queue to more robustly extract meaningful error strings. This includes prioritizing themessage
property for error objects, gracefully handling cases whereJSON.stringify
yields empty results ({}
or[]
), and providing a fallback 'Unnamed Error' for ambiguous or uninformative error values. - Standardized Logging Messages: Updated the
winston.error
log messages in both the standard and extended process queues to include more consistent and descriptive prefixes, such as 'Received Error on child in queue' and 'Received Error on child in extended queue', improving clarity in logs.
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 updates the extended process queue with the same error messages as the normal process queue. The changes include improved error serialization and more descriptive fallback error messages. Code duplication in error handling logic should be addressed by extracting it into a shared utility function.
if (err instanceof Error) { | ||
errorString = err.message || err.toString() | ||
if (errorString === "{}") { | ||
winston.debug("err.message or err.toString() for Error instance resulted in '{}'. Using a more descriptive fallback.") | ||
errorString = "Unnamed Error" | ||
} | ||
} else if (typeof err === "object" && err !== null) { | ||
try { | ||
errorString = JSON.stringify(err) | ||
if (Object.prototype.hasOwnProperty.call(err, "message") && typeof (err).message === "string") { | ||
errorString = (err).message | ||
} else { | ||
const stringified = JSON.stringify(err) | ||
if (stringified === "{}" || stringified === "[]") { | ||
winston.debug("Error stringified into {}") | ||
errorString = err.toString() | ||
} else { | ||
errorString = stringified | ||
} | ||
} | ||
} catch (jsonError: any) { | ||
errorString = `[Object could not be stringified: ${jsonError.message || jsonError.toString()}]` | ||
} | ||
} else { | ||
errorString = String(err) | ||
if (errorString === "{}") { | ||
winston.debug("String(err) resulted in '{}'. Using a generic representation for non-object error.") | ||
errorString = "Unnamed Error" | ||
} | ||
} |
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.
The error serialization logic is duplicated between src/xpc/extended_execute_process.ts
and src/xpc/execute_process.ts
. To improve maintainability and reduce redundancy, extract this logic into a shared utility function in src/hub/utils.ts
and import it into both files.
// In src/hub/utils.ts
export function serializeError(err: any): string {
let errorString: string;
if (err instanceof Error) {
errorString = err.message || err.toString();
if (errorString === "{}") {
errorString = "Unnamed Error";
}
} else if (typeof err === "object" && err !== null) {
try {
if (Object.prototype.hasOwnProperty.call(err, "message") && typeof (err).message === "string") {
errorString = (err).message;
} else {
const stringified = JSON.stringify(err);
if (stringified === "{}" || stringified === "[]") {
errorString = err.toString();
} else {
errorString = stringified;
}
}
} catch (jsonError: any) {
errorString = `[Object could not be stringified: ${jsonError.message || jsonError.toString()}]`;
}
} else {
errorString = String(err);
if (errorString === "{}") {
errorString = "Unnamed Error";
}
}
return errorString;
}
// In extended_execute_process.ts and execute_process.ts
import { serializeError } from "../hub/utils";
.catch((err) => {
const errorString = serializeError(err);
winston.error(`Received Error on child...: ${errorString}. WebhookID: ${request.webhookId}`);
process.send!({ success: false, message: errorString });
})
if (errorString === "{}") { | ||
winston.debug("err.message or err.toString() for Error instance resulted in '{}'. Using a more descriptive fallback."); | ||
errorString = "Unnamed Error"; |
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.
if (errorString === "{}") { | ||
winston.debug("err.message or err.toString() for Error instance resulted in '{}'. Using a more descriptive fallback.") | ||
errorString = "Unnamed Error" |
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.
…cess queue