Add OpenAPI to management interface if enabled, with option to exclude

Signed-off-by: Phillip Kruger <[email protected]>

extensions/smallrye-graphql/deployment/src/main/java/io/quarkus/smallrye/graphql/deployment/devui/SmallRyeGraphQLDevUIProcessor.java

@@ -18,17 +18,16 @@ CardPageBuildItem createCard(NonApplicationRootPathBuildItem nonApplicationRootP
         CardPageBuildItem cardPageBuildItem = new CardPageBuildItem();
 
         // Generated GraphQL Schema
+        String schemaPath = "/" + graphQLConfig.rootPath + "/schema.graphql";
         PageBuilder schemaPage = Page.externalPageBuilder("GraphQL Schema")
                 .icon("font-awesome-solid:diagram-project")
-                .url("/" + graphQLConfig.rootPath + "/schema.graphql");
+                .url(schemaPath, schemaPath);
 
         // GraphiQL UI
         String uiPath = nonApplicationRootPathBuildItem.resolvePath(graphQLConfig.ui.rootPath);
         PageBuilder uiPage = Page.externalPageBuilder("GraphQL UI")
                 .icon("font-awesome-solid:table-columns")
-                .staticLabel("<a style='color: var(--lumo-contrast-80pct);' href='" + uiPath
-                        + "' target='_blank'><vaadin-icon class='icon' icon='font-awesome-solid:up-right-from-square'></vaadin-icon></a>")
-                .url(uiPath + "/index.html?embed=true");
+                .url(uiPath + "/index.html?embed=true", uiPath);
 
         // Learn
         PageBuilder learnLink = Page.externalPageBuilder("Learn more about GraphQL")

extensions/smallrye-health/deployment/src/main/java/io/quarkus/smallrye/health/deployment/SmallRyeHealthConfig.java

@@ -72,6 +72,13 @@ public class SmallRyeHealthConfig {
     @ConfigItem
     Optional<String> defaultHealthGroup;
 
+    /**
+     * If management interface is turned on the health endpoints and ui will be published under the management interface. This
+     * allows you to exclude Health from management by setting the value to false
+     */
+    @ConfigItem(name = "management.enabled", defaultValue = "true")
+    public boolean managementEnabled;
+
     /**
      * SmallRye Health UI configuration
      */

extensions/smallrye-health/deployment/src/main/java/io/quarkus/smallrye/health/deployment/SmallRyeHealthDevUiProcessor.java

@@ -25,16 +25,19 @@ CardPageBuildItem create(NonApplicationRootPathBuildItem nonApplicationRootPathB
             SmallRyeHealthRecorder unused) {
         CardPageBuildItem pageBuildItem = new CardPageBuildItem();
 
-        var path = nonApplicationRootPathBuildItem.resolveManagementPath(config.rootPath,
-                managementInterfaceBuildTimeConfig, launchModeBuildItem);
+        String path = nonApplicationRootPathBuildItem.resolveManagementPath(config.rootPath,
+                managementInterfaceBuildTimeConfig, launchModeBuildItem, config.managementEnabled);
+
         pageBuildItem.addPage(Page.externalPageBuilder("Health")
                 .icon("font-awesome-solid:heart-circle-bolt")
-                .url(path)
+                .url(path, path)
                 .isJsonContent());
 
+        String uipath = nonApplicationRootPathBuildItem.resolveManagementPath(config.ui.rootPath,
+                managementInterfaceBuildTimeConfig, launchModeBuildItem, config.managementEnabled);
         pageBuildItem.addPage(Page.externalPageBuilder("Health UI")
                 .icon("font-awesome-solid:stethoscope")
-                .url(nonApplicationRootPathBuildItem.resolvePath(config.ui.rootPath))
+                .url(uipath, uipath)
                 .isHtmlContent());
 
         return pageBuildItem;

extensions/smallrye-health/deployment/src/main/java/io/quarkus/smallrye/health/deployment/SmallRyeHealthProcessor.java

@@ -208,7 +208,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the health handler
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .route(healthConfig.rootPath)
                 .routeConfigKey("quarkus.smallrye-health.root-path")
                 .handler(new SmallRyeHealthHandler())
@@ -218,7 +218,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the liveness handler
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.livenessPath)
                 .handler(new SmallRyeLivenessHandler())
                 .displayOnNotFoundPage()
@@ -227,7 +227,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the readiness handler
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.readinessPath)
                 .handler(new SmallRyeReadinessHandler())
                 .displayOnNotFoundPage()
@@ -249,7 +249,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the health group handlers
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.groupPath)
                 .handler(new SmallRyeHealthGroupHandler())
                 .displayOnNotFoundPage()
