Use Quarkus Quinoa for serving web UI (#391)

* refactor(web): Migrate to Quarkus 3

This commit updates the OpenDC web server to use Quarkus 3, which
changes annotations to use the Jakarta namespace for annotations.

* refactor(web): Configure runtime variables for web UI

This commit updates the web UI to propagate runtime variables via the
next-runtime-env package. Before, we would need to replace the variables
in the generated sources by Next.js, next-runtime-env works by loading a
JavaScript file when opening the OpenDC web UI which contains the
configuration of the web app.

* refactor(web): Migrate to Quarkus Quinoa

This commit updates the OpenDC web server to make use of Quarkus Quinoa
for serving the web UI. This allows us to deprecate the complex Quarkus
extension for serving the web UI.

* refactor(web): Move web UI into Quarkus web app

This commit moves the web UI into the Quarkus web server module to
ensure we follow Quarkus Quinoa's conventions.

* refactor(web): Merge Quarkus extension into single module

This commit merges the existing Quarkus extensions into a single module
to prevent build complexity.

* refactor(web): Migrate web proto to Java

This commit migrates the web protocol to Java and removes the dependency
on Jandex Gradle.

* refactor(web): Migrate to Quarkus 3

This commit updates the OpenDC web server to use Quarkus 3, which
changes annotations to use the Jakarta namespace for annotations.

* enable DB schema migration on DEV server

* webui is not needed anymore

* remove MAINTAINERS is depricated

* fix quarkus.quinoa properties

* revert properties change, install npm in docker image to allow building the frontend

* pin postgres version, this is a best practice. Fix some properties the old ones are depricated. Added properties for local testing

* fix build error

* :opendc-web:opendc-web-proto:spotlessApply

* fix database schema

---------

Co-authored-by: Fabian Mastenbroek <mail.fabianm@gmail.com>

4 files changed, 0 insertions, 526 deletions

diff --git a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/AuthConfiguration.java b/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/AuthConfiguration.java
deleted file mode 100644
index 82e02549..00000000
--- a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/AuthConfiguration.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright (c) 2022 AtLarge Research
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package org.opendc.web.ui.deployment;
-
-import io.quarkus.runtime.annotations.ConfigGroup;
-import io.quarkus.runtime.annotations.ConfigItem;
-import java.util.Optional;
-
-/**
- * Auth configuration for the OpenDC UI extension.
- */
-@ConfigGroup
-public class AuthConfiguration {
-    /**
-     * The authentication domain.
-     */
-    @ConfigItem
-    Optional<String> domain;
-
-    /**
-     * The client identifier used by the OpenDC web ui.
-     */
-    @ConfigItem
-    Optional<String> clientId;
-
-    /**
-     * The audience of the OpenDC API.
-     */
-    @ConfigItem
-    Optional<String> audience;
-}
diff --git a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiConfig.java b/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiConfig.java
deleted file mode 100644
index 091e60ab..00000000
--- a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiConfig.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/*
- * Copyright (c) 2022 AtLarge Research
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package org.opendc.web.ui.deployment;
-
-import io.quarkus.runtime.annotations.ConfigItem;
-import io.quarkus.runtime.annotations.ConfigRoot;
-import java.util.Optional;
-
-/**
- * Build-time configuration for the OpenDC UI extension.
- */
-@ConfigRoot(name = "opendc-ui")
-public class OpenDCUiConfig {
-    /**
-     * A flag to include the OpenDC UI extension into the build.
-     */
-    @ConfigItem(defaultValue = "true")
-    boolean include;
-
-    /**
-     * The base URL of the OpenDC API.
-     */
-    @ConfigItem(defaultValue = "/api")
-    String apiBaseUrl;
-
-    /**
-     * Configuration properties for web UI authentication.
-     */
-    AuthConfiguration auth;
-
-    /**
-     * Sentry DSN.
-     */
-    @ConfigItem
-    Optional<String> sentryDsn;
-}
diff --git a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiProcessor.java b/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiProcessor.java
deleted file mode 100644
index 5733e0db..00000000
--- a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiProcessor.java
+++ /dev/null
@@ -1,301 +0,0 @@
-/*
- * Copyright (c) 2022 AtLarge Research
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package org.opendc.web.ui.deployment;
-
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import io.quarkus.deployment.annotations.BuildProducer;
-import io.quarkus.deployment.annotations.BuildStep;
-import io.quarkus.deployment.annotations.ExecutionTime;
-import io.quarkus.deployment.annotations.Record;
-import io.quarkus.deployment.builditem.FeatureBuildItem;
-import io.quarkus.deployment.builditem.ShutdownContextBuildItem;
-import io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem;
-import io.quarkus.maven.dependency.GACT;
-import io.quarkus.maven.dependency.ResolvedDependency;
-import io.quarkus.paths.PathVisit;
-import io.quarkus.vertx.http.deployment.HttpRootPathBuildItem;
-import io.quarkus.vertx.http.deployment.RouteBuildItem;
-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.vertx.core.Handler;
-import io.vertx.ext.web.RoutingContext;
-import java.io.*;
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.function.BooleanSupplier;
-import java.util.function.Function;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import org.opendc.web.ui.runtime.OpenDCUiRecorder;
-import org.opendc.web.ui.runtime.OpenDCUiRuntimeConfig;
-
-/**
- * Build processor for the OpenDC web UI Quarkus extension.
- */
-public class OpenDCUiProcessor {
-
-    private static final String FEATURE = "opendc-ui";
-    private static final GACT OPENDC_UI_WEBJAR_ARTIFACT_KEY = new GACT("org.opendc.web", "opendc-web-ui", null, "jar");
-    private static final String OPENDC_UI_WEBJAR_STATIC_RESOURCES_PATH = "META-INF/resources/opendc-web-ui";
-    private static final Pattern PATH_PARAM_PATTERN = Pattern.compile("\\[(\\w+)]");
-
-    private final ObjectMapper objectMapper = new ObjectMapper();
-
-    /**
-     * Provide the {@link FeatureBuildItem} for this Quarkus extension.
-     */
-    @BuildStep(onlyIf = IsIncluded.class)
-    public FeatureBuildItem feature() {
-        return new FeatureBuildItem(FEATURE);
-    }
-
-    /**
-     * Build the WebJar that is used to serve the Next.js resources.
-     */
-    @BuildStep(onlyIf = IsIncluded.class)
-    public WebJarBuildItem buildWebJar(OpenDCUiConfig config) {
-        return WebJarBuildItem.builder()
-                .artifactKey(OPENDC_UI_WEBJAR_ARTIFACT_KEY)
-                .root(OPENDC_UI_WEBJAR_STATIC_RESOURCES_PATH)
-                .onlyCopyNonArtifactFiles(false)
-                .useDefaultQuarkusBranding(false)
-                .filter(new InsertVariablesResourcesFilter(config))
-                .build();
-    }
-
-    /**
-     * Build the Next.js routes based on the route manifest generated by it.
-     */
-    @BuildStep(onlyIf = IsIncluded.class)
-    public OpenDCUiRoutingBuildItem buildRoutes(CurateOutcomeBuildItem curateOutcomeBuildItem) throws IOException {
-        ResolvedDependency dependency = getAppArtifact(curateOutcomeBuildItem, OPENDC_UI_WEBJAR_ARTIFACT_KEY);
-        PathVisit visit = dependency
-                .getContentTree()
-                .apply(OPENDC_UI_WEBJAR_STATIC_RESOURCES_PATH + "/routes-manifest.json", v -> v);
-
-        if (visit == null) {
-            throw new FileNotFoundException("Cannot find routes-manifest.json");
-        }
-
-        JsonNode routeManifest = objectMapper.readTree(visit.getUrl());
-
-        var pages = new ArrayList<OpenDCUiRoutingBuildItem.Page>();
-        for (Iterator<JsonNode> it = routeManifest.get("staticRoutes").elements(); it.hasNext(); ) {
-            JsonNode route = it.next();
-
-            String page = route.get("page").asText();
-
-            // Static routes do not have any path parameters
-            pages.add(new OpenDCUiRoutingBuildItem.Page(page, page));
-        }
-
-        for (Iterator<JsonNode> it = routeManifest.get("dynamicRoutes").elements(); it.hasNext(); ) {
-            JsonNode route = it.next();
-
-            String page = route.get("page").asText();
-            String path = PATH_PARAM_PATTERN.matcher(page).replaceAll(r -> ":" + r.group(1));
-
-            pages.add(new OpenDCUiRoutingBuildItem.Page(path, page));
-        }
-
-        var redirects = new ArrayList<OpenDCUiRoutingBuildItem.Redirect>();
-        for (Iterator<JsonNode> it = routeManifest.get("redirects").elements(); it.hasNext(); ) {
-            JsonNode redirect = it.next();
-            if (redirect.has("internal")) {
-                continue;
-            }
-
-            int statusCode = redirect.get("statusCode").asInt();
-            String path = redirect.get("source").asText();
-            String destination = redirect.get("destination").asText();
-
-            if (path.isEmpty()) {
-                path = "/";
-            }
-
-            redirects.add(new OpenDCUiRoutingBuildItem.Redirect(path, destination, statusCode));
-        }
-
-        var custom404 = routeManifest.get("pages404").asBoolean();
-        return new OpenDCUiRoutingBuildItem(pages, redirects, custom404);
-    }
-
-    /**
-     * Register the HTTP handles for the OpenDC web UI.
-     */
-    @BuildStep(onlyIf = IsIncluded.class)
-    @Record(ExecutionTime.RUNTIME_INIT)
-    public void registerOpenDCUiHandler(
-            OpenDCUiRecorder recorder,
-            BuildProducer<RouteBuildItem> routes,
-            HttpRootPathBuildItem httpRootPathBuildItem,
-            WebJarResultsBuildItem webJarResultsBuildItem,
-            OpenDCUiRoutingBuildItem openDCUiBuildItem,
-            OpenDCUiRuntimeConfig runtimeConfig,
-            ShutdownContextBuildItem shutdownContext) {
-
-        WebJarResultsBuildItem.WebJarResult result =
-                webJarResultsBuildItem.byArtifactKey(OPENDC_UI_WEBJAR_ARTIFACT_KEY);
-        if (result == null) {
-            return;
-        }
-
-        String basePath = httpRootPathBuildItem.getRootPath();
-        String finalDestination = result.getFinalDestination();
-
-        /* Construct dynamic routes */
-        for (var redirect : openDCUiBuildItem.getRedirects()) {
-            String destination =
-                    basePath.equals("/") ? redirect.getDestination() : basePath + redirect.getDestination();
-
-            routes.produce(httpRootPathBuildItem
-                    .routeBuilder()
-                    .route(basePath + redirect.getPath())
-                    .handler(recorder.redirectHandler(destination, redirect.getStatusCode(), runtimeConfig))
-                    .build());
-        }
-
-        for (var page : openDCUiBuildItem.getPages()) {
-            routes.produce(httpRootPathBuildItem
-                    .routeBuilder()
-                    .route(basePath + page.getPath())
-                    .handler(recorder.pageHandler(finalDestination, page.getName(), runtimeConfig))
-                    .build());
-        }
-
-        /* Construct static routes */
-        Handler<RoutingContext> staticHandler = recorder.staticHandler(
-                finalDestination, basePath, result.getWebRootConfigurations(), runtimeConfig, shutdownContext);
-
-        routes.produce(httpRootPathBuildItem
-                .routeBuilder()
-                .route("*")
-                .handler(staticHandler)
-                .build());
-    }
-
-    /**
-     * A {@link WebJarResourcesFilter} that instantiates the variables in the web jar resource.
-     */
-    private static class InsertVariablesResourcesFilter implements WebJarResourcesFilter {
-
-        private static final String HTML = ".html";
-        private static final String CSS = ".css";
-        private static final String JS = ".js";
-
-        private final OpenDCUiConfig config;
-
-        public InsertVariablesResourcesFilter(OpenDCUiConfig config) {
-            this.config = config;
-        }
-
-        @Override
-        public FilterResult apply(String fileName, InputStream stream) throws IOException {
-            if (stream == null) {
-                return new FilterResult(null, false);
-            }
-
-            // Allow replacement of variables in HTML, CSS, and JavaScript files
-            if (fileName.endsWith(HTML) || fileName.endsWith(CSS) || fileName.endsWith(JS)) {
-                byte[] oldContentBytes = stream.readAllBytes();
-                String oldContents = new String(oldContentBytes);
-                String contents = substituteVariables(oldContents, this::substitute);
-
-                boolean changed = contents.length() != oldContents.length() || !contents.equals(oldContents);
-                if (changed) {
-                    return new FilterResult(new ByteArrayInputStream(contents.getBytes()), true);
-                } else {
-                    return new FilterResult(new ByteArrayInputStream(oldContentBytes), false);
-                }
-            }
-
-            return new FilterResult(stream, false);
-        }
-
-        private String substitute(String var) {
-            switch (var) {
-                case "NEXT_PUBLIC_API_BASE_URL":
-                    return config.apiBaseUrl;
-                case "NEXT_PUBLIC_SENTRY_DSN":
-                    return config.sentryDsn.orElse("");
-                case "NEXT_PUBLIC_AUTH0_DOMAIN":
-                    return config.auth.domain.orElse("");
-                case "NEXT_PUBLIC_AUTH0_CLIENT_ID":
-                    return config.auth.clientId.orElse("");
-                case "NEXT_PUBLIC_AUTH0_AUDIENCE":
-                    return config.auth.audience.orElse("");
-                default:
-                    return null;
-            }
-        }
-
-        /**
-         * Pattern to match variables in the OpenDC web UI sources specified using the following format: "%%VAR_NAME%%".
-         * <p>
-         * Be aware that to properly handle Next.js base path, we need to also match a possible forward slash in front
-         * of the variable.
-         */
-        private static final Pattern PATTERN = Pattern.compile("%%(\\w+)%%");
-
-        /**
-         * Helper method to substitute variables in the OpenDC web UI.
-         */
-        private static String substituteVariables(String contents, Function<String, String> substitute) {
-            Matcher m = PATTERN.matcher(contents);
-            StringBuilder sb = new StringBuilder();
-
-            while (m.find()) {
-                String group = m.group(1);
-                String val = substitute.apply(group);
-                m.appendReplacement(sb, val != null ? val : group);
-            }
-
-            m.appendTail(sb);
-            return sb.toString();
-        }
-    }
-
-    /**
-     * A {@link BooleanSupplier} to determine if the OpenDC web UI extension should be included.
-     */
-    private static class IsIncluded implements BooleanSupplier {
-        OpenDCUiConfig config;
-
-        @Override
-        public boolean getAsBoolean() {
-            return config.include;
-        }
-    }
-
-    private static ResolvedDependency getAppArtifact(CurateOutcomeBuildItem curateOutcomeBuildItem, GACT artifactKey) {
-        for (ResolvedDependency dep :
-                curateOutcomeBuildItem.getApplicationModel().getDependencies()) {
-            if (dep.getKey().equals(artifactKey)) {
-                return dep;
-            }
-        }
-        throw new RuntimeException("Could not find artifact " + artifactKey + " among the application dependencies");
-    }
-}
diff --git a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiRoutingBuildItem.java b/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiRoutingBuildItem.java
deleted file mode 100644
index 6cf44893..00000000
--- a/opendc-web/opendc-web-ui-quarkus-deployment/src/main/java/org/opendc/web/ui/deployment/OpenDCUiRoutingBuildItem.java
+++ /dev/null
@@ -1,118 +0,0 @@
-/*
- * Copyright (c) 2022 AtLarge Research
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package org.opendc.web.ui.deployment;
-
-import io.quarkus.builder.item.SimpleBuildItem;
-import java.util.List;
-
-/**
- * Build item containing the routes for the OpenDC web UI.
- */
-public final class OpenDCUiRoutingBuildItem extends SimpleBuildItem {
-
-    private final boolean custom404;
-    private final List<Page> pages;
-    private final List<Redirect> redirects;
-
-    /**
-     * Construct a {@link OpenDCUiRoutingBuildItem} instance.
-     *
-     * @param routes The routes defined by Next.js.
-     * @param redirects The redirects that have been defined by Next.js.
-     * @param custom404 A flag to indicate that custom 404 pages are enabled.
-     */
-    public OpenDCUiRoutingBuildItem(List<Page> routes, List<Redirect> redirects, boolean custom404) {
-        this.custom404 = custom404;
-        this.pages = routes;
-        this.redirects = redirects;
-    }
-
-    public List<Page> getPages() {
-        return pages;
-    }
-
-    public List<Redirect> getRedirects() {
-        return redirects;
-    }
-
-    public boolean hasCustom404() {
-        return this.custom404;
-    }
-
-    /**
-     * A redirect defined by the Next.js routes manifest.
-     */
-    public static final class Redirect {
-
-        private final String path;
-        private final String destination;
-        private final int statusCode;
-
-        /**
-         * Construct a {@link Redirect} route.
-         *
-         * @param path The path that should result in a redirect.
-         * @param destination The destination of the redirect.
-         * @param statusCode The status code of the redirect.
-         */
-        public Redirect(String path, String destination, int statusCode) {
-            this.statusCode = statusCode;
-            this.path = path;
-            this.destination = destination;
-        }
-
-        public String getPath() {
-            return path;
-        }
-
-        public String getDestination() {
-            return destination;
-        }
-
-        public int getStatusCode() {
-            return statusCode;
-        }
-    }
-
-    /**
-     * A page defined by the Next.js routes manifest.
-     */
-    public static final class Page {
-
-        private final String path;
-        private final String name;
-
-        public Page(String path, String page) {
-            this.path = path;
-            this.name = page;
-        }
-
-        public String getPath() {
-            return path;
-        }
-
-        public String getName() {
-            return name;
-        }
-    }
-}