refactor(relay): revise public API to follow naming convention #3238

jxs · 2022-12-13T18:26:30Z

Description

Continues addressing #2217.

Notes

Per commit review is suggested :)

Links to any relevant issues

Open Questions

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

…port.

thomaseizinger

Thanks, just one question :)

protocols/relay/CHANGELOG.md

mergify · 2022-12-14T14:33:23Z

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

and use them across the crate. Deprecate the old ones.

…he crate

…cross the crate

and use them across the crate. Deprecate the v2 ones.

With libp2p#2712 merged, this can be marked as done.

…ibp2p#3208) Addresses libp2p#2885

Currently, we create a new cache for each workflow run for each crate. That ends up blowing the maximum allowed cache size of 10GB and GitHub deletes the least-recently used cache again. Effectively, this means we don't have any caching. This patch introduces a cache factory workflow that only runs on master and always _saves_ a new cache. The CI workflow run for pull-requests on the other hand only restore these caches but don't save them.

) This patch deprecates 3 out of 4 functions on `PollParameters`: - `local_peer_id` - `listened_addresses` - `external_addresses` The addresses can be obtained by inspecting the `FromSwarm` event. To make this easier, we introduce two utility structs in `libp2p-swarm`: - `ExternalAddresses` - `ListenAddresses` A node's `PeerId` is always known to the caller, thus we can require them to pass it in. Related: libp2p#3124.

mergify · 2022-12-14T14:40:29Z

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

mergify · 2022-12-14T15:47:42Z

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

thomaseizinger

Very nice! Thank you!

protocols/relay/src/client.rs

protocols/relay/src/lib.rs

protocols/relay/src/v2.rs

protocols/relay/src/lib.rs

- rename RelayTransport in client doc to transport - make behaviour mod private re-exporting CircuitId - make client mod private re-exporting pub types.

thomaseizinger

Thanks for pushing this forward, some more thoughts!

protocols/relay/src/lib.rs

protocols/relay/src/priv_client.rs

protocols/relay/src/lib.rs

- dcutr tests use relay::client instead of just client:: - rename RelayedConnection to RelayedConnection - improve deprcated wording for types, remove the renamed references.

rename RelayedDial to Dial.

mergify · 2022-12-20T05:05:55Z

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

mergify · 2022-12-20T08:53:54Z

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

thomaseizinger

Sorry to add some more comments, I've had another thorough look and I think we can polish this a bit more :)

protocols/relay/CHANGELOG.md

protocols/dcutr/examples/dcutr.rs

protocols/relay/src/priv_client.rs

protocols/relay/src/priv_client/transport.rs

protocols/relay/tests/lib.rs

jxs · 2022-12-21T13:10:57Z

Sorry to add some more comments, I've had another thorough look and I think we can polish this a bit more :)

no, thank you for doing it so we caught things like the wrong PR link in the changelog!

thomaseizinger

Two more things! :)

protocols/relay/src/lib.rs

protocols/relay/src/priv_client/transport.rs

thomaseizinger · 2022-12-22T06:38:17Z

protocols/relay/tests/lib.rs

 #[derive(Debug)]
 enum ClientEvent {
-    Relay(client::Event),
+    Relay(relay::client::Event),
    Ping(ping::Event),
 }

-impl From<client::Event> for ClientEvent {
-    fn from(event: client::Event) -> Self {
+impl From<relay::client::Event> for ClientEvent {
+    fn from(event: relay::client::Event) -> Self {
        ClientEvent::Relay(event)
    }
 }


If you are feeling like deleting a bit more code, we could turn on event_process = true (which is the default) and remove this. Can easily be done in a follow-up though.

ehe yeah done. Also deleted the ClientEvent and RelayEvent that's what you were meaning right? And also removed from the examples.

thomaseizinger

Great improvement :)

Can you open an issue to investigate how we can have the CI pipeline complain about deprecated APIs in docs?

jxs · 2022-12-24T13:45:10Z

Great improvement :)

Can you open an issue to investigate how we can have the CI pipeline complain about deprecated APIs in docs?

opened #3282

mxinden

Appreciate the work here!

jxs added 6 commits December 13, 2022 18:27

rename relay::Relay to relay::Behaviour.

6453766

rename client::Client to client::Behaviour.

0f1c10e

rename client::transport::ClientTransport to client::transport::Trans…

796425a

…port.

rename relay::v2::client::RelayError to relay::v2::client::Error.

f0c8429

rename relay::v2::client::RelayListener to relay::v2::client::Listener.

9963cfa

add CHANGELOG.md entries

604178b

jxs force-pushed the rename-relay branch from 3fee23a to 604178b Compare December 13, 2022 18:27

thomaseizinger reviewed Dec 13, 2022

View reviewed changes

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

protocols/relay/CHANGELOG.md Show resolved Hide resolved

add missing links to CHANGELOG.md

395d516

jxs force-pushed the rename-relay branch from be14f2f to 395d516 Compare December 13, 2022 22:32

jxs and others added 8 commits December 14, 2022 14:38

move relay::v2 root symbols to relay::

50207ba

and use them across the crate. Deprecate the old ones.

move relay::v2::client symbols to relay::client and use them across t…

948f87b

…he crate

move relay::v2::copy_future module to relay::copy_future and use it a…

dcbca3a

…cross the crate

move relay::v2::relay symbols to relay::behaviour,

