GH-2076 Prototype redirect plugin + a little bit more user-friendly routing api (#2077)

dzikoysk · web-flow · commit d3137a5d9e26 · 2024-03-21T18:21:27.000+01:00
diff --git a/.run/Run Reposilite - Test workspace.run.xml b/.run/Run Reposilite - Test workspace.run.xml
@@ -10,7 +10,7 @@
     <option name="MAIN_CLASS_NAME" value="com.reposilite.ReposiliteLauncherKt" />
     <module name="reposilite-parent.reposilite-backend.main" />
     <option name="PROGRAM_PARAMETERS" value="--token name:secret --level=DEBUG" />
-    <option name="VM_PARAMETERS" value="-Xmx32M" />
+    <option name="VM_PARAMETERS" value="-Xmx32M -Dreposilite.redirect.default-repository=releases" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/reposilite-test/workspace" />
     <extension name="net.ashald.envfile">
       <option name="IS_ENABLED" value="false" />
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/ReposiliteFactory.kt b/reposilite-backend/src/main/kotlin/com/reposilite/ReposiliteFactory.kt
@@ -27,8 +27,8 @@ import com.reposilite.shared.extensions.LoomExtensions
 import com.reposilite.shared.extensions.newFixedThreadPool
 import com.reposilite.shared.extensions.newSingleThreadScheduledExecutor
 import com.reposilite.web.HttpServer
-import panda.utilities.console.Effect
 import kotlin.io.path.absolutePathString
+import panda.utilities.console.Effect
 
 object ReposiliteFactory {
 
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/maven/infrastructure/MavenEndpoints.kt b/reposilite-backend/src/main/kotlin/com/reposilite/maven/infrastructure/MavenEndpoints.kt
@@ -22,12 +22,16 @@ import com.reposilite.maven.api.DeleteRequest
 import com.reposilite.maven.api.DeployRequest
 import com.reposilite.maven.api.LookupRequest
 import com.reposilite.shared.extensions.resultAttachment
+import com.reposilite.shared.extensions.uri
+import com.reposilite.storage.api.Location
+import com.reposilite.token.AccessTokenIdentifier
 import com.reposilite.web.api.ReposiliteRoute
 import io.javalin.community.routing.Route.DELETE
 import io.javalin.community.routing.Route.GET
 import io.javalin.community.routing.Route.HEAD
 import io.javalin.community.routing.Route.POST
 import io.javalin.community.routing.Route.PUT
+import io.javalin.http.Context
 import io.javalin.openapi.ContentType.FORM_DATA_MULTIPART
 import io.javalin.openapi.HttpMethod
 import io.javalin.openapi.OpenApi
@@ -61,26 +65,30 @@ internal class MavenEndpoints(
     private val findFile = ReposiliteRoute<Unit>("/{repository}/<gav>", HEAD, GET) {
         accessed {
             requireGav { gav ->
-                LookupRequest(this?.identifier, requireParameter("repository"), gav)
-                    .let { request -> mavenFacade.findFile(request) }
-                    .peek {
-                        ctx.resultAttachment(
-                            name = it.document.name,
-                            contentType = it.document.contentType,
-                            contentLength = it.document.contentLength,
-                            compressionStrategy = compressionStrategy,
-                            cache = it.cachable,
-                            data = it.content
-                        )
-                    }
-                    .onError {
-                        ctx.status(it.status).html(frontendFacade.createNotFoundPage(uri, it.message))
-                        mavenFacade.logger.debug("FIND | Could not find file due to $it")
-                    }
+                findFile(ctx, this?.identifier, requireParameter("repository"), gav)
             }
         }
     }
 
+    fun findFile(ctx: Context, identifier: AccessTokenIdentifier?, repository: String, gav: Location) {
+        LookupRequest(identifier, repository, gav)
+            .let { request -> mavenFacade.findFile(request) }
+            .peek {
+                ctx.resultAttachment(
+                    name = it.document.name,
+                    contentType = it.document.contentType,
+                    contentLength = it.document.contentLength,
+                    compressionStrategy = compressionStrategy,
+                    cache = it.cachable,
+                    data = it.content
+                )
+            }
+            .onError {
+                ctx.status(it.status).html(frontendFacade.createNotFoundPage(ctx.uri(), it.message))
+                mavenFacade.logger.debug("FIND | Could not find file due to $it")
+            }
+    }
+
     @OpenApi(
         tags = [ "Maven" ],
         path = "/{repository}/{gav}",
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/redirect/RedirectPlugin.kt b/reposilite-backend/src/main/kotlin/com/reposilite/redirect/RedirectPlugin.kt
@@ -0,0 +1,66 @@
+package com.reposilite.redirect
+
+import com.reposilite.configuration.local.LocalConfiguration
+import com.reposilite.frontend.FrontendFacade
+import com.reposilite.maven.MavenFacade
+import com.reposilite.maven.infrastructure.MavenEndpoints
+import com.reposilite.plugin.api.Facade
+import com.reposilite.plugin.api.Plugin
+import com.reposilite.plugin.api.ReposilitePlugin
+import com.reposilite.plugin.event
+import com.reposilite.plugin.facade
+import com.reposilite.storage.api.Location
+import com.reposilite.web.api.ReposiliteRoute
+import com.reposilite.web.api.RoutingSetupEvent
+import io.javalin.community.routing.Route.GET
+import io.javalin.community.routing.Route.HEAD
+
+@Plugin(name = "redirect", dependencies = ["local-configuration", "frontend", "maven"])
+class RedirectPlugin : ReposilitePlugin() {
+
+    private val redirectTo: String? = System.getProperty("reposilite.redirect.default-repository", "")
+
+    override fun initialize(): Facade? {
+        if (redirectTo.isNullOrEmpty()) {
+            return null
+        }
+
+        val mavenFacade = facade<MavenFacade>()
+
+        val mavenEndpoints = MavenEndpoints(
+            mavenFacade = mavenFacade,
+            frontendFacade = facade<FrontendFacade>(),
+            compressionStrategy = facade<LocalConfiguration>().compressionStrategy.get()
+        )
+
+        logger.info("")
+        logger.info("--- Redirect")
+
+        val redirectedRoutes = mavenFacade.getRepository(redirectTo)
+            ?.storageProvider
+            ?.getFiles(Location.of("/"))
+            ?.orNull()
+            ?.map {
+                logger.info("Redirecting /${it.getSimpleName()}/<gav> to /$redirectTo/${it.getSimpleName()}/<gav>")
+
+                ReposiliteRoute<Unit>("/${it.getSimpleName()}/<gav>", HEAD, GET) {
+                    accessed {
+                        mavenEndpoints.findFile(
+                            ctx = ctx,
+                            identifier = this?.identifier,
+                            repository = redirectTo,
+                            gav = it.resolve(requireParameter("gav"))
+                        )
+                    }
+                }
+            }
+            ?: emptyList()
+
+        event { event: RoutingSetupEvent ->
+            event.register(redirectedRoutes)
+        }
+
+        return null
+    }
+
+}
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/web/api/Routing.kt b/reposilite-backend/src/main/kotlin/com/reposilite/web/api/Routing.kt
@@ -17,6 +17,7 @@
 package com.reposilite.web.api
 
 import com.reposilite.shared.ContextDsl
+import com.reposilite.web.infrastructure.ReposiliteDslRoute
 import com.reposilite.web.routing.RouteMethod
 import io.javalin.community.routing.Route
 import io.javalin.community.routing.dsl.DefaultDslRoute
@@ -33,17 +34,8 @@ abstract class ReposiliteRoutes : DslContainer<DslRoute<ContextDsl<*>, Unit>, Co
             .map { it as ReposiliteRoute<Any> }
             .toSet()
 
-    @Suppress("UNCHECKED_CAST")
-    override fun routes(): Collection<DslRoute<ContextDsl<*>, Unit>> =
-        routes.flatMap { route ->
-            route.methods.map { method ->
-                DefaultDslRoute(
-                    path = route.path,
-                    method = method,
-                    handler = route.handler as ContextDsl<*>.() -> Unit
-                )
-            }
-        }
+    override fun routes(): Collection<ReposiliteDslRoute> =
+        routes.flatMap { it.toDslRoutes() }
 
 }
 
@@ -62,9 +54,19 @@ class ReposiliteRoute<R>(
         path = path,
         methods = methods
             .map { Route.valueOf(it.name) }
-            .toTypedArray()
-        ,
+            .toTypedArray(),
         handler = handler
     )
 
+    @Suppress("UNCHECKED_CAST")
+    fun toDslRoutes(): Set<ReposiliteDslRoute> =
+        methods.mapTo(HashSet()) { method ->
+            @Suppress("UNCHECKED_CAST")
+            DefaultDslRoute(
+                path = path,
+                method = method,
+                handler = handler as ContextDsl<*>.() -> Unit
+            )
+        }
+
 }
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/web/api/RoutingSetupEvent.kt b/reposilite-backend/src/main/kotlin/com/reposilite/web/api/RoutingSetupEvent.kt
@@ -21,17 +21,25 @@ import com.reposilite.plugin.api.Event
 
 class RoutingSetupEvent(val reposilite: Reposilite) : Event {
 
-    private val routes: MutableSet<ReposiliteRoutes> = mutableSetOf()
+    private val routes: MutableSet<ReposiliteRoute<*>> = mutableSetOf()
 
-    fun registerRoutes(routesToAdd: ReposiliteRoutes) {
-        routes.add(routesToAdd)
+    fun register(routeToAdd: ReposiliteRoute<*>) {
+        routes.add(routeToAdd)
     }
 
-    fun registerRoutes(routesToAdd: Set<ReposiliteRoutes>) {
+    fun register(routesToAdd: Collection<ReposiliteRoute<*>>) {
         routes.addAll(routesToAdd)
     }
 
-    fun getRoutes(): Collection<ReposiliteRoutes> =
+    fun registerRoutes(routesToAdd: ReposiliteRoutes) {
+        routes.addAll(routesToAdd.routes)
+    }
+
+    fun registerRoutes(routesToAdd: Collection<ReposiliteRoutes>) {
+        routes.addAll(routesToAdd.map { it.routes }.flatten())
+    }
+
+    fun getRoutes(): Collection<ReposiliteRoute<*>> =
         routes
 
 }
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/web/application/JavalinConfiguration.kt b/reposilite-backend/src/main/kotlin/com/reposilite/web/application/JavalinConfiguration.kt
@@ -100,8 +100,13 @@ internal object JavalinConfiguration {
             authenticationFacade = extensionManager.facade()
         )
 
-        extensionManager.emitEvent(RoutingSetupEvent(reposilite)).getRoutes().asSequence().flatMap { it.routes() }.distinctBy { "${it.method.name}:${it.path}" }
-            .toSet().let { route ->
+        extensionManager.emitEvent(RoutingSetupEvent(reposilite))
+            .getRoutes()
+            .asSequence()
+            .flatMap { it.toDslRoutes() }
+            .distinctBy { "${it.method.name}:${it.path}" }
+            .toSet()
+            .let { route ->
                 config.router.mount(reposiliteDsl) {
                     it.routes(route)
                 }
diff --git a/reposilite-backend/src/main/kotlin/com/reposilite/web/infrastructure/ReposiliteRouting.kt b/reposilite-backend/src/main/kotlin/com/reposilite/web/infrastructure/ReposiliteRouting.kt
@@ -22,22 +22,22 @@ import io.javalin.http.Header
 import io.javalin.http.HttpStatus.INTERNAL_SERVER_ERROR
 import io.javalin.util.javalinLazy
 
-typealias ReposiliteRouting = DslRouting<ReposiliteConfiguration, ReposiliteRoute, ReposiliteScope, Unit>
-typealias ReposiliteRoute = DslRoute<ContextDsl<*>, Unit>
+typealias ReposiliteRouting = DslRouting<ReposiliteConfiguration, ReposiliteDslRoute, ReposiliteScope, Unit>
+typealias ReposiliteDslRoute = DslRoute<ContextDsl<*>, Unit>
 typealias ReposiliteExceptionHandler = DslExceptionHandler<ContextDsl<*>, Exception, Unit>
 typealias ReposiliteScope = ContextDsl<*>
 
 class ReposiliteDsl(
-    private val routeFactory: (ReposiliteRoute) -> Handler,
+    private val routeFactory: (ReposiliteDslRoute) -> Handler,
     private val exceptionRouteFactory: (ReposiliteExceptionHandler) -> ExceptionHandler<Exception>
-) : RoutingDslFactory<ReposiliteConfiguration, ReposiliteRoute, ContextDsl<*>, Unit> {
+) : RoutingDslFactory<ReposiliteConfiguration, ReposiliteDslRoute, ContextDsl<*>, Unit> {
 
-    open class ReposiliteConfiguration : RoutingDslConfiguration<ReposiliteRoute, ContextDsl<*>, Unit>()
+    open class ReposiliteConfiguration : RoutingDslConfiguration<ReposiliteDslRoute, ContextDsl<*>, Unit>()
 
     override fun createConfiguration(): ReposiliteConfiguration =
         ReposiliteConfiguration()
 
-    override fun createHandler(route: ReposiliteRoute): Handler =
+    override fun createHandler(route: ReposiliteDslRoute): Handler =
         routeFactory.invoke(route)
 
     override fun createExceptionHandler(handler: ReposiliteExceptionHandler): ExceptionHandler<Exception> =
diff --git a/reposilite-backend/src/main/resources/META-INF/services/com.reposilite.plugin.api.ReposilitePlugin b/reposilite-backend/src/main/resources/META-INF/services/com.reposilite.plugin.api.ReposilitePlugin
@@ -2,6 +2,7 @@ com.reposilite.auth.application.AuthenticationPlugin
 com.reposilite.console.application.ConsolePlugin
 com.reposilite.frontend.application.FrontendPlugin
 com.reposilite.maven.application.MavenPlugin
+com.reposilite.redirect.RedirectPlugin
 com.reposilite.javadocs.application.JavadocPlugin
 com.reposilite.configuration.application.ConfigurationPlugin
 com.reposilite.configuration.local.LocalConfigurationPlugin
