raft-tech / TANF-app

Repo for development of a new TANF Data Reporting System
Other
16 stars 3 forks source link

2693 cat2 messaging cleanup #2963

Closed jtimpe closed 1 day ago

jtimpe commented 2 months ago

Summary of Changes

Pull request closes #2693

How to Test

cd tdrs-backend && docker-compose up
cd tdrs-frontend && docker-compose up --build
  1. Open http://localhost:3000/ and sign in.
  2. Upload data files containing errors
  3. Inspect the generated error report

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

Deliverable 2: Tested Code

Deliverable 3: Properly Styled Code

Deliverable 4: Accessible

Deliverable 5: Deployed

Deliverable 6: Documented

Deliverable 7: Secure

Deliverable 8: User Research

Research product(s) clearly articulate(s):

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.97%. Comparing base (b5f8bd7) to head (07701c8).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963/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/2963?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) ```diff @@ Coverage Diff @@ ## develop #2963 +/- ## ======================================== Coverage 92.97% 92.97% ======================================== Files 276 276 Lines 7316 7321 +5 Branches 646 647 +1 ======================================== + Hits 6802 6807 +5 Misses 413 413 Partials 101 101 ``` | [Flag](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963/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/2963/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech) | `93.03% <100.00%> (+<0.01%)` | :arrow_up: | | [dev-frontend](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963/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/2963?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/2963?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.78% <100.00%> (ø)` | | | [tdrs-backend/tdpservice/parsers/util.py](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963?src=pr&el=tree&filepath=tdrs-backend%2Ftdpservice%2Fparsers%2Futil.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=raft-tech#diff-dGRycy1iYWNrZW5kL3RkcHNlcnZpY2UvcGFyc2Vycy91dGlsLnB5) | `93.43% <100.00%> (+0.14%)` | :arrow_up: | | [tdrs-backend/tdpservice/parsers/validators.py](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963?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) | `91.66% <100.00%> (+0.06%)` | :arrow_up: | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963?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/2963?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 [b5f8bd7...07701c8](https://app.codecov.io/gh/raft-tech/TANF-app/pull/2963?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).
reitermb commented 2 months ago

I have one question, but it doesn't halt the PR. In the Errors audit, @reitermb has the friendly_name in parenthesis; e.g. Item 26 (Number of Months Countable toward Federal Time Limit). I leave it up to him whether that should be updated in this PR. Otherwise, great work!

Yeah, all friendly names should be in parentheses next to the item #'s—I believe that's currently the case for lower categories, right?

I think with that this is good to go re: my review!

ADPennington commented 1 month ago

per sync with @jtimpe and @reitermb:

ADPennington commented 1 month ago

@jtimpe sorry just noticed merge conflicts on this

ADPennington commented 1 month ago

@jtimpe @reitermb @andrew-jameson i tested this PR based on the most common cat 1, cat2, and cat 3 errors in prod since sprint 98 was released to prod. Please note:

Further below are the error messages I tested for reference ⬇️. let me know how we should proceed, especially re: cat 2 error messages.



jtimpe commented 1 month ago

@ADPennington i've updated the is required validator message to use the schema/item/friendly string formatting. this change applies to every field where the required=True