Deprecate @RestSseElementType in favour of @RestStreamElementType

quarkusio · Jan 20, 2022 · 9f1823d · 9f1823d
1 parent 584cfde
commit 9f1823d
Show file tree

Hide file tree

Showing 16 changed files with 106 additions and 63 deletions.
diff --git a/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc b/docs/src/main/asciidoc/kafka-schema-registry-avro.adoc
@@ -229,7 +229,7 @@ import javax.ws.rs.core.MediaType;
 
 import org.acme.kafka.quarkus.Movie;
 import org.eclipse.microprofile.reactive.messaging.Channel;
-import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 
 import io.smallrye.mutiny.Multi;
 
@@ -242,7 +242,7 @@ public class ConsumedMovieResource {
 
     @GET
     @Produces(MediaType.SERVER_SENT_EVENTS)
-    @RestSseElementType(MediaType.TEXT_PLAIN)
+    @RestStreamElementType(MediaType.TEXT_PLAIN)
     public Multi<String> stream() {
         return movies.map(movie -> String.format("'%s' from %s", movie.getTitle(), movie.getYear()));
     }

diff --git a/docs/src/main/asciidoc/resteasy-reactive.adoc b/docs/src/main/asciidoc/resteasy-reactive.adoc
@@ -708,7 +708,7 @@ https://html.spec.whatwg.org/multipage/server-sent-events.html[Server-Sent Event
 by just annotating your endpoint method with 
 link:{jaxrsapi}/javax/ws/rs/Produces.html[`@Produces(MediaType.SERVER_SENT_EVENTS)`]
 and specifying that each element should be <<json,serialised to JSON>> with 
-`@RestSseElementType(MediaType.APPLICATION_JSON)`.
+`@RestStreamElementType(MediaType.APPLICATION_JSON)`.
 
 [source,java]
 ----
@@ -720,7 +720,7 @@ import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
 
-import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
@@ -739,7 +739,7 @@ public class Endpoint {
     // Send the stream over SSE
     @Produces(MediaType.SERVER_SENT_EVENTS)
     // Each element will be sent as JSON
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public Multi<Book> stream() {
         return books;
     }

diff --git a/...t/src/test/java/io/quarkus/resteasy/reactive/jackson/deployment/test/sse/SseResource.java b/...t/src/test/java/io/quarkus/resteasy/reactive/jackson/deployment/test/sse/SseResource.java
@@ -10,7 +10,7 @@
 import javax.ws.rs.sse.SseBroadcaster;
 import javax.ws.rs.sse.SseEventSink;
 
-import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 import org.jboss.resteasy.reactive.common.util.RestMediaType;
 
 import io.smallrye.common.annotation.Blocking;
@@ -43,7 +43,7 @@ public Multi<String> multiText() {
     @Path("json")
     @GET
     @Produces(MediaType.SERVER_SENT_EVENTS)
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public void sseJson(Sse sse, SseEventSink sink) throws IOException {
         if (sink == null) {
             throw new IllegalStateException("No client connected.");
@@ -60,7 +60,7 @@ public void sseJson(Sse sse, SseEventSink sink) throws IOException {
     @Path("blocking/json")
     @GET
     @Produces(MediaType.SERVER_SENT_EVENTS)
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public void blockingSseJson(Sse sse, SseEventSink sink) throws IOException {
         if (sink == null) {
             throw new IllegalStateException("No client connected.");
@@ -94,7 +94,7 @@ public void sseJson2(Sse sse, SseEventSink sink) throws IOException {
     @Path("json/multi")
     @GET
     @Produces(MediaType.SERVER_SENT_EVENTS)
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public Multi<Message> multiJson() {
         return Multi.createFrom().items(new Message("hello"), new Message("stef"));
     }
@@ -109,15 +109,15 @@ public Multi<Message> multiDefaultElementType() {
     @Path("ndjson/multi")
     @GET
     @Produces(RestMediaType.APPLICATION_NDJSON)
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public Multi<Message> multiNdJson() {
         return Multi.createFrom().items(new Message("hello"), new Message("stef"));
     }
 
     @Path("stream-json/multi")
     @GET
     @Produces(RestMediaType.APPLICATION_STREAM_JSON)
-    @RestSseElementType(MediaType.APPLICATION_JSON)
+    @RestStreamElementType(MediaType.APPLICATION_JSON)
     public Multi<Message> multiStreamJson() {
         return Multi.createFrom().items(new Message("hello"), new Message("stef"));
     }

diff --git a/...ment/src/test/java/io/quarkus/resteasy/reactive/jaxb/deployment/test/SseResourceTest.java b/...ment/src/test/java/io/quarkus/resteasy/reactive/jaxb/deployment/test/SseResourceTest.java
@@ -26,7 +26,7 @@
 import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 import org.jboss.resteasy.reactive.client.impl.MultiInvoker;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -154,7 +154,7 @@ public Multi<String> multiText() {
         @Path("xml")
         @GET
         @Produces(MediaType.SERVER_SENT_EVENTS)
-        @RestSseElementType(MediaType.APPLICATION_XML)
+        @RestStreamElementType(MediaType.APPLICATION_XML)
         public void sseXml(Sse sse, SseEventSink sink) {
             if (sink == null) {
                 throw new IllegalStateException("No client connected.");
@@ -170,7 +170,7 @@ public void sseXml(Sse sse, SseEventSink sink) {
         @Path("blocking/xml")
         @GET
         @Produces(MediaType.SERVER_SENT_EVENTS)
-        @RestSseElementType(MediaType.APPLICATION_XML)
+        @RestStreamElementType(MediaType.APPLICATION_XML)
         public void blockingSseXml(Sse sse, SseEventSink sink) {
             if (sink == null) {
                 throw new IllegalStateException("No client connected.");

diff --git a/...ent/src/test/java/io/quarkus/resteasy/reactive/jsonb/deployment/test/sse/SseResource.java b/...ent/src/test/java/io/quarkus/resteasy/reactive/jsonb/deployment/test/sse/SseResource.java
@@ -10,6 +10,7 @@
 import javax.ws.rs.sse.SseBroadcaster;
 import javax.ws.rs.sse.SseEventSink;
 
+// Using `@RestStreamElementType` on purpose to ensure the backward compatibility.
 import org.jboss.resteasy.reactive.RestSseElementType;
 import org.jboss.resteasy.reactive.common.util.RestMediaType;
 

diff --git a/...ain/java/io/quarkus/resteasy/reactive/server/deployment/QuarkusServerEndpointIndexer.java b/...ain/java/io/quarkus/resteasy/reactive/server/deployment/QuarkusServerEndpointIndexer.java
@@ -182,7 +182,7 @@ private boolean isDefaultJson() {
     }
 
     private boolean hasJson(ServerResourceMethod method) {
-        return hasJson(method.getProduces()) || hasJson(method.getConsumes()) || isJson(method.getSseElementType());
+        return hasJson(method.getProduces()) || hasJson(method.getConsumes()) || isJson(method.getStreamElementType());
     }
 
     private boolean hasJson(String[] types) {

diff --git a/...processor/src/main/java/org/jboss/resteasy/reactive/common/processor/EndpointIndexer.java b/...processor/src/main/java/org/jboss/resteasy/reactive/common/processor/EndpointIndexer.java
@@ -49,6 +49,7 @@
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.REST_QUERY_PARAM;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.REST_RESPONSE;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.REST_SSE_ELEMENT_TYPE;
+import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.REST_STREAM_ELEMENT_TYPE;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.SET;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.SORTED_SET;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.STRING;
@@ -329,15 +330,10 @@ protected List<ResourceMethod> createEndpoints(ClassInfo currentClassInfo,
         String[] classProduces = extractProducesConsumesValues(getAnnotationStore().getAnnotation(currentClassInfo, PRODUCES));
         String[] classConsumes = extractProducesConsumesValues(getAnnotationStore().getAnnotation(currentClassInfo, CONSUMES));
 
-        String classSseElementType = null;
-        AnnotationInstance classSseElementTypeAnnotation = getAnnotationStore().getAnnotation(currentClassInfo,
-                REST_SSE_ELEMENT_TYPE);
-        if (classSseElementTypeAnnotation != null) {
-            classSseElementType = classSseElementTypeAnnotation.value().asString();
-        }
+        String classStreamElementType = getStreamAnnotationValue(currentClassInfo);
 
         BasicResourceClassInfo basicResourceClassInfo = new BasicResourceClassInfo(resourceClassPath, classProduces,
-                classConsumes, pathParameters, classSseElementType);
+                classConsumes, pathParameters, classStreamElementType);
 
         Set<String> classNameBindings = NameBindingUtil.nameBindingNames(index, currentClassInfo);
 
@@ -563,19 +559,19 @@ private ResourceMethod createResourceMethod(ClassInfo currentClassInfo, ClassInf
             produces = applyDefaultProduces(produces, nonAsyncReturnType);
             produces = addDefaultCharsets(produces);
 
-            String sseElementType = basicResourceClassInfo.getSseElementType();
-            AnnotationInstance sseElementTypeAnnotation = getAnnotationStore().getAnnotation(currentMethodInfo,
-                    REST_SSE_ELEMENT_TYPE);
-            if (sseElementTypeAnnotation != null) {
-                sseElementType = sseElementTypeAnnotation.value().asString();
+            String streamElementType = basicResourceClassInfo.getStreamElementType();
+            String streamElementTypeInMethod = getStreamAnnotationValue(currentMethodInfo);
+            if (streamElementTypeInMethod != null) {
+                streamElementType = streamElementTypeInMethod;
             }
+
             boolean returnsMultipart = false;
             if (produces != null && produces.length == 1) {
-                if (sseElementType == null && MediaType.SERVER_SENT_EVENTS.equals(produces[0])) {
+                if (streamElementType == null && MediaType.SERVER_SENT_EVENTS.equals(produces[0])) {
                     // Handle server sent events responses
                     String[] defaultProducesForType = applyAdditionalDefaults(nonAsyncReturnType);
                     if (defaultProducesForType.length == 1) {
-                        sseElementType = defaultProducesForType[0];
+                        streamElementType = defaultProducesForType[0];
                     }
                 } else if (MediaType.MULTIPART_FORM_DATA.equals(produces[0])) {
                     // Handle multipart form data responses
@@ -614,7 +610,7 @@ private ResourceMethod createResourceMethod(ClassInfo currentClassInfo, ClassInf
                     .setBlocking(blocking)
                     .setSuspended(suspended)
                     .setSse(sse)
-                    .setSseElementType(sseElementType)
+                    .setStreamElementType(streamElementType)
                     .setFormParamRequired(formParamRequired)
                     .setMultipart(multipart)
                     .setParameters(methodParameters)
@@ -644,6 +640,25 @@ protected void handleClientSubResource(ResourceMethod resourceMethod, MethodInfo
 
     }
 
+    private String getStreamAnnotationValue(AnnotationTarget target) {
+        String value = getAnnotationValueAsString(target, REST_STREAM_ELEMENT_TYPE);
+        if (value == null) {
+            value = getAnnotationValueAsString(target, REST_SSE_ELEMENT_TYPE);
+        }
+
+        return value;
+    }
+
+    private String getAnnotationValueAsString(AnnotationTarget target, DotName annotationType) {
+        String value = null;
+        AnnotationInstance annotation = getAnnotationStore().getAnnotation(target, annotationType);
+        if (annotation != null) {
+            value = annotation.value().asString();
+        }
+
+        return value;
+    }
+
     private boolean isBlocking(MethodInfo info, BlockingDefault defaultValue) {
         Map.Entry<AnnotationTarget, AnnotationInstance> blockingAnnotation = getInheritableAnnotation(info, BLOCKING);
         Map.Entry<AnnotationTarget, AnnotationInstance> nonBlockingAnnotation = getInheritableAnnotation(info,
@@ -1374,15 +1389,15 @@ public static class BasicResourceClassInfo {
         private final String[] produces;
         private final String[] consumes;
         private final Set<String> pathParameters;
-        private final String sseElementType;
+        private final String streamElementType;
 
         public BasicResourceClassInfo(String path, String[] produces, String[] consumes, Set<String> pathParameters,
-                String sseElementType) {
+                String streamElementType) {
             this.path = path;
             this.produces = produces;
             this.consumes = consumes;
             this.pathParameters = pathParameters;
-            this.sseElementType = sseElementType;
+            this.streamElementType = streamElementType;
         }
 
         public String getPath() {
@@ -1401,8 +1416,8 @@ public Set<String> getPathParameters() {
             return pathParameters;
         }
 
-        public String getSseElementType() {
-            return sseElementType;
+        public String getStreamElementType() {
+            return streamElementType;
         }
     }
 

diff --git a/.../src/main/java/org/jboss/resteasy/reactive/common/processor/ResteasyReactiveDotNames.java b/.../src/main/java/org/jboss/resteasy/reactive/common/processor/ResteasyReactiveDotNames.java
@@ -91,6 +91,7 @@
 import org.jboss.resteasy.reactive.RestQuery;
 import org.jboss.resteasy.reactive.RestResponse;
 import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 import org.reactivestreams.Publisher;
 
 public final class ResteasyReactiveDotNames {
@@ -111,6 +112,7 @@ public final class ResteasyReactiveDotNames {
             .createSimple("org.jboss.resteasy.reactive.server.spi.ServerRequestContext");
 
     public static final DotName REST_SSE_ELEMENT_TYPE = DotName.createSimple(RestSseElementType.class.getName());
+    public static final DotName REST_STREAM_ELEMENT_TYPE = DotName.createSimple(RestStreamElementType.class.getName());
     public static final DotName CONSUMES = DotName.createSimple(Consumes.class.getName());
     public static final DotName PRODUCES = DotName.createSimple(Produces.class.getName());
     public static final DotName PROVIDER = DotName.createSimple(Provider.class.getName());

diff --git a/...reactive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestSseElementType.java b/...reactive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestSseElementType.java
@@ -9,11 +9,14 @@
 
 /**
  * Defines the MIME type of each SSE element in the annotated stream.
+ *
+ * @deprecated replaced by {@link RestStreamElementType}
  */
 @Inherited
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@Deprecated
 public @interface RestSseElementType {
     String value();
 }
diff --git a/...ctive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestStreamElementType.java b/...ctive/common/runtime/src/main/java/org/jboss/resteasy/reactive/RestStreamElementType.java
@@ -0,0 +1,19 @@
+package org.jboss.resteasy.reactive;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Defines the MIME type of each SSE element in the annotated stream.
+ */
+@Inherited
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface RestStreamElementType {
+    String value();
+}
diff --git a/...common/runtime/src/main/java/org/jboss/resteasy/reactive/common/model/ResourceMethod.java b/...common/runtime/src/main/java/org/jboss/resteasy/reactive/common/model/ResourceMethod.java
@@ -6,6 +6,7 @@
 import javax.ws.rs.Consumes;
 import javax.ws.rs.Produces;
 import org.jboss.resteasy.reactive.RestSseElementType;
+import org.jboss.resteasy.reactive.RestStreamElementType;
 
 /**
  * A representation of a REST endpoint. This is passed directly to recorders so must be bytecode serializable.
@@ -30,10 +31,11 @@ public class ResourceMethod {
     private String[] produces;
 
     /**
-     * The value of the {@link RestSseElementType} annotation, if none is specified on the method
+     * The value of the {@link RestStreamElementType} or the {@link RestSseElementType} annotation, if none is specified on the
+     * method
      * then this represents the value inherited from the class level, or null if not specified.
      */
-    private String sseElementType;
+    private String streamElementType;
 
     /**
      * The value of the {@link Consumes} annotation, if none is specified on the method
@@ -68,14 +70,14 @@ public class ResourceMethod {
     public ResourceMethod() {
     }
 
-    public ResourceMethod(String httpMethod, String path, String[] produces, String sseElementType, String[] consumes,
+    public ResourceMethod(String httpMethod, String path, String[] produces, String streamElementType, String[] consumes,
             Set<String> nameBindingNames, String name, String returnType, String simpleReturnType, MethodParameter[] parameters,
             boolean blocking, boolean suspended, boolean isSse, boolean isFormParamRequired, boolean isMultipart,
             List<ResourceMethod> subResourceMethods) {
         this.httpMethod = httpMethod;
         this.path = path;
         this.produces = produces;
-        this.sseElementType = sseElementType;
+        this.streamElementType = streamElementType;
         this.consumes = consumes;
         this.nameBindingNames = nameBindingNames;
         this.name = name;
@@ -220,13 +222,13 @@ public ResourceMethod setMultipart(boolean isMultipart) {
         return this;
     }
 
-    public ResourceMethod setSseElementType(String sseElementType) {
-        this.sseElementType = sseElementType;
+    public ResourceMethod setStreamElementType(String streamElementType) {
+        this.streamElementType = streamElementType;
         return this;
     }
 
-    public String getSseElementType() {
-        return sseElementType;
+    public String getStreamElementType() {
+        return streamElementType;
     }
 
     @Override

diff --git a/...e/common/runtime/src/main/java/org/jboss/resteasy/reactive/common/util/RestMediaType.java b/...e/common/runtime/src/main/java/org/jboss/resteasy/reactive/common/util/RestMediaType.java
@@ -5,14 +5,14 @@
 /**
  * Extended media types in Resteasy Reactive.
  */
-public final class RestMediaType {
+public class RestMediaType extends MediaType {
 
     public static final String APPLICATION_NDJSON = "application/x-ndjson";
-    public static final MediaType APPLICATION_NDJSON_TYPE = new MediaType("application", "x-ndjson");
+    public static final RestMediaType APPLICATION_NDJSON_TYPE = new RestMediaType("application", "x-ndjson");
     public static final String APPLICATION_STREAM_JSON = "application/stream+json";
-    public static final MediaType APPLICATION_STREAM_JSON_TYPE = new MediaType("application", "stream+json");
-
-    private RestMediaType() {
+    public static final RestMediaType APPLICATION_STREAM_JSON_TYPE = new RestMediaType("application", "stream+json");
 
+    public RestMediaType(String type, String subtype) {
+        super(type, subtype);
     }
 }