This repository has been archived by the owner on May 26, 2022. It is now read-only.
stop using goprocess to control teardown #278
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
marten-seemann
force-pushed
the
remove-goprocess
branch
from
2f4278a
to
206a275
Compare
Stebalien
suggested changes
Sep 7, 2021
| @@ -293,16 +278,6 @@ func (s *Swarm) Peerstore() peerstore.Peerstore { | |||
| return s.peers | |||
| } | |||
|
|
|||
| // Context returns the context of the swarm | |||
| func (s *Swarm) Context() context.Context { | |||
There was a problem hiding this comment.
For posterity: the user should control their own system's shutdown.
| @@ -201,11 +191,6 @@ func (s *Swarm) teardown() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // Process returns the Process of the swarm | |||
| func (s *Swarm) Process() goprocess.Process { | |||
| return s.proc | |||
There was a problem hiding this comment.
For posterity: this was very difficult to use correctly because adding child processes raced with the process shutting down (leading to a panic if this process closed before the child was added).
Technically, it could be used correctly with AddChildNoWait, but most callers would use AddCHild and Go (leading to panics on shutdown).
| @@ -103,11 +102,14 @@ type Swarm struct { | |||
| // `extra` interface{} parameter facilitates the future migration. Supported | |||
| // elements are: | |||
| // - connmgr.ConnectionGater | |||
| func NewSwarm(ctx context.Context, local peer.ID, peers peerstore.Peerstore, bwc metrics.Reporter, extra ...interface{}) *Swarm { | |||
| func NewSwarm(local peer.ID, peers peerstore.Peerstore, bwc metrics.Reporter, extra ...interface{}) *Swarm { | |||
There was a problem hiding this comment.
If we're breaking this interface anyways, let's consider using functional options. We can also do that in a followup patch.
Stebalien
approved these changes
Sep 7, 2021
|
Deferring merging until we've cut a new -core release. |
This was referenced Sep 7, 2021
marten-seemann
force-pushed
the
remove-goprocess
branch
from
8c94164
to
7ad413c
Compare
marten-seemann
force-pushed
the
remove-goprocess
branch
from
7ad413c
to
6ff34de
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Depends on libp2p/go-libp2p-core#212.
This PR:
Swarm.Process() goprocess.ProcessSwarm.Context() context.Contextcontext.ContextfromNewSwarmAnnoyingly, this means that we can't attach the closing of the peerstore in the
testingpackage any more:go-libp2p-swarm/testing/testing.go
Lines 118 to 120 in 29bd937
We therefore return a
network.Networkfromtesting.GenSwarm, and close the peerstore inClose. This change is responsible for 95% of the LOC changed in this PR.