Add data interceptor (#248)

Co-authored-by: Sree P <[email protected]>

Author: lkemperman-cfa

.github/workflows/run-tests.yaml

@@ -29,6 +29,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Set up ChromeDriver
         uses: nanasess/[email protected]
+        with:
+          chromedriver-version: '115.0.5790.102'
       - name: Set up JDK
         uses: actions/[email protected]
         with:
@@ -78,6 +80,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Set up ChromeDriver
         uses: nanasess/[email protected]
+        with:
+          chromedriver-version: '115.0.5790.102'
       - name: Set up JDK
         uses: actions/setup-java@v1
         with:

src/main/java/org/ladocuploader/app/config/DataRequiredHandlerConfiguration.java

@@ -0,0 +1,19 @@
+package org.ladocuploader.app.config;
+
+import formflow.library.data.SubmissionRepositoryService;
+import org.ladocuploader.app.interceptors.DataRequiredInterceptor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Configuration
+public class DataRequiredHandlerConfiguration implements WebMvcConfigurer {
+    @Autowired
+    SubmissionRepositoryService submissionRepositoryService;
+
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(new DataRequiredInterceptor(this.submissionRepositoryService)).addPathPatterns(DataRequiredInterceptor.PATH_FORMAT);
+    }
+}

src/main/java/org/ladocuploader/app/config/SecurityConfiguration.java

@@ -2,14 +2,17 @@
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.security.config.Customizer;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.web.SecurityFilterChain;
 
 @Configuration
 public class SecurityConfiguration {
     @Bean
     public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
-        http.httpBasic().disable();
+        http.
+                httpBasic(Customizer.withDefaults()
+                );
         return http.build();
     }
 }

src/main/java/org/ladocuploader/app/filters/LoggingFilter.java

@@ -29,6 +29,7 @@ public void doFilter(ServletRequest servletRequest, ServletResponse servletRespo
     MDC.put("sessionCreatedAt", new DateTime(request.getSession().getCreationTime()).toString("HH:mm:ss.SSS"));
     MDC.put("method", request.getMethod());
     MDC.put("request", request.getRequestURI());
+    MDC.put("ip", request.getRemoteAddr());
     filterChain.doFilter(servletRequest, servletResponse);
     MDC.clear();
   }

src/main/java/org/ladocuploader/app/interceptors/DataRequiredInterceptor.java

@@ -0,0 +1,75 @@
+package org.ladocuploader.app.interceptors;
+
+import formflow.library.data.SubmissionRepositoryService;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+import org.springframework.util.AntPathMatcher;
+import org.springframework.web.servlet.HandlerInterceptor;
+
+import java.util.Map;
+import java.util.UUID;
+
+@Component
+@Slf4j
+public class DataRequiredInterceptor implements HandlerInterceptor {
+    public static final String PATH_FORMAT = "/flow/{flow}/{screen}";
+    private final SubmissionRepositoryService submissionRepositoryService;
+    private static final Map<String, String> REQUIRED_DATA = Map.ofEntries(
+            // Step 1
+            Map.entry("howToAddDocuments", "firstName"),
+            Map.entry("uploadDocuments", "firstName"),
+            Map.entry("docSubmitConfirmation", "firstName"),
+            Map.entry("finalConfirmation", "firstName")
+    );
+
+    public DataRequiredInterceptor(SubmissionRepositoryService submissionRepositoryService) {
+        this.submissionRepositoryService = submissionRepositoryService;
+    }
+
+    @Override
+    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
+        try {
+            var parsedUrl = new AntPathMatcher().extractUriTemplateVariables(PATH_FORMAT, request.getRequestURI());
+            var requiredData = REQUIRED_DATA.get(parsedUrl.get("screen"));
+            String redirect_url = String.format("/flow/laDocUpload/clientInfo?intercepted=%s", parsedUrl.get("screen"));
+            if (requiredData == null) {
+                return true; // There are no data requirements for this page
+            }
+
+            var session = request.getSession(false);
+            if (session == null) {
+                log.info("No session present (missing field data %s), redirecting to clientInfo page".formatted(requiredData));
+                response.sendRedirect(redirect_url);
+
+                return false;
+            }
+
+            var submissionId = (UUID) session.getAttribute("id");
+            if (submissionId != null) {
+                var submissionMaybe = this.submissionRepositoryService.findById(submissionId);
+                if (submissionMaybe.isPresent()) {
+                    var submission = submissionMaybe.get();
+                    if (submission.getInputData().getOrDefault(requiredData, "").toString().isBlank()) {
+                        log.error("Submission %s missing field data %s, redirecting to clientInfo page".formatted(submissionId, requiredData));
+                        response.sendRedirect(redirect_url);
+                        return false;
+                    }
+                } else {
+                    log.error("Submission %s not found in database (required field %s), redirecting to clientInfo page".formatted(submissionId, requiredData));
+                    response.sendRedirect(redirect_url);
+                    return false;
+                }
+            } else {
+                log.error("No submission ID in session (required field %s), redirecting to clientInfo page".formatted(requiredData));
+                response.sendRedirect(redirect_url);
+                return false;
+            }
+
+            return true;
+        } catch (IllegalStateException e) {
+            return true;
+        }
+    }
+}

