feat: CoJ receivedFromTis

build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 
 group = "uk.nhs.hee.trainee.details"
-version = "0.31.0"
+version = "0.32.0"
 
 configurations {
   compileOnly {

src/main/java/uk/nhs/hee/trainee/details/dto/ConditionsOfJoiningDto.java

@@ -29,7 +29,9 @@
  *
  * @param signedAt When the Conditions of Joining were signed.
  * @param version  The Gold Guide version of the Conditions of Joining.
+ * @param syncedAt When the saved Conditions of Joining was synced from TIS.
  */
-public record ConditionsOfJoiningDto(Instant signedAt, GoldGuideVersion version) {
+public record ConditionsOfJoiningDto(Instant signedAt, GoldGuideVersion version,
+                                     Instant syncedAt) {
 
 }

src/main/java/uk/nhs/hee/trainee/details/model/ConditionsOfJoining.java

@@ -30,8 +30,10 @@
  *
  * @param signedAt When the Conditions of Joining were signed.
  * @param version  The Gold Guide version of the Conditions of Joining.
+ * @param syncedAt When the saved Conditions of Joining was synced from TIS.
  */
-public record ConditionsOfJoining(Instant signedAt, GoldGuideVersion version) implements
+public record ConditionsOfJoining(Instant signedAt, GoldGuideVersion version,
+                                  Instant syncedAt) implements
     Serializable {
 
 }

src/main/java/uk/nhs/hee/trainee/details/service/ProgrammeMembershipService.java

@@ -220,7 +220,7 @@ public Optional<ProgrammeMembership> signProgrammeMembershipCoj(
       for (ProgrammeMembership existingProgrammeMembership : existingProgrammeMemberships) {
         if (existingProgrammeMembership.getTisId().equals(programmeMembershipId)) {
           ConditionsOfJoining conditionsOfJoining =
-              new ConditionsOfJoining(Instant.now(), GoldGuideVersion.getLatest());
+              new ConditionsOfJoining(Instant.now(), GoldGuideVersion.getLatest(), null);
           existingProgrammeMembership.setConditionsOfJoining(conditionsOfJoining);
           repository.save(traineeProfile);
           return Optional.of(existingProgrammeMembership);

src/main/java/uk/nhs/hee/trainee/details/service/TraineeProfileService.java

@@ -75,7 +75,7 @@ public TraineeProfile getTraineeProfileByTraineeTisId(String traineeTisId) {
       }
 
       // Set latest CoJ version if not already signed.
-      ConditionsOfJoining coj = new ConditionsOfJoining(null, GoldGuideVersion.getLatest());
+      ConditionsOfJoining coj = new ConditionsOfJoining(null, GoldGuideVersion.getLatest(), null);
 
       traineeProfile.getProgrammeMemberships().stream()
           .filter(pm -> pm.getConditionsOfJoining() == null

src/test/java/uk/nhs/hee/trainee/details/api/ProgrammeMembershipResourceTest.java

@@ -290,7 +290,7 @@ void shouldSignCojWhenTraineePmFound() throws Exception {
     programmeMembership.setProgrammeName("programmeNameValue");
     programmeMembership.setProgrammeNumber("programmeNumberValue");
     programmeMembership.setConditionsOfJoining(
-        new ConditionsOfJoining(signedAt, GoldGuideVersion.getLatest()));
+        new ConditionsOfJoining(signedAt, GoldGuideVersion.getLatest(), null));
 
     when(service.signProgrammeMembershipCoj("tisIdValue", "40"))
         .thenReturn(Optional.of(programmeMembership));
@@ -311,6 +311,8 @@ void shouldSignCojWhenTraineePmFound() throws Exception {
         .andExpect(jsonPath("$.programmeNumber").value(is("programmeNumberValue")))
         .andExpect(jsonPath("$.conditionsOfJoining.signedAt").value(is(signedAt.toString())))
         .andExpect(jsonPath("$.conditionsOfJoining.version")
-            .value(is(GoldGuideVersion.GG9.toString())));
+            .value(is(GoldGuideVersion.GG9.toString())))
+        .andExpect(jsonPath("$.conditionsOfJoining.syncedAt")
+            .isEmpty());
   }
 }

src/test/java/uk/nhs/hee/trainee/details/api/TraineeProfileResourceTest.java

@@ -116,6 +116,7 @@ class TraineeProfileResourceTest {
   private static final String PLACEMENT_SITE = "Addenbrookes Hospital";
   private static final Status PLACEMENT_STATUS = Status.CURRENT;
   private static final Instant NOW = Instant.now();
+  private static final Instant COJ_SYNCED_AT = Instant.MAX;
 
   @Autowired
   private MappingJackson2HttpMessageConverter jacksonMessageConverter;
@@ -204,7 +205,8 @@ void setupProgrammeMembershipsData() {
     programmeMembership.setProgrammeName(PROGRAMME_NAME);
     programmeMembership.setProgrammeNumber(PROGRAMME_NUMBER);
     programmeMembership.setCurricula(List.of(curriculum));
-    programmeMembership.setConditionsOfJoining(new ConditionsOfJoining(NOW, GoldGuideVersion.GG9));
+    programmeMembership.setConditionsOfJoining(
+        new ConditionsOfJoining(NOW, GoldGuideVersion.GG9, COJ_SYNCED_AT));
   }
 
   /**
@@ -327,6 +329,9 @@ void getShouldReturnTraineeProfileWhenTisIdExists() throws Exception {
             NOW.toString()))
         .andExpect(jsonPath("$.programmeMemberships[*].conditionsOfJoining.version").value(
             GoldGuideVersion.GG9.toString()))
+        .andExpect(
+            jsonPath("$.programmeMemberships[*].conditionsOfJoining.syncedAt")
+                .value(COJ_SYNCED_AT.toString()))
         .andExpect(jsonPath("$.programmeMemberships[*].signature.hmac").value(signature.getHmac()))
         .andExpect(jsonPath("$.programmeMemberships[*].signature.signedAt")
             .value(signature.getSignedAt().toString()))

src/test/java/uk/nhs/hee/trainee/details/service/CachingDelegateIntegrationTest.java

@@ -63,7 +63,8 @@ void shouldReturnEmptyConditionsOfJoiningWhenNotCached() {
   void shouldReturnCachedConditionsOfJoiningAfterCaching() {
     String key = UUID.randomUUID().toString();
 
-    ConditionsOfJoining coj = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9);
+    ConditionsOfJoining coj
+        = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9, Instant.now());
     ConditionsOfJoining cachedCoj = delegate.cacheConditionsOfJoining(key, coj);
     assertThat("Unexpected cached value.", cachedCoj, is(coj));
   }
@@ -72,7 +73,8 @@ void shouldReturnCachedConditionsOfJoiningAfterCaching() {
   void shouldGetCachedConditionsOfJoiningWhenCached() {
     String key = UUID.randomUUID().toString();
 
-    ConditionsOfJoining coj = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9);
+    ConditionsOfJoining coj
+        = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9, Instant.now());
     delegate.cacheConditionsOfJoining(key, coj);
 
     Optional<ConditionsOfJoining> cachedOptional = delegate.getConditionsOfJoining(key);
@@ -83,7 +85,8 @@ void shouldGetCachedConditionsOfJoiningWhenCached() {
   void shouldRemoveConditionsOfJoiningWhenRetrieved() {
     String key = UUID.randomUUID().toString();
 
-    ConditionsOfJoining coj = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9);
+    ConditionsOfJoining coj
+        = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9, Instant.now());
     delegate.cacheConditionsOfJoining(key, coj);
 
     // Ignore this result, the cached value should be evicted.

src/test/java/uk/nhs/hee/trainee/details/service/CachingDelegateTest.java

@@ -42,7 +42,8 @@ void setUp() {
 
   @Test
   void shouldReturnCachedConditionsOfJoining() {
-    ConditionsOfJoining cachedCoj = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9);
+    ConditionsOfJoining cachedCoj
+        = new ConditionsOfJoining(Instant.now(), GoldGuideVersion.GG9, Instant.now());
     ConditionsOfJoining returnedCoj = delegate.cacheConditionsOfJoining("40", cachedCoj);
     assertThat("Unexpected Conditions of Joining.", cachedCoj, is(returnedCoj));
   }