server: prevent duplicate onion addresses in getinfo #10341
Conversation
Summary of ChangesHello @bitromortac, 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 an issue where the LND server could accumulate duplicate Tor onion addresses in its node announcement, particularly when Tor health checks caused the hidden service to be re-created. By introducing a check for existing addresses before appending new ones, the change ensures that the node's advertised addresses remain clean and accurate, improving the stability and reliability of Tor-enabled LND nodes. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly prevents duplicate onion addresses from being added to the node announcement by checking for existing addresses before appending a new one. The fix is simple and effective. To prevent future regressions, it would be beneficial to add a unit test that covers this specific scenario of a Tor controller restart leading to a duplicate address.
server.go
Outdated
| newNodeAnn, err := s.genNodeAnnouncement( | ||
| nil, func(currentAnn *lnwire.NodeAnnouncement1) { | ||
| currentAnn.Addresses = append(currentAnn.Addresses, addr) | ||
| // Check if this address was already added. |
There was a problem hiding this comment.
will the whole list be deleted during restart, so we only have like 1 address in there at least 1 onion address I mean ?
There was a problem hiding this comment.
Good point! I decided to change the approach to deduplicate addresses in genNodeAnnouncement after modifiers were applied as this also removes previously added duplicate addresses. On start we recreate the node announcement, which will clean it up (I could reproduce the bug and verified that this works).
server.go
Outdated
| // Check if this address was already added. | ||
| for _, anAddr := range currentAnn.Addresses { | ||
| if anAddr.String() == addr.String() { | ||
| return |
There was a problem hiding this comment.
nit: can use some debug log here
server.go
Outdated
| } | ||
| } | ||
|
|
||
| currentAnn.Addresses = append( |
There was a problem hiding this comment.
It looks like Addresses should be a set (map) to avoid this duplicated addresses issue, but that's a larger PR.
|
@bitromortac, remember to re-request review from reviewers when ready |
|
@bitromortac can we finalize this one |
bitromortac
force-pushed
the
2511-fix-tor-healthcheck
branch
from
c638402 to
1d7d9e3
Compare
ziggie1984
left a comment
ziggie1984
left a comment
There was a problem hiding this comment.
LGMT => please add release notes entry for 20.1 and also create a backport PR for the 20.x branch
Modifiers of the node announcement may add duplicate addresses, which we remove here after the modifications were applied. This also ensures that any previously added duplicate addresses are removed as well.
bitromortac
force-pushed
the
2511-fix-tor-healthcheck
branch
from
1d7d9e3 to
b513efc
Compare
5 participants
Attempts to fix #10328.
The user's config is set to do periodic health checks for tor connections:
The issues seems to be the following. If
healthcheck.CheckTorServiceStatusreceivessyscall.EPIPEit restarts the tor controller, which re-creates the hidden service.createNewHiddenServicethen updates the node announcement, appending the new (old) onion service address, not checking if it's already present, which is fixed here.