feature: 'ipfs swarm peering' command

[TakashiMatsuda]

Overview

This PR is intended to implement a part of #7880.

Detail

New command ipfs swarm peering is added in this commit.
There are three subcommands under ipfs swarm peering. :

ipfs swarm peering add <address>... - add peers into the peering service.
ipfs swarm peering ls               - list peers registered in the peering service.
ipfs swarm peering rm <ID>...       - remove a peer from the peering service.

Usage of 'ipfs swarm peering add'

Example:

$ ./cmd/ipfs/ipfs swarm peering add /ip4/1.2.3.4/tcp/1234/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
add QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N success

Help text:

USAGE
ipfs swarm peering add <address>... - add peers into the peering service.

ipfs swarm peering add [--] <address>...

'ipfs swarm peering add' adds peers into the peering service.

For more information about each command, use:
'ipfs swarm peering add <subcmd> --help'

Usage of 'ipfs swarm peering rm'

Example:

$ ./cmd/ipfs/ipfs swarm peering rm QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
remove QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N success

Help text:

> ipfs swarm peering rm IDs...
USAGE
  ipfs swarm peering rm <ID>... - remove a peer from the peering subsystem.

  ipfs swarm peering rm [--] <ID>...

  'ipfs swarm peering rm' remove peers from the peering subsystem.

  For more information about each command, use:
  'ipfs swarm peering rm <subcmd> --help'

Usage of 'ipfs swarm peering ls'

Example:

$ ./cmd/ipfs/ipfs swarm peering ls
12D3KooWPBxKtYk9ptRH2B9tEJvBiQnPxKL3JxaVvJgmh3bpeGmn
        /ip4/35.213.90.5/tcp/4001

Help text:

USAGE
  ipfs swarm peering ls - list peers registered in the peering service.

  ipfs swarm peering ls

  'ipfs swarm peering ls' lists peers registered in the peering service.

  For more information about each command, use:
  'ipfs swarm peering ls <subcmd> --help'

Comment

• I have not added the --save option and the add command.
• ipfs swarm peering ls command is not requested in [Enhancement] Dynamic Peerlist adding / removing #7880. If ls was unnecessary, I would remove it.
• Please let me know if I have broken any compatibility with the output format of the command.

[Stebalien]

1. This will need sharness tests (test/sharness).
2. Punting --save to a future patch is fine, punting the add command is not. It makes it hard to test will likely confuse users.

[TakashiMatsuda]

Thank you for your comment. I understand.
I'll work on adding sharness tests and the add command. I'll leave this PR as Draft until the add is done.

[TakashiMatsuda]

1. This will need sharness tests (test/sharness).
2. Punting --save to a future patch is fine, punting the add command is not. It makes it hard to test will likely confuse users.

@Stebalien ( @aschmahmann )
I've added the missing implementation for 1 and 2. Could you review it again?

[Stebalien]

Thanks!

[BigLep]

@TakashiMatsuda : let us know when this is ready to be looked at again.

[TakashiMatsuda]

@BigLep Okay. Sorry I kept you waiting. I will finish in a few days.

[TakashiMatsuda]

@BigLep @Stebalien
I have finished the corrections. It's ready to be looked at.

[Stebalien]

https://github.com/ipfs/go-ipfs/pull/8147/files#r690637152 still needs to be addressed and I've added one help-text nit. Other than that, this looks great! And thanks for writing the tests.

[Stebalien]

Could you rebase on master one more time to fix the tests?

[TakashiMatsuda]

Sure, can I push -f it to the repository?

[aschmahmann]

Thanks @TakashiMatsuda 🙏

[Wondertan]

ListPeers does not hold a lock when reads from the peers map.

[Stebalien]

Thanks for catching that! Fixed in #8438.