libp2p/jvm-libp2p

Test coverage of MultiplexHandler/Channel

Open

#27 opened on Jul 12, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Kotlin (85 forks)auto 404
good first issue

Repository metrics

Stars
 (359 stars)
PR merge metrics
 (PR metrics pending)

Description

Cover the MultiplexHandler/Channel classes with unit tests. These are pretty central and non-primitive classes so they should be tested well. Primary attention should paid to closing child channels, so once the channel is created it must be finally closed. Child channels shouldn't leak. There are following close circumstances:

  • parent channel is closed
  • remote peer sends RESET signal
  • local peer sends RESET (on channel.close() invoked)
  • remote and local peers sends CLOSE (on channel.disconnect())

Child channels may be created with MultiplexHandler.createStream() asynchronously from any thread and prior to the parent channel is activated. Those cases should also be considered.

Contributor guide

Research direction
Study the MultiplexHandler and Channel classes to understand their behavior. Identify all close scenarios: parent channel close, remote RESET, local RESET, and CLOSE from both peers. Write unit tests for each scenario, ensuring child channels are properly closed. Also test asynchronous creation of child streams before parent activation.
Tech stack
kotlin
Domain
networkingtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinJVMUnit testing basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75