Merge pull request #137 from companieshouse/feature/gci-2203_toggle_product_class_cnum

dlgroves-ch · web-flow · commit daa9b6719da6 · 2022-09-05T15:57:42.000+01:00
GCI-2203 Toggle checkout search fields
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/config/FeatureOptions.java b/src/main/java/uk/gov/companieshouse/orders/api/config/FeatureOptions.java
@@ -3,12 +3,18 @@
 public class FeatureOptions {
 
     private final boolean ordersSearchEndpointEnabled;
+    private final boolean multiItemBasketSearchEnabled;
 
-    public FeatureOptions(boolean ordersSearchEndpointEnabled) {
+    public FeatureOptions(boolean ordersSearchEndpointEnabled, boolean multiItemBasketSearchEnabled) {
         this.ordersSearchEndpointEnabled = ordersSearchEndpointEnabled;
+        this.multiItemBasketSearchEnabled = multiItemBasketSearchEnabled;
     }
 
     public boolean isOrdersSearchEndpointEnabled() {
         return ordersSearchEndpointEnabled;
     }
+
+    public boolean isMultiItemBasketSearchEnabled() {
+        return multiItemBasketSearchEnabled;
+    }
 }
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/config/FeatureOptionsConfig.java b/src/main/java/uk/gov/companieshouse/orders/api/config/FeatureOptionsConfig.java
@@ -10,8 +10,11 @@ public class FeatureOptionsConfig {
     @Value("${feature.options.ordersSearchEndpointEnabled:false}")
     private boolean ordersSearchEnabled;
 
+    @Value("${feature.options.multiItemBasketSearchEnabled:false}")
+    private boolean multiItemBasketSearchEnabled;
+
     @Bean
     public FeatureOptions featureOptions() {
-        return new FeatureOptions(ordersSearchEnabled);
+        return new FeatureOptions(ordersSearchEnabled, multiItemBasketSearchEnabled);
     }
 }
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/exception/ServiceException.java b/src/main/java/uk/gov/companieshouse/orders/api/exception/ServiceException.java
@@ -6,4 +6,7 @@ public ServiceException(String message) {
         super(message);
     }
 
+    public ServiceException(String message, Throwable cause) {
+        super(message, cause);
+    }
 }
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummary.java b/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummary.java
@@ -26,7 +26,7 @@ public static Builder newBuilder() {
         return new Builder();
     }
 
