DFR-3063/DFR-3195 Upload warnings on upload doc + NPE fix.

build.gradle

@@ -423,7 +423,7 @@ dependencies {
     implementation("org.apache.poi:poi:5.3.0") {
         exclude group: "org.apache.commons", module: "commons-math3"
     }
-    implementation("org.apache.poi:poi-ooxml:5.3.0") {
+    implementation("org.apache.poi:poi-ooxml:5.2.5") {
         exclude group: "org.apache.commons", module: "commons-math3"
     }
 

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/handler/UploadDocumentConsentedAboutToSubmitHandler.java

@@ -0,0 +1,83 @@
+package uk.gov.hmcts.reform.finrem.caseorchestration.handler;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.util.ObjectUtils;
+import uk.gov.hmcts.reform.finrem.caseorchestration.ccd.callback.CallbackType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.controllers.GenericAboutToStartOrSubmitCallbackResponse;
+import uk.gov.hmcts.reform.finrem.caseorchestration.mapper.FinremCaseDetailsMapper;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.EventType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.CaseType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.FinremCaseData;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.FinremCaseDetails;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.UploadDocumentCollection;
+import uk.gov.hmcts.reform.finrem.caseorchestration.service.NewUploadedDocumentsService;
+import uk.gov.hmcts.reform.finrem.caseorchestration.service.documentchecker.DocumentCheckerService;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import static java.lang.String.format;
+
+@Slf4j
+@Service
+public class UploadDocumentConsentedAboutToSubmitHandler extends FinremCallbackHandler {
+
+    private final DocumentCheckerService documentCheckerService;
+    private final NewUploadedDocumentsService newUploadedDocumentsService;
+
+    public UploadDocumentConsentedAboutToSubmitHandler(FinremCaseDetailsMapper mapper,
+                                                       DocumentCheckerService documentCheckerService,
+                                                       NewUploadedDocumentsService newUploadedDocumentsService) {
+        super(mapper);
+        this.documentCheckerService = documentCheckerService;
+        this.newUploadedDocumentsService = newUploadedDocumentsService;
+    }
+
+    @Override
+    public boolean canHandle(CallbackType callbackType, CaseType caseType, EventType eventType) {
+        return CallbackType.ABOUT_TO_SUBMIT.equals(callbackType)
+            && CaseType.CONSENTED.equals(caseType)
+            && EventType.UPLOAD_DOCUMENT_CONSENTED.equals(eventType);
+    }
+
+    @Override
+    @SuppressWarnings("squid:CallToDeprecatedMethod")
+    public GenericAboutToStartOrSubmitCallbackResponse<FinremCaseData> handle(FinremCallbackRequest callbackRequest,
+                                                                              String userAuthorisation) {
+        FinremCaseDetails beforeFinremCaseDetails = callbackRequest.getCaseDetailsBefore();
+        FinremCaseDetails finremCaseDetails = callbackRequest.getCaseDetails();
+        FinremCaseData caseData = finremCaseDetails.getData();
+        FinremCaseData caseDataBefore = callbackRequest.getCaseDetailsBefore().getData();
+        final Long caseId = finremCaseDetails.getId();
+
+        List<UploadDocumentCollection> newDocuments = newUploadedDocumentsService.getNewUploadDocuments(caseData, caseDataBefore,
+            FinremCaseData::getUploadDocuments);
+
+        Set<String> allWarnings = new HashSet<>();
+        for (UploadDocumentCollection doc : newDocuments) {
+            if (doc.getValue() != null && doc.getValue().getDocumentLink() != null) {
+                try {
+                    List<String> warnings = documentCheckerService.getWarnings(doc.getValue().getDocumentLink(), beforeFinremCaseDetails,
+                        finremCaseDetails, userAuthorisation);
+                    if (!ObjectUtils.isEmpty(warnings)) {
+                        allWarnings.addAll(warnings);
+                    }
+                } catch (Exception t) {
+                    log.error(format("%s - Exception was caught when checking the warnings", caseId), t);
+                }
+            }
+        }
+
+        if (!allWarnings.isEmpty()) {
+            log.info(format("%s - Number of warnings encountered when uploading document: %s",
+                caseId, allWarnings.size()));
+        }
+
+        return GenericAboutToStartOrSubmitCallbackResponse.<FinremCaseData>builder()
+            .warnings((allWarnings.stream().sorted().toList()))
+            .data(caseData).build();
+    }
+
+}

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/handler/UploadDocumentContestedAboutToSubmitHandler.java

@@ -0,0 +1,103 @@
+package uk.gov.hmcts.reform.finrem.caseorchestration.handler;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.util.ObjectUtils;
+import uk.gov.hmcts.reform.finrem.caseorchestration.ccd.callback.CallbackType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.controllers.GenericAboutToStartOrSubmitCallbackResponse;
+import uk.gov.hmcts.reform.finrem.caseorchestration.mapper.FinremCaseDetailsMapper;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.EventType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.CaseType;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.FinremCaseData;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.FinremCaseDetails;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.UploadGeneralDocument;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.UploadGeneralDocumentCollection;
+import uk.gov.hmcts.reform.finrem.caseorchestration.service.NewUploadedDocumentsService;
+import uk.gov.hmcts.reform.finrem.caseorchestration.service.documentcatergory.UploadGeneralDocumentsCategoriser;
+import uk.gov.hmcts.reform.finrem.caseorchestration.service.documentchecker.DocumentCheckerService;
+
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import static java.lang.String.format;
+import static java.util.Comparator.comparing;
+import static java.util.Comparator.nullsLast;
+import static java.util.Optional.ofNullable;
+
+@Slf4j
+@Service
+public class UploadDocumentContestedAboutToSubmitHandler extends FinremCallbackHandler {
+
+    private final DocumentCheckerService documentCheckerService;
+    private final NewUploadedDocumentsService newUploadedDocumentsService;
+    private final UploadGeneralDocumentsCategoriser uploadGeneralDocumentsCategoriser;
+
+    public UploadDocumentContestedAboutToSubmitHandler(FinremCaseDetailsMapper mapper,
+                                                       DocumentCheckerService documentCheckerService,
+                                                       NewUploadedDocumentsService newUploadedDocumentsService,
+                                                       UploadGeneralDocumentsCategoriser uploadGeneralDocumentsCategoriser) {
+        super(mapper);
+        this.documentCheckerService = documentCheckerService;
+        this.newUploadedDocumentsService = newUploadedDocumentsService;
+        this.uploadGeneralDocumentsCategoriser = uploadGeneralDocumentsCategoriser;
+    }
+
+    @Override
+    public boolean canHandle(CallbackType callbackType, CaseType caseType, EventType eventType) {
+        return CallbackType.ABOUT_TO_SUBMIT.equals(callbackType)
+            && CaseType.CONTESTED.equals(caseType)
+            && EventType.UPLOAD_DOCUMENT_CONTESTED.equals(eventType);
+    }
+
+    @Override
+    @SuppressWarnings("squid:CallToDeprecatedMethod")
+    public GenericAboutToStartOrSubmitCallbackResponse<FinremCaseData> handle(FinremCallbackRequest callbackRequest,
+                                                                              String userAuthorisation) {
+        FinremCaseDetails beforeFinremCaseDetails = callbackRequest.getCaseDetailsBefore();
+        FinremCaseDetails finremCaseDetails = callbackRequest.getCaseDetails();
+        FinremCaseData caseData = finremCaseDetails.getData();
+        FinremCaseData caseDataBefore = callbackRequest.getCaseDetailsBefore().getData();
+        final Long caseId = finremCaseDetails.getId();
+
+        List<UploadGeneralDocumentCollection> newDocuments = newUploadedDocumentsService.getNewUploadDocuments(caseData, caseDataBefore,
+            FinremCaseData::getUploadGeneralDocuments);
+
+        Set<String> allWarnings = new HashSet<>();
+        for (UploadGeneralDocumentCollection doc : newDocuments) {
+            if (doc.getValue() != null && doc.getValue().getDocumentLink() != null) {
+                try {
+                    List<String> warnings = documentCheckerService.getWarnings(doc.getValue().getDocumentLink(), beforeFinremCaseDetails,
+                        finremCaseDetails, userAuthorisation);
+                    if (!ObjectUtils.isEmpty(warnings)) {
+                        allWarnings.addAll(warnings);
+                    }
+                } catch (Exception t) {
+                    log.error(format("%s - Exception was caught when checking the warnings", caseId), t);
+                }
+            }
+        }
+
+        if (!allWarnings.isEmpty()) {
+            log.info(format("%s - Number of warnings encountered when uploading general document: %s",
+                caseId, allWarnings.size()));
+        }
+
+        // Do sorting
+        List<UploadGeneralDocumentCollection> uploadedDocuments = new ArrayList<>(ofNullable(caseData.getUploadGeneralDocuments())
+            .orElse(List.of()));
+        uploadedDocuments.sort(comparing(UploadGeneralDocumentCollection::getValue,
+            comparing(UploadGeneralDocument::getGeneralDocumentUploadDateTime, nullsLast(Comparator.reverseOrder()))));
+        caseData.setUploadGeneralDocuments(uploadedDocuments);
+
+        // Execute the categoriser for CFV
+        uploadGeneralDocumentsCategoriser.categorise(caseData);
+
+        return GenericAboutToStartOrSubmitCallbackResponse.<FinremCaseData>builder()
+            .warnings(allWarnings.stream().sorted().toList())
+            .data(caseData).build();
+    }
+
+}

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/DocumentCheckContext.java

@@ -0,0 +1,15 @@
+package uk.gov.hmcts.reform.finrem.caseorchestration.model;
+
+import lombok.Builder;
+import lombok.Getter;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.CaseDocument;
+import uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd.FinremCaseDetails;
+
+@Builder
+@Getter
+public class DocumentCheckContext {
+    private CaseDocument caseDocument;
+    private byte[] bytes;
+    private FinremCaseDetails beforeCaseDetails;
+    private FinremCaseDetails caseDetails;
+}

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/EventType.java

@@ -15,7 +15,8 @@ public enum EventType {
     PREPARE_FOR_HEARING("FR_prepareForHearing"),
     UPLOAD_CASE_FILES("FR_uploadCaseFiles"),
     UPLOAD_CONFIDENTIAL_DOCUMENT("FR_uploadConfidentialDocument"),
-    UPLOAD_GENERAL_DOCUMENT("FR_uploadGeneralDocument"),
+    UPLOAD_DOCUMENT_CONSENTED("FR_uploadDocument"),
+    UPLOAD_DOCUMENT_CONTESTED("FR_uploadGeneralDocument"),
     INTERIM_HEARING("FR_listForInterimHearing"),
     SOLICITOR_CREATE("FR_solicitorCreate"),
     AMEND_APP_DETAILS("FR_amendApplicationDetails"),

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/AdditionalHearingDocument.java

@@ -18,7 +18,7 @@
 @Setter
 @NoArgsConstructor
 @AllArgsConstructor
-public class AdditionalHearingDocument {
+public class AdditionalHearingDocument implements HasCaseDocument {
     @JsonProperty("additionalHearingDocument")
     private CaseDocument document;
 

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/AdditionalHearingDocumentCollection.java

@@ -11,6 +11,6 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
-public class AdditionalHearingDocumentCollection {
+public class AdditionalHearingDocumentCollection implements HasCaseDocument {
     private AdditionalHearingDocument value;
 }

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/AmendedConsentOrder.java

@@ -15,7 +15,7 @@
 @AllArgsConstructor
 @NoArgsConstructor
 @SuppressWarnings("java:S1700")
-public class AmendedConsentOrder {
+public class AmendedConsentOrder implements HasCaseDocument {
     @JsonProperty("amendedConsentOrder")
     private CaseDocument amendedConsentOrder;
     @JsonProperty("amendedConsentOrderDate")

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/AmendedConsentOrderCollection.java

@@ -11,6 +11,6 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
-public class AmendedConsentOrderCollection {
+public class AmendedConsentOrderCollection implements HasCaseDocument {
     private AmendedConsentOrder value;
 }

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/ApproveOrder.java

@@ -16,7 +16,7 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
-public class ApproveOrder {
+public class ApproveOrder implements HasCaseDocument {
 
     @JsonProperty("approveOrder")
     CaseDocument caseDocument;

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/ApproveOrdersHolder.java

@@ -18,7 +18,7 @@
 @AllArgsConstructor
 @NoArgsConstructor
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class ApproveOrdersHolder {
+public class ApproveOrdersHolder implements HasCaseDocument {
     @JsonSerialize(using = LocalDateTimeSerializer.class)
     private LocalDateTime orderReceivedAt;
     private List<ApprovedOrderCollection> approveOrders;

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/ApprovedOrder.java

@@ -14,7 +14,7 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-public class ApprovedOrder {
+public class ApprovedOrder implements HasCaseDocument {
     @JsonProperty("orderLetter")
     private CaseDocument orderLetter;
     @JsonProperty("consentOrder")

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/ApprovedOrderCollection.java

@@ -12,7 +12,7 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
-public class ApprovedOrderCollection {
+public class ApprovedOrderCollection implements HasCaseDocument {
 
     @JsonProperty("id")
     private String id;

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/ApprovedOrderConsolidateCollection.java

@@ -11,7 +11,7 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
-public class ApprovedOrderConsolidateCollection {
+public class ApprovedOrderConsolidateCollection implements HasCaseDocument {
 
     private ApproveOrdersHolder value;
 

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/CaseDocument.java

@@ -20,7 +20,7 @@
 @AllArgsConstructor
 @EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class CaseDocument {
+public class CaseDocument implements DocumentFileNameProvider {
 
     @JsonProperty("document_url")
     private String documentUrl;
@@ -41,4 +41,8 @@ public CaseDocument(CaseDocument caseDocuments) {
         this.categoryId = caseDocuments.getCategoryId();
         this.uploadTimestamp = caseDocuments.getUploadTimestamp();
     }
+
+    public String getDocumentUrl() {
+        return this.documentUrl == null ? "" : this.documentUrl;
+    }
 }

src/main/java/uk/gov/hmcts/reform/finrem/caseorchestration/model/ccd/CaseDocumentCollection.java

@@ -0,0 +1,5 @@
+package uk.gov.hmcts.reform.finrem.caseorchestration.model.ccd;
+
+public interface CaseDocumentCollection<T extends HasDocumentLink> {
+    T getValue();
+}