feature: 'ipfs swarm peering' command #8147

TakashiMatsuda · 2021-05-19T15:33:34Z

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 · 2021-05-24T17:23:35Z

This will need sharness tests (test/sharness).
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 · 2021-05-25T11:59:54Z

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 · 2021-08-17T17:34:23Z

This will need sharness tests (test/sharness).

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!

peering/peering.go

core/commands/swarm.go

BigLep · 2021-08-27T15:21:26Z

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

TakashiMatsuda · 2021-08-27T17:07:22Z

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

TakashiMatsuda · 2021-09-02T13:15:10Z

@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.

core/commands/swarm.go

Stebalien · 2021-09-02T17:15:06Z

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

TakashiMatsuda · 2021-09-02T17:16:55Z

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

Co-authored-by: Steven Allen <steven@stebalien.com>

aschmahmann · 2021-09-15T14:46:25Z

Thanks @TakashiMatsuda 🙏

Wondertan · 2021-09-15T16:55:28Z

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

Stebalien · 2021-09-15T17:00:17Z

Thanks for catching that! Fixed in #8438.

* feat: added swarm peering command supporting add, ls and rm Co-authored-by: Steven Allen <steven@stebalien.com> (cherry picked from commit a651045)

TakashiMatsuda changed the title ~~add peering rm command without save option~~ feature: 'ipfs swarm peering rm' command without save option May 19, 2021

TakashiMatsuda changed the title ~~feature: 'ipfs swarm peering rm' command without save option~~ feature: 'ipfs swarm peering rm' command without '--save' option May 19, 2021

aschmahmann self-assigned this May 24, 2021

aschmahmann added P3 Low: Not priority right now need/maintainer-input Needs input from the current maintainer(s) labels May 24, 2021

Stebalien added need/author-input Needs input from the original author and removed need/maintainer-input Needs input from the current maintainer(s) labels May 24, 2021

TakashiMatsuda marked this pull request as draft May 25, 2021 12:00

TakashiMatsuda mentioned this pull request Aug 7, 2021

Fix: Use a pointer type on IpfsNode.Peering #8331

Merged

TakashiMatsuda force-pushed the feat/peering-rm branch from c4a7df6 to e6424a2 Compare August 7, 2021 09:15

TakashiMatsuda force-pushed the feat/peering-rm branch 3 times, most recently from d70ae1b to 6721d11 Compare August 17, 2021 17:13

TakashiMatsuda marked this pull request as ready for review August 17, 2021 17:25

TakashiMatsuda changed the title ~~feature: 'ipfs swarm peering rm' command without '--save' option~~ feature: 'ipfs swarm peering' command Aug 17, 2021

Stebalien requested changes Aug 17, 2021

View reviewed changes

TakashiMatsuda force-pushed the feat/peering-rm branch 2 times, most recently from 3d459e3 to 2f6be1a Compare August 18, 2021 12:26

Stebalien requested changes Sep 2, 2021

View reviewed changes

core/commands/swarm.go Show resolved Hide resolved

TakashiMatsuda added 3 commits September 3, 2021 02:17

feat: swarm peering command without save option

3ea465c

fix: unnecessary printf

6207eeb

fix: add an encoder for swarm peering ls

f6b7a91

TakashiMatsuda and others added 8 commits September 3, 2021 02:17

Update peering/peering.go

93aee8f

Co-authored-by: Steven Allen <steven@stebalien.com>

Update peering/peering.go

4a99978

Co-authored-by: Steven Allen <steven@stebalien.com>

Update core/commands/swarm.go

9121c9e

Co-authored-by: Steven Allen <steven@stebalien.com>

Update core/commands/swarm.go

9c2340c

Co-authored-by: Steven Allen <steven@stebalien.com>

fix: help text and comments

0803da7

change return value of swarm peering add

9b9c26c

change return value of swarm peering rm

8f32e34

Update core/commands/swarm.go

dbdf103

