3385 - Regional staff submission history #3490

jtimpe · 2025-02-25T16:28:12Z

Summary of Changes

Pull request closes #3385

Creates a "read only" version of submission history for OFA Regional Staff users
Regional Staff can only view submission history of locations assocaited with their region
Reorganizes cypress test data from django management commands to django fixtures. Creates a cypress test for regional staff workflow

How to Test

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

Open http://localhost:3000/ and sign in.
Assign your user the OFA Regional Staff role. Add one or more regions.
Navigate to the Data Files page. Use the STT Combobox to select a location. Verify list of available locations is limited to those associated with your user's region.
Submit the search form. Verify the upload form cannot be viewed, only submission history can be viewed. Verify that files cannot be downloaded.

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

Regional user can view submission history for STTs in their region.
Regional user can't upload files to any section of TDP.
Regional user can't download data files from TDP.
Clicking 'Search' automatically shows Submission History.
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 · 2025-02-25T16:42:10Z

Codecov Report

Attention: Patch coverage is 83.33333% with 5 lines in your changes missing coverage. Please review.

Project coverage is 90.66%. Comparing base (8ffdb0f) to head (314b03a).

Files with missing lines	Patch %	Lines
tdrs-frontend/src/selectors/stts.js	50.00%	2 Missing ⚠️
tdrs-frontend/src/components/Reports/Reports.jsx	90.00%	1 Missing ⚠️
...mponents/SubmissionHistory/CaseAggregatesTable.jsx	66.66%	1 Missing ⚠️
...ponents/SubmissionHistory/TotalAggregatesTable.jsx	66.66%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3490      +/-   ##
===========================================
+ Coverage    90.64%   90.66%   +0.01%     
===========================================
  Files          310      311       +1     
  Lines         8908     8924      +16     
  Branches       677      680       +3     
===========================================
+ Hits          8075     8091      +16     
- Misses         704      706       +2     
+ Partials       129      127       -2

Flag	Coverage Δ
dev-backend	`90.45% <100.00%> (+<0.01%)`	⬆️
dev-frontend	`92.15% <80.76%> (+0.08%)`	⬆️

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

Files with missing lines	Coverage Δ
tdrs-backend/tdpservice/settings/common.py	`99.34% <100.00%> (+<0.01%)`	⬆️
tdrs-backend/tdpservice/users/permissions.py	`100.00% <100.00%> (ø)`
...rontend/src/components/STTComboBox/STTComboBox.jsx	`90.90% <100.00%> (ø)`
...components/SubmissionHistory/SubmissionHistory.jsx	`100.00% <ø> (ø)`
tdrs-frontend/src/selectors/auth.js	`97.50% <100.00%> (+0.13%)`	⬆️
tdrs-frontend/src/components/Reports/Reports.jsx	`87.82% <90.00%> (+0.21%)`	⬆️
...mponents/SubmissionHistory/CaseAggregatesTable.jsx	`93.75% <66.66%> (+0.89%)`	⬆️
...ponents/SubmissionHistory/TotalAggregatesTable.jsx	`86.66% <66.66%> (+17.43%)`	⬆️
tdrs-frontend/src/selectors/stts.js	`50.00% <50.00%> (ø)`

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 8ffdb0f...314b03a. Read the comment docs.

reitermb · 2025-02-25T17:37:34Z

Looking good! Clear scan and expected screenreader behavior

raftmsohani · 2025-02-27T14:33:14Z

docs/Technical-Documentation/cypress-integration-tests.md

