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.

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

Include all Cat2/3 Errors on Critical Tab of Error Report #3381

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

elipe17
Copy link

@elipe17 elipe17 commented Dec 17, 2024

Summary of Changes

  • Updated error report generation to accept a boolean indicating if it is a S3 or S4 file
  • Updated the prioritized queryset function to prioritize the queryset differently for S3 and S4 files
  • Exclude header update indicator cat2 errors wrt S3/S4 files
  • Updated spreadsheet writer to exclude the case number column for S3/S4 files since it will always be empty
    Pull request closes Move Cat 2 and Cat 3 errors from aggregate and stratum to critical worksheet #3341

Something to note. S3/S4 records/errors do NOT have a case number association. However, the error report always includes a column on the critical tab for case number. In the S3/S4 case, that column will be completely empty. I have reached out to Alex to see if I can handle that case under this PR or if it should live in another ticket.

How to Test

cd tdrs-frontend && docker-compose up
cd tdrs-backend && docker-compose up
  1. Open http://localhost:3000/ and sign in.
  2. Update a Aggregate/Stratum file to have some cat2/cat3 errors
  3. Submit the file
  4. Verify the report displays all cat2/cat3 errors on the "Critical" tab

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

  • Any Cat 2 or Cat 3 errors detected in Aggregate data is included on critical worksheet
  • Any Cat 2 or Cat 3 errors detected in Stratum data is included on critical worksheet
  • The following cat 2 error message does not appear on critical worksheet: HEADER Update Indicator must be set to D instead of N. Please review Exporting Complete Data Using FTANF in the Knowledge Center.
  • Testing Checklist has been run and all tests pass
  • README is updated, if necessary

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

@elipe17 elipe17 added bug backend dev raft review This issue is ready for raft review labels Dec 17, 2024
@elipe17 elipe17 self-assigned this Dec 17, 2024
@elipe17 elipe17 marked this pull request as ready for review December 17, 2024 20:45
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

Attention: Patch coverage is 73.07692% with 7 lines in your changes missing coverage. Please review.

Project coverage is 91.38%. Comparing base (ff01121) to head (e2e05cd).
Report is 5 commits behind head on develop.

Files with missing lines Patch % Lines
tdrs-backend/tdpservice/data_files/util.py 69.56% 5 Missing and 2 partials ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #3381      +/-   ##
===========================================
- Coverage    91.48%   91.38%   -0.10%     
===========================================
  Files          299      299              
  Lines         8595     8614      +19     
  Branches       636      640       +4     
===========================================
+ Hits          7863     7872       +9     
- Misses         615      622       +7     
- Partials       117      120       +3     
Flag Coverage Δ
dev-backend 91.24% <73.07%> (-0.09%) ⬇️
dev-frontend 92.44% <ø> (-0.22%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
tdrs-backend/tdpservice/data_files/views.py 88.99% <100.00%> (+0.10%) ⬆️
tdrs-backend/tdpservice/data_files/util.py 94.06% <69.56%> (-5.94%) ⬇️

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f01cfef...e2e05cd. Read the comment docs.

@elipe17 elipe17 requested a review from ADPennington January 2, 2025 14:29
@elipe17 elipe17 added QASP Review and removed raft review This issue is ready for raft review labels Jan 2, 2025
@ADPennington ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jan 3, 2025
@ADPennington
Copy link
Collaborator

ADPennington commented Jan 3, 2025

@klinkoberstar

Section 3 and 4 error reports before this change:

2024-Q1-SSP Stratum Data (1).xlsx
2023.Q3.Tribal Aggregate Data (1).txt
2022-Q1-Aggregate Data (5).xlsx
2024-Q3-Stratum Data (1).xlsx

Section 3 and 4 error reports after this change:

2022-Q1-Aggregate Data (6).xlsx
2022-Q1-SSP Stratum Data (4).xlsx
2023-Q3-Tribal Aggregate Data (9).xlsx
2024-Q3-Stratum Data.xlsx

Copy link
Collaborator

@ADPennington ADPennington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@ADPennington ADPennington added Ready to Merge and removed QASP Review Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI labels Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move Cat 2 and Cat 3 errors from aggregate and stratum to critical worksheet
4 participants