Group the network modifications search results by modification id (#719)

Previously, the modification search returned a list of modified equipments for each node, with the associated modification id. Now, for each node, a list of modifications is returned, and each modification is associated with a list of impacted equipments. Impacted equipments are therefore grouped by modificationId.

Author: carojeandat

src/main/java/org/gridsuite/modification/server/dto/ModificationsSearchResult.java

@@ -13,10 +13,12 @@
 import lombok.NoArgsConstructor;
 import org.gridsuite.modification.server.entities.ModificationEntity;
 
+import java.util.List;
 import java.util.UUID;
 
 /**
  * @author Souissi Maissa <souissi.maissa at rte-france.com>
+ * @author Caroline Jeandat <caroline.jeandat at rte-france.com>
  */
 @Getter
 @NoArgsConstructor
@@ -27,21 +29,15 @@ public class ModificationsSearchResult {
     @Schema(description = "Modification id")
     private UUID modificationUuid;
 
-    @Schema(
-            description = "Message type"
-    )
+    @Schema(description = "Message type")
     private String messageType;
 
-    @Schema(
-            description = "Impacted equipment ID"
-    )
-
-    private String impactedEquipmentId;
-    @Schema(
-            description = "Message values"
-    )
+    @Schema(description = "Message values")
     private String messageValues;
 
+    @Schema(description = "List of impacted equipment IDs")
+    private List<String> impactedEquipmentIds;
+
     public static ModificationsSearchResult.ModificationsSearchResultBuilder fromModificationEntity(ModificationEntity modificationEntity) {
         return ModificationsSearchResult.builder()
                 .modificationUuid(modificationEntity.getId())

src/main/java/org/gridsuite/modification/server/service/NetworkModificationService.java

@@ -403,7 +403,6 @@ public Map<UUID, List<ModificationsSearchResult>> searchNetworkModifications(@No
 
         List<ModificationsSearchResult> filteredSearchModificationsResult = rawSearchModificationInfos.stream()
                 .map(result -> findMatchingEquipmentResults(modificationEntitiesById.get(result.getModificationUuid()), result, userInput))
-                .flatMap(List::stream)
                 .toList();
 
         return groupSearchResultsByGroupUuid(filteredSearchModificationsResult, rawSearchModificationInfos);
@@ -431,14 +430,13 @@ private Map<UUID, ModificationEntity> getModificationEntitiesById(List<Modificat
                 .collect(Collectors.toMap(ModificationEntity::getId, Function.identity()));
     }
 
-    private List<ModificationsSearchResult> findMatchingEquipmentResults(
+    private ModificationsSearchResult findMatchingEquipmentResults(
             ModificationEntity modificationEntity,
             ModificationApplicationInfos matchedModification,
             String userInput) {
         Pattern pattern = Pattern.compile(Pattern.quote(stripAccents(userInput)), Pattern.CASE_INSENSITIVE);
 
-        List<ModificationsSearchResult> modificationSearchResults = new ArrayList<>();
-        Stream.of(
+        List<String> impactedEquipmentIds = Stream.of(
                         matchedModification.getCreatedEquipmentIds(),
                         matchedModification.getModifiedEquipmentIds(),
                         matchedModification.getDeletedEquipmentIds()
@@ -447,12 +445,11 @@ private List<ModificationsSearchResult> findMatchingEquipmentResults(
                 .flatMap(Collection::stream)
                 .distinct()
                 .filter(id -> pattern.matcher(stripAccents(id)).find())
-                .map(id -> ModificationsSearchResult.fromModificationEntity(modificationEntity)
-                        .impactedEquipmentId(id)
-                        .build())
-                .forEach(modificationSearchResults::add);
+                .toList();
 
-        return modificationSearchResults;
+        return ModificationsSearchResult.fromModificationEntity(modificationEntity)
+                        .impactedEquipmentIds(impactedEquipmentIds)
+                        .build();
     }
 
     private static String stripAccents(String input) {

src/test/java/org/gridsuite/modification/server/ModificationControllerTest.java

@@ -1979,7 +1979,8 @@ void testSearchModificationInfos() throws Exception {
                 });
         assertEquals(1, networkModificationsResult.size());
         modificationsSearchResult = networkModificationsResult.get(TEST_GROUP_ID);
-        assertEquals(4, modificationsSearchResult.size());
+        assertEquals(1, modificationsSearchResult.size());
+        assertEquals(4, modificationsSearchResult.getFirst().getImpactedEquipmentIds().size());
         assertEquals("GENERATOR_CREATION", modificationsSearchResult.getFirst().getMessageType());
         assertEquals("{\"equipmentId\":\"idGenerator1\"}", modificationsSearchResult.getFirst().getMessageValues());