Change signature of migrate method to return mutated instance of case data

Author: DamianDunajski

README.md

@@ -24,13 +24,13 @@ Package offers base domain classes for standardised case data structures such as
 Assuming that you have Java project scaffolding please include framework artifact as a project dependency by adding following line:
 
 ```groovy
-compile group: 'uk.gov.hmcts.reform.ccd-case-migration', name: 'processor', version: '1.1.0'
+compile group: 'uk.gov.hmcts.reform.ccd-case-migration', name: 'processor', version: '2.0.0'
 ```
 
 If you want to take advantages of standard domain classes please also include domain artifact as a project dependency by adding following line:
 
 ```groovy
-compile group: 'uk.gov.hmcts.reform.ccd-case-migration', name: 'domain', version: '1.1.0'
+compile group: 'uk.gov.hmcts.reform.ccd-case-migration', name: 'domain', version: '2.0.0'
 ```
 
 Having done above please create class that implements `uk.gov.hmcts.reform.migration.service.DataMigrationService` interface in similar way as shown below:

build.gradle

@@ -11,7 +11,7 @@ subprojects {
   apply plugin: 'com.jfrog.bintray'
 
   group = 'uk.gov.hmcts.reform.ccd-case-migration'
-  version = '1.1.0'
+  version = '2.0.0'
 
   sourceCompatibility = '11'
   targetCompatibility = '11'

modules/processor/src/main/java/uk/gov/hmcts/reform/migration/CaseMigrationProcessor.java

@@ -10,6 +10,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 @Slf4j
 @Component
@@ -21,7 +22,7 @@ public class CaseMigrationProcessor {
     @Autowired
     private CoreCaseDataService coreCaseDataService;
     @Autowired
-    private DataMigrationService dataMigrationService;
+    private DataMigrationService<?> dataMigrationService;
     @Getter
     private List<Long> migratedCases = new ArrayList<>();
     @Getter
@@ -36,7 +37,7 @@ public void processSingleCase(String userToken, String caseId) {
             return;
         }
         if (dataMigrationService.accepts().test(caseDetails)) {
-            updateCase(userToken, caseDetails);
+            updateCase(userToken, caseDetails.getId(), caseDetails.getData());
         } else {
             log.info("Case {} already migrated", caseDetails.getId());
         }
@@ -45,21 +46,20 @@ public void processSingleCase(String userToken, String caseId) {
     public void processAllCases(String userToken, String userId) {
         coreCaseDataService.fetchAll(userToken, userId).stream()
             .filter(dataMigrationService.accepts())
-            .forEach(caseDetails -> updateCase(userToken, caseDetails));
+            .forEach(caseDetails -> updateCase(userToken, caseDetails.getId(), caseDetails.getData()));
     }
 
-    private void updateCase(String authorisation, CaseDetails caseDetails) {
-        log.info("Updating case {}", caseDetails.getId());
+    private void updateCase(String authorisation, Long id, Map<String, Object> data) {
+        log.info("Updating case {}", id);
         try {
-            log.debug("Case data: {}", caseDetails.getData());
-            dataMigrationService.migrate(caseDetails);
-            coreCaseDataService.update(authorisation, caseDetails.getId().toString(),
-                EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, caseDetails.getData());
-            log.info("Case {} successfully updated", caseDetails.getId());
-            migratedCases.add(caseDetails.getId());
+            log.debug("Case data: {}", data);
+            coreCaseDataService.update(authorisation, id.toString(),
+                EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, dataMigrationService.migrate(data));
+            log.info("Case {} successfully updated", id);
+            migratedCases.add(id);
         } catch (Exception e) {
-            log.error("Case {} update failed due to: {}", caseDetails.getId(), e.getMessage());
-            failedCases.add(caseDetails.getId());
+            log.error("Case {} update failed due to: {}", id, e.getMessage());
+            failedCases.add(id);
         }
     }
 }

modules/processor/src/main/java/uk/gov/hmcts/reform/migration/service/DataMigrationService.java

@@ -2,10 +2,11 @@
 
 import uk.gov.hmcts.reform.ccd.client.model.CaseDetails;
 
+import java.util.Map;
 import java.util.function.Predicate;
 
-public interface DataMigrationService {
+public interface DataMigrationService<T> {
     Predicate<CaseDetails> accepts();
 
-    void migrate(CaseDetails caseDetails);
+    T migrate(Map<String, Object> data);
 }

modules/processor/src/test/java/uk/gov/hmcts/reform/migration/CaseMigrationProcessorTest.java

@@ -66,6 +66,7 @@ public void shouldProcessASingleCaseAndMigrationIsSuccessful() {
     public void shouldProcessASingleCaseAndMigrationIsFailed() {
         when(coreCaseDataService.fetchOne(USER_TOKEN, CASE_ID)).thenReturn(caseDetails1);
         when(dataMigrationService.accepts()).thenReturn(candidate -> true);
+        when(dataMigrationService.migrate(caseDetails1.getData())).thenReturn(caseDetails1.getData());
         when(coreCaseDataService.update(USER_TOKEN, caseDetails1.getId().toString(), EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, caseDetails1.getData())).thenThrow(new RuntimeException("Internal server error"));
         caseMigrationProcessor.processSingleCase(USER_TOKEN, CASE_ID);
         verify(coreCaseDataService, times(1)).fetchOne(USER_TOKEN, CASE_ID);
@@ -80,6 +81,9 @@ public void shouldProcessAllTheCandidateCases_whenOneCaseFailed() {
         mockDataUpdate(caseDetails1);
         mockDataUpdate(caseDetails2);
         when(dataMigrationService.accepts()).thenReturn(candidate -> true);
+        when(dataMigrationService.migrate(caseDetails1.getData())).thenReturn(caseDetails1.getData());
+        when(dataMigrationService.migrate(caseDetails2.getData())).thenReturn(caseDetails2.getData());
+        when(dataMigrationService.migrate(caseDetails3.getData())).thenReturn(caseDetails3.getData());
         when(coreCaseDataService.update(USER_TOKEN, caseDetails3.getId().toString(), EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, caseDetails3.getData())).thenThrow(new RuntimeException("Internal server error"));
         caseMigrationProcessor.processAllCases(USER_TOKEN, USER_ID);
         assertThat(caseMigrationProcessor.getFailedCases(), contains(1113L));
@@ -91,6 +95,9 @@ public void shouldProcessAllTheCandidateCases_whenTwoCasesFailed() {
         mockDataFetch(caseDetails1, caseDetails2, caseDetails3);
         mockDataUpdate(caseDetails1);
         when(dataMigrationService.accepts()).thenReturn(candidate -> true);
+        when(dataMigrationService.migrate(caseDetails1.getData())).thenReturn(caseDetails1.getData());
+        when(dataMigrationService.migrate(caseDetails2.getData())).thenReturn(caseDetails2.getData());
+        when(dataMigrationService.migrate(caseDetails3.getData())).thenReturn(caseDetails3.getData());
         when(coreCaseDataService.update(USER_TOKEN, caseDetails2.getId().toString(), EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, caseDetails2.getData())).thenThrow(new RuntimeException("Internal server error"));
         when(coreCaseDataService.update(USER_TOKEN, caseDetails3.getId().toString(), EVENT_ID, EVENT_SUMMARY, EVENT_DESCRIPTION, caseDetails3.getData())).thenThrow(new RuntimeException("Internal server error"));
         caseMigrationProcessor.processAllCases(USER_TOKEN, USER_ID);