src/main/resources/messages.properties

@@ -5,6 +5,7 @@ general.files.add-your-files=Add files
 general.files.file-added.one=1 file added ({0} max)
 general.files.file-added.other={0} files added ({1} max)
 general.files.confirm-delete=You are about to delete your file called {0}. Is that okay?
+general.missing-info=Something went wrong. Please re-enter your information.
 general.files.uploaded-documents=Uploaded documents
 general.delete=delete
 general.cancel=Cancel

src/main/resources/templates/fragments/fileUploader.html

@@ -63,7 +63,7 @@
     window['myDropZone' + [[${inputName}]]] = null;
     window['userFileIds' + [[${inputName}]]] = [];
     window['cancelledFiles' + [[${inputName}]]] = [];
-    var userFiles = [[${session.userFiles}]]
+    var userFiles = [[${session.userFiles ?: ''}]]
     var thumbnailWidthFromAppYml = [[${@environment.getProperty('form-flow.uploads.thumbnail-width')}]];
     var thumbnailHeightFromAppYml = [[${@environment.getProperty('form-flow.uploads.thumbnail-height')}]];
     var thumbnailWidth = thumbnailWidthFromAppYml ? thumbnailWidthFromAppYml : '64';
@@ -235,7 +235,6 @@
     }
 
     $("#document-upload-" + [[${inputName}]]).dropzone({
-      // TODO: use a variable? Use to get it from the id being on the form element
       url: "/file-upload",
       uploadMultiple: false,
       previewsContainer: [[${'#document-upload-' + inputName}]] + " .preview-container",
@@ -431,7 +430,8 @@
       },
       error: function (file, errorMessage, xhr) {
         if (xhr && xhr.response) {
-          file.previewElement.getElementsByClassName("text--error")[0].innerText = xhr.response;
+          // redirect to client info page with intercepted param for error popup
+          location.href = "/flow/laDocUpload/clientInfo?intercepted=uploadDocuments"
         } else {
           var message = errorMessage.error ? errorMessage.error : errorMessage;
           file.previewElement.getElementsByClassName("text--error")[0].innerText = message;

src/main/resources/templates/fragments/mixpanelTracking.html

@@ -17,6 +17,17 @@
   const ref_id = ref_id_param ? ref_id_param : '[[${submission == null ? "" : submission.getUrlParams().getOrDefault("ref_id", "")}]]'
   const ref_id_sanitized = ref_id.replaceAll("[^a-zA-Z0-9]", "");
 
+    const intercepted_param = window.location.href.includes("?intercepted=") ? window.location.href.split("?intercepted=")[1].split('&')[0] : null
+
+   if (intercepted_param) {
+       mixpanel.track("error",
+           {
+            error_message: 'Something went wrong. Please re-enter your information.',
+            error_location: intercepted_param
+           }
+    )
+   }
+
   if ((ref_id_sanitized.startsWith("T")) && (ref_id_sanitized.length === 11)){
       tracking_params.ref_id = ref_id_sanitized
   }

src/main/resources/templates/fragments/toolbar.html

@@ -24,6 +24,10 @@
                   }
               })
 
+              $(".flash__dismiss").on("click", function (e) {
+                $(this).parent()[0].setAttribute("class", "display-none");
+              })
+
           });
       </script>
       <div th:replace="~{fragments/localeSelect :: localeSelect}"></div>

src/main/resources/templates/laDocUpload/clientInfo.html

@@ -8,6 +8,12 @@
     <div class="grid">
       <div th:replace="~{fragments/goBack :: goBackLink}"></div>
       <main id="content" role="main" class="form-card spacing-above-35">
+        <div class="intercept-error-container">
+          <div class="flash flash--error" id="client-info-missing" th:if="${param.intercepted != null}" >
+            <p class="flash__message" th:text="#{general.missing-info}"></p>
+            <a href="#" class="flash__dismiss" aria-label="Dismiss"><span class="icon icon-close"></span></a>
+          </div>
+        </div>
         <th:block th:replace="~{fragments/icons :: matchInfo}"></th:block>
         <th:block
             th:replace="~{fragments/cardHeader :: cardHeader(header=#{client-info.header}, subtext=#{client-info.subtext})}"/>