[go: nahoru, domu]
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2c9f85f
Implement --save option in ipfs swarm peering add/rm
samuelbacaner Aug 14, 2022
e3369a4
Factor our config update; simplify updating config in add case
samuelbacaner Aug 25, 2022
cc967e9
Fix error message
ajnavarro Nov 21, 2022
35efa59
Requested changes.
ajnavarro Dec 6, 2022
689f476
Improve delete from config code
ajnavarro Dec 6, 2022
70524a0
Merge branch 'master' into ajnavarro/swarm-peering-save
ajnavarro Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 60 additions & 1 deletion core/commands/swarm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ const (
swarmLatencyOptionName = "latency"
swarmDirectionOptionName = "direction"
swarmResetLimitsOptionName = "reset"
swarmSaveOptionName = "save"
swarmUsedResourcesPercentageName = "min-used-limit-perc"
)

Expand Down Expand Up @@ -103,6 +104,9 @@ var swarmPeeringAddCmd = &cmds.Command{
Arguments: []cmds.Argument{
cmds.StringArg("address", true, true, "address of peer to add into the peering subsystem"),
},
Options: []cmds.Option{
cmds.BoolOption(swarmSaveOptionName, "if set, address(es) will be saved to peering config"),
},
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
addrs := make([]ma.Multiaddr, len(req.Arguments))

Expand Down Expand Up @@ -135,6 +139,18 @@ var swarmPeeringAddCmd = &cmds.Command{
return err
}
}

save, _ := req.Options[swarmSaveOptionName].(bool)
if save {
update := func(cfg *config.Config) {
cfg.Peering.Peers = append(cfg.Peering.Peers, addInfos...)
}
err := updateAndPersistConfig(env, update)
if err != nil {
return fmt.Errorf("unable to update and persist config change: %w", err)
}
}

return nil
},
Encoders: cmds.EncoderMap{
Expand Down Expand Up @@ -193,6 +209,9 @@ var swarmPeeringRmCmd = &cmds.Command{
Arguments: []cmds.Argument{
cmds.StringArg("ID", true, true, "ID of peer to remove from the peering subsystem"),
},
Options: []cmds.Option{
cmds.BoolOption(swarmSaveOptionName, "if set, address(es) will be removed from peering config"),
},
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
node, err := cmdenv.GetNode(env)
if err != nil {
Expand All @@ -202,17 +221,40 @@ var swarmPeeringRmCmd = &cmds.Command{
return ErrNotOnline
}

pids := make(map[peer.ID]struct{}, len(req.Arguments))
for _, arg := range req.Arguments {
id, err := peer.Decode(arg)
if err != nil {
return err
}

pids[id] = struct{}{}
node.Peering.RemovePeer(id)
if err = res.Emit(peeringResult{id, "success"}); err != nil {
return err
}
}

save, _ := req.Options[swarmSaveOptionName].(bool)
if save {
update := func(cfg *config.Config) {
var cfgOut []peer.AddrInfo
for _, p := range cfg.Peering.Peers {
if _, ok := pids[p.ID]; ok {
continue
}

cfgOut = append(cfgOut, p)
}

cfg.Peering.Peers = cfgOut
}

err := updateAndPersistConfig(env, update)
if err != nil {
return fmt.Errorf("unable to update and persist config change: %w", err)
}
}

return nil
},
Type: peeringResult{},
Expand Down Expand Up @@ -1098,3 +1140,20 @@ func filtersRemove(r repo.Repo, cfg *config.Config, toRemoveFilters []string) ([

return removed, nil
}

func updateAndPersistConfig(env cmds.Environment, update func(*config.Config)) error {
r, err := fsrepo.Open(env.(*commands.Context).ConfigRoot)
if err != nil {
return fmt.Errorf("error opening repo: %w", err)
}
defer r.Close()
cfg, err := r.Config()
if err != nil {
return fmt.Errorf("error fetching config file: %w", err)
}
update(cfg)
if err := r.SetConfig(cfg); err != nil {
return fmt.Errorf("error setting config: %w", err)
}
return nil
}
29 changes: 29 additions & 0 deletions test/sharness/t0140-swarm.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,35 @@ test_expect_success 'peering is removed' '

test_kill_ipfs_daemon

test_launch_ipfs_daemon

peeringID='QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N'
peeringID2='QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5K'
peeringAddr='/ip4/1.2.3.4/tcp/1234/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N'
peeringAddr2='/ip4/1.2.3.4/tcp/1234/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5K'

test_expect_success "'ipfs swarm peering add' with save option mutates config" '
ipfs config Peering.Peers > start-peers &&
ipfs swarm peering add ${peeringAddr} ${peeringAddr2} --save &&
ipfs config Peering.Peers > end-peers &&
! test_cmp start-peers end-peers &&
test_should_contain "${peeringID}" end-peers &&
test_should_contain ${peeringID2} end-peers &&
rm start-peers end-peers
'

test_expect_success "'ipfs swarm peering rm' with save option mutates config" '
ipfs config Peering.Peers > start-peers &&
ipfs swarm peering rm ${peeringID} --save &&
ipfs config Peering.Peers > end-peers &&
! test_cmp start-peers end-peers &&
test_should_not_contain "${peeringID}" end-peers &&
test_should_contain ${peeringID2} end-peers &&
rm start-peers end-peers
'

test_kill_ipfs_daemon

test_expect_success "set up tcp testbed" '
iptb testbed create -type localipfs -count 2 -force -init
'
Expand Down