Skip to content

add globalFilters to getSensitivityAnalysisResult endpoint #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

add globalFilters to getSensitivityAnalysisResult endpoint #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1e523fe
add globalFilters to getSensitivityAnalysisResult endpoint
ghazwarhili Jun 23, 2025
dfeb24d
add networUuuid and variantId
ghazwarhili Jun 25, 2025
7023671
fix broken TU
ghazwarhili Jun 25, 2025
49dddd6
fix checkstyle unused import
ghazwarhili Jun 25, 2025
6ce446d
add TU for coverage
ghazwarhili Jun 25, 2025
68fd7d7
Merge branch 'main' into add-globalFilters-RequestParam
Mathieu-Deharbe Jun 26, 2025
d73335c
Merge branch 'main' into add-globalFilters-RequestParam
Mathieu-Deharbe Jun 27, 2025
68b8884
Merge branch 'main' into add-globalFilters-RequestParam
thangqp Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/main/java/org/gridsuite/study/server/controller/StudyController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1688,9 +1688,10 @@ public ResponseEntity<String> getSensitivityAnalysisResult(
@Parameter(description = "rootNetworkUuid") @PathVariable("rootNetworkUuid") UUID rootNetworkUuid,
@Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid,
@Parameter(description = "results selector") @RequestParam("selector") String selector,
@Parameter(description = "JSON array of filters") @RequestParam(name = "filters", required = false) String filters
@Parameter(description = "JSON array of filters") @RequestParam(name = "filters", required = false) String filters,
@Parameter(description = "JSON array of global filters") @RequestParam(name = "globalFilters", required = false) String globalFilters
) {
String result = rootNetworkNodeInfoService.getSensitivityAnalysisResult(nodeUuid, rootNetworkUuid, selector, filters);
String result = rootNetworkNodeInfoService.getSensitivityAnalysisResult(nodeUuid, rootNetworkUuid, selector, filters, globalFilters);
return result != null ? ResponseEntity.ok().body(result) :
ResponseEntity.noContent().build();
}
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/org/gridsuite/study/server/service/RootNetworkNodeInfoService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,9 +546,12 @@ public List<TimelineEventInfos> getDynamicSimulationTimeline(UUID nodeUuid, UUID
}

@Transactional(readOnly = true)
public String getSensitivityAnalysisResult(UUID nodeUuid, UUID rootNetworkUuid, String selector, String filters) {
public String getSensitivityAnalysisResult(UUID nodeUuid, UUID rootNetworkUuid, String selector, String filters, String globalFilters) {
RootNetworkNodeInfoEntity rootNetworkNodeInfoEntity = rootNetworkNodeInfoRepository.findByNodeInfoIdAndRootNetworkId(nodeUuid, rootNetworkUuid).orElseThrow(() -> new StudyException(ROOT_NETWORK_NOT_FOUND));
String variantId = rootNetworkNodeInfoEntity.getVariantId();
UUID networkUuid = rootNetworkNodeInfoEntity.getRootNetwork().getNetworkUuid();
UUID resultUuid = getComputationResultUuid(nodeUuid, rootNetworkUuid, SENSITIVITY_ANALYSIS);
return sensitivityAnalysisService.getSensitivityAnalysisResult(resultUuid, selector, filters);
return sensitivityAnalysisService.getSensitivityAnalysisResult(resultUuid, networkUuid, variantId, selector, filters, globalFilters);
}

@Transactional(readOnly = true)
Expand Down
9 changes: 8 additions & 1 deletion src/main/java/org/gridsuite/study/server/service/SensitivityAnalysisService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public UUID runSensitivityAnalysis(UUID nodeUuid, UUID rootNetworkUuid, UUID net
return restTemplate.exchange(sensitivityAnalysisServerBaseUri + path, HttpMethod.POST, httpEntity, UUID.class).getBody();
}

public String getSensitivityAnalysisResult(UUID resultUuid, String selector, String filters) {
public String getSensitivityAnalysisResult(UUID resultUuid, UUID networkUuid, String variantId, String selector, String filters, String globalFilters) {
String result;

if (resultUuid == null) {
Expand All @@ -120,6 +120,13 @@ public String getSensitivityAnalysisResult(UUID resultUuid, String selector, Str
if (StringUtils.isNotBlank(filters)) {
uriBuilder.queryParam("filters", URLEncoder.encode(filters, StandardCharsets.UTF_8));
}
if (!StringUtils.isEmpty(globalFilters)) {
uriBuilder.queryParam("globalFilters", URLEncoder.encode(globalFilters, StandardCharsets.UTF_8));
uriBuilder.queryParam("networkUuid", networkUuid);
if (!StringUtils.isBlank(variantId)) {
uriBuilder.queryParam(QUERY_PARAM_VARIANT_ID, variantId);
}
}
URI uri = uriBuilder.build().encode().toUri();

try {
Expand Down
17 changes: 13 additions & 4 deletions src/test/java/org/gridsuite/study/server/SensitivityAnalysisTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import org.gridsuite.study.server.repository.nonevacuatedenergy.NonEvacuatedEnergyParametersEntity;
import org.gridsuite.study.server.repository.rootnetwork.RootNetworkNodeInfoRepository;
import org.gridsuite.study.server.service.*;
import org.gridsuite.study.server.service.LoadFlowService;
import org.gridsuite.study.server.utils.SendInput;
import org.gridsuite.study.server.utils.TestUtils;
import org.gridsuite.study.server.utils.elasticsearch.DisableElasticsearch;
Expand Down Expand Up @@ -303,7 +302,9 @@ public MockResponse dispatch(RecordedRequest request) {
} else if (path.matches("/v1/parameters") && method.equals("POST")) {
return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), objectMapper.writeValueAsString(SENSITIVITY_ANALYSIS_PARAMETERS_UUID));
} else if (path.matches("/v1/parameters/default") && method.equals("POST")) {
return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), objectMapper.writeValueAsString(SENSITIVITY_ANALYSIS_PARAMETERS_UUID));
return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), objectMapper.writeValueAsString(SENSITIVITY_ANALYSIS_PARAMETERS_UUID));
} else if (path.matches("/v1/results/" + SENSITIVITY_ANALYSIS_RESULT_UUID + "\\?filters=.*globalFilters=.*networkUuid=.*variantId.*sort=.*")) {
return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), SENSITIVITY_ANALYSIS_RESULT_UUID);
} else {
LOGGER.error("Unhandled method+path: " + request.getMethod() + " " + request.getPath());
return new MockResponse.Builder().code(418).body("Unhandled method+path: " + request.getMethod() + " " + request.getPath()).build();
Expand Down Expand Up @@ -350,6 +351,14 @@ private void testSensitivityAnalysisWithRootNetworkUuidAndNodeUuid(final MockWeb
.andExpectAll(status().isOk(), content().string(FAKE_RESULT_JSON));
assertTrue(TestUtils.getRequestsDone(1, server).stream().anyMatch(r -> r.contains("/v1/results/" + resultUuid + "/filter-options")));

// get result with filters , globalFilters and sort
mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/result?filters=lineId2&selector=subjectId&globalFilters=ss", studyUuid, rootNetworkUuid, nodeUuid))
.andExpectAll(status().isOk(), content().string(FAKE_RESULT_JSON));

Set<String> actualRequests = TestUtils.getRequestsDone(1, server);
assertTrue(actualRequests.stream().anyMatch(request -> request.contains("/v1/results/" + resultUuid) && request.contains("selector=subjectId") && request.contains("filters=lineId2") && request.contains("globalFilters=ss")
));

// get sensitivity analysis status
mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/status", studyUuid, rootNetworkUuid, nodeUuid)).andExpectAll(
status().isOk(),
Expand Down Expand Up @@ -414,7 +423,7 @@ void testSensitivityAnalysis(final MockWebServer server) throws Exception {

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/result?selector={selector}",
studyNameUserIdUuid, firstRootNetworkUuid, UUID.randomUUID(), "fakeJsonSelector"))
.andExpectAll(status().isNoContent());
.andExpectAll(status().isNotFound());

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/result/filter-options?selector={selector}",
studyNameUserIdUuid, firstRootNetworkUuid, UUID.randomUUID(), "fakeJsonSelector"))
Expand Down Expand Up @@ -490,7 +499,7 @@ void testGetSensitivityResultWithWrongId() throws Exception {
UUID studyUuid = studyEntity.getId();
UUID firstRootNetworkUuid = studyTestUtils.getOneRootNetworkUuid(studyUuid);
mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/result?selector={selector}", studyUuid, firstRootNetworkUuid, UUID.randomUUID(), FAKE_RESULT_JSON))
.andExpect(status().isNoContent()).andReturn();
.andExpect(status().isNotFound()).andReturn();

mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/sensitivity-analysis/result/filter-options?selector={selector}", studyUuid, firstRootNetworkUuid, UUID.randomUUID(), FAKE_RESULT_JSON))
.andExpect(status().isNoContent()).andReturn();
Expand Down