[Issue #3546] Add user notification table

api/src/db/migrations/versions/2025_01_22_notification_table.py

@@ -0,0 +1,63 @@
+"""notification table
+
+Revision ID: fe052c05c757
+Revises: 99bb8e01ad38
+Create Date: 2025-01-22 13:01:54.955189
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "fe052c05c757"
+down_revision = "99bb8e01ad38"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "user_notification_log",
+        sa.Column("user_notification_log_id", sa.UUID(), nullable=False),
+        sa.Column("user_id", sa.UUID(), nullable=False),
+        sa.Column("notification_reason", sa.Text(), nullable=False),
+        sa.Column("notification_sent", sa.Boolean(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.Column(
+            "updated_at",
+            sa.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.ForeignKeyConstraint(
+            ["user_id"], ["api.user.user_id"], name=op.f("user_notification_log_user_id_user_fkey")
+        ),
+        sa.PrimaryKeyConstraint(
+            "user_notification_log_id", name=op.f("user_notification_log_pkey")
+        ),
+        schema="api",
+    )
+    op.create_index(
+        op.f("user_notification_log_user_id_idx"),
+        "user_notification_log",
+        ["user_id"],
+        unique=False,
+        schema="api",
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(
+        op.f("user_notification_log_user_id_idx"), table_name="user_notification_log", schema="api"
+    )
+    op.drop_table("user_notification_log", schema="api")
+    # ### end Alembic commands ###

api/src/db/models/user_models.py

@@ -101,3 +101,15 @@ class UserSavedSearch(ApiSchemaTable, TimestampMixin):
     search_query: Mapped[dict] = mapped_column(JSONB)
 
     name: Mapped[str]
+
+
+class UserNotificationLog(ApiSchemaTable, TimestampMixin):
+    __tablename__ = "user_notification_log"
+
+    user_notification_log_id: Mapped[uuid.UUID] = mapped_column(UUID, primary_key=True)
+
+    user_id: Mapped[uuid.UUID] = mapped_column(ForeignKey(User.user_id), index=True)
+    user: Mapped[User] = relationship(User)
+
+    notification_reason: Mapped[str]
+    notification_sent: Mapped[bool]

api/tests/src/db/models/factories.py

@@ -1979,6 +1979,19 @@ class Meta:
     email = factory.Faker("email")
 
 
+class UserNotificationLogFactory(BaseFactory):
+    class Meta:
+        model = user_models.UserNotificationLog
+
+    user_notification_log_id = Generators.UuidObj
+
+    user = factory.SubFactory(UserFactory)
+    user_id = factory.LazyAttribute(lambda s: s.user.user_id)
+
+    notification_reason = "test"
+    notification_sent = True
+
+
 class LoginGovStateFactory(BaseFactory):
     class Meta:
         model = user_models.LoginGovState