PAY-5978 Duplicate Payment Report

api/build.gradle

@@ -268,7 +268,7 @@ serenity {
     reports = ["single-page-html"]
 }
 
-def getCheckedOutGitCommitHash() {
+static def getCheckedOutGitCommitHash() {
     'git rev-parse --verify --short HEAD'.execute().text.trim()
 }
 

api/src/main/java/uk/gov/hmcts/payment/api/configuration/PaymentReportConfiguration.java

@@ -4,27 +4,16 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import uk.gov.hmcts.payment.api.reports.PaymentReportType;
-import uk.gov.hmcts.payment.api.reports.config.BarPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.CardPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaCmcPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaCivilPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaDivorcePaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaFinremPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaProbatePaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaFplPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaPrlPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaIacPaymentReportConfig;
-import uk.gov.hmcts.payment.api.reports.config.PbaSmcPaymentReportConfig;
-
+import uk.gov.hmcts.payment.api.reports.config.*;
 
 import java.util.Map;
 
 @Configuration
 public class PaymentReportConfiguration {
 
     @Bean
-    public Map<PaymentReportType, PaymentReportConfig> configMap(CardPaymentReportConfig cardPaymentReportConfig,
+    public Map<PaymentReportType, PaymentReportConfig> configMap(DuplicatePaymentReportConfig duplicatePaymentReportConfig,
+                                                                 CardPaymentReportConfig cardPaymentReportConfig,
                                                                  BarPaymentReportConfig barPaymentReportConfig,
                                                                  PbaCmcPaymentReportConfig pbaCmcPaymentReportConfig,
                                                                  PbaProbatePaymentReportConfig pbaProbatePaymentReportConfig,
@@ -36,6 +25,7 @@ public Map<PaymentReportType, PaymentReportConfig> configMap(CardPaymentReportCo
                                                                  PbaIacPaymentReportConfig pbaIacPaymentReportConfig,
                                                                  PbaSmcPaymentReportConfig pbaSmcPaymentReportConfig) {
         return ImmutableMap.<PaymentReportType, PaymentReportConfig>builder()
+            .put(PaymentReportType.DUPLICATE_PAYMENT, duplicatePaymentReportConfig)
             .put(PaymentReportType.CARD, cardPaymentReportConfig)
             .put(PaymentReportType.DIGITAL_BAR, barPaymentReportConfig)
             .put(PaymentReportType.PBA_CMC, pbaCmcPaymentReportConfig)

api/src/main/java/uk/gov/hmcts/payment/api/controllers/PaymentReportController.java

@@ -59,4 +59,23 @@ public void generateAndEmailReport(@RequestParam(name = "payment_method", requir
 
         paymentsReportFacade.generateCsvAndSendEmail(fromDate, toDate, paymentMethodTypeName, service);
     }
+
+    @Operation(summary = "API to generate report for payment failure ", description = "Get list of payments failures by providing date range. MM/dd/yyyy is  the supported date/time format.")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "Report Generated, email only sent if data exists"),
+        @ApiResponse(responseCode = "500", description = "Internal Server Error")
+    })
+    @PostMapping(value = "/jobs/duplicate-payment-process")
+    public void duplicatePaymentEmailReport(@RequestParam(name = "start_date", required = false) Optional<String> startDateString,
+                                            @RequestParam(name = "end_date", required = false) Optional<String> endDateString) {
+
+        LOG.info("Inside /jobs/duplicate-payment-process");
+        validator.validateToFromDates(startDateString, endDateString);
+
+        Date fromDate = startDateString.map(s -> clock.atStartOfDay(s, FORMATTER)).orElseGet(clock::getYesterdayDate);
+        Date toDate = endDateString.map(s -> clock.atEndOfDay(s, FORMATTER)).orElseGet(clock::getTodayDate);
+
+        paymentsReportFacade.generateDuplicatePaymentCsvAndSendEmail(fromDate, toDate);
+    }
+
 }

api/src/main/java/uk/gov/hmcts/payment/api/reports/PaymentReportType.java

@@ -6,6 +6,7 @@
 
 public enum PaymentReportType {
 
+    DUPLICATE_PAYMENT,
     CARD,
     DIGITAL_BAR,
     PBA_CMC,

api/src/main/java/uk/gov/hmcts/payment/api/reports/PaymentsReportFacade.java

@@ -31,9 +31,30 @@ public void generateCsvAndSendEmail(Date startDate, Date endDate, PaymentMethodT
         PaymentReportConfig reportConfig = configMap.get(PaymentReportType.from(paymentMethodType, serviceType));
         if (reportConfig.isEnabled()) {
             LOG.info("payments report flag is enabled for type :{} and service :{}. creating csv", paymentMethodType, serviceType);
-            reportService.generateCsvAndSendEmail(startDate, endDate, paymentMethodType, serviceType, reportConfig);
+            reportService.generateCsvAndSendEmail(
+                startDate,
+                endDate,
+                paymentMethodType,
+                serviceType,
+                reportConfig);
         } else {
             LOG.info("payments report flag is disabled for type :{} and service :{}. So, system will not send CSV email", paymentMethodType, serviceType);
         }
     }
+
+    public void generateDuplicatePaymentCsvAndSendEmail(Date startDate, Date endDate) {
+        LOG.info("Inside generateDuplicatePaymentCsvAndSendEmail with startDate: {} and endDate: {}",
+            startDate, endDate);
+        PaymentReportConfig reportConfig = configMap.get(PaymentReportType.DUPLICATE_PAYMENT);
+        if (reportConfig.isEnabled()) {
+            LOG.info("duplicate payments report flag is enabled. creating csv");
+            reportService.generateDuplicatePaymentsCsvAndSendEmail(
+                startDate,
+                endDate,
+                reportConfig);
+        } else {
+            LOG.info("duplicate payments report flag is disabled. So, system will not send CSV email");
+        }
+    }
+
 }

api/src/main/java/uk/gov/hmcts/payment/api/reports/PaymentsReportService.java

@@ -4,18 +4,23 @@
 import org.slf4j.Logger;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
+import uk.gov.hmcts.payment.api.dto.DuplicatePaymentDto;
 import uk.gov.hmcts.payment.api.contract.PaymentDto;
 import uk.gov.hmcts.payment.api.dto.PaymentSearchCriteria;
 import uk.gov.hmcts.payment.api.dto.mapper.PaymentDtoMapper;
 import uk.gov.hmcts.payment.api.email.Email;
 import uk.gov.hmcts.payment.api.email.EmailService;
+import uk.gov.hmcts.payment.api.model.Payment2Repository;
 import uk.gov.hmcts.payment.api.model.PaymentFeeLink;
 import uk.gov.hmcts.payment.api.reports.config.PaymentReportConfig;
 import uk.gov.hmcts.payment.api.service.DelegatingPaymentService;
 import uk.gov.hmcts.payment.api.util.PaymentMethodType;
 
+import javax.persistence.Tuple;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.math.BigDecimal;
+import java.math.BigInteger;
 import java.nio.charset.Charset;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
@@ -42,15 +47,20 @@ public class PaymentsReportService {
 
     private static final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd-HH-mm-ss");
 
+    private final Payment2Repository paymentRepository;
     private final DelegatingPaymentService<PaymentFeeLink, String> delegatingPaymentService;
+
+
     private final PaymentDtoMapper paymentDtoMapper;
     private final EmailService emailService;
     private final FeesService feesService;
 
     @Autowired
-    public PaymentsReportService(@Qualifier("loggingPaymentService") DelegatingPaymentService<PaymentFeeLink, String> delegatingPaymentService, PaymentDtoMapper paymentDtoMapper,
+    public PaymentsReportService(@Qualifier("loggingPaymentService") DelegatingPaymentService<PaymentFeeLink, String> delegatingPaymentService,
+                                 Payment2Repository paymentRepository, PaymentDtoMapper paymentDtoMapper,
                                  EmailService emailService, FeesService feesService) {
         this.delegatingPaymentService = delegatingPaymentService;
+        this.paymentRepository = paymentRepository;
         this.paymentDtoMapper = paymentDtoMapper;
         this.emailService = emailService;
         this.feesService = feesService;
@@ -67,6 +77,21 @@ public void generateCsvAndSendEmail(Date startDate, Date endDate, PaymentMethodT
         LOG.info("End of payments csv report for method type :{} and service name :{}", paymentMethodType, serviceName);
     }
 
+    public void generateDuplicatePaymentsCsvAndSendEmail(Date startDate, Date endDate, PaymentReportConfig reportConfig) {
+
+        LOG.info("Start of duplicate payments csv report");
+
+        List<DuplicatePaymentDto> duplicatePaymentsCsvData = findDuplicatePaymentsBy(startDate, endDate);
+
+        if (duplicatePaymentsCsvData.isEmpty()) {
+            LOG.info("No duplicate payments were found, skipping email");
+        } else {
+            generateDuplicatePaymentReportCsvAndSendEmail(duplicatePaymentsCsvData, reportConfig);
+        }
+
+        LOG.info("End of duplicate payments csv report");
+    }
+
     private List<PaymentDto> findPaymentsBy(Date startDate, Date endDate, PaymentMethodType paymentMethodType, String serviceName) {
         String serviceType = serviceName;
         String paymentMethodTypeString = Optional.ofNullable(paymentMethodType).map(PaymentMethodType::getType).orElse(null);
@@ -85,6 +110,28 @@ private List<PaymentDto> findPaymentsBy(Date startDate, Date endDate, PaymentMet
             .collect(Collectors.toList());
     }
 
+    private List<DuplicatePaymentDto> findDuplicatePaymentsBy(Date startDate, Date endDate) {
+        LOG.info("Inside findDuplicatePaymentsBy");
+
+        // Use of Tuple requires the data in the nativeQuery is returned the same order as presented in the DTO.
+        List<Tuple> duplicatePaymentsTuples = paymentRepository.findDuplicatePaymentsByDate(startDate, endDate);
+
+        List<DuplicatePaymentDto> duplicatePaymentsDto = duplicatePaymentsTuples.stream()
+            .map(tup -> new DuplicatePaymentDto(
+                tup.get(0, Date.class),
+                tup.get(1, String.class),
+                tup.get(2, String.class),
+                tup.get(3, BigDecimal.class),
+                tup.get(4, String.class),
+                tup.get(5, String.class),
+                tup.get(6, Integer.class),
+                tup.get(7, BigInteger.class)
+            ))
+            .collect(Collectors.toList());
+
+        return duplicatePaymentsDto;
+    }
+
     private void generateCsvAndSendEmail(List<PaymentDto> payments, PaymentReportConfig reportConfig) {
         LOG.info("CollectionUtils.isNotEmpty(payments): {}", CollectionUtils.isNotEmpty(payments));
         String paymentsCsvFileName = reportConfig.getCsvFileNamePrefix() + LocalDateTime.now().format(formatter) + PAYMENTS_CSV_FILE_EXTENSION;
@@ -98,6 +145,19 @@ private void generateCsvAndSendEmail(List<PaymentDto> payments, PaymentReportCon
         sendEmail(email, paymentsByteArray, paymentsCsvFileName);
     }
 
+    private void generateDuplicatePaymentReportCsvAndSendEmail(List<DuplicatePaymentDto> duplicatePayments, PaymentReportConfig reportConfig) {
+        LOG.info("CollectionUtils.isNotEmpty(duplicatePayments): {}", CollectionUtils.isNotEmpty(duplicatePayments));
+        String paymentsCsvFileName = reportConfig.getCsvFileNamePrefix() + LocalDateTime.now().format(formatter) + PAYMENTS_CSV_FILE_EXTENSION;
+        byte[] paymentsByteArray = createDuplicatePaymentsCsvByteArray(duplicatePayments, paymentsCsvFileName, reportConfig);
+        Email email = Email.emailWith()
+            .from(reportConfig.getFrom())
+            .to(reportConfig.getTo())
+            .subject(reportConfig.getSubject())
+            .message(reportConfig.getMessage())
+            .build();
+        sendEmail(email, paymentsByteArray, paymentsCsvFileName);
+    }
+
     private void sendEmail(Email email, byte[] paymentsCsvByteArray, String csvFileName) {
         email.setAttachments(newArrayList(csv(paymentsCsvByteArray, csvFileName)));
         emailService.sendEmail(email);
@@ -120,5 +180,22 @@ private byte[] createPaymentsCsvByteArray(List<PaymentDto> payments, String paym
         }
         return paymentsCsvByteArray;
     }
+
+    private byte[] createDuplicatePaymentsCsvByteArray(List<DuplicatePaymentDto> duplicatePayments, String paymentsCsvFileName, PaymentReportConfig reportConfig) {
+        byte[] paymentsCsvByteArray = null;
+        try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
+            bos.write(reportConfig.getCsvHeader().getBytes(utf8));
+            bos.write(BYTE_ARRAY_OUTPUT_STREAM_NEWLINE.getBytes(utf8));
+            for (DuplicatePaymentDto duplicatePayment : duplicatePayments) {
+                bos.write(reportConfig.getCsvRecord(duplicatePayment).getBytes(utf8));
+                bos.write(BYTE_ARRAY_OUTPUT_STREAM_NEWLINE.getBytes(utf8));
+            }
+            LOG.info("PaymentsReportService - Total {} duplicate payment records written in csv file {}", duplicatePayments.size(), paymentsCsvFileName);
+            paymentsCsvByteArray = bos.toByteArray();
+        } catch (IOException ex) {
+            LOG.error("PaymentsReportService - Error while creating duplicate payments csv file {}. Error message is {}", paymentsCsvFileName, ex.getMessage());
+        }
+        return paymentsCsvByteArray;
+    }
 }
 

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/BarPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class BarPaymentReportConfig implements PaymentReportConfig {
+public class BarPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/CardPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class CardPaymentReportConfig implements PaymentReportConfig {
+public class CardPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CARD_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Payment created date,Payment status updated date,Payment status," +
@@ -33,10 +33,7 @@ public class CardPaymentReportConfig implements PaymentReportConfig {
     private boolean enabled;
 
     @Override
-    public PaymentReportType getType() {
-        return PaymentReportType.CARD;
-    }
-
+    public PaymentReportType getType() { return PaymentReportType.CARD; }
     @Override
     public String getCsvHeader() {
         return CARD_PAYMENTS_HEADER;

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/DuplicatePaymentReportConfig.java

@@ -0,0 +1,48 @@
+package uk.gov.hmcts.payment.api.reports.config;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+import uk.gov.hmcts.payment.api.contract.PaymentDto;
+import uk.gov.hmcts.payment.api.dto.DuplicatePaymentDto;
+import uk.gov.hmcts.payment.api.reports.PaymentReportType;
+
+@Component
+@Getter
+@AllArgsConstructor
+@NoArgsConstructor
+public class DuplicatePaymentReportConfig implements PaymentReportConfig<DuplicatePaymentDto> {
+
+    private static final String DUPLICATE_PAYMENTS_HEADER = "Date,Time,CCD Case Number,Service Type,Amount,"
+        + "Payment Channel,Payment Method,Payment Link ID,Count";
+
+    private static final String DUPLICATE_PAYMENTS_CSV_FILE_PREFIX = "hmcts_potential_duplicate_payments_";
+
+    @Value("${duplicate.payments.email.from:dummy}")
+    private String from;
+    @Value("${duplicate.payments.email.to:dummy}")
+    private String[] to;
+    @Value("${duplicate.payments.email.subject:dummy}")
+    private String subject;
+    @Value("${duplicate.payments.email.message:dummy}")
+    private String message;
+    @Value("${duplicate.payments.report.scheduler.enabled:false}")
+    private boolean enabled;
+    @Override
+    public PaymentReportType getType() { return PaymentReportType.DUPLICATE_PAYMENT; }
+    @Override
+    public String getCsvHeader() {
+        return DUPLICATE_PAYMENTS_HEADER;
+    }
+    @Override
+    public String getCsvRecord(DuplicatePaymentDto duplicatePaymentDto) {
+        return duplicatePaymentDto.toDuplicatePaymentCsv();
+    }
+    @Override
+    public String getCsvFileNamePrefix() {
+        return DUPLICATE_PAYMENTS_CSV_FILE_PREFIX;
+    }
+}

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PaymentReportConfig.java

@@ -1,9 +1,10 @@
 package uk.gov.hmcts.payment.api.reports.config;
 
 import uk.gov.hmcts.payment.api.contract.PaymentDto;
+import uk.gov.hmcts.payment.api.dto.DuplicatePaymentDto;
 import uk.gov.hmcts.payment.api.reports.PaymentReportType;
 
-public interface PaymentReportConfig {
+public interface PaymentReportConfig<T> {
 
     PaymentReportType getType();
 
@@ -21,6 +22,6 @@ public interface PaymentReportConfig {
 
     String getCsvHeader();
 
-    String getCsvRecord(PaymentDto paymentDto);
+    String getCsvRecord(T dto);
 
 }

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PbaCivilPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class PbaCivilPaymentReportConfig implements PaymentReportConfig {
+public class PbaCivilPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CREDIT_ACCOUNT_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PbaCmcPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class PbaCmcPaymentReportConfig implements PaymentReportConfig {
+public class PbaCmcPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CREDIT_ACCOUNT_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PbaDivorcePaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class PbaDivorcePaymentReportConfig implements PaymentReportConfig {
+public class PbaDivorcePaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CREDIT_ACCOUNT_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PbaFinremPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class PbaFinremPaymentReportConfig implements PaymentReportConfig {
+public class PbaFinremPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CREDIT_ACCOUNT_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +

api/src/main/java/uk/gov/hmcts/payment/api/reports/config/PbaFplPaymentReportConfig.java

@@ -12,7 +12,7 @@
 @Getter
 @AllArgsConstructor
 @NoArgsConstructor
-public class PbaFplPaymentReportConfig implements PaymentReportConfig {
+public class PbaFplPaymentReportConfig implements PaymentReportConfig<PaymentDto> {
 
     private static final String CREDIT_ACCOUNT_PAYMENTS_HEADER = "Service,Payment Group reference,Payment reference," +
         "CCD reference,Case reference,Organisation name,Customer internal reference,PBA Number,Payment created date," +