Add Filter Based Contingency List #136

basseche · 2025-09-01T15:53:35Z

needs filter lib version : gridsuite/filter#84

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

sonarqubecloud · 2025-09-16T08:06:52Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

thangqp · 2025-09-17T14:19:03Z

src/main/java/org/gridsuite/actions/server/entities/FilterBasedContingencyListEntity.java

+    @OneToMany(cascade = CascadeType.ALL)
+    private List<FilterMetaDataEntity> filtersListEntities;


Should declare all annotations for this relation, ex; table name, column names, constraint name

thangqp · 2025-09-17T17:30:11Z

src/main/java/org/gridsuite/actions/server/entities/FilterBasedContingencyListEntity.java

+@Getter
+@Setter
+@Entity
+@Table(name = "filter_based_contingency_list")


Suggested change

@Table(name = "filter_based_contingency_list")

@Table(name = ""filter_based_contingency"")

No contingency list is on element in this table. We should stay coherent with the other contingency list names.

src/main/java/org/gridsuite/actions/server/entities/FilterBasedContingencyListEntity.java

thangqp · 2025-09-18T07:06:48Z

src/main/resources/db/changelog/changesets/changelog_20250901T135222Z.xml

+        <addForeignKeyConstraint baseColumnNames="filter_based_contingency_list_entity_id" baseTableName="filter_based_contingency_list_filters_list_entities" constraintName="FK9edqyxdc33w1i725puwjjfhf5" deferrable="false" initiallyDeferred="false" referencedColumnNames="id" referencedTableName="filter_based_contingency_list" validate="true"/>
+    </changeSet>
+    <changeSet author="elcheikhbas (generated)" id="1756734757338-15">
+        <addForeignKeyConstraint baseColumnNames="filters_list_entities_id" baseTableName="filter_based_contingency_list_filters_list_entities" constraintName="FKgvj11ba8of2teiuumbgfho6c8" deferrable="false" initiallyDeferred="false" referencedColumnNames="id" referencedTableName="filter_metadata" validate="true"/>


constrantName not yet managed

thangqp · 2025-09-18T07:07:03Z

src/main/resources/db/changelog/changesets/changelog_20250901T135222Z.xml

+        <addUniqueConstraint columnNames="filters_list_entities_id" constraintName="UC_FILTER_BASED_CONTINGENCY_LIST_FILTERS_LIST_ENTITIESFILTERS_L" tableName="filter_based_contingency_list_filters_list_entities"/>
+    </changeSet>
+    <changeSet author="elcheikhbas (generated)" id="1756734757338-14">
+        <addForeignKeyConstraint baseColumnNames="filter_based_contingency_list_entity_id" baseTableName="filter_based_contingency_list_filters_list_entities" constraintName="FK9edqyxdc33w1i725puwjjfhf5" deferrable="false" initiallyDeferred="false" referencedColumnNames="id" referencedTableName="filter_based_contingency_list" validate="true"/>


constrantName not yet managed

src/main/java/org/gridsuite/actions/server/ContingencyListController.java

thangqp · 2025-09-18T07:12:46Z

src/main/java/org/gridsuite/actions/server/ContingencyListController.java

+    @PutMapping(value = "/filters-contingency-lists/{id}", consumes = MediaType.APPLICATION_JSON_VALUE)
+    @Operation(summary = "Modify a filter based contingency list")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The filter based contingency list have been modified successfully")})
+    public ResponseEntity<Void> modifyFilterBasedContingencyList(
+        @PathVariable UUID id,
+        @RequestBody FilterBasedContingencyList contingencyList,
+        @RequestHeader("userId") String userId) {
+        try {
+            service.modifyFilterBasedContingencyList(id, contingencyList, userId);
+            return ResponseEntity.ok().build();
+        } catch (EntityNotFoundException ignored) {
+            return ResponseEntity.notFound().build();
+        }
+    }


PUT insert new lines in filter_metadata but not clean old lines, to verify annotation orphanRemoval option of OneToMany.
However, I see lines in relation table are removed

thangqp · 2025-09-18T07:19:41Z

src/main/java/org/gridsuite/actions/server/dto/FilterMetaData.java

+    @Schema(description = "filter name")
+    private String name;
+
+    @Schema(description = "equipment type")
+    private String equipmentType;


In my opinion, storing filter metadata on the actions server creates a risk: if a filter’s name or equipment type is updated, this information won’t stay synchronized.

These metadata should be enriched at service level when GET filter's info

Co-authored-by: Thang PHAM <[email protected]>

flomillot · 2025-09-18T13:49:48Z

src/main/java/org/gridsuite/actions/server/ContingencyListController.java

+    }
+
+    @PostMapping(value = "/filters-contingency-lists", params = "duplicateFrom")
+    @Operation(summary = "Create a filter based contingency list from another existing one")


the correct sentence is from an existing one or another one

flomillot · 2025-09-18T13:51:38Z

