Close netconf topology and callhome resources#2346
Close netconf topology and callhome resources#2346ihrasko merged 4 commits intoPANTHEONtech:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Tobianas, 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 improves the robustness and resource management of the Netconf modules by ensuring that critical resources, such as timers, schema assemblers, and service providers, are properly closed when their respective plugins are stopped. This change directly addresses reported resource leakage concerns and enhances the overall stability of the application.
Highlights
- Resource Closure Enhancement: Implemented explicit closure for netconf topology and callhome related resources to prevent potential leaks.
- SonarCloud Remediation: Addresses issues flagged by SonarCloud regarding unclosed resources.
- Refactored Resource Management: Introduced a common "closeResource" helper method to streamline the closing of AutoCloseable instances in stopProcedure methods.
- Variable Scope Adjustment: Promoted several local variables to class fields in NetconfCallhomePlugin and NetconfTopologyPlugin to ensure they are accessible for proper closure during plugin shutdown.
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 correctly addresses potential resource leaks by ensuring that several AutoCloseable resources in NetconfCallhomePlugin and NetconfTopologyPlugin are closed in the stopProcedure methods. The changes involve promoting local variables to instance fields so they can be accessed for cleanup and implementing a robust closing mechanism. My review includes a critical fix for the resource closing order in NetconfCallhomePlugin to respect component dependencies, and a suggestion to refactor duplicated code to improve maintainability.
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfCallhomePlugin.java
Outdated
Show resolved
Hide resolved
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfCallhomePlugin.java
Show resolved
Hide resolved
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfTopologyPlugin.java
Show resolved
Hide resolved
Tobianas
force-pushed
the
main_close_resources
branch
from
c834a14 to
fe0e339
Compare
ihrasko
left a comment
ihrasko
left a comment
There was a problem hiding this comment.
Which resources? Can you split to more patches, one for each class?
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfTopologyPlugin.java
Outdated
Show resolved
Hide resolved
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfCallhomePlugin.java
Outdated
Show resolved
Hide resolved
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfCallhomePlugin.java
Show resolved
Hide resolved
Rework the shutdown of resources in Topology and Callhome plugins. JIRA: LIGHTY-381 Signed-off-by: tobias.pobocik <[email protected]>
This resource was not closed as well as being duplicated. JIRA: LIGHTY-381 Signed-off-by: tobias.pobocik <[email protected]>
Tobianas
force-pushed
the
main_close_resources
branch
from
fe0e339 to
5fed6f4
Compare
done |
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfTopologyPlugin.java
Outdated
Show resolved
Hide resolved
...etconf-sb/src/main/java/io/lighty/modules/southbound/netconf/impl/NetconfTopologyPlugin.java
Outdated
Show resolved
Hide resolved
This resource was not closed. JIRA: LIGHTY-381 Signed-off-by: tobias.pobocik <[email protected]>
This resource was not closed. JIRA: LIGHTY-381 Signed-off-by: tobias.pobocik <[email protected]>
Tobianas
force-pushed
the
main_close_resources
branch
from
5fed6f4 to
8888da7
Compare
2 participants
As reported by sonarcloud, these resources should be properly closed.
JIRA: LIGHTY-381