Merge pull request #38070 from mcruzdev/issue-37901

Avoid executing OpenAPI build filters twice on build
quarkusio · Feb 6, 2024 · e037514 · e037514
2 parents 8f8f86b + dc0e6dd
commit e037514
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 7 deletions.
diff --git a/...oyment/src/main/java/io/quarkus/smallrye/openapi/deployment/SmallRyeOpenApiProcessor.java b/...oyment/src/main/java/io/quarkus/smallrye/openapi/deployment/SmallRyeOpenApiProcessor.java
@@ -1117,7 +1117,7 @@ static class Result {
 
     private OpenApiDocument loadDocument(OpenAPI staticModel, OpenAPI annotationModel,
             List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems, IndexView index) {
-        OpenApiDocument document = prepareOpenApiDocument(staticModel, annotationModel, openAPIBuildItems, index);
+        OpenApiDocument document = prepareOpenApiDocument(staticModel, annotationModel, openAPIBuildItems, index, true);
 
         Config c = ConfigProvider.getConfig();
         String title = c.getOptionalValue("quarkus.application.name", String.class).orElse("Generated");
@@ -1146,7 +1146,7 @@ private OpenApiDocument storeDocument(OutputTargetBuildItem out,
         Config config = ConfigProvider.getConfig();
         OpenApiConfig openApiConfig = new OpenApiConfigImpl(config);
 
-        OpenApiDocument document = prepareOpenApiDocument(loadedModel, null, Collections.emptyList(), index);
+        OpenApiDocument document = prepareOpenApiDocument(loadedModel, null, Collections.emptyList(), index, false);
 
         if (includeRuntimeFilters) {
             List<String> userDefinedRuntimeFilters = getUserDefinedRuntimeFilters(openApiConfig, index);
@@ -1186,7 +1186,8 @@ private OpenApiDocument storeDocument(OutputTargetBuildItem out,
     private OpenApiDocument prepareOpenApiDocument(OpenAPI staticModel,
             OpenAPI annotationModel,
             List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems,
-            IndexView index) {
+            IndexView index,
+            boolean executeBuildFilters) {
         Config config = ConfigProvider.getConfig();
         OpenApiConfig openApiConfig = new OpenApiConfigImpl(config);
 
@@ -1203,10 +1204,12 @@ private OpenApiDocument prepareOpenApiDocument(OpenAPI staticModel,
             OASFilter otherExtensionFilter = openAPIBuildItem.getOASFilter();
             document.filter(otherExtensionFilter);
         }
-        // Add user defined Build time filters
-        List<String> userDefinedFilters = getUserDefinedBuildtimeFilters(index);
-        for (String filter : userDefinedFilters) {
-            document.filter(filter(filter, index));
+        // Add user defined Build time filters if necessary
+        if (executeBuildFilters) {
+            List<String> userDefinedFilters = getUserDefinedBuildtimeFilters(index);
+            for (String filter : userDefinedFilters) {
+                document.filter(filter(filter, index));
+            }
         }
         return document;
     }

diff --git a/...ployment/src/test/java/io/quarkus/smallrye/openapi/test/jaxrs/CounterBuildtimeFilter.java b/...ployment/src/test/java/io/quarkus/smallrye/openapi/test/jaxrs/CounterBuildtimeFilter.java
@@ -0,0 +1,25 @@
+package io.quarkus.smallrye.openapi.test.jaxrs;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import org.eclipse.microprofile.openapi.OASFactory;
+import org.eclipse.microprofile.openapi.OASFilter;
+import org.eclipse.microprofile.openapi.models.OpenAPI;
+
+import io.quarkus.smallrye.openapi.OpenApiFilter;
+
+@OpenApiFilter(OpenApiFilter.RunStage.BUILD)
+public class CounterBuildtimeFilter implements OASFilter {
+
+    private static final AtomicInteger TIMES = new AtomicInteger();
+
+    public CounterBuildtimeFilter() {
+    }
+
+    @Override
+    public void filterOpenAPI(OpenAPI aOpenAPI) {
+        int times = TIMES.incrementAndGet();
+        aOpenAPI.info(
+                OASFactory.createInfo().description("CounterBuildtimeFilter was called " + times + " time(s)"));
+    }
+}
diff --git a/...o/quarkus/smallrye/openapi/test/jaxrs/OpenApiAnnotatedCounterBuildtimeFilterTestCase.java b/...o/quarkus/smallrye/openapi/test/jaxrs/OpenApiAnnotatedCounterBuildtimeFilterTestCase.java
@@ -0,0 +1,28 @@
+package io.quarkus.smallrye.openapi.test.jaxrs;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.test.QuarkusUnitTest;
+import io.restassured.RestAssured;
+
+public class OpenApiAnnotatedCounterBuildtimeFilterTestCase {
+    private static final String OPEN_API_PATH = "/q/openapi";
+
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(OpenApiResource.class, ResourceBean.class, CounterBuildtimeFilter.class));
+
+    @Test
+    public void testOpenApiFilterResource() {
+        RestAssured.given().header("Accept", "application/json")
+                .when().get(OPEN_API_PATH)
+                .then()
+                .header("Content-Type", "application/json;charset=UTF-8")
+                .body("info.description", Matchers.startsWith("CounterBuildtimeFilter was called 1 time(s)"));
+
+    }
+
+}