Add formr admin get endpoints #782

EdwardBarclay · 2026-01-12T10:11:49Z

feat: add get endpoints for for R. these are for the admins to use to get a list of all forms or a singular formR

…s-trainee-forms

ReubenRobertsHEE · 2026-01-12T10:50:01Z

@EdwardBarclay would you mind fixing the build/compile issues before a proper review? 😁

EdwardBarclay · 2026-01-12T10:51:56Z

@EdwardBarclay would you mind fixing the build/compile issues before a proper review? 😁

Yep! think I mixed something up when re-doing the PR, sorting out the partB so it gets the id within the service rather then needing a param too

src/main/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartBResource.java

ReubenRobertsHEE · 2026-01-14T09:49:49Z

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAService.java

+    query.addCriteria(Criteria.where("traineeTisId").is(traineeTisId));
+
+    query.addCriteria(Criteria.where("submissionDate").ne(null));
+    query.addCriteria(Criteria.where("status.lifecycleState").ne(LifecycleState.DELETED));


If it were me, I would rather use a parameterised query in the FormRPartARepository for this, it might fit better there (and allows you to avoid using the mongoTemplate directly from the service). e.g. something like

@Query("{ 'traineeTisId': ?0, 'submissionDate': { $ne: null }, 'status.lifecycleState': { $ne: 'DELETED' } }") List<FormRPartA> findNotDraftNorDeletedByTraineeTisId(String traineeTisId);

(excluding DRAFT forms by using the presence of a submissionDate is maybe a bit brittle, I'd rather use the lifecycleState for all conditions, but it's somewhat a matter of taste. Either way, you should be consistent in the criteria used for a single form and a list of forms, to avoid inconsistency. For a single form you are currently using lifecycleState only.)

Also, can you please test locally to confirm that status.lifecycleState is actually the correct term? On my side I would have assumed it was lifecycleState, there is no status subdocument in FormRs.

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java

src/main/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartBResource.java

ReubenRobertsHEE

Looking pretty good. It would be sensible to add some integration tests, in the same way that we have for other endpoints.

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResourceIntegrationTest.java

… get a list of all forms or a singular formR TICKET TIS21-8076 TICKET TIS21-8077 chore: codesmells that arnt consecutive capitalisation TICKET TIS21-8076 TICKET TIS21-8077 test: fix broken tests TICKET TIS21-8076 TICKET TIS21-8077 chore: github comments TICKET TIS21-8076 TICKET TIS21-8077 chore: codesmells TICKET TIS21-8076 TICKET TIS21-8077 test: add service tests TICKET TIS21-8076 TICKET TIS21-8077 feat: fix build errors refactor admins form R part B GET service TICKET TIS21-8076 TICKET TIS21-8077 refactor: remove re-appeared mongo implimentation TICKET TIS21-8076 TICKET TIS21-8077 refactor: change services to return optional of forms instead of nullable, and update tests TICKET TIS21-8076 TICKET TIS21-8077 fix: I forgot to remove the GET params TICKET TIS21-8076 TICKET TIS21-8077 fix: issue with incorrect labling for trainee Id and Id in the repository test: add intergration tests TICKET TIS21-8076 TICKET TIS21-8077 test: add forgotton intergration testing TICKET TIS21-8076 TICKET TIS21-8077 refactor: remove filtering logic from service to be preformed by mongo in the repo. update tests to match changes TICKET TIS21-8076 TICKET TIS21-8077

sonarqubecloud · 2026-01-21T10:19:06Z

Quality Gate passed

Issues
37 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ReubenRobertsHEE · 2026-01-21T13:54:59Z

src/main/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResource.java

