feature: amp-151 add get endpoint and tidy ups

coling01 · coling01 · commit e9ac7f28d697 · 2025-12-15T11:52:22.000Z
* Add get by subscription id
* Pull in v1.0.0 api
* Default updatedAt with createdAt
* Make event_types 128 and notification endpoint 2048 in database table
diff --git a/build.gradle b/build.gradle
@@ -30,7 +30,7 @@ apply {
 }
 
 dependencies {
-  implementation(group: 'uk.gov.hmcts.cp', name: 'api-cp-crime-hearing-case-event-subscription', version: '0.1.0-724f10f')
+  implementation(group: 'uk.gov.hmcts.cp', name: 'api-cp-crime-hearing-case-event-subscription', version: '1.0.0')
 
   // This is proving to be a real puzzle. This is actually included in the api published pom
   // ( though with scope of "runtime" )
diff --git a/src/main/java/uk/gov/hmcts/cp/controllers/SubscriptionController.java b/src/main/java/uk/gov/hmcts/cp/controllers/SubscriptionController.java
@@ -9,6 +9,8 @@
 import uk.gov.hmcts.cp.openapi.model.ClientSubscriptionRequest;
 import uk.gov.hmcts.cp.services.SubscriptionService;
 
+import java.util.UUID;
+
 @RestController
 @RequiredArgsConstructor
 @Slf4j
@@ -23,4 +25,12 @@ public ResponseEntity<ClientSubscription> createClientSubscription(final ClientS
         log.info("createClientSubscription created subscription:{}", response.getClientSubscriptionId());
         return ResponseEntity.ok(response);
     }
+
+    @Override
+    public ResponseEntity<ClientSubscription> getClientSubscription(final UUID clientSubscriptionId) {
+        log.info("getClientSubscription clientId:{}", "TODO");
+        final ClientSubscription response = subscriptionService.getSubscription(clientSubscriptionId);
+        log.info("createClientSubscription returning subscription:{}", response.getClientSubscriptionId());
+        return ResponseEntity.ok(response);
+    }
 }
diff --git a/src/main/java/uk/gov/hmcts/cp/mappers/SubscriptionMapper.java b/src/main/java/uk/gov/hmcts/cp/mappers/SubscriptionMapper.java
@@ -21,14 +21,15 @@ public interface SubscriptionMapper {
 
     @Mapping(source = "request.eventTypes", target = "eventTypes", qualifiedByName = "sortedEventTypes")
     @Mapping(target = "createdAt", expression = "java(java.time.OffsetDateTime.now())")
+    @Mapping(target = "updatedAt", expression = "java(java.time.OffsetDateTime.now())")
     ClientSubscriptionEntity mapRequestToEntity(ClientSubscriptionRequest request);
 
     @Mapping(source = "id", target = "clientSubscriptionId")
     ClientSubscription mapEntityToResponse(ClientSubscriptionEntity entity);
 
     @Named("sortedEventTypes")
     static List<EntityEventType> sortedEventTypes(final List<EventType> events) {
-        List<String> sorted = events.stream().map(e -> e.name()).sorted().collect(toList());
+        final List<String> sorted = events.stream().map(e -> e.name()).sorted().collect(toList());
         return sorted.stream().map(e -> EntityEventType.valueOf(e)).toList();
     }
 
diff --git a/src/main/java/uk/gov/hmcts/cp/services/SubscriptionService.java b/src/main/java/uk/gov/hmcts/cp/services/SubscriptionService.java
@@ -9,6 +9,8 @@
 import uk.gov.hmcts.cp.openapi.model.ClientSubscriptionRequest;
 import uk.gov.hmcts.cp.repositories.SubscriptionRepository;
 
+import java.util.UUID;
+
 @Service
 @RequiredArgsConstructor
 @Slf4j
@@ -21,4 +23,9 @@ public ClientSubscription saveSubscription(final ClientSubscriptionRequest reque
         final ClientSubscriptionEntity entity = mapper.mapRequestToEntity(request);
         return mapper.mapEntityToResponse(subscriptionRepository.save(entity));
     }
+
+    public ClientSubscription getSubscription(final UUID clientSubscriptionId) {
+        final ClientSubscriptionEntity entity = subscriptionRepository.getReferenceById(clientSubscriptionId);
+        return mapper.mapEntityToResponse(entity);
+    }
 }
diff --git a/src/main/resources/db/migration/V1.001__subscription_schema.sql b/src/main/resources/db/migration/V1.001__subscription_schema.sql
@@ -1,7 +1,7 @@
 create table client_subscription (
     id                      uuid primary key not null,
-    event_types              varchar(2048) not null,
-    notification_endpoint   text        not null,
+    event_types             varchar(128) not null,
+    notification_endpoint   varchar(2048) not null,
     created_at              timestamp not null,
-    updated_at              timestamp
+    updated_at              timestamp not null
 );
diff --git a/src/test/java/uk/gov/hmcts/cp/controllers/SubscriptionControllerTest.java b/src/test/java/uk/gov/hmcts/cp/controllers/SubscriptionControllerTest.java
@@ -5,12 +5,14 @@
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.http.ResponseEntity;
 import uk.gov.hmcts.cp.openapi.model.ClientSubscription;
 import uk.gov.hmcts.cp.openapi.model.ClientSubscriptionRequest;
 import uk.gov.hmcts.cp.services.SubscriptionService;
 
 import java.util.UUID;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -28,10 +30,19 @@ class SubscriptionControllerTest {
 
     @Test
     void create_controller_should_call_service() {
-        UUID id = UUID.randomUUID();
-        ClientSubscription response = ClientSubscription.builder().clientSubscriptionId(id).build();
+        UUID subscriptionId = UUID.randomUUID();
+        ClientSubscription response = ClientSubscription.builder().clientSubscriptionId(subscriptionId).build();
         when(subscriptionService.saveSubscription(any())).thenReturn(response);
         subscriptionController.createClientSubscription(request);
         verify(subscriptionService).saveSubscription(request);
     }
+
+    @Test
+    void get_controller_should_call_service() {
+        UUID subscriptionId = UUID.randomUUID();
+        ClientSubscription response = ClientSubscription.builder().clientSubscriptionId(subscriptionId).build();
+        when(subscriptionService.getSubscription(subscriptionId)).thenReturn(response);
+        ResponseEntity<ClientSubscription> result = subscriptionController.getClientSubscription(subscriptionId);
+        assertThat(result.getBody()).isEqualTo(response);
+    }
 }
diff --git a/src/test/java/uk/gov/hmcts/cp/integration/IntegrationTestBase.java b/src/test/java/uk/gov/hmcts/cp/integration/IntegrationTestBase.java
@@ -2,11 +2,18 @@
 
 import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.web.servlet.MockMvc;
 import uk.gov.hmcts.cp.config.TestContainersInitialise;
+import uk.gov.hmcts.cp.entities.ClientSubscriptionEntity;
+import uk.gov.hmcts.cp.model.EntityEventType;
+import uk.gov.hmcts.cp.repositories.SubscriptionRepository;
+
+import java.time.OffsetDateTime;
+import java.util.List;
 
 @SpringBootTest
 @ContextConfiguration(initializers = TestContainersInitialise.class)
@@ -16,4 +23,18 @@ public abstract class IntegrationTestBase {
 
     @Resource
     protected MockMvc mockMvc;
+
+    @Autowired
+    SubscriptionRepository subscriptionRepository;
+
+    protected ClientSubscriptionEntity insertSubscription(String notificationUri, List<EntityEventType> entityEventTypes) {
+        ClientSubscriptionEntity subscription = ClientSubscriptionEntity.builder()
+                .eventTypes(entityEventTypes)
+                .notificationEndpoint(notificationUri)
+                .createdAt(OffsetDateTime.now())
+                .build();
+        ClientSubscriptionEntity saved = subscriptionRepository.save(subscription);
+        log.info("Inserted subscription:{}", saved.getId());
+        return saved;
+    }
 }
diff --git a/src/test/java/uk/gov/hmcts/cp/integration/SubscriptionControllerIntegrationTest.java b/src/test/java/uk/gov/hmcts/cp/integration/SubscriptionControllerIntegrationTest.java
@@ -15,6 +15,7 @@
 import java.util.List;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
