Merge pull request #50938 from geoand/#50932

Add support for `java.time.Period` in Quarkus REST

Author: geoand

independent-projects/resteasy-reactive/common/processor/src/main/java/org/jboss/resteasy/reactive/common/processor/EndpointIndexer.java

@@ -45,6 +45,7 @@
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PATH;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PATH_PARAM;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PATH_SEGMENT;
+import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PERIOD;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PRIMITIVE_BOOLEAN;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PRIMITIVE_CHAR;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PRIMITIVE_DOUBLE;
@@ -159,7 +160,7 @@ public abstract class EndpointIndexer<T extends EndpointIndexer<T, PARAM, METHOD
             RESOURCE_INFO);
 
     protected static final Set<DotName> SUPPORT_TEMPORAL_PARAMS = Set.of(INSTANT, LOCAL_DATE, LOCAL_TIME, LOCAL_DATE_TIME,
-            OFFSET_TIME, OFFSET_DATE_TIME, ZONED_DATE_TIME, YEAR, YEAR_MONTH);
+            OFFSET_TIME, OFFSET_DATE_TIME, ZONED_DATE_TIME, YEAR, YEAR_MONTH, PERIOD);
 
     protected static final Logger log = Logger.getLogger(EndpointIndexer.class);
     protected static final String[] EMPTY_STRING_ARRAY = new String[] {};

independent-projects/resteasy-reactive/common/processor/src/main/java/org/jboss/resteasy/reactive/common/processor/ResteasyReactiveDotNames.java

@@ -11,6 +11,7 @@
 import java.time.LocalTime;
 import java.time.OffsetDateTime;
 import java.time.OffsetTime;
+import java.time.Period;
 import java.time.Year;
 import java.time.YearMonth;
 import java.time.ZonedDateTime;
@@ -207,6 +208,7 @@ public final class ResteasyReactiveDotNames {
     public static final DotName ZONED_DATE_TIME = DotName.createSimple(ZonedDateTime.class.getName());
     public static final DotName YEAR = DotName.createSimple(Year.class.getName());
     public static final DotName YEAR_MONTH = DotName.createSimple(YearMonth.class.getName());
+    public static final DotName PERIOD = DotName.createSimple(Period.class.getName());
 
     public static final DotName UNI = DotName.createSimple(Uni.class.getName());
     public static final DotName MULTI = DotName.createSimple(Multi.class.getName());

independent-projects/resteasy-reactive/server/processor/src/main/java/org/jboss/resteasy/reactive/server/processor/ServerEndpointIndexer.java

@@ -18,6 +18,7 @@
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.MULTI_VALUED_MAP;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.OFFSET_DATE_TIME;
 import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.OFFSET_TIME;
+import static org.jboss.resteasy.reactive.common.processor.ResteasyReactiveDotNames.PERIOD;
 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.YEAR;
@@ -81,6 +82,7 @@
 import org.jboss.resteasy.reactive.server.core.parameters.converters.OptionalConverter;
 import org.jboss.resteasy.reactive.server.core.parameters.converters.ParameterConverterSupplier;
 import org.jboss.resteasy.reactive.server.core.parameters.converters.PathSegmentParamConverter;
+import org.jboss.resteasy.reactive.server.core.parameters.converters.PeriodParamConverter;
 import org.jboss.resteasy.reactive.server.core.parameters.converters.RuntimeResolvedConverter;
 import org.jboss.resteasy.reactive.server.core.parameters.converters.SetConverter;
 import org.jboss.resteasy.reactive.server.core.parameters.converters.SortedSetConverter;
@@ -636,6 +638,8 @@ private ParameterConverterSupplier determineTemporalConverter(DotName paramType,
             return new YearParamConverter.Supplier(format, dateTimeFormatterProviderClassName);
         } else if (YEAR_MONTH.equals(paramType)) {
             return new YearMonthParamConverter.Supplier(format, dateTimeFormatterProviderClassName);
+        } else if (PERIOD.equals(paramType)) {
+            return new PeriodParamConverter.Supplier();
         }
 
         throw new RuntimeException(

independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/core/parameters/converters/PeriodParamConverter.java

@@ -0,0 +1,24 @@
+package org.jboss.resteasy.reactive.server.core.parameters.converters;
+
+import java.time.Period;
+
+public class PeriodParamConverter implements ParameterConverter {
+
+    @Override
+    public Object convert(Object value) {
+        return Period.parse(value.toString());
+    }
+
+    public static final class Supplier implements ParameterConverterSupplier {
+
+        @Override
+        public ParameterConverter get() {
+            return new PeriodParamConverter();
+        }
+
+        @Override
+        public String getClassName() {
+            return PeriodParamConverter.class.getName();
+        }
+    }
+}

independent-projects/resteasy-reactive/server/vertx/src/test/java/org/jboss/resteasy/reactive/server/vertx/test/simple/PeriodParamTest.java

@@ -0,0 +1,51 @@
+package org.jboss.resteasy.reactive.server.vertx.test.simple;
+
+import static org.hamcrest.Matchers.equalTo;
+
+import java.time.Period;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
+
+import org.jboss.resteasy.reactive.server.vertx.test.framework.ResteasyReactiveUnitTest;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.restassured.RestAssured;
+
+public class PeriodParamTest {
+
+    @RegisterExtension
+    static ResteasyReactiveUnitTest test = new ResteasyReactiveUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(PeriodResource.class));
+
+    @Test
+    public void periodAsQueryParam() {
+        RestAssured.get("/period?value=P1Y2M3D")
+                .then().statusCode(200).body(equalTo("P1Y2M3D"));
+    }
+
+    @Test
+    public void periodAsPathParam() {
+        RestAssured.get("/period/P2Y")
+                .then().statusCode(200).body(equalTo("P2Y"));
+    }
+
+    @Path("period")
+    public static class PeriodResource {
+
+        @GET
+        public String query(@QueryParam("value") Period period) {
+            return period.toString();
+        }
+
+        @GET
+        @Path("{value}")
+        public String path(@PathParam("value") Period period) {
+            return period.toString();
+        }
+    }
+}