src/main/java/org/gridsuite/actions/server/ContingencyListController.java

+    @PostMapping(value = "/filters-contingency-lists", params = "duplicateFrom")
+    @Operation(summary = "Create a filter based contingency list from another existing one")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The filter based contingency list have been duplicated successfully"),
+        @ApiResponse(responseCode = "404", description = "Source form contingency list not found")})


Suggested change

@ApiResponse(responseCode = "404", description = "Source form contingency list not found")})

@ApiResponse(responseCode = "404", description = "Source from contingency list not found")})

I guess it's a mistake

yes i should replace by filter based contingency list

flomillot · 2025-09-18T13:59:44Z

src/main/java/org/gridsuite/actions/server/dto/FilterMetaData.java

+@NoArgsConstructor
+@AllArgsConstructor
+@Schema(description = "Metadata on filters composing filter based contingency list")
+public class FilterMetaData {


ok changed the class was renamed to FilterAttributes

flomillot · 2025-09-18T14:11:28Z

src/test/java/org/gridsuite/actions/server/ContingencyListControllerTest.java

+        String jsonData = "{\"filters\":[{\"equipmentType\":\"LINE\",\"id\":\"b45df471-ada2-4422-975b-d89b62192191\",\"name\":\"Filter1\"}";
+        jsonData += ",{\"equipmentType\":\"TWO_WINDINGS_TRANSFORMER\",\"id\":\"2da834f8-6ab7-4781-b3ba-83f6f4a2f509\",\"name\":\"Filter3\"}]}";
+        return jsonData;


these kind of strings are very annoying to read and maintain can you make it an object or a json ?

flomillot · 2025-09-18T14:18:23Z

src/main/java/org/gridsuite/actions/server/utils/RestTemplateConfig.java

+import org.springframework.web.client.RestTemplate;
+
+@Configuration
+public class RestTemplateConfig {


I guess you took it from another service, maybe we can mutualize this bean?

first version

9f3fe7d

basseche self-assigned this Sep 1, 2025

basseche changed the title ~~Add Filter Based Contingency List~~ WIP : Add Filter Based Contingency List Sep 1, 2025

basseche added 5 commits September 2, 2025 14:20

Merge branch 'main' into filterBasedContingencyList

6dacdd9

Save contingency list Ok

383a3ef

delete element Ok

0f6aeba

add more metadata to restore colors in GUI

d7a3915

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

editing contingency list ok

e775fd4

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

basseche force-pushed the filterBasedContingencyList branch from 85727fe to e775fd4 Compare September 4, 2025 12:58

basseche added 4 commits September 10, 2025 11:46

add duplicate request

081cadb

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

checkstyle Ok

4ef14c4

Merge branch 'main' into filterBasedContingencyList

faea470

Fix + add Tests

ac2a7ee

basseche changed the title ~~WIP : Add Filter Based Contingency List~~ Add Filter Based Contingency List Sep 11, 2025

basseche added 10 commits September 12, 2025 09:43

add more tests for filter based contingency list

47f22ed

fix name

11df483

add header

7690d93

fix test failure

981ee07

add connection to filter-server

b519ccd

change variantId to string

0cd4045

add test on get

2d1d51b

increase coverage

c82ce8f

more tests

dd05b3d

little refactor

21f1bec

basseche requested review from thangqp and Mathieu-Deharbe September 16, 2025 08:27

basseche added 2 commits September 16, 2025 17:50

modify filterServer to fit modifications on filter server

01775ac

add todo

e9018fa

thangqp reviewed Sep 17, 2025

View reviewed changes

src/main/java/org/gridsuite/actions/server/entities/FilterBasedContingencyListEntity.java Outdated Show resolved Hide resolved

thangqp reviewed Sep 18, 2025

View reviewed changes

src/main/java/org/gridsuite/actions/server/ContingencyListController.java Outdated Show resolved Hide resolved

thangqp reviewed Sep 18, 2025

View reviewed changes

Apply suggestions from code review

d62481d

Co-authored-by: Thang PHAM <[email protected]>

flomillot reviewed Sep 18, 2025

View reviewed changes

basseche added 3 commits September 19, 2025 15:56

Changes on data base conception - tests Ko

12faf76

tests ok

ea66686

review

89200de

		@OneToMany(cascade = CascadeType.ALL)
		private List<FilterMetaDataEntity> filtersListEntities;

	@Table(name = "filter_based_contingency_list")
	@Table(name = ""filter_based_contingency"")

	@ApiResponse(responseCode = "404", description = "Source form contingency list not found")})
	@ApiResponse(responseCode = "404", description = "Source from contingency list not found")})

Add Filter Based Contingency List #136

Are you sure you want to change the base?

Add Filter Based Contingency List #136

Uh oh!

Conversation

basseche commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 16, 2025

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

basseche commented Sep 1, 2025 •

edited

Loading