#3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] #3408

zandercymatics · 2025-01-27T16:29:04Z

Ticket

Resolves #3317

Changes

Hides "in-use" federal agencies from the federal agency dropdown (if a portfolio exists AND if the waffle flag is enabled or not)
Refactors the _form_complete logic to be more consistent across usage and fix code duplication

Context for reviewers

In the near future, we intend to enable the organization_requests waffle flag. When we do so, we anticipate that some users, particularly those with started domain requests, may not be on said portfolio. Since federal agency and portfolio are the same contextually -- and since we only want "verified" users to be making requests -- we want to hide "in-use" federal agencies for those users from the dropdown list.

To achieve this, I opted to not set the underlying federal agency to none. I instead am targeting the queryset, and I modified the organization_contact step unlock logic to take this into account. This logic is then piped (all using the same function) to the summary page as well, and the final _form_complete step.

During the ticket that implemented the domain request flow for portfolio, this form complete logic was simplified by only using a length compare on db_check_for_unlocking_steps. It was chosen at the time to keep the old logic intact, but this PR finishes the refactor of that area and cleans that bit of the code up. The reason is that I had to take the portfolio logic into account on the summary page, form compete page, and also the side bar unlock.

It is worth noting that a script will be ran that will clean up the federal agency field on started domain requests, so this logic will primarily target new domain requests after that is ran. But it is designed to be robust enough to handle misses.

Setup

Testing new domain requests

Enable the organization_feature and organization_requests waffle flags.
Create a portfolio with the same name as an existing federal agency. A great one to use is AMTRAK.
Remove the user profile permission of your user while keeping said flags turned on.
Create a new federal domain request on the non-org page
On the organization page, note that AMTRAK is no longer in the dropdown

Testing existing domain requests

Create a federal domain request for AMTRAK, complete it entirely but don't submit it.
Enable the organization_feature and organization_requests waffle flags.
Create a portfolio with the same name as an existing federal agency. A great one to use is AMTRAK.
Remove the user profile permission of your user while keeping said flags turned on.
Visit your existing domain request, note that the request should now be "incomplete" on organization and on the summary (and it should not let you submit)

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

Met the acceptance criteria, or will meet them in a subsequent PR
Created/modified automated tests
Update documentation in READMEs and/or onboarding guide

Ensured code standards are met (Original Developer)

If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
Interactions with external systems are wrapped in try/except
Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

Tag @dotgov-designers in this PR's Reviewers for design review. If code is not user-facing, delete design reviewer checklist
Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
Checked keyboard navigability
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

Pulled this branch locally and tested it
Verified code meets all checks above. Address any checks that are not satisfied
Reviewed this code and left comments. Indicate if comments must be addressed before code is merged
Checked that all code is adequately covered by tests
Verify migrations are valid and do not conflict with existing migrations

Validated user-facing changes as a developer

Note: Multiple code reviewers can share the checklists above, a second reviewer should not make a duplicate checklist. All checks should be checked before approving, even those labeled N/A.

New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
Checked keyboard navigability
Meets all designs and user flows provided by design/product
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
(Rarely needed) Tested as both an analyst and applicant user

As a designer reviewer, I have

Verified that the changes match the design intention

Checked that the design translated visually
Checked behavior. Comment any found issues or broken flows.
Checked different states (empty, one, some, error)
Checked for landmarks, page heading structure, and links

Validated user-facing changes as a designer

Checked keyboard navigability
Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
Tested with multiple browsers (check off which ones were used)
- Chrome
- Microsoft Edge
- FireFox
- Safari
(Rarely needed) Tested as both an analyst and applicant user

References

Code review best practices

Screenshots

github-actions · 2025-01-27T16:33:24Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2025-01-27T19:21:33Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2025-01-27T19:46:59Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2025-01-27T21:29:09Z

🥳 Successfully deployed to developer sandbox za.

zandercymatics · 2025-01-27T18:34:33Z

src/registrar/templates/includes/request_review_steps.html

-        {% if domain_request.organization_name %}
+        {% if domain_request.unlock_organization_contact %}


This change syncs the unlock state of each step to the incomplete dialog on the domain request page -- which further reduces code duplication.

I've just added it to this specific step and unlock_other_contacts for now

zandercymatics · 2025-01-28T16:12:47Z

src/registrar/utility/waffle.py

@@ -10,3 +11,18 @@ def flag_is_active_for_user(user, flag_name):
    request = HttpRequest()
    request.user = user
    return flag_is_active(request, flag_name)
+
+
+def flag_is_active_anywhere(flag_name):


We intend to use the organization_requests flag kind of like a y/n switch, where we intend to turn it on for everyone at once. This function is a drop-in replacement for doing flag_is_active(request=None, "organization_requests" because that relies moreso on an implementation bug and breaks when only specific users are defined. So - relying on something we define rather than a hack

@dave-kennedy-ecs -- you worked on this area extensively though, any thoughts on this? An alternative is of course just using said approach with those caveats

github-actions · 2025-01-28T17:02:12Z

🥳 Successfully deployed to developer sandbox za.

zandercymatics · 2025-01-28T21:37:56Z

src/registrar/tests/test_models.py

        )
