feat(dlvp): adapt DynamicListRoutePlugin to stateless RoutePlugin interface

Author: christophechevalier

dlvp/README.md

@@ -45,7 +45,7 @@ The route plugin exposes a dynamic endpoint that returns structured elements fro
 
 ```yaml
 routes:
-  - name: dynamic-list
+  - type: dynamic-list
     route: /api/something
     url: https://external-api.com/api/personnes
     method: GET
@@ -156,7 +156,7 @@ entities:
 
 - The plugin consists of two types:
   - **Validation plugin** (`type: dynamic-list`): validates that a value is included in the list fetched from the external API. Only the `value` field of each element is used for comparison.
-  - **Route plugin** (`name: dynamic-list`): exposes a configurable endpoint (via `route`) returning structured elements as a paginated `Page<DynamicListEntry>` response, where `DynamicListEntry` is a record with `label` and `value` fields.
+  - **Route plugin** (`type: dynamic-list`): exposes a configurable endpoint (via `route`) returning structured elements as a paginated `Page<DynamicListEntry>` response, where `DynamicListEntry` is a record with `label` and `value` fields.
 
 - Both plugins share a common HTTP service (`HttpService`) that sends an HTTP request to the configured `url` with optional `headers` and `body`, and returns the raw response body.
 

dlvp/src/main/java/io/github/linagora/linid/im/dlvp/DynamicListRoutePlugin.java

@@ -33,9 +33,10 @@
 import io.github.linagora.linid.im.corelib.plugin.authorization.AuthorizationFactory;
 import io.github.linagora.linid.im.corelib.plugin.config.JinjaService;
 import io.github.linagora.linid.im.corelib.plugin.config.dto.EntityConfiguration;
+import io.github.linagora.linid.im.corelib.plugin.config.dto.RouteConfiguration;
 import io.github.linagora.linid.im.corelib.plugin.entity.DynamicEntity;
-import io.github.linagora.linid.im.corelib.plugin.route.AbstractRoutePlugin;
 import io.github.linagora.linid.im.corelib.plugin.route.RouteDescription;
+import io.github.linagora.linid.im.corelib.plugin.route.RoutePlugin;
 import io.github.linagora.linid.im.corelib.plugin.task.TaskEngine;
 import io.github.linagora.linid.im.corelib.plugin.task.TaskExecutionContext;
 import io.github.linagora.linid.im.dlvp.model.DynamicListConfiguration;
@@ -66,7 +67,7 @@
  */
 @Slf4j
 @Component
-public class DynamicListRoutePlugin extends AbstractRoutePlugin implements DynamicListSupport {
+public class DynamicListRoutePlugin implements RoutePlugin, DynamicListSupport {
 
   /** I18n key for missing configuration option errors. */
   private static final String MISSING_OPTION = "error.plugin.default.missing.option";
@@ -114,8 +115,9 @@ public boolean supports(final @NonNull String type) {
   }
 
   @Override
-  public List<RouteDescription> getRoutes(final List<EntityConfiguration> entities) {
-    String route = getConfiguration().getOption("route")
+  public List<RouteDescription> getRoutes(final RouteConfiguration configuration,
+                                          final List<EntityConfiguration> entities) {
+    String route = configuration.getOption("route")
         .orElseThrow(() -> new ApiException(
             500,
             I18nMessage.of(MISSING_OPTION, Map.of(OPTION, "route"))
@@ -124,11 +126,12 @@ public List<RouteDescription> getRoutes(final List<EntityConfiguration> entities
   }
 
   @Override
-  public boolean match(final String url, final String method) {
-    if (getConfiguration() == null) {
+  public boolean match(final RouteConfiguration configuration,
+                       final String url, final String method) {
+    if (configuration == null) {
       return false;
     }
-    String route = getConfiguration().getOption("route")
+    String route = configuration.getOption("route")
         .orElseThrow(() -> new ApiException(
             500,
             I18nMessage.of(MISSING_OPTION, Map.of(OPTION, "route"))
@@ -137,20 +140,21 @@ public boolean match(final String url, final String method) {
   }
 
   @Override
-  public ResponseEntity<Page<DynamicListEntry>> execute(final HttpServletRequest request) {
-    String route = getConfiguration().getOption("route")
+  public ResponseEntity<Page<DynamicListEntry>> execute(final RouteConfiguration configuration,
+                                                        final HttpServletRequest request) {
+    String route = configuration.getOption("route")
         .orElseThrow(() -> new ApiException(
             500,
             I18nMessage.of(MISSING_OPTION, Map.of(OPTION, "route"))
         ));
     log.info("Receiving request on dynamic-list route '{}'", route);
 
     DynamicListConfiguration dlConfig = mapper.convertValue(
-        getConfiguration().getOptions(), new TypeReference<>() {
+        configuration.getOptions(), new TypeReference<>() {
         });
 
     TaskExecutionContext context = new TaskExecutionContext();
-    DynamicEntity entity = buildDynamicEntity(getConfiguration());
+    DynamicEntity entity = buildDynamicEntity(configuration);
 
     var authorizationPlugin = authorizationFactory.getAuthorizationPlugin();
 
@@ -160,7 +164,7 @@ public ResponseEntity<Page<DynamicListEntry>> execute(final HttpServletRequest r
 
     taskEngine.execute(entity, context, "beforeDynamicList");
 
-    String response = httpService.request(context, getConfiguration());
+    String response = httpService.request(context, configuration);
     context.put("response", response);
 
     taskEngine.execute(entity, context, "afterDynamicList");

dlvp/src/test/java/io/github/linagora/linid/im/dlvp/DynamicListRoutePluginE2ETest.java

@@ -93,9 +93,9 @@ private RouteConfiguration buildConfiguration(String url, String method) {
   @Test
   @DisplayName("test execute: should return paginated elements from external API via GET")
   void testExecuteGet() {
-    plugin.setConfiguration(buildConfiguration("http://localhost:3001/v1/test_api/types", "GET"));
+    var configuration = buildConfiguration("http://localhost:3001/v1/test_api/types", "GET");
 
-    var response = plugin.execute(null);
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());
@@ -118,9 +118,8 @@ void testExecuteWithHeaders() {
     var configuration = buildConfiguration(
         "http://localhost:3001/v1/test_api/types/with-headers", "GET");
     configuration.addOption("headers", Map.of("Authorization", "Bearer my-token"));
-    plugin.setConfiguration(configuration);
 
-    var response = plugin.execute(null);
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());
@@ -137,10 +136,11 @@ void testExecuteWithHeaders() {
   @Test
   @DisplayName("test execute: should throw exception on 401 without auth header")
   void testExecuteUnauthorized() {
-    plugin.setConfiguration(buildConfiguration(
-        "http://localhost:3001/v1/test_api/types/with-headers", "GET"));
+    var configuration = buildConfiguration(
+        "http://localhost:3001/v1/test_api/types/with-headers", "GET");
 
-    ApiException exception = assertThrows(ApiException.class, () -> plugin.execute(null));
+    ApiException exception = assertThrows(ApiException.class,
+        () -> plugin.execute(configuration, null));
 
     assertEquals(401, exception.getStatusCode());
     assertEquals("dlvp.error.external.api", exception.getError().key());
@@ -149,9 +149,10 @@ void testExecuteUnauthorized() {
   @Test
   @DisplayName("test execute: should throw exception on 4xx error")
   void testExecute4xx() {
-    plugin.setConfiguration(buildConfiguration("http://localhost:3001/v1/test_api/400", "GET"));
+    var configuration = buildConfiguration("http://localhost:3001/v1/test_api/400", "GET");
 
-    ApiException exception = assertThrows(ApiException.class, () -> plugin.execute(null));
+    ApiException exception = assertThrows(ApiException.class,
+        () -> plugin.execute(configuration, null));
 
     assertEquals(400, exception.getStatusCode());
     assertEquals("dlvp.error.external.api", exception.getError().key());
@@ -160,9 +161,10 @@ void testExecute4xx() {
   @Test
   @DisplayName("test execute: should throw exception on 5xx error")
   void testExecute5xx() {
-    plugin.setConfiguration(buildConfiguration("http://localhost:3001/v1/test_api/500", "GET"));
+    var configuration = buildConfiguration("http://localhost:3001/v1/test_api/500", "GET");
 
-    ApiException exception = assertThrows(ApiException.class, () -> plugin.execute(null));
+    ApiException exception = assertThrows(ApiException.class,
+        () -> plugin.execute(configuration, null));
 
     assertEquals(502, exception.getStatusCode());
     assertEquals("dlvp.error.external.api.unavailable", exception.getError().key());
@@ -171,10 +173,11 @@ void testExecute5xx() {
   @Test
   @DisplayName("test execute: should throw exception on invalid JSON response")
   void testExecuteInvalidJson() {
-    plugin.setConfiguration(buildConfiguration(
-        "http://localhost:3001/v1/test_api/invalid-json", "GET"));
+    var configuration = buildConfiguration(
+        "http://localhost:3001/v1/test_api/invalid-json", "GET");
 
-    ApiException exception = assertThrows(ApiException.class, () -> plugin.execute(null));
+    ApiException exception = assertThrows(ApiException.class,
+        () -> plugin.execute(configuration, null));
 
     assertEquals(500, exception.getStatusCode());
     assertEquals("jptp.error.json.parsing", exception.getError().key());
@@ -183,10 +186,10 @@ void testExecuteInvalidJson() {
   @Test
   @DisplayName("test execute: should return empty page when API returns empty content")
   void testExecuteEmptyContent() {
-    plugin.setConfiguration(buildConfiguration(
-        "http://localhost:3001/v1/test_api/types/empty", "GET"));
+    var configuration = buildConfiguration(
+        "http://localhost:3001/v1/test_api/types/empty", "GET");
 
-    var response = plugin.execute(null);
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     Page<DynamicListEntry> page = response.getBody();
@@ -203,9 +206,8 @@ void testExecutePost() {
     configuration.addOption("headers",
         Map.of("Content-Type", "application/json"));
     configuration.addOption("body", "{\"filter\":\"\"}");
-    plugin.setConfiguration(configuration);
 
-    var response = plugin.execute(null);
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());
@@ -222,9 +224,10 @@ void testExecutePost() {
   @Test
   @DisplayName("test execute: should throw exception on invalid method")
   void testExecuteInvalidMethod() {
-    plugin.setConfiguration(buildConfiguration("http://localhost:3001/v1/test_api/types", "DELETE"));
+    var configuration = buildConfiguration("http://localhost:3001/v1/test_api/types", "DELETE");
 
-    ApiException exception = assertThrows(ApiException.class, () -> plugin.execute(null));
+    ApiException exception = assertThrows(ApiException.class,
+        () -> plugin.execute(configuration, null));
 
     assertEquals(500, exception.getStatusCode());
     assertEquals("error.plugin.default.invalid.option", exception.getError().key());

dlvp/src/test/java/io/github/linagora/linid/im/dlvp/DynamicListRoutePluginTest.java

@@ -93,49 +93,45 @@ void testSupports() {
   void testGetRoutes() {
     var configuration = new RouteConfiguration();
     configuration.addOption("route", "/api/etablissement/types");
-    plugin.setConfiguration(configuration);
 
     var expected = List.of(new RouteDescription("GET", "/api/etablissement/types", null, List.of()));
-    assertEquals(expected, plugin.getRoutes(List.of()));
+    assertEquals(expected, plugin.getRoutes(configuration, List.of()));
   }
 
   @Test
   @DisplayName("test match: should match dynamic route from configuration")
   void testMatch() {
     var configuration = new RouteConfiguration();
     configuration.addOption("route", "/api/etablissement/types");
-    plugin.setConfiguration(configuration);
 
-    assertTrue(plugin.match("/api/etablissement/types", "GET"));
-    assertFalse(plugin.match("/api/other", "GET"));
-    assertFalse(plugin.match("/api/etablissement/types", "POST"));
+    assertTrue(plugin.match(configuration, "/api/etablissement/types", "GET"));
+    assertFalse(plugin.match(configuration, "/api/other", "GET"));
+    assertFalse(plugin.match(configuration, "/api/etablissement/types", "POST"));
   }
 
   @Test
   @DisplayName("test match: should be case-insensitive on method")
   void testMatchCaseInsensitiveMethod() {
     var configuration = new RouteConfiguration();
     configuration.addOption("route", "/api/etablissement/types");
-    plugin.setConfiguration(configuration);
 
-    assertTrue(plugin.match("/api/etablissement/types", "get"));
-    assertTrue(plugin.match("/api/etablissement/types", "Get"));
+    assertTrue(plugin.match(configuration, "/api/etablissement/types", "get"));
+    assertTrue(plugin.match(configuration, "/api/etablissement/types", "Get"));
   }
 
   @Test
   @DisplayName("test match: should return false when no configuration")
   void testMatchNoConfiguration() {
-    assertFalse(plugin.match("/api/anything", "GET"));
+    assertFalse(plugin.match(null, "/api/anything", "GET"));
   }
 
   @Test
   @DisplayName("test getRoutes: should throw exception when route is null")
   void testGetRoutesNullRoute() {
     var configuration = new RouteConfiguration();
-    plugin.setConfiguration(configuration);
 
     ApiException exception =
-        assertThrows(ApiException.class, () -> plugin.getRoutes(List.of()));
+        assertThrows(ApiException.class, () -> plugin.getRoutes(configuration, List.of()));
 
     assertEquals(500, exception.getStatusCode());
     assertEquals("error.plugin.default.missing.option", exception.getError().key());
@@ -145,10 +141,9 @@ void testGetRoutesNullRoute() {
   @DisplayName("test match: should throw exception when route is null")
   void testMatchNullRoute() {
     var configuration = new RouteConfiguration();
-    plugin.setConfiguration(configuration);
 
     ApiException exception =
-        assertThrows(ApiException.class, () -> plugin.match("/api/anything", "GET"));
+        assertThrows(ApiException.class, () -> plugin.match(configuration, "/api/anything", "GET"));
 
     assertEquals(500, exception.getStatusCode());
     assertEquals("error.plugin.default.missing.option", exception.getError().key());
@@ -174,8 +169,6 @@ void testExecute() {
             "destination", "response",
             "phases", List.of("beforeDynamicListMapping"))
     ));
-    plugin.setConfiguration(configuration);
-
     when(authorizationFactory.getAuthorizationPlugin()).thenReturn(authorizationPlugin);
     when(httpService.request(any(TaskExecutionContext.class), any(PluginConfiguration.class)))
         .thenReturn("{\"content\":[{\"name\":\"Type 1\",\"id\":\"1\"},{\"name\":\"Type 2\",\"id\":\"2\"}],"
@@ -202,7 +195,7 @@ void testExecute() {
     when(jinjaService.render(any(TaskExecutionContext.class), any(DynamicEntity.class),
         eq("{{ context.response.totalElements }}"))).thenReturn("2");
 
-    var response = plugin.execute(null);
+    var response = plugin.execute(configuration, null);
 
     assertNotNull(response);
     assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());