Skip to content

Fix closing pending frames#194

Merged
jxs merged 4 commits intolibp2p:masterfrom
turuslan:fix/closing-pending-frames
Oct 23, 2024
Merged

Fix closing pending frames#194
jxs merged 4 commits intolibp2p:masterfrom
turuslan:fix/closing-pending-frames

Conversation

@turuslan
Copy link
Contributor

When yamux connection is closing it should:

  • Send pending frames.
  • Send GoAway frame.
  • Close underlying connection.

But test showed that pending frames from stream_receivers and GoAway frame were not sent.

Commits introducing this bug:

  • 61003c5 replaced VecDeque with Option,
    which caused loss of pending frames,
    because only last pending frame was stored in Option
  • 297e9eb reordered sending and collecting pending frames,
    trying to fix loss of pending frames.
  • 2867280 reverted 61003c5 Option back to VecDeque,
    so all pending frames are stored again.
  • However 297e9eb was not reverted,
    so pending frames are collected,
    but not sent.

This PR provides test to reproduce it, and reverts 297e9eb and af8f693 to fix it.

Copy link
Member

@jxs jxs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! Yeah I overlooked that DrainingStreamReceiver pushes frames back to the end of the queue.
Will release a patch version with this fix later on

@jxs jxs merged commit 7063268 into libp2p:master Oct 23, 2024
lexnv added a commit to paritytech/litep2p that referenced this pull request Jan 29, 2025
… API (#320)

This PR relies on the libp2p-yamux crate for the core functionality of
our multiplexer.
The main goal is to bring complete compatibility between libp2p and
litep2p on the yamux layer, and remove 90% of the yamux code in favor of
the upstream implementation while keeping the controller API in place.

The upstream crate brings in multiple fixes for substreams while
minimally impacting our dependency tree.

The downside of the upstream implementation is that the controller API
has been removed. Adjusting to the new API would be a massive breaking
change for all transport layers. Therefore, we keep the controller API
which integrates seamlessly with the upstream yamux. No other changes
were present to the controller API in the upstream implementation.

### Yamux changelog

The changelog includes the fixes from the upstream since the moment we
have inlined the crate in litep2p:

```
# 0.13.4

- Fix sending pending frames after closing. See [PR 194](libp2p/rust-yamux#194).

# 0.13.3

- Wake up readers after setting the state to RecvClosed to not miss EOF.
  See [PR 190](libp2p/rust-yamux#190).

- Use `web-time` instead of `instant`.
  See [PR 191](libp2p/rust-yamux#191).

# 0.13.2

- Bound `Active`'s `pending_frames` to enforce backpressure. 
  See [460baf2](libp2p/rust-yamux@460baf2)
  
# 0.13.1

- Fix WASM support using `instant::{Duration, Instant}` instead of `std::time::{Duration, Instant}`.
  See [PR 179](libp2p/rust-yamux#179).

# 0.13.0

- Introduce dynamic stream receive window auto-tuning.
  While low-resourced deployments maintain the benefit of small buffers, high resource deployments eventually end-up with a window of roughly the bandwidth-delay-product (ideal) and are thus able to use the entire available bandwidth.
  See [PR 176](libp2p/rust-yamux#176) for performance results and details on the implementation.
- Remove `WindowUpdateMode`.
  Behavior will always be `WindowUpdateMode::OnRead`, thus enabling flow-control and enforcing backpressure.
  See [PR 178](libp2p/rust-yamux#178).

# 0.12.1

- Deprecate `WindowUpdateMode::OnReceive`.
  It does not enforce flow-control, i.e. breaks backpressure.
  Use `WindowUpdateMode::OnRead` instead.
  See [PR #177](libp2p/rust-yamux#177).

# 0.12.0

- Remove `Control` and `ControlledConnection`.
  Users have to move to the `poll_` functions of `Connection`.
  See [PR #164](libp2p/rust-yamux#164).

- Fix a bug where `Stream`s would not be dropped until their corresponding `Connection` was dropped.
  See [PR #167](libp2p/rust-yamux#167).

```


### Next Steps
- [x] deployment in versi-net and monitor metrics / CPU impact
(extensively test this)


cc @paritytech/networking

---------

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants