Add ability to disable WebRoot entirely (#1602)

stonesmi · web-flow · commit 30baff402299 · 2025-07-10T09:42:11.000+01:00
* Add ability to disable WebRoot entirely

* Add ability to disable WebRoot entirely

* Add ability to disable WebRoot entirely

* Add ability to disable WebRoot entirely
diff --git a/example/apache-ignite/src/main/scala/org/finos/vuu/example/ignite/IgniteVuuMain.scala b/example/apache-ignite/src/main/scala/org/finos/vuu/example/ignite/IgniteVuuMain.scala
@@ -17,7 +17,7 @@ import org.finos.vuu.core.module.vui.VuiStateModule
 import org.finos.vuu.example.ignite.loader.IgniteOrderGenerator
 import org.finos.vuu.example.ignite.module.IgniteOrderDataModule
 import org.finos.vuu.net.auth.AlwaysHappyAuthenticator
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.finos.vuu.net.{AlwaysHappyLoginValidator, Authenticator, LoggedInTokenValidator}
 import org.finos.vuu.order.oms.OmsApi
 import org.finos.vuu.plugin.virtualized.VirtualizedTablePlugin
@@ -63,12 +63,8 @@ object IgniteVuuMain extends App with StrictLogging {
 
   val config = VuuServerConfig(
     VuuHttp2ServerOptions()
-      //only specify webroot if we want to load the source locally, we'll load it from the jar
-      //otherwise
-      .withWebRoot(webRoot)
+      .withWebRoot(AbsolutePathWebRoot(webRoot, directoryListings = true))
       .withSsl(certPath, keyPath)
-      //don't leave me on in prod pls....
-      .withDirectoryListings(true)
       .withBindAddress("0.0.0.0")
       .withPort(8443),
     VuuWebSocketOptions()
diff --git a/example/main-java/src/main/java/org/finos/vuu/VuuExampleMain.java b/example/main-java/src/main/java/org/finos/vuu/VuuExampleMain.java
@@ -19,6 +19,7 @@
 import org.finos.vuu.net.Authenticator;
 import org.finos.vuu.net.LoggedInTokenValidator;
 import org.finos.vuu.net.auth.AlwaysHappyAuthenticator;
+import org.finos.vuu.net.http.AbsolutePathWebRoot;
 import org.finos.vuu.net.http.VuuHttp2ServerOptions;
 import org.finos.vuu.plugin.Plugin;
 import org.finos.vuu.state.MemoryBackedVuiStateStore;
@@ -54,13 +55,9 @@ public static void main( String[] args )
         final String keyPath = "example/main/src/main/resources/certs/key.pem";
 
         final VuuServerConfig config = new VuuServerConfig(
-                        VuuHttp2ServerOptions.apply()
-                                .withWebRoot(webRoot)
-                        //if we specify a web root, it means we will serve the files from a directory on the file system
-                        //if we don't the files will be served from the vuu-ui jar directly.
-                        //.withWebRoot(".")
+                VuuHttp2ServerOptions.apply()
+                        .withWebRoot(new AbsolutePathWebRoot(webRoot, true))
                         .withSsl(certPath, keyPath)
-                        .withDirectoryListings(true)
                         .withPort(8443),
                 VuuWebSocketOptions.apply()
                         .withUri("websocket")
diff --git a/example/main/src/main/scala/org/finos/vuu/SimulMain.scala b/example/main/src/main/scala/org/finos/vuu/SimulMain.scala
@@ -20,7 +20,7 @@ import org.finos.vuu.example.rest.client.{HttpClient, StubbedBackend}
 import org.finos.vuu.example.rest.module.RestModule
 import org.finos.vuu.example.virtualtable.module.VirtualTableModule
 import org.finos.vuu.net.auth.AlwaysHappyAuthenticator
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.finos.vuu.net.{AlwaysHappyLoginValidator, Authenticator, LoggedInTokenValidator}
 import org.finos.vuu.order.oms.OmsApi
 import org.finos.vuu.plugin.virtualized.VirtualizedTablePlugin
@@ -101,9 +101,8 @@ object httpServerOptions {
     val options = VuuHttp2ServerOptions()
       //only specify webroot if we want to load the source locally, we'll load it from the jar
       //otherwise
-      .withWebRoot(c.getString(ConfigKeys.webroot))
+      .withWebRoot(AbsolutePathWebRoot(c.getString(ConfigKeys.webroot), directoryListings = true))
       //don't leave me on in prod pls....
-      .withDirectoryListings(true)
       .withBindAddress("0.0.0.0")
       .withPort(8443)
 
diff --git a/example/permission/src/test/scala/org/finos/vuu/core/module/authn/AuthNServerTest.scala b/example/permission/src/test/scala/org/finos/vuu/core/module/authn/AuthNServerTest.scala
@@ -12,7 +12,7 @@ import org.finos.vuu.core.module.TableDefContainer
 import org.finos.vuu.core.module.vui.VuiStateModule
 import org.finos.vuu.core.{VuuSecurityOptions, VuuServer, VuuServerConfig, VuuWebSocketOptions}
 import org.finos.vuu.net.auth.AlwaysHappyAuthenticator
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.finos.vuu.net.{Authenticator, LoggedInTokenValidator}
 import org.finos.vuu.state.MemoryBackedVuiStateStore
 import org.scalatest.featurespec.AnyFeatureSpec
@@ -47,9 +47,8 @@ class AuthNServerTest extends AnyFeatureSpec with Matchers with StrictLogging {
 
       val config = VuuServerConfig(
         VuuHttp2ServerOptions()
-          .withWebRoot("vuu/src/main/resources/www")
+          .withWebRoot(AbsolutePathWebRoot("vuu/src/main/resources/www", directoryListings = true))
           .withSsl("vuu/src/main/resources/certs/cert.pem", "vuu/src/main/resources/certs/key.pem")
-          .withDirectoryListings(true)
           .withPort(https),
         VuuWebSocketOptions()
           .withUri("websocket")
diff --git a/vuu/src/main/scala/org/finos/vuu/net/http/VuuHttp2Server.scala b/vuu/src/main/scala/org/finos/vuu/net/http/VuuHttp2Server.scala
@@ -86,33 +86,36 @@ class VertxHttp2Verticle(val options: VuuHttp2ServerOptions, val services: List[
       services.foreach(service => addRestService(router, service))
 
       var webRoot: String = null
-      if(options.webRoot.isEmpty){
-        webRoot = "classpath://webroot"
-        router.route("/public/*")
-          .handler(StaticHandler.create())
-        router.route("/*")
-          .handler(StaticHandler.create())
-      }else{
-        webRoot = new File(options.webRoot).getAbsoluteFile.toString
-        PathChecker.throwOnDirectoryNotExists(options.webRoot, "webroot path does not exist:")
-
-        router.route("/public/*")
-          .handler(StaticHandler.create()
-            .setWebRoot(options.webRoot)
-            .setDirectoryListing(options.allowDirectoryListings)
-          )
-
-        // Serve the static pages
-        router.route("/*")
-          .handler(StaticHandler.create()
-            .setWebRoot(options.webRoot)
-            .setDirectoryListing(options.allowDirectoryListings)
-          )
+      options.webRoot match {
+        case WebRootDisabled() =>
+          webRoot = "disabled"
+        case ClassPathWebRoot() => {
+          webRoot = "classpath://webroot"
+          router.route("/public/*")
+            .handler(StaticHandler.create())
+          router.route("/*")
+            .handler(StaticHandler.create())
+        }
+        case AbsolutePathWebRoot(path: String, directoryListings: Boolean) => {
+          webRoot = new File(path).getAbsoluteFile.toString
+          PathChecker.throwOnDirectoryNotExists(path, "webroot path does not exist:")
+
+          router.route("/public/*")
+            .handler(StaticHandler.create()
+              .setWebRoot(path)
+              .setDirectoryListing(directoryListings)
+            )
+
+          // Serve the static pages
+          router.route("/*")
+            .handler(StaticHandler.create()
+              .setWebRoot(path)
+              .setDirectoryListing(directoryListings)
+            )
+        }
       }
 
-      vertx.createHttpServer(httpOpts).requestHandler(router).listen(options.port);
-
-
+      vertx.createHttpServer(httpOpts).requestHandler(router).listen(options.port)
       logger.info(s"[HTTP2] Server Started @ ${options.port} on / with webroot $webRoot ")
 
     } catch {
diff --git a/vuu/src/main/scala/org/finos/vuu/net/http/VuuHttp2ServerOptions.scala b/vuu/src/main/scala/org/finos/vuu/net/http/VuuHttp2ServerOptions.scala
@@ -9,32 +9,34 @@ trait VuuSecurityOptions {
   def withLoginValidator(tokenValidator: LoginTokenValidator): VuuSecurityOptions
 }
 
+sealed trait VuuHttp2ServerWebRootType
+case class WebRootDisabled() extends VuuHttp2ServerWebRootType
+case class ClassPathWebRoot() extends VuuHttp2ServerWebRootType
+case class AbsolutePathWebRoot(path: String, directoryListings: Boolean = false) extends VuuHttp2ServerWebRootType
+
 trait VuuHttp2ServerOptions {
-  def allowDirectoryListings: Boolean
   def sslEnabled: Boolean
   def certPath: String
   def keyPath: String
-  def webRoot: String
+  def webRoot: VuuHttp2ServerWebRootType
   def port: Int
   def bindAddress: String
   def withSsl(certPath: String, keyPath: String): VuuHttp2ServerOptions
   def withSslDisabled(): VuuHttp2ServerOptions
-  def withWebRoot(webRoot: String): VuuHttp2ServerOptions
-  def withDirectoryListings(allow: Boolean): VuuHttp2ServerOptions
+  def withWebRoot(webRoot: VuuHttp2ServerWebRootType): VuuHttp2ServerOptions
   def withPort(port: Int): VuuHttp2ServerOptions
   def withBindAddress(bindAddress: String): VuuHttp2ServerOptions
 }
 
 object VuuHttp2ServerOptions {
   def apply(): VuuHttp2ServerOptions = {
-    VuuHttp2ServerOptionsImpl(port = 8080, allowDirectoryListings = false)
+    VuuHttp2ServerOptionsImpl(port = 8080)
   }
 }
 
 private case class VuuHttp2ServerOptionsImpl(sslEnabled: Boolean = true,
                                              certPath: String = "", keyPath: String = "",
-                                             webRoot: String = "", port: Int,
-                                             allowDirectoryListings: Boolean,
+                                             webRoot: VuuHttp2ServerWebRootType = WebRootDisabled(), port: Int,
                                              bindAddress: String = "") extends VuuHttp2ServerOptions {
 
   def withPort(port: Int): VuuHttp2ServerOptions = {
@@ -47,12 +49,9 @@ private case class VuuHttp2ServerOptionsImpl(sslEnabled: Boolean = true,
     this.copy(certPath = certPath, keyPath = keyPath, sslEnabled = true)
   }
 
-  def withWebRoot(webRoot: String): VuuHttp2ServerOptions = {
+  def withWebRoot(webRoot: VuuHttp2ServerWebRootType): VuuHttp2ServerOptions = {
     this.copy(webRoot = webRoot)
   }
 
-  override def withDirectoryListings(allow: Boolean): VuuHttp2ServerOptions = {
-    this.copy(allowDirectoryListings = allow)
-  }
   override def withBindAddress(bindAddress: String): VuuHttp2ServerOptions = this.copy(bindAddress = bindAddress)
 }
diff --git a/vuu/src/test/scala/org/finos/vuu/core/module/modulefrommodule/ModuleConstructorTest.scala b/vuu/src/test/scala/org/finos/vuu/core/module/modulefrommodule/ModuleConstructorTest.scala
@@ -6,7 +6,7 @@ import org.finos.toolbox.time.{Clock, DefaultClock}
 import org.finos.vuu.core.module.TableDefContainer
 import org.finos.vuu.core.{VuuSecurityOptions, VuuServerConfig, VuuThreadingOptions, VuuWebSocketOptions}
 import org.finos.vuu.net.{AlwaysHappyLoginValidator, Authenticator, ViewServerMessage}
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.scalatest.GivenWhenThen
 import org.scalatest.featurespec.AnyFeatureSpec
 import org.scalatest.matchers.should.Matchers
@@ -32,10 +32,9 @@ class ModuleConstructorTest extends AnyFeatureSpec with Matchers with GivenWhenT
         VuuHttp2ServerOptions()
           //only specify webroot if we want to load the source locally, we'll load it from the jar
           //otherwise
-          .withWebRoot("webRoot")
+          .withWebRoot(AbsolutePathWebRoot("webRoot", directoryListings = true))
           .withSsl("certPath", "keyPath")
           //don't leave me on in prod pls....
-          .withDirectoryListings(true)
           .withBindAddress("0.0.0.0")
           .withPort(8443),
         VuuWebSocketOptions()
diff --git a/vuu/src/test/scala/org/finos/vuu/net/rest/RestServiceTest.scala b/vuu/src/test/scala/org/finos/vuu/net/rest/RestServiceTest.scala
@@ -3,7 +3,7 @@ package org.finos.vuu.net.rest
 import com.typesafe.scalalogging.StrictLogging
 import org.finos.vuu.core.module.vui.VuiStateModule
 import org.finos.vuu.core.{VuuSecurityOptions, VuuServer, VuuServerConfig, VuuWebSocketOptions}
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.finos.vuu.state.MemoryBackedVuiStateStore
 import io.vertx.core.json.JsonObject
 import io.vertx.core.{Vertx, VertxOptions}
@@ -42,9 +42,8 @@ class RestServiceTest extends AnyFeatureSpec with Matchers with StrictLogging {
 
       val config = VuuServerConfig(
         VuuHttp2ServerOptions()
-          .withWebRoot("vuu/src/main/resources/www")
+          .withWebRoot(AbsolutePathWebRoot("vuu/src/main/resources/www", directoryListings = true))
           .withSsl("vuu/src/main/resources/certs/cert.pem", "vuu/src/main/resources/certs/key.pem")
-          .withDirectoryListings(true)
           .withPort(https),
         VuuWebSocketOptions()
           .withUri("websocket")
diff --git a/vuu/src/test/scala/org/finos/vuu/net/rpc/RpcModuleTest.scala b/vuu/src/test/scala/org/finos/vuu/net/rpc/RpcModuleTest.scala
@@ -4,7 +4,7 @@ import org.finos.vuu.client.ClientHelperFns._
 import org.finos.vuu.core.module.{MyObjectParam, TableDefContainer, TestModule}
 import org.finos.vuu.core.{VuuSecurityOptions, VuuServer, VuuServerConfig, VuuWebSocketOptions}
 import org.finos.vuu.net.WebSocketViewServerClient
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{AbsolutePathWebRoot, VuuHttp2ServerOptions}
 import org.finos.vuu.net.json.JsonVsSerializer
 import org.finos.vuu.net.ws.WebSocketClient
 import org.finos.toolbox.jmx.{MetricsProvider, MetricsProviderImpl}
@@ -42,9 +42,8 @@ class RpcModuleTest extends AnyFeatureSpec with Matchers {
 
       val config = VuuServerConfig(
         VuuHttp2ServerOptions()
-          .withWebRoot("vuu/src/main/resources/www")
+          .withWebRoot(AbsolutePathWebRoot("vuu/src/main/resources/www", directoryListings = true))
           .withSsl("vuu/src/main/resources/certs/cert.pem", "vuu/src/main/resources/certs/key.pem")
-          .withDirectoryListings(true)
           .withPort(https),
         VuuWebSocketOptions()
           .withUri("websocket")
diff --git a/vuu/src/test/scala/org/finos/vuu/wsapi/helpers/TestStartUp.scala b/vuu/src/test/scala/org/finos/vuu/wsapi/helpers/TestStartUp.scala
@@ -6,10 +6,11 @@ import org.finos.toolbox.time.Clock
 import org.finos.vuu.core.module.{TableDefContainer, ViewServerModule}
 import org.finos.vuu.core._
 import org.finos.vuu.net.auth.AlwaysHappyAuthenticator
-import org.finos.vuu.net.http.VuuHttp2ServerOptions
+import org.finos.vuu.net.http.{VuuHttp2ServerOptions, WebRootDisabled}
 import org.finos.vuu.net.json.JsonVsSerializer
 import org.finos.vuu.net.ws.WebSocketClient
 import org.finos.vuu.net.{AlwaysHappyLoginValidator, ViewServerClient, WebSocketViewServerClient}
+
 import java.security.SecureRandom
 
 class TestStartUp(moduleFactoryFunc: () => ViewServerModule)(
@@ -33,8 +34,8 @@ class TestStartUp(moduleFactoryFunc: () => ViewServerModule)(
 
     val config = VuuServerConfig(
       VuuHttp2ServerOptions()
+        .withWebRoot(WebRootDisabled())
         .withSslDisabled()
-        .withDirectoryListings(true)
         .withPort(http),
       VuuWebSocketOptions()
         .withBindAddress("0.0.0.0")
