-
Notifications
You must be signed in to change notification settings - Fork 2.2k
contractcourt: only close quit in Stop
#10045
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 @yyforyongyu, 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 resolves a critical panic within the contractcourt
package's UtxoNursery
component. The fix ensures that the component's quit
channel is managed correctly, preventing it from being closed multiple times during startup failures, which previously led to a node-crashing 'close of closed channel' panic. The changes streamline channel lifecycle management by centralizing the quit
channel closure to the Stop
method.
Highlights
- Bug Fix: Panic Prevention: Addressed a critical 'close of closed channel' panic that occurred when the
UtxoNursery
component failed to start up. Previously, thequit
channel was prematurely closed inStart()
's error paths, leading to a panic whenStop()
later attempted to close it again. - Channel Lifecycle Management: Refactored the
UtxoNursery.Start()
method to remove all instances ofu.quit
channel closure. This ensures that thequit
channel is now exclusively closed within theStop()
method, adhering to proper component lifecycle management and preventing double-closure issues. - Improved Error Logging: Replaced the premature
close(u.quit)
calls with explicit error logging usingutxnLog.Errorf
before returning an error, providing better diagnostic information during startup failures.
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 fixes a potential panic caused by closing the quit
channel in multiple places. Centralizing the channel closure within the Stop
method eliminates the risk of a double-close.
contractcourt/utxonursery.go
Outdated
// point forward, we must close the nursery's quit channel if we detect | ||
// any failures during startup to ensure they terminate. |
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.
Make sure we don't prematurely close the `quit` chans.
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.
LGTM, probably something for 19.2 ?
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.
LGTM 🎉
Make sure we don't prematurely close the
quit
chans. Fixes the panic,This will keep node in panic as the
quit
chan was closed inStart
, and we always callStop
to close thequit
, which will cause a panic. This is also because we have changed to cleanup order in 653e2f3.