add urlPathPrefix configuration parameter (#377)

Author: sanity

api/kweb-core.api

@@ -917,6 +917,7 @@ public abstract class kweb/config/KwebConfiguration {
 	public fun getClientOfflineToastTextTemplate ()Ljava/lang/String;
 	public abstract fun getClientStateStatsEnabled ()Z
 	public abstract fun getClientStateTimeout ()Ljava/time/Duration;
+	public fun getUrlPathPrefix ()Ljava/lang/String;
 	public fun onWebsocketMessageHandlingFailure (Ljava/lang/Exception;)V
 	public fun robotsTxt (Lio/ktor/server/application/ApplicationCall;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public final fun validate ()V

jitpack.yml

@@ -0,0 +1,2 @@
+jdk:
+  - openjdk17

src/main/kotlin/kweb/Kweb.kt

@@ -223,7 +223,7 @@ class Kweb private constructor(
                 kwebConfig.faviconIco(call)
             }
 
-            get("/{visitedUrl...}") {
+            get("${kwebConfig.urlPathPrefix}/{visitedUrl...}") {
                 respondKweb(call, buildPage)
             }
 
@@ -237,7 +237,7 @@ class Kweb private constructor(
         HtmlDocumentSupplier.createDocTemplate(plugins, application.routing { })
 
         application.routing {
-            webSocket("/ws") {
+            webSocket("/kweb_ws") {
                 listenForWebsocketConnection()
             }
         }
@@ -329,7 +329,7 @@ class Kweb private constructor(
     suspend fun respondKweb(call: ApplicationCall, buildPage: WebBrowser.() -> Unit) {
         val htmlDocument = HtmlDocumentSupplier.getTemplateCopy()
 
-        // The client prefix allows to monitor the ressource usage (#Sessions, State Size) per User
+        // The client prefix allows to monitor the resource usage (#Sessions, State Size) per User
         val clientPrefix = determineClientPrefix(call)
         val kwebSessionId = clientPrefix + ":" + createNonce()
 

src/main/kotlin/kweb/config/KwebConfiguration.kt

@@ -86,6 +86,27 @@ abstract class KwebConfiguration {
      */
     open val clientOfflineToastTextTemplate: String = "Connection to server lost, attempting to reconnect"
 
+    /**
+     * By default, Kweb will handle all paths under `/`, but this may not be desirable if you have other
+     * Ktor route handlers. This function allows you to add a prefix to the Kweb route handler, e.g. `/my_kweb_site`,
+     * so that only URLs under that path will be handled by Kweb.
+     *
+     * ```kotlin
+     *    cfg.urlPathPrefix = ""
+     *    path("/users/{userId}") { } // will be accessible at /users/1234
+     *
+     *    cfg.urlPathPrefix = "/my_kweb_site"
+     *    path("/my_kweb_site/users/{userId}") { } // will be accessible at /my_kweb_site/users/1234
+     *
+     *    cfg.urlPathPrefix = "/my_kweb_site"
+     *    path("/users/{userId}") { } // Will **NOT** be accessible
+     * ```
+     *
+     * The path used for the WebSocket connection (`/kweb_ws`) and static assets (`/kweb_static/`) will be
+     * unaffected by this setting.
+     */
+    open val urlPathPrefix : String = ""
+
     protected object Accessor {
         private val env = System.getenv()
 

src/main/resources/kweb/kweb_bootstrap.js

@@ -93,7 +93,7 @@ function debugErr(debugToken, err, errMsg) {
 }
 
 function connectWs() {
-    var wsURL = toWSUrl("ws");
+    var wsURL = toWSUrl("kweb_ws");
     console.debug("Establishing websocket connection", wsURL);
     socket = new WebSocket(wsURL);
     if (window.WebSocket === undefined) {