feat(request-response): add modules for `json` and `cbor` messages #3952

dgarus · 2023-05-16T10:16:42Z

Description

This patch adds two modules to libp2p::request_response:

cbor
json

Both define a Behaviour type-alias that comes with a Codec implementation which uses the respective serde crate to serialize and deserialize the messages.

Fixes #3905.

Notes & open questions

added a common implementation of Behavior struct to use with the SerdeCodec<Request, Response>
added modules to create Behavior with the json or cbor codec
added integration tests for serde_codecs

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

thomaseizinger

Thanks for tackling this! I've left some comments with ideas :)

protocols/request-response/Cargo.toml

protocols/request-response/src/serde_codec.rs

protocols/request-response/src/cbor.rs

protocols/request-response/src/serde_codec.rs

protocols/request-response/src/cbor.rs

protocols/request-response/tests/cbor.rs

thomaseizinger

Good progress! :)

protocols/request-response/src/cbor.rs

dgarus · 2023-05-19T12:55:11Z

Good progress! :)

Thanks!

thomaseizinger

Thanks! I've left some more comments but the direction here looks good! :)

protocols/request-response/src/cbor.rs

protocols/request-response/src/lib.rs

protocols/request-response/CHANGELOG.md

protocols/request-response/src/cbor.rs

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

thomaseizinger

Great! :)

Almost there. I'd like to see whether we can remove the length-prefixing.

protocols/request-response/Cargo.toml

protocols/request-response/src/cbor.rs

dgarus · 2023-05-23T14:08:32Z

@thomaseizinger

I knew should be a better solution to wrap behavior :)

core/src/upgrade/transfer.rs

protocols/request-response/src/cbor.rs

thomaseizinger

Awesome! Some final requests and then we can merge this!

protocols/request-response/src/codec.rs

protocols/request-response/src/json.rs

thomaseizinger

Awesome! Thanks for bearing with us on the iterations. I think this is a really nice addition that will make using rust-libp2p easier :)

dgarus · 2023-05-24T11:20:19Z

Awesome! Thanks for bearing with us on the iterations. I think this is a really nice addition that will make using rust-libp2p easier :)

Thanks for the review, it is the best way to deep dive into p2p and Rust.

mxinden · 2023-05-25T03:42:52Z

protocols/request-response/src/cbor.rs

+/// # use libp2p_request_response::{cbor, ProtocolSupport, self as request_response};
+/// # use libp2p_swarm::{StreamProtocol, SwarmBuilder};
+/// #[derive(Debug, serde::Serialize, serde::Deserialize)]
+/// struct GreetRequest {
+///     name: String,
+/// }
+///
+/// #[derive(Debug, serde::Serialize, serde::Deserialize)]
+/// struct GreetResponse {
+///     message: String,
+/// }
+///
+/// let behaviour = cbor::Behaviour::<GreetRequest, GreetResponse>::new(
+///     [(StreamProtocol::new("/my-cbor-protocol"), ProtocolSupport::Full)],
+///     request_response::Config::default()
+/// );


Wonderful how simple this turned out to be. Thanks @dgarus and @thomaseizinger!

This patch adds two modules to `libp2p::request_response`: - `cbor` - `json` Both define a `Behaviour` type-alias that comes with a `Codec` implementation which uses the respective `serde` crate to serialize and deserialize the messages. Fixes libp2p#3905. Pull-Request: libp2p#3952.

3905 Serde support

dd98771

dgarus changed the title ~~3905 Serde support~~ feat(request-response): serde (json and/or cbor) support May 16, 2023

dgarus added 6 commits May 16, 2023 13:40

fix failures

55bc76a

fix failures

a5f3ed9

fix failures

5304fb8

Fix format

e9628ee

Merge branch 'master' into 3905-serde_support

4f8150d

Fix failure

23b7722

thomaseizinger reviewed May 16, 2023

View reviewed changes

dgarus added 4 commits May 18, 2023 14:10

Cbor behavior

11e0783

Cbor behavior

ade1842

Format

771560c

Fix test

2a6693e

thomaseizinger reviewed May 18, 2023

View reviewed changes

thomaseizinger reviewed May 19, 2023

View reviewed changes

protocols/request-response/src/cbor.rs Outdated Show resolved Hide resolved

protocols/request-response/src/cbor.rs Outdated Show resolved Hide resolved

dgarus added 2 commits May 19, 2023 15:28

