Skip to content

Implement global filter #120

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

Merged
merged 20 commits into from
Jul 11, 2025
Merged

Implement global filter #120

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
2e2a603
draft version
ghazwarhili Jun 24, 2025
3d036a8
clean code
ghazwarhili Jun 25, 2025
5e68b50
add TU for global filter
ghazwarhili Jun 26, 2025
2e8c92e
fix failed TU
ghazwarhili Jun 26, 2025
426ee55
change timeout from 5OO to 1000 ms
ghazwarhili Jun 26, 2025
91c0309
fix TU
ghazwarhili Jun 26, 2025
b1fc653
add TU
ghazwarhili Jun 26, 2025
798b9cf
enhance and remove intersection algo
ghazwarhili Jun 26, 2025
476bb51
Merge branch 'main' into implement-global-filter
thangqp Jul 1, 2025
3aaf29d
code review remarks
ghazwarhili Jul 7, 2025
41b6a60
Merge remote-tracking branch 'origin/implement-global-filter' into im…
ghazwarhili Jul 8, 2025
52e59f5
Merge branch 'main' into implement-global-filter
ghazwarhili Jul 8, 2025
53dfdd5
add coverage TU
ghazwarhili Jul 8, 2025
66222e1
refacto
ghazwarhili Jul 8, 2025
28ddf34
clean code
ghazwarhili Jul 9, 2025
769faa3
Merge branch 'main' into implement-global-filter
Mathieu-Deharbe Jul 9, 2025
6038621
refacto part 2
ghazwarhili Jul 9, 2025
c278e26
Merge remote-tracking branch 'origin/implement-global-filter' into im…
ghazwarhili Jul 9, 2025
59cab55
add AbstractFilterService
ghazwarhili Jul 11, 2025
90c12bd
fix sonar issue
ghazwarhili Jul 11, 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
4 changes: 4 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.gridsuite</groupId>
<artifactId>gridsuite-filter</artifactId>
</dependency>

<!-- Runtime dependencies -->
<dependency>
Expand Down
26 changes: 17 additions & 9 deletions src/main/java/org/gridsuite/sensitivityanalysis/server/SensitivityAnalysisController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@
import com.fasterxml.jackson.databind.ObjectMapper;
import com.powsybl.sensitivity.SensitivityAnalysisResult;
import com.powsybl.sensitivity.SensitivityFunctionType;
import com.powsybl.ws.commons.computation.dto.GlobalFilter;
import com.powsybl.ws.commons.computation.dto.ReportInfos;
import com.powsybl.ws.commons.computation.dto.ResourceFilterDTO;
import com.powsybl.ws.commons.computation.utils.FilterUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import com.powsybl.ws.commons.computation.dto.ReportInfos;
import org.gridsuite.sensitivityanalysis.server.dto.*;
import org.gridsuite.sensitivityanalysis.server.dto.nonevacuatedenergy.NonEvacuatedEnergyInputData;
import org.gridsuite.sensitivityanalysis.server.dto.nonevacuatedenergy.NonEvacuatedEnergyStatus;
Expand All @@ -40,7 +43,6 @@
import java.util.UUID;

import static com.powsybl.ws.commons.computation.service.NotificationService.HEADER_USER_ID;
import static com.powsybl.ws.commons.computation.utils.FilterUtils.fromStringFiltersToDTO;
import static org.springframework.http.MediaType.*;

/**
Expand Down Expand Up @@ -139,19 +141,25 @@ public ResponseEntity<Long> getFactorsCount(@Parameter(description = "Network UU
@GetMapping(value = "/results/{resultUuid}", produces = APPLICATION_JSON_VALUE)
@Operation(summary = "Get a sensitivity analysis result from the database")
@ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The sensitivity analysis result"),
@ApiResponse(responseCode = "404", description = "Sensitivity analysis result has not been found")})
@ApiResponse(responseCode = "404", description = "Sensitivity analysis result has not been found"),
@ApiResponse(responseCode = "400", description = "Invalid filter format")})
public ResponseEntity<SensitivityRunQueryResult> getResult(
@Parameter(description = "Result UUID") @PathVariable("resultUuid") UUID resultUuid,
@RequestParam(name = "selector", required = false) String selectorJson,
@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 = "Global Filters") @RequestParam(name = "globalFilters", required = false) String globalFilters,
@Parameter(description = "network Uuid") @RequestParam(name = "networkUuid", required = false) UUID networkUuid,
@Parameter(description = "variant Id") @RequestParam(name = "variantId", required = false) String variantId
) {
String decodedStringFilters = filters != null ? URLDecoder.decode(filters, StandardCharsets.UTF_8) : null;
try {
String decodedStringFilters = filters != null ? URLDecoder.decode(filters, StandardCharsets.UTF_8) : null;
String decodedStringGlobalFilters = globalFilters != null ? URLDecoder.decode(globalFilters, StandardCharsets.UTF_8) : null;
List<ResourceFilterDTO> resourceFilters = FilterUtils.fromStringFiltersToDTO(decodedStringFilters, objectMapper);
GlobalFilter globalFilter = FilterUtils.fromStringGlobalFiltersToDTO(decodedStringGlobalFilters, objectMapper);
ResultsSelector selector = getSelector(selectorJson);
SensitivityRunQueryResult result = service.getRunResult(resultUuid, selector, fromStringFiltersToDTO(decodedStringFilters, objectMapper));
return result != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(result)
: ResponseEntity.notFound().build();
} catch (JsonProcessingException e) {
SensitivityRunQueryResult result = service.getRunResult(resultUuid, networkUuid, variantId, selector, resourceFilters, globalFilter);
return result != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(result) : ResponseEntity.notFound().build();
} catch (Exception e) {
return ResponseEntity.badRequest().build();
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you change JsonProcessingException to Exception doesn't it mean that any throw will be considered a bad request error ?

If you want to catch everything maybe : ?

        } catch (JsonProcessingException e) {
            return ResponseEntity.badRequest().build();
        } catch (Exception e) {
            return ResponseEntity.internalServerError().build();
        }

But if you think that we can consider any error in the controller to be a badRequest, then fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

}
Expand Down
76 changes: 72 additions & 4 deletions ...ityanalysis/server/repositories/specifications/SensitivityResultSpecificationBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@
import jakarta.persistence.criteria.Root;
import org.gridsuite.sensitivityanalysis.server.dto.resultselector.ResultsSelector;
import org.gridsuite.sensitivityanalysis.server.entities.AnalysisResultEntity;
import org.gridsuite.sensitivityanalysis.server.entities.ContingencyResultEntity;
import org.gridsuite.sensitivityanalysis.server.entities.RawSensitivityResultEntity;
import org.gridsuite.sensitivityanalysis.server.entities.SensitivityResultEntity;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;

import java.util.Collection;
import java.util.List;
import java.util.UUID;
import java.util.*;
import java.util.stream.Collectors;

/**
* Builds specifications for querying {@link SensitivityResultEntity} objects.
Expand Down Expand Up @@ -59,7 +59,14 @@ public Specification<SensitivityResultEntity> addSpecificFilterWhenChildrenFilte
}

public Specification<SensitivityResultEntity> buildSpecificationFromSelector(UUID resultUuid, List<ResourceFilterDTO> resourceFilters, ResultsSelector selector) {
return buildSpecification(resultUuid, resourceFilters, false)
Specification<SensitivityResultEntity> baseSpec = buildSpecification(resultUuid, Collections.emptyList(), false);
Specification<SensitivityResultEntity> resourceFilterSpec = buildCustomResourceFilterSpecification(resourceFilters);
Copy link
Contributor

@Mathieu-Deharbe Mathieu-Deharbe Jun 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is this change that breaks the filter by column (cf request change). Probably because you don't use the specification functions anymore (like appendTextFilterToSpecification...)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Specification<SensitivityResultEntity> finalSpec = baseSpec;
if (resourceFilterSpec != null) {
finalSpec = finalSpec.and(resourceFilterSpec);
}

return finalSpec
.and(fieldIn(
List.of(selector.getFunctionType()),
ResultsSelector.Fields.functionType,
Expand All @@ -74,6 +81,67 @@ public Specification<SensitivityResultEntity> buildSpecificationFromSelector(UUI
null));
}

private Specification<SensitivityResultEntity> buildCustomResourceFilterSpecification(List<ResourceFilterDTO> resourceFilters) {
if (resourceFilters == null || resourceFilters.isEmpty()) {
return Specification.where(null);
}
Map<String, List<ResourceFilterDTO>> filtersByColumn = resourceFilters.stream()
.filter(Objects::nonNull)
.collect(Collectors.groupingBy(ResourceFilterDTO::column));
Specification<SensitivityResultEntity> finalSpec = null;
for (List<ResourceFilterDTO> filtersForColumn : filtersByColumn.values()) {
Specification<SensitivityResultEntity> columnSpec = buildOrSpecificationForColumn(filtersForColumn);

if (columnSpec != null) {
finalSpec = finalSpec == null ? columnSpec : finalSpec.and(columnSpec);
}
}
return finalSpec;
}

private Specification<SensitivityResultEntity> buildOrSpecificationForColumn(List<ResourceFilterDTO> filters) {
if (filters.isEmpty()) {
return null;
}
Specification<SensitivityResultEntity> columnSpec = null;
for (ResourceFilterDTO filter : filters) {
Specification<SensitivityResultEntity> singleFilterSpec = createSingleFilterSpecification(filter);
columnSpec = columnSpec == null ? singleFilterSpec : columnSpec.or(singleFilterSpec);
}
return columnSpec;
}

private Specification<SensitivityResultEntity> createSingleFilterSpecification(ResourceFilterDTO filter) {
return (root, query, criteriaBuilder) -> {
if (filter.value() instanceof List<?> valueList && !valueList.isEmpty()) {
Path<Object> fieldPath = getFieldPathForFilter(root, filter.column());

switch (filter.type()) {
case IN:
return fieldPath.in(valueList);
case EQUALS:
if (valueList.size() == 1) {
return criteriaBuilder.equal(fieldPath, valueList.getFirst());
}
return fieldPath.in(valueList);
default:
return criteriaBuilder.and();
}
}
return criteriaBuilder.and();
};
}

private Path<Object> getFieldPathForFilter(Root<SensitivityResultEntity> root, String column) {
return switch (column) {
case "functionId" -> root.get(SensitivityResultEntity.Fields.functionId);
case "variableId" -> root.get(SensitivityResultEntity.Fields.variableId);
case "contingencyId" -> root.get(SensitivityResultEntity.Fields.contingencyResult)
.get(ContingencyResultEntity.Fields.contingencyId);
default -> root.get(column);
};
}

public Specification<SensitivityResultEntity> nullRawValue() {
return (root, query, criteriaBuilder) -> criteriaBuilder.and(
criteriaBuilder.isNull(
Expand Down
Loading