Ensure column id and column name unicity when duplicating a column

Signed-off-by: Franck LECUYER <[email protected]>

Author: FranckLecuyer

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

@@ -8,6 +8,7 @@
 
 import jakarta.persistence.EntityNotFoundException;
 import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.tuple.Pair;
 import org.gridsuite.studyconfig.server.dto.*;
 import org.gridsuite.studyconfig.server.entities.ColumnEntity;
 import org.gridsuite.studyconfig.server.entities.GlobalFilterEntity;
@@ -371,16 +372,45 @@ private static void reorderColumns(List<UUID> columnOrder, List<ColumnEntity> co
         columns.sort(Comparator.comparingInt(column -> columnOrder.indexOf(column.getUuid())));
     }
 
+    private String newCandidate(String base, int n) {
+        return base + '(' + n + ')';
+    }
+
+    private Pair<String, String> getDuplicateIdAndNameCandidate(SpreadsheetConfigEntity entity, String columnId, String columnName) {
+        String newColumnId = columnId;
+        String newColumnName = columnName;
+
+        var existingColumnIds = entity.getColumns().stream().map(ColumnEntity::getId).collect(Collectors.toSet());
+        var existingColumnNames = entity.getColumns().stream().map(ColumnEntity::getName).collect(Collectors.toSet());
+
+        if (existingColumnIds.contains(columnId)) {
+            int i = 1;
+            while (existingColumnIds.contains(newCandidate(columnId, i))) {
+                ++i;
+            }
+            newColumnId = newCandidate(columnId, i);
+        }
+        if (existingColumnNames.contains(columnName)) {
+            int i = 1;
+            while (existingColumnNames.contains(newCandidate(columnName, i))) {
+                ++i;
+            }
+            newColumnName = newCandidate(columnName, i);
+        }
+
+        return Pair.of(newColumnId, newColumnName);
+    }
+
     @Transactional
     public void duplicateColumn(UUID id, UUID columnId) {
         SpreadsheetConfigEntity entity = findEntityById(id);
         ColumnEntity columnEntity = entity.getColumns().stream().filter(col -> col.getUuid().equals(columnId))
                 .findFirst().orElseThrow(() -> new EntityNotFoundException(COLUMN_NOT_FOUND + columnId));
         ColumnEntity columnCopy = columnEntity.toBuilder().build();
         columnCopy.setUuid(UUID.randomUUID());
-        columnCopy.setId(columnCopy.getId() + "copy");
-        columnCopy.setName(columnCopy.getName() + "-copy");
-
+        Pair<String, String> idAndName = getDuplicateIdAndNameCandidate(entity, columnCopy.getId(), columnCopy.getName());
+        columnCopy.setId(idAndName.getLeft());
+        columnCopy.setName(idAndName.getRight());
         List<ColumnEntity> columns = entity.getColumns();
         columns.add(columns.indexOf(columnEntity) + 1, columnCopy);
         entity.setColumns(columns);

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

@@ -30,6 +30,7 @@
 import java.util.stream.Collectors;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
@@ -328,12 +329,22 @@ void testDuplicateColumn() throws Exception {
         ColumnInfos duplicatedColumnInfos = configAfterDuplicate.columns().get(1);
 
         assertThat(columnInfos.uuid()).isNotEqualTo(duplicatedColumnInfos.uuid());
-        assertThat(columnInfos.id()).isNotEqualTo(duplicatedColumnInfos.id());
+        assertEquals(columnInfos.id() + "(1)", duplicatedColumnInfos.id());
+        assertEquals(columnInfos.name() + "(1)", duplicatedColumnInfos.name());
         assertThat(columnInfos.visible()).isEqualTo(duplicatedColumnInfos.visible());
         assertThat(columnInfos.formula()).isEqualTo(duplicatedColumnInfos.formula());
         assertThat(columnInfos.dependencies()).isEqualTo(duplicatedColumnInfos.dependencies());
         assertThat(columnInfos.precision()).isEqualTo(duplicatedColumnInfos.precision());
 
+        mockMvc.perform(post(URI_SPREADSHEET_CONFIG_GET_PUT + configId + URI_COLUMN_BASE + "/" + columnId + "/duplicate"))
+                .andExpect(status().isNoContent());
+        configAfterDuplicate = getSpreadsheetConfig(configId);
+        assertThat(configAfterDuplicate.columns()).hasSize(6);
+        duplicatedColumnInfos = configAfterDuplicate.columns().get(1);
+        assertThat(columnInfos.uuid()).isNotEqualTo(duplicatedColumnInfos.uuid());
+        assertEquals(columnInfos.id() + "(2)", duplicatedColumnInfos.id());
+        assertEquals(columnInfos.name() + "(2)", duplicatedColumnInfos.name());
+
         mockMvc.perform(post(URI_SPREADSHEET_CONFIG_GET_PUT + configId + URI_COLUMN_BASE + "/" + UUID.randomUUID() + "/duplicate"))
                 .andExpect(status().isNotFound());
     }