CIV-12772 Application Fee - Claimant Notification

src/main/java/uk/gov/hmcts/reform/civil/callback/CaseEvent.java

@@ -41,6 +41,7 @@ public enum CaseEvent {
     END_JUDGE_BUSINESS_PROCESS_GASPEC(CAMUNDA),
     END_HEARING_SCHEDULED_PROCESS_GASPEC(CAMUNDA),
     GA_EVIDENCE_UPLOAD_CHECK(CAMUNDA),
+    END_GA_HWF_NOTIFY_PROCESS(CAMUNDA),
 
     ASSIGN_GA_ROLES(CAMUNDA),
 
@@ -87,7 +88,8 @@ public enum CaseEvent {
     UPDATE_HELP_WITH_FEE_NUMBER_GA(USER),
     FEE_PAYMENT_OUTCOME_GA(USER),
     UPDATE_TASK_LIST_GA_CREATED(CAMUNDA),
-    UPDATE_TASK_LIST_GA_COMPLETE(CAMUNDA);
+    UPDATE_TASK_LIST_GA_COMPLETE(CAMUNDA),
+    NOTIFY_APPLICANT_LIP_HWF(CAMUNDA);
 
     private final UserType userType;
 

src/main/java/uk/gov/hmcts/reform/civil/config/properties/notification/NotificationsProperties.java

@@ -79,4 +79,7 @@ public class NotificationsProperties {
 
     @NotEmpty
     private String evidenceUploadTemplate;
+
+    @NotEmpty
+    private String notifyApplicantForHwFMoreInformationNeeded;
 }

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/camunda/businessprocess/EndHwfNotifyProcessCallbackHandler.java

@@ -0,0 +1,51 @@
+package uk.gov.hmcts.reform.civil.handler.callback.camunda.businessprocess;
+
+import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
+import static uk.gov.hmcts.reform.civil.callback.CaseEvent.END_GA_HWF_NOTIFY_PROCESS;
+
+import uk.gov.hmcts.reform.ccd.client.model.AboutToStartOrSubmitCallbackResponse;
+import uk.gov.hmcts.reform.ccd.client.model.CallbackResponse;
+import uk.gov.hmcts.reform.civil.callback.Callback;
+import uk.gov.hmcts.reform.civil.callback.CallbackHandler;
+import uk.gov.hmcts.reform.civil.callback.CallbackParams;
+import uk.gov.hmcts.reform.civil.callback.CaseEvent;
+import uk.gov.hmcts.reform.civil.helpers.CaseDetailsConverter;
+import uk.gov.hmcts.reform.civil.model.CaseData;
+
+import java.util.List;
+import java.util.Map;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class EndHwfNotifyProcessCallbackHandler extends CallbackHandler {
+
+    private static final List<CaseEvent> EVENTS = List.of(END_GA_HWF_NOTIFY_PROCESS);
+
+    private final CaseDetailsConverter caseDetailsConverter;
+
+    @Override
+    protected Map<String, Callback> callbacks() {
+        return Map.of(callbackKey(ABOUT_TO_SUBMIT), this::endHwfNotifyBusinessProcess);
+    }
+
+    @Override
+    public List<CaseEvent> handledEvents() {
+        return EVENTS;
+    }
+
+    private CallbackResponse endHwfNotifyBusinessProcess(CallbackParams callbackParams) {
+        CaseData data = caseDetailsConverter.toCaseData(callbackParams.getRequest().getCaseDetails());
+        return evaluateReady(callbackParams);
+    }
+
+    private CallbackResponse evaluateReady(CallbackParams callbackParams) {
+        Map<String, Object> output = callbackParams.getRequest().getCaseDetails().getData();
+
+        return AboutToStartOrSubmitCallbackResponse.builder()
+            .data(output)
+            .build();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/camunda/notification/HwfApplicantNotificationHandler.java

@@ -0,0 +1,51 @@
+package uk.gov.hmcts.reform.civil.handler.callback.camunda.notification;
+
+import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
+import static uk.gov.hmcts.reform.civil.callback.CaseEvent.NOTIFY_APPLICANT_LIP_HWF;
+
+import uk.gov.hmcts.reform.ccd.client.model.AboutToStartOrSubmitCallbackResponse;
+import uk.gov.hmcts.reform.ccd.client.model.CallbackResponse;
+import uk.gov.hmcts.reform.civil.callback.Callback;
+import uk.gov.hmcts.reform.civil.callback.CallbackHandler;
+import uk.gov.hmcts.reform.civil.callback.CallbackParams;
+import uk.gov.hmcts.reform.civil.callback.CaseEvent;
+import uk.gov.hmcts.reform.civil.model.CaseData;
+import uk.gov.hmcts.reform.civil.service.HwfNotificationService;
+
+import java.util.List;
+import java.util.Map;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class HwfApplicantNotificationHandler extends CallbackHandler {
+
+    private final ObjectMapper objectMapper;
+    private final HwfNotificationService notificationService;
+    private static final List<CaseEvent> EVENTS = List.of(
+            NOTIFY_APPLICANT_LIP_HWF
+    );
+
+    @Override
+    protected Map<String, Callback> callbacks() {
+        return Map.of(
+            callbackKey(ABOUT_TO_SUBMIT), this::hwfApplicantNotification
+        );
+    }
+
+    @Override
+    public List<CaseEvent> handledEvents() {
+        return EVENTS;
+    }
+
+    private CallbackResponse hwfApplicantNotification(CallbackParams callbackParams) {
+        CaseData caseData = callbackParams.getCaseData();
+        notificationService.sendNotification(caseData);
+        return AboutToStartOrSubmitCallbackResponse.builder()
+            .data(caseData.toMap(objectMapper))
+            .build();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/camunda/notification/NotificationData.java

@@ -18,6 +18,13 @@ public interface NotificationData {
     String GA_LIP_RESP_NAME = "respondentName";
     String CASE_TITLE = "ClaimantvDefendant";
 
+    //hwf
+    String CLAIMANT_NAME = "claimantName";
+    String HWF_REFERENCE_NUMBER = "hwFReferenceNumber";
+    String TYPE_OF_FEE = "typeOfFee";
+    String HWF_MORE_INFO_DATE = "date";
+    String HWF_MORE_INFO_DOCUMENTS = "documents";
+
     Map<String, String> addProperties(CaseData caseData);
 
 }

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/user/MoreInformationHwfCallbackHandler.java

@@ -5,12 +5,14 @@
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.MID;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.SUBMITTED;
 import static uk.gov.hmcts.reform.civil.callback.CaseEvent.MORE_INFORMATION_HWF_GA;
+import static uk.gov.hmcts.reform.civil.callback.CaseEvent.NOTIFY_APPLICANT_LIP_HWF;
 
 import uk.gov.hmcts.reform.ccd.client.model.AboutToStartOrSubmitCallbackResponse;
 import uk.gov.hmcts.reform.ccd.client.model.CallbackResponse;
 import uk.gov.hmcts.reform.civil.callback.Callback;
 import uk.gov.hmcts.reform.civil.callback.CallbackParams;
 import uk.gov.hmcts.reform.civil.enums.FeeType;
+import uk.gov.hmcts.reform.civil.model.BusinessProcess;
 import uk.gov.hmcts.reform.civil.model.CaseData;
 import uk.gov.hmcts.reform.civil.model.genapplication.HelpWithFeesDetails;
 import uk.gov.hmcts.reform.civil.model.genapplication.HelpWithFeesMoreInformation;
@@ -68,7 +70,8 @@ private CallbackResponse validationMoreInformation(CallbackParams callbackParams
 
     private CallbackResponse submitMoreInformationHwf(CallbackParams callbackParams) {
         CaseData caseData = callbackParams.getCaseData();
-        CaseData.CaseDataBuilder updatedData = caseData.toBuilder();
+        CaseData.CaseDataBuilder updatedData = caseData.toBuilder()
+                .businessProcess(BusinessProcess.ready(NOTIFY_APPLICANT_LIP_HWF));
 
         if (caseData.getHwfFeeType().equals(FeeType.ADDITIONAL)) {
             HelpWithFeesDetails additionalFeeDetails =

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/user/UpdatedRefNumberHWFCallbackHandler.java

@@ -67,7 +67,8 @@ private CaseData updateHwFReference(CaseData caseData) {
             ofNullable(caseData.getGeneralAppHelpWithFees())
                 .ifPresent(hwf -> updatedData.generalAppHelpWithFees(hwf.toBuilder().helpWithFeesReferenceNumber(newRefNumber).build()));
             if (caseData.getGaHwfDetails() != null) {
-                updatedData.gaHwfDetails(caseData.getGaHwfDetails().toBuilder().hwfReferenceNumber(null).build());
+                updatedData.gaHwfDetails(caseData.getGaHwfDetails().toBuilder()
+                        .hwfCaseEvent(UPDATE_HELP_WITH_FEE_NUMBER_GA).hwfReferenceNumber(null).build());
             }
             return updatedData.build();
         }
@@ -76,7 +77,8 @@ private CaseData updateHwFReference(CaseData caseData) {
             ofNullable(caseData.getGeneralAppHelpWithFees())
                 .ifPresent(hwf -> updatedData.generalAppHelpWithFees(hwf.toBuilder().helpWithFeesReferenceNumber(newRefNumber).build()));
             if (caseData.getAdditionalHwfDetails() != null) {
-                updatedData.additionalHwfDetails(caseData.getAdditionalHwfDetails().toBuilder().hwfReferenceNumber(null).build());
+                updatedData.additionalHwfDetails(caseData.getAdditionalHwfDetails().toBuilder()
+                        .hwfCaseEvent(UPDATE_HELP_WITH_FEE_NUMBER_GA).hwfReferenceNumber(null).build());
             }
             return updatedData.build();
         }

src/main/java/uk/gov/hmcts/reform/civil/handler/tasks/EndGaHwfNotifyProcessTaskHandler.java

@@ -0,0 +1,53 @@
+package uk.gov.hmcts.reform.civil.handler.tasks;
+
+import static uk.gov.hmcts.reform.civil.callback.CaseEvent.END_GA_HWF_NOTIFY_PROCESS;
+
+import uk.gov.hmcts.reform.ccd.client.model.CaseDataContent;
+import uk.gov.hmcts.reform.ccd.client.model.Event;
+import uk.gov.hmcts.reform.ccd.client.model.StartEventResponse;
+import uk.gov.hmcts.reform.civil.helpers.CaseDetailsConverter;
+import uk.gov.hmcts.reform.civil.model.BusinessProcess;
+import uk.gov.hmcts.reform.civil.model.CaseData;
+import uk.gov.hmcts.reform.civil.service.CoreCaseDataService;
+import uk.gov.hmcts.reform.civil.service.data.ExternalTaskInput;
+
+import java.util.Map;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.camunda.bpm.client.task.ExternalTask;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class EndGaHwfNotifyProcessTaskHandler implements BaseExternalTaskHandler {
+
+    private final CoreCaseDataService coreCaseDataService;
+    private final CaseDetailsConverter caseDetailsConverter;
+    private final ObjectMapper mapper;
+
+    @Override
+    public void handleTask(ExternalTask externalTask) {
+        ExternalTaskInput externalTaskInput = mapper.convertValue(externalTask.getAllVariables(),
+                                                                  ExternalTaskInput.class);
+        String caseId = externalTaskInput.getCaseId();
+        StartEventResponse startEventResponse = coreCaseDataService
+            .startGaUpdate(caseId, END_GA_HWF_NOTIFY_PROCESS);
+        CaseData data = caseDetailsConverter.toCaseData(startEventResponse.getCaseDetails());
+        BusinessProcess businessProcess = data.getBusinessProcess();
+        coreCaseDataService.submitGaUpdate(caseId, caseDataContent(startEventResponse, businessProcess));
+    }
+
+    private CaseDataContent caseDataContent(StartEventResponse startEventResponse, BusinessProcess businessProcess) {
+        Map<String, Object> data = startEventResponse.getCaseDetails().getData();
+        data.put("businessProcess", businessProcess.reset());
+
+        return CaseDataContent.builder()
+            .eventToken(startEventResponse.getToken())
+            .event(Event.builder().id(startEventResponse.getEventId()).build())
+            .data(data)
+            .build();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/service/HwfNotificationService.java

@@ -0,0 +1,127 @@
+package uk.gov.hmcts.reform.civil.service;
+
+import static uk.gov.hmcts.reform.civil.helpers.DateFormatHelper.DATE;
+import static uk.gov.hmcts.reform.civil.helpers.DateFormatHelper.formatLocalDate;
+
+import uk.gov.hmcts.reform.civil.callback.CaseEvent;
+import uk.gov.hmcts.reform.civil.config.properties.notification.NotificationsProperties;
+import uk.gov.hmcts.reform.civil.enums.FeeType;
+import uk.gov.hmcts.reform.civil.enums.HwFMoreInfoRequiredDocuments;
+import uk.gov.hmcts.reform.civil.handler.callback.camunda.notification.NotificationData;
+import uk.gov.hmcts.reform.civil.helpers.CaseDetailsConverter;
+import uk.gov.hmcts.reform.civil.model.CaseData;
+import uk.gov.hmcts.reform.civil.model.genapplication.HelpWithFeesMoreInformation;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class HwfNotificationService implements NotificationData {
+
+    private final NotificationService notificationService;
+    private final NotificationsProperties notificationsProperties;
+    private final CaseDetailsConverter caseDetailsConverter;
+    private final CoreCaseDataService coreCaseDataService;
+    private final SolicitorEmailValidation solicitorEmailValidation;
+    private Map<CaseEvent, String> emailTemplates;
+
+    private static final String ERROR_HWF_EVENT = "Hwf Event not support";
+
+    public void sendNotification(CaseData caseData) throws NotificationException {
+        CaseData civilCaseData = caseDetailsConverter
+                .toCaseData(coreCaseDataService
+                        .getCase(Long.parseLong(caseData.getGeneralAppParentCaseLink().getCaseReference())));
+
+        caseData = solicitorEmailValidation.validateSolicitorEmail(civilCaseData, caseData);
+        CaseEvent event = getEvent(caseData);
+
+        notificationService.sendMail(
+                caseData.getGeneralAppApplnSolicitor().getEmail(),
+                getTemplate(event),
+                addProperties(caseData),
+                caseData.getGeneralAppParentCaseLink().getCaseReference()
+        );
+    }
+
+    @Override
+    public Map<String, String> addProperties(CaseData caseData) {
+        Map<String, String> commonProperties = getCommonProperties(caseData);
+        Map<String, String> furtherProperties = getFurtherProperties(caseData);
+        return Collections.unmodifiableMap(
+                Stream.concat(commonProperties.entrySet().stream(), furtherProperties.entrySet().stream())
+                        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));
+    }
+
+    private Map<String, String> getCommonProperties(CaseData caseData) {
+        return Map.of(
+                CASE_REFERENCE, caseData.getCcdCaseReference().toString(),
+                CLAIMANT_NAME, caseData.getApplicantPartyName(),
+                TYPE_OF_FEE, caseData.getHwfFeeType().getLabel(),
+                HWF_REFERENCE_NUMBER, caseData.getGeneralAppHelpWithFees().getHelpWithFeesReferenceNumber()
+        );
+    }
+
+    private Map<String, String> getFurtherProperties(CaseData caseData) {
+        return switch (getEvent(caseData)) {
+            //case NO_REMISSION_HWF -> getNoRemissionProperties(caseData);
+            case MORE_INFORMATION_HWF_GA -> getMoreInformationProperties(caseData);
+            //case PARTIAL_REMISSION_HWF_GRANTED -> getPartialRemissionProperties(caseData);
+            //case INVALID_HWF_REFERENCE, UPDATE_HELP_WITH_FEE_NUMBER -> Collections.emptyMap();
+            default -> throw new NotificationException(new Exception(ERROR_HWF_EVENT));
+        };
+    }
+
+    private CaseEvent getEvent(CaseData caseData) {
+        if (caseData.getHwfFeeType().equals(FeeType.APPLICATION)) {
+            return caseData.getGaHwfDetails().getHwfCaseEvent();
+        } else if (caseData.getHwfFeeType().equals(FeeType.ADDITIONAL)) {
+            return caseData.getAdditionalHwfDetails().getHwfCaseEvent();
+        } else {
+            throw new NotificationException(new Exception(ERROR_HWF_EVENT));
+        }
+    }
+
+    private String getTemplate(CaseEvent hwfEvent) {
+        if (emailTemplates == null) {
+            emailTemplates = Map.of(
+                CaseEvent.MORE_INFORMATION_HWF_GA,
+                notificationsProperties.getNotifyApplicantForHwFMoreInformationNeeded()
+            );
+        }
+        return emailTemplates.get(hwfEvent);
+    }
+
+    private Map<String, String> getMoreInformationProperties(CaseData caseData) {
+        HelpWithFeesMoreInformation moreInformation =
+                null != caseData.getHelpWithFeesMoreInformationGa()
+                        ? caseData.getHelpWithFeesMoreInformationGa()
+                        : caseData.getHelpWithFeesMoreInformationAdditional();
+        return Map.of(
+                HWF_MORE_INFO_DATE, formatLocalDate(moreInformation.getHwFMoreInfoDocumentDate(), DATE),
+                HWF_MORE_INFO_DOCUMENTS, getMoreInformationDocumentList(
+                        moreInformation.getHwFMoreInfoRequiredDocuments()
+                )
+        );
+    }
+
+    private String getMoreInformationDocumentList(List<HwFMoreInfoRequiredDocuments> list) {
+        StringBuilder documentList = new StringBuilder();
+        for (HwFMoreInfoRequiredDocuments doc : list) {
+            documentList.append(doc.getName());
+            if (!doc.getDescription().isEmpty()) {
+                documentList.append(" - ");
+                documentList.append(doc.getDescription());
+            }
+            documentList.append("\n");
+            documentList.append("\n");
+        }
+        return documentList.toString();
+    }
+}

src/main/java/uk/gov/hmcts/reform/civil/service/tasklisteners/EndGaBusinessProcessExternalTaskListener.java

@@ -0,0 +1,22 @@
+package uk.gov.hmcts.reform.civil.service.tasklisteners;
+
+import uk.gov.hmcts.reform.civil.handler.tasks.EndJudgeMakesDecisionBusinessProcessTaskHandler;
+
+import org.camunda.bpm.client.ExternalTaskClient;
+import org.camunda.bpm.client.topic.TopicSubscriptionBuilder;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class EndGaBusinessProcessExternalTaskListener {
+
+    private static final String TOPIC = "END_GA_BUSINESS_PROCESS";
+
+    @Autowired
+    private EndGaBusinessProcessExternalTaskListener(
+        EndJudgeMakesDecisionBusinessProcessTaskHandler handler,
+        ExternalTaskClient client) {
+        TopicSubscriptionBuilder subscriptionBuilder = client.subscribe(TOPIC);
+        subscriptionBuilder.handler(handler).open();
+    }
+}