Share common definitions in Review and ReviewCreate

src/database/review.py

@@ -2,10 +2,10 @@
 from datetime import datetime, timezone
 
 import sqlalchemy
-from pydantic.main import BaseModel
 from sqlalchemy import Column
 from sqlmodel import SQLModel, Field, Relationship
 
+from database.model.field_length import NORMAL, LONG
 
 REQUIRED_NUMBER_OF_REVIEWS = 1
 
@@ -16,37 +16,51 @@ class Decision(enum.StrEnum):
     RETRACTED = enum.auto()
 
 
-class Review(SQLModel, table=True):  # type: ignore [call-arg]
+class ReviewBase(SQLModel):
     """A review (which may be pending), requested by a user to publish an asset/change."""
 
+    comment: str = Field(
+        description="Motivation for the decision.",
+        max_length=LONG,
+        default="",
+        schema_extra={"example": "The organization's contact information is invalid."},
+    )
+    decision: Decision = Field(
+        description="The decision made by the reviewer.",
+        sa_column=Column(sqlalchemy.Enum(Decision)),
+    )
+    submission_identifier: int = Field(
+        description="The identifier of the submission (review request)."
+    )
+
+
+class ReviewCreate(ReviewBase):
+    pass
+
+
+class Review(ReviewBase, table=True):  # type: ignore [call-arg]
     __tablename__ = "review"
 
     identifier: int = Field(primary_key=True, default=None)
     decision_date: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
 
-    # Not sure if size should be limited, especially if we want to use this for structured data.
-    comment: str | None = Field()
-    decision: Decision = Field(sa_column=Column(sqlalchemy.Enum(Decision)))
-
-    reviewer_identifier: str = Field(
-        foreign_key="user.subject_identifier",
-        exclude=True,
-    )
-    submission_identifier: int = Field(
-        foreign_key="submission.identifier",
-    )
+    reviewer_identifier: str = Field(foreign_key="user.subject_identifier", exclude=True)
+    submission_identifier: int = Field(foreign_key="submission.identifier")
     submission: "Submission" = Relationship(back_populates="reviews")
 
 
-class ReviewCreate(BaseModel):
-    comment: str | None = Field(description="Motivation for the decision.")
-    decision: Decision = Field(description="The decision made by the reviewer.")
-    submission_identifier: int = Field(
-        description="The identifier of the submission (review request)."
+class SubmissionCreate(SQLModel):
+    """User provided information to submit a review request."""
+
+    comment: str = Field(
+        description="Optional. Comment to the reviewer to motivate the submission or provide clarification.",
+        max_length=NORMAL,
+        default="",
+        schema_extra={"example": "'IA' is not a typo, it's for L'intelligence artificielle."},
     )
 
 
-class SubmissionBase(SQLModel):
+class SubmissionBase(SubmissionCreate):
     """A review request, requested by a user to publish an asset/change."""
 
     identifier: int = Field(primary_key=True, default=None)

src/routers/resource_router.py

@@ -26,7 +26,7 @@
     resource_read,
 )
 from database.model.serializers import deserialize_resource_relationships
-from database.review import Decision, Review, Submission, ReviewCreate
+from database.review import Decision, Review, Submission, ReviewCreate, SubmissionCreate
 from database.session import DbSession
 from dependencies.filtering import ResourceFilters, ResourceFiltersParams
 from dependencies.pagination import Pagination, PaginationParams
@@ -544,6 +544,7 @@ def get_submit_func(self):
 
         def submit_resource(
             identifier: str,
+            submission: SubmissionCreate | None = None,
             user: KeycloakUser = Depends(get_user_or_raise),
         ):
             with DbSession() as session:
@@ -565,6 +566,7 @@ def submit_resource(
                 review_request = Submission(
                     requestee_identifier=user._subject_identifier,
                     aiod_entry_identifier=resource.aiod_entry.identifier,
+                    comment=submission.comment if submission else "",
                 )
                 session.add(review_request)
                 session.commit()

src/tests/authorization/test_authorization.py

@@ -88,12 +88,18 @@ def test_drafts_are_private(
     # with and without authentication
 
 
-def test_user_can_submit_draft_for_review(client, publication):
+@pytest.mark.parametrize(
+    "comment", [None, "foo"]
+)
+def test_user_can_submit_draft_for_review(comment, client, publication):
     identifier = register_asset(publication, owner=ALICE, status=EntryStatus.DRAFT)
+    content = f'{{"comment": "{comment}"}}' if comment else None
+
     with logged_in_user(ALICE):
         submission = client.post(
             f"/publications/submit/v1/{identifier}",
             headers={"Authorization": "Fake token"},
+            content=content,
         )
         assert submission.status_code == HTTPStatus.OK, submission.json()
         assert "submission_identifier" in submission.json()
@@ -102,7 +108,9 @@ def test_user_can_submit_draft_for_review(client, publication):
         queue = client.get("/submissions/v1", headers={"Authorization": "Fake token"})
         assert queue.status_code == HTTPStatus.OK, queue.json()
         assert len(queue.json()) == 1, "A successful request should result in a submission."
-        assert "requestee_identifier" not in queue.json()
+        [sub] = queue.json()
+        assert "requestee_identifier" not in sub, "Submissions should not review who submitted."
+        assert sub["comment"] == (comment if comment else ""), "Comment should be stored."
 
 
 def test_user_can_not_submit_other_for_review(client, publication):
@@ -152,6 +160,7 @@ def test_get_submission_by_id(client, publication):
         assert submission_dict == {
             "identifier": 1,
             "aiod_entry_identifier": 1,
+            "comment": "",
             "reviews": [
                 {
                     "identifier": 1,