db1ff9f

and use them across the crate. Deprecate the v2 ones.

chore(ROADMAP): Mark Kademlia efficient querying as done (libp2p#3233)

2171c36

With libp2p#2712 merged, this can be marked as done.

feat: move Identify I/O from NetworkBehaviour to ConnectionHandler (l…

e6e4005

…ibp2p#3208) Addresses libp2p#2885

jxs force-pushed the rename-relay branch from 96420cb to 63f03be Compare December 14, 2022 14:39

jxs added 3 commits December 14, 2022 14:40

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

8744f97

fix typo on client deprecation message.

009aadc

Update CHANGELOG.md.

b4bb917

jxs added 2 commits December 14, 2022 15:53

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

e32d990

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

59d3225

thomaseizinger reviewed Dec 14, 2022

View reviewed changes

protocols/relay/src/client.rs Outdated Show resolved Hide resolved

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

protocols/relay/src/v2.rs Show resolved Hide resolved

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

multiple updates:

4134363

- rename RelayTransport in client doc to transport - make behaviour mod private re-exporting CircuitId - make client mod private re-exporting pub types.

thomaseizinger reviewed Dec 14, 2022

View reviewed changes

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

protocols/relay/src/priv_client.rs Show resolved Hide resolved

thomaseizinger reviewed Dec 16, 2022

View reviewed changes

protocols/relay/src/lib.rs Outdated Show resolved Hide resolved

jxs mentioned this pull request Dec 16, 2022

Encapsulate relay::client::Connection into an Newtype type that only exposes AsyncRead and AsyncWrite #3255

Closed

jxs added 3 commits December 16, 2022 15:14

review: apply multiple suggestions:

64e6dd9

- dcutr tests use relay::client instead of just client:: - rename RelayedConnection to RelayedConnection - improve deprcated wording for types, remove the renamed references.

review: address left deprecation messages,

bc66c5b

rename RelayedDial to Dial.

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

6f63553

thomaseizinger approved these changes Dec 18, 2022

View reviewed changes

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

91241e7

jxs force-pushed the rename-relay branch from 48e8201 to 91241e7 Compare December 20, 2022 14:25

jxs mentioned this pull request Dec 20, 2022

All crates should have a consistent API & naming #2217

Open

thomaseizinger added send-it and removed send-it labels Dec 21, 2022

thomaseizinger reviewed Dec 21, 2022

View reviewed changes

adress Thomas multiple review suggestions.

e3a8f0a

Merge branch 'master' of github.com:libp2p/rust-libp2p into rename-relay

7f653b3

thomaseizinger reviewed Dec 22, 2022

View reviewed changes

jxs mentioned this pull request Dec 23, 2022

refactor(swarm)!: don't be generic over Transport #3272

Merged

4 tasks

review: apply suggestions.

0951271

jxs force-pushed the rename-relay branch from 7c4562c to 0951271 Compare December 23, 2022 19:33

thomaseizinger approved these changes Dec 23, 2022

View reviewed changes

jxs mentioned this pull request Dec 24, 2022

Investigate how we can have the CI pipeline complain about warnings in doc code. #3282

Open

Merge branch 'master' into rename-relay

f3bf4bd

mxinden approved these changes Jan 2, 2023

View reviewed changes

mxinden added the send-it label Jan 2, 2023

Merge branch 'master' into rename-relay

c532b34

mergify bot merged commit 9c96bbb into libp2p:master Jan 2, 2023

thomaseizinger mentioned this pull request Mar 1, 2023

kademlia: shrink public API of libp2p-kad #3533

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(relay): revise public API to follow naming convention #3238

refactor(relay): revise public API to follow naming convention #3238

jxs commented Dec 13, 2022 •

edited by thomaseizinger

Loading

thomaseizinger left a comment

mergify bot commented Dec 14, 2022

mergify bot commented Dec 14, 2022

mergify bot commented Dec 14, 2022

thomaseizinger left a comment

thomaseizinger left a comment

mergify bot commented Dec 20, 2022

mergify bot commented Dec 20, 2022

thomaseizinger left a comment

jxs commented Dec 21, 2022

thomaseizinger left a comment

thomaseizinger Dec 22, 2022

jxs Dec 23, 2022

thomaseizinger Dec 23, 2022

thomaseizinger left a comment

jxs commented Dec 24, 2022

mxinden left a comment

refactor(relay): revise public API to follow naming convention #3238

refactor(relay): revise public API to follow naming convention #3238

Conversation

jxs commented Dec 13, 2022 • edited by thomaseizinger Loading

Description

Notes

Links to any relevant issues

Open Questions

Change checklist

thomaseizinger left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 14, 2022

mergify bot commented Dec 14, 2022

mergify bot commented Dec 14, 2022

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 20, 2022

mergify bot commented Dec 20, 2022

thomaseizinger left a comment

Choose a reason for hiding this comment

jxs commented Dec 21, 2022

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger Dec 22, 2022

Choose a reason for hiding this comment

jxs Dec 23, 2022

Choose a reason for hiding this comment

thomaseizinger Dec 23, 2022

Choose a reason for hiding this comment

thomaseizinger left a comment

Choose a reason for hiding this comment

jxs commented Dec 24, 2022

mxinden left a comment

Choose a reason for hiding this comment

jxs commented Dec 13, 2022 •

edited by thomaseizinger

Loading