better user-agent handling #702
Conversation
| if version == "(devel)" { | ||
| ClientVersion = bi.Main.Path | ||
| } else { | ||
| ClientVersion = fmt.Sprintf("%s@%s", bi.Main.Path, bi.Main.Version) |
There was a problem hiding this comment.
This is the path/version of the main module (application), not libp2p itself.
Stebalien
force-pushed
the
feat/user-agent
branch
3 times, most recently
from
63a4a4c
to
009eeba
Compare
Instead of using a global variable. This also: * Adds an option to the identify service to set the user agent. * Removes the ability to pass an identify service to NewHost as any reasonable Identify service already needs to be constructed with an instance of the host.
This should help us improve network stats on who's using libp2p.
Stebalien
force-pushed
the
feat/user-agent
branch
from
009eeba
to
e337633
Compare
| // ClientVersion is the default user agent. | ||
| // | ||
| // Deprecated: Set this with the UserAgent option. | ||
| var ClientVersion = "github.com/libp2p/go-libp2p" |
There was a problem hiding this comment.
let's just call this go-libp2p.
There was a problem hiding this comment.
Sure but users using go mod will still use their full paths by default. E.g., github.com/libp2p/go-libp2p-examples@v0.1.1.
There was a problem hiding this comment.
This will increase the size of the identify messages by 15 bytes. It's ok but worth noting.
| } | ||
| version := bi.Main.Version | ||
| if version == "(devel)" { | ||
| ClientVersion = bi.Main.Path |
There was a problem hiding this comment.
let's keep the devel designator somewhere in the reported agent.
There was a problem hiding this comment.
Anything built manually (i.e., built from a manually checked-out source tree) will have a (devel) version. It doesn't mean it's actually a development version.
To get a proper version, one would have to build with go get github.com/libp2p/go-libp2p-examples@latest (i.e., build with go mod).
Users that care can override this.
|
@raulk this:
|
| // ClientVersion is the default user agent. | ||
| // | ||
| // Deprecated: Set this with the UserAgent option. | ||
| var ClientVersion = "github.com/libp2p/go-libp2p" |
There was a problem hiding this comment.
This will increase the size of the identify messages by 15 bytes. It's ok but worth noting.
| } | ||
| version := bi.Main.Version | ||
| if version == "(devel)" { | ||
| ClientVersion = bi.Main.Path |
| @@ -47,7 +67,8 @@ const transientTTL = 10 * time.Second | |||
| // * Our IPFS Agent Version | |||
| // * Our public Listen Addresses | |||
| type IDService struct { | |||
| Host host.Host | |||
| Host host.Host | |||
| UserAgent string | |||
There was a problem hiding this comment.
Keeping this exported could lead to races if the user modifies the value at runtime. Not a biggie, but just pointing it out.
| @@ -31,9 +33,27 @@ const ID = "/ipfs/id/1.0.0" | |||
|
|
|||
| // LibP2PVersion holds the current protocol version for a client running this code | |||
| // TODO(jbenet): fix the versioning mess. | |||
| // XXX: Don't change this till 2020. You'll break all go-ipfs versions prior to | |||
There was a problem hiding this comment.
We should make this configurable too. Many projects using libp2p don't care about compatibility with IPFS and their networks are deliberately segregated.
There was a problem hiding this comment.
LGTM, modulo:
- some missing godocs -- fixed in a subsequent commit.
- suffix unknown versions with
@unknown, to normalise the format of that field. - Make LibP2PVersion configurable and dedup with UserAgent #714 (collateral to this).
Thanks for waiting for my sign off, @Stebalien!
This PR improves user-agent handling by: