Add append mode in spreadsheet collection import (#44)

Signed-off-by: David BRAQUART <[email protected]>

Author: dbraquart

src/main/java/org/gridsuite/studyconfig/server/controller/SpreadsheetConfigCollectionController.java

@@ -105,6 +105,18 @@ public ResponseEntity<Void> updateSpreadsheetConfigCollectionWithConfigs(
         return ResponseEntity.noContent().build();
     }
 
+    @PutMapping("/{id}/append")
+    @Operation(summary = "Append a collection to another collection",
+            description = "")
+    @ApiResponse(responseCode = "204", description = "Collection updated")
+    @ApiResponse(responseCode = "404", description = "One of the collections not found")
+    public ResponseEntity<Void> appendSpreadsheetConfigCollection(
+            @Parameter(description = "ID of the configuration collection to update") @PathVariable UUID id,
+            @Parameter(description = "ID of the configuration collection to be appended") @RequestParam(name = "sourceCollection") UUID sourceCollectionId) {
+        spreadsheetConfigService.appendSpreadsheetConfigCollection(id, sourceCollectionId);
+        return ResponseEntity.noContent().build();
+    }
+
     @PostMapping(params = { "duplicateFrom" })
     @Operation(summary = "Duplicate a spreadsheet configuration collection",
             description = "Creates a copy of an existing spreadsheet configuration collection")

src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java

@@ -190,6 +190,40 @@ public void updateSpreadsheetConfigCollectionWithConfigs(UUID id, List<UUID> con
                 .toList());
     }
 
