Skip to content
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

Properly handle SSE comments in RESTEasy Reactive client and server code #30177

Merged
merged 1 commit into from
Jan 5, 2023
Merged

Properly handle SSE comments in RESTEasy Reactive client and server code #30177

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
11 changes: 9 additions & 2 deletions ...t/src/test/java/io/quarkus/resteasy/reactive/jsonb/deployment/test/sse/SseParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ public void testParser() {

// all fields
testParser("data:DATA\nid:ID\n:COMMENT\nretry:23\nevent:NAME\n\n", "DATA", "COMMENT", "ID", "NAME", 23);
// all fields and no data: no event
testParser("id:ID\n:COMMENT\nretry:23\nevent:NAME\n\n", null, null, null, null, SseEvent.RECONNECT_NOT_SET);
// all fields and no data
testParser("id:ID\n:COMMENT\nretry:23\nevent:NAME\n\n", null, "COMMENT", "ID", "NAME", 23);

// optional space after colon
testParser("data:foo\n\n", "foo", null, null, null, SseEvent.RECONNECT_NOT_SET);
Expand Down Expand Up @@ -147,6 +147,13 @@ private void testParser(String event, String data, String comment, String lastId
.setId(lastId)
.setName(name)
.setReconnectDelay(reconnectDelay)));
} else if (comment != null) {
testParser(Collections.singletonList(event), Collections.singletonList(new InboundSseEventImpl(null, null)
.setData(null)
.setComment(comment)
.setId(lastId)
.setName(name)
.setReconnectDelay(reconnectDelay)));
} else {
testParser(Collections.singletonList(event), Collections.emptyList());
}
Expand Down
3 changes: 2 additions & 1 deletion ...loyment/src/test/java/io/quarkus/resteasy/reactive/server/test/stream/StreamResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ public Multi<String> sseThrows() {
@GET
@Produces(MediaType.SERVER_SENT_EVENTS)
public Multi<OutboundSseEvent> sseRaw(@Context Sse sse) {
return Multi.createFrom().items(sse.newEventBuilder().id("one").data("uno").name("eins").build(),
return Multi.createFrom().items(sse.newEventBuilder().comment("dummy").build(),
sse.newEventBuilder().id("one").data("uno").name("eins").build(),
sse.newEventBuilder().id("two").data("dos").name("zwei").build(),
sse.newEventBuilder().id("three").data("tres").name("drei").build());
}
Expand Down
12 changes: 7 additions & 5 deletions ...loyment/src/test/java/io/quarkus/resteasy/reactive/server/test/stream/StreamTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CopyOnWriteArrayList;
Expand Down Expand Up @@ -211,7 +210,7 @@ public void testSse() throws InterruptedException {
});
sse.open();
Assertions.assertTrue(latch.await(20, TimeUnit.SECONDS));
Assertions.assertEquals(Arrays.asList("a", "b", "c"), results);
org.assertj.core.api.Assertions.assertThat(results).containsExactly("a", "b", "c");
Assertions.assertEquals(0, errors.size());
}
}
Expand Down Expand Up @@ -248,7 +247,9 @@ public void testSseForMultiWithOutboundSseEvent() throws InterruptedException {
List<String> results = new CopyOnWriteArrayList<>();
List<String> ids = new CopyOnWriteArrayList<>();
List<String> names = new CopyOnWriteArrayList<>();
List<String> comments = new CopyOnWriteArrayList<>();
sse.register(event -> {
comments.add(event.getComment());
results.add(event.readData());
ids.add(event.getId());
names.add(event.getName());
Expand All @@ -259,9 +260,10 @@ public void testSseForMultiWithOutboundSseEvent() throws InterruptedException {
});
sse.open();
Assertions.assertTrue(latch.await(20, TimeUnit.SECONDS));
Assertions.assertEquals(Arrays.asList("uno", "dos", "tres"), results);
Assertions.assertEquals(Arrays.asList("one", "two", "three"), ids);
Assertions.assertEquals(Arrays.asList("eins", "zwei", "drei"), names);
org.assertj.core.api.Assertions.assertThat(results).containsExactly(null, "uno", "dos", "tres");
org.assertj.core.api.Assertions.assertThat(ids).containsExactly(null, "one", "two", "three");
org.assertj.core.api.Assertions.assertThat(names).containsExactly(null, "eins", "zwei", "drei");
org.assertj.core.api.Assertions.assertThat(comments).containsExactly("dummy", null, null, null);
Assertions.assertEquals(0, errors.size());
}
}
Expand Down
4 changes: 2 additions & 2 deletions ...ctive/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/SseParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ private void parseEvent() {

private void dispatchEvent() {
// ignore empty events
if (dataBuffer.length() == 0)
if (dataBuffer.length() == 0 && commentBuffer.length() == 0)
return;
WebTargetImpl webTarget = sseEventSource.getWebTarget();
InboundSseEventImpl event;
Expand All @@ -159,7 +159,7 @@ private void dispatchEvent() {
event.setComment(commentBuffer.length() == 0 ? null : commentBuffer.toString());
// SSE spec says empty string is the default, but JAX-RS says null if not specified
event.setId(lastEventId);
event.setData(dataBuffer.toString());
event.setData(dataBuffer.length() == 0 ? null : dataBuffer.toString());
// SSE spec says "message" is the default, but JAX-RS says null if not specified
event.setName(eventType);
event.setReconnectDelay(eventReconnectTime);
Expand Down
6 changes: 4 additions & 2 deletions ...eactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/core/SseUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,10 @@ private static String serialiseEvent(ResteasyReactiveRequestContext context, Out
if (event.getReconnectDelay() >= 0)
serialiseField(context, sb, "retry", Long.toString(event.getReconnectDelay()), false);
}
String data = serialiseDataToString(context, event, eventMediaType);
serialiseField(context, sb, "data", data, true);
if (event.getData() != null) {
String data = serialiseDataToString(context, event, eventMediaType);
serialiseField(context, sb, "data", data, true);
}
sb.append(NL);
// return a UTF8 buffer
return sb.toString();
Expand Down