#2416: portfolio admin notification emails [BOB] #3441

dave-kennedy-ecs · 2025-02-01T12:04:46Z

Ticket

Resolves #2416

Changes

Announce when someone is added as an admin for a portfolio:
- Email is sent to all admins of a portfolio when someone is invited to become an admin.
  - Email is sent if someone is invited via registrar, in members section, add new member
  - Email is sent if someone is invited via registrar, in members section, edit member, update from basic to admin
  - Email is sent if someone is invited via django admin, portfolio invitations table, add new portfolio invitation (admin role)
  - Email is sent if portfolio invitation (with status invited) is updated in django admin, role updated from member to admin
Announce when someone is removed as admin for a portfolio:
- Email is sent to all admins of a portfolio when someone is removed as an admin.
  - Email is sent if member is removed from portfolio via members section of the registrar
  - Email is sent if member's role is updated from Admin to Basic via members section of the registrar

Context for reviewers

Code Review Notes:
Email sending for both addition and removal notification emails is centralized in utility/email_invitations.py
Template files hold the email content
Logic for when to call which emails is in admin.py (for DJA) and views/portfolios.py
Exception handling is also in these views
Most other code is incidental or minor bug fixes
There are many tests!

Setup

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

…-admin-emails

…ber to admin

…-admin-emails

…mins

github-actions · 2025-02-01T12:09:17Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T13:15:06Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T13:40:26Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T16:21:54Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T17:43:08Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T18:33:01Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T21:07:35Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T22:04:06Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T22:56:32Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-01T23:03:02Z

🥳 Successfully deployed to developer sandbox bob.

dave-kennedy-ecs · 2025-02-01T23:10:28Z

src/registrar/models/utility/portfolio_helper.py

-        existing_invitations = PortfolioInvitation.objects.exclude(
-            portfolio=user_portfolio_permission.portfolio
-        ).filter(email=user_portfolio_permission.user.email)
+        existing_invitations = PortfolioInvitation.objects.filter(email=user_portfolio_permission.user.email).exclude(
+            Q(portfolio=user_portfolio_permission.portfolio)
+            | Q(status=PortfolioInvitation.PortfolioInvitationStatus.RETRIEVED)
+        )


this fixes an undocumented bug where retrieved invitations were blocking creation of new invitations

dave-kennedy-ecs · 2025-02-01T23:10:39Z

src/registrar/models/utility/portfolio_helper.py

