Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Page][Resolve Errors/Warnings] Basic skeleton of errors and warnings #333

Closed
Tracked by #108
billhimmelsbach opened this issue Mar 28, 2024 · 3 comments · Fixed by #423
Closed
Tracked by #108

[Page][Resolve Errors/Warnings] Basic skeleton of errors and warnings #333

billhimmelsbach opened this issue Mar 28, 2024 · 3 comments · Fixed by #423
Assignees
@shindigira
Labels
UI Tasks involving visual elements

Comments

@billhimmelsbach
Copy link
Contributor

billhimmelsbach commented Mar 28, 2024 •
edited by shindigira

Just to fail early, we want to try to present the user errors and warnings on the page with very basic formatting.

Current behavior

  • no errors are displayed

Expected behavior

  • errors are displayed on the page, even if rough and undesigned
@billhimmelsbach
Copy link
Contributor Author

Assigning over the error and warnings to you @shindigira. Try to get the errors and warnings on the page to start.

@billhimmelsbach billhimmelsbach mentioned this issue Apr 4, 2024
Closed
@billhimmelsbach
Copy link
Contributor Author

billhimmelsbach commented Apr 4, 2024 •
edited

@shindigira, make sure to message Jason (to check in on what the backend is sending over) and maybe just check in with Meissa who might have a skeleton page you could use as part of their routing work.

@hkeeler
Copy link
Member

hkeeler commented Apr 4, 2024

As you're working on this, it'll be good to keep an eye on cfpb/sbl-filing-api#140. That's the one that's going to add warning and error counts. It's also going to change the naming of the fields a bit. We'll try to nail the format down today so you can plan ahead.

@shindigira shindigira added the UI Tasks involving visual elements label Apr 23, 2024
@shindigira shindigira mentioned this issue Apr 23, 2024
Open
4 tasks
@shindigira shindigira changed the title [Task] Basic skeleton of errors and warnings (Phase 1) [Task] Basic skeleton of errors (Phase 1) May 1, 2024
@shindigira shindigira mentioned this issue May 1, 2024
Merged
@shindigira shindigira changed the title [Task] Basic skeleton of errors (Phase 1) [Task] Basic skeleton of Resolve Errors (Phase 1) May 2, 2024
@shindigira shindigira changed the title [Task] Basic skeleton of Resolve Errors (Phase 1) [Page][Resolve Errors] Basic skeleton of errors (Phase 1) May 2, 2024
@shindigira shindigira changed the title [Page][Resolve Errors] Basic skeleton of errors (Phase 1) [Page][Resolve Errors/Warnings] Basic skeleton of errors and warnings(Phase 1) May 3, 2024
@shindigira shindigira changed the title [Page][Resolve Errors/Warnings] Basic skeleton of errors and warnings(Phase 1) [Page][Resolve Errors/Warnings] Basic skeleton of errors and warnings May 3, 2024
shindigira added a commit that referenced this issue May 6, 2024
@shindigira @meissadia
[Page] Resolve Errors & Warnings (#423)
4429fa1 
closes #333 
closes #401 

## Note (05/02/24)
The `sbl-filing` branch used is `main` -- latest working commit
`0ddf51bd4bd0ab7aefac8cbb02c7797077885620`

branched off
[331-filing-routing_phase2-live-data](#406)

## Changes
- feat(Resolve Errors): Single-Field Errors
- feat(Resolve Errors): Multi-Field Errors
- feat(Resolve Errors): Register-Level Errors
- feat(Resolve Errors): Alerts present depending on errors or no errors
- feat(Resolve Errors): Swappable between Step 1 (Syntax Errors) and
Step 2 (Logical Errors/Register Errors); navigates to `warnings` on Step
2 (no errors)
- enhancement(Upload): added an `enableLongPolling` boolean to
`useGetSubmissionLatest`; default false
- enhancement(Resolve Errors): Implemented 'react-markdown' --
Validation Description
- chore(Resolve Errors): TypeScript handling in
`FilingErrors.helpers.ts`
- [chore(Upload): Hide FilingNavButtons if still
loading](d380708)
- feat(Resolve Errors): if a get submission latest fails, there is an
Alert that pops up


## Next PRs
- Pagination
- Accessibility pass
- Table styling size adjustments
- Download linking the validation report

## How to Test

1. `yarn install` to install `react-markdown`
2. Select an institution and upload with the csv files provided (Syntax
Errors and then Logical/Register Errors)
3. Ensure the right Alert occurs based on the error (or no errors) per
segment
4. Verify all proper data is present per field-level section

#### Test CSV's to use

[all-errors-warnings-no-syntax-errors.csv](https://github.com/cfpb/sbl-frontend/files/15182232/all-errors-warnings-no-syntax-errors.csv)

[sblar_syntax_errors_large.csv](https://github.com/cfpb/sbl-frontend/files/15182233/sblar_syntax_errors_large.csv)

[sblar_syntax_errors.csv](https://github.com/cfpb/sbl-frontend/files/15182234/sblar_syntax_errors.csv)

Note: If Syntax Errors are present, then validation for the logical
errors/warnings do not occur. Hence, why the test CSV's has either
syntax errors or logical errors; not both.

## Screenshots
|Markdown|
|--|
|<img width="602" alt="Screenshot 2024-05-02 at 2 40 05 AM"
src="https://github.com/cfpb/sbl-frontend/assets/13324863/c277389e-46c3-4374-8195-740e3b04b193">|

| SingleFieldErrors | Success | Register-Level |
|--|--|--|
|<img width="411" alt="Screenshot 2024-05-01 at 4 44 52 PM"
src="https://github.com/cfpb/sbl-frontend/assets/13324863/776da07d-7c9a-4dca-9fe9-24e106ac00e2">|<img
width="400" alt="Screenshot 2024-05-01 at 4 45 10 PM"
src="https://github.com/cfpb/sbl-frontend/assets/13324863/4682d70c-52dc-40fb-9f8b-a3e0c72d8247">|<img
width="403" alt="Screenshot 2024-05-01 at 4 45 45 PM"
src="https://github.com/cfpb/sbl-frontend/assets/13324863/c1b6e28e-c6e1-4b1a-902b-b7803aa91f77">|

---------

Co-authored-by: Meis <meissadia@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shindigira shindigira

Labels
UI Tasks involving visual elements
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Page] Resolve Errors & Warnings cfpb/sbl-frontend
3 participants
@hkeeler @shindigira @billhimmelsbach