Dev UI: New page types (Settings and Unlisted) and DEV MVC Moved to use those

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

Author: phillip-kruger

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/AbstractPageBuildItem.java

@@ -27,7 +27,7 @@ public AbstractPageBuildItem() {
     public AbstractPageBuildItem(PageBuilder... pageBuilder) {
         super();
         this.buildTimeData = new HashMap<>();
-        this.pageBuilders = Arrays.asList(pageBuilder);
+        this.pageBuilders = new ArrayList<>(Arrays.asList(pageBuilder));
     }
 
     public AbstractPageBuildItem(String customIdentifier) {
@@ -39,7 +39,7 @@ public AbstractPageBuildItem(String customIdentifier) {
     public AbstractPageBuildItem(String customIdentifier, PageBuilder... pageBuilder) {
         super(customIdentifier);
         this.buildTimeData = new HashMap<>();
-        this.pageBuilders = Arrays.asList(pageBuilder);
+        this.pageBuilders = new ArrayList<>(Arrays.asList(pageBuilder));
     }
 
     public void addPage(PageBuilder page) {

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/AssistantPageBuilder.java

@@ -0,0 +1,12 @@
+package io.quarkus.devui.spi.page;
+
+public class AssistantPageBuilder extends WebComponentPageBuilder {
+
+    protected AssistantPageBuilder() {
+        super();
+        icon("font-awesome-solid:robot");
+        color("var(--quarkus-assistant)");
+        tooltip("This uses the Quarkus Assistant feature");
+        metadata("isAssistantPage", "true");
+    }
+}

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/Page.java

@@ -53,8 +53,16 @@ protected Page(String icon,
             String namespaceLabel,
             String extensionId) {
 
-        this.icon = icon;
-        this.color = color;
+        if (icon != null) {
+            this.icon = icon;
+        } else {
+            this.icon = "font-awesome-solid:arrow-right"; // default
+        }
+        if (color != null) {
+            this.color = color;
+        } else {
+            this.color = "var(--lumo-contrast-80pct)"; // default
+        }
         this.tooltip = tooltip;
         this.title = title;
         this.staticLabel = staticLabel;
@@ -224,8 +232,7 @@ public static WebComponentPageBuilder webComponentPageBuilder() {
      * You can use build time data if you made it available
      */
     public static WebComponentPageBuilder assistantPageBuilder() {
-        return new WebComponentPageBuilder("font-awesome-solid:robot", "var(--quarkus-assistant)",
-                "This uses the Quarkus Assistant feature");
+        return new AssistantPageBuilder();
     }
 
     /**

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/PageBuilder.java

@@ -35,31 +35,18 @@ public abstract class PageBuilder<T> {
     protected String extensionId = null;
     protected Class preprocessor = null;
 
-    protected PageBuilder() {
-        this("font-awesome-solid:arrow-right", "var(--lumo-contrast-80pct)", null, false);
-    }
-
-    protected PageBuilder(String icon, String color, String tooltip, boolean assistantPage) {
-        this.icon = icon;
-        this.color = color;
-        this.tooltip = tooltip;
-        if (assistantPage) {
-            metadata("isAssistantPage", "true");
-        }
-    }
-
     @SuppressWarnings("unchecked")
     public T icon(String icon) {
-        if (this.icon != null) {
+        if (this.icon == null) {
             this.icon = icon;
         } else {
-            log.warn("Icon already set, ignoring " + icon);
+            log.warn("Icon already set to [" + this.icon + "] , ignoring [" + icon + "]");
         }
         return (T) this;
     }
 
     public T color(String color) {
-        if (this.color != null) {
+        if (this.color == null) {
             this.color = color;
         } else {
             log.warn("Color already set, ignoring " + color);
@@ -68,7 +55,7 @@ public T color(String color) {
     }
 
     public T tooltip(String tooltip) {
-        if (this.tooltip != null) {
+        if (this.tooltip == null) {
             this.tooltip = tooltip;
         } else {
             log.warn("Tooltip already set, ignoring " + tooltip);

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/SettingPageBuildItem.java

@@ -0,0 +1,19 @@
+package io.quarkus.devui.spi.page;
+
+/**
+ * Add a setting page to the Dev UI. (Tab in the setting screen)
+ */
+public final class SettingPageBuildItem extends AbstractPageBuildItem {
+
+    public SettingPageBuildItem() {
+        super();
+    }
+
+    public SettingPageBuildItem(PageBuilder... pageBuilder) {
+        super(pageBuilder);
+    }
+
+    public SettingPageBuildItem(String customIdentifier, PageBuilder... pageBuilder) {
+        super(customIdentifier, pageBuilder);
+    }
+}

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/UnlistedPageBuildItem.java

@@ -0,0 +1,19 @@
+package io.quarkus.devui.spi.page;
+
+/**
+ * Add a unlisted page to the Dev UI. Page that is not linked from anywhere in the Dashboard, but reachable if you know the url
+ */
+public final class UnlistedPageBuildItem extends AbstractPageBuildItem {
+
+    public UnlistedPageBuildItem() {
+        super();
+    }
+
+    public UnlistedPageBuildItem(PageBuilder... pageBuilder) {
+        super(pageBuilder);
+    }
+
+    public UnlistedPageBuildItem(String customIdentifier, PageBuilder... pageBuilder) {
+        super(customIdentifier, pageBuilder);
+    }
+}

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/WebComponentPageBuilder.java

@@ -6,10 +6,6 @@ protected WebComponentPageBuilder() {
         super();
     }
 
-    protected WebComponentPageBuilder(String icon, String color, String tooltip) {
-        super(icon, color, tooltip, true);
-    }
-
     public WebComponentPageBuilder componentName(String componentName) {
         if (componentName == null || componentName.isEmpty()) {
             throw new RuntimeException("Invalid component [" + componentName + "]");

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/BuildTimeContentProcessor.java

@@ -78,6 +78,8 @@
 import io.quarkus.devui.spi.page.MenuPageBuildItem;
 import io.quarkus.devui.spi.page.Page;
 import io.quarkus.devui.spi.page.PageBuilder;
+import io.quarkus.devui.spi.page.SettingPageBuildItem;
+import io.quarkus.devui.spi.page.UnlistedPageBuildItem;
 import io.quarkus.maven.dependency.ResolvedDependency;
 import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem;
 import io.vertx.core.json.jackson.DatabindCodec;
@@ -194,6 +196,8 @@ RelocationImportMapBuildItem createRelocationMap() {
     void mapPageBuildTimeData(List<CardPageBuildItem> cards,
             List<MenuPageBuildItem> menus,
             List<FooterPageBuildItem> footers,
+            List<SettingPageBuildItem> settings,
+            List<UnlistedPageBuildItem> unlisteds,
             CurateOutcomeBuildItem curateOutcomeBuildItem,
             BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer) {
 
@@ -221,6 +225,23 @@ void mapPageBuildTimeData(List<CardPageBuildItem> cards,
                         new BuildTimeConstBuildItem(extensionPathName, buildTimeData));
             }
         }
+        for (SettingPageBuildItem setting : settings) {
+            String extensionPathName = setting.getExtensionPathName(curateOutcomeBuildItem);
+            Map<String, BuildTimeData> buildTimeData = getBuildTimeDataForPage(setting);
+            if (!buildTimeData.isEmpty()) {
+                buildTimeConstProducer.produce(
+                        new BuildTimeConstBuildItem(extensionPathName, buildTimeData));
+            }
+        }
+
+        for (UnlistedPageBuildItem unlisted : unlisteds) {
+            String extensionPathName = unlisted.getExtensionPathName(curateOutcomeBuildItem);
+            Map<String, BuildTimeData> buildTimeData = getBuildTimeDataForPage(unlisted);
+            if (!buildTimeData.isEmpty()) {
+                buildTimeConstProducer.produce(
+                        new BuildTimeConstBuildItem(extensionPathName, buildTimeData));
+            }
+        }
     }
 
     @BuildStep(onlyIf = IsLocalDevelopment.class)
@@ -513,6 +534,8 @@ void createBuildTimeData(BuildProducer<BuildTimeConstBuildItem> buildTimeConstPr
         addThemeBuildTimeData(internalBuildTimeData, devUIConfig, themeVarsProducer);
         addMenuSectionBuildTimeData(internalBuildTimeData, internalPages, extensionsBuildItem);
         addFooterTabBuildTimeData(internalBuildTimeData, extensionsBuildItem, devUIConfig);
+        addSettingTabBuildTimeData(internalBuildTimeData, extensionsBuildItem);
+        addUnlistedPageBuildTimeData(internalBuildTimeData, extensionsBuildItem);
         addApplicationInfoBuildTimeData(internalBuildTimeData, curateOutcomeBuildItem, nonApplicationRootPathBuildItem);
         addIdeBuildTimeData(internalBuildTimeData, effectiveIdeBuildItem, launchModeBuildItem);
         buildTimeConstProducer.produce(internalBuildTimeData);
@@ -557,8 +580,7 @@ private void addMenuSectionBuildTimeData(BuildTimeConstBuildItem internalBuildTi
             List<InternalPageBuildItem> internalPages,
             ExtensionsBuildItem extensionsBuildItem) {
         // Menu section
-        @SuppressWarnings("unchecked")
-        List<Page> sectionMenu = new ArrayList();
+        List<Page> sectionMenu = new ArrayList<>();
         Collections.sort(internalPages, (t, t1) -> {
             return ((Integer) t.getPosition()).compareTo(t1.getPosition());
         });
@@ -583,11 +605,34 @@ private void addMenuSectionBuildTimeData(BuildTimeConstBuildItem internalBuildTi
         internalBuildTimeData.addBuildTimeData("menuItems", sectionMenu);
     }
 
+    private void addSettingTabBuildTimeData(BuildTimeConstBuildItem internalBuildTimeData,
+            ExtensionsBuildItem extensionsBuildItem) {
+
+        List<Page> settingTabs = new ArrayList<>();
+        // Settings from extensions
+        for (Extension e : extensionsBuildItem.getSettingTabsExtensions()) {
+            List<Page> pagesFromExtension = e.getSettingPages();
+            settingTabs.addAll(pagesFromExtension);
+        }
+        internalBuildTimeData.addBuildTimeData("settingTabs", settingTabs);
+    }
+
+    private void addUnlistedPageBuildTimeData(BuildTimeConstBuildItem internalBuildTimeData,
+            ExtensionsBuildItem extensionsBuildItem) {
+
+        List<Page> unlistedPages = new ArrayList<>();
+        // Unlisted pages from extensions
+        for (Extension e : extensionsBuildItem.getUnlistedExtensions()) {
+            List<Page> pagesFromExtension = e.getUnlistedPages();
+            unlistedPages.addAll(pagesFromExtension);
+        }
+        internalBuildTimeData.addBuildTimeData("unlistedPages", unlistedPages);
+    }
+
     private void addFooterTabBuildTimeData(BuildTimeConstBuildItem internalBuildTimeData,
             ExtensionsBuildItem extensionsBuildItem, DevUIConfig devUIConfig) {
         // Add the Footer tabs
-        @SuppressWarnings("unchecked")
-        List<Page> footerTabs = new ArrayList();
+        List<Page> footerTabs = new ArrayList<>();
         Page serverLog = Page.webComponentPageBuilder().internal()
                 .namespace("devui-logstream")
                 .title("Server")