+
+    Optional<FormRPartADto> formRPartADto = service.getAdminsFormRPartAById(id);
+
+    formRPartADto.ifPresent(dto ->


As per #782 (comment)

src/main/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartBResource.java

src/test/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAServiceTest.java

ReubenRobertsHEE · 2026-01-21T14:27:55Z

src/test/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAServiceTest.java

+  }
+
+  @Test
+  void shouldGetAdminsFormRPartAByIdWhenSubmitted() {


Because you are mocking the repository function, there is no real value in having these two tests (shouldGetAdminsFormRPartAByIdWhenSubmitted(), shouldGetAdminsFormRPartAByIdWhenUnsubmitted()). If anything, that logic should be tested in repository unit tests, or in the e2e tests.

ReubenRobertsHEE · 2026-01-21T14:32:10Z

src/test/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAServiceTest.java

+
+  @ParameterizedTest(name = "Should return empty when admin form is {0}")
+  @EnumSource(value = LifecycleState.class, names = {"DRAFT", "DELETED"})
+  void shouldReturnEmptyWhenAdminsFormRPartAIsDraftOrDeleted(LifecycleState state) {


Because you don't mock the repository method here, any lifecycle state will return nothing, which means its not testing what you are trying to test.
If you want to test the repository method logic directly, which would be nice, these should go in a repository test class.

src/test/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBServiceTest.java

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResourceIntegrationTest.java

ReubenRobertsHEE · 2026-01-21T14:54:28Z

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResourceIntegrationTest.java

+      GET    | /api/admin/formr-parta/{formId}          | HEE Admin Sensitive
+      GET    | /api/admin/formr-parta/{formId}          | HEE TIS Admin
+      """)
+  void shouldReturnOkWhenRequiredFormFound(HttpMethod method, String uriTemplate,


As you do for the list request tests below, it would be useful to confirm the lifecycleState filter is working correctly for a single form request. In this particular case, lifecycleState == null, which 'passes', but if anything makes me think the filter should be a bit stricter and not allow null lifecycleState forms to be returned!

Repository unit tests could be used to confirm the filters are working as intended, in which case the e2e tests do not need to cover this logic in detail.

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartBResourceIntegrationTest.java

ReubenRobertsHEE · 2026-01-21T15:03:44Z

Sorry @EdwardBarclay, lots of comments - the squash commit sent me back to review everything, you see 😁 😈

EdwardBarclay added 8 commits November 11, 2025 12:29

Merge branch 'main' of https://github.com/Health-Education-England/ti…

17f50f3

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

b41a1c3

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

7d75758

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

2385678

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

93070e0

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

ab2ade0

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

bef276f

…s-trainee-forms

Merge branch 'main' of https://github.com/Health-Education-England/ti…

e8a0f8c

…s-trainee-forms

EdwardBarclay requested review from Judge40 and ReubenRobertsHEE January 12, 2026 10:11

ReubenRobertsHEE reviewed Jan 14, 2026

View reviewed changes

src/main/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartBResource.java Outdated Show resolved Hide resolved

ReubenRobertsHEE reviewed Jan 14, 2026

View reviewed changes

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java Outdated Show resolved Hide resolved

ReubenRobertsHEE reviewed Jan 14, 2026

View reviewed changes

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartAService.java Outdated Show resolved Hide resolved

ReubenRobertsHEE reviewed Jan 14, 2026

View reviewed changes

src/main/java/uk/nhs/hee/tis/trainee/forms/service/FormRPartBService.java Outdated Show resolved Hide resolved

EdwardBarclay requested a review from ReubenRobertsHEE January 16, 2026 09:59

EdwardBarclay force-pushed the add_formr_admin_get_endpoints branch from 7f07966 to 6f173c6 Compare January 16, 2026 09:59

EdwardBarclay marked this pull request as ready for review January 16, 2026 10:01

EdwardBarclay requested a review from a team as a code owner January 16, 2026 10:01

Judge40 requested changes Jan 16, 2026

View reviewed changes

EdwardBarclay force-pushed the add_formr_admin_get_endpoints branch from d051904 to 342a84a Compare January 16, 2026 12:48

EdwardBarclay requested a review from Judge40 January 16, 2026 14:00

Judge40 requested changes Jan 16, 2026

View reviewed changes

EdwardBarclay requested a review from Judge40 January 19, 2026 15:40

ReubenRobertsHEE requested changes Jan 20, 2026

View reviewed changes

EdwardBarclay requested a review from ReubenRobertsHEE January 20, 2026 15:39

ReubenRobertsHEE reviewed Jan 20, 2026

View reviewed changes

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResourceIntegrationTest.java Show resolved Hide resolved

ReubenRobertsHEE reviewed Jan 20, 2026

View reviewed changes

...rationTest/java/uk/nhs/hee/tis/trainee/forms/api/AdminFormRPartAResourceIntegrationTest.java Show resolved Hide resolved

EdwardBarclay force-pushed the add_formr_admin_get_endpoints branch from 8ef972a to e5e7867 Compare January 21, 2026 10:14