@@ -258,7 +258,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         SmallRyeIndividualHealthGroupHandler handler = new SmallRyeIndividualHealthGroupHandler();
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.groupPath + "/*")
                 .handler(handler)
                 .displayOnNotFoundPage()
@@ -267,7 +267,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the wellness handler
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.wellnessPath)
                 .handler(new SmallRyeWellnessHandler())
                 .displayOnNotFoundPage()
@@ -276,7 +276,7 @@ public void defineHealthRoutes(BuildProducer<RouteBuildItem> routes,
 
         // Register the startup handler
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
-                .management()
+                .management("quarkus.smallrye-health.management.enabled")
                 .nestedRoute(healthConfig.rootPath, healthConfig.startupPath)
                 .handler(new SmallRyeStartupHandler())
                 .displayOnNotFoundPage()
@@ -443,15 +443,17 @@ void registerHealthUiHandler(
 
             Handler<RoutingContext> handler = recorder.uiHandler(result.getFinalDestination(),
                     healthUiPath, result.getWebRootConfigurations(), runtimeConfig, shutdownContext);
-            // The health ui is not a management route.
+
             routeProducer.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                    .management("quarkus.smallrye-health.management.enabled")
                     .route(healthConfig.ui.rootPath)
                     .displayOnNotFoundPage("Health UI")
                     .routeConfigKey("quarkus.smallrye-health.ui.root-path")
                     .handler(handler)
                     .build());
 
             routeProducer.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                    .management("quarkus.smallrye-health.management.enabled")
                     .route(healthConfig.ui.rootPath + "*")
                     .handler(handler)
                     .build());

extensions/smallrye-openapi-common/deployment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java

@@ -37,6 +37,13 @@ public final class SmallRyeOpenApiConfig {
     @ConfigItem(defaultValue = "false")
     public boolean ignoreStaticDocument;
 
+    /**
+     * If management interface is turned on the openapi schema document will be published under the management interface. This
+     * allows you to exclude OpenAPI from management by setting the value to false
+     */
+    @ConfigItem(name = "management.enabled", defaultValue = "true")
+    public boolean managementEnabled;
+
     /**
      * A list of local directories that should be scanned for yaml and/or json files to be included in the static model.
      * Example: `META-INF/openapi/`

extensions/smallrye-openapi/deployment/src/main/java/io/quarkus/smallrye/openapi/deployment/SmallRyeOpenApiProcessor.java

@@ -271,6 +271,7 @@ void handler(LaunchModeBuildItem launch,
         }
 
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                .management("quarkus.smallrye-openapi.management.enabled")
                 .routeFunction(openApiConfig.path, corsFilter)
                 .routeConfigKey("quarkus.smallrye-openapi.path")
                 .handler(handler)
@@ -279,16 +280,19 @@ void handler(LaunchModeBuildItem launch,
                 .build());
 
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                .management("quarkus.smallrye-openapi.management.enabled")
                 .routeFunction(openApiConfig.path + ".json", corsFilter)
                 .handler(handler)
                 .build());
 
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                .management("quarkus.smallrye-openapi.management.enabled")
                 .routeFunction(openApiConfig.path + ".yaml", corsFilter)
                 .handler(handler)
                 .build());
 
         routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                .management("quarkus.smallrye-openapi.management.enabled")
                 .routeFunction(openApiConfig.path + ".yml", corsFilter)
                 .handler(handler)
                 .build());

extensions/smallrye-openapi/deployment/src/main/java/io/quarkus/smallrye/openapi/deployment/devui/OpenApiDevUIProcessor.java

@@ -2,37 +2,44 @@
 
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.LaunchModeBuildItem;
 import io.quarkus.devui.spi.page.CardPageBuildItem;
 import io.quarkus.devui.spi.page.Page;
 import io.quarkus.smallrye.openapi.common.deployment.SmallRyeOpenApiConfig;
 import io.quarkus.swaggerui.deployment.SwaggerUiConfig;
 import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem;
+import io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig;
 
 public class OpenApiDevUIProcessor {
 
     @BuildStep(onlyIf = IsDevelopment.class)
     public CardPageBuildItem pages(NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
-            SwaggerUiConfig swaggerUiConfig, SmallRyeOpenApiConfig openApiConfig) {
+            ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig,
+            LaunchModeBuildItem launchModeBuildItem,
+            SwaggerUiConfig swaggerUiConfig,
+            SmallRyeOpenApiConfig openApiConfig) {
 
-        String uiPath = nonApplicationRootPathBuildItem.resolvePath(swaggerUiConfig.path);
-        String schemaPath = nonApplicationRootPathBuildItem.resolvePath(openApiConfig.path);
+        String uiPath = nonApplicationRootPathBuildItem.resolveManagementPath(swaggerUiConfig.path,
+                managementInterfaceBuildTimeConfig, launchModeBuildItem, openApiConfig.managementEnabled);
+
+        String schemaPath = nonApplicationRootPathBuildItem.resolveManagementPath(openApiConfig.path,
+                managementInterfaceBuildTimeConfig, launchModeBuildItem, openApiConfig.managementEnabled);
 
         CardPageBuildItem cardPageBuildItem = new CardPageBuildItem();
 
         cardPageBuildItem.addPage(Page.externalPageBuilder("Schema yaml")
-                .url(nonApplicationRootPathBuildItem.resolvePath(schemaPath))
+                .url(schemaPath, schemaPath)
                 .isYamlContent()
                 .icon("font-awesome-solid:file-lines"));
 
+        String jsonSchema = schemaPath + "?format=json";
         cardPageBuildItem.addPage(Page.externalPageBuilder("Schema json")
-                .url(nonApplicationRootPathBuildItem.resolvePath(schemaPath) + "?format=json")
+                .url(jsonSchema, jsonSchema)
                 .isJsonContent()
                 .icon("font-awesome-solid:file-code"));
 
         cardPageBuildItem.addPage(Page.externalPageBuilder("Swagger UI")
-                .url(uiPath + "/index.html?embed=true")
-                .staticLabel("<a style='color: var(--lumo-contrast-80pct);' href='" + uiPath
-                        + "' target='_blank'><vaadin-icon class='icon' icon='font-awesome-solid:up-right-from-square'></vaadin-icon></a>")
+                .url(uiPath + "/index.html?embed=true", uiPath)
                 .isHtmlContent()
                 .icon("font-awesome-solid:signs-post"));
 

extensions/swagger-ui/deployment/src/main/java/io/quarkus/swaggerui/deployment/SwaggerUiProcessor.java

@@ -37,6 +37,7 @@
 import io.quarkus.vertx.http.deployment.webjar.WebJarBuildItem;
 import io.quarkus.vertx.http.deployment.webjar.WebJarResourcesFilter;
 import io.quarkus.vertx.http.deployment.webjar.WebJarResultsBuildItem;
+import io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig;
 import io.smallrye.openapi.ui.IndexHtmlCreator;
 import io.smallrye.openapi.ui.Option;
 import io.smallrye.openapi.ui.ThemeHref;
@@ -86,6 +87,7 @@ List<HotDeploymentWatchedFileBuildItem> brandingFiles() {
     @BuildStep
     public void getSwaggerUiFinalDestination(
             NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
+            ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig,
             LaunchModeBuildItem launchMode,
             SwaggerUiConfig swaggerUiConfig,
             SmallRyeOpenApiConfig openapi,
@@ -119,7 +121,9 @@ public void getSwaggerUiFinalDestination(
                 }
             }
 
-            String openApiPath = nonApplicationRootPathBuildItem.resolvePath(openapi.path);
+            String openApiPath = nonApplicationRootPathBuildItem.resolveManagementPath(openapi.path,
+                    managementInterfaceBuildTimeConfig, launchMode, openapi.managementEnabled);
+
             String swaggerUiPath = nonApplicationRootPathBuildItem.resolvePath(swaggerUiConfig.path);
             ThemeHref theme = swaggerUiConfig.theme.orElse(ThemeHref.feeling_blue);
 
@@ -180,13 +184,15 @@ public void registerSwaggerUiHandler(SwaggerUiRecorder recorder,
                     runtimeConfig, shutdownContext);
 
             routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                    .management("quarkus.smallrye-openapi.management.enabled")
                     .route(swaggerUiConfig.path)
                     .displayOnNotFoundPage("Open API UI")
                     .routeConfigKey("quarkus.swagger-ui.path")
                     .handler(handler)
                     .build());
 
             routes.produce(nonApplicationRootPathBuildItem.routeBuilder()
+                    .management("quarkus.smallrye-openapi.management.enabled")
                     .route(swaggerUiConfig.path + "*")
                     .handler(handler)
                     .build());

extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/HttpRootPathBuildItem.java

@@ -224,6 +224,12 @@ public Builder management() {
             return this;
         }
 
+        @Override
+        public Builder management(String managementConfigKey) {
+            super.management(managementConfigKey);
+            return this;
+        }
+
         @Override
         protected NotFoundPageDisplayableEndpointBuildItem getNotFoundEndpoint() {
             return super.getNotFoundEndpoint();

extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/NonApplicationRootPathBuildItem.java

@@ -169,22 +169,27 @@ public String resolvePath(String path) {
 
     public String resolveManagementPath(String path, ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig,
             LaunchModeBuildItem mode) {
+        return resolveManagementPath(path, managementInterfaceBuildTimeConfig, mode, true);
+    }
+
+    public String resolveManagementPath(String path, ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig,
+            LaunchModeBuildItem mode, boolean extensionOverride) {
         if (path == null || path.trim().isEmpty()) {
             throw new IllegalArgumentException("Specified path can not be empty");
         }
-        if (!managementInterfaceBuildTimeConfig.enabled) {
-            if (managementRootPath != null) {
-                return UriNormalizationUtil.normalizeWithBase(managementRootPath, path, false).getPath();
-            }
-            return UriNormalizationUtil.normalizeWithBase(nonApplicationRootPath, path, false).getPath();
-        } else {
+        if (managementInterfaceBuildTimeConfig.enabled && extensionOverride) {
             // Best effort
             String prefix = getManagementUrlPrefix(mode);
             if (managementRootPath != null) {
                 return prefix + UriNormalizationUtil.normalizeWithBase(managementRootPath, path, false).getPath();
             } else {
                 return prefix + path;
             }
+        } else {
+            if (managementRootPath != null) {
+                return UriNormalizationUtil.normalizeWithBase(managementRootPath, path, false).getPath();
+            }
+            return UriNormalizationUtil.normalizeWithBase(nonApplicationRootPath, path, false).getPath();
         }
     }
 
@@ -411,6 +416,11 @@ public Builder management() {
             return this;
         }
 
+        @Override
+        public Builder management(String managementConfigKey) {
+            super.management(managementConfigKey);
+            return this;
+        }
     }
 
     /**

extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/RouteBuildItem.java

@@ -5,6 +5,9 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.ConfigProvider;
+
 import io.quarkus.builder.item.MultiBuildItem;
 import io.quarkus.vertx.http.deployment.devmode.NotFoundPageDisplayableEndpointBuildItem;
 import io.quarkus.vertx.http.deployment.devmode.console.ConfiguredPathInfo;
@@ -210,10 +213,23 @@ public Builder routeConfigKey(String attributeName) {
         }
 
         public Builder management() {
-            this.isManagement = true;
+            return management(null);
+        }
+
+        public Builder management(String managementConfigKey) {
+            if (managementConfigKey == null || shouldInclude(managementConfigKey)) {
+                this.isManagement = true;
+            } else {
+                this.isManagement = false;
+            }
             return this;
         }
 
+        private boolean shouldInclude(String managementConfigKey) {
+            Config config = ConfigProvider.getConfig();
+            return config.getValue(managementConfigKey, boolean.class);
+        }
+
         public RouteBuildItem build() {
             if (routeFunction == null) {
                 throw new IllegalStateException(

extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/qwc/qwc-external-page.js

@@ -109,7 +109,7 @@ export class QwcExternalPage extends LitElement {
                 let currentPath = window.location.pathname;
                 currentPath = currentPath.substring(0, currentPath.indexOf('/dev'));
                 return html`<div class="codeBlock">
-                            <span class="download" @click="${this._download}">
+                            <span class="download" @click="${this._download}" title="${this._externalUrl}">
                                 <vaadin-icon class="icon" icon="font-awesome-solid:download"></vaadin-icon>
                                 Download
                             </span>