darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-04 10:21:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #583 from GSA/adr-0003-updates

Browse Source 
Update ADR-0003: InvitedUser Expirations
This commit is contained in:
Steven Reilly
2023-11-08 10:22:08 -05:00
committed by GitHub
parent 9d0098b5c8 c364c8fdab
commit 5aaa18e210
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/adrs/0003-implementing-invite-expirations.md
View File

@@ -3,7 +3,7 @@
| CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS | | CREATED DATE | LAST UPDATED | STATUS | AUTHOR | STAKEHOLDERS |
| :---: | :---: | :---: | :---: | :---: | | :---: | :---: | :---: | :---: | :---: |
| 06/06/2023 | 09/15/2023 | Accepted | @ccostino | @GSA/notify-contributors | | 06/06/2023 | 11/08/2023 | Accepted | @ccostino | @GSA/notify-contributors |
## CONTEXT AND PROBLEM STATEMENT ## CONTEXT AND PROBLEM STATEMENT
@@ -30,7 +30,8 @@ has more specific details.)
We'd like to adjust the API and data model so that invited users are no longer We'd like to adjust the API and data model so that invited users are no longer
deleted from the system and are instead tracked as active or expired. When an deleted from the system and are instead tracked as active or expired. When an
invite is expired, we'd like to be able to re-invite the person. invite is expired, we'd like to be able to show that in the invited users
screen and provide the ability re-invite the person.
### SECURITY COMPLIANCE CONSIDERATIONS ### SECURITY COMPLIANCE CONSIDERATIONS
@@ -55,20 +56,20 @@ This is the approach we've considered for implementing this change:
dates for when they need to expire. This would involve the following dates for when they need to expire. This would involve the following
potential changes: potential changes:
- Add an `expired` flag to the `InvitedUser` model
- Change the `delete_invitations` scheduled job to `expire_invitations` and - Change the `delete_invitations` scheduled job to `expire_invitations` and
change its behavior to check for `InvitedUser` objects that are older than change its behavior to check for `InvitedUser` objects that are older than
24 hours and flip the `expired` flag to `True`. 24 hours and change the status type to `expired`.
- Add an additional `INVITE_EXPIRED` status to the API and include it in the - Add an additional `INVITE_EXPIRED` status to the API and include it in the
`INVITED_USER_STATUS_TYPES` enum. This will be necessary for future UI `INVITED_USER_STATUS_TYPES` enum. This will be necessary for future UI
changes. changes.
- Make sure the API responses that provided `InvitedUser` objects/data - Make sure the API responses that provided `InvitedUser` objects/data
included the new `expired` field and status. included the new `expired` status.
- Update all tests related to `InvitedUsers` to account for the new behavior. - Update all tests related to `InvitedUsers` to account for the new behavior;
this may require making a new test or two to check explicitly for the new
`expired` status.
The pros in making this change: The pros in making this change: