Add UPnP support for peer discovery. Resolves #1036 #1088
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…oncurrent modification of the port mappings list. Also removed 3 code smells: - logging of a swallowed Exception in `UpnpService::stop()`. - removed `Optional` type used as an instance field in `UDPServer`. - reduced cyclomatic complexity of `RskContext.buildInternalServices()`.
|
Hey @CoeJoder, sorry for the delay. Thanks a lot for your contribution and the explicit notes on the design decitions. |
…oncurrent modification of the port mappings list. Also removed 3 code smells: - logging of a swallowed Exception in `UpnpService::stop()`. - removed `Optional` type used as an instance field in `UDPServer`. - reduced cyclomatic complexity of `RskContext.buildInternalServices()`.
|
@nacho692 No problem. I just removed an integration test which relied on PowerMockito. |
aeidelman
added
the
Gitcoin hackathon
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature description:
UPnP is toggleable by the config property
peer.discovery.upnp_enabledand is enabled by default.If automatic port mapping fails, a log message notifies the user to enable UPnP on their router, or disable UPnP in the node conf and forward router ports manually.
Any automatic port mapping created via UPnP on the router is deleted upon node shutdown.
Implementation notes:
The
UpnpServiceis injected intoUDPServerif the service was enabled in the conf. This is the only service using UPnP right now.There are three TCP services running:
Web3WebSocketServer,Web3HttpServer,PeerServerImpl. All three of these services are configurable with different network interfaces/local addresses, each of which could be connected to unique WAN gateways. IfUpnpServicewas injected into these server objects, it could handle the port mapping easily. But that is out of scope for this ticket.There is one unit test which relies on
@VisibleForTesting(UpnpServiceTest::testExceptionDuringStop())There are two integration test which rely on
PowerMockitowhich was already being used in the test class (RskContextTest::testPeerDiscoveryWithUpnpEnabled()andRskContextTest::testPeerDiscoveryWithUpnpDisabled()).TODO:
There is a new dependency on the weUPnP library, see rsksmart/reproducible-builds#19. The
build.gradledependency is currently using the SHA hash of the public repo, but should be switched to that of the reproducible build when it is ready.