-
Notifications
You must be signed in to change notification settings - Fork 38k
/
RSocketBufferLeakTests.java
364 lines (295 loc) · 10.8 KB
/
RSocketBufferLeakTests.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.messaging.rsocket;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import io.netty.buffer.PooledByteBufAllocator;
import io.netty.util.ReferenceCounted;
import io.rsocket.RSocket;
import io.rsocket.SocketAcceptor;
import io.rsocket.core.RSocketServer;
import io.rsocket.exceptions.ApplicationErrorException;
import io.rsocket.frame.decoder.PayloadDecoder;
import io.rsocket.plugins.RSocketInterceptor;
import io.rsocket.transport.netty.server.CloseableChannel;
import io.rsocket.transport.netty.server.TcpServerTransport;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestInstance.Lifecycle;
import org.reactivestreams.Publisher;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.publisher.Sinks;
import reactor.test.StepVerifier;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.Resource;
import org.springframework.messaging.handler.annotation.MessageExceptionHandler;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.Payload;
import org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler;
import org.springframework.stereotype.Controller;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for scenarios that could lead to Payload and/or DataBuffer leaks.
*
* @author Rossen Stoyanchev
*/
@TestInstance(Lifecycle.PER_CLASS)
class RSocketBufferLeakTests {
private final PayloadInterceptor payloadInterceptor = new PayloadInterceptor();
private AnnotationConfigApplicationContext context;
private CloseableChannel server;
private RSocketRequester requester;
@BeforeAll
void setupOnce() {
context = new AnnotationConfigApplicationContext(ServerConfig.class);
RSocketMessageHandler messageHandler = context.getBean(RSocketMessageHandler.class);
SocketAcceptor responder = messageHandler.responder();
server = RSocketServer.create(responder)
.payloadDecoder(PayloadDecoder.ZERO_COPY)
.interceptors(registry -> registry.forResponder(payloadInterceptor)) // intercept responding
.bind(TcpServerTransport.create("localhost", 7000))
.block();
requester = RSocketRequester.builder()
.rsocketConnector(conn -> conn.interceptors(registry -> registry.forRequester(payloadInterceptor)))
.rsocketStrategies(context.getBean(RSocketStrategies.class))
.tcp("localhost", 7000);
}
@AfterAll
void tearDownOnce() {
requester.rsocketClient().dispose();
server.dispose();
context.close();
}
@BeforeEach
void setUp() {
getLeakAwareNettyDataBufferFactory().reset();
payloadInterceptor.reset();
}
@AfterEach
void tearDown() throws InterruptedException {
getLeakAwareNettyDataBufferFactory().checkForLeaks(Duration.ofSeconds(5));
payloadInterceptor.checkForLeaks();
}
private LeakAwareNettyDataBufferFactory getLeakAwareNettyDataBufferFactory() {
return (LeakAwareNettyDataBufferFactory) context.getBean(RSocketStrategies.class).dataBufferFactory();
}
@Test
void assemblyTimeErrorForHandleAndReply() {
Mono<String> result = requester.route("A.B").data("foo").retrieveMono(String.class);
StepVerifier.create(result).expectErrorMatches(ex -> {
String prefix = "Ambiguous handler methods mapped for destination 'A.B':";
return ex.getMessage().startsWith(prefix);
}).verify(Duration.ofSeconds(5));
}
@Test
void subscriptionTimeErrorForHandleAndReply() {
Mono<String> result = requester.route("not-decodable").data("foo").retrieveMono(String.class);
StepVerifier.create(result).expectErrorMatches(ex -> {
String prefix = "Cannot decode to [org.springframework.core.io.Resource]";
return ex.getMessage().contains(prefix);
}).verify(Duration.ofSeconds(5));
}
@Test
void errorSignalWithExceptionHandler() {
Flux<String> result = requester.route("error-signal").data("foo").retrieveFlux(String.class);
StepVerifier.create(result).expectNext("Handled 'bad input'").expectComplete().verify(Duration.ofSeconds(5));
}
@Test
void ignoreInput() {
Mono<String> result = requester.route("ignore-input").data("a").retrieveMono(String.class);
StepVerifier.create(result).expectNext("bar").thenCancel().verify(Duration.ofSeconds(5));
}
@Test // gh-24741
@Disabled
// pending https://github.com/rsocket/rsocket-java/pull/777
void noSuchRouteOnChannelInteraction() {
Flux<String> input = Flux.just("foo", "bar", "baz");
Flux<String> result = requester.route("no-such-route").data(input).retrieveFlux(String.class);
StepVerifier.create(result).expectError(ApplicationErrorException.class).verify(Duration.ofSeconds(5));
}
@Test
void echoChannel() {
Flux<String> result = requester.route("echo-channel")
.data(Flux.range(1, 10).map(i -> "Hello " + i), String.class)
.retrieveFlux(String.class);
StepVerifier.create(result)
.expectNext("Hello 1 async").expectNextCount(8).expectNext("Hello 10 async")
.thenCancel() // https://github.com/rsocket/rsocket-java/issues/613
.verify(Duration.ofSeconds(5));
}
@Controller
static class ServerController {
@MessageMapping("A.*")
void ambiguousMatchA(String payload) {
throw new IllegalStateException("Unexpected call");
}
@MessageMapping("*.B")
void ambiguousMatchB(String payload) {
throw new IllegalStateException("Unexpected call");
}
@MessageMapping("not-decodable")
void notDecodable(@Payload Resource resource) {
throw new IllegalStateException("Unexpected call");
}
@MessageMapping("error-signal")
Flux<String> errorSignal(String payload) {
return Flux.error(new IllegalArgumentException("bad input"))
.delayElements(Duration.ofMillis(10))
.cast(String.class);
}
@MessageExceptionHandler
String handleIllegalArgument(IllegalArgumentException ex) {
return "Handled '" + ex.getMessage() + "'";
}
@MessageMapping("ignore-input")
Mono<String> ignoreInput() {
return Mono.delay(Duration.ofMillis(10)).map(l -> "bar");
}
@MessageMapping("echo-channel")
Flux<String> echoChannel(Flux<String> payloads) {
return payloads.delayElements(Duration.ofMillis(10)).map(payload -> payload + " async");
}
}
@Configuration
static class ServerConfig {
@Bean
ServerController controller() {
return new ServerController();
}
@Bean
RSocketMessageHandler messageHandler() {
RSocketMessageHandler handler = new RSocketMessageHandler();
handler.setRSocketStrategies(rsocketStrategies());
return handler;
}
@Bean
RSocketStrategies rsocketStrategies() {
return RSocketStrategies.builder()
.dataBufferFactory(new LeakAwareNettyDataBufferFactory(PooledByteBufAllocator.DEFAULT))
.build();
}
}
/**
* Store all intercepted incoming and outgoing payloads and then use
* {@link #checkForLeaks()} at the end to check reference counts.
*/
private static class PayloadInterceptor implements RSocket, RSocketInterceptor {
private final List<PayloadSavingDecorator> rsockets = new CopyOnWriteArrayList<>();
void checkForLeaks() {
this.rsockets.stream().map(PayloadSavingDecorator::getPayloads)
.forEach(payloadInfoProcessor -> {
payloadInfoProcessor.tryEmitComplete();
payloadInfoProcessor.asFlux()
.doOnNext(this::checkForLeak)
.blockLast();
});
}
private void checkForLeak(PayloadLeakInfo info) {
Instant start = Instant.now();
while (true) {
try {
int count = info.getReferenceCount();
assertThat(count).as("Leaked payload (refCnt=" + count + "): " + info).isEqualTo(0);
break;
}
catch (AssertionError ex) {
if (Instant.now().isAfter(start.plus(Duration.ofSeconds(5)))) {
throw ex;
}
}
try {
Thread.sleep(50);
}
catch (InterruptedException ex) {
// ignore
}
}
}
void reset() {
this.rsockets.forEach(PayloadSavingDecorator::reset);
}
@Override
public RSocket apply(RSocket rsocket) {
PayloadSavingDecorator decorator = new PayloadSavingDecorator(rsocket);
this.rsockets.add(decorator);
return decorator;
}
private static class PayloadSavingDecorator implements RSocket {
private final RSocket delegate;
private Sinks.Many<PayloadLeakInfo> payloads = Sinks.many().replay().all();
PayloadSavingDecorator(RSocket delegate) {
this.delegate = delegate;
}
Sinks.Many<PayloadLeakInfo> getPayloads() {
return this.payloads;
}
void reset() {
this.payloads = Sinks.many().replay().all();
}
@Override
public Mono<Void> fireAndForget(io.rsocket.Payload payload) {
return this.delegate.fireAndForget(addPayload(payload));
}
@Override
public Mono<io.rsocket.Payload> requestResponse(io.rsocket.Payload payload) {
return this.delegate.requestResponse(addPayload(payload)).doOnSuccess(this::addPayload);
}
@Override
public Flux<io.rsocket.Payload> requestStream(io.rsocket.Payload payload) {
return this.delegate.requestStream(addPayload(payload)).doOnNext(this::addPayload);
}
@Override
public Flux<io.rsocket.Payload> requestChannel(Publisher<io.rsocket.Payload> payloads) {
return this.delegate
.requestChannel(Flux.from(payloads).doOnNext(this::addPayload))
.doOnNext(this::addPayload);
}
private io.rsocket.Payload addPayload(io.rsocket.Payload payload) {
this.payloads.tryEmitNext(new PayloadLeakInfo(payload));
return payload;
}
@Override
public Mono<Void> metadataPush(io.rsocket.Payload payload) {
return this.delegate.metadataPush(addPayload(payload));
}
}
}
private static class PayloadLeakInfo {
private final String description;
private final ReferenceCounted referenceCounted;
PayloadLeakInfo(io.rsocket.Payload payload) {
this.description = payload.toString();
this.referenceCounted = payload;
}
int getReferenceCount() {
return this.referenceCounted.refCnt();
}
@Override
public String toString() {
return this.description;
}
}
}