feat(command): add connection direction #5457
Conversation
License: MIT Signed-off-by: Overbool <[email protected]>
core/commands/swarm.go
Outdated
| @@ -101,6 +100,9 @@ var swarmPeersCmd = &cmds.Command{ | |||
| */ | |||
|
|
|||
| if verbose || latency { | |||
| // set direction | |||
| ci.Direction = c.Stat().Direction | |||
There was a problem hiding this comment.
Instead of overloading the latency flag, let's just add a --direction flag. I'm usually all for reducing the number of flags we have but tying latency to connection direction feels a bit weird.
core/commands/swarm.go
Outdated
| Peer: pid.Pretty(), | ||
| Addr: addr.String(), | ||
| Peer: pid.Pretty(), | ||
| Direction: inet.Direction(-1), |
There was a problem hiding this comment.
Let's just let this default to 0 ("unknown"). By using -1, we're changing the API a bit: new clients running against old servers will see Direction: 0 (instead of Direction: -1) even if they haven't requested the direction. When they do, they'll print the direction as if the user had requested it. See my comment at https://github.com/ipfs/go-ipfs/pull/5457/files#diff-ab43cdc4b214774869f9dc156ebc0fa0R152
core/commands/swarm.go
Outdated
| @@ -146,6 +148,11 @@ var swarmPeersCmd = &cmds.Command{ | |||
| if info.Latency != "" { | |||
| fmt.Fprintf(buf, " %s", info.Latency) | |||
| } | |||
|
|
|||
| if info.Direction >= 0 { | |||
There was a problem hiding this comment.
I'd just check to see if the user has passed the appropriate flag (either --direction or --verbose). That way we can keep the default direction as 0.
Alternatively, we can just not print anything if the direction is unknown. Either way is fine by me.
Stebalien
added
status/in-progress
License: MIT Signed-off-by: Overbool <[email protected]>
overbool
force-pushed
the
feat/command/add-connection-direction
branch
from
fff878d
to
daf6fbd
Compare
|
@Stebalien Thank you for your advice. could you help me review my pr again? |
Stebalien
added
need/review
|
Given that this is a change to a public API, I'd like to get one more sign off. I'm puling a few others to see if they have any options. |
| @@ -146,6 +151,11 @@ var swarmPeersCmd = &cmds.Command{ | |||
| if info.Latency != "" { | |||
| fmt.Fprintf(buf, " %s", info.Latency) | |||
| } | |||
|
|
|||
| if info.Direction != inet.DirUnknown { | |||
There was a problem hiding this comment.
nit (feel free to ignore): can we check for the direction or verbose flag here? I prefer not to rely on default (unset) values.
There was a problem hiding this comment.
See: #5457 (comment). We've explicitly defined the zero value of Direction to be DirUnknown so this should always work.
There was a problem hiding this comment.
SGTY or would you actually like to print "unknown" if --direction is passed?
There was a problem hiding this comment.
SGTY or would you actually like to print "unknown" if
--directionis passed?
I'm fine either way ("unknown" or any non-empty string would make the output easier to parse in case we add more information fields in the future), my original comment was more about the fact that we are overloading the DirUnknown value to mean either unknown and/or unset, but's just a nit, I'm fine with the patch as is.
There was a problem hiding this comment.
Yeah, I see your point. The original patch used -1 but I that would change the API (go tends to assume missing == 0 so old go-ipfs daemons would return 0 instead of -1).
I'm just going to go with this for now as I think it's the simplest solution. If it continues to bug you, we can do a separate PR.
(note: users should be parsing ipfs --enc=json swarm peers if they know what's good for them...).
ghost
removed
the
License: MIT
Signed-off-by: Overbool [email protected]
Fixes: #5443