Skip to content

Commit

Permalink
CIV-7965 Notify claimant of hearing HMC (#2906)
Browse files Browse the repository at this point in the history 
* modify handler for notify claimant hmc event
* Setup the hearing notice process handlers and events
* update commons version
* check payment details field
---------

Co-authored-by: GarethLancaster <[email protected]>
Co-authored-by: Gareth Lancaster <[email protected]>
Co-authored-by: Harry H <[email protected]>
  • Loading branch information
@sankaviv1 @Gareth40342
@Gareth40343 @HarryH96
4 people authored Jul 14, 2023
1 parent 393f51d commit 348cadc
Show file tree
Hide file tree
Showing 3 changed files with 210 additions and 11 deletions.
2 changes: 1 addition & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ configurations.all {
}

dependencies {
implementation 'com.github.hmcts:civil-commons:1.0.0'
implementation 'com.github.hmcts:civil-commons:1.0.4'

implementation group: 'org.springframework.boot', name: 'spring-boot-starter-web'
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-actuator'
Expand Down
82 changes: 72 additions & 10 deletions ...orm/civil/handler/callback/camunda/notification/NotificationClaimantOfHearingHandler.java
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
package uk.gov.hmcts.reform.civil.handler.callback.camunda.notification;

import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
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.CallbackException;
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.Fee;
import uk.gov.hmcts.reform.civil.notify.NotificationsProperties;
import uk.gov.hmcts.reform.civil.model.CaseData;
import uk.gov.hmcts.reform.civil.notify.NotificationService;
import uk.gov.hmcts.reform.civil.service.hearingnotice.HearingNoticeCamundaService;
import uk.gov.hmcts.reform.civil.service.hearings.HearingFeesService;

import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
Expand All @@ -22,17 +29,26 @@
import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
import static uk.gov.hmcts.reform.civil.callback.CaseEvent.NOTIFY_CLAIMANT_HEARING;
import static uk.gov.hmcts.reform.civil.callback.CaseEvent.NOTIFY_CLAIMANT_HEARING_HMC;
import static uk.gov.hmcts.reform.civil.utils.NotificationUtils.isEvent;
import static uk.gov.hmcts.reform.civil.enums.PaymentStatus.SUCCESS;
import static uk.gov.hmcts.reform.civil.utils.HearingFeeUtils.calculateAndApplyFee;
import static uk.gov.hmcts.reform.civil.utils.HearingFeeUtils.calculateHearingDueDate;

@Service
@RequiredArgsConstructor
@Slf4j
public class NotificationClaimantOfHearingHandler extends CallbackHandler implements NotificationData {

private final NotificationService notificationService;
private final HearingFeesService hearingFeesService;
private final NotificationsProperties notificationsProperties;
private final HearingNoticeCamundaService camundaService;
private static final List<CaseEvent> EVENTS = List.of(NOTIFY_CLAIMANT_HEARING, NOTIFY_CLAIMANT_HEARING_HMC);
private static final String REFERENCE_TEMPLATE_HEARING = "notification-of-hearing-%s";
public static final String TASK_ID_CLAIMANT = "NotifyClaimantHearing";
public static final String TASK_ID_CLAIMANT_HMC = "NotifyClaimantSolicitorHearing";
private static final String EVENT_NOT_FOUND_MESSAGE = "Callback handler received illegal event: %s";
private static final String DATE_FORMAT = "dd-MM-yyyy";
private static final String TIME_FORMAT = "hh:mma";

@Override
protected Map<String, Callback> callbacks() {
Expand All @@ -43,20 +59,26 @@ protected Map<String, Callback> callbacks() {

@Override
public String camundaActivityId(CallbackParams callbackParams) {
return TASK_ID_CLAIMANT;
CaseEvent caseEvent = CaseEvent.valueOf(callbackParams.getRequest().getEventId());
if (NOTIFY_CLAIMANT_HEARING.equals(caseEvent)) {
return TASK_ID_CLAIMANT;
} else if (NOTIFY_CLAIMANT_HEARING_HMC.equals(caseEvent)) {
return TASK_ID_CLAIMANT_HMC;
} else {
throw new CallbackException(String.format(EVENT_NOT_FOUND_MESSAGE, caseEvent));
}
}

private CallbackResponse notifyClaimantHearing(CallbackParams callbackParams) {
CaseData caseData = callbackParams.getCaseData();

//ToDo: Replace with AHN logic
if (isEvent(callbackParams, NOTIFY_CLAIMANT_HEARING_HMC)) {
return AboutToStartOrSubmitCallbackResponse.builder()
.build();
}

String recipient = caseData.getApplicantSolicitor1UserDetails().getEmail();
sendEmail(caseData, recipient);
CaseEvent caseEvent = CaseEvent.valueOf(callbackParams.getRequest().getEventId());
if (NOTIFY_CLAIMANT_HEARING.equals(caseEvent)) {
sendEmail(caseData, recipient);
}
if (NOTIFY_CLAIMANT_HEARING_HMC.equals(caseEvent)) {
sendEmailHMC(caseData, recipient);
}
return AboutToStartOrSubmitCallbackResponse.builder()
.build();
}
Expand All @@ -74,6 +96,21 @@ private void sendEmail(CaseData caseData, String recipient) {
);
}

private void sendEmailHMC(CaseData caseData, String recipient) {
String emailTemplate;
if (caseData.getHearingFeePaymentDetails() != null
&& SUCCESS.equals(caseData.getHearingFeePaymentDetails().getStatus())) {
emailTemplate = notificationsProperties.getHearingListedNoFeeClaimantLrTemplateHMC();
} else {
emailTemplate = notificationsProperties.getHearingListedFeeClaimantLrTemplateHMC();
}
String hearingId = camundaService
.getProcessVariables(caseData.getBusinessProcess().getProcessInstanceId()).getHearingId();
notificationService.sendMail(recipient, emailTemplate, addPropertiesHMC(caseData),
String.format(REFERENCE_TEMPLATE_HEARING, hearingId)
);
}

@Override
public List<CaseEvent> handledEvents() {
return EVENTS;
Expand Down Expand Up @@ -108,4 +145,29 @@ public Map<String, String> addProperties(final CaseData caseData) {

));
}

public Map<String, String> addPropertiesHMC(final CaseData caseData) {
Fee fee = calculateAndApplyFee(hearingFeesService, caseData, caseData.getAllocatedTrack());
LocalDateTime hearingStartDateTime = camundaService
.getProcessVariables(caseData.getBusinessProcess().getProcessInstanceId()).getHearingStartDateTime();

LocalDate hearingDate = hearingStartDateTime.toLocalDate();
LocalTime hearingTime = hearingStartDateTime.toLocalTime();

return Map.of(
CLAIM_REFERENCE_NUMBER,
caseData.getLegacyCaseReference(),
HEARING_FEE,
fee == null ? "£0.00" : String.valueOf(fee.formData()),
HEARING_DATE,
hearingDate.format(DateTimeFormatter.ofPattern(DATE_FORMAT)),
HEARING_TIME,
hearingTime.format(DateTimeFormatter.ofPattern(TIME_FORMAT)).replace("AM", "am").replace(
"PM",
"pm"
),
HEARING_DUE_DATE,
calculateHearingDueDate(LocalDate.now(), hearingDate).format(DateTimeFormatter.ofPattern(DATE_FORMAT))
);
}
}
137 changes: 137 additions & 0 deletions ...civil/handler/callback/camunda/notification/NotificationClaimantOfHearingHandlerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import uk.gov.hmcts.reform.ccd.client.model.CallbackRequest;
import uk.gov.hmcts.reform.civil.callback.CallbackParams;
import uk.gov.hmcts.reform.civil.model.BusinessProcess;
import uk.gov.hmcts.reform.civil.model.PaymentDetails;
import uk.gov.hmcts.reform.civil.model.SolicitorReferences;
import uk.gov.hmcts.reform.civil.notify.NotificationsProperties;
import uk.gov.hmcts.reform.civil.enums.YesOrNo;
Expand All @@ -20,16 +23,26 @@
import uk.gov.hmcts.reform.civil.sampledata.CallbackParamsBuilder;
import uk.gov.hmcts.reform.civil.sampledata.CaseDataBuilder;
import uk.gov.hmcts.reform.civil.notify.NotificationService;
import uk.gov.hmcts.reform.civil.service.hearingnotice.HearingNoticeCamundaService;
import uk.gov.hmcts.reform.civil.service.hearingnotice.HearingNoticeVariables;
import uk.gov.hmcts.reform.civil.service.hearings.HearingFeesService;

import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.CALLS_REAL_METHODS;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
import static uk.gov.hmcts.reform.civil.enums.PaymentStatus.SUCCESS;
import static uk.gov.hmcts.reform.civil.handler.callback.camunda.notification.NotificationClaimantOfHearingHandler.TASK_ID_CLAIMANT;
import static uk.gov.hmcts.reform.civil.handler.callback.camunda.notification.NotificationClaimantOfHearingHandler.TASK_ID_CLAIMANT_HMC;
import static uk.gov.hmcts.reform.civil.handler.callback.camunda.notification.NotificationData.CLAIM_REFERENCE_NUMBER;

@SpringBootTest(classes = {
Expand All @@ -41,7 +54,11 @@ public class NotificationClaimantOfHearingHandlerTest {
@MockBean
private NotificationService notificationService;
@MockBean
private HearingFeesService hearingFeesService;
@MockBean
NotificationsProperties notificationsProperties;
@MockBean
HearingNoticeCamundaService hearingNoticeCamundaService;
@Autowired
private NotificationClaimantOfHearingHandler handler;

Expand All @@ -54,6 +71,10 @@ void setup() {
.thenReturn("test-template-fee-claimant-id");
when(notificationsProperties.getHearingListedNoFeeClaimantLrTemplate())
.thenReturn("test-template-no-fee-claimant-id");
when(notificationsProperties.getHearingListedFeeClaimantLrTemplateHMC())
.thenReturn("test-template-fee-claimant-id-hmc");
when(notificationsProperties.getHearingListedNoFeeClaimantLrTemplateHMC())
.thenReturn("test-template-no-fee-claimant-id-hmc");
}

@Test
Expand Down Expand Up @@ -83,6 +104,44 @@ void shouldNotifyApplicantSolicitor_whenInvokedWithFeeAnd1v1() {
);
}

@Test
void shouldNotifyApplicantSolicitor_whenInvokedWithFeeAnd1v1HMC() {
// Given
CaseData caseData = CaseDataBuilder.builder().atStateClaimDetailsNotified().build().toBuilder()
.applicantSolicitor1UserDetails(IdamUserDetails.builder().email("[email protected]").build())
.respondentSolicitor1EmailAddress("[email protected]")
.addApplicant2(YesOrNo.NO)
.addRespondent2(YesOrNo.NO)
.businessProcess(BusinessProcess.builder().processInstanceId("").build())
.build();

when(hearingFeesService.getFeeForHearingFastTrackClaims(any()))
.thenReturn(Fee.builder().calculatedAmountInPence(BigDecimal.valueOf(30000)).build());
when(hearingNoticeCamundaService.getProcessVariables(any()))
.thenReturn(HearingNoticeVariables.builder()
.hearingId("HER1234")
.hearingStartDateTime(LocalDateTime.of(
LocalDate.of(2022, 10, 7),
LocalTime.of(15, 30)))
.build());

LocalDate now = LocalDate.of(2022, 9, 29);
try (MockedStatic<LocalDate> mock = mockStatic(LocalDate.class, CALLS_REAL_METHODS)) {
mock.when(LocalDate::now).thenReturn(now);
CallbackParams params = CallbackParamsBuilder.builder().of(ABOUT_TO_SUBMIT, caseData)
.request(CallbackRequest.builder().eventId("NOTIFY_CLAIMANT_HEARING_HMC").build()).build();
// When
handler.handle(params);
// Then
verify(notificationService).sendMail(
"[email protected]",
"test-template-fee-claimant-id-hmc",
getNotificationFeeDataMapHMC(caseData),
"notification-of-hearing-HER1234"
);
}
}

@Test
void shouldNotifyApplicantSolicitor_whenInvokedWithFeeAnd1v1WithNoFee() {
// Given
Expand Down Expand Up @@ -111,6 +170,47 @@ void shouldNotifyApplicantSolicitor_whenInvokedWithFeeAnd1v1WithNoFee() {
);
}

@Test
void shouldNotifyApplicantSolicitor_whenInvoked1v1WithNoFeeHMC() {
// Given
CaseData caseData = CaseDataBuilder.builder().atStateClaimDetailsNotified().build().toBuilder()
.applicantSolicitor1UserDetails(IdamUserDetails.builder().email("[email protected]").build())
.respondentSolicitor1EmailAddress("[email protected]")
.addApplicant2(YesOrNo.NO)
.addRespondent2(YesOrNo.NO)
.hearingFeePaymentDetails(PaymentDetails.builder()
.status(SUCCESS)
.build())
.businessProcess(BusinessProcess.builder().processInstanceId("").build())
.build();

when(hearingFeesService.getFeeForHearingFastTrackClaims(any()))
.thenReturn(Fee.builder().calculatedAmountInPence(BigDecimal.valueOf(0)).build());
when(hearingNoticeCamundaService.getProcessVariables(any()))
.thenReturn(HearingNoticeVariables.builder()
.hearingId("HER1234")
.hearingStartDateTime(LocalDateTime.of(
LocalDate.of(2022, 10, 7),
LocalTime.of(15, 30)))
.build());

LocalDate now = LocalDate.of(2022, 9, 29);
try (MockedStatic<LocalDate> mock = mockStatic(LocalDate.class, CALLS_REAL_METHODS)) {
mock.when(LocalDate::now).thenReturn(now);
CallbackParams params = CallbackParamsBuilder.builder().of(ABOUT_TO_SUBMIT, caseData)
.request(CallbackRequest.builder().eventId("NOTIFY_CLAIMANT_HEARING_HMC").build()).build();
// When
handler.handle(params);
// Then
verify(notificationService).sendMail(
"[email protected]",
"test-template-no-fee-claimant-id-hmc",
getNotificationNoFeeDatePMDataMapHMC(caseData),
"notification-of-hearing-HER1234"
);
}
}

@Test
void shouldNotifyApplicantSolicitor_whenInvokedWithFeeAnd1v1WithNoSolicitorReferences() {
// Given
Expand Down Expand Up @@ -283,6 +383,14 @@ private Map<String, String> getNotificationFeeDataMap(CaseData caseData) {
);
}

@NotNull
private Map<String, String> getNotificationFeeDataMapHMC(CaseData caseData) {
return Map.of(
CLAIM_REFERENCE_NUMBER, caseData.getLegacyCaseReference(), "hearingFee", "£300.00",
"hearingDate", "07-10-2022", "hearingTime", "03:30pm", "hearingDueDate", "06-10-2022"
);
}

@NotNull
private Map<String, String> getNotificationNoFeeDataMap(CaseData caseData) {
return Map.of(
Expand All @@ -292,6 +400,14 @@ private Map<String, String> getNotificationNoFeeDataMap(CaseData caseData) {
);
}

@NotNull
private Map<String, String> getNotificationNoFeeDataMapHMC(CaseData caseData) {
return Map.of(
CLAIM_REFERENCE_NUMBER, caseData.getLegacyCaseReference(), "hearingFee", "£0.00",
"hearingDate", "07-10-2022", "hearingTime", "08:30am", "hearingDueDate", "06-10-2022"
);
}

@NotNull
private Map<String, String> getNotificationNoFeeDatePMDataMap(CaseData caseData) {
return Map.of(
Expand All @@ -301,10 +417,31 @@ private Map<String, String> getNotificationNoFeeDatePMDataMap(CaseData caseData)
);
}

@NotNull
private Map<String, String> getNotificationNoFeeDatePMDataMapHMC(CaseData caseData) {
return Map.of(
CLAIM_REFERENCE_NUMBER, caseData.getLegacyCaseReference(), "hearingFee", "£0.00",
"hearingDate", "07-10-2022", "hearingTime", "03:30pm", "hearingDueDate", "06-10-2022"
);
}

@Test
void shouldReturnCorrectCamundaActivityId_whenInvoked() {
CaseData caseData = CaseDataBuilder.builder().atStateClaimDetailsNotified().build();
CallbackParams params = CallbackParamsBuilder.builder().of(ABOUT_TO_SUBMIT, caseData)
.request(CallbackRequest.builder().eventId("NOTIFY_CLAIMANT_HEARING").build()).build();
assertThat(handler.camundaActivityId(CallbackParamsBuilder.builder().request(CallbackRequest
.builder().eventId(
"NOTIFY_CLAIMANT_HEARING").build()).build())).isEqualTo(TASK_ID_CLAIMANT);
}

@Test
void shouldReturnCorrectCamundaActivityId_whenInvokedHMC() {
CaseData caseData = CaseDataBuilder.builder().atStateClaimDetailsNotified().build();
CallbackParams params = CallbackParamsBuilder.builder().of(ABOUT_TO_SUBMIT, caseData)
.request(CallbackRequest.builder().eventId("NOTIFY_CLAIMANT_HEARING").build()).build();
assertThat(handler.camundaActivityId(CallbackParamsBuilder.builder().request(CallbackRequest
.builder().eventId(
"NOTIFY_CLAIMANT_HEARING_HMC").build()).build())).isEqualTo(TASK_ID_CLAIMANT_HMC);
}
}

0 comments on commit 348cadc

Please sign in to comment.