Merge pull request #171 from xhaggi/feature/gh-170

Allow @HxRequest to ignore restore history requests and ignore them by default

Author: wimdeblauwe

htmx-spring-boot/src/main/java/io/github/wimdeblauwe/htmx/spring/boot/mvc/HtmxRequestMappingHandlerMapping.java

@@ -55,6 +55,11 @@ private RequestCondition<?> createCondition(HxRequest hxRequest) {
             conditions.add(new HeadersRequestCondition("!" + HX_BOOSTED.getValue()));
         }
 
+        if (!hxRequest.historyRestoreRequest()) {
+            // exclude history restore requests by checking whether the header is absent
+            conditions.add(new HeadersRequestCondition("!" + HX_HISTORY_RESTORE_REQUEST.getValue()));
+        }
+
         return new CompositeRequestCondition(conditions.toArray(RequestCondition[]::new));
     }
 

htmx-spring-boot/src/main/java/io/github/wimdeblauwe/htmx/spring/boot/mvc/HxRequest.java

@@ -21,6 +21,14 @@
      */
     boolean boosted() default true;
 
+    /**
+     * Whether the mapping applies also for requests that have been made for history restoration.
+     *
+     * @see <a href="https://htmx.org/reference/#request_headers">HX-History-Restore-Request</a>
+     * @since 4.1.0
+     */
+    boolean historyRestoreRequest() default false;
+
     /**
      * Restricts the mapping to the {@code id} of a specific target element.
      *

htmx-spring-boot/src/test/java/io/github/wimdeblauwe/htmx/spring/boot/mvc/HtmxRequestMappingHandlerMappingTest.java

@@ -47,6 +47,23 @@ void testHxRequestShouldIgnoreBoostedRequest() throws Exception {
                .andExpect(status().isNotFound());
     }
 
+    @Test
+    void testHxRequestShouldHandleHistoryRestoreRequest() throws Exception {
+        mockMvc.perform(get("/hx-request-handle-history-restore-request")
+                                .header(HX_REQUEST.getValue(), "true")
+                                .header(HX_HISTORY_RESTORE_REQUEST.getValue(), "true"))
+               .andExpect(status().isOk())
+               .andExpect(content().string("history-restore-request-handled"));
+    }
+
+    @Test
+    void testHxRequestShouldIgnoreHistoryRestoreRequest() throws Exception {
+        mockMvc.perform(get("/hx-request")
+                                .header(HX_REQUEST.getValue(), "true")
+                                .header(HX_HISTORY_RESTORE_REQUEST.getValue(), "true"))
+               .andExpect(status().isNotFound());
+    }
+
     @Test
     void testHxRequestTargetBar() throws Exception {
         mockMvc.perform(get("/hx-request-target")
@@ -155,6 +172,13 @@ public String hxRequestIgnoreBoosted() {
             return "boosted-ignored";
         }
 
+        @HxRequest(historyRestoreRequest = true)
+        @GetMapping("/hx-request-handle-history-restore-request")
+        @ResponseBody
+        public String hxRequestHandleHistoryRestoreRequest() {
+            return "history-restore-request-handled";
+        }
+
         @HxRequest(target = "bar")
         @GetMapping("/hx-request-target")
         @ResponseBody