transports/webrtc: Implement message framing #10

thomaseizinger · 2022-09-27T03:08:33Z

Description

This continues on #9 which I unfortunately couldn't push to. This PR is based off a branch in rust-libp2p now so @mxinden should definitely have push access and because it targets @melekes's PR he should have push access to :)

Links to any relevant issues

Open Questions

Open tasks

Send a RESET flag once a substream gets dropped. This is what mplex does too. I wouldn't know when else to send a RESET flag.
Integrate with StreamMuxer test suite once it is written (Add a crate that provides a test suit for an implementation of StreamMuxer libp2p/rust-libp2p#508)

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

…brtc-message-framing

With mxinden/specs@865f4f2 the RESET no longer resets both write and read part of a stream, but only the former.

melekes

looks good so far 👍

thomaseizinger · 2022-09-28T14:26:57Z

Writing the muxer test suite turns out to be a bit more complex than I thought it would. I'll see to dedicate most of tomorrow to that.

Might have to first write tests specific to this impl.

This reverts commit 1b0b671.

melekes · 2022-10-10T11:39:02Z

Looks like the branch has diverged from anton/webrtc-transport. @thomaseizinger do you mind fixing this?

thomaseizinger · 2022-10-10T12:28:14Z

Looks like the branch has diverged from anton/webrtc-transport. @thomaseizinger do you mind fixing this?

Yep, I should have time for this tomorrow! I got caught up trying to implement stream-resets properly on the other muxers so we can have a standardised test suite but that turns out to be a bigger effort.

…brtc-message-framing

Logging these state transitions is no longer really worth it because we have changed the design to have many more functions which would all require logging now.

transports/webrtc/Cargo.toml

transports/webrtc/src/substream.rs

melekes

thomaseizinger · 2022-10-11T08:17:54Z

I also implemented sending of reset flags now for dropped substreams. I think this is now actually complete :)

thomaseizinger · 2022-10-11T08:18:26Z

@mxinden Can you review this please?

melekes · 2022-10-12T11:38:57Z

@mxinden I think you still should be able to review here or in main PR (whatever you prefer).

Updates #2759 See melekes/rust-libp2p#10 and libp2p/specs#412 (comment) Co-authored-by: Pierre Krieger <pierre.krieger1708@gmail.com>

mxinden · 2022-10-14T16:57:20Z

I will review the main branch. Sorry for being a bottleneck here. Thanks @thomaseizinger for driving this all the way from the spec to the implementation! 🙏

mxinden and others added 19 commits August 19, 2022 12:11

transports/webrtc/: Test message framing sizes

59617de

transports/webrtc/: Implement message framing

7dc3ce1

transports/webrtc: Update protobuf

503e32f

Merge remote-tracking branch 'melekes/anton/webrtc-transport' into we…

22e97a0

…brtc-message-framing

transports/webrtc/: Change semantic of RESET

55da918

With mxinden/specs@865f4f2 the RESET no longer resets both write and read part of a stream, but only the former.

transports/webrtc/: Import message_proto types

11c016f

transports/webrtc/: Refactor AsyncRead match arm

1a6e4bd

transports/webrtc/: Handle flags when read side closed

d46a171

transports/webrtc: Enforce maximum message length

9cd4ef7

minor refactoring

31e019a

rename PollDataChannel to Substream

6f57ed6

Merge branch 'master' into webrtc-message-framing

421a8ec

add comments

4a1d4d6

add debug to handle_flag

c6c5a96

Create noise-prologue from server + client FP in fixed order

1b0b671

Make substream a top-level module

aa38c81

Replace nightly feature with refactoring

d0e918b

Remove use of import rename

171c613

Merge branch 'anton/webrtc-transport' into webrtc-message-framing

cb481a6

thomaseizinger changed the title ~~transports/webrtc/: Implement message framing~~ transports/webrtc: Implement message framing Sep 27, 2022

thomaseizinger added 8 commits September 27, 2022 13:09

Remove unused public API

6402665

Make sure we don't construct substreams outside of this crate

