[SIMPLE_FORMS] feat: form remediation solution streamlining, test coverage, and documentation - PART 2

[pennja]

Summary

This solution is designed to remediate form submissions which have failed submission and are over two weeks old. It is composed of several Ruby on Rails service objects which interact with each other.

The primary use-case for this solution is for form remediation. This process consists of the following:

1. Accept a form submission identifier.
2. Generate an archive payload consisting of the original form submission data as well as remediation specific documentation:
   1. Hydrate the original form submission
   2. Hydrate any original attachments that were a part of this submission
   3. Generate a JSON file with the original metadata from the submission
   4. Generate a manifest file to be used in the remediation process
3. Upload the generated archive as a .zip file onto the configured S3 bucket
4. Optionally return a presigned URL for accessing this file

This solution also provides a means for storing and retrieving a single .pdf copy of the originally submitted form.

The following image depicts how this solution is architected:

• This work updates the form remediation solution to be configurable and usable by all other va.gov teams.
• This is part 2 of a larger PR which was too large and needed broken up. It includes submission remediation data, etc.

Related issue(s)

• Form Submission Remediation - Genericize S3 bucket archiving solution for external team usage

Testing done

• New logic is covered by unit tests

Requested Feedback

Any

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: lib/simple_forms_api/form_remediation/configuration/base.rb

[github-actions]

1 Warning

⚠️

This PR changes 206 LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding 200. Expect some delays getting reviews. File Summary Files modules/simple_forms_api/app/services/simple_forms_api/form_remediation/submission_remediation_data.rb (+91/-0) modules/simple_forms_api/spec/services/form_remediation/submission_remediation_data_spec.rb (+115/-0) Note: We exclude files matching the following when considering PR size: *.csv, *.json, *.tsv, *.txt, *.md, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, *.bru, *.pdf Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

[github-actions]

Backend-review-group approval confirmed.