Issue #2595: update domain request view only pages - [ZA] #2753

zandercymatics · 2024-09-13T18:19:20Z

Ticket

Resolves #2595

Changes

Changes which date(s) display on the viewonly pages for which state. For instance, withdrawn now has a Withdrawn on: date.
Fixes a bug with cisa representative wherein it would always show no even if one did in fact exist.
Fixes a bug where the domain requests header in portfolio mode would show both domains and domain requests as active
Adds a breadcrumb instead of a back button for these pages

Context for reviewers

**Important: ** When viewing these changes in portfolio view, make sure that the domain requests that you add a portfolio have yourself set as the creator. We have not yet implemented a viewonly view, as that is a follow-on ticket. This means that you will only see these dates on the "manage" page for now.

To see your portfolio, you will need the following:

The waffle flags organization_feature and organization_requests enabled ("everyone" set to "yes)
A portfolio added on multiple domain requests
A new User portfolio permission record with yourself added as an admin. This can be found on that table.
A started domain request that you yourself created (aka using the start a new domain request button)

Note: You can technically view our viewonly mode for started and action needed domains, but its not yet supported. To do so, you need to copy the domain request id in the url, and navigate to http://getgov-za.app.cloud.gov/domain-request/{ID}.

Setup

You will need to test the following cases:

The view-only page on a domain request in every status (minus approved). Ensure that the dates here match the ones on the figma stylistically. Do note that in_review and ineligible will just show Last updated on as no update was specified.
Add a cisa representative to a domain request in view-only mode. Ensure that the cisa rep section doesn't display no, but instead displays their name
Ensure that clicking the view mode of a domain request doesn't cause a header bug where it looks like you are on the domains page, and the domains request page
Test that the breadcrumb works correctly
Test that all of the above still apply when in portfolio view

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
Added at least 2 developers as PR reviewers (only 1 will need to approve)
Messaged on Slack or in standup to notify the team that a PR is ready for review
Changes to “how we do things” are documented in READMEs and or onboarding guide
If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Original Developer)

All new functions and methods are commented using plain language
Did dependency updates in Pipfile also get changed 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)

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)
Add at least 1 designer as PR reviewer

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

Pulled this branch locally and tested it
Reviewed this code and left comments
Checked that all code is adequately covered by tests
Made it clear which comments need to be addressed before this work is merged
If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Code reviewer)

All new functions and methods are commented using plain language
Interactions with external systems are wrapped in try/except
Error handling exists for unusual or missing values
(Rarely needed) Did dependency updates in Pipfile also get changed in requirements.txt?

Validated user-facing changes as a developer

Note: Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist

As a designer reviewer, I have

Verified that the changes match the design intention

Checked that the design translated visually
Checked behavior
Checked different states (empty, one, some, error)
Checked for landmarks, page heading structure, and links
Tried to break the intended flow

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

Screenshots

github-actions · 2024-09-16T16:16:38Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-16T17:07:53Z

🥳 Successfully deployed to developer sandbox za.

zandercymatics · 2024-09-16T17:17:52Z

src/registrar/templatetags/custom_filters.py

+
+
+@register.filter(name="is_domain_request_subpage")
+def is_domain_request_subpage(path):


@dave-kennedy-ecs / @rachidatecs Just for your awareness, I had to add this logic to fix the headers. They weren't displaying correctly on many subpages. I've include this for portfolio and domains.

The easier solution here would have been to check a url like domain-requests/{some url} though I don't think we current follow that scheme

github-actions · 2024-09-16T17:19:33Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-16T17:23:14Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T15:23:18Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T17:25:16Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T17:35:28Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T17:51:01Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T17:58:26Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-17T18:05:52Z

🥳 Successfully deployed to developer sandbox za.

github-actions · 2024-09-18T21:12:57Z

🥳 Successfully deployed to developer sandbox za.

erinysong · 2024-09-18T22:37:39Z

Is the Created by field still within the scope of this ticket? I'm testing the different view only pages and noticed that they aren't displaying so wanted to check in case ACs changed from the ticket discussion thread earlier

erinysong · 2024-09-18T22:48:56Z

Results of the view only page on all domain statuses. Everything seems to display as expected aside from the missing Created by field as mentioned above

Started

Submitted

Rejected

Withdrawn - Not sure what case the view only page for this would be visible but wanted to note that the view-only page for Withdrawn domains gives the option to click the Withdraw button -- is this expected behavior?

Action Needed

erinysong · 2024-09-18T23:52:49Z

Verified CISA rep name displays correctly. Domain Requests view only page also no longer includes bug where both Domains and Domain Requests tab are active. Breadcrumb also looks good and works as expected

github-actions · 2024-09-19T14:08:23Z

🥳 Successfully deployed to developer sandbox za.

AnnaGingle

Awesome work!

zandercymatics · 2024-09-19T15:38:55Z

@erinysong

Is the Created by field still within the scope of this ticket? I'm testing the different view only pages and noticed that they aren't displaying so wanted to check in case ACs changed from the ticket discussion thread earlier

I asked the same thing! The answer is no (per @abroddrick) - that is actually handled in this follow on ticket. The same goes for any other content changes

Not sure what case the view only page for this would be visible but wanted to note that the view-only page for Withdrawn domains gives the option to click the Withdraw button -- is this expected behavior?

Yeah I noticed that too. That will be handled in the follow-on as it touches on some content changes given design OKs it.
Its a bug with the current implementation because I think its only checking if its not in "rejected" (or something like that - going from memory)

github-actions · 2024-09-19T16:18:50Z

🥳 Successfully deployed to developer sandbox za.

erinysong

Verified that things work on the UI and left some minor clarifying/planning questions! Everything else looks good and I can approve afterwards!

erinysong · 2024-09-19T15:46:53Z

src/registrar/templates/domain_request_status.html

+    {% comment %} 
+    These are intentionally seperated this way. 
+    There is some code repetition, but it gives us more flexibility rather than a dense reduction. 
+    Leave it this way until we've solidified our requirements.


Just checking if there ended up being any requirements set or any tickets to set these requirements on the way we display status and if we yes, if we should reference them here!

No tickets in particular that I am aware of! That is a good callout though and I'm glad you thought of that.

These pages are still undergoing design review + we are fleshing out the org feature. Personally, I think these dates may shift around - or we may decide to add some more in the future. That was my thinking, at least

erinysong · 2024-09-19T16:23:37Z

src/registrar/templatetags/custom_filters.py

+    """Checks if the given page is a subpage of domains.
+    Takes a path name, like '/domains/'."""
+    # Since our pages aren't unified under a common path, we need this approach for now.
+    url_names = [


Don't think this is necessary to address in this PR, but I imagine this may get bigger as we introduce pages/subpages so should we consider a ticket to revisit this and refactor our paths in a way that's easier to recognize a page's more meta traits? @abroddrick

I agree 100% with doing a refactor on our urls - and I share your concern about this list growing. Do you mind branching this off into a slack thread?

I'm in favor of a refactor ticket on these as you mentioned!

erinysong · 2024-09-19T16:25:03Z

src/registrar/templatetags/custom_filters.py

+def is_portfolio_subpage(path):
+    """Checks if the given page is a subpage of portfolio.
+    Takes a path name, like '/organization/'."""
+    # Since our pages aren't unified under a common path, we need this approach for now.


Same as the above comment that it may be worth revisiting how we organize our URL paths if we're adding more nested pages in the future

erinysong · 2024-09-19T16:29:06Z

src/registrar/models/domain_request.py

    notes = models.TextField(
        null=True,
        blank=True,
    )

+    def get_first_status_set_date(self, status):


Just curious, would we expect any cases where we'd want to get the date a request was first given a certain status aside from started?

Maybe for scripts or some info for django admin, but I'm not really concrete on it. I left this function around in case we need it, but honestly if you think it'd be more clear to just consolidate these I am totally OK with that too

Also don't have a strong opinion so I'm happy to go with whatever data from audit logs you think would be useful in the future!

github-actions · 2024-09-19T17:20:26Z

🥳 Successfully deployed to developer sandbox za.

erinysong

LGTM - thank you for answering clarifying questions! One nonblocking suggestion to consolidate the first started getter if you think there's no likely use cases for getting the first time a certain status was set, but will leave that to your discretion!

zandercymatics added 3 commits September 13, 2024 11:13

Update dates displayed + add created by per figma

01ce2fb

tweaks + cleanup on normal view

e5a011c

Fix main nav issue

5be9f3f

zandercymatics requested a review from abroddrick as a code owner September 13, 2024 18:19

zandercymatics added 2 commits September 13, 2024 12:23

Update domain_request_status.html

b5b2d69

Fix url path bug

eb38504

Add unit tests and cleanup

ef0e1c0

Add additional subpage logic

82c5d7f

zandercymatics commented Sep 16, 2024

View reviewed changes

lint

ac9edec

zandercymatics changed the title ~~(Draft) 2595 update domain request view only pages~~ Issue #2595: update domain request view only pages - [ZA] Sep 16, 2024

zandercymatics changed the title ~~Issue #2595: update domain request view only pages - [ZA]~~ (DRAFT) Issue #2595: update domain request view only pages - [ZA] Sep 17, 2024

Readd created by logic

b31c7cd

re-remove and fix breadcrumb

fe8a680

add subpage tests

e5f26e5

add breadcrumb for everyone

1248954

erinysong self-assigned this Sep 17, 2024

zandercymatics requested review from therealslimhsiehdy, Matt-Spence, CocoByte, rachidatecs and dave-kennedy-ecs September 17, 2024 17:53

zandercymatics requested review from erinysong and asaki222 September 17, 2024 17:53

lint

484a4b4

Update domain_request_status.html

11c7268

zandercymatics changed the title ~~(DRAFT) Issue #2595: update domain request view only pages - [ZA]~~ Issue #2595: update domain request view only pages - [ZA] Sep 17, 2024

zandercymatics requested review from Katherine-Osos and a team September 17, 2024 19:00

AnnaGingle requested review from AnnaGingle and removed request for a team and Katherine-Osos September 19, 2024 15:02

AnnaGingle approved these changes Sep 19, 2024

View reviewed changes

erinysong reviewed Sep 19, 2024

View reviewed changes

Merge branch 'main' into za/2595-update-domain-request-view-only-pages

999ed2f

erinysong approved these changes Sep 19, 2024

View reviewed changes

zandercymatics merged commit 3495101 into main Sep 19, 2024
10 checks passed

zandercymatics deleted the za/2595-update-domain-request-view-only-pages branch September 19, 2024 18:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #2595: update domain request view only pages - [ZA] #2753

Issue #2595: update domain request view only pages - [ZA] #2753

zandercymatics commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 16, 2024

zandercymatics Sep 16, 2024

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 18, 2024

erinysong commented Sep 18, 2024

erinysong commented Sep 18, 2024 •

edited

Loading

erinysong commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024

AnnaGingle left a comment

zandercymatics commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024

erinysong left a comment

erinysong Sep 19, 2024

zandercymatics Sep 19, 2024 •

edited

Loading

erinysong Sep 19, 2024

zandercymatics Sep 19, 2024

erinysong Sep 19, 2024

erinysong Sep 19, 2024

zandercymatics Sep 19, 2024

erinysong Sep 19, 2024

github-actions bot commented Sep 19, 2024

erinysong left a comment



		@register.filter(name="is_domain_request_subpage")
		def is_domain_request_subpage(path):

Issue #2595: update domain request view only pages - [ZA] #2753

Issue #2595: update domain request view only pages - [ZA] #2753

Conversation

zandercymatics commented Sep 13, 2024 • 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

Ensured code standards are met (Code reviewer)

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

Screenshots

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 16, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 16, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 17, 2024

github-actions bot commented Sep 18, 2024

erinysong commented Sep 18, 2024

erinysong commented Sep 18, 2024 • edited Loading

erinysong commented Sep 18, 2024 • edited Loading

github-actions bot commented Sep 19, 2024

AnnaGingle left a comment

Choose a reason for hiding this comment

zandercymatics commented Sep 19, 2024 • edited Loading

github-actions bot commented Sep 19, 2024

erinysong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zandercymatics Sep 19, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 19, 2024

erinysong left a comment

Choose a reason for hiding this comment

zandercymatics commented Sep 13, 2024 •

edited

Loading

erinysong commented Sep 18, 2024 •

edited

Loading

erinysong commented Sep 18, 2024 •

edited

Loading

zandercymatics commented Sep 19, 2024 •

edited

Loading

zandercymatics Sep 19, 2024 •

edited

Loading