d537696

Don't expose public APIs for temporary workarounds

c8c2446

Remove pub where not necessary

d58f219

Remove utilities below usage

eb09d36

Remove stale derive

99af2a1

Update docs

2d85ab4

Fix clippy warnings

6e2aeb1

melekes reviewed Sep 28, 2022

View reviewed changes

thomaseizinger added 2 commits October 7, 2022 10:58

Revert "Create noise-prologue from server + client FP in fixed order"

a6b2aac

This reverts commit 1b0b671.

Merge branch 'master' into webrtc-message-framing

afac31c

thomaseizinger added 7 commits October 11, 2022 15:21

Merge remote-tracking branch 'melekes/anton/webrtc-transport' into we…

8266fc4

…brtc-message-framing

Add initial test suite for substream state machine

d2da793

Precompute substream ID

1b520a9

Implement new state machine

e483974

Reset flag clears buffer

29d6f74

Remove substream ID

d829fda

Logging these state transitions is no longer really worth it because we have changed the design to have many more functions which would all require logging now.

Remove use of map_err

058a153

melekes reviewed Oct 11, 2022

View reviewed changes

transports/webrtc/Cargo.toml Outdated Show resolved Hide resolved

transports/webrtc/src/substream.rs Outdated Show resolved Hide resolved

transports/webrtc/src/substream.rs Show resolved Hide resolved

thomaseizinger added 4 commits October 11, 2022 18:22

Replace error with Poll::Pending

e1df3c4

Remove unnecessary dependency

8c8feaa

Group imports

e6c177c

Add spec wording to constant

b2961a0

melekes reviewed Oct 11, 2022

View reviewed changes

transports/webrtc/src/substream.rs Outdated Show resolved Hide resolved

melekes approved these changes Oct 11, 2022

View reviewed changes

Introduce dedicated State submodule

f827f62

melekes marked this pull request as ready for review October 11, 2022 08:15

Send reset flag for dropped substreams

16433db

thomaseizinger added 2 commits October 11, 2022 19:23

Fix clippy warnings

834ec64

Fix docs

7e0e46d

melekes merged commit 225453b into melekes:anton/webrtc-transport Oct 12, 2022

mergify bot pushed a commit to paritytech/smoldot that referenced this pull request Oct 13, 2022

set the Noise prologue in the WebRTC handshake (#2807)

3e7ffe1

Updates #2759 See melekes/rust-libp2p#10 and libp2p/specs#412 (comment) Co-authored-by: Pierre Krieger <pierre.krieger1708@gmail.com>

thomaseizinger deleted the webrtc-message-framing branch October 14, 2022 20:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

transports/webrtc: Implement message framing #10

transports/webrtc: Implement message framing #10

thomaseizinger commented Sep 27, 2022 •

edited

melekes left a comment •

edited

thomaseizinger commented Sep 28, 2022

melekes commented Oct 10, 2022

thomaseizinger commented Oct 10, 2022

melekes left a comment •

edited

thomaseizinger commented Oct 11, 2022

thomaseizinger commented Oct 11, 2022

melekes commented Oct 12, 2022 •

edited

mxinden commented Oct 14, 2022

transports/webrtc: Implement message framing #10

transports/webrtc: Implement message framing #10

Conversation

thomaseizinger commented Sep 27, 2022 • edited

Description

Links to any relevant issues

Open Questions

Open tasks

Change checklist

melekes left a comment • edited

Choose a reason for hiding this comment

thomaseizinger commented Sep 28, 2022

melekes commented Oct 10, 2022

thomaseizinger commented Oct 10, 2022

melekes left a comment • edited

Choose a reason for hiding this comment

thomaseizinger commented Oct 11, 2022

thomaseizinger commented Oct 11, 2022

melekes commented Oct 12, 2022 • edited

mxinden commented Oct 14, 2022

thomaseizinger commented Sep 27, 2022 •

edited

melekes left a comment •

edited

melekes left a comment •

edited

melekes commented Oct 12, 2022 •

edited