-        existing_invitations = PortfolioInvitation.objects.exclude(id=portfolio_invitation.id).filter(
-            email=portfolio_invitation.email
+        existing_invitations = PortfolioInvitation.objects.filter(email=portfolio_invitation.email).exclude(
+            Q(id=portfolio_invitation.id) | Q(status=PortfolioInvitation.PortfolioInvitationStatus.RETRIEVED)


this fixes an undocumented bug where retrieved invitations were blocking creation of new invitations

Katherine-MN · 2025-02-03T15:28:14Z

@dave-kennedy-ecs We're bundling the permission emails with the m5 design review next sprint (3281), so design will review these emails then.

github-actions · 2025-02-04T09:18:03Z

🥳 Successfully deployed to developer sandbox bob.

CocoByte

Thorough work overall. Just one small question.

CocoByte · 2025-02-06T04:40:54Z

src/registrar/admin.py

@@ -1642,30 +1648,57 @@ def save_model(self, request, obj, form, change):
        Emails sent to requested user / email.
        When exceptions are raised, return without saving model.
        """
-        if not change:  # Only send email if this is a new PortfolioInvitation (creation)
+        try:


I like the way you moved the try statement up

CocoByte · 2025-02-06T04:51:40Z

src/registrar/admin.py

+                    ):
+                        messages.warning(
+                            self.request, "Could not send email notification to existing organization admins."
+                        )


I could be missing something, but don't we need an else after this if-statement? Or does the function somehow terminate before setting the following success message?

No, we don't need an else. In this case, we don't want to raise exceptions when email send attempts fail. But we want views to create messages. So, we are returning a pass/fail boolean from the send_email methods. If it fails, we want to raise a warning. Whether pass or fail, we want to continue after the method completes.

CocoByte

lgtm

github-actions · 2025-02-06T18:47:59Z

🥳 Successfully deployed to developer sandbox bob.

github-actions · 2025-02-06T18:58:34Z

🥳 Successfully deployed to developer sandbox bob.

dave-kennedy-ecs added 10 commits January 30, 2025 06:33

Merge branch 'hotgov/3402-invitation-updates' into bob/2416-portfolio…

b4c697f

…-admin-emails

portfolio addition email send to admins on registrar invite

37f52aa

added support in forms and views for sending email on change from mem…

1bd73b6

…ber to admin

removal email template

04b375f

Merge branch 'hotgov/3402-invitation-updates' into bob/2416-portfolio…

f62dd76

…-admin-emails

updates to complete initial implementation of invitation emails to ad…

4ce9eff

…mins

handle demoted member

f786d13

handle removals

b1f528b

wip

5996c4d

handle changes to PortfolioInvitation in DJA

041df21

dave-kennedy-ecs requested a review from allly-b as a code owner February 1, 2025 12:04

fixed existing tests and lint errors

6671545

fix remaining broken test

1e280ed

added tests for test_email_invitations

be0c55d

testing PortfolioInvitationAdmin

c47122a

additional portfolio member tests

ff9c402

tests for PortfolioMemberDeleteView PortfolioInvitedMemberDeleteView

d29205f

updated tests for PortfolioMemberEditView

a089dbc

tests for PortfolioInvitedMemberEditView

f405ae8

lint

2ab3b04

dave-kennedy-ecs changed the title ~~[DRAFT] #2416: portfolio admin notification emails [BOB]~~ #2416: portfolio admin notification emails [BOB] Feb 1, 2025

dave-kennedy-ecs commented Feb 1, 2025

View reviewed changes

dave-kennedy-ecs requested review from lizpearl, therealslimhsiehdy, Matt-Spence, CocoByte, rachidatecs, Katherine-MN, erinysong, asaki222, zandercymatics and a team and removed request for a team and Katherine-MN February 3, 2025 09:42

Merge branch 'main' into bob/2416-portfolio-admin-emails

c1c4ec0

CocoByte self-assigned this Feb 5, 2025

CocoByte requested changes Feb 6, 2025

View reviewed changes

dave-kennedy-ecs requested a review from CocoByte February 6, 2025 09:34

CocoByte approved these changes Feb 6, 2025

View reviewed changes

Merge branch 'main' into bob/2416-portfolio-admin-emails

cf51677

Merge branch 'main' into bob/2416-portfolio-admin-emails

05aca45

dave-kennedy-ecs merged commit 5aebbb4 into main Feb 6, 2025
10 checks passed

dave-kennedy-ecs deleted the bob/2416-portfolio-admin-emails branch February 6, 2025 18:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2416: portfolio admin notification emails [BOB] #3441

#2416: portfolio admin notification emails [BOB] #3441

dave-kennedy-ecs commented Feb 1, 2025 •

edited

Loading

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

dave-kennedy-ecs Feb 1, 2025

dave-kennedy-ecs Feb 1, 2025

Katherine-MN commented Feb 3, 2025 •

edited

Loading

github-actions bot commented Feb 4, 2025

CocoByte left a comment

CocoByte Feb 6, 2025

CocoByte Feb 6, 2025

dave-kennedy-ecs Feb 6, 2025

CocoByte left a comment

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 6, 2025

#2416: portfolio admin notification emails [BOB] #3441

#2416: portfolio admin notification emails [BOB] #3441

Conversation

dave-kennedy-ecs commented Feb 1, 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 Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

github-actions bot commented Feb 1, 2025

dave-kennedy-ecs Feb 1, 2025

Choose a reason for hiding this comment

dave-kennedy-ecs Feb 1, 2025

Choose a reason for hiding this comment

Katherine-MN commented Feb 3, 2025 • edited Loading

github-actions bot commented Feb 4, 2025

CocoByte left a comment

Choose a reason for hiding this comment

CocoByte Feb 6, 2025

Choose a reason for hiding this comment

CocoByte Feb 6, 2025

Choose a reason for hiding this comment

dave-kennedy-ecs Feb 6, 2025

Choose a reason for hiding this comment

CocoByte left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 6, 2025

dave-kennedy-ecs commented Feb 1, 2025 •

edited

Loading

Katherine-MN commented Feb 3, 2025 •

edited

Loading