2897 finalized reporting language #2962

jtimpe · 2024-04-25T16:41:56Z

Summary of Changes

Pull request closes #2897 and closes #3024

Remove "(In Development)" from submission history table column headers on the frontend
Add a link to the knowledge center above the submission history tables
Replace "in development" messaging on error reports with official language and links to explaining documents
Remove the "error type" and "column number" columns from the error report
provides clarity around the coding instructions in the error report

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 errors. Examine the submission history page/tables.
Download the error report. Examine the header and columns.

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

Submission history page, data columns, and error report copy match requirements
All changes in frontend pass a11y review
Testing Checklist has been run and all tests pass
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

…ders

codecov · 2024-04-25T17:11:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.05%. Comparing base (fefbe14) to head (1fd7300).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2962   +/-   ##
========================================
  Coverage    93.04%   93.05%           
========================================
  Files          276      276           
  Lines         7102     7108    +6     
  Branches       599      599           
========================================
+ Hits          6608     6614    +6     
  Misses         399      399           
  Partials        95       95

Flag	Coverage Δ
dev-backend	`93.11% <100.00%> (+<0.01%)`	⬆️
dev-frontend	`92.62% <100.00%> (ø)`

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

Files	Coverage Δ
tdrs-backend/tdpservice/data_files/util.py	`90.00% <100.00%> (+1.76%)`	⬆️
...mponents/SubmissionHistory/CaseAggregatesTable.jsx	`81.25% <ø> (ø)`
...components/SubmissionHistory/SubmissionHistory.jsx	`100.00% <100.00%> (ø)`
...ponents/SubmissionHistory/TotalAggregatesTable.jsx	`66.66% <ø> (ø)`

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 69fb0f7...1fd7300. Read the comment docs.

jtimpe · 2024-04-25T17:17:44Z

tdrs-backend/tdpservice/data_files/util.py

