-
Notifications
You must be signed in to change notification settings - Fork 6
Batch confirm members #549
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
georgelgeback
wants to merge
5
commits into
main
Choose a base branch
from
batch-confirm-members
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
aae8cdf
Add stil-id support when registering
georgelgeback 701f8a4
Add simple test case to prevent inadvertent validation rollbacks
georgelgeback b39ff76
Add prereg member system and tests for it.
georgelgeback 8652243
Copilot suggested fixes. Added tests for regression prevention.
georgelgeback a71c9cb
Add missing pytest import oops
georgelgeback File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| from api_schemas.base_schema import BaseSchema | ||
| from pydantic_extra_types.phone_numbers import PhoneNumber | ||
|
|
||
|
|
||
| class PreregMemberCreate(BaseSchema): | ||
| telephone_number: PhoneNumber | None = None | ||
| stil_id: str | None = None | ||
| email: str | None = None | ||
|
|
||
|
|
||
| class PreregMemberUpdate(BaseSchema): | ||
| telephone_number: PhoneNumber | None = None | ||
| stil_id: str | None = None | ||
| email: str | None = None | ||
|
|
||
|
|
||
| class PreregMemberRead(BaseSchema): | ||
| prereg_member_id: int | ||
| telephone_number: PhoneNumber | None = None | ||
| stil_id: str | None = None | ||
| email: str | None = None |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| from typing import Optional | ||
| from sqlalchemy import CheckConstraint, String, UniqueConstraint | ||
| from sqlalchemy.orm import Mapped, mapped_column | ||
| from .base_model import BaseModel_DB | ||
|
|
||
| from helpers.constants import MAX_TELEPHONE_LEN | ||
|
|
||
|
|
||
| class PreregMember_DB(BaseModel_DB): | ||
| __tablename__ = "prereg_member_table" | ||
| prereg_member_id: Mapped[int] = mapped_column( | ||
| primary_key=True, init=False | ||
| ) # Not the id the user will have when confirmed as member! | ||
|
|
||
| telephone_number: Mapped[Optional[str]] = mapped_column(String(MAX_TELEPHONE_LEN), default=None) | ||
| stil_id: Mapped[Optional[str]] = mapped_column(default=None) | ||
| email: Mapped[Optional[str]] = mapped_column(default=None) | ||
|
|
||
| __table_args__ = ( | ||
| CheckConstraint( | ||
| "telephone_number IS NOT NULL OR stil_id IS NOT NULL OR email IS NOT NULL", | ||
| name="at_least_one_identifier_required", | ||
| ), | ||
| UniqueConstraint( | ||
| "telephone_number", | ||
| "stil_id", | ||
| "email", | ||
| name="unique_all", | ||
| postgresql_nulls_not_distinct=True, # Without this, NULL =/= NULL, failing many unique_all tests | ||
| ), | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import re | ||
|
|
||
|
|
||
| def check_stil_id(s: str) -> bool: | ||
| if not len(s) == 10: | ||
| return False | ||
| pattern = r"^[a-z]{2}\d{4}[a-z]{2}-s$" | ||
| return bool(re.fullmatch(pattern, s)) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| from fastapi import APIRouter, Body, HTTPException | ||
| from database import DB_dependency | ||
| from db_models.prereg_member_model import PreregMember_DB | ||
| from api_schemas.prereg_member_schema import ( | ||
| PreregMemberCreate, | ||
| PreregMemberRead, | ||
| PreregMemberUpdate, | ||
| ) | ||
| from user.permission import Permission | ||
| from helpers.check_stil_id import check_stil_id | ||
| import phonenumbers | ||
|
|
||
| prereg_member_router = APIRouter() | ||
|
|
||
|
|
||
| def normalize_telephone_number(telephone_number: str | None) -> str | None: | ||
| if telephone_number is None: | ||
| return None | ||
|
|
||
| return phonenumbers.format_number( | ||
| phonenumbers.parse(str(telephone_number), None), phonenumbers.PhoneNumberFormat.E164 | ||
| ) | ||
|
|
||
|
|
||
| def prereg_member_matches(member: PreregMember_DB, data: PreregMemberCreate | PreregMemberUpdate) -> bool: | ||
| return ( | ||
| normalize_telephone_number(member.telephone_number) == normalize_telephone_number(data.telephone_number) | ||
| and member.stil_id == data.stil_id | ||
| and member.email == data.email | ||
| ) | ||
|
|
||
|
|
||
| def validate_identifiers(data: PreregMemberCreate | PreregMemberUpdate) -> bool: | ||
| if data.stil_id: | ||
| if not check_stil_id(data.stil_id): | ||
| return False | ||
|
|
||
| if data.email: | ||
| if "@" not in data.email or "." not in data.email: | ||
| return False | ||
|
|
||
| return True | ||
|
|
||
|
|
||
| @prereg_member_router.get("/", response_model=list[PreregMemberRead], dependencies=[Permission.require("view", "User")]) | ||
| def get_all_prereg_member_info(db: DB_dependency): | ||
| all_prereg_members = db.query(PreregMember_DB).all() | ||
| return all_prereg_members | ||
|
|
||
|
|
||
| @prereg_member_router.get( | ||
| "/{prereg_member_id}", response_model=PreregMemberRead, dependencies=[Permission.require("view", "User")] | ||
| ) | ||
| def get_prereg_member_info(prereg_member_id: int, db: DB_dependency): | ||
| prereg_member = db.query(PreregMember_DB).filter(PreregMember_DB.prereg_member_id == prereg_member_id).one_or_none() | ||
| if not prereg_member: | ||
| raise HTTPException(404, detail="Prereg member not found") | ||
| return prereg_member | ||
|
|
||
|
|
||
| @prereg_member_router.post("/", response_model=PreregMemberRead, dependencies=[Permission.require("manage", "User")]) | ||
| def create_prereg_member( | ||
| data: PreregMemberCreate, | ||
| db: DB_dependency, | ||
| ): | ||
| if not (data.telephone_number or data.stil_id or data.email): | ||
| raise HTTPException( | ||
| 400, detail="At least one identifier (telephone number, stil_id, or email) must be provided" | ||
| ) | ||
|
|
||
| if not validate_identifiers(data): | ||
| raise HTTPException(400, detail="Invalid identifier(s) provided") | ||
|
|
||
| existing_prereg_member = next( | ||
| (member for member in db.query(PreregMember_DB).all() if prereg_member_matches(member, data)), | ||
| None, | ||
| ) | ||
| if existing_prereg_member: | ||
| raise HTTPException(400, detail="Prereg member with the exact same details already exists") | ||
| prereg_member = PreregMember_DB( | ||
| telephone_number=data.telephone_number, | ||
| stil_id=data.stil_id, | ||
| email=data.email, | ||
| ) | ||
| db.add(prereg_member) | ||
| db.commit() | ||
| return prereg_member | ||
|
|
||
|
|
||
| @prereg_member_router.post( | ||
| "/multiple", | ||
| response_model=list[PreregMemberRead], | ||
| dependencies=[Permission.require("manage", "User")], | ||
| ) | ||
| def create_multiple_prereg_members( | ||
| data: list[PreregMemberCreate], | ||
| db: DB_dependency, | ||
| ): | ||
| prereg_members: list[PreregMember_DB] = [] | ||
| existing_prereg_members: list[PreregMember_DB] = [] | ||
|
|
||
| if not data: | ||
| raise HTTPException(400, detail="No prereg members provided") | ||
|
|
||
| for member_data in data: | ||
| if not (member_data.telephone_number or member_data.stil_id or member_data.email): | ||
| raise HTTPException( | ||
| 400, | ||
| detail="At least one identifier (telephone number, stil_id, or email) must be provided for all entries you want to add", | ||
| ) | ||
|
|
||
| if not validate_identifiers(member_data): | ||
| raise HTTPException( | ||
| 400, | ||
| detail=f"One of the entries had an invalid identifier. At least one of the telephone number: {member_data.telephone_number}, stil_id: {member_data.stil_id}, or email: {member_data.email} is invalid", | ||
| ) | ||
|
|
||
| existing_prereg_member = next( | ||
| (member for member in db.query(PreregMember_DB).all() if prereg_member_matches(member, member_data)), | ||
| None, | ||
| ) | ||
|
|
||
| if existing_prereg_member: | ||
| # There is already an entry with the exact same combination of identifiers. | ||
| # Erroring here would be too strict | ||
| existing_prereg_members.append(existing_prereg_member) | ||
| continue | ||
|
|
||
| prereg_member = PreregMember_DB( | ||
| telephone_number=member_data.telephone_number, | ||
| stil_id=member_data.stil_id, | ||
| email=member_data.email, | ||
| ) | ||
| db.add(prereg_member) | ||
| prereg_members.append(prereg_member) | ||
|
|
||
| if len(existing_prereg_members) == len(data): | ||
| raise HTTPException(400, detail="All prereg members already exist") | ||
|
|
||
| db.commit() | ||
|
|
||
| # Note: returns all existing prereg members that would collide unless they were skipped, not the newly created prereg members | ||
| return existing_prereg_members | ||
|
Comment on lines
+142
to
+143
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the frontend, we use the collision count to report collisions in a nice way back to the user. AFAIK we have never ever used returned rows to discover IDs in any part of the frontend, so I think it can be safely ignored. |
||
|
|
||
|
|
||
| @prereg_member_router.patch( | ||
| "/{prereg_member_id}", response_model=PreregMemberRead, dependencies=[Permission.require("manage", "User")] | ||
| ) | ||
| def update_prereg_member(prereg_member_id: int, data: PreregMemberUpdate, db: DB_dependency): | ||
| prereg_member = db.query(PreregMember_DB).filter(PreregMember_DB.prereg_member_id == prereg_member_id).one_or_none() | ||
| if not prereg_member: | ||
| raise HTTPException(404, detail="Prereg member not found") | ||
|
|
||
| if not validate_identifiers(data): | ||
| raise HTTPException(400, detail="Invalid identifier(s) provided") | ||
|
|
||
| for var, value in data.model_dump(exclude_unset=True).items(): | ||
| # Update the fields even if they are being set to None so they can be cleared | ||
| setattr(prereg_member, var, value) | ||
|
|
||
| if not (prereg_member.telephone_number or prereg_member.stil_id or prereg_member.email): | ||
| db.rollback() | ||
| raise HTTPException( | ||
| 400, detail="At least one identifier (telephone number, stil_id, or email) must be provided" | ||
| ) | ||
|
|
||
| db.commit() | ||
| return prereg_member | ||
|
|
||
|
|
||
| @prereg_member_router.delete( | ||
| "/multiple", | ||
| response_model=list[PreregMemberRead], | ||
| dependencies=[Permission.require("manage", "User")], | ||
| ) | ||
| def delete_multiple_prereg_members( | ||
| db: DB_dependency, | ||
| prereg_member_ids: list[int] = Body(...), | ||
| ): | ||
| prereg_members = db.query(PreregMember_DB).filter(PreregMember_DB.prereg_member_id.in_(prereg_member_ids)).all() | ||
| if not prereg_members: | ||
| raise HTTPException(404, detail="No prereg members found for the provided ids") | ||
| if len(prereg_members) != len(prereg_member_ids): | ||
| raise HTTPException(404, detail="Some prereg members not found for the provided ids") | ||
| for member in prereg_members: | ||
| db.delete(member) | ||
| db.commit() | ||
| return prereg_members | ||
|
|
||
|
|
||
| @prereg_member_router.delete( | ||
| "/{prereg_member_id}", response_model=PreregMemberRead, dependencies=[Permission.require("manage", "User")] | ||
| ) | ||
| def delete_prereg_member(prereg_member_id: int, db: DB_dependency): | ||
| prereg_member = db.query(PreregMember_DB).filter(PreregMember_DB.prereg_member_id == prereg_member_id).one_or_none() | ||
| if not prereg_member: | ||
| raise HTTPException(404, detail="Prereg member not found") | ||
| db.delete(prereg_member) | ||
| db.commit() | ||
| return prereg_member | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.