feat(kad)!: add `ModeChanged` event #4341

dhuseby · 2023-08-18T01:20:03Z

Description

Previously, the kademlia protocol would only log changes to the internal mode. With this patch, we now also emit an event which allows users to code against the internal state of the kademlia protocol.

Fixes #4310.

Notes & open questions

I added the code to emit the event in the reconfigure_mode function on the assumption that all mode changes result in that function being called.

Change checklist

I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
A changelog entry has been made in the appropriate crates

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

dhuseby · 2023-08-18T01:20:09Z

Maybe the correct behavior is to change the Handler so that after it has made changes in response to the KademliaHandlerIn::ReconfigureMode event, then it confirms that change by telling the behavior to emit the event. Thoughts?

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

Pull-Request: libp2p#4337.

mergify · 2023-08-18T08:05:42Z

This pull request has merge conflicts. Could you please resolve them @dhuseby? 🙏

thomaseizinger · 2023-08-18T08:46:54Z

Please no force-pushing :)

See https://github.com/libp2p/rust-libp2p/blob/master/CONTRIBUTING.md#we-squash-merge-pull-requests.

thomaseizinger

Thanks!

The test now fails which is good. We should update the test to also assert the new event being emitted.

protocols/kad/CHANGELOG.md

protocols/kad/src/behaviour.rs

thomaseizinger · 2023-08-18T08:51:10Z

I've queued this for the v0.53 release because it is a breaking change. We set those PRs to draft to prevent them from being merged accidentally before that :)

thomaseizinger · 2023-08-18T08:53:02Z

Maybe the correct behavior is to change the Handler so that after it has made changes in response to the KademliaHandlerIn::ReconfigureMode event, then it confirms that change by telling the behavior to emit the event. Thoughts?

The handler doesn't know about the "automatic" reconfiguration based on the external address. In other words, it also reconfigures itself if the user sets the mode manually. I think we should not emit an event in that case because the user already knows that they just changed the mode. We should probably also mention that in the docs of the new event.

protocols/kad/src/behaviour.rs

Pull-Request: libp2p#4344.

Pull-Request: libp2p#4340.

Following libp2p#4289 (comment), hereby is the PR to also improve the `create_socket` using [`for_addr`](https://docs.rs/socket2/latest/socket2/struct.Domain.html#method.for_address). We also add a test for listening on IPv4 and IPv6 separately. Pull-Request: libp2p#4328.

Request to add [TAPLE](https://www.taple.es) Project to rust-libp2p notable users. TAPLE is a permissioned DLT solution for traceability of assets and processes. We use libp2p for the network layer. Pull-Request: libp2p#4309.

Pull-Request: libp2p#4296.

dhuseby · 2023-08-18T23:11:24Z

Please no force-pushing :)

I can kill this PR, create a new clean branch on my end and resubmit with your suggested changes.

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

thomaseizinger · 2023-08-19T05:43:31Z

Please no force-pushing :)

I can kill this PR, create a new clean branch on my end and resubmit with your suggested changes.

No need for the extra effort! Continuing here is fine :)

thomaseizinger · 2023-08-19T06:04:59Z

README.md

