Mark users as claimed when they reset passwords

from key

Mark users as claimed when they reset password from profile page

Add method to claim user, and use that method instead

Add docs on unclaimed user accounts
This commit is contained in:
Lacey Williams Henschel
2023-09-29 14:43:03 -07:00
committed by Lacey Henschel
parent 5f6125d907
commit 73c310fd1c
9 changed files with 107 additions and 2 deletions

View File

@@ -3,6 +3,7 @@
- [Development Setup Notes](./development_setup_notes.md)
- [Environment Variables](./env_vars.md)
- [Example Files](./examples/README.md) - Contains samples of `libraries.json`. `.gitmodules`, and other files that Boost data depends on
- [Handling "Unclaimed" User Accounts](./unclaimed_user_accounts.md) - Describes how we allow authors and maintainers to "claim" the accounts that we create for them as part of the library upload process
- [Management Commands](./commands.md)
- [Retrieving Static Content from the Boost Amazon S3 Bucket](./static_content.md)
- [Syncing Data about Boost Versions and Libraries with GitHub](./syncing_data_with_github.md)

View File

@@ -0,0 +1,24 @@
# Handling "Unclaimed" User Accounts
This page covers how to handle the User records that are created as part of the upload process from the [first-time data import](./first_time_data_import.md) and through [syncing with GitHub](./syncing_data_with_github.md).
The code for this page lives in the `users/` app.
## About Registration and Login
- We use Django Allauth to handle user accounts
- We do some overriding of their logic for the profile page
- We override the password reset logic as part of allowing users to claim their unclaimed accounts
## About Unclaimed User Accounts
- When libraries are created and updated from GitHub, we receive information on Library Maintainers and Authors.
- Those authors and maintainers are added as Users and then linked to the Library or LibraryVersion record they belong to.
- When they are created, the User accounts have their `claimed` field marked as False. This field defaults to `True`, and will only be `False` for users who were created by an automated process.
- We use the email address and name in the `libraries.json` file for that library to create the User record
## When An Unclaimed User Tries to Register
- If a user tries to register with the same email address as an existing user (a user with `claimed` set to `False`), we interrupt the Django Allauth registration error that happens in this case to check whether the user has been claimed
- If the user has `claimed` set to `False`, we send the user a custom message and send them a password reset email
- On the backend, we interrupt the Django Allauth password reset process to mark users as claimed once their password has been successfully reset