update comments

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

Author: dbraquart

src/main/java/org/gridsuite/modification/server/repositories/NetworkModificationRepository.java

@@ -104,18 +104,16 @@ public void deleteAll() {
         modificationGroupRepository.deleteAll();
     }
 
-    @Transactional // To have all create in the same transaction (atomic)
-    // TODO Remove transaction when errors will no longer be sent to the front
-    // This method should be package-private and not used as API of the service as it uses ModificationEntity and
-    // we want to encapsulate the use of Entity related objects to this service.
-    // Nevertheless We have to keep it public for transactional annotation.
+    @Transactional
+    // TODO Rather than calling saveModificationsNonTransactional(), we should call saveModificationInfos() below.
+    // In this case, we could change this method signature to use DTOs instead of Entities.
+    // Note: This current method is used only by the tests.
     public List<ModificationEntity> saveModifications(UUID groupUuid, List<ModificationEntity> modifications) {
         return saveModificationsNonTransactional(groupUuid, modifications);
     }
 
     public List<ModificationEntity> saveModificationInfos(UUID groupUuid, List<ModificationInfos> modifications) {
         List<ModificationEntity> entities = modifications.stream().map(ModificationEntity::fromDTO).toList();
-
         return saveModificationsNonTransactional(groupUuid, entities);
     }
 

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

@@ -450,7 +450,8 @@ void testNetworkModificationsWithErrorOnNetworkFlush() throws Exception {
         String groovyScriptInfosJson = getJsonBody(groovyScriptInfos, TEST_NETWORK_WITH_FLUSH_ERROR_ID, NetworkCreation.VARIANT_ID);
 
         mockMvc.perform(post(NETWORK_MODIFICATION_URI).content(groovyScriptInfosJson).contentType(MediaType.APPLICATION_JSON)).andExpect(status().is5xxServerError());
-
+        // TODO because creating a modification is now a unique Tx, and because network.flush() is not covered by the apply() exception catch,
+        // this test result has changed : the modification save is not committed because of the flush exception.
         assertEquals(0, modificationRepository.getModifications(TEST_GROUP_ID, true, false).size());
     }
 

src/test/java/org/gridsuite/modification/server/modifications/tabularcreations/TabularGeneratorCreationsTest.java

@@ -338,7 +338,7 @@ void testUnsupportedTabularCreationType() throws Exception {
                 .build();
         String tabularCreationJson = getJsonBody(creationInfos, null);
 
-        // try to create something impossible
+        // try to create+apply a tabular creation with an unsupported type
         ServletException exception = assertThrows(
                 ServletException.class,
                 () -> mockMvc.perform(post(getNetworkModificationUri()).content(tabularCreationJson).contentType(MediaType.APPLICATION_JSON))

src/test/java/org/gridsuite/modification/server/modifications/tabularmodifications/TabularGeneratorModificationsTest.java

@@ -595,7 +595,7 @@ void testUnsupportedTabularModificationType() throws Exception {
                 .build();
         String tabularModificationJson = getJsonBody(tabularInfos, null);
 
-        // try to create something impossible
+        // try to create+apply a tabular modification with an unsupported type
         ServletException exception = assertThrows(
                 ServletException.class,
                 () -> mockMvc.perform(post(getNetworkModificationUri()).content(tabularModificationJson).contentType(MediaType.APPLICATION_JSON))