control filters order

Author: Tristan-WorkGH

src/main/java/org/gridsuite/gateway/filters/AbstractGlobalPreFilter.java

@@ -16,12 +16,12 @@
 /**
  * @author Slimane Amar <slimane.amar at rte-france.com>
  */
-public abstract class AbstractGlobalPreFilter implements GlobalFilter, Ordered {
+abstract class AbstractGlobalPreFilter implements GlobalFilter, Ordered {
 
     protected Mono<Void> completeWithCode(ServerWebExchange exchange, HttpStatus code) {
         exchange.getResponse().setStatusCode(code);
         if ("websocket".equalsIgnoreCase(exchange.getRequest().getHeaders().getUpgrade())) {
-            // Force the connection to close for websockets handshakes to workaround apache
+            // Force the connection to close for websockets handshakes to work around apache
             // httpd reusing the connection for all subsequent requests in this connection.
             exchange.getResponse().getHeaders().set(HttpHeaders.CONNECTION, "close");
         }

src/test/java/org/gridsuite/gateway/GatewayApplicationTest.java

@@ -1,17 +1,25 @@
 package org.gridsuite.gateway;
 
+import lombok.extern.slf4j.Slf4j;
 import org.assertj.core.api.InstanceOfAssertFactories;
 import org.assertj.core.api.WithAssertions;
 import org.gridsuite.gateway.endpoints.*;
+import org.gridsuite.gateway.filters.ElementAccessControllerGlobalPreFilter;
+import org.gridsuite.gateway.filters.TokenValidatorGlobalPreFilter;
+import org.gridsuite.gateway.filters.UserAdminControlGlobalPreFilter;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cloud.gateway.filter.GlobalFilter;
+import org.springframework.cloud.gateway.filter.WebsocketRoutingFilter;
 import org.springframework.cloud.gateway.route.RouteLocator;
 import org.springframework.context.ApplicationContext;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import reactor.test.StepVerifier;
 
 import java.util.Map;
 
+@Slf4j
 @SpringBootTest
 class GatewayApplicationTest implements WithAssertions {
     @Autowired
@@ -66,4 +74,33 @@ void testRoutesInitialized() {
                     .expectNextCount(28)
                     .verifyComplete();
     }
+
+    @Test
+    void testFiltersOrder() {
+        assertThat(applicationContext.getBeansOfType(GlobalFilter.class)
+                                     .values()
+                                     .stream()
+                                     .sorted(AnnotationAwareOrderComparator.INSTANCE) //sort work only on bean instances
+                                     .peek(f -> log.info("p={} ; o={} ; {}", AAOC.INSTANCE.getPriority(f), AAOC.INSTANCE.getOrder(f), f.getClass().getName()))
+                                     .map(GlobalFilter::getClass)
+                                     .toList()).as("global filters found")
+            // Before ElementAccessControllerGlobalPreFilter to enforce authentication
+            .containsSubsequence(TokenValidatorGlobalPreFilter.class, ElementAccessControllerGlobalPreFilter.class)
+            // Before WebsocketRoutingFilter to control access
+            .containsSubsequence(ElementAccessControllerGlobalPreFilter.class, WebsocketRoutingFilter.class)
+            .containsSubsequence(
+                TokenValidatorGlobalPreFilter.class, //Ordered.LOWEST_PRECEDENCE - 4
+                UserAdminControlGlobalPreFilter.class, //Ordered.LOWEST_PRECEDENCE - 3
+                ElementAccessControllerGlobalPreFilter.class //Ordered.LOWEST_PRECEDENCE - 2
+        );
+    }
+
+    private static class AAOC extends AnnotationAwareOrderComparator {
+        public static final AAOC INSTANCE = new AAOC();
+
+        @Override
+        public int getOrder(final Object obj) {
+            return super.getOrder(obj);
+        }
+    }
 }