TakashiMatsuda force-pushed the feat/peering-rm branch from 3e8381a to dbdf103 Compare September 2, 2021 17:20

Stebalien approved these changes Sep 2, 2021

View reviewed changes

BigLep requested a review from lidel September 10, 2021 15:18

BigLep assigned lidel and unassigned aschmahmann Sep 10, 2021

Stebalien removed the need/author-input Needs input from the original author label Sep 15, 2021

aschmahmann merged commit a651045 into ipfs:master Sep 15, 2021

Stebalien mentioned this pull request Sep 15, 2021

fix: take the lock while listing peers #8438

Merged

TakashiMatsuda deleted the feat/peering-rm branch September 17, 2021 16:51

aschmahmann mentioned this pull request Sep 27, 2021

v0.10.0-rc2 #8459

Merged

5 tasks

aschmahmann pushed a commit that referenced this pull request Sep 27, 2021

feature: 'ipfs swarm peering' command (#8147)

614e33d

* feat: added swarm peering command supporting add, ls and rm Co-authored-by: Steven Allen <steven@stebalien.com> (cherry picked from commit a651045)

aschmahmann pushed a commit that referenced this pull request Sep 27, 2021

feature: 'ipfs swarm peering' command (#8147)

6288f0b

* feat: added swarm peering command supporting add, ls and rm Co-authored-by: Steven Allen <steven@stebalien.com> (cherry picked from commit a651045)

aschmahmann mentioned this pull request Sep 30, 2021

Release v0.10 #8176

Closed

62 tasks

aschmahmann mentioned this pull request Dec 1, 2021

Release v0.11 #8343

Closed

80 tasks

samuelbacaner mentioned this pull request Aug 14, 2022

feature: Implement --save option in 'ipfs swarm peering add/rm' #9192

Closed

ajnavarro mentioned this pull request Nov 21, 2022

feature: Implement --save option in 'ipfs swarm peering add/rm' #9425

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: 'ipfs swarm peering' command #8147

feature: 'ipfs swarm peering' command #8147

TakashiMatsuda commented May 19, 2021 •

edited

Loading

Stebalien commented May 24, 2021

TakashiMatsuda commented May 25, 2021

TakashiMatsuda commented Aug 17, 2021 •

edited

Loading

Stebalien left a comment

BigLep commented Aug 27, 2021 •

edited

Loading

TakashiMatsuda commented Aug 27, 2021

TakashiMatsuda commented Sep 2, 2021 •

edited

Loading

Stebalien left a comment

Stebalien commented Sep 2, 2021

TakashiMatsuda commented Sep 2, 2021 •

edited

Loading

aschmahmann commented Sep 15, 2021

Wondertan commented Sep 15, 2021

Stebalien commented Sep 15, 2021

feature: 'ipfs swarm peering' command #8147

feature: 'ipfs swarm peering' command #8147

Conversation

TakashiMatsuda commented May 19, 2021 • edited Loading

Overview

Detail

Comment

Stebalien commented May 24, 2021

TakashiMatsuda commented May 25, 2021

TakashiMatsuda commented Aug 17, 2021 • edited Loading

Stebalien left a comment

Choose a reason for hiding this comment

BigLep commented Aug 27, 2021 • edited Loading

TakashiMatsuda commented Aug 27, 2021

TakashiMatsuda commented Sep 2, 2021 • edited Loading

Stebalien left a comment

Choose a reason for hiding this comment

Stebalien commented Sep 2, 2021

TakashiMatsuda commented Sep 2, 2021 • edited Loading

aschmahmann commented Sep 15, 2021

Wondertan commented Sep 15, 2021

Stebalien commented Sep 15, 2021

TakashiMatsuda commented May 19, 2021 •

edited

Loading

TakashiMatsuda commented Aug 17, 2021 •

edited

Loading

BigLep commented Aug 27, 2021 •

edited

Loading

TakashiMatsuda commented Sep 2, 2021 •

edited

Loading

TakashiMatsuda commented Sep 2, 2021 •

edited

Loading