-
        self.domain_request.other_contacts.add(other)


This test will be moved to another file. I'm leaving it in test_models for now so its easier to read the git log

github-actions · 2025-01-28T21:41:10Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2025-01-28T22:20:22Z

🥳 Successfully deployed to developer sandbox za.

zandercymatics · 2025-01-29T15:12:25Z

src/registrar/models/domain_request.py

+        return (
+            self.federal_agency is not None
+            or self.organization_name is not None
+            or self.address_line1 is not None
+            or self.city is not None
+            or self.state_territory is not None
+            or self.zipcode is not None
+            or self.urbanization is not None
+        )


This was the original logic for this unlock_contact page - but would we want this to be an and statement on all required fields?

zandercymatics · 2025-01-29T15:13:13Z

src/registrar/models/domain_request.py

-    def _is_interstate_complete(self):
-        # Interstate -> "About your organization" page can't be empty
-        return self.about_your_organization is not None


All of these functions actually presently exist on the DomainRequestWizard!

zandercymatics · 2025-01-29T15:16:16Z

src/registrar/views/domain_request.py

@@ -434,20 +424,38 @@ def db_check_for_unlocking_steps(self):
        Queries the DB for a domain request and returns a list of unlocked steps."""
        return [key for key, is_unlocked_checker in self.unlocking_steps.items() if is_unlocked_checker(self)]

+    def form_is_complete(self):


This is a modification of the old logic, org_steps_complete = len(self.db_check_for_unlocking_steps()) == len(self.steps). The domain request form on the org model had a key difference as compared to the standard one: it didn't have "conditional" steps. Length comparison only works without those, so this approach is more complete and takes into account all required steps and all currently unlocked steps

github-actions · 2025-01-29T18:15:05Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2025-01-29T22:48:44Z

🥳 Successfully deployed to developer sandbox za.

zandercymatics added 2 commits January 23, 2025 15:15

Core logic

a6de529

add check

a4f1abc

zandercymatics requested a review from abroddrick as a code owner January 27, 2025 16:29

zandercymatics changed the title ~~[draft] #3317: hide org federal agencies~~ [draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio Jan 27, 2025

zandercymatics added 2 commits January 27, 2025 10:37

Merge branch 'main' into za/3317-hide-org-federal-agencies

0725447

Add UI logic

297029a

Add unit test for waffle utility

1f9efb7

zandercymatics changed the title ~~[draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio~~ [draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio [NO SANDBOX] Jan 27, 2025

Add tests for unlock_organization_contact

bdb3875

zandercymatics changed the title ~~[draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio [NO SANDBOX]~~ [draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] Jan 28, 2025

zandercymatics commented Jan 28, 2025

View reviewed changes

zandercymatics requested review from therealslimhsiehdy, Matt-Spence, CocoByte, rachidatecs, dave-kennedy-ecs, erinysong, asaki222 and lizpearl January 28, 2025 16:28

zandercymatics added 2 commits January 28, 2025 09:57

Merge branch 'main' into za/3317-hide-org-federal-agencies

8504eb1

lint and fix test

ad79557

zandercymatics changed the title ~~[draft] #3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA]~~ #3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] Jan 28, 2025

Fix unit tests

0478d2b

zandercymatics commented Jan 28, 2025

View reviewed changes

remove test code and lint

4dba0a3

zandercymatics commented Jan 29, 2025

View reviewed changes

lint

b5935a3

Update test_forms.py

cc0c530

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] #3408

#3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] #3408

zandercymatics commented Jan 27, 2025 •

edited

Loading

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

zandercymatics Jan 27, 2025 •

edited

Loading

zandercymatics Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 28, 2025

zandercymatics Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

zandercymatics Jan 29, 2025

zandercymatics Jan 29, 2025

zandercymatics Jan 29, 2025

github-actions bot commented Jan 29, 2025

github-actions bot commented Jan 29, 2025

		{% if domain_request.organization_name %}
		{% if domain_request.unlock_organization_contact %}

#3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] #3408

Are you sure you want to change the base?

#3317: Don't allow non-org model domain requests for federal agencies in a portfolio [ZA] #3408

Conversation

zandercymatics commented Jan 27, 2025 • edited Loading

Ticket

Changes

Context for reviewers

Setup

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

Ensured code standards are met (Original Developer)

Validated user-facing changes (if applicable)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

Validated user-facing changes as a developer

As a designer reviewer, I have

Verified that the changes match the design intention

Validated user-facing changes as a designer

References

Screenshots

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

github-actions bot commented Jan 27, 2025

zandercymatics Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

zandercymatics Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 28, 2025

zandercymatics Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

zandercymatics Jan 29, 2025

Choose a reason for hiding this comment

zandercymatics Jan 29, 2025

Choose a reason for hiding this comment

zandercymatics Jan 29, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 29, 2025

github-actions bot commented Jan 29, 2025

zandercymatics commented Jan 27, 2025 •

edited

Loading

zandercymatics Jan 27, 2025 •

edited

Loading

zandercymatics Jan 28, 2025 •

edited

Loading

zandercymatics Jan 28, 2025 •

edited

Loading