-    public static final class Builder {
+    public static final class Builder implements CheckoutSummaryBuildable {
         private String id;
         private String email;
         private String companyNumber;
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryBuildable.java b/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryBuildable.java
@@ -0,0 +1,14 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import java.time.LocalDateTime;
+
+public interface CheckoutSummaryBuildable {
+    CheckoutSummaryBuildable withId(String id);
+    CheckoutSummaryBuildable withEmail(String email);
+    CheckoutSummaryBuildable withCompanyNumber(String companyNumber);
+    CheckoutSummaryBuildable withProductLine(String productLine);
+    CheckoutSummaryBuildable withCheckoutDate(LocalDateTime checkoutDate);
+    CheckoutSummaryBuildable withPaymentStatus(PaymentStatus paymentStatus);
+    CheckoutSummaryBuildable withLinks(Links links);
+    CheckoutSummary build();
+}
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryBuilderFactory.java b/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryBuilderFactory.java
@@ -0,0 +1,23 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import java.lang.reflect.Proxy;
+import org.springframework.stereotype.Component;
+import uk.gov.companieshouse.orders.api.config.FeatureOptions;
+
+@Component
+public class CheckoutSummaryBuilderFactory {
+
+    private final FeatureOptions featureOptions;
+
+    public CheckoutSummaryBuilderFactory(FeatureOptions featureOptions) {
+        this.featureOptions = featureOptions;
+    }
+
+    public CheckoutSummaryBuildable newCheckoutSummaryBuilder() {
+        CheckoutSummaryBuildable builder = CheckoutSummary.newBuilder();
+        return (CheckoutSummaryBuildable) Proxy.newProxyInstance(
+                builder.getClass().getClassLoader(),
+                builder.getClass().getInterfaces(),
+                new CheckoutSummaryInvocationHandler(this.featureOptions, builder));
+    }
+}
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryInvocationHandler.java b/src/main/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryInvocationHandler.java
@@ -0,0 +1,38 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import uk.gov.companieshouse.orders.api.config.FeatureOptions;
+import uk.gov.companieshouse.orders.api.exception.ServiceException;
+
+public class CheckoutSummaryInvocationHandler implements InvocationHandler {
+
+    private final CheckoutSummaryBuildable builder;
+    private final FeatureOptions featureOptions;
+
+    public CheckoutSummaryInvocationHandler(FeatureOptions featureOptions, CheckoutSummaryBuildable builder) {
+        this.builder = builder;
+        this.featureOptions = featureOptions;
+    }
+
+    @Override
+    public Object invoke(Object proxy, Method method, Object[] args) {
+        try {
+            if ("withCompanyNumber".equals(method.getName())
+                    && featureOptions.isMultiItemBasketSearchEnabled()) {
+                return proxy;
+            } else if ("withProductLine".equals(method.getName())
+                    && featureOptions.isMultiItemBasketSearchEnabled()) {
+                return proxy;
+            } else if (method.getName().startsWith("with")) {
+                method.invoke(builder, args);
+                return proxy;
+            } else {
+                return method.invoke(builder, args);
+            }
+        } catch (InvocationTargetException | IllegalAccessException e) {
+            throw new ServiceException("Error mapping checkout summary", e);
+        }
+    }
+}
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/service/CheckoutService.java b/src/main/java/uk/gov/companieshouse/orders/api/service/CheckoutService.java
@@ -23,17 +23,20 @@ public class CheckoutService {
     private final LinksGeneratorService linksGeneratorService;
     private final CheckoutHelper checkoutHelper;
     private final SearchFieldMapper searchFieldMapper;
+    private final CheckoutSummaryBuilderFactory summaryBuilderFactory;
 
     public CheckoutService(CheckoutRepository checkoutRepository,
                            EtagGeneratorService etagGeneratorService,
                            LinksGeneratorService linksGeneratorService,
                            CheckoutHelper checkoutHelper,
-                           SearchFieldMapper searchFieldMapper) {
+                           SearchFieldMapper searchFieldMapper,
+                           CheckoutSummaryBuilderFactory summaryBuilderFactory) {
         this.checkoutRepository = checkoutRepository;
         this.etagGeneratorService = etagGeneratorService;
         this.linksGeneratorService = linksGeneratorService;
         this.checkoutHelper = checkoutHelper;
         this.searchFieldMapper = searchFieldMapper;
+        this.summaryBuilderFactory = summaryBuilderFactory;
     }
 
     private String autoGenerateId() {
@@ -97,7 +100,7 @@ public CheckoutSearchResults searchCheckouts(CheckoutSearchCriteria checkoutSear
 
         return new CheckoutSearchResults(checkoutPages.getTotalElements(),
                 checkouts.stream().map(
-                        checkout -> CheckoutSummary.newBuilder()
+                        checkout -> summaryBuilderFactory.newCheckoutSummaryBuilder()
                                 .withId(checkout.getId())
                                 .withEmail(
                                         Optional.ofNullable(checkout.getData())
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -14,4 +14,5 @@ spring.data.mongodb.field-naming-strategy=uk.gov.companieshouse.orders.api.model
 
 spring.kafka.producer.bootstrap-servers: ${KAFKA_BROKER_ADDR}
 
-feature.options.ordersSearchEndpointEnabled=${ORDERS_SEARCH_ENDPOINT_ENABLED:false}
+feature.options.ordersSearchEndpointEnabled=${ORDERS_SEARCH_ENDPOINT_ENABLED:false}
+feature.options.multiItemBasketSearchEnabled=${ORDERS_SEARCH_MULTIBASKET_ENABLED:false}
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/controller/OrderControllerIntegrationTest.java b/src/test/java/uk/gov/companieshouse/orders/api/controller/OrderControllerIntegrationTest.java
@@ -77,7 +77,7 @@
 @AutoConfigureMockMvc
 @SpringBootTest
 @EmbeddedKafka
-@ActiveProfiles("orders-search-enabled")
+@ActiveProfiles({"orders-search-enabled", "orders-search-multibasket-enabled"})
 class OrderControllerIntegrationTest {
     private static final String ORDER_ID = "0001";
     private static final String ORDER_REFERENCE = "0001";
@@ -252,8 +252,6 @@ void searchCheckoutsById() throws Exception {
                         CheckoutSummary.newBuilder()
                                 .withId(CHECKOUT_ID)
                                 .withEmail("demo@ch.gov.uk")
-                                .withCompanyNumber("12345678")
-                                .withProductLine("item#certificate")
                                 .withPaymentStatus(PaymentStatus.PAID)
                                 .withCheckoutDate(LocalDate.of(2022, 4, 12).atStartOfDay())
                                 .withLinks(new Links(new HRef("http"), new HRef("http")))
@@ -269,7 +267,7 @@ void searchCheckoutsById() throws Exception {
                 .header(ERIC_AUTHORISED_TOKEN_PERMISSIONS, String.format(TOKEN_PERMISSION_VALUE, Permission.Value.READ))
                 .contentType(MediaType.APPLICATION_JSON))
                 .andExpect(status().isOk())
-                .andExpect(content().json(mapper.writeValueAsString(expected)));
+                .andExpect(content().json(mapper.writeValueAsString(expected), true));
     }
 
     @DisplayName("Should find a single checkout when searching with a partial email address")
@@ -281,8 +279,6 @@ void searchCheckoutsByEmail() throws Exception {
                         CheckoutSummary.newBuilder()
                                 .withId(CHECKOUT_ID)
                                 .withEmail("demo@ch.gov.uk")
-                                .withCompanyNumber("12345678")
-                                .withProductLine("item#certificate")
                                 .withPaymentStatus(PaymentStatus.PAID)
                                 .withCheckoutDate(LocalDate.of(2022, 4, 12).atStartOfDay())
                                 .withLinks(new Links(new HRef("http"), new HRef("http")))
@@ -298,7 +294,7 @@ void searchCheckoutsByEmail() throws Exception {
                 .header(ERIC_AUTHORISED_TOKEN_PERMISSIONS, String.format(TOKEN_PERMISSION_VALUE, Permission.Value.READ))
                 .contentType(MediaType.APPLICATION_JSON))
                 .andExpect(status().isOk())
-                .andExpect(content().json(mapper.writeValueAsString(expected)));
+                .andExpect(content().json(mapper.writeValueAsString(expected), true));
     }
 
     @DisplayName("Should find a single checkout when a valid company number is provided")
@@ -312,8 +308,6 @@ void searchCheckoutsByCompanyNumber() throws Exception {
                         CheckoutSummary.newBuilder()
                                 .withId(ORDER_ID)
                                 .withEmail("demo@ch.gov.uk")
-                                .withCompanyNumber("12345678")
-                                .withProductLine("item#certificate")
                                 .withPaymentStatus(PaymentStatus.PAID)
                                 .withCheckoutDate(LocalDate.of(2022, 4, 12).atStartOfDay())
                                 .withLinks(new Links(new HRef("http"), new HRef("http")))
@@ -329,7 +323,7 @@ void searchCheckoutsByCompanyNumber() throws Exception {
                 .header(ERIC_AUTHORISED_TOKEN_PERMISSIONS, String.format(TOKEN_PERMISSION_VALUE, Permission.Value.READ))
                 .contentType(MediaType.APPLICATION_JSON))
                 .andExpect(status().isOk())
-                .andExpect(content().json(mapper.writeValueAsString(expected)));
+                .andExpect(content().json(mapper.writeValueAsString(expected), true));
     }
 
     @ParameterizedTest(name = "{index}: {0}")
@@ -348,7 +342,7 @@ void searchReturnsNoMatches(final String displayName, final String searchField,
                         .header(ERIC_AUTHORISED_TOKEN_PERMISSIONS, String.format(TOKEN_PERMISSION_VALUE, Permission.Value.READ))
                         .contentType(MediaType.APPLICATION_JSON))
                 .andExpect(status().isOk())
-                .andExpect(content().json(mapper.writeValueAsString(expected)));
+                .andExpect(content().json(mapper.writeValueAsString(expected), true));
     }
 
     @DisplayName("Should return a page containing a single order when page_size is one")
@@ -578,7 +572,7 @@ private MockHttpServletRequestBuilder reprocessOrderWithRequiredCredentials() {
                         .contentType(MediaType.APPLICATION_JSON);
     }
 
-    private static Stream<Arguments> noMatchesFixture() {
+    static Stream<Arguments> noMatchesFixture() {
         return Stream.of(Arguments.arguments("Should not find a order when incomplete order id is provided", "id", "00"),
                 Arguments.arguments("Should not find a order when a incorrect email address is provided", "email", "wrong@ch.gov.uk"),
                 Arguments.arguments("Should not find a order when a incomplete company number is provided", "company_number", "345678912"));
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/controller/OrdersSearchMultibasketDisabledIntegrationTest.java b/src/test/java/uk/gov/companieshouse/orders/api/controller/OrdersSearchMultibasketDisabledIntegrationTest.java
@@ -0,0 +1,91 @@
+package uk.gov.companieshouse.orders.api.controller;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import static uk.gov.companieshouse.api.util.security.EricConstants.ERIC_AUTHORISED_TOKEN_PERMISSIONS;
+import static uk.gov.companieshouse.api.util.security.SecurityConstants.INTERNAL_USER_ROLE;
+import static uk.gov.companieshouse.orders.api.util.EricHeaderHelper.API_KEY_IDENTITY_TYPE;
+import static uk.gov.companieshouse.orders.api.util.EricHeaderHelper.ERIC_IDENTITY_TYPE;
+import static uk.gov.companieshouse.orders.api.util.TestConstants.ERIC_IDENTITY_HEADER_NAME;
+import static uk.gov.companieshouse.orders.api.util.TestConstants.ERIC_IDENTITY_VALUE;
+import static uk.gov.companieshouse.orders.api.util.TestConstants.REQUEST_ID_HEADER_NAME;
+import static uk.gov.companieshouse.orders.api.util.TestConstants.TOKEN_PERMISSION_VALUE;
+import static uk.gov.companieshouse.orders.api.util.TestConstants.TOKEN_REQUEST_ID_VALUE;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.time.LocalDate;
+import java.util.Collections;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.MediaType;
+import org.springframework.kafka.test.context.EmbeddedKafka;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.web.servlet.MockMvc;
+import uk.gov.companieshouse.api.util.security.Permission;
+import uk.gov.companieshouse.orders.api.model.CheckoutSearchResults;
+import uk.gov.companieshouse.orders.api.model.CheckoutSummary;
+import uk.gov.companieshouse.orders.api.model.HRef;
+import uk.gov.companieshouse.orders.api.model.Links;
+import uk.gov.companieshouse.orders.api.model.PaymentStatus;
+import uk.gov.companieshouse.orders.api.repository.CheckoutRepository;
+import uk.gov.companieshouse.orders.api.util.StubHelper;
+import uk.gov.companieshouse.orders.api.util.TestConstants;
+
+@DirtiesContext
+@AutoConfigureMockMvc
+@SpringBootTest
+@EmbeddedKafka
+@ActiveProfiles({"orders-search-enabled", "orders-search-multibasket-disabled"})
+class OrdersSearchMultibasketDisabledIntegrationTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @Autowired
+    private CheckoutRepository checkoutRepository;
+
+    @Autowired
+    private ObjectMapper mapper;
+
+    @AfterEach
+    void tearDown() {
+        checkoutRepository.deleteAll();
+    }
+
+    @DisplayName("Should find a single checkout when searching by order id")
+    @Test
+    void searchCheckoutsById() throws Exception {
+        checkoutRepository.save(
+                StubHelper.getCheckout(TestConstants.CHECKOUT_ID, "demo@ch.gov.uk", "12345678",
+                        PaymentStatus.PAID));
+        CheckoutSearchResults expected = new CheckoutSearchResults(1,
+                Collections.singletonList(
+                        CheckoutSummary.newBuilder()
+                                       .withId(TestConstants.CHECKOUT_ID)
+                                       .withEmail("demo@ch.gov.uk")
+                                       .withCompanyNumber("12345678")
+                                       .withProductLine("item#certificate")
+                                       .withPaymentStatus(PaymentStatus.PAID)
+                                       .withCheckoutDate(LocalDate.of(2022, 4, 12).atStartOfDay())
+                                       .withLinks(new Links(new HRef("http"), new HRef("http")))
+                                       .build()));
+
+        mockMvc.perform(get(TestConstants.CHECKOUT_SEARCH_PATH)
+                       .param(TestConstants.CHECKOUT_SEARCH_ID_PARAM, TestConstants.CHECKOUT_ID)
+                       .param(TestConstants.CHECKOUT_SEARCH_PAGE_SIZE_PARAM, "1")
+                       .header(REQUEST_ID_HEADER_NAME, TOKEN_REQUEST_ID_VALUE)
+                       .header(ERIC_IDENTITY_TYPE, API_KEY_IDENTITY_TYPE)
+                       .header(TestConstants.ERIC_AUTHORISED_KEY_PRIVILEGES, INTERNAL_USER_ROLE)
+                       .header(ERIC_IDENTITY_HEADER_NAME, ERIC_IDENTITY_VALUE)
+                       .header(ERIC_AUTHORISED_TOKEN_PERMISSIONS, String.format(TOKEN_PERMISSION_VALUE, Permission.Value.READ))
+                       .contentType(MediaType.APPLICATION_JSON))
+               .andExpect(status().isOk())
+               .andExpect(content().json(mapper.writeValueAsString(expected), true));
+    }
+}
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryInvocationHandlerTest.java b/src/test/java/uk/gov/companieshouse/orders/api/model/CheckoutSummaryInvocationHandlerTest.java
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/service/CheckoutServiceTest.java b/src/test/java/uk/gov/companieshouse/orders/api/service/CheckoutServiceTest.java
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/util/TestConstants.java b/src/test/java/uk/gov/companieshouse/orders/api/util/TestConstants.java
diff --git a/src/test/resources/application.properties b/src/test/resources/application.properties

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,18 @@`
`3`	`3`	`public class FeatureOptions {`
`4`	`4`
`5`	`5`	`private final boolean ordersSearchEndpointEnabled;`
	`6`	`+ private final boolean multiItemBasketSearchEnabled;`
`6`	`7`
`7`		`- public FeatureOptions(boolean ordersSearchEndpointEnabled) {`
	`8`	`+ public FeatureOptions(boolean ordersSearchEndpointEnabled, boolean multiItemBasketSearchEnabled) {`
`8`	`9`	`this.ordersSearchEndpointEnabled = ordersSearchEndpointEnabled;`
	`10`	`+ this.multiItemBasketSearchEnabled = multiItemBasketSearchEnabled;`
`9`	`11`	`}`
`10`	`12`
`11`	`13`	`public boolean isOrdersSearchEndpointEnabled() {`
`12`	`14`	`return ordersSearchEndpointEnabled;`
`13`	`15`	`}`
	`16`	`+`
	`17`	`+ public boolean isMultiItemBasketSearchEnabled() {`
	`18`	`+ return multiItemBasketSearchEnabled;`
	`19`	`+ }`
`14`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,11 @@ public class FeatureOptionsConfig {`
`10`	`10`	`@Value("${feature.options.ordersSearchEndpointEnabled:false}")`
`11`	`11`	`private boolean ordersSearchEnabled;`
`12`	`12`
	`13`	`+ @Value("${feature.options.multiItemBasketSearchEnabled:false}")`
	`14`	`+ private boolean multiItemBasketSearchEnabled;`
	`15`	`+`
`13`	`16`	`@Bean`
`14`	`17`	`public FeatureOptions featureOptions() {`
`15`		`- return new FeatureOptions(ordersSearchEnabled);`
	`18`	`+ return new FeatureOptions(ordersSearchEnabled, multiItemBasketSearchEnabled);`
`16`	`19`	`}`
`17`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,7 @@ public ServiceException(String message) {`
`6`	`6`	`super(message);`
`7`	`7`	`}`
`8`	`8`
	`9`	`+ public ServiceException(String message, Throwable cause) {`
	`10`	`+ super(message, cause);`
	`11`	`+ }`
`9`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public static Builder newBuilder() {`
`26`	`26`	`return new Builder();`
`27`	`27`	`}`
`28`	`28`
`29`		`- public static final class Builder {`
	`29`	`+ public static final class Builder implements CheckoutSummaryBuildable {`
`30`	`30`	`private String id;`
`31`	`31`	`private String email;`
`32`	`32`	`private String companyNumber;`