- [Ursa](https://github.com/fleek-network/ursa) - Decentralized Content Delivery & Edge Compute.
+- [Taple](https://github.com/opencanarias/taple-core) - Sustainable DLT for asset and process traceability by [OpenCanarias](https://www.opencanarias.com/en/).


Something seems to have gone wrong during the rebase / merge because this diff is showing up here as if it were in this PR?

yeah...I think I pulled the upstream master into my branch at some point. let me see if I can clean this up.

I tried to do an interactive rebase and drop the unwanted commits and they don't show up in the list of available commits to drop. So instead I created a new branch and used cherry-pick to recreate this PR's branch with just my commits and your review commits. The new branch is here: https://github.com/dhuseby/rust-libp2p/tree/add-kad-modechanged-event

I was think the best course of action at this point is to close this PR and file a new PR with the new clean branch. What do you think?

I was think the best course of action at this point is to close this PR and file a new PR with the new clean branch. What do you think?

Yes, sounds good!

dhuseby · 2023-09-13T17:12:00Z

This branch is messed up. Replaced by PR #4499

feat!: added kademlia ModeChanged event

9467159

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

dhuseby force-pushed the add-kademlia-modechanged-event branch from 0d7b317 to f81207f Compare August 18, 2023 01:31

dhuseby and others added 2 commits August 17, 2023 19:31

bumped crate version

f81207f

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

deps(identity): update ed25519-dalek to 2.0

fb61697

Pull-Request: libp2p#4337.

thomaseizinger changed the title ~~feat!: added kademlia ModeChanged event~~ feat(kad)!: add ModeChanged event Aug 18, 2023

thomaseizinger reviewed Aug 18, 2023

View reviewed changes

protocols/kad/CHANGELOG.md Outdated Show resolved Hide resolved

protocols/kad/CHANGELOG.md Outdated Show resolved Hide resolved

protocols/kad/CHANGELOG.md Outdated Show resolved Hide resolved

protocols/kad/src/behaviour.rs Outdated Show resolved Hide resolved

thomaseizinger added this to the v0.53.0 milestone Aug 18, 2023

thomaseizinger marked this pull request as draft August 18, 2023 08:51

thomaseizinger reviewed Aug 18, 2023

View reviewed changes

protocols/kad/src/behaviour.rs Outdated Show resolved Hide resolved

mxinden and others added 5 commits August 18, 2023 09:02

chore: use workspace rust-version

16b2f15

Pull-Request: libp2p#4344.

docs: remove archived ursa project from README

08292c5

Pull-Request: libp2p#4340.

docs(readme): add taple to notable users

ffdd812

Request to add [TAPLE](https://www.taple.es) Project to rust-libp2p notable users. TAPLE is a permissioned DLT solution for traceability of assets and processes. We use libp2p for the network layer. Pull-Request: libp2p#4309.

deps: bump pin-project from 1.1.2 to 1.1.3

d3da24f

Pull-Request: libp2p#4296.

dhuseby and others added 10 commits August 18, 2023 17:11

Update protocols/kad/CHANGELOG.md

2dbfc8e

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Update protocols/kad/CHANGELOG.md

88766cf

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Update protocols/kad/src/behaviour.rs

7da6ff6

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

feat!: added kademlia ModeChanged event

251783f

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

rebasing

b34b96e

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

Update protocols/kad/CHANGELOG.md

664c97d

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Update protocols/kad/CHANGELOG.md

9377401

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

Update protocols/kad/src/behaviour.rs

4fb3e52

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>

event only emits when mode changes automatically

57fa234

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

catching up with GH suggested changes

53cc23a

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

dhuseby added 2 commits August 18, 2023 17:48

pulling in GH merges messed things up a bit

10ea2d7

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

fix the broken tests

42b1be5

Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>

thomaseizinger reviewed Aug 19, 2023

View reviewed changes

dhuseby mentioned this pull request Sep 13, 2023

feat(kad): report changes to our mode as an event #4499

Closed

5 tasks

dhuseby closed this Sep 13, 2023

dhuseby mentioned this pull request Sep 14, 2023

feat(kad): report automatic changes to kad mode #4503

Merged

4 tasks

thomaseizinger removed this from the v0.53.0 milestone Oct 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(kad)!: add `ModeChanged` event #4341

feat(kad)!: add `ModeChanged` event #4341

dhuseby commented Aug 18, 2023 •

edited by thomaseizinger

dhuseby commented Aug 18, 2023

mergify bot commented Aug 18, 2023

thomaseizinger commented Aug 18, 2023

thomaseizinger left a comment

thomaseizinger commented Aug 18, 2023

thomaseizinger commented Aug 18, 2023

dhuseby commented Aug 18, 2023

thomaseizinger commented Aug 19, 2023

thomaseizinger Aug 19, 2023

dhuseby Aug 25, 2023

dhuseby Aug 25, 2023

thomaseizinger Aug 26, 2023

dhuseby commented Sep 13, 2023

		- [Ursa](https://github.com/fleek-network/ursa) - Decentralized Content Delivery & Edge Compute.
		- [Taple](https://github.com/opencanarias/taple-core) - Sustainable DLT for asset and process traceability by [OpenCanarias](https://www.opencanarias.com/en/).

feat(kad)!: add ModeChanged event #4341

feat(kad)!: add ModeChanged event #4341

Conversation

dhuseby commented Aug 18, 2023 • edited by thomaseizinger

Description

Notes & open questions

Change checklist

dhuseby commented Aug 18, 2023

mergify bot commented Aug 18, 2023

thomaseizinger commented Aug 18, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger commented Aug 18, 2023

thomaseizinger commented Aug 18, 2023

dhuseby commented Aug 18, 2023

thomaseizinger commented Aug 19, 2023

thomaseizinger Aug 19, 2023

Choose a reason for hiding this comment

dhuseby Aug 25, 2023

Choose a reason for hiding this comment

dhuseby Aug 25, 2023

Choose a reason for hiding this comment

thomaseizinger Aug 26, 2023

Choose a reason for hiding this comment

dhuseby commented Sep 13, 2023

feat(kad)!: add `ModeChanged` event #4341

feat(kad)!: add `ModeChanged` event #4341

dhuseby commented Aug 18, 2023 •

edited by thomaseizinger