fix(relay/client): only try to forward handler events once #5765
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We currently try to forward pending handler events in the relay client behavior twice: in
handle_established_{in, out}bound_connection
and inon_swarm_event()
(introduced in #3328).This is redundant because by the second time we try to forward it there won't be any pending event anymore.
This PR removes the duplicated logic from
on_swarm_event
. Forwarding it inhandle_established_{in, out}bound_connection
is more convenient as we still have direct access to the handler there and don't need to go through the swarm.However, it requires that in
handle_established_{in, out}bound_connection
the event is also removed when the connection is relayed, in which case the event is simply discarded because the commands are only valid on direct connections.Notes & open questions
Change checklist
I have made corresponding changes to the documentationI have added tests that prove my fix is effective or that my feature works