Merge pull request #246 from Eastern-Research-Group/develop

Sync staging with develop
USEPA · Nov 2, 2022 · 5fe3b7a · 5fe3b7a
2 parents a2f607e + a08eea3
commit 5fe3b7a
Show file tree

Hide file tree

Showing 47 changed files with 4,558 additions and 2,240 deletions.
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -45,7 +45,8 @@ jobs:
       FORMIO_PKG_AUTH_TOKEN: ${{ secrets.FORMIO_PKG_AUTH_TOKEN }}
       FORMIO_BASE_URL: ${{ secrets.FORMIO_BASE_URL }}
       FORMIO_PROJECT_NAME: ${{ secrets.FORMIO_PROJECT_NAME }}
-      FORMIO_FORM_NAME: ${{ secrets.FORMIO_FORM_NAME }}
+      FORMIO_APPLICATION_FORM_PATH: ${{ secrets.FORMIO_APPLICATION_FORM_PATH }}
+      FORMIO_PAYMENT_REQUEST_FORM_PATH: ${{ secrets.FORMIO_PAYMENT_REQUEST_FORM_PATH }}
       FORMIO_API_KEY: ${{ secrets.FORMIO_API_KEY }}
       BAP_CLIENT_ID: ${{ secrets.BAP_CLIENT_ID }}
       BAP_CLIENT_SECRET: ${{ secrets.BAP_CLIENT_SECRET }}
@@ -54,6 +55,7 @@ jobs:
       BAP_PASSWORD: ${{ secrets.BAP_PASSWORD }}
       BAP_SAM_TABLE: ${{ secrets.BAP_SAM_TABLE }}
       BAP_FORMS_TABLE: ${{ secrets.BAP_FORMS_TABLE }}
+      BAP_BUS_TABLE: ${{ secrets.BAP_BUS_TABLE }}
       AWS_ACCESS_KEY_ID: ${{ secrets.S3_PUBLIC_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_PUBLIC_SECRET_ACCESS_KEY }}
       AWS_DEFAULT_REGION: ${{ secrets.S3_PUBLIC_REGION }}
@@ -122,7 +124,8 @@ jobs:
           cf set-env $APP_NAME "CSB_ENROLLMENT_PERIOD" "$CSB_ENROLLMENT_PERIOD" > /dev/null
           cf set-env $APP_NAME "FORMIO_BASE_URL" "$FORMIO_BASE_URL" > /dev/null
           cf set-env $APP_NAME "FORMIO_PROJECT_NAME" "$FORMIO_PROJECT_NAME" > /dev/null
-          cf set-env $APP_NAME "FORMIO_FORM_NAME" "$FORMIO_FORM_NAME" > /dev/null
+          cf set-env $APP_NAME "FORMIO_APPLICATION_FORM_PATH" "$FORMIO_APPLICATION_FORM_PATH" > /dev/null
+          cf set-env $APP_NAME "FORMIO_PAYMENT_REQUEST_FORM_PATH" "$FORMIO_PAYMENT_REQUEST_FORM_PATH" > /dev/null
           cf set-env $APP_NAME "FORMIO_API_KEY" "$FORMIO_API_KEY" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_ID" "$BAP_CLIENT_ID" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_SECRET" "$BAP_CLIENT_SECRET" > /dev/null
@@ -131,6 +134,7 @@ jobs:
           cf set-env $APP_NAME "BAP_PASSWORD" "$BAP_PASSWORD" > /dev/null
           cf set-env $APP_NAME "BAP_SAM_TABLE" "$BAP_SAM_TABLE" > /dev/null
           cf set-env $APP_NAME "BAP_FORMS_TABLE" "$BAP_FORMS_TABLE" > /dev/null
+          cf set-env $APP_NAME "BAP_BUS_TABLE" "$BAP_BUS_TABLE" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_BUCKET" "$S3_PUBLIC_BUCKET" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_REGION" "$AWS_DEFAULT_REGION" > /dev/null
 

diff --git a/.github/workflows/proto.yml b/.github/workflows/proto.yml
@@ -40,11 +40,12 @@ jobs:
       SAML_PUBLIC_KEY: ${{ secrets.SAML_PUBLIC_KEY }}
       JWT_PUBLIC_KEY: ${{ secrets.JWT_PUBLIC_KEY }}
       JWT_PRIVATE_KEY: ${{ secrets.JWT_PRIVATE_KEY }}
-      CSB_ENROLLMENT_PERIOD: closed
+      CSB_ENROLLMENT_PERIOD: open
       FORMIO_PKG_AUTH_TOKEN: ${{ secrets.FORMIO_PKG_AUTH_TOKEN }}
       FORMIO_BASE_URL: ${{ secrets.FORMIO_BASE_URL }}
       FORMIO_PROJECT_NAME: ${{ secrets.FORMIO_PROJECT_NAME }}
-      FORMIO_FORM_NAME: ${{ secrets.FORMIO_FORM_NAME }}
+      FORMIO_APPLICATION_FORM_PATH: ${{ secrets.FORMIO_APPLICATION_FORM_PATH }}
+      FORMIO_PAYMENT_REQUEST_FORM_PATH: ${{ secrets.FORMIO_PAYMENT_REQUEST_FORM_PATH }}
       FORMIO_API_KEY: ${{ secrets.FORMIO_API_KEY }}
       BAP_CLIENT_ID: ${{ secrets.BAP_CLIENT_ID }}
       BAP_CLIENT_SECRET: ${{ secrets.BAP_CLIENT_SECRET }}
@@ -53,6 +54,7 @@ jobs:
       BAP_PASSWORD: ${{ secrets.BAP_PASSWORD }}
       BAP_SAM_TABLE: ${{ secrets.BAP_SAM_TABLE }}
       BAP_FORMS_TABLE: ${{ secrets.BAP_FORMS_TABLE }}
+      BAP_BUS_TABLE: ${{ secrets.BAP_BUS_TABLE }}
       AWS_ACCESS_KEY_ID: ${{ secrets.S3_PUBLIC_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_PUBLIC_SECRET_ACCESS_KEY }}
       AWS_DEFAULT_REGION: ${{ secrets.S3_PUBLIC_REGION }}
@@ -120,7 +122,8 @@ jobs:
           cf set-env $APP_NAME "CSB_ENROLLMENT_PERIOD" "$CSB_ENROLLMENT_PERIOD" > /dev/null
           cf set-env $APP_NAME "FORMIO_BASE_URL" "$FORMIO_BASE_URL" > /dev/null
           cf set-env $APP_NAME "FORMIO_PROJECT_NAME" "$FORMIO_PROJECT_NAME" > /dev/null
-          cf set-env $APP_NAME "FORMIO_FORM_NAME" "$FORMIO_FORM_NAME" > /dev/null
+          cf set-env $APP_NAME "FORMIO_APPLICATION_FORM_PATH" "$FORMIO_APPLICATION_FORM_PATH" > /dev/null
+          cf set-env $APP_NAME "FORMIO_PAYMENT_REQUEST_FORM_PATH" "$FORMIO_PAYMENT_REQUEST_FORM_PATH" > /dev/null
           cf set-env $APP_NAME "FORMIO_API_KEY" "$FORMIO_API_KEY" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_ID" "$BAP_CLIENT_ID" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_SECRET" "$BAP_CLIENT_SECRET" > /dev/null
@@ -129,6 +132,7 @@ jobs:
           cf set-env $APP_NAME "BAP_PASSWORD" "$BAP_PASSWORD" > /dev/null
           cf set-env $APP_NAME "BAP_SAM_TABLE" "$BAP_SAM_TABLE" > /dev/null
           cf set-env $APP_NAME "BAP_FORMS_TABLE" "$BAP_FORMS_TABLE" > /dev/null
+          cf set-env $APP_NAME "BAP_BUS_TABLE" "$BAP_BUS_TABLE" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_BUCKET" "$S3_PUBLIC_BUCKET" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_REGION" "$AWS_DEFAULT_REGION" > /dev/null
 

diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml
@@ -45,7 +45,8 @@ jobs:
       FORMIO_PKG_AUTH_TOKEN: ${{ secrets.FORMIO_PKG_AUTH_TOKEN }}
       FORMIO_BASE_URL: ${{ secrets.FORMIO_BASE_URL }}
       FORMIO_PROJECT_NAME: ${{ secrets.FORMIO_PROJECT_NAME }}
-      FORMIO_FORM_NAME: ${{ secrets.FORMIO_FORM_NAME }}
+      FORMIO_APPLICATION_FORM_PATH: ${{ secrets.FORMIO_APPLICATION_FORM_PATH }}
+      FORMIO_PAYMENT_REQUEST_FORM_PATH: ${{ secrets.FORMIO_PAYMENT_REQUEST_FORM_PATH }}
       FORMIO_API_KEY: ${{ secrets.FORMIO_API_KEY }}
       BAP_CLIENT_ID: ${{ secrets.BAP_CLIENT_ID }}
       BAP_CLIENT_SECRET: ${{ secrets.BAP_CLIENT_SECRET }}
@@ -54,6 +55,7 @@ jobs:
       BAP_PASSWORD: ${{ secrets.BAP_PASSWORD }}
       BAP_SAM_TABLE: ${{ secrets.BAP_SAM_TABLE }}
       BAP_FORMS_TABLE: ${{ secrets.BAP_FORMS_TABLE }}
+      BAP_BUS_TABLE: ${{ secrets.BAP_BUS_TABLE }}
       AWS_ACCESS_KEY_ID: ${{ secrets.S3_PUBLIC_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_PUBLIC_SECRET_ACCESS_KEY }}
       AWS_DEFAULT_REGION: ${{ secrets.S3_PUBLIC_REGION }}
@@ -122,7 +124,8 @@ jobs:
           cf set-env $APP_NAME "CSB_ENROLLMENT_PERIOD" "$CSB_ENROLLMENT_PERIOD" > /dev/null
           cf set-env $APP_NAME "FORMIO_BASE_URL" "$FORMIO_BASE_URL" > /dev/null
           cf set-env $APP_NAME "FORMIO_PROJECT_NAME" "$FORMIO_PROJECT_NAME" > /dev/null
-          cf set-env $APP_NAME "FORMIO_FORM_NAME" "$FORMIO_FORM_NAME" > /dev/null
+          cf set-env $APP_NAME "FORMIO_APPLICATION_FORM_PATH" "$FORMIO_APPLICATION_FORM_PATH" > /dev/null
+          cf set-env $APP_NAME "FORMIO_PAYMENT_REQUEST_FORM_PATH" "$FORMIO_PAYMENT_REQUEST_FORM_PATH" > /dev/null
           cf set-env $APP_NAME "FORMIO_API_KEY" "$FORMIO_API_KEY" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_ID" "$BAP_CLIENT_ID" > /dev/null
           cf set-env $APP_NAME "BAP_CLIENT_SECRET" "$BAP_CLIENT_SECRET" > /dev/null
@@ -131,6 +134,7 @@ jobs:
           cf set-env $APP_NAME "BAP_PASSWORD" "$BAP_PASSWORD" > /dev/null
           cf set-env $APP_NAME "BAP_SAM_TABLE" "$BAP_SAM_TABLE" > /dev/null
           cf set-env $APP_NAME "BAP_FORMS_TABLE" "$BAP_FORMS_TABLE" > /dev/null
+          cf set-env $APP_NAME "BAP_BUS_TABLE" "$BAP_BUS_TABLE" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_BUCKET" "$S3_PUBLIC_BUCKET" > /dev/null
           cf set-env $APP_NAME "S3_PUBLIC_REGION" "$AWS_DEFAULT_REGION" > /dev/null
 

diff --git a/app/client/src/components/app.tsx b/app/client/src/components/app.tsx
@@ -18,40 +18,43 @@ import "@formio/choices.js/public/assets/styles/choices.min.css";
 import "@formio/premium/dist/premium.css";
 import "formiojs/dist/formio.full.min.css";
 // ---
-import { serverBasePath, serverUrl, cloudSpace, fetchData } from "../config";
-import Loading from "components/loading";
-import MarkdownContent from "components/markdownContent";
-import Welcome from "components/welcome";
-import Dashboard from "components/dashboard";
-import ConfirmationDialog from "components/confirmationDialog";
-import Helpdesk from "routes/helpdesk";
-import AllRebates from "routes/allRebates";
-import NewRebate from "routes/newRebate";
-import ExistingRebate from "routes/existingRebate";
+import { serverBasePath, serverUrl, cloudSpace, getData } from "../config";
+import { Loading } from "components/loading";
+import { MarkdownContent } from "components/markdownContent";
+import { Welcome } from "routes/welcome";
+import { Dashboard } from "components/dashboard";
+import { ConfirmationDialog } from "components/confirmationDialog";
+import { Helpdesk } from "routes/helpdesk";
+import { AllRebates } from "routes/allRebates";
+import { NewApplicationForm } from "routes/newApplicationForm";
+import { ApplicationForm } from "routes/applicationForm";
+import { PaymentRequestForm } from "routes/paymentRequestForm";
 import { useContentState, useContentDispatch } from "contexts/content";
-import { useUserState, useUserDispatch } from "contexts/user";
 import { useDialogDispatch, useDialogState } from "contexts/dialog";
+import { useUserState, useUserDispatch } from "contexts/user";
+
+type FetchStatus = "idle" | "pending" | "success" | "failure";
 
-// Custom hook to fetch static content
+/** Custom hook to fetch static content */
 function useFetchedContent() {
-  const dispatch = useContentDispatch();
+  const contentDispatch = useContentDispatch();
 
   useEffect(() => {
-    dispatch({ type: "FETCH_CONTENT_REQUEST" });
-    fetchData(`${serverUrl}/api/content`)
+    contentDispatch({ type: "FETCH_CONTENT_REQUEST" });
+    getData(`${serverUrl}/api/content`)
       .then((res) => {
-        dispatch({
+        contentDispatch({
           type: "FETCH_CONTENT_SUCCESS",
           payload: res,
         });
       })
       .catch((err) => {
-        dispatch({ type: "FETCH_CONTENT_FAILURE" });
+        contentDispatch({ type: "FETCH_CONTENT_FAILURE" });
       });
-  }, [dispatch]);
+  }, [contentDispatch]);
 }
 
-// Custom hook to display a site-wide alert banner
+/** Custom hook to display a site-wide alert banner */
 function useSiteAlertBanner() {
   const { content } = useContentState();
 
@@ -89,7 +92,7 @@ function useSiteAlertBanner() {
   }, [content]);
 }
 
-// Custom hook to display the CSB disclaimer banner for development/staging
+/** Custom hook to display the CSB disclaimer banner for development/staging */
 function useDisclaimerBanner() {
   useEffect(() => {
     if (!(cloudSpace === "dev" || cloudSpace === "staging")) return;
@@ -112,29 +115,28 @@ function useDisclaimerBanner() {
   }, []);
 }
 
-// Custom hook to set up inactivity timer to auto-logout user if they're inactive for >15 minutes
+/** Custom hook to set up inactivity timer to auto-logout user if they're inactive for >15 minutes */
 function useInactivityDialog(callback: () => void) {
   const { epaUserData } = useUserState();
   const { dialogShown, heading } = useDialogState();
-  const dispatch = useDialogDispatch();
+  const dialogDispatch = useDialogDispatch();
 
-  /**
-   * Initial time (in seconds) used in the warning countdown timer.
-   */
-  const warningTime = 60;
-  const [logoutTimer, setLogoutTimer] = useState(warningTime);
+  /** Initial time (seconds) used in the logout countdown timer */
+  const initialCountdownSeconds = 60;
+
+  const [logoutTimer, setLogoutTimer] = useState(initialCountdownSeconds);
 
   /**
-   * One minute less than our intended timeout (14 instead of 15) so that onIdle
-   * is called and displays a 60-second warning modal to keep user logged in.
+   * One minute less than our intended 15 minute timeout, so `onIdle` is called
+   * and displays a 60 second warning modal to keep user logged in.
    */
-  const timeout = 14 * 60 * 1000; // 14 minutes to millisecond
+  const timeout = 14 * 60 * 1000; // 14 minutes in milliseconds
 
   const { reset } = useIdleTimer({
     timeout,
     onIdle: () => {
-      // Display 60-second countdown dialog after 14 minutes of idle time
-      dispatch({
+      // display 60 second countdown dialog after 14 minutes of idle time
+      dialogDispatch({
         type: "DISPLAY_DIALOG",
         payload: {
           dismissable: false,
@@ -150,22 +152,22 @@ function useInactivityDialog(callback: () => void) {
     },
     onAction: () => {
       if (!dialogShown) {
-        // Reset logout timer if user confirmed activity
-        // (so countdown starts over on next inactive warning)
-        setLogoutTimer(warningTime);
+        // keep logout timer at initial countdown time if the dialog isn't shown
+        // (so logout timer is ready for the next inactive warning)
+        setLogoutTimer(initialCountdownSeconds);
       }
 
-      /**
-       * If user makes action and the JWT is set to expire within 3 minutes,
-       * call the callback (hit the /epa-data endpoint) to refresh the JWT
-       */
       if (epaUserData.status !== "success") return;
 
-      const jwtRefreshWindow = 180; // in seconds
-      const exp = epaUserData.data.exp;
-      const timeToExpire = exp - Date.now() / 1000;
+      const { exp } = epaUserData.data; // seconds
+      const timeToExpire = exp - Date.now() / 1000; // seconds
+      const threeMinutes = 180; // seconds
 
-      if (timeToExpire < jwtRefreshWindow) {
+      /**
+       * If user makes action and the JWT is set to expire within 3 minutes,
+       * call the callback (access "/epa-user-data") to refresh the JWT
+       */
+      if (timeToExpire < threeMinutes) {
         callback();
         reset();
       }
@@ -175,36 +177,35 @@ function useInactivityDialog(callback: () => void) {
   });
 
   useEffect(() => {
+    // update inactivity warning dialog's time remaining every second
     if (dialogShown && heading === "Inactivity Warning") {
       setTimeout(() => {
-        setLogoutTimer((count: number) => (count > 0 ? count - 1 : count));
-        dispatch({
+        setLogoutTimer((time: number) => (time > 0 ? time - 1 : time));
+        dialogDispatch({
           type: "UPDATE_DIALOG_DESCRIPTION",
           payload: {
-            description: `You will be automatically logged out in ${
-              logoutTimer - 1
-            } seconds due to inactivity.`,
+            description:
+              `You will be automatically logged out in ` +
+              `${logoutTimer - 1} seconds due to inactivity.`,
           },
         });
       }, 1000);
     }
 
-    // Log user out from server if inactivity countdown reaches 0
+    // log user out from server if inactivity countdown reaches 0
     if (logoutTimer === 0) {
       window.location.href = `${serverUrl}/logout?RelayState=/welcome?info=timeout`;
     }
-  }, [dialogShown, heading, logoutTimer, dispatch]);
+  }, [dialogShown, heading, logoutTimer, dialogDispatch]);
 }
 
-// Custom hook to check if user should have access to helpdesk pages
+/** Custom hook to check if user should have access to helpdesk pages */
 export function useHelpdeskAccess() {
-  const [helpdeskAccess, setHelpdeskAccess] = useState<
-    "idle" | "pending" | "success" | "failure"
-  >("idle");
+  const [helpdeskAccess, setHelpdeskAccess] = useState<FetchStatus>("idle");
 
   useEffect(() => {
     setHelpdeskAccess("pending");
-    fetchData(`${serverUrl}/api/helpdesk-access`)
+    getData(`${serverUrl}/api/helpdesk-access`)
       .then((res) => setHelpdeskAccess("success"))
       .catch((err) => setHelpdeskAccess("failure"));
   }, []);
@@ -216,28 +217,32 @@ export function useHelpdeskAccess() {
 function ProtectedRoute({ children }: { children: JSX.Element }) {
   const { pathname } = useLocation();
   const { isAuthenticating, isAuthenticated } = useUserState();
-  const dispatch = useUserDispatch();
+  const userDispatch = useUserDispatch();
 
-  // Check if user is already logged in or needs to be redirected to /welcome route
+  // check if user is already logged in or needs to be logged out (which will
+  // redirect them to the "/welcome" route)
   const verifyUser = useCallback(() => {
-    fetchData(`${serverUrl}/api/epa-data`)
+    getData(`${serverUrl}/api/epa-user-data`)
       .then((res) => {
-        dispatch({
+        userDispatch({
           type: "FETCH_EPA_USER_DATA_SUCCESS",
           payload: { epaUserData: res },
         });
-        dispatch({ type: "USER_SIGN_IN" });
+        userDispatch({ type: "USER_SIGN_IN" });
       })
       .catch((err) => {
-        dispatch({ type: "FETCH_EPA_USER_DATA_FAILURE" });
-        dispatch({ type: "USER_SIGN_OUT" });
+        userDispatch({ type: "FETCH_EPA_USER_DATA_FAILURE" });
+        userDispatch({ type: "USER_SIGN_OUT" });
       });
-  }, [dispatch]);
+  }, [userDispatch]);
 
+  // NOTE: even though `pathname` isn't used in the effect below, it's being
+  // included it in the dependency array as we want to verify the user's access
+  // any time a route changes
   useEffect(() => {
-    dispatch({ type: "FETCH_EPA_USER_DATA_REQUEST" });
+    userDispatch({ type: "FETCH_EPA_USER_DATA_REQUEST" });
     verifyUser();
-  }, [verifyUser, dispatch, pathname]);
+  }, [userDispatch, verifyUser, pathname]);
 
   useInactivityDialog(verifyUser);
 
@@ -257,7 +262,7 @@ function ProtectedRoute({ children }: { children: JSX.Element }) {
   );
 }
 
-export default function App() {
+export function App() {
   useFetchedContent();
   useSiteAlertBanner();
   useDisclaimerBanner();
@@ -288,8 +293,12 @@ export default function App() {
             displayed.
           */}
           <Route path="helpdesk" element={<Helpdesk />} />
-          <Route path="rebate/new" element={<NewRebate />} />
-          <Route path="rebate/:id" element={<ExistingRebate />} />
+          <Route path="rebate/new" element={<NewApplicationForm />} />
+          <Route path="rebate/:mongoId" element={<ApplicationForm />} />
+          <Route
+            path="payment-request/:rebateId"
+            element={<PaymentRequestForm />}
+          />
           <Route path="*" element={<Navigate to="/" replace />} />
         </Route>
       </Routes>