+    @Transactional
+    public void appendSpreadsheetConfigCollection(UUID id, UUID sourceCollectionId) {
+        SpreadsheetConfigCollectionEntity targetEntity = spreadsheetConfigCollectionRepository.findById(id)
+                .orElseThrow(() -> new EntityNotFoundException(SPREADSHEET_CONFIG_COLLECTION_NOT_FOUND + id));
+        SpreadsheetConfigCollectionEntity sourceEntity = spreadsheetConfigCollectionRepository.findById(sourceCollectionId)
+                .orElseThrow(() -> new EntityNotFoundException(SPREADSHEET_CONFIG_COLLECTION_NOT_FOUND + sourceCollectionId));
+        // Make sure names are unique in the merged collection
+        Set<String> targetNames = targetEntity.getSpreadsheetConfigs().stream().map(SpreadsheetConfigEntity::getName).collect(Collectors.toSet());
+        Set<String> sourceNames = sourceEntity.getSpreadsheetConfigs().stream().map(SpreadsheetConfigEntity::getName).collect(Collectors.toSet());
+        targetEntity.getSpreadsheetConfigs().addAll(sourceEntity.getSpreadsheetConfigs().stream().map(SpreadsheetConfigEntity::getId)
+                .map(configId -> {
+                    SpreadsheetConfigEntity clone = duplicateSpreadsheetConfigEntity(configId);
+                    clone.setName(getUniqueName(clone.getName(), targetNames, sourceNames));
+                    return clone;
+                })
+                .toList());
+        // keep only aliases of appended collection, they will be invalidated by the Front
+        targetEntity.getNodeAliases().clear();
+        targetEntity.getNodeAliases().addAll(sourceEntity.getNodeAliases());
+    }
+
+    private String getUniqueName(String name, Set<String> targetNames, Set<String> sourceNames) {
+        if (!targetNames.contains(name)) {
+            return name;
+        }
+        final String newNameFormat = name + " (%d)";
+        String nextName;
+        int x = 0;
+        do {
+            nextName = String.format(newNameFormat, ++x);
+        } while (targetNames.contains(nextName) || sourceNames.contains(nextName));
+        return nextName;
+    }
+
     @Transactional
     public UUID duplicateSpreadsheetConfigCollection(UUID id) {
         SpreadsheetConfigCollectionEntity entity = spreadsheetConfigCollectionRepository.findById(id)

src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigCollectionIntegrationTest.java

@@ -123,6 +123,29 @@ void testUpdateCollection() throws Exception {
             .isEqualTo(updatedCollection);
     }
 
+    @Test
+    void testAppendCollection() throws Exception {
+        List<String> existingAliases = List.of("n1", "n2", "n3");
+        SpreadsheetConfigCollectionInfos collectionToUpdate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), existingAliases);
+        UUID collectionUuid = saveAndReturnId(collectionToUpdate);
+
+        List<String> appendedAliases = List.of("n1", "n6", "n3");
+        SpreadsheetConfigCollectionInfos appendedCollection = new SpreadsheetConfigCollectionInfos(null, createUpdatedSpreadsheetConfigs(), appendedAliases);
+        UUID appendedCollectionUuid = saveAndReturnId(appendedCollection);
+
+        mockMvc.perform(put(URI_SPREADSHEET_CONFIG_COLLECTION_BASE + "/" + collectionUuid + "/append?sourceCollection=" + appendedCollectionUuid)
+                        .contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isNoContent());
+
+        SpreadsheetConfigCollectionInfos mergedCollection = getSpreadsheetConfigCollection(collectionUuid);
+
+        // We have 3 new tabs coming from the appended collection, but 2 have been renamed to ensure name uniqueness.
+        assertThat(mergedCollection.spreadsheetConfigs().stream().map(SpreadsheetConfigInfos::name).toList())
+                .isEqualTo(List.of("TestSheet", "TestSheet1", "Generator", "TestSheet (2)", "TestSheet (1)"));
+        // In the appended collection, we keep only the aliases from the appended collection
+        assertThat(mergedCollection.nodeAliases()).isEqualTo(appendedAliases);
+    }
+
     @Test
     void testDeleteCollection() throws Exception {
         SpreadsheetConfigCollectionInfos collectionToDelete = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
@@ -185,8 +208,8 @@ void testAddSpreadsheetConfigToCollection() throws Exception {
         SpreadsheetConfigCollectionInfos initialCollection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(initialCollection);
 
-        List<ColumnInfos> columnInfos = Arrays.asList(
-            new ColumnInfos(null, "new_col", ColumnType.NUMBER, 1, "formula", "[\"dep\"]", "idNew")
+        List<ColumnInfos> columnInfos = List.of(
+                new ColumnInfos(null, "new_col", ColumnType.NUMBER, 1, "formula", "[\"dep\"]", "idNew")
         );
         SpreadsheetConfigInfos newConfig = new SpreadsheetConfigInfos(null, "NewSheet", SheetType.BATTERY, columnInfos);
 
@@ -212,7 +235,7 @@ void testRemoveSpreadsheetConfigFromCollection() throws Exception {
         UUID collectionUuid = postSpreadsheetConfigCollection(initialCollection);
 
         SpreadsheetConfigCollectionInfos createdCollection = getSpreadsheetConfigCollection(collectionUuid);
-        UUID configIdToRemove = createdCollection.spreadsheetConfigs().get(0).id();
+        UUID configIdToRemove = createdCollection.spreadsheetConfigs().getFirst().id();
 
         mockMvc.perform(delete(URI_SPREADSHEET_CONFIG_COLLECTION_BASE + "/" + collectionUuid + "/spreadsheet-configs/" + configIdToRemove))
                 .andExpect(status().isNoContent());
@@ -343,8 +366,8 @@ private List<SpreadsheetConfigInfos> createUpdatedSpreadsheetConfigs() {
 
         return List.of(
                 new SpreadsheetConfigInfos(null, "Generator", SheetType.GENERATOR, columnInfos),
-                new SpreadsheetConfigInfos(null, "Generator1", SheetType.GENERATOR, columnInfos),
-                new SpreadsheetConfigInfos(null, "Battery", SheetType.BATTERY, columnInfos)
+                new SpreadsheetConfigInfos(null, "TestSheet", SheetType.GENERATOR, columnInfos),
+                new SpreadsheetConfigInfos(null, "TestSheet (1)", SheetType.BATTERY, columnInfos)
         );
     }