darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-01 23:55:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update ADR-0003: InvitedUser Expirations

Browse Source 
This changeset updates ADR-0003 to clarify the work a bit more and remove a couple of extraneous steps.  The previous draft included provisions for creating a whole separate `expired` field, which is unnecessary.

h/t to @xlorepdarkhelm and @stvnrlly for catching this and asking about it!
This commit is contained in:
Carlo Costino
2023-11-08 10:05:22 -05:00
committed by GitHub
parent 9d0098b5c8
commit 3f900101c6
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3,7 +3,7 @@
| 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
@@ -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
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
@@ -55,8 +56,6 @@ This is the approach we've considered for implementing this change:
dates for when they need to expire. This would involve the following
potential changes:
- Add an `expired` flag to the `InvitedUser` model
- Change the `delete_invitations` scheduled job to `expire_invitations` and
change its behavior to check for `InvitedUser` objects that are older than
24 hours and flip the `expired` flag to `True`.
@@ -66,9 +65,11 @@ This is the approach we've considered for implementing this change:
changes.
- 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: