Refactor upload service

[hannasage]

Purpose

This PR refactors our common submission functionality, including document uploads and the submission payload, out into its own file complete with a standard function and hook adapter. This unifies the code that handles this intricate process, and creates a uniform developer experience.

Linked Issues to Close

N/A

Approach

First, we established that we'd need two interfaces as we sometimes submit actions from pages with just static data, no form input, and sometimes we submit from pages with said form data via react-hook-form. Check out MedicaidForm and ToggleRaiResponseWithdraw to see this variance.

Next, we ported over the document upload process from the big block of code int he MedicaidForm submit handler function, and split it out into well-named functions for easy maintenance and readability.

Finally, we orchestrated document uploads and form data submission via the main submit function.

Assorted Notes/Considerations/Learning

There is an addition of a map with key/value pairs representing a file's object attribute key and the UI friendly title. If you do not add your attachment type in and it's not currently available in the map, your attachment defaults to the object key (i.e. "cmsForm179" instead of "CMS Form 179")

Examples

For use with react-hook-form:

const handleSubmit: SubmitHandler<MedicaidFormSchema> = async (formData) => {
  try {
    await submit<MedicaidFormSchema>({
      data: formData,
      endpoint: "/submit",
      user,
      authority: Authority.MED_SPA,
    });
    // Open success modal
  } catch (e) {
    console.error(e);
    // Open error modal
  }
};

<form onSubmit={form.handleSubmit(handleSubmit)}> 
   ... 
</form>

For use without any input data or uploaded docs:

const { mutate, isLoading, isSuccess, error } = useSubmissionService<{
  id: string;
}>({
  data: { id: id! },
  endpoint: buildActionUrl(type!),
  user,
});

// Triggers error modal when an error is returned
useEffect(() => if (error) setErrorModalOpen(true), [error]}

<Button onClick={() => {
    mutate()
    // Open success modal
}>Submit</Button>

[hannasage]

@mdial89f @13bfrancis We get one pre-signed URL object back per GROUP of files since every key can hold an array of 1 or more. This was copied functionality from the original approach, but this DOES mean every file in a group associated to a single key is uploaded with the same URL and given the same key. This seems like a flaw, is it?

I believe we should be getting a pre-signed URL per file, not per file group. That way every file has its own upload url and key. But this is making some assumptions about how the upload service and retrieval of a file works.

[hannasage]

@mdial89f Can this be a GET? POST with an empty body seems like we're maybe compensating for an external services requirement, and if that isn't the case, I think we should refactor.

[hannasage]

I like the idea of switch-ing on our endpoint value because it can help us identify areas where our payloads are literally the same, but have a renamed attribute here and there. We should strive to keep this switch to as few special cases as possible and group similar payloads.

For instance, requestedDate and responseDate don't need to be two fields in two payloads...that's just a timestamp. We can derive whether the timestamp is for a response or request based on the action itself.

[13bfrancis]

I like this. If I get my branch deployed and finished you can use that one for testing if you would like

[github-actions]

🎉 This PR is included in version 1.5.0-val.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