@@ -39,7 +40,7 @@ class SubscriptionControllerIntegrationTest extends IntegrationTestBase {
     @Transactional
     void save_client_subscription_should_save_subscription() throws Exception {
         String body = new ObjectMapper().writeValueAsString(request);
-        mockMvc.perform(post("/clientSubscriptions")
+        mockMvc.perform(post("/client-subscriptions")
                         .contentType(MediaType.APPLICATION_JSON)
                         .header("client-id-todo", "1234")
                         .content(body))
@@ -52,6 +53,19 @@ void save_client_subscription_should_save_subscription() throws Exception {
         assertThatEventTypesAreSortedInDatabase();
     }
 
+    @Test
+    @Transactional
+    void get_subscription_should_return_expected() throws Exception {
+        ClientSubscriptionEntity entity = insertSubscription("http://example.com/event", List.of(EntityEventType.PCR));
+        mockMvc.perform(get("/client-subscriptions/{id}", entity.getId())
+                        .header("client-id-todo", "1234"))
+                .andDo(print())
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.clientSubscriptionId").value(entity.getId().toString()))
+                .andExpect(jsonPath("$.eventTypes.[0]").value("PCR"))
+                .andExpect(jsonPath("$.createdAt").exists());
+    }
+
     private void assertThatEventTypesAreSortedInDatabase() {
         List<ClientSubscriptionEntity> entities = subscriptionRepository.findAll();
         assertThat(entities).hasSize(1);
diff --git a/src/test/java/uk/gov/hmcts/cp/mappers/SubscriptionMapperTest.java b/src/test/java/uk/gov/hmcts/cp/mappers/SubscriptionMapperTest.java
@@ -40,7 +40,7 @@ void request_should_map_to_entity_with_sorted_types() {
         assertThat(entity.getNotificationEndpoint()).isEqualTo("https://example.com");
         assertThat(entity.getEventTypes().toString()).isEqualTo("[CUSTODIAL_RESULT, PCR]");
         assertThat(entity.getCreatedAt()).isNotNull();
-        assertThat(entity.getUpdatedAt()).isNull();
+        assertThat(entity.getUpdatedAt()).isNotNull();
     }
 
     @Test
diff --git a/src/test/java/uk/gov/hmcts/cp/repositories/SubscriptionRepositoryTest.java b/src/test/java/uk/gov/hmcts/cp/repositories/SubscriptionRepositoryTest.java
@@ -21,12 +21,11 @@ void beforeEach() {
     @Transactional
     @Test
     void subscription_should_save_and_read_ok() {
-        insertSubscription("https://example.com/notify", List.of(CUSTODIAL_RESULT, PCR));
-        List<ClientSubscriptionEntity> subscriptions = subscriptionRepository.findAll();
-        assertThat(subscriptions).hasSize(1);
-        assertThat(subscriptions.get(0).getId()).isNotNull();
-        assertThat(subscriptions.get(0).getEventTypes()).isEqualTo(List.of(CUSTODIAL_RESULT, PCR));
-        assertThat(subscriptions.get(0).getNotificationEndpoint()).isEqualTo("https://example.com/notify");
-        assertThat(subscriptions.get(0).getCreatedAt()).isNotNull();
+        ClientSubscriptionEntity saved = insertSubscription("https://example.com/notify", List.of(CUSTODIAL_RESULT, PCR));
+        ClientSubscriptionEntity found = subscriptionRepository.getReferenceById(saved.getId());
+        assertThat(found.getId()).isEqualTo(saved.getId());
+        assertThat(found.getEventTypes()).isEqualTo(List.of(CUSTODIAL_RESULT, PCR));
+        assertThat(found.getNotificationEndpoint()).isEqualTo("https://example.com/notify");
+        assertThat(found.getCreatedAt()).isNotNull();
     }
 }
diff --git a/src/test/java/uk/gov/hmcts/cp/services/SubscriptionServiceTest.java b/src/test/java/uk/gov/hmcts/cp/services/SubscriptionServiceTest.java
@@ -12,6 +12,8 @@
 import uk.gov.hmcts.cp.openapi.model.ClientSubscriptionRequest;
 import uk.gov.hmcts.cp.repositories.SubscriptionRepository;
 
+import java.util.UUID;
+
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -44,4 +46,15 @@ void request_should_save_entity() {
         verify(subscriptionRepository).save(requestEntity);
         assertThat(result).isEqualTo(response);
     }
+
+    @Test
+    void request_should_get_entity() {
+        UUID subscriptionId = UUID.fromString("2ca16eb5-3998-4bb7-adce-4bb9b3b7223c");
+        when(subscriptionRepository.getReferenceById(subscriptionId)).thenReturn(savedEntity);
+        when(mapper.mapEntityToResponse(savedEntity)).thenReturn(response);
+
+        ClientSubscription result = subscriptionService.getSubscription(subscriptionId);
+
+        assertThat(result).isEqualTo(response);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ apply {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`dependencies {`
`33`		`- implementation(group: 'uk.gov.hmcts.cp', name: 'api-cp-crime-hearing-case-event-subscription', version: '0.1.0-724f10f')`
	`33`	`+ implementation(group: 'uk.gov.hmcts.cp', name: 'api-cp-crime-hearing-case-event-subscription', version: '1.0.0')`
`34`	`34`
`35`	`35`	`// This is proving to be a real puzzle. This is actually included in the api published pom`
`36`	`36`	`// ( though with scope of "runtime" )`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ void request_should_map_to_entity_with_sorted_types() {`
`40`	`40`	`assertThat(entity.getNotificationEndpoint()).isEqualTo("https://example.com");`
`41`	`41`	`assertThat(entity.getEventTypes().toString()).isEqualTo("[CUSTODIAL_RESULT, PCR]");`
`42`	`42`	`assertThat(entity.getCreatedAt()).isNotNull();`
`43`		`- assertThat(entity.getUpdatedAt()).isNull();`
	`43`	`+ assertThat(entity.getUpdatedAt()).isNotNull();`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`@Test`