feat: move options to main package and make internals private #486
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
Rational: 1. This allows us to make private options for testing. 2. This removes an import for DHT users. 3. This makes options much easier to discover. 4. This makes it possible to make the config/options internals private. We originally put them in a sub-package to avoid poluting the root namespace, but that isn't really necessary. This keeps the old package (for now) to avoid breaking too much.
aschmahmann
approved these changes
Mar 9, 2020
opts/options.go
Outdated
| "github.com/libp2p/go-libp2p-record" | ||
| ) | ||
|
|
||
| // Deprecated: The old format did not support more than one message per stream, and is not supported | ||
| // or relevant with stream pooling. ProtocolDHT should be used instead. | ||
| const ProtocolDHTOld protocol.ID = "/ipfs/dht" | ||
| const ProtocolDHTOld = dht.ProtocolDHTOld |
There was a problem hiding this comment.
Do we need this at all? I was thinking of removing it in #479, could kill it there since it might be more appropriate.
There was a problem hiding this comment.
Note: we're going to have to refactor this anyways when we fix protocol string handling.
Stebalien
force-pushed
the
feat/move-options
branch
from
df53f8d
to
2e10782
Compare
|
@aschmahmann I'll leave merging this to you. |
aschmahmann
pushed a commit
that referenced
this pull request
Mar 10, 2020
* feat: move options to main package and make internals private Rationale: 1. This allows us to make private options for testing. 2. This removes an import for DHT users. 3. This makes options much easier to discover. 4. This makes it possible to make the config/options internals private. We originally put them in a sub-package to avoid poluting the root namespace, but that isn't really necessary. This keeps the old package (for now) to avoid breaking too much.
Stebalien
added a commit
that referenced
this pull request
Apr 3, 2020
* feat: move options to main package and make internals private Rationale: 1. This allows us to make private options for testing. 2. This removes an import for DHT users. 3. This makes options much easier to discover. 4. This makes it possible to make the config/options internals private. We originally put them in a sub-package to avoid poluting the root namespace, but that isn't really necessary. This keeps the old package (for now) to avoid breaking too much.
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.
Rational:
We originally put them in a sub-package to avoid poluting the root namespace,
but that isn't really necessary.
This keeps the old package (for now) to avoid breaking too much.