|
| 1 | +""" |
| 2 | +Add communication preference columns to the user table. |
| 3 | +
|
| 4 | +SQLModel create_all() does not alter existing tables. Run this after pulling |
| 5 | +#189 changes if your local or deployed database predates comm_opt_in columns. |
| 6 | +
|
| 7 | +Usage: |
| 8 | + uv run python -m migrations.add_communication_preferences .env |
| 9 | + uv run python -m migrations.add_communication_preferences .env --apply |
| 10 | +""" |
| 11 | + |
| 12 | +from __future__ import annotations |
| 13 | + |
| 14 | +import argparse |
| 15 | +from dataclasses import dataclass |
| 16 | + |
| 17 | +from dotenv import load_dotenv |
| 18 | +from sqlalchemy import text |
| 19 | +from sqlmodel import Session, create_engine |
| 20 | + |
| 21 | +from utils.core.db import get_connection_url |
| 22 | + |
| 23 | +COLUMNS = ("comm_opt_in", "comm_updates", "comm_marketing") |
| 24 | + |
| 25 | + |
| 26 | +@dataclass |
| 27 | +class MigrationStats: |
| 28 | + missing_columns: tuple[str, ...] = () |
| 29 | + all_present: bool = False |
| 30 | + |
| 31 | + |
| 32 | +def _column_exists(session: Session, column_name: str) -> bool: |
| 33 | + result = session.connection().execute( |
| 34 | + text( |
| 35 | + """ |
| 36 | + SELECT 1 |
| 37 | + FROM information_schema.columns |
| 38 | + WHERE table_schema = 'public' |
| 39 | + AND table_name = 'user' |
| 40 | + AND column_name = :column_name |
| 41 | + """ |
| 42 | + ), |
| 43 | + {"column_name": column_name}, |
| 44 | + ) |
| 45 | + return result.first() is not None |
| 46 | + |
| 47 | + |
| 48 | +def add_communication_preference_columns(env_file: str, apply: bool) -> MigrationStats: |
| 49 | + load_dotenv(env_file, override=True) |
| 50 | + engine = create_engine(get_connection_url()) |
| 51 | + stats = MigrationStats() |
| 52 | + |
| 53 | + try: |
| 54 | + with Session(engine) as session: |
| 55 | + missing = tuple( |
| 56 | + column for column in COLUMNS if not _column_exists(session, column) |
| 57 | + ) |
| 58 | + stats.missing_columns = missing |
| 59 | + stats.all_present = not missing |
| 60 | + |
| 61 | + if apply and missing: |
| 62 | + session.connection().execute( |
| 63 | + text( |
| 64 | + """ |
| 65 | + ALTER TABLE "user" |
| 66 | + ADD COLUMN IF NOT EXISTS comm_opt_in BOOLEAN NOT NULL DEFAULT FALSE, |
| 67 | + ADD COLUMN IF NOT EXISTS comm_updates BOOLEAN NOT NULL DEFAULT FALSE, |
| 68 | + ADD COLUMN IF NOT EXISTS comm_marketing BOOLEAN NOT NULL DEFAULT FALSE |
| 69 | + """ |
| 70 | + ) |
| 71 | + ) |
| 72 | + session.commit() |
| 73 | + else: |
| 74 | + session.rollback() |
| 75 | + finally: |
| 76 | + engine.dispose() |
| 77 | + |
| 78 | + return stats |
| 79 | + |
| 80 | + |
| 81 | +def main() -> None: |
| 82 | + parser = argparse.ArgumentParser( |
| 83 | + description=( |
| 84 | + "Add comm_opt_in, comm_updates, and comm_marketing to the user table. " |
| 85 | + "Without --apply, runs in dry-run mode." |
| 86 | + ) |
| 87 | + ) |
| 88 | + parser.add_argument("env", help="Env file to use (e.g. .env)") |
| 89 | + parser.add_argument( |
| 90 | + "--apply", |
| 91 | + action="store_true", |
| 92 | + help="Apply the schema change (default is dry-run).", |
| 93 | + ) |
| 94 | + args = parser.parse_args() |
| 95 | + |
| 96 | + stats = add_communication_preference_columns( |
| 97 | + env_file=args.env, apply=args.apply |
| 98 | + ) |
| 99 | + mode = "APPLY" if args.apply else "DRY-RUN" |
| 100 | + if stats.all_present: |
| 101 | + print(f"[{mode}] All communication preference columns already exist.") |
| 102 | + return |
| 103 | + |
| 104 | + print(f"[{mode}] missing_columns={list(stats.missing_columns)}") |
| 105 | + if args.apply: |
| 106 | + print(f"[{mode}] Columns added successfully.") |
| 107 | + else: |
| 108 | + print("Dry-run only. Re-run with --apply to add columns.") |
| 109 | + |
| 110 | + |
| 111 | +if __name__ == "__main__": |
| 112 | + main() |
0 commit comments