Add foreign keys & update alembic revisions (#78)

* add foreign key & implied metadata

* combine alembic revisions

Author: EarthenSky

src/alembic/versions/04a41462e0a8_modify_site_user_table.py

@@ -1,61 +1,44 @@
-"""introduce officer tables
+"""create user session table
 
-Revision ID: 75857bf0c826
-Revises: 0db2c57ce969
-Create Date: 2024-06-03 06:36:40.642476
+Revision ID: 166f3772fce7
+Revises:
+Create Date: 2024-02-23 00:58:50.320796
 
 """
 
 from collections.abc import Sequence
+from datetime import datetime
 from typing import Union
 
 import sqlalchemy as sa
 from alembic import op
 
 # revision identifiers, used by Alembic.
-revision: str = "75857bf0c826"
-down_revision: str | None = "0db2c57ce969"
+revision: str = "166f3772fce7"
+down_revision: str | None = None
 branch_labels: str | Sequence[str] | None = None
 depends_on: str | Sequence[str] | None = None
 
 
 def upgrade() -> None:
-    # drop all existing user session data
-    # TODO: combine all past migrations into this one
-    op.drop_table("user_session")
-    op.create_table(
-        "user_session",
-        sa.Column("session_id", sa.String(512), nullable=False, primary_key=True),
-        sa.Column("issue_time", sa.DateTime, nullable=False),
-        sa.Column("computing_id", sa.String(32), nullable=False),
-    )
-    op.create_unique_constraint("unique__user_session__session_id", "user_session", ["session_id"])
-
-    # drop all existing site user data
-    # TODO: combine all past migrations into this one
-    op.drop_table("site_user")
     op.create_table(
         "site_user",
-        sa.Column("computing_id", sa.String(32), nullable=False, primary_key=True),
+        sa.Column("computing_id", sa.String(32), primary_key=True),
+        sa.Column("first_logged_in", sa.DateTime, nullable=False, default=datetime(2024, 6, 16)),
+        sa.Column("last_logged_in", sa.DateTime, nullable=False, default=datetime(2024, 6, 16)),
     )
-
     op.create_table(
-        "officer_info",
-        sa.Column("is_filled_in", sa.Boolean(), nullable=False),
-        sa.Column("legal_name", sa.String(length=128), nullable=False),
-        sa.Column("discord_id", sa.String(length=18), nullable=True),
-        sa.Column("discord_name", sa.String(length=32), nullable=True),
-        sa.Column("discord_nickname", sa.String(length=32), nullable=True),
-        sa.Column("computing_id", sa.String(length=32), nullable=False),
-        sa.Column("phone_number", sa.String(length=24), nullable=True),
-        sa.Column("github_username", sa.String(length=39), nullable=True),
-        sa.Column("google_drive_email", sa.Text(), nullable=True),
-        sa.PrimaryKeyConstraint("computing_id", name="pk__officer_info__computing_id"),
+        "user_session",
+        # NOTE: order is important; site_user must be created first!
+        sa.Column("computing_id", sa.String(32), sa.ForeignKey("site_user.computing_id"), primary_key=True),
+        sa.Column("issue_time", sa.DateTime, nullable=False),
+        sa.Column("session_id", sa.String(512), nullable=False, unique=True),
     )
+
     op.create_table(
         "officer_term",
-        sa.Column("id", sa.Integer(), nullable=False),
-        sa.Column("computing_id", sa.String(length=32), nullable=False),
+        sa.Column("id", sa.Integer(), primary_key=True, autoincrement=True),
+        sa.Column("computing_id", sa.String(length=32), sa.ForeignKey("site_user.computing_id"), nullable=False),
         sa.Column("is_filled_in", sa.Boolean(), nullable=False),
         sa.Column("position", sa.String(length=128), nullable=False),
         sa.Column("start_date", sa.DateTime(), nullable=False),
@@ -67,26 +50,23 @@ def upgrade() -> None:
         sa.Column("favourite_pl_1", sa.String(length=32), nullable=True),
         sa.Column("biography", sa.Text(), nullable=True),
         sa.Column("photo_url", sa.Text(), nullable=True),
-        sa.PrimaryKeyConstraint("id", name="pk__officer_term__id"),
     )
-
+    op.create_table(
+        "officer_info",
+        sa.Column("is_filled_in", sa.Boolean(), nullable=False),
+        sa.Column("legal_name", sa.String(length=128), nullable=False),
+        sa.Column("discord_id", sa.String(length=18), nullable=True),
+        sa.Column("discord_name", sa.String(length=32), nullable=True),
+        sa.Column("discord_nickname", sa.String(length=32), nullable=True),
+        sa.Column("computing_id", sa.String(length=32), sa.ForeignKey("user_session.computing_id"), primary_key=True),
+        sa.Column("phone_number", sa.String(length=24), nullable=True),
+        sa.Column("github_username", sa.String(length=39), nullable=True),
+        sa.Column("google_drive_email", sa.String(length=256), nullable=True),
+    )
 
 def downgrade() -> None:
-    op.drop_table("officer_term")
     op.drop_table("officer_info")
-
-    op.drop_table("site_user")
-    op.create_table(
-        "site_user",
-        sa.Column("id", sa.Integer, primary_key=True, autoincrement=True),
-        sa.Column("computing_id", sa.String(32), nullable=False),
-    )
+    op.drop_table("officer_term")
 
     op.drop_table("user_session")
-    op.create_table(
-        "user_session",
-        sa.Column("id", sa.Integer, primary_key=True, autoincrement=True),
-        sa.Column("issue_time", sa.DateTime, nullable=False),
-        sa.Column("session_id", sa.String(512), nullable=False),
-        sa.Column("computing_id", sa.String(32), nullable=False),
-    )
+    op.drop_table("site_user")

src/alembic/versions/066f3772fce6_create_user_session_table.py

@@ -3,15 +3,16 @@
 from constants import COMPUTING_ID_LEN, SESSION_ID_LEN
 from database import Base
 from sqlalchemy import Column, DateTime, ForeignKey, String
-from sqlalchemy.orm import relationship
 
 
 class UserSession(Base):
     __tablename__ = "user_session"
 
-    # note: a primary key is required for every database table
     computing_id = Column(
-        String(COMPUTING_ID_LEN), nullable=False, primary_key=True
+        String(COMPUTING_ID_LEN),
+        ForeignKey("site_user.computing_id"),
+        # in psql pkey means non-null
+        primary_key=True,
     )
 
     # time the CAS ticket was issued
@@ -27,11 +28,8 @@ class SiteUser(Base):
     # see: https://stackoverflow.com/questions/22256124/cannot-create-a-database-table-named-user-in-postgresql
     __tablename__ = "site_user"
 
-    # note: a primary key is required for every database table
     computing_id = Column(
         String(COMPUTING_ID_LEN),
-        #ForeignKey("user_session.computing_id"),
-        nullable=False,
         primary_key=True,
     )
 

src/alembic/versions/0db2c57ce969_add_persistent_user_table.py

@@ -7,20 +7,27 @@
 import asyncpg
 import sqlalchemy
 from fastapi import Depends, FastAPI
+from sqlalchemy import MetaData
 from sqlalchemy.ext.asyncio import (
     AsyncConnection,
     AsyncSession,
 )
 
-# Base = sqlalchemy.ext.declarative.declarative_base()
+convention = {
+    "ix": "ix_%(column_0_label)s", # index
+    "uq": "uq_%(table_name)s_%(column_0_name)s", # unique
+    "ck": "ck_%(table_name)s_%(constraint_name)s", # check
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", # foreign key
+    "pk": "pk_%(table_name)s", # primary key
+}
+
 Base = sqlalchemy.orm.declarative_base()
+Base.metadata = MetaData(naming_convention=convention)
 
 # from: https://medium.com/@tclaitken/setting-up-a-fastapi-app-with-async-sqlalchemy-2-0-pydantic-v2-e6c540be4308
 class DatabaseSessionManager:
     def __init__(self, db_url: str, engine_kwargs: dict[str, Any], check_db=True):
-        # engine = sqlalchemy.create_engine(SQLALCHEMY_DATABASE_URL)
         self._engine = sqlalchemy.ext.asyncio.create_async_engine(db_url, **engine_kwargs)
-        # SessionLocal = sqlalchemy.orm.sessionmaker(autocommit=False, autoflush=False, bind=engine)
         self._sessionmaker = sqlalchemy.ext.asyncio.async_sessionmaker(autocommit=False, bind=self._engine)
 
         if check_db:

src/alembic/versions/75857bf0c826_introduce_officer_tables.py renamed to src/alembic/versions/166f3772fce7_auth_officer_init.py

@@ -13,6 +13,7 @@
     Boolean,
     Column,
     DateTime,
+    ForeignKey,
     Integer,
     String,
     Text,
@@ -29,6 +30,7 @@ class OfficerTerm(Base):
     id = Column(Integer, primary_key=True, autoincrement=True)
     computing_id = Column(
         String(COMPUTING_ID_LEN),
+        ForeignKey("user_session.computing_id"),
         nullable=False,
     )
 
@@ -127,23 +129,21 @@ class OfficerInfo(Base):
     # private info will be added last
     computing_id = Column(
         String(COMPUTING_ID_LEN),
+        ForeignKey("user_session.computing_id"),
         primary_key=True,
     )
     phone_number = Column(String(24))
     github_username = Column(String(GITHUB_USERNAME_LEN))
 
-    # A comma separated list of emails
-    # technically 320 is the most common max-size for emails
-    # specifications for valid email addresses vary widely, but we will not
-    # accept any that contain a comma
-    google_drive_email = Column(Text)
+    # Technically 320 is the most common max-size for emails, but we'll use 256 instead,
+    # since it's reasonably large (input validate this too)
+    google_drive_email = Column(String(256))
 
     # NOTE: not sure if we'll need this, depending on implementation
+    # TODO: get this data on the fly when requested, but rate limit users
+    # to something like 1/s 100/hour
     # has_signed_into_bitwarden = Column(Boolean)
 
-    # TODO: can we represent more complicated data structures?
-    # has_autheticated_github = Column(Boolean)
-
     @staticmethod
     def from_data(is_filled_in: bool, officer_info_data: OfficerInfoData) -> OfficerTerm:
         return OfficerInfo(