[JN-1650] redirect user back to pre-enroll if enrollment fails (#1551)

Author: connorlbark

core/src/main/java/bio/terra/pearl/core/dao/survey/SurveyDao.java

@@ -2,6 +2,7 @@
 
 import bio.terra.pearl.core.dao.BaseVersionedJdbiDao;
 import bio.terra.pearl.core.model.survey.Survey;
+import bio.terra.pearl.core.model.survey.SurveyType;
 import org.jdbi.v3.core.Jdbi;
 import org.springframework.stereotype.Component;
 
@@ -146,4 +147,18 @@ public List<Survey> findActivePreEnrolleeSurveysByPortalId(UUID portalId) {
                         .list()
         );
     }
+
+    public List<Survey> findActiveInStudyEnvWithType(UUID studyEnvId, SurveyType type) {
+        return jdbi.withHandle(handle ->
+                handle.createQuery("""
+                                select s.* from survey s
+                                inner join study_environment_survey ses on s.id = ses.survey_id and ses.active = true
+                                where ses.study_environment_id = :studyEnvId and s.survey_type = :type
+                                """)
+                        .bind("studyEnvId", studyEnvId)
+                        .bind("type", type)
+                        .mapTo(clazz)
+                        .list()
+        );
+    }
 }

core/src/main/java/bio/terra/pearl/core/service/survey/SurveyService.java

@@ -9,6 +9,7 @@
 import bio.terra.pearl.core.model.survey.AnswerMapping;
 import bio.terra.pearl.core.model.survey.Survey;
 import bio.terra.pearl.core.model.survey.SurveyQuestionDefinition;
+import bio.terra.pearl.core.model.survey.SurveyType;
 import bio.terra.pearl.core.service.CascadeProperty;
 import bio.terra.pearl.core.service.VersionedEntityService;
 import bio.terra.pearl.core.service.exception.NotFoundException;
@@ -228,4 +229,8 @@ public List<Survey> findActiveSurveysByPortalId(UUID portalId) {
 
         return surveys;
     }
+
+    public List<Survey> findActiveInStudyEnvWithType(UUID studyEnvId, SurveyType type) {
+        return dao.findActiveInStudyEnvWithType(studyEnvId, type);
+    }
 }

core/src/main/java/bio/terra/pearl/core/service/workflow/EnrollmentService.java

@@ -148,6 +148,10 @@ public HubResponse<Enrollee> enroll(PortalParticipantUser operator,
         if (!studyEnvConfig.isAcceptingEnrollment()) {
             throw new IllegalArgumentException("study %s is not accepting enrollment".formatted(studyShortcode));
         }
+        if (preEnrollResponseId == null && hasRequiredPreEnroll(studyEnv.getId())) {
+            throw new IllegalArgumentException("user did not complete required pre-enrollment survey");
+        }
+
         PreEnrollmentResponse preEnrollResponse = validatePreEnrollResponse(operator, studyEnv, preEnrollResponseId, user.getId(), isSubject);
 
         // if the user is signed up, but not a subject, we can just return the existing enrollee,
@@ -170,6 +174,12 @@ public HubResponse<Enrollee> enroll(PortalParticipantUser operator,
         return hubResponse;
     }
 
+    private boolean hasRequiredPreEnroll(UUID studyEnvId) {
+        // should be a single pre-enroll survey, but we'll check all of them
+        List<Survey> preEnrolls = surveyService.findActiveInStudyEnvWithType(studyEnvId, SurveyType.PRE_ENROLL);
+        return preEnrolls.stream().anyMatch(Survey::isRequired);
+    }
+
     private Enrollee findOrCreateEnrolleeForEnrollment(ParticipantUser user, PortalParticipantUser ppUser, StudyEnvironment studyEnv,
                                                        String studyShortcode, UUID preEnrollResponseId, boolean isSubjectEnrollment,
                                                        EnrolleeSourceType source) {

core/src/test/java/bio/terra/pearl/core/service/workflow/EnrollmentServiceTests.java

@@ -26,7 +26,6 @@
 import bio.terra.pearl.core.service.study.StudyService;
 import bio.terra.pearl.core.service.survey.SurveyResponseService;
 import com.fasterxml.jackson.core.JsonProcessingException;
-import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInfo;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -37,6 +36,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 public class EnrollmentServiceTests extends BaseSpringBootTest {
     @Autowired
@@ -134,6 +134,30 @@ public void testEnrollDoesNotRequirePreEnroll(TestInfo testInfo) {
         assertThat(hubResponse.getEnrollee(), notNullValue());
     }
 
+    @Test
+    @Transactional
+    public void testEnrollRequiresPreEnrollIfSurveyRequired(TestInfo testInfo) {
+        PortalEnvironment portalEnv = portalEnvironmentFactory.buildPersisted(getTestName(testInfo));
+        StudyEnvironment studyEnv = studyEnvironmentFactory.buildPersisted(portalEnv, getTestName(testInfo));
+        Survey survey = surveyFactory.buildPersisted(surveyFactory.builder(getTestName(testInfo))
+                .surveyType(SurveyType.PRE_ENROLL)
+                .required(true)
+                .portalId(portalEnv.getPortalId()));
+        surveyFactory.attachToEnv(survey, studyEnv.getId(), true);
+        ParticipantUserFactory.ParticipantUserAndPortalUser userBundle = participantUserFactory.buildPersisted(portalEnv,
+                getTestName(testInfo));
+        String studyShortcode = studyService.find(studyEnv.getStudyId()).get().getShortcode();
+
+
+        assertThrows(
+                IllegalArgumentException.class,
+                () -> {
+                    enrollmentService.enroll(userBundle.ppUser(), studyEnv.getEnvironmentName(), studyShortcode,
+                            userBundle.user(), userBundle.ppUser(), null, false);
+                });
+
+    }
+
     @Test
     @Transactional
     public void testEnrollChecksConfigAllowsEnrollment(TestInfo testInfo) {
@@ -148,7 +172,7 @@ public void testEnrollChecksConfigAllowsEnrollment(TestInfo testInfo) {
                 getTestName(testInfo));
         String studyShortcode = studyService.find(studyEnv.getStudyId()).get().getShortcode();
         String portalShortcode = portalService.find(portalEnv.getPortalId()).get().getShortcode();
-        Assertions.assertThrows(IllegalArgumentException.class, () -> {
+        assertThrows(IllegalArgumentException.class, () -> {
             enrollmentService.enroll(userBundle.ppUser(), studyEnv.getEnvironmentName(), studyShortcode, userBundle.user(), userBundle.ppUser(),
                     null, false);
         });