Regional User Request Access #3440

elipe17 · 2025-01-23T16:27:30Z

Summary of Changes

Added support for acf domain based users to select whether they're central or regional users
Added frontend support for selecting regions for regional users
Refactored the request access form into it's own component
Added new frontend tests to test the new form component
Added support in the backend to allow a user to be associated with multiple regions and vice versa
Updated email templates to handle regional vs central access request/approved emails
Added new form fields for e2e tests
Pull request closes Update the existing OFA access workflow to include regions #3384

How to Test

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

Open http://localhost:3000/ and sign in.
Request access as a normal central user, make sure you try introducing form errors to verify the errors and count of errors looks good.
Verify you can successfully request access and that your user is updated etc...
To test as the regional user with acf domain, you can modify line 247 in RequestAccessForm from {isAMSUser && ( to {!isAMSUser && (. Notice the addition of the bang symbol.
Now log in, and request access again. Toggle the regional radio buttons to verify functionality.
Introduce/fix form errors with and without the regional checkboxes rendered
select one or more regions for your user, and request access
Verify the user is created and that it is correctly associated with the regions you chose.

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

When a user with an ACF email domain, they should be presented with the region checkboxes
Regional user is emailed when access is submitted, approved, and/or denied.
The regional user must select 1+ region(s).
DAC should allow regional user with null STTs if region is selected.
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

- Pulled form elements out of Home component

- Create custom through model - Update serializer to handle new many to many field - Temporary migrations - Update request access patch to include selected regions - Remove unused imports - Update regions info to be a set to ensure no duplicates and easy manipulation

- Updated region checkbox error state to be smarter

codecov · 2025-01-23T20:29:00Z

Codecov Report

Attention: Patch coverage is 89.82036% with 17 lines in your changes missing coverage. Please review.

Project coverage is 91.15%. Comparing base (d227065) to head (29468bf).
Report is 51 commits behind head on develop.

Files with missing lines	Patch %	Lines
...backend/tdpservice/email/helpers/account_status.py	44.44%	3 Missing and 2 partials ⚠️
tdrs-backend/tdpservice/users/serializers.py	61.53%	3 Missing and 2 partials ⚠️
...rc/components/RequestAccessForm/RegionSelector.jsx	88.23%	2 Missing and 2 partials ⚠️
tdrs-backend/tdpservice/users/models.py	81.81%	1 Missing and 1 partial ⚠️
...ponents/RequestAccessForm/JurisdictionSelector.jsx	75.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3440      +/-   ##
===========================================
- Coverage    91.24%   91.15%   -0.09%     
===========================================
  Files          303      308       +5     
  Lines         8734     8832      +98     
  Branches       650      670      +20     
===========================================
+ Hits          7969     8051      +82     
- Misses         645      654       +9     
- Partials       120      127       +7

Flag	Coverage Δ
dev-backend	`91.01% <83.09%> (-0.10%)`	⬇️
dev-frontend	`92.18% <94.79%> (-0.04%)`	⬇️

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

Files with missing lines	Coverage Δ
...pservice/stts/management/commands/populate_stts.py	`100.00% <100.00%> (ø)`
...tdpservice/stts/migrations/0011_add_region_name.py	`100.00% <100.00%> (ø)`
tdrs-backend/tdpservice/stts/models.py	`100.00% <100.00%> (ø)`
tdrs-backend/tdpservice/users/admin.py	`77.50% <100.00%> (+4.77%)`	⬆️
...s/migrations/0043_create_regions_m2m_del_region.py	`100.00% <100.00%> (ø)`
tdrs-backend/tdpservice/users/permissions.py	`100.00% <100.00%> (ø)`
tdrs-backend/tdpservice/users/test/factories.py	`100.00% <ø> (ø)`
tdrs-backend/tdpservice/users/views.py	`96.00% <ø> (ø)`
tdrs-frontend/src/actions/requestAccess.js	`100.00% <100.00%> (ø)`
tdrs-frontend/src/components/Home/Home.jsx	`100.00% <100.00%> (+1.78%)`	⬆️
... and 6 more

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 8955b3b...29468bf. Read the comment docs.

…onal user

…r is submitting an access request.

- begin removing region refs

- remove region from factory - update logic in tests

- add tests for form logic

elipe17 · 2025-02-07T20:35:45Z

@elipe17 merge conflict here

@ADPennington , just fixed :)

ADPennington · 2025-02-10T22:54:20Z

@elipe17 @lhuxraft -- @ttran-hub and I will meet tomorrow, 2/11, to test this PR together in the QASP environment. I need to avoid deleting my user account for testing in QASP because it is linked to the vast majority of data file objects tested in this environment.

ADPennington · 2025-02-11T22:11:48Z

@elipe17 @lhuxraft -- @ttran-hub and I will meet tomorrow, 2/11, to test this PR together in the QASP environment. I need to avoid deleting my user account for testing in QASP because it is linked to the vast majority of data file objects tested in this environment.

@elipe17 @lhuxraft -- @ttran-hub and I completed our testing and below are the findings. Please note that I deleted the test account after every test to model a new user flow as closely as possible. Let us know how best to proceed here.

In summary:

the state issue underlying the Bug: Group renders as None in request approved email if assigned During Approval #3449 bug is still apparent and would need to be addressed before we can onboard any regional staff users. We would be okay approving this as long as it is addressed before onboarding.
we also noticed that it is possible to add regions to a user account but not possible to remove any. This probably needs to be addressed in another ticket.
For the approved regional user's profile, would be a nice enhancement to add the region(s) associated with their account to the profile.
STT(s) not able to be selected on data files page (Update Data Files page for regional staff #3385)

test 1. Request access as a central office user

user received the correct email language

test 2. Request access as a regional office user (one region only)

user received the incorrect email language (no evidence of requesting R1 in email but evident in user account)

test 3. Request access as a regional office user (more than one region only)

user received the incorrect email language (no evidence of requesting multiple regions in email but evident in user account)

user profile once approved

data files page once approved

- Update serializer to pass M2M fields to model save to use for email context

…t-tech/TANF-app into 3384-regional-user-workflows

elipe17 · 2025-02-13T18:52:05Z

@elipe17 @lhuxraft -- @ttran-hub and I will meet tomorrow, 2/11, to test this PR together in the QASP environment. I need to avoid deleting my user account for testing in QASP because it is linked to the vast majority of data file objects tested in this environment.

@elipe17 @lhuxraft -- @ttran-hub and I completed our testing and below are the findings. Please note that I deleted the test account after every test to model a new user flow as closely as possible. Let us know how best to proceed here.

In summary:

the state issue underlying the Request Approved Template has Missing Data #3449 bug is still apparent and would need to be addressed before we can onboard any regional staff users. We would be okay approving this as long as it is addressed before onboarding.

we also noticed that it is possible to add regions to a user account but not possible to remove any. This probably needs to be addressed in another ticket.

For the approved regional user's profile, would be a nice enhancement to add the region(s) associated with their account to the profile.

STT(s) not able to be selected on data files page (Update Data Files page for regional staff #3385)

test 1. Request access as a central office user

user received the correct email language

test 2. Request access as a regional office user (one region only)

user received the incorrect email language (no evidence of requesting R1 in email but evident in user account)

test 3. Request access as a regional office user (more than one region only)

user received the incorrect email language (no evidence of requesting multiple regions in email but evident in user account)

user profile once approved

data files page once approved

@ADPennington, I added a fix to correctly handle the email context wrt a user being central/regional. You should now be able to request access as central/regional user and get the correct emails. You can also use the same user now without having to delete it from shell_plus. The caveat to this is you should NOT assign the user a group while switching the request access state back and forth. It's hard to explain here why that can cause issues, but happy to get on a call to explain. The issue WRT the Group being null in approval emails is still an issue and is the same issue I fixed for the email context stuff but in a different code flow. Because it has a different flow, my fix for the emails does not apply to the group stuff. I also updated the admin form to allow you and other admins the ability to add/remove regions. Sorry this took so long, it was a tough issue to track down and has to do with Many to Many fields inside of Models.

cc. @lhuxraft

ADPennington · 2025-02-14T16:35:33Z

@elipe17 re-tested with a team member who didnt previously have an account in qasp environment. Results below:

central office user request ✔️

(after resetting account to initial state) user request for one region ✔️

(after assigning to RO group ---> account status pending ---> save/continue --> account status approval) approval email ✔️

(after adding a region to the user's approved account --> account status pending ---> save/continue --> account status approval) approval email ✔️
(after checking to delete regions, removing user from RO group, and setting account status to initial state) user request for multiple regions ✔️

ADPennington · 2025-02-14T17:19:10Z

tdrs-backend/tdpservice/users/test/test_api/test_users.py

@@ -52,7 +52,7 @@ def test_create_user_endpoint_not_present(api_client, user_data):
 @pytest.mark.django_db
 def test_regional_user_update_user_in_region(api_client, regional_user, user_in_region):
    """Test regional staff can update users in their region."""
-    assert regional_user.region.id == user_in_region.stt.region.id
+    assert user_in_region.stt.region in regional_user.regions.all()


during review, I noticed the tests here for regional staff interactions with the user accounts in/out of their region. Its come to my attention that regional user group is currently configured to have visibility into user accounts, and its not just users in their region. These permissions need to be removed before onboarding of regional staff users. Currently no impact. will spin up new ticket, as these permissions were pre-existing @elipe17 @lhuxraft

ADPennington

LGTM @elipe17 🚀

As discussed, there will be new tickets for:

adding region(s) to profile for approved regional staff users
resolving regional staff permissions re: users before onboarding

elipe17 added 3 commits January 22, 2025 15:18

- Moved request access form to its own component

5ced593

- Pulled form elements out of Home component

- Add inline to display new m2m field in admin

a833b78

elipe17 self-assigned this Jan 23, 2025

- Updated region checkboxes to be toggleable

732decf

- Updated region checkbox error state to be smarter

elipe17 added 11 commits January 23, 2025 15:30

- Fixed issue where exception occurred submitting request as non regi…

804e94b

…onal user

- Use correct nomenclature

055488b

- Update email templates to reflect whether a regional or central use…

6597cf2

…r is submitting an access request.

- linting

27714b4

- correct migration

62065af

- begin removing region refs

- Updated tests to support the new regions field

833aaff

- remove select related

9de5ff6

- remove region from factory - update logic in tests

- fix permission logic

78752bb

- Updated logic in validator to correctly asses if a user has a region

965cc78

- update form to display correctly for stts

8ac272b

- add tests for form logic

- Added missing form fields for the regions field

d1c0e94

elipe17 requested review from andrew-jameson, raftmsohani and jtimpe January 24, 2025 20:53

elipe17 added frontend backend dev raft review This issue is ready for raft review a11y-review PR is ready for accessibility review labels Jan 24, 2025

elipe17 requested review from reitermb and victoriaatraft January 24, 2025 20:54

elipe17 and others added 3 commits January 27, 2025 09:51

- Add todos for post review

5e45495

- revert todos because tests wont pass

e2fd85a

Merge branch 'develop' into 3384-regional-user-workflows

dd21e2d

- Fixed migratin conflict

4e4f625

ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Feb 10, 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 10, 2025

- Quick logic add for null stt

6929039

ADPennington added Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI and removed Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI labels Feb 10, 2025

jtimpe mentioned this pull request Feb 11, 2025

3398 - FRA Reports - search and upload #3445

Merged

31 tasks

lhuxraft mentioned this pull request Feb 11, 2025

3205 reparse command refactor #3361

Merged

28 tasks

ADPennington removed the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Feb 12, 2025

elipe17 and others added 5 commits February 13, 2025 09:33

- Update to allow admin to add or remove regions

c110231

- Update approve template to be a little better

f9bf368

- Update serializer to pass M2M fields to model save to use for email context

Merge branch 'develop' into 3384-regional-user-workflows

ac213de

- fix lint

9dec208

Merge branch '3384-regional-user-workflows' of https://github.com/raf…

29468bf

…t-tech/TANF-app into 3384-regional-user-workflows

ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Feb 13, 2025

ADPennington reviewed Feb 14, 2025

View reviewed changes

ADPennington approved these changes Feb 14, 2025

View reviewed changes

ADPennington added Ready to Merge and removed raft review This issue is ready for raft review QASP Review Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI labels Feb 14, 2025

elipe17 merged commit 758ab45 into develop Feb 14, 2025
23 checks passed

elipe17 deleted the 3384-regional-user-workflows branch February 14, 2025 18:26

jtimpe mentioned this pull request Mar 6, 2025

Release/v3.7.8 sprint 119+hotfix HHS/TANF-app#567

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Regional User Request Access #3440

Regional User Request Access #3440

Uh oh!

elipe17 commented Jan 23, 2025 •

edited by ADPennington

Loading

Uh oh!

codecov bot commented Jan 23, 2025 •

edited

Loading

Uh oh!

elipe17 commented Feb 7, 2025

Uh oh!

ADPennington commented Feb 10, 2025

Uh oh!

ADPennington commented Feb 11, 2025

Uh oh!

elipe17 commented Feb 13, 2025

Uh oh!

ADPennington commented Feb 14, 2025

Uh oh!

ADPennington Feb 14, 2025

Uh oh!

ADPennington left a comment

Uh oh!

Uh oh!

Uh oh!

Regional User Request Access #3440

Regional User Request Access #3440

Uh oh!

Conversation

elipe17 commented Jan 23, 2025 • edited by ADPennington Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

How to Test

Deliverables

Uh oh!

codecov bot commented Jan 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

elipe17 commented Feb 7, 2025

Uh oh!

ADPennington commented Feb 10, 2025

Uh oh!

ADPennington commented Feb 11, 2025

Uh oh!

elipe17 commented Feb 13, 2025

Uh oh!

ADPennington commented Feb 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ADPennington left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

elipe17 commented Jan 23, 2025 •

edited by ADPennington

Loading

codecov bot commented Jan 23, 2025 •

edited

Loading