DSND-2876: Handle null metrics data for PSCs (#187)

* This isn't what I would like this service to look like. However, a ticket to refactor and address low test coverage has been put in the backlog.

Author: sthompsonCH

src/main/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscService.java

@@ -14,6 +14,7 @@
 import org.springframework.stereotype.Component;
 import uk.gov.companieshouse.api.exemptions.CompanyExemptions;
 import uk.gov.companieshouse.api.metrics.MetricsApi;
+import uk.gov.companieshouse.api.metrics.PscApi;
 import uk.gov.companieshouse.api.metrics.RegisterApi;
 import uk.gov.companieshouse.api.metrics.RegistersApi;
 import uk.gov.companieshouse.api.model.psc.PscIndividualFullRecordApi;
@@ -395,27 +396,24 @@ private PscList createPscDocumentList(List<PscDocument> pscDocuments, final int
             links.setExemptions(String.format("/company/%s/exemptions", companyNumber));
         }
 
-        if (companyMetrics == null) {
-            LOGGER.info("No company metrics counts data found", DataMapHolder.getLogMap());
+        if (companyMetrics == null
+                || companyMetrics.getCounts() == null // NOSONAR
+                || companyMetrics.getCounts().getPersonsWithSignificantControl() == null) {
+            LOGGER.info("No company metrics for PSC data found", DataMapHolder.getLogMap());
         } else {
+            PscApi pscCounts = companyMetrics.getCounts().getPersonsWithSignificantControl();
             if (registerView) {
                 final int withdrawnCount = (int) pscData.stream()
                         .filter(document -> document.getCeasedOn() != null)
                         .count();
 
                 pscList.setCeasedCount(withdrawnCount);
-                pscList.setTotalResults(companyMetrics.getCounts()
-                        .getPersonsWithSignificantControl().getActivePscsCount()
-                        + pscList.getCeasedCount());
-                pscList.setActiveCount(companyMetrics.getCounts()
-                        .getPersonsWithSignificantControl().getActivePscsCount());
+                pscList.setTotalResults(pscCounts.getActivePscsCount() + pscList.getCeasedCount());
+                pscList.setActiveCount(pscCounts.getActivePscsCount());
             } else {
-                pscList.setActiveCount(companyMetrics.getCounts()
-                        .getPersonsWithSignificantControl().getActivePscsCount());
-                pscList.setCeasedCount(companyMetrics.getCounts()
-                        .getPersonsWithSignificantControl().getCeasedPscsCount());
-                pscList.setTotalResults(companyMetrics.getCounts()
-                        .getPersonsWithSignificantControl().getPscsCount());
+                pscList.setActiveCount(pscCounts.getActivePscsCount());
+                pscList.setCeasedCount(pscCounts.getCeasedPscsCount());
+                pscList.setTotalResults(pscCounts.getPscsCount());
             }
         }
 

src/test/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscServiceTest.java

@@ -4,6 +4,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.ArgumentMatchers.anyInt;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
@@ -23,11 +24,16 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Named;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.function.Executable;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Captor;
 import org.mockito.InjectMocks;
@@ -36,7 +42,9 @@
 import uk.gov.companieshouse.api.exemptions.CompanyExemptions;
 import uk.gov.companieshouse.api.exemptions.Exemptions;
 import uk.gov.companieshouse.api.exemptions.PscExemptAsTradingOnUkRegulatedMarketItem;
+import uk.gov.companieshouse.api.metrics.CountsApi;
 import uk.gov.companieshouse.api.metrics.MetricsApi;
+import uk.gov.companieshouse.api.metrics.PscApi;
 import uk.gov.companieshouse.api.metrics.RegisterApi;
 import uk.gov.companieshouse.api.metrics.RegistersApi;
 import uk.gov.companieshouse.api.model.psc.PscIndividualFullRecordApi;
@@ -875,4 +883,75 @@ void getIndividualFullRecordShouldReturnFullRecordWhenFound_FlagVerifyStateTrue(
         verify(repository).getPscByCompanyNumberAndId(COMPANY_NUMBER, NOTIFICATION_ID);
         verify(transformer).transformPscDocToIndividualFullRecord(pscDocument);
     }
+
+    @Test
+    void shouldSetFieldsWhenRegisterViewIsTrue() {
+        // given
+        MetricsApi metricsApi = new MetricsApi().counts(
+                new CountsApi().personsWithSignificantControl(
+                        new PscApi().activePscsCount(1))).registers(
+                new RegistersApi().personsWithSignificantControl(
+                        new RegisterApi().registerMovedTo("public-register")));
+
+        Links links = new Links();
+        links.setSelf("/company/%s/persons-with-significant-control".formatted(COMPANY_NUMBER));
+
+        final PscList expected = new PscList()
+                .itemsPerPage(25)
+                .links(links)
+                .startIndex(0)
+                .items(List.of(new ListSummary()))
+                .ceasedCount(0)
+                .totalResults(1)
+                .activeCount(1);
+
+        when(companyMetricsApiService.getCompanyMetrics(anyString())).thenReturn(Optional.of(metricsApi));
+        when(repository.getListSummaryRegisterView(any(), any(), any(), any())).thenReturn(
+                Collections.singletonList(pscDocument));
+        when(transformer.transformPscDocToListSummary(any(), anyBoolean())).thenReturn(new ListSummary());
+
+        // when
+        final PscList actual = service.retrievePscListSummaryFromDb(COMPANY_NUMBER, 0, true, 25);
+
+        // then
+        assertEquals(expected, actual);
+    }
+
+    @ParameterizedTest
+    @MethodSource("nullCompanyMetricsPscDataArgs")
+    void shouldTestIfCompanyMetricsPscDataIsNull(MetricsApi metricsApi) {
+        // given
+        Links links = new Links();
+        links.setSelf("/company/%s/persons-with-significant-control".formatted(COMPANY_NUMBER));
+
+        final PscList expected = new PscList()
+                .itemsPerPage(25)
+                .links(links)
+                .startIndex(0)
+                .items(List.of(new ListSummary()));
+
+        when(companyMetricsApiService.getCompanyMetrics(anyString())).thenReturn(Optional.of(metricsApi));
+        when(repository.getListSummaryRegisterView(any(), any(), any(), any())).thenReturn(
+                Collections.singletonList(pscDocument));
+        when(transformer.transformPscDocToListSummary(any(), anyBoolean())).thenReturn(new ListSummary());
+
+        // when
+        final PscList actual = service.retrievePscListSummaryFromDb(COMPANY_NUMBER, 0, true, 25);
+
+        // then
+        assertEquals(expected, actual);
+    }
+
+    private static Stream<Arguments> nullCompanyMetricsPscDataArgs() {
+        return Stream.of(
+                Arguments.of(Named.of("Metrics with counts but no psc data",
+                        new MetricsApi().counts(new CountsApi()).registers(
+                                new RegistersApi().personsWithSignificantControl(
+                                        new RegisterApi().registerMovedTo("public-register"))))),
+                Arguments.of(Named.of("Metrics without counts",
+                        new MetricsApi().registers(
+                                new RegistersApi().personsWithSignificantControl(
+                                        new RegisterApi().registerMovedTo("public-register")))))
+        );
+    }
 }