Add Request Timeouts (apache#1431) (apache#34)

* add timeout

* add iceberg exception mapping

* dont use quarkus bom, disable timeout

* nits

Co-authored-by: Richard Liu <35082658+RichardLiu2001@users.noreply.github.com>

Author: sfc-gh-rliu

api/iceberg-service/build.gradle.kts

@@ -45,6 +45,8 @@ dependencies {
   implementation("com.fasterxml.jackson.core:jackson-annotations")
   implementation("com.fasterxml.jackson.core:jackson-core")
   implementation("com.fasterxml.jackson.core:jackson-databind")
+
+  compileOnly(libs.microprofile.fault.tolerance.api)
 }
 
 openApiGenerate {

api/management-service/build.gradle.kts

@@ -33,6 +33,7 @@ dependencies {
   compileOnly(libs.jakarta.annotation.api)
   compileOnly(libs.jakarta.inject.api)
   compileOnly(libs.jakarta.validation.api)
+  compileOnly(libs.microprofile.fault.tolerance.api)
   compileOnly(libs.swagger.annotations)
 
   implementation(libs.jakarta.servlet.api)

gradle/libs.versions.toml

@@ -74,6 +74,7 @@ jetbrains-annotations = { module = "org.jetbrains:annotations", version = "26.0.
 junit-bom = { module = "org.junit:junit-bom", version = "5.12.0" }
 logback-classic = { module = "ch.qos.logback:logback-classic", version = "1.5.16" }
 micrometer-bom = { module = "io.micrometer:micrometer-bom", version = "1.14.4" }
+microprofile-fault-tolerance-api = { module = "org.eclipse.microprofile.fault-tolerance:microprofile-fault-tolerance-api", version = "4.1.1" }
 mockito-core = { module = "org.mockito:mockito-core", version = "5.15.2" }
 mockito-junit-jupiter = { module = "org.mockito:mockito-junit-jupiter", version = "5.15.2" }
 opentelemetry-bom = { module = "io.opentelemetry:opentelemetry-bom", version = "1.47.0" }

quarkus/defaults/src/main/resources/application.properties

@@ -79,6 +79,10 @@ quarkus.otel.sdk.disabled=true
 
 quarkus.test.integration-test-profile=it
 
+quarkus.fault-tolerance.global.timeout.enabled=false
+# quarkus.fault-tolerance.global.timeout.unit=minutes
+# quarkus.fault-tolerance.global.timeout.value=10
+
 polaris.realm-context.type=default
 polaris.realm-context.realms=POLARIS
 polaris.realm-context.header-name=Polaris-Realm

quarkus/service/build.gradle.kts

@@ -47,6 +47,7 @@ dependencies {
   implementation("io.quarkus:quarkus-micrometer-registry-prometheus")
   implementation("io.quarkus:quarkus-opentelemetry")
   implementation("io.quarkus:quarkus-smallrye-context-propagation")
+  implementation("io.quarkus:quarkus-smallrye-fault-tolerance")
 
   implementation(libs.jakarta.enterprise.cdi.api)
   implementation(libs.jakarta.inject.api)

server-templates/api.mustache

@@ -57,6 +57,8 @@ import {{javaxPackage}}.inject.Inject;
 
 import org.apache.polaris.core.context.RealmContext;
 
+import org.eclipse.microprofile.faulttolerance.Timeout;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -107,6 +109,7 @@ public class {{classname}}  {
   @Consumes({ {{#consumes}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/consumes}} }){{/hasConsumes}}{{#hasProduces}}
   @Produces({ {{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}} }){{/hasProduces}}
   @Timed("{{metricsPrefix}}.{{baseName}}.{{nickname}}")
+  @Timeout
   public Response {{nickname}}({{#isMultipart}}MultipartFormDataInput input,{{/isMultipart}}{{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{^isMultipart}}{{>formParams}},{{/isMultipart}}{{#isMultipart}}{{^isFormParam}},{{/isFormParam}}{{/isMultipart}}{{/allParams}}@Context @MeterTag(key="realm_id",expression="realmIdentifier") RealmContext realmContext,@Context SecurityContext securityContext) {
 {{! Don't log form or header params in case there are secrets, e.g., OAuth tokens }}
     LOGGER.atDebug().setMessage("Invoking {{baseName}} with params")

service/common/build.gradle.kts

@@ -89,6 +89,8 @@ dependencies {
   implementation("com.azure:azure-storage-blob")
   implementation("com.azure:azure-storage-file-datalake")
 
+  implementation(libs.microprofile.fault.tolerance.api)
+
   testImplementation(platform(libs.junit.bom))
   testImplementation("org.junit.jupiter:junit-jupiter")
   testImplementation(libs.assertj.core)

service/common/src/main/java/org/apache/polaris/service/exception/IcebergExceptionMapper.java

@@ -56,6 +56,7 @@
 import org.apache.iceberg.exceptions.UnprocessableEntityException;
 import org.apache.iceberg.exceptions.ValidationException;
 import org.apache.iceberg.rest.responses.ErrorResponse;
+import org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.event.Level;
@@ -198,6 +199,7 @@ static int mapExceptionToResponseCode(RuntimeException rex) {
       case IllegalArgumentException e -> Status.BAD_REQUEST.getStatusCode();
       case UnsupportedOperationException e -> Status.NOT_ACCEPTABLE.getStatusCode();
       case WebApplicationException e -> e.getResponse().getStatus();
+      case TimeoutException e -> Status.REQUEST_TIMEOUT.getStatusCode();
       default -> Status.INTERNAL_SERVER_ERROR.getStatusCode();
     };
   }