@@ -14,7 +14,7 @@ All tests added into the `tdrs-frontend/cypress/e2e/` folder will be run against
 1. In a new terminal, set up test users by running
   ```bash
   cd tdrs-backend
-   docker-compose exec web python manage.py generate_cypress_users
+   docker-compose exec web python manage.py loaddata cypress/users cypress/data_files


raftmsohani

LGTM!

elipe17 · 2025-02-27T16:55:05Z

tdrs-backend/tdpservice/data_files/test/test_api.py

-        response = self.post_data_file_file(api_client, regional_data_file_data)
+        """Test OFA Regional Staff cannot download datafiles."""
+        post_client = self.login_as(data_analyst)
+        response = self.post_data_file_file(post_client, regional_data_file_data)


I know you didn't write this func, but it has a confusing/awkward name. Are you open to renaming it to something like post_datafile?

tdrs-backend/tdpservice/users/permissions.py

elipe17 · 2025-02-27T16:59:09Z

tdrs-frontend/cypress/support/commands.js

  })

  cy.clearCookie('sessionid')
  cy.clearCookie('csrftoken')
 })

 Cypress.Commands.add(
-  'adminApiRequest',
+  'adminConsoleFormRequest',


Love this name change to help us remember it is admin form fields in the future!

elipe17 · 2025-02-27T17:02:42Z

tdrs-frontend/src/selectors/stts.js

+  accountIsRegionalStaff(state)
+    ? selectUser(state)
+        .regions?.map((region) => region.stts)
+        .flat()


Can we alphabetize this list?

elipe17

Couple of nits. Otherwise this looks great, LGTM!

Co-authored-by: Eric Lipe <[email protected]>

jtimpe added 11 commits February 19, 2025 12:16

allow regional users to see submission history

0065a87

filter datafiles stt combobox to regional stts

1479c6c

add backend permission checks

055b8f8

tests

c23d62f

fix tests

8910523

Merge branch 'develop' into 3385-regional-staff-submission-history

a0ef6c6

separate admin api from admin console requests

5c2c53e

change feat file discovery

2dd9444

reorg

3f2cc0f

create user/datafile fixtures

1b5efb8

add regional staff submission history test

d2b05be

jtimpe self-assigned this Feb 25, 2025

jtimpe added raft review This issue is ready for raft review a11y-review PR is ready for accessibility review labels Feb 25, 2025

jtimpe requested review from reitermb, mattcoleanderson, raftmsohani, victoriaatraft and elipe17 February 25, 2025 16:28

reitermb added the Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI label Feb 25, 2025

jtimpe added Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI and removed Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI labels Feb 25, 2025

reitermb approved these changes Feb 25, 2025

View reviewed changes

victoriaatraft approved these changes Feb 25, 2025

View reviewed changes

reitermb removed the Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI label Feb 26, 2025

raftmsohani reviewed Feb 27, 2025

View reviewed changes

raftmsohani approved these changes Feb 27, 2025

View reviewed changes

elipe17 reviewed Feb 27, 2025

View reviewed changes

tdrs-backend/tdpservice/users/permissions.py Outdated Show resolved Hide resolved

elipe17 reviewed Feb 27, 2025

View reviewed changes

elipe17 approved these changes Feb 27, 2025

View reviewed changes

jtimpe and others added 3 commits February 27, 2025 12:13

Update tdrs-backend/tdpservice/users/permissions.py

c37d3fc

Co-authored-by: Eric Lipe <[email protected]>

alphabetize stt list

a5c3748

change test func name

314b03a

jtimpe added QASP Review and removed raft review This issue is ready for raft review a11y-review PR is ready for accessibility review labels Feb 27, 2025

jtimpe requested a review from ADPennington February 27, 2025 18:14

mattcoleanderson approved these changes Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3385 - Regional staff submission history #3490

3385 - Regional staff submission history #3490

jtimpe commented Feb 25, 2025

codecov bot commented Feb 25, 2025 •

edited

Loading

reitermb commented Feb 25, 2025

raftmsohani Feb 27, 2025

raftmsohani left a comment

elipe17 Feb 27, 2025

jtimpe Feb 27, 2025

elipe17 Feb 27, 2025

elipe17 Feb 27, 2025

elipe17 left a comment

3385 - Regional staff submission history #3490

Are you sure you want to change the base?

3385 - Regional staff submission history #3490

Conversation

jtimpe commented Feb 25, 2025

Summary of Changes

How to Test

Deliverables

codecov bot commented Feb 25, 2025 • edited Loading

Codecov Report

reitermb commented Feb 25, 2025

Choose a reason for hiding this comment

raftmsohani left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

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

codecov bot commented Feb 25, 2025 •

edited

Loading