Fix review comments

d4bff4c

Fix tests running

92d9862

dgarus added 3 commits May 19, 2023 16:27

Fix tests running

a0b8ee5

Added features json and cbor

1129dee

CHANGELOG

a8f9ee9

thomaseizinger reviewed May 19, 2023

View reviewed changes

dgarus and others added 8 commits May 20, 2023 14:49

Update protocols/request-response/CHANGELOG.md

36eaf02

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

Update protocols/request-response/src/cbor.rs

61f7d48

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

Update protocols/request-response/src/cbor.rs

d78c17b

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

Update protocols/request-response/src/cbor.rs

0ee31bd

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

Update protocols/request-response/src/cbor.rs

d4044a5

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

fix review comments

416f271

fix serde feature should be in the test scope

9d20aaa

No default features

ed5da99

thomaseizinger reviewed May 23, 2023

View reviewed changes

dgarus added 6 commits May 23, 2023 11:40

Remove libp2p-swarm-derive dep

9d6d608

Read/write without prefixed size

5cdb636

fix format

c177570

fix format

60f029c

fix bug

0fb3e78

Deref for behaviors

12a1322

fix format

4122c4e

thomaseizinger reviewed May 23, 2023

View reviewed changes

core/src/upgrade/transfer.rs Outdated Show resolved Hide resolved

protocols/request-response/src/cbor.rs Outdated Show resolved Hide resolved

Rename constructors to better support type aliases

74669a3

thomaseizinger force-pushed the 3905-serde_support branch from f732b78 to 74669a3 Compare May 23, 2023 16:02

dgarus added 2 commits May 23, 2023 19:41

move fn read_to_end to request_response crate

2da4b43

Merge branch 'master' into 3905-serde_support

20b2c07

thomaseizinger reviewed May 23, 2023

View reviewed changes

thomaseizinger changed the title ~~feat(request-response): serde (json and/or cbor) support~~ feat(request-response): add convenience modules for json and cbor messages May 23, 2023

thomaseizinger mentioned this pull request May 23, 2023

Support sending files libp2p/universal-connectivity#69

Closed

dgarus added 3 commits May 24, 2023 10:51

fix review comments

207f15a

Merge branch 'master' into 3905-serde_support

9047c7a

fix review comments

8197278

thomaseizinger approved these changes May 24, 2023

View reviewed changes

thomaseizinger changed the title ~~feat(request-response): add convenience modules for json and cbor messages~~ feat(request-response): add modules for json and cbor messages May 24, 2023

thomaseizinger added the send-it label May 24, 2023

mergify bot merged commit a5cd0d0 into libp2p:master May 24, 2023

dgarus deleted the 3905-serde_support branch May 24, 2023 11:31

mxinden reviewed May 25, 2023

View reviewed changes

thomaseizinger mentioned this pull request Jun 14, 2023

refactor(rendezvous): rewrite using libp2p-request-response #4051

Merged

4 tasks

mxinden mentioned this pull request Jun 20, 2023

Add rust-libp2p v0.52 blog post mxinden/blog#1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(request-response): add modules for `json` and `cbor` messages #3952

feat(request-response): add modules for `json` and `cbor` messages #3952

dgarus commented May 16, 2023 •

edited by thomaseizinger

Loading

thomaseizinger left a comment

thomaseizinger left a comment

dgarus commented May 19, 2023

thomaseizinger left a comment

thomaseizinger left a comment

dgarus commented May 23, 2023

thomaseizinger left a comment

thomaseizinger left a comment

dgarus commented May 24, 2023

mxinden May 25, 2023

feat(request-response): add modules for json and cbor messages #3952

feat(request-response): add modules for json and cbor messages #3952

Conversation

dgarus commented May 16, 2023 • edited by thomaseizinger Loading

Description

Notes & open questions

Change checklist

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger left a comment

Choose a reason for hiding this comment

dgarus commented May 19, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger left a comment

Choose a reason for hiding this comment

dgarus commented May 23, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

thomaseizinger left a comment

Choose a reason for hiding this comment

dgarus commented May 24, 2023

mxinden May 25, 2023

Choose a reason for hiding this comment

feat(request-response): add modules for `json` and `cbor` messages #3952

feat(request-response): add modules for `json` and `cbor` messages #3952

dgarus commented May 16, 2023 •

edited by thomaseizinger

Loading