Add Endpoints for processing several filters and returning Identifiables attributes List (#843)

Signed-off-by: basseche <[email protected]>

Author: basseche

src/main/java/org/gridsuite/study/server/controller/StudyController.java

@@ -2355,6 +2355,16 @@ public ResponseEntity<String> exportFilterFromFirstRootNetwork(
         return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(studyService.exportFilterFromFirstRootNetwork(studyUuid, filterUuid));
     }
 
+    // temporary - used by grid-explore only to prevent filter conversion from dysfunctioning since it does not have access to root networks yet
+    @GetMapping(value = "/studies/{studyUuid}/filters/elements")
+    @Operation(summary = "Evaluate filters list on first root network of study to get matched identifiables elements")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The list of matched identifiables elements")})
+    public ResponseEntity<String> evaluateFiltersOnFirstRootNetwork(
+        @Parameter(description = "Study uuid") @PathVariable("studyUuid") UUID studyUuid,
+        @Parameter(description = "Filters uuid to be applied") @RequestParam(name = "filtersUuid") List<UUID> filtersUuid) {
+        return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(studyService.evaluateFiltersFromFirstRootNetwork(studyUuid, filtersUuid));
+    }
+
     @GetMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/filters/elements")
     @Operation(summary = "Evaluate a list of filters on root node to get matched elements")
     @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The list of matched elements")})

src/main/java/org/gridsuite/study/server/service/FilterService.java

@@ -36,6 +36,7 @@
 public class FilterService {
 
     public static final String FILTER_END_POINT_EVALUATE = "/filters/evaluate";
+    public static final String FILTER_END_POINT_EVALUATE_IDS = "/filters/evaluate/identifiables";
     public static final String FILTER_END_POINT_EXPORT = "/filters/{id}/export";
     public static final String FILTERS_END_POINT_EXPORT = "/filters/export";
 
@@ -109,4 +110,17 @@ public String exportFilters(UUID networkUuid, List<UUID> filtersUuid, String var
 
         return restTemplate.getForObject(uriComponent.toUriString(), String.class);
     }
+
+    public String evaluateFilters(UUID networkUuid, List<UUID> filtersUuid) {
+        Objects.requireNonNull(networkUuid);
+        Objects.requireNonNull(filtersUuid);
+        String endPointUrl = getBaseUri() + DELIMITER + FILTER_API_VERSION + FILTER_END_POINT_EVALUATE_IDS;
+
+        UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromHttpUrl(endPointUrl);
+        uriComponentsBuilder.queryParam("networkUuid", networkUuid);
+        uriComponentsBuilder.queryParam("ids", filtersUuid);
+        var uriComponent = uriComponentsBuilder.buildAndExpand();
+
+        return restTemplate.getForObject(uriComponent.toUriString(), String.class);
+    }
 }

src/main/java/org/gridsuite/study/server/service/StudyService.java

@@ -3334,6 +3334,11 @@ public String exportFilterFromFirstRootNetwork(UUID studyUuid, UUID filterUuid)
     }
 
     @Transactional(readOnly = true)
+    public String evaluateFiltersFromFirstRootNetwork(UUID studyUuid, List<UUID> filtersUuid) {
+        StudyEntity studyEntity = studyRepository.findById(studyUuid).orElseThrow(() -> new StudyException(STUDY_NOT_FOUND));
+        return filterService.evaluateFilters(studyEntity.getFirstRootNetwork().getNetworkUuid(), filtersUuid);
+    }
+
     public String exportFilters(UUID rootNetworkUuid, List<UUID> filtersUuid, UUID nodeUuid, boolean inUpstreamBuiltParentNode) {
         UUID nodeUuidToSearchIn = getNodeUuidToSearchIn(nodeUuid, rootNetworkUuid, inUpstreamBuiltParentNode);
         String variantId = networkModificationTreeService.getVariantId(nodeUuidToSearchIn, rootNetworkUuid);

src/test/java/org/gridsuite/study/server/FilterServiceTest.java

@@ -32,6 +32,8 @@
 import org.springframework.http.MediaType;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
 
 import java.util.List;
 import java.util.UUID;
@@ -291,6 +293,35 @@ void exportFilterFromFirstRootNetwork() throws Exception {
         wireMockUtils.verifyFilterExport(stubUuid, FILTER_UUID_STRING, studyFirstRootNetworkUuid.toString());
     }
 
+    @Test
+    void evaluateFiltersOnFirstRootNetworkTest() throws Exception {
+
+        StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_UUID);
+        UUID studyUuid = studyEntity.getId();
+        UUID studyFirstRootNetworkUuid = studyTestUtils.getOneRootNetwork(studyUuid).getNetworkUuid();
+        String responseBody = """
+                [
+                    {"id":"MANDA7COND.41","type":"SHUNT_COMPENSATOR","distributionKey":null},
+                    {"id":"MANDA7COND.31","type":"SHUNT_COMPENSATOR","distributionKey":null}
+                ]
+            """;
+        List<UUID> filtersUuids = List.of(UUID.fromString(FILTER_UUID_STRING));
+        UUID stubUuid = wireMockUtils.stubFiltersEvaluate(studyFirstRootNetworkUuid.toString(), filtersUuids, responseBody);
+
+        List<String> strfilterUuids = filtersUuids.stream().map(Object::toString).collect(Collectors.toList());
+        MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
+        params.addAll("filtersUuid", strfilterUuids);
+        MvcResult mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/filters/elements",
+                studyUuid).params(params).contentType(MediaType.APPLICATION_JSON))
+            .andExpect(status().isOk())
+            .andReturn();
+
+        String resultAsString = mvcResult.getResponse().getContentAsString();
+        Assert.assertEquals(responseBody, resultAsString);
+
+        wireMockUtils.verifyFiltersEvaluate(stubUuid, strfilterUuids, studyFirstRootNetworkUuid.toString());
+    }
+
     @Test
     void testExportFilters() throws Exception {
         StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_UUID);

src/test/java/org/gridsuite/study/server/utils/WireMockUtils.java

@@ -550,6 +550,14 @@ public UUID stubFilterExport(String networkUuid, String filterUuid, String respo
         ).getId();
     }
 
+    public UUID stubFiltersEvaluate(String networkUuid, List<UUID> filtersUuid, String responseBody) {
+        return wireMock.stubFor(WireMock.get(WireMock.urlPathEqualTo("/v1/filters/evaluate/identifiables"))
+            .withQueryParam(NETWORK_UUID, WireMock.equalTo(networkUuid))
+                .withQueryParam("ids", WireMock.equalTo(String.join(",", filtersUuid.stream().map(UUID::toString).toList())))
+            .willReturn(WireMock.ok().withBody(responseBody))
+        ).getId();
+    }
+
     public UUID stubFiltersExport(String networkUuid, List<String> filtersUuid, String responseBody) {
         MappingBuilder requestPatternBuilder = WireMock.get(WireMock.urlPathEqualTo("/v1/filters/export"))
             .withQueryParam(NETWORK_UUID, WireMock.equalTo(networkUuid));
@@ -573,6 +581,15 @@ public void verifyFiltersExport(UUID stubUuid, List<String> filtersUuid, String
         verifyGetRequest(stubUuid, "/v1/filters/export", queryParams);
     }
 
+    public void verifyFiltersEvaluate(UUID stubUuid, List<String> filtersUuid, String networkUuid) {
+        Map<String, StringValuePattern> queryParams = new HashMap<>();
+        queryParams.put(NETWORK_UUID, WireMock.equalTo(networkUuid));
+        for (String filterUuid : filtersUuid) {
+            queryParams.put(IDS, WireMock.equalTo(filterUuid));
+        }
+        verifyGetRequest(stubUuid, "/v1/filters/evaluate/identifiables", queryParams);
+    }
+
     public UUID stubSearchModifications(String networkUuid, String userInput, String responseBody) {
         return wireMock.stubFor(WireMock.get(WireMock.urlPathEqualTo("/v1/network-modifications/indexation-infos"))
                         .withQueryParam("networkUuid", WireMock.equalTo(networkUuid))