[P2P] [Tooling] Peer discovery peer connections subcommand

[bryanchriswhite]

@Reviewer

This PR may be more digestible / reviewable on a commit-by-commit basis. Commits are organized logically and any given line is only modified in a single commit, with few exceptions*.

*(In the interest of preserving the git-time-continuum 👮🚨, this applies in batches of commits between comments or reviews by humans, only once "in review")

---

Description

Adds the following subcommands:

Print open peer connections

Usage:
  p1 peer connections [flags]

Flags:
  -h, --help   help for connections

Global Flags:
  -a, --all                     operations apply to both staked & unstaked router peerstores (default)
      --config string           Path to config
      --data_dir string         Path to store pocket related data (keybase etc.) (default "/home/bwhite/.pocket")
  -l, --local                   operations apply to the local (CLI binary's) P2P module instead of being broadcast
      --non_interactive         if true skips the interactive prompts wherever possible (useful for scripting & automation)
      --remote_cli_url string   takes a remote endpoint in the form of <protocol>://<host>:<port> (uses RPC Port) (default "http://localhost:50832")
  -s, --staked                  operations only apply to staked router peerstore (i.e. raintree)
  -u, --unstaked                operations only apply to unstaked router peerstore (i.e. gossipsub)
      --verbose                 Show verbose output

Issue

Related:

• [P2P] Peer discovery debug CLI sub-commands #730

Dependencies:

• [P2P] refactor: peerstore provider (part 1) #804
• [CLI] Consistent config/flag parsing & common helpers #891

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Major breaking change
• Documentation
• Other

List of changes

• Added peer connections subcommand
• Added P2PModule#GetConnections() interface method & implementation

Testing

• make develop_test; if any code changes were made
• make test_e2e on k8s LocalNet; if any code changes were made
• e2e-devnet-test passes tests on DevNet; if any code was changed
• Docker Compose LocalNet; if any major functionality was changed or introduced
• k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
• I have tested my changes using the available tooling
• I have updated the corresponding CHANGELOG

If Applicable Checklist

• I have updated the corresponding README(s); local and/or global
• I have added tests that prove my fix is effective or that my feature works
• I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (re/refactor/cli@a18c047). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head 10e00d0 differs from pull request most recent head ca2e971. Consider uploading reports for the commit ca2e971 to get more accurate results

Additional details and impacted files

@@                Coverage Diff                 @@
##             re/refactor/cli     #801   +/-   ##
==================================================
  Coverage                   ?   29.96%           
==================================================
  Files                      ?      108           
  Lines                      ?     8829           
  Branches                   ?        0           
==================================================
  Hits                       ?     2646           
  Misses                     ?     5873           
  Partials                   ?      310           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Olshansk]

I feel like we can skip the first switch statement and just return (with a debug log or error) if if !m.cfg.EnablePeerDiscoveryDebugRpc {

[Olshansk]

Cna you please update it everywhere else as well?

[Olshansk]

Everywhere else we have a function that returns a new instance of cobra.Command.

I think we should either:

1. Stay consisstent
2. Stay consistent + add a TODO to change the others
3. Change all of them

[Olshansk]

Should we add a debug build tag?

[Olshansk]

does PrintConnectionsTable need to be publically exposed given that we use PrintPeerConnections in the cli?

[Olshansk]

what happens if we don't return an error when provideRow errors? Is a partial list not an option?

[Olshansk]

Suggested change

	Use: "connections",
	Short: "Print open peer connections",
	Use: "Connections",
	Short: "Print open peer connections",
	Long: "Prints ..." // list out printConnectionsHeader
	Aliases: []string{"conns"},

[Olshansk]

OPTIONAL: The way I would've done this is by having a smaller private helper function like below that returns the router typ:

func foo() routerType {
	switch
	case stakedFlag && !unstakedFlag && !allFlag {
		return debug.StakeRouterType
	}
	case unstakedFlag && !stakedFlag && !allFlag {
		return debug.UnstakedRouterType
	}
	case stakedFlag || unstakedFlag {
		return ErrRouterType
	}
	// even if `allFlag` is false, we still want to print all connections
	default:
		return debug.AllRouterTypes
	}
}

Wdyt?

[Olshansk]

So why don't we do this?

[Olshansk]

So if this is false we don't print anything?

I don't fully understand its use. Is it like a "verbose" flag?

[h5law]

This localFlag determines whether we print locally ie to the terminal that ran the command or on the node itself AFAIK. With -l we will see the output in our terminal, otherwise it will be logged by the node

[Olshansk]

@bryanchriswhite Can you pick this up when you're back?