Merge pull request quarkusio#49776 from phillip-kruger/welcome-page-contributions

Allow extensions to contribute to welcome message

Author: phillip-kruger

extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/welcome/DynamicWelcomeBuildItem.java

@@ -0,0 +1,20 @@
+package io.quarkus.devui.spi.welcome;
+
+import io.quarkus.devui.spi.AbstractDevUIBuildItem;
+
+/**
+ * Adds dynamic data to the welcome page
+ */
+public final class DynamicWelcomeBuildItem extends AbstractDevUIBuildItem {
+
+    private final String html;
+
+    public DynamicWelcomeBuildItem(String html) {
+        super();
+        this.html = html;
+    }
+
+    public String getHTML() {
+        return this.html;
+    }
+}

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/welcome/WelcomeData.java

@@ -10,6 +10,7 @@ public class WelcomeData {
     public String resourcesDir;
     public String sourceDir;
     public List<SelectedExtension> selectedExtensions = new ArrayList<>();
+    public String dynamicContent;
 
     public void addSelectedExtension(String name, String description, URL guide) {
         selectedExtensions.add(new SelectedExtension(name, description, guide));

extensions/devui/deployment/src/main/java/io/quarkus/devui/deployment/welcome/WelcomeProcessor.java

@@ -18,6 +18,7 @@
 import io.quarkus.devui.deployment.InternalPageBuildItem;
 import io.quarkus.devui.deployment.extension.Extension;
 import io.quarkus.devui.spi.page.Page;
+import io.quarkus.devui.spi.welcome.DynamicWelcomeBuildItem;
 
 /**
  * This creates Welcome page
@@ -26,11 +27,13 @@ public class WelcomeProcessor {
 
     @BuildStep(onlyIf = IsLocalDevelopment.class)
     InternalPageBuildItem createWelcomePages(CurateOutcomeBuildItem curateOutcomeBuildItem,
+            List<DynamicWelcomeBuildItem> dynamicWelcomeBuildItems,
             ExtensionsBuildItem extensionsBuildItem) {
 
         InternalPageBuildItem welcomePageBuildItem = new InternalPageBuildItem("Welcome", 99999);
 
-        welcomePageBuildItem.addBuildTimeData("welcomeData", createWelcomeData(curateOutcomeBuildItem, extensionsBuildItem),
+        welcomePageBuildItem.addBuildTimeData("welcomeData",
+                createWelcomeData(curateOutcomeBuildItem, dynamicWelcomeBuildItems, extensionsBuildItem),
                 "Contains high level information about the Quarkus application, including the configFile, resourcesDir, sourceDir and selectedExtensions");
 
         welcomePageBuildItem.addPage(Page.webComponentPageBuilder()
@@ -44,6 +47,7 @@ InternalPageBuildItem createWelcomePages(CurateOutcomeBuildItem curateOutcomeBui
     }
 
     private WelcomeData createWelcomeData(CurateOutcomeBuildItem curateOutcomeBuildItem,
+            List<DynamicWelcomeBuildItem> dynamicWelcomeBuildItems,
             ExtensionsBuildItem extensionsBuildItem) {
 
         WorkspaceModule workspaceModule = curateOutcomeBuildItem.getApplicationModel().getApplicationModule();
@@ -52,6 +56,7 @@ private WelcomeData createWelcomeData(CurateOutcomeBuildItem curateOutcomeBuildI
         welcomeData.configFile = getConfigFile(workspaceModule);
         welcomeData.sourceDir = getSourceDir(workspaceModule);
         welcomeData.resourcesDir = getResourcesDir(workspaceModule);
+        welcomeData.dynamicContent = getDynamicContent(dynamicWelcomeBuildItems, welcomeData.resourcesDir);
 
         List<Extension> selectedExtensions = getSelectedExtensions(workspaceModule, extensionsBuildItem);
         for (Extension extension : selectedExtensions) {
@@ -151,4 +156,19 @@ private Map<String, Extension> getExtensionMap(ExtensionsBuildItem extensionsBui
         return all;
     }
 
+    private String getDynamicContent(List<DynamicWelcomeBuildItem> dynamicWelcomeBuildItems, String resourceDir) {
+        if (dynamicWelcomeBuildItems == null || dynamicWelcomeBuildItems.isEmpty())
+            return null;
+
+        StringBuilder sb = new StringBuilder();
+        for (DynamicWelcomeBuildItem dynamicWelcomeBuildItem : dynamicWelcomeBuildItems) {
+
+            String extensionProvidedHTML = dynamicWelcomeBuildItem.getHTML();
+            extensionProvidedHTML = extensionProvidedHTML.replace("${devuiState.welcomeData.resourcesDir}", resourceDir);
+
+            sb.append(extensionProvidedHTML);
+            // TODO: Add order ? Add extension name ? Add paragraph
+        }
+        return sb.toString();
+    }
 }

extensions/devui/resources/src/main/resources/dev-ui/qwc/qwc-welcome.js

@@ -9,6 +9,7 @@
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.devui.spi.page.CardPageBuildItem;
 import io.quarkus.devui.spi.page.Page;
+import io.quarkus.devui.spi.welcome.DynamicWelcomeBuildItem;
 import io.quarkus.webdependency.locator.deployment.ImportMapBuildItem;
 
 public class WebDependencyLocatorDevUIProcessor {
@@ -53,4 +54,15 @@ public void createPages(BuildProducer<CardPageBuildItem> cardPageProducer,
         cardPageProducer.produce(cardPageBuildItem);
     }
 
+    @BuildStep(onlyIf = IsDevelopment.class)
+    public DynamicWelcomeBuildItem createDynamicWelcomeData() {
+        return new DynamicWelcomeBuildItem(DYNAMIC_WELCOME);
+    }
+
+    private static final String DYNAMIC_WELCOME = """
+                <span>Learn how you can <a href="https://quarkus.io/guides/web-dependency-locator" target="_blank">add your own web content</a></span>
+                <span>Static assets: <code>${devuiState.welcomeData.resourcesDir}/META-INF/resources/</code> OR </span>
+                <span>Dynamic assets: <code>${devuiState.welcomeData.resourcesDir}/web</code></span>
+            """;
+
 }