+    row, col = 3, 0
+    worksheet.write_url(
+        row, col,
+        'https://tdp-project-updates.app.cloud.gov/knowledge-center/viewing-error-reports.html',


this was the link provided in the ticket, but it currently 404s - @reitermb

This should start working as soon as we merge #2969

elipe17

I still see the 404 on the knowledge center link also. Otherwise looks good!

raftmsohani

LGTM! 🥇

atrimpe

LGTM

reitermb

Looks good, with the addition of the knowledge center link at the top of submission history this should be good to go!

ADPennington · 2024-06-03T19:44:50Z

tdrs-frontend/src/components/SubmissionHistory/SubmissionHistory.jsx

+          aria-label="Knowledge Center error reports guidance"
+          rel="noreferrer"
+        >
+          Visit the Knowledge Center for further guidance on interpreting error


Suggested change

Visit the Knowledge Center for further guidance on interpreting error

Visit the Knowledge Center for further guidance on reviewing error

ADPennington · 2024-06-03T19:46:49Z

tdrs-backend/tdpservice/data_files/util.py

+    worksheet.write_url(
+        row, col,
+        'https://tdp-project-updates.app.cloud.gov/knowledge-center/viewing-error-reports.html',
+        string='Visit the Knowledge Center for further guidance on interpreting error reports'


Suggested change

string='Visit the Knowledge Center for further guidance on interpreting error reports'

string='Visit the Knowledge Center for further guidance on reviewing error reports'

tdrs-backend/tdpservice/data_files/util.py

ADPennington

@jtimpe @reitermb looks great! thank you for the updates for clarity and a11y! cc: @ttran-hub

I confirmed the results are consistent for all STT types and data types (tribal, tanf, and ssp) 🥇

jtimpe added 5 commits April 25, 2024 11:32

remove development indicator from submission history table column hea…

f14ed47

…ders

finalize error report messaging

40796b5

adjust link start

43b0a2a

fix test

15ae6e0

fix other test

eb92add

jtimpe added the raft review This issue is ready for raft review label Apr 25, 2024

jtimpe assigned andrew-jameson, raftmsohani, atrimpe and elipe17 Apr 25, 2024

jtimpe commented Apr 25, 2024

View reviewed changes

jtimpe assigned jtimpe and unassigned andrew-jameson, raftmsohani, atrimpe and elipe17 Apr 25, 2024

jtimpe requested review from andrew-jameson, raftmsohani, atrimpe and elipe17 April 25, 2024 20:22

elipe17 approved these changes Apr 30, 2024

View reviewed changes

jtimpe requested a review from reitermb April 30, 2024 16:59

raftmsohani approved these changes May 1, 2024

View reviewed changes

atrimpe approved these changes May 1, 2024

View reviewed changes

Merge branch 'develop' into 2897-finalized-reporting-language

ce3d788

reitermb added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label May 2, 2024

reitermb approved these changes May 2, 2024

View reviewed changes

reitermb removed the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label May 2, 2024

add submission history kc link

ccbffed

Merge branch 'develop' into 2897-finalized-reporting-language

b398b1b

jtimpe added QASP Review and removed raft review This issue is ready for raft review labels May 2, 2024

jtimpe requested a review from ADPennington May 2, 2024 22:19

andrew-jameson removed their request for review May 8, 2024 19:13

jtimpe and others added 5 commits May 16, 2024 10:53

Merge branch 'develop' into 2897-finalized-reporting-language

53730fc

Merge branch 'develop' into 2897-finalized-reporting-language

10c3e55

Merge branch 'develop' into 2897-finalized-reporting-language

7d22365

Merge branch 'develop' into 2897-finalized-reporting-language

84d742a

Merge branch 'develop' into 2897-finalized-reporting-language

fcf04af

ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jun 3, 2024

remove column_number

2816ce0

ADPennington reviewed Jun 3, 2024

View reviewed changes

interpreting -> reviewing

60714c8

ADPennington reviewed Jun 3, 2024

View reviewed changes

interpreting -> reviewing

087e052

ADPennington reviewed Jun 3, 2024

View reviewed changes

tdrs-backend/tdpservice/data_files/util.py Outdated Show resolved Hide resolved

ADPennington removed the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jun 4, 2024

jtimpe and others added 3 commits June 4, 2024 17:04

more descriptive guidance text

02c0298

Merge branch 'develop' into 2897-finalized-reporting-language

9cdd0b6

revert to single column instructions link

1fd7300

ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jun 5, 2024

ADPennington approved these changes Jun 5, 2024

View reviewed changes

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 Jun 5, 2024

andrew-jameson merged commit 0326896 into develop Jun 5, 2024
25 checks passed

andrew-jameson deleted the 2897-finalized-reporting-language branch June 5, 2024 13:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2897 finalized reporting language #2962

2897 finalized reporting language #2962

jtimpe commented Apr 25, 2024 •

edited by ADPennington

Loading

codecov bot commented Apr 25, 2024 •

edited

Loading

jtimpe Apr 25, 2024 •

edited

Loading

reitermb May 2, 2024

elipe17 left a comment

raftmsohani left a comment

atrimpe left a comment

reitermb left a comment •

edited

Loading

ADPennington Jun 3, 2024

ADPennington Jun 3, 2024

ADPennington left a comment

	Visit the Knowledge Center for further guidance on interpreting error
	Visit the Knowledge Center for further guidance on reviewing error

	string='Visit the Knowledge Center for further guidance on interpreting error reports'
	string='Visit the Knowledge Center for further guidance on reviewing error reports'

2897 finalized reporting language #2962

2897 finalized reporting language #2962

Conversation

jtimpe commented Apr 25, 2024 • edited by ADPennington Loading

Summary of Changes

How to Test

Deliverables

codecov bot commented Apr 25, 2024 • edited Loading

Codecov Report

jtimpe Apr 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elipe17 left a comment

Choose a reason for hiding this comment

raftmsohani left a comment

Choose a reason for hiding this comment

atrimpe left a comment

Choose a reason for hiding this comment

reitermb left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ADPennington left a comment

Choose a reason for hiding this comment

jtimpe commented Apr 25, 2024 •

edited by ADPennington

Loading

codecov bot commented Apr 25, 2024 •

edited

Loading

jtimpe Apr 25, 2024 •

edited

Loading

reitermb left a comment •

edited

Loading