Add the Annotation.moderation_status column

h/migrations/versions/bd0cc0e6ed54_create_the_moderation_status_column.py

@@ -0,0 +1,28 @@
+"""Create the moderation_status column."""
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+revision = "bd0cc0e6ed54"
+down_revision = "1d26b96db4af"
+
+
+def upgrade() -> None:
+    moderation_status_type = postgresql.ENUM(
+        "APPROVED",
+        "DENIED",
+        "SPAM",
+        "PENDING",
+        name="moderationstatus",
+    )
+    moderation_status_type.create(op.get_bind(), checkfirst=True)
+
+    op.add_column(
+        "annotation",
+        sa.Column("moderation_status", moderation_status_type, nullable=True),
+    )
+
+
+def downgrade() -> None:
+    op.drop_column("annotation", "moderation_status")

h/models/annotation.py

@@ -1,20 +1,32 @@
 import datetime
+from enum import Enum
 from uuid import UUID
 
 import sqlalchemy as sa
 from sqlalchemy.dialects import postgresql as pg
 from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.ext.mutable import MutableDict, MutableList
+from sqlalchemy.orm import Mapped, relationship
 
 from h.db import Base, types
 from h.models.group import Group
 from h.util import markdown_render, uri
 from h.util.user import split_user
 
 
+class ModerationStatus(Enum):
+    APPROVED = "APPROVED"
+    PENDING = "PENDING"
+    DENIED = "DENIED"
+    SPAM = "SPAM"
+
+
 class Annotation(Base):
     """Model class representing a single annotation."""
 
+    # Expose the ModerationStatus directly here
+    ModerationStatus = ModerationStatus
+
     __tablename__ = "annotation"
     __table_args__ = (
         # Tags are stored in an array-type column, and indexed using a
@@ -68,7 +80,7 @@ class Annotation(Base):
         index=True,
     )
 
-    group = sa.orm.relationship(
+    group = relationship(
         Group,
         primaryjoin=(Group.pubid == groupid),
         foreign_keys=[groupid],
@@ -138,11 +150,15 @@ class Annotation(Base):
         uselist=True,
     )
 
-    mentions = sa.orm.relationship("Mention", back_populates="annotation")
+    mentions = relationship("Mention", back_populates="annotation")
 
-    notifications = sa.orm.relationship(
-        "Notification", back_populates="source_annotation"
-    )
+    notifications = relationship("Notification", back_populates="source_annotation")
+
+    moderation_status: Mapped[ModerationStatus | None]
+    """Current moderation status of the annotation.
+
+    None means the annotation is either "approved" before this column was added  or it's a private annotation.
+    """
 
     @property
     def uuid(self):