Add web url prefix using application properties (#100)

* Add web url prefix using application properties

* Added change log

Author: sonus21

CHANGELOG.md

@@ -1,5 +1,12 @@
 # [Rqueue] New and Notable Changes
 
+### [2.8.1] - 19-Jul-2021
+
+Option to add rqueue web url prefix, the prefix is configured from application.properties file using
+`rqueue.web.url.prefix=my-application`, now rqueue dashboard would be served
+at  `my-application/rquque` instead of `/rqueue`, the configuration has higher priority than the
+HTTP request header `x-forwarded-prefix`.
+
 ### [2.8.0] - 08-Jun-2021
 
 ### Fixes
@@ -13,12 +20,11 @@
 ### Added
 
 * Pause/Unpause queue from dashboard
-* Pause/Unpause queue programatically 
+* Pause/Unpause queue programatically
 * Batch message fetching
 * Default queue priority to WEIGHTED
 * Added an API to update the visibility timeout of running job
 
-
 ## [2.7.0] - 13-Apr-2021
 
 ### Fixes
@@ -244,3 +250,5 @@ Fixes:
 [2.7.0]: https://repo1.maven.org/maven2/com/github/sonus21/rqueue-core/2.7.0-RELEASE
 
 [2.8.0]: https://repo1.maven.org/maven2/com/github/sonus21/rqueue-core/2.8.0-RELEASE
+
+[2.8.0]: https://repo1.maven.org/maven2/com/github/sonus21/rqueue-core/2.8.1-RELEASE

build.gradle

@@ -70,7 +70,7 @@ ext {
 
 subprojects {
     group = 'com.github.sonus21'
-    version = '2.8.0-RELEASE'
+    version = '2.8.1-RELEASE'
 
     dependencies {
         // https://mvnrepository.com/artifact/org.springframework/spring-messaging

docs/static/rqueue-message-flow.jpg

@@ -29,10 +29,12 @@ public class RqueueWebConfig {
    * Control whether web app is enabled or not. If it's marked false then it will throw HTTP 503
    * (Service unavailable) error.
    */
-
   @Value("${rqueue.web.enable:true}")
   private boolean enable;
 
+  @Value("${rqueue.web.url.prefix:}")
+  private String urlPrefix;
+
   @Value("${rqueue.web.max.message.move.count:1000}")
   private int maxMessageMoveCount;
 

rqueue-core/src/main/java/com/github/sonus21/rqueue/config/RqueueWebConfig.java

@@ -19,6 +19,7 @@
 import com.github.sonus21.rqueue.config.RqueueConfig;
 import com.github.sonus21.rqueue.config.RqueueWebConfig;
 import com.github.sonus21.rqueue.utils.ReactiveEnabled;
+import com.github.sonus21.rqueue.utils.StringUtils;
 import com.github.sonus21.rqueue.web.service.RqueueViewControllerService;
 import java.util.Locale;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -57,7 +58,11 @@ public ReactiveRqueueViewController(
   }
 
   private String xForwardedPrefix(ServerHttpRequest request) {
-    return request.getHeaders().getFirst("x-forwarded-prefix");
+    String prefix = rqueueWebConfig.getUrlPrefix();
+    if (StringUtils.isEmpty(prefix)) {
+      return request.getHeaders().getFirst("x-forwarded-prefix");
+    }
+    return prefix;
   }
 
   @GetMapping

rqueue-core/src/main/java/com/github/sonus21/rqueue/web/controller/ReactiveRqueueViewController.java

@@ -18,6 +18,7 @@
 
 import com.github.sonus21.rqueue.config.RqueueWebConfig;
 import com.github.sonus21.rqueue.utils.ReactiveDisabled;
+import com.github.sonus21.rqueue.utils.StringUtils;
 import com.github.sonus21.rqueue.web.service.RqueueViewControllerService;
 import com.mitchellbosecke.pebble.spring.servlet.PebbleViewResolver;
 import java.util.Locale;
@@ -53,7 +54,11 @@ public RqueueViewController(
   }
 
   private String xForwardedPrefix(HttpServletRequest request) {
-    return request.getHeader("x-forwarded-prefix");
+    String prefix = rqueueWebConfig.getUrlPrefix();
+    if (StringUtils.isEmpty(prefix)) {
+      return request.getHeader("x-forwarded-prefix");
+    }
+    return prefix;
   }
 
   @GetMapping

rqueue-core/src/main/java/com/github/sonus21/rqueue/web/controller/RqueueViewController.java

@@ -289,6 +289,13 @@
       "type": "java.lang.Boolean",
       "defaultValue": true
     },
+    {
+      "sourceType": "com.github.sonus21.rqueue.config.RqueueWebConfig",
+      "name": "rqueue.web.url.prefix",
+      "description": "Rqueue web url path prefix",
+      "type": "java.lang.String",
+      "defaultValue": null
+    },
     {
       "sourceType": "com.github.sonus21.rqueue.config.RqueueWebConfig",
       "name": "rqueue.web.max.message.move.count",