fix(kad): preserve deadline in keep alive logic #3801
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3991197 to
7c84e94
Compare
mxinden
reviewed
Apr 19, 2023
protocols/kad/src/handler_priv.rs
Outdated
Comment on lines
760
to
768
| if self.outbound_substreams.is_empty() && self.inbound_substreams.is_empty() { | ||
| // We destroyed all substreams in this function. | ||
| self.keep_alive = KeepAlive::Until(Instant::now() + self.config.idle_timeout); | ||
| self.keep_alive = if let KeepAlive::Until(time) = self.keep_alive { | ||
| // Preserve the existing idle timeout | ||
| KeepAlive::Until(time) | ||
| } else { | ||
| // Setup idle timeout | ||
| KeepAlive::Until(Instant::now() + self.config.idle_timeout) | ||
| }; |
There was a problem hiding this comment.
Functionality wise, this looks good to me. What do you think of decreasing the nesting?
- if self.outbound_substreams.is_empty() && self.inbound_substreams.is_empty() {
- // We destroyed all substreams in this function.
- self.keep_alive = KeepAlive::Until(Instant::now() + self.config.idle_timeout);
- } else {
- self.keep_alive = KeepAlive::Yes;
- }
+ let no_streams = self.outbound_substreams.is_empty() && self.inbound_substreams.is_empty();
+ self.keep_alive = match (no_streams, self.keep_alive) {
+ // No open streams. Preserve the existing idle timeout.
+ (true, k @ KeepAlive::Until(_)) => k,
+ // No open streams. Set idle timeout.
+ (true, _) => KeepAlive::Until(Instant::now() + self.config.idle_timeout),
+ // Keep alive for open streams.
+ (false, _) => KeepAlive::Yes,
+ };Previous to this change if the ConnectionHandler::poll for kad was called more frequently than the connection idle timeout the timeout would continually be pushed further into the feature. After this change kad now will preserve the existing idle deadline.
7c84e94 to
20f25c8
Compare
|
@mxinden Thanks for the review. I agree I like the simpler logic. PR updated and rebased off master. |
|
I looked into the CI failures and they seem to be unrelated to the change. One is a clippy error for code I did not change. The other is a failed test in gossipsub. |
mxinden
approved these changes
Apr 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Previous to this change if the ConnectionHandler::poll for kad was called more frequently than the connection idle timeout the timeout would continually be pushed further into the future. After this change kad now will preserve the existing idle deadline.
Notes & open questions
How should I add tests?
Change checklist