3016 - cat3 error cleanup

raft-tech / TANF-app

Repo for development of a new TANF Data Reporting System

Other

16 stars 3 forks source link

Summary of Changes

Pull request closes #3016

cleans up category 2 error messages when presented "inline" in a category 3 error
- creates a new format_error_context which takes a string format. prefix is the default, inline is passed in anywhere a cat3 validator calls a make_validator-created validator.
- creates a new python @dataclass called ValidatorErrorArguments - this cleans up the 5 params going into every make_validator-created validator

How to Test

cd tdrs-backend && docker-compose up
cd tdrs-frontend && docker-compose up --build

Open http://localhost:3000/ and sign in.
Upload a datafile containing cat2 and cat3 errors
Ensure cat2 errors follow the prefix format, cat3 errors follow the inline format

Demo GIF(s) and screenshots for testing procedure

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

[ ] update the cat3 validator messages to be more human-readable
[ ] lfrohlich and/or adpennington confirmed that ACs are met.

Deliverable 2: Tested Code

Are all areas of code introduced in this PR meaningfully tested?
- [ ] If this PR introduces backend code changes, are they meaningfully tested?
- [ ] If this PR introduces frontend code changes, are they meaningfully tested?
Are code coverage minimums met?
- [ ] Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
- [ ] Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

[ ] Are backend code style checks passing on CircleCI?
[ ] Are frontend code style checks passing on CircleCI?
[ ] Are code maintainability principles being followed?

Deliverable 4: Accessible

[ ] Does this PR complete the epic?
[ ] Are links included to any other gov-approved PRs associated with epic?
[ ] Does PR include documentation for Raft's a11y review?
[ ] Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

[ ] Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

[ ] Does this PR provide background for why coding decisions were made?
[ ] If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
[ ] If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
[ ] If this PR introduces dependencies, are their licenses documented?
[ ] Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

[ ] Does the OWASP Scan pass on CircleCI?
[ ] Do manual code review and manual testing detect any new security issues?
[ ] If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

[ ] the purpose of the research
[ ] methods used to conduct the research
[ ] who participated in the research
[ ] what was tested and how
[ ] impact of research on TDP
[ ] (if applicable) final design mockups produced for TDP development

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.99%. Comparing base (89c0f2d) to head (fb0e539).

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032/graphs/tree.svg?width=650&height=150&src=pr&token=BA04YXPAL9&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech)](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) ```diff @@ Coverage Diff @@ ## 2693-cat2-messaging-cleanup #3032 +/- ## =============================================================== + Coverage 92.97% 92.99% +0.01% =============================================================== Files 276 276 Lines 7321 7338 +17 Branches 647 649 +2 =============================================================== + Hits 6807 6824 +17 Misses 413 413 Partials 101 101 ``` | [Flag](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) | Coverage Δ | | |---|---|---| | [dev-backend](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) | `93.05% <96.66%> (+0.01%)` | :arrow_up: | | [dev-frontend](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) | `92.60% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) | Coverage Δ | | |---|---|---| | [tdrs-backend/tdpservice/parsers/row\_schema.py](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?src=pr&el=tree&filepath=tdrs-backend%2Ftdpservice%2Fparsers%2Frow_schema.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech#diff-dGRycy1iYWNrZW5kL3RkcHNlcnZpY2UvcGFyc2Vycy9yb3dfc2NoZW1hLnB5) | `94.82% <100.00%> (+0.04%)` | :arrow_up: | | [tdrs-backend/tdpservice/parsers/validators.py](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?src=pr&el=tree&filepath=tdrs-backend%2Ftdpservice%2Fparsers%2Fvalidators.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech#diff-dGRycy1iYWNrZW5kL3RkcHNlcnZpY2UvcGFyc2Vycy92YWxpZGF0b3JzLnB5) | `92.16% <96.42%> (+0.49%)` | :arrow_up: | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech). Last update [89c0f2d...fb0e539](https://app.codecov.io/gh/raft-tech/TANF-app/pull/3032?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech).

raft-tech / TANF-app