LJ-365 New Comments models (#5833)

Co-authored-by: Jade Wibbels <[email protected]>
Co-authored-by: Adrian Galvan <[email protected]>

Author: 3 people

.fides/db_dataset.yml

@@ -143,6 +143,46 @@ dataset:
     - name: user_id
       data_categories:
       - user.unique_id
+  - name: comment
+    fields:
+    - name: comment_text
+      data_categories:
+      - system.operations
+    - name: comment_type
+      data_categories:
+      - system.operations
+    - name: created_at
+      data_categories:
+      - system.operations
+    - name: id
+      data_categories:
+      - system.operations
+    - name: updated_at
+      data_categories:
+      - system.operations
+    - name: user_id
+      data_categories:
+      - system.operations
+  - name: comment_reference
+    fields:
+    - name: comment_id
+      data_categories:
+      - system.operations
+    - name: created_at
+      data_categories:
+      - system.operations
+    - name: id
+      data_categories:
+      - system.operations
+    - name: reference_id
+      data_categories:
+      - system.operations
+    - name: reference_type
+      data_categories:
+      - system.operations
+    - name: updated_at
+      data_categories:
+      - system.operations
   - name: client
     fields:
     - name: created_at

CHANGELOG.md

@@ -26,6 +26,7 @@ Changes can also be flagged with a GitHub label for tracking purposes. The URL o
 - DB model support for messages on `MonitorExecution` records [#5846](https://github.com/ethyca/fides/pull/5846) https://github.com/ethyca/fides/labels/db-migration
 - Added support for GPP String integration in Fides String [#5845](https://github.com/ethyca/fides/pull/5845)
 - Attachments storage capabilities (S3 or local) [#5812](https://github.com/ethyca/fides/pull/5812) https://github.com/ethyca/fides/labels/db-migration
+- DB model support for Comments [#5833](https://github.com/ethyca/fides/pull/5833/files) https://github.com/ethyca/fides/labels/db-migration
 
 ### Changed
 - Bumped supported Python versions to `3.10.16` and `3.9.21` [#5840](https://github.com/ethyca/fides/pull/5840)

src/fides/api/alembic/migrations/versions/69ad6d844e21_add_comments_and_comment_references.py

@@ -0,0 +1,84 @@
+"""Add comments and comment references
+
+Revision ID: 69ad6d844e21
+Revises: 6ea2171c544f
+Create Date: 2025-03-03 16:31:22.495305
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "69ad6d844e21"
+down_revision = "6ea2171c544f"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "comment",
+        sa.Column("id", sa.String(), nullable=False),
+        sa.Column("user_id", sa.String(), nullable=True),
+        sa.Column("comment_text", sa.String(), nullable=False),
+        sa.Column("comment_type", sa.String(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.Column(
+            "updated_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=True,
+        ),
+        sa.ForeignKeyConstraint(["user_id"], ["fidesuser.id"], ondelete="SET NULL"),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_table(
+        "comment_reference",
+        sa.Column("id", sa.String(), nullable=False),
+        sa.Column("comment_id", sa.String(), nullable=False),
+        sa.Column("reference_id", sa.String(), nullable=False),
+        sa.Column("reference_type", sa.String(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.Column(
+            "updated_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=True,
+        ),
+        sa.ForeignKeyConstraint(["comment_id"], ["comment.id"], ondelete="CASCADE"),
+        sa.PrimaryKeyConstraint("comment_id", "reference_id"),
+    )
+    # Add index on comment_reference.reference_id
+    op.create_index(
+        "ix_comment_reference_reference_id",
+        "comment_reference",
+        ["reference_id"],
+    )
+    # Add index on comment_reference.reference_type
+    op.create_index(
+        "ix_comment_reference_reference_type",
+        "comment_reference",
+        ["reference_type"],
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # Drop the index on comment_reference.reference_id
+    op.drop_index("ix_comment_reference_reference_id", table_name="comment_reference")
+    # Drop the index on comment_reference.reference_type
+    op.drop_index("ix_comment_reference_reference_type", table_name="comment_reference")
+    op.drop_table("comment_reference")
+    op.drop_table("comment")
+    # ### end Alembic commands ###

src/fides/api/models/comment.py

@@ -0,0 +1,109 @@
+from enum import Enum as EnumType
+from typing import Any
+
+from sqlalchemy import Column
+from sqlalchemy import Enum as EnumColumn
+from sqlalchemy import ForeignKey, String, UniqueConstraint
+from sqlalchemy.ext.declarative import declared_attr
+from sqlalchemy.orm import Session, relationship
+
+from fides.api.db.base_class import Base
+from fides.api.models.attachment import Attachment, AttachmentReference
+from fides.api.models.fides_user import FidesUser  # pylint: disable=unused-import
+
+
+class CommentType(str, EnumType):
+    """
+    Enum for comment types. Indicates comment usage.
+
+    - notes are internal comments.
+    - reply comments are public and may cause an email or other communciation to be sent
+    """
+
+    note = "note"
+    reply = "reply"
+
+
+class CommentReferenceType(str, EnumType):
+    """
+    Enum for comment reference types. Indicates where the comment is referenced.
+    """
+
+    manual_step = "manual_step"
+    privacy_request = "privacy_request"
+
+
+class CommentReference(Base):
+    """
+    Stores information about a comment and any other element which may reference that comment.
+    """
+
+    @declared_attr
+    def __tablename__(cls) -> str:
+        """Overriding base class method to set the table name."""
+        return "comment_reference"
+
+    comment_id = Column(String, ForeignKey("comment.id"), nullable=False)
+    reference_id = Column(String, nullable=False)
+    reference_type = Column(EnumColumn(CommentReferenceType), nullable=False)
+
+    __table_args__ = (
+        UniqueConstraint("comment_id", "reference_id", name="comment_reference_uc"),
+    )
+
+    comment = relationship(
+        "Comment",
+        back_populates="references",
+        uselist=False,
+    )
+
+    @classmethod
+    def create(
+        cls, db: Session, *, data: dict[str, Any], check_name: bool = False
+    ) -> "CommentReference":
+        """Creates a new comment reference record in the database."""
+        return super().create(db=db, data=data, check_name=check_name)
+
+
+class Comment(Base):
+    """
+    Stores information about a Comment.
+    """
+
+    user_id = Column(
+        String, ForeignKey("fidesuser.id", ondelete="SET NULL"), nullable=True
+    )
+    comment_text = Column(String, nullable=False)
+    comment_type = Column(EnumColumn(CommentType), nullable=False)
+
+    user = relationship(
+        "FidesUser",
+        backref="comments",
+        lazy="selectin",
+        uselist=False,
+    )
+
+    references = relationship(
+        "CommentReference",
+        back_populates="comment",
+        cascade="all, delete",
+        uselist=True,
+    )
+
+    def get_attachments(self, db: Session) -> list[Attachment]:
+        """Retrieve all attachments associated with this comment."""
+        stmt = (
+            db.query(Attachment)
+            .join(
+                AttachmentReference, Attachment.id == AttachmentReference.attachment_id
+            )
+            .where(AttachmentReference.reference_id == self.id)
+        )
+        return db.execute(stmt).scalars().all()
+
+    def delete(self, db: Session) -> None:
+        """Delete the comment and all associated references."""
+        attachments = self.get_attachments(db)
+        for attachment in attachments:
+            attachment.delete(db)
+        db.delete(self)

tests/ctl/models/conftest.py

@@ -0,0 +1,97 @@
+import boto3
+import pytest
+from moto import mock_aws
+
+from fides.api.models.attachment import (
+    Attachment,
+    AttachmentReference,
+    AttachmentReferenceType,
+    AttachmentType,
+)
+from fides.api.schemas.storage.storage import StorageDetails
+
+
+@pytest.fixture
+def s3_client(storage_config):
+    with mock_aws():
+        session = boto3.Session(
+            aws_access_key_id="fake_access_key",
+            aws_secret_access_key="fake_secret_key",
+            region_name="us-east-1",
+        )
+        s3 = session.client("s3")
+        s3.create_bucket(Bucket=storage_config.details[StorageDetails.BUCKET.value])
+        yield s3
+
+
+@pytest.fixture
+def attachment_data(user, storage_config):
+    """Returns attachment data."""
+    return {
+        "user_id": user.id,
+        "file_name": "file.txt",
+        "attachment_type": AttachmentType.internal_use_only,
+        "storage_key": storage_config.key,
+    }
+
+
+@pytest.fixture
+def attachment(s3_client, db, attachment_data, monkeypatch):
+    """Creates an attachment."""
+
+    def mock_get_s3_client(auth_method, storage_secrets):
+        return s3_client
+
+    monkeypatch.setattr("fides.api.tasks.storage.get_s3_client", mock_get_s3_client)
+    attachment = Attachment.create_and_upload(
+        db, data=attachment_data, attachment_file=b"file content"
+    )
+    yield attachment
+    attachment.delete(db)
+
+
+@pytest.fixture
+def multiple_attachments(s3_client, db, attachment_data, user, monkeypatch):
+    """Creates multiple attachments."""
+
+    def mock_get_s3_client(auth_method, storage_secrets):
+        return s3_client
+
+    monkeypatch.setattr("fides.api.tasks.storage.get_s3_client", mock_get_s3_client)
+
+    attachment_data["user_id"] = user.id
+    attachment_data["file_name"] = "file_1.txt"
+    attachment_1 = Attachment.create_and_upload(
+        db, data=attachment_data, attachment_file=b"file content 1"
+    )
+
+    attachment_data["file_name"] = "file_2.txt"
+    attachment_2 = Attachment.create_and_upload(
+        db, data=attachment_data, attachment_file=b"file content 2"
+    )
+
+    attachment_data["file_name"] = "file_3.txt"
+    attachment_3 = Attachment.create_and_upload(
+        db, data=attachment_data, attachment_file=b"file content 3"
+    )
+
+    yield attachment_1, attachment_2, attachment_3
+
+    attachment_1.delete(db)
+    attachment_2.delete(db)
+    attachment_3.delete(db)
+
+
+@pytest.fixture
+def attachment_reference(db, attachment):
+    """Creates an attachment reference."""
+    attachment_reference = AttachmentReference.create(
+        db=db,
+        data={
+            "attachment_id": attachment.id,
+            "reference_id": "ref_1",
+            "reference_type": AttachmentReferenceType.privacy_request,
+        },
+    )
+    yield attachment_reference
+    attachment_reference.delete(db)