Skip to content

Fix server sending unnecessary proactive keepalives #1130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wdroste wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix server sending unnecessary proactive keepalives #1130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion rsocket-core/src/main/java/io/rsocket/core/RSocketRequester.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.rsocket.core;

import static io.rsocket.keepalive.KeepAliveSupport.ClientKeepAliveSupport;
import static io.rsocket.keepalive.KeepAliveSupport.ServerKeepAliveSupport;

import io.netty.buffer.ByteBuf;
import io.netty.util.collection.IntObjectMap;
Expand Down Expand Up @@ -85,6 +86,38 @@ class RSocketRequester extends RequesterResponderSupport implements RSocket {
@Nullable RequesterLeaseTracker requesterLeaseTracker,
Sinks.Empty<Void> onThisSideClosedSink,
Mono<Void> onAllClosed) {
this(
connection,
payloadDecoder,
streamIdSupplier,
mtu,
maxFrameLength,
maxInboundPayloadSize,
keepAliveTickPeriod,
keepAliveAckTimeout,
keepAliveHandler,
requestInterceptorFunction,
requesterLeaseTracker,
onThisSideClosedSink,
onAllClosed,
false);
}

RSocketRequester(
DuplexConnection connection,
PayloadDecoder payloadDecoder,
StreamIdSupplier streamIdSupplier,
int mtu,
int maxFrameLength,
int maxInboundPayloadSize,
int keepAliveTickPeriod,
int keepAliveAckTimeout,
@Nullable KeepAliveHandler keepAliveHandler,
Function<RSocket, RequestInterceptor> requestInterceptorFunction,
@Nullable RequesterLeaseTracker requesterLeaseTracker,
Sinks.Empty<Void> onThisSideClosedSink,
Mono<Void> onAllClosed,
boolean serverSide) {
super(
mtu,
maxFrameLength,
Expand All @@ -105,7 +138,11 @@ class RSocketRequester extends RequesterResponderSupport implements RSocket {

if (keepAliveTickPeriod != 0 && keepAliveHandler != null) {
KeepAliveSupport keepAliveSupport =
new ClientKeepAliveSupport(this.getAllocator(), keepAliveTickPeriod, keepAliveAckTimeout);
serverSide
? new ServerKeepAliveSupport(
this.getAllocator(), keepAliveTickPeriod, keepAliveAckTimeout)
: new ClientKeepAliveSupport(
this.getAllocator(), keepAliveTickPeriod, keepAliveAckTimeout);
this.keepAliveFramesAcceptor =
keepAliveHandler.start(
keepAliveSupport,
Expand Down
3 changes: 2 additions & 1 deletion rsocket-core/src/main/java/io/rsocket/core/RSocketServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,8 @@ private Mono<Void> acceptSetup(
requesterLeaseTracker,
requesterOnAllClosedSink,
Mono.whenDelayError(
responderOnAllClosedSink.asMono(), requesterOnAllClosedSink.asMono()));
responderOnAllClosedSink.asMono(), requesterOnAllClosedSink.asMono()),
true);

RSocket wrappedRSocketRequester = interceptors.initRequester(rSocketRequester);

Expand Down
13 changes: 13 additions & 0 deletions rsocket-core/src/main/java/io/rsocket/keepalive/KeepAliveSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,19 @@ void onIntervalTick() {
}
}

public static final class ServerKeepAliveSupport extends KeepAliveSupport {

public ServerKeepAliveSupport(
ByteBufAllocator allocator, int keepAliveInterval, int keepAliveTimeout) {
super(allocator, keepAliveInterval, keepAliveTimeout);
}

@Override
void onIntervalTick() {
tryTimeout();
}
}

public static final class KeepAlive {
private final Duration tickPeriod;
private final Duration timeoutMillis;
Expand Down
123 changes: 123 additions & 0 deletions rsocket-core/src/test/java/io/rsocket/core/KeepAliveTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,30 @@ static RSocketState requester(int tickPeriod, int timeout) {
return new RSocketState(rSocket, allocator, connection, empty);
}

static RSocketState serverRequester(int tickPeriod, int timeout) {
LeaksTrackingByteBufAllocator allocator =
LeaksTrackingByteBufAllocator.instrument(ByteBufAllocator.DEFAULT);
TestDuplexConnection connection = new TestDuplexConnection(allocator);
Sinks.Empty<Void> empty = Sinks.empty();
RSocketRequester rSocket =
new RSocketRequester(
connection,
PayloadDecoder.ZERO_COPY,
StreamIdSupplier.serverSupplier(),
0,
FRAME_LENGTH_MASK,
Integer.MAX_VALUE,
tickPeriod,
timeout,
new DefaultKeepAliveHandler(),
r -> null,
null,
empty,
empty.asMono(),
true);
return new RSocketState(rSocket, allocator, connection, empty);
}

static ResumableRSocketState resumableRequester(int tickPeriod, int timeout) {
LeaksTrackingByteBufAllocator allocator =
LeaksTrackingByteBufAllocator.instrument(ByteBufAllocator.DEFAULT);
Expand Down Expand Up @@ -339,6 +363,105 @@ void resumableRSocketsNotDisposedOnMissingKeepAlives() throws InterruptedExcepti
resumableRequesterState.allocator.assertHasNoLeaks();
}

@Test
void serverDoesNotSendProactiveKeepAlives() {
RSocketState serverState = serverRequester(KEEP_ALIVE_INTERVAL, KEEP_ALIVE_TIMEOUT);
TestDuplexConnection connection = serverState.connection();

virtualTimeScheduler.advanceTimeBy(Duration.ofMillis(KEEP_ALIVE_INTERVAL * 3));

// Server should not have sent any keepalive frames
Assertions.assertThat(connection.pollFrame()).isNull();

serverState.rSocket.dispose();
FrameAssert.assertThat(connection.pollFrame())
.typeOf(FrameType.ERROR)
.hasData("Disposed")
.hasNoLeaks();
serverState.connection.dispose();

serverState.allocator.assertHasNoLeaks();
}

@Test
void serverRespondsToClientKeepAlives() {
RSocketState serverState = serverRequester(100_000, 100_000);
TestDuplexConnection connection = serverState.connection();

Duration duration = Duration.ofMillis(100);
Mono.delay(duration)
.subscribe(
l ->
connection.addToReceivedBuffer(
KeepAliveFrameCodec.encode(
serverState.allocator, true, 0, Unpooled.EMPTY_BUFFER)));

virtualTimeScheduler.advanceTimeBy(duration);
FrameAssert.assertThat(connection.awaitFrame())
.typeOf(FrameType.KEEPALIVE)
.matches(this::keepAliveFrameWithoutRespondFlag);

serverState.rSocket.dispose();
FrameAssert.assertThat(serverState.connection.pollFrame())
.typeOf(FrameType.ERROR)
.hasStreamIdZero()
.hasData("Disposed")
.hasNoLeaks();
serverState.connection.dispose();

serverState.allocator.assertHasNoLeaks();
}

@Test
void serverDisposedOnMissingKeepAlives() {
RSocketState serverState = serverRequester(KEEP_ALIVE_INTERVAL, KEEP_ALIVE_TIMEOUT);

RSocket rSocket = serverState.rSocket();

virtualTimeScheduler.advanceTimeBy(Duration.ofMillis(KEEP_ALIVE_TIMEOUT * 2));

Assertions.assertThat(rSocket.isDisposed()).isTrue();
rSocket
.onClose()
.as(StepVerifier::create)
.expectError(ConnectionErrorException.class)
.verify(Duration.ofMillis(100));

Assertions.assertThat(serverState.connection.getSent()).allMatch(ByteBuf::release);

serverState.allocator.assertHasNoLeaks();
}

@Test
void serverNotDisposedOnPresentKeepAlives() {
RSocketState serverState = serverRequester(KEEP_ALIVE_INTERVAL, KEEP_ALIVE_TIMEOUT);

TestDuplexConnection connection = serverState.connection();

Disposable disposable =
Flux.interval(Duration.ofMillis(KEEP_ALIVE_INTERVAL))
.subscribe(
n ->
connection.addToReceivedBuffer(
KeepAliveFrameCodec.encode(
serverState.allocator, true, 0, Unpooled.EMPTY_BUFFER)));

virtualTimeScheduler.advanceTimeBy(Duration.ofMillis(KEEP_ALIVE_TIMEOUT * 2));

RSocket rSocket = serverState.rSocket();

Assertions.assertThat(rSocket.isDisposed()).isFalse();

disposable.dispose();

serverState.connection.dispose();
serverState.rSocket.dispose();

Assertions.assertThat(serverState.connection.getSent()).allMatch(ByteBuf::release);

serverState.allocator.assertHasNoLeaks();
}

private boolean keepAliveFrame(ByteBuf frame) {
return FrameHeaderCodec.frameType(frame) == FrameType.KEEPALIVE;
}
Expand Down