Add reorder spreadsheet configs (#32)

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

Author: achour94

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

@@ -137,4 +137,16 @@ public ResponseEntity<Void> removeSpreadsheetConfigFromCollection(
         return ResponseEntity.noContent().build();
     }
 
+    @PutMapping("/{id}/reorder")
+    @Operation(summary = "Reorder spreadsheet configs in a collection",
+            description = "Updates the order of spreadsheet configs within a collection")
+    @ApiResponse(responseCode = "204", description = "Order updated")
+    @ApiResponse(responseCode = "404", description = "Collection not found")
+    public ResponseEntity<Void> reorderSpreadsheetConfigs(
+            @Parameter(description = "ID of the configuration collection") @PathVariable UUID id,
+            @Valid @RequestBody List<UUID> newOrder) {
+        spreadsheetConfigService.reorderSpreadsheetConfigs(id, newOrder);
+        return ResponseEntity.noContent().build();
+    }
+
 }

src/main/java/org/gridsuite/studyconfig/server/entities/SpreadsheetConfigCollectionEntity.java

@@ -32,6 +32,7 @@ public class SpreadsheetConfigCollectionEntity {
 
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
     @JoinColumn(name = "collection_id", foreignKey = @ForeignKey(name = "fk_spreadsheet_config_collection"))
+    @OrderColumn(name = "config_order")
     @Builder.Default
     private List<SpreadsheetConfigEntity> spreadsheetConfigs = new ArrayList<>();
 }

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

@@ -27,9 +27,8 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.List;
-import java.util.Objects;
-import java.util.UUID;
+import java.util.*;
+import java.util.stream.Collectors;
 
 /**
  * @author Achour BERRAHMA <achour.berrahma at rte-france.com>
@@ -303,4 +302,26 @@ public void removeSpreadsheetConfigFromCollection(UUID collectionId, UUID config
         spreadsheetConfigCollectionRepository.save(collection);
     }
 
+    @Transactional
+    public void reorderSpreadsheetConfigs(UUID collectionId, List<UUID> newOrder) {
+        SpreadsheetConfigCollectionEntity collection = spreadsheetConfigCollectionRepository.findById(collectionId)
+                .orElseThrow(() -> new EntityNotFoundException(SPREADSHEET_CONFIG_COLLECTION_NOT_FOUND + collectionId));
+
+        // Validate inputs
+        Set<UUID> existingIds = collection.getSpreadsheetConfigs().stream()
+                .map(SpreadsheetConfigEntity::getId)
+                .collect(Collectors.toSet());
+
+        if (existingIds.size() != newOrder.size() || !existingIds.containsAll(newOrder)) {
+            throw new IllegalArgumentException("New order must contain exactly the same configs as the collection");
+        }
+
+        List<SpreadsheetConfigEntity> configs = collection.getSpreadsheetConfigs();
+        configs.sort((c1, c2) -> {
+            int idx1 = newOrder.indexOf(c1.getId());
+            int idx2 = newOrder.indexOf(c2.getId());
+            return Integer.compare(idx1, idx2);
+        });
+    }
+
 }

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

@@ -0,0 +1,21 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="berrahmaach (generated)" id="1741095166265-1">
+        <addColumn tableName="spreadsheet_config">
+            <column name="config_order" type="integer"/>
+        </addColumn>
+    </changeSet>
+    <changeSet author="berrahmaach (generated)" id="1741095166265-2">
+        <sql dbms="postgresql">
+            WITH ordered_configs AS (
+            SELECT id, collection_id, ROW_NUMBER() OVER (PARTITION BY collection_id ORDER BY id) - 1 as seq
+            FROM spreadsheet_config
+            WHERE collection_id IS NOT NULL
+            )
+            UPDATE spreadsheet_config sc
+            SET config_order = oc.seq
+            FROM ordered_configs oc
+            WHERE sc.id = oc.id;
+        </sql>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/db/changelog/db.changelog-master.yaml

@@ -23,3 +23,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20250220T172856Z.xml
       relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250304T133229Z.xml
+      relativeToChangelogFile: true

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

@@ -24,9 +24,7 @@
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
-import java.util.Arrays;
-import java.util.List;
-import java.util.UUID;
+import java.util.*;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
@@ -228,6 +226,38 @@ void testRemoveNonExistentSpreadsheetConfig() throws Exception {
                 .andExpect(status().isNotFound());
     }
 
+    @Test
+    void testReorderSpreadsheetConfigs() throws Exception {
+        // Create a collection with multiple configs
+        SpreadsheetConfigCollectionInfos collection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        UUID collectionId = postSpreadsheetConfigCollection(collection);
+
+        // Get the created collection to get the config IDs
+        SpreadsheetConfigCollectionInfos createdCollection = getSpreadsheetConfigCollection(collectionId);
+        List<UUID> configIds = createdCollection.spreadsheetConfigs().stream()
+                .map(SpreadsheetConfigInfos::id)
+                .toList();
+
+        // Create a new order (reverse the existing order)
+        List<UUID> newOrder = new ArrayList<>(configIds);
+        Collections.reverse(newOrder);
+
+        // Send the reorder request
+        String newOrderJson = mapper.writeValueAsString(newOrder);
+        mockMvc.perform(put("/v1/spreadsheet-config-collections/" + collectionId + "/reorder")
+                        .content(newOrderJson)
+                        .contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isNoContent());
+
+        // Get the collection again and verify the order has changed
+        SpreadsheetConfigCollectionInfos updatedCollection = getSpreadsheetConfigCollection(collectionId);
+        List<UUID> updatedConfigIds = updatedCollection.spreadsheetConfigs().stream()
+                .map(SpreadsheetConfigInfos::id)
+                .toList();
+
+        assertThat(updatedConfigIds).isEqualTo(newOrder);
+    }
+
     private List<SpreadsheetConfigInfos> createSpreadsheetConfigs() {
         List<ColumnInfos> columnInfos = Arrays.asList(
             new ColumnInfos(null, "cust_a", ColumnType.NUMBER, 1, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),