Add reveal endpoint and assignment due date migration

Author: karenrasmussen

lms/migrations/versions/2a45f5cb8e25_add_assignment_due_date.py

@@ -0,0 +1,19 @@
+"""add_assignment_due_date
+
+Revision ID: 2a45f5cb8e25
+Revises: af090ca7e73f
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+revision = '2a45f5cb8e25'
+down_revision = 'af090ca7e73f'
+
+
+def upgrade() -> None:
+    op.add_column('assignment', sa.Column('due_date', sa.DateTime(), nullable=True))
+
+
+def downgrade() -> None:
+    op.drop_column('assignment', 'due_date')

lms/models/assignment.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from enum import StrEnum
 
 import sqlalchemy as sa
@@ -146,6 +147,9 @@ class Assignment(CreatedUpdatedMixin, Base):
     )
     auto_grading_config = relationship("AutoGradingConfig")
 
+    due_date: Mapped[datetime | None] = mapped_column()
+    """The due date for this assignment; NULL if not set."""
+
     checkpoint = relationship(
         "AssignmentCheckpoint", uselist=False, back_populates="assignment"
     )

lms/product/canvas/product.py

@@ -25,7 +25,7 @@ class Canvas(Product):
 
     settings_key = "canvas"
 
-    use_toolbar_grading = False
+    use_toolbar_grading = False 
     """We use SpeedGrader in canvas instead"""
     use_toolbar_editing = False
     """Canvas allows re-deeplinking assignments. We don't support editing in our side."""

lms/resources/_js_config/__init__.py

@@ -1,6 +1,6 @@
 import functools
 import re
-from datetime import timedelta
+from datetime import UTC, timedelta
 from enum import Enum, StrEnum
 from typing import Any
 from urllib.parse import urlparse
@@ -471,6 +471,41 @@ def enable_instructor_dashboard_entry_point(self, assignment):
         }
         self._config["hypothesisClient"] = self._hypothesis_client
 
+    def enable_toolbar_checkpoint(self, assignment):
+        toolbar_config = self._config.get("instructorToolbar", {})
+
+        toolbar_config["checkpoint"] = {
+            "enabled": True,
+            "revealed": assignment.checkpoint.reveal_date is not None,
+            # reveal_date is stored as UTC without timezone info. Adding
+            # UTC here so the ISO string includes +00:00 and the browser
+            # can convert it to the user's local timezone.
+            "revealDate": assignment.checkpoint.reveal_date.replace(tzinfo=UTC).isoformat()
+            if assignment.checkpoint.reveal_date
+            else None,
+            # TODO: use actual due date once available; for now reuse reveal_date.
+            "dueDate": assignment.checkpoint.reveal_date.replace(tzinfo=UTC).isoformat()
+            if assignment.checkpoint.reveal_date
+            else None,
+            "revealUrl": self._request.route_url(
+                "api.checkpoint.reveal", assignment_id=assignment.id
+            ),
+        }
+        self._config["instructorToolbar"] = toolbar_config
+
+    def enable_student_checkpoint(self, assignment):
+        revealed = assignment.checkpoint.reveal_date is not None
+        self._config["studentCheckpoint"] = {
+            "hidden": not revealed,
+            # TODO: use actual due date once available; for now reuse reveal_date.
+            # reveal_date is stored as UTC without timezone info. Adding
+            # UTC here so the ISO string includes +00:00 and the browser
+            # can convert it to the user's local timezone.
+            "dueDate": assignment.checkpoint.reveal_date.replace(tzinfo=UTC).isoformat()
+            if assignment.checkpoint.reveal_date
+            else None,
+        }
+
     def enable_toolbar_editing(self):
         toolbar_config = self._get_toolbar_config()
 

lms/routes.py

@@ -45,6 +45,11 @@ def includeme(config):  # noqa: PLR0915
     )
 
     config.add_route("api.sync", "/api/sync", request_method="POST")
+    config.add_route(
+        "api.checkpoint.reveal",
+        "/api/assignments/{assignment_id}/checkpoint/reveal",
+        request_method="POST",
+    )
     config.add_route(
         "api.courses.group_sets.list", "/api/courses/{course_id}/group_sets"
     )

lms/services/h_api.py

@@ -221,14 +221,14 @@ def sync_checkpoints(
         self,
         authority: str,
         checkpoints: list[dict],
-        instructor_username: str | None = None,
+        user: dict | None = None,
     ) -> None:
         """Sync checkpoint data to h via the bulk checkpoint endpoint.
 
         :param authority: The h authority
         :param checkpoints: List of dicts with group_authority_provided_id,
             document_uri, and optionally reveal_date
-        :param instructor_username: Optional username of an instructor to set
+        :param user: Optional dict with 'username' and 'role' to set
             their lms_role in the group memberships
         """
         if not checkpoints:
@@ -238,8 +238,8 @@ def sync_checkpoints(
             "authority": authority,
             "checkpoints": checkpoints,
         }
-        if instructor_username:
-            payload["instructor_username"] = instructor_username
+        if user:
+            payload["user"] = user
 
         self._api_request(
             "POST",
@@ -250,6 +250,34 @@ def sync_checkpoints(
             },
         )
 
+    def reveal_checkpoints(
+        self,
+        authority: str,
+        checkpoints: list[dict],
+    ) -> None:
+        """Reveal checkpoints in h, making annotations visible immediately.
+
+        :param authority: The h authority
+        :param checkpoints: List of dicts with group_authority_provided_id
+            and document_uri
+        """
+        if not checkpoints:
+            return
+
+        payload = {
+            "authority": authority,
+            "checkpoints": checkpoints,
+        }
+
+        self._api_request(
+            "POST",
+            path="bulk/checkpoint/reveal",
+            body=json.dumps(payload),
+            headers={
+                "Content-Type": "application/json",
+            },
+        )
+
     def _api_request(self, method, path, body=None, headers=None, stream=False):  # noqa: FBT002
         """
         Send any kind of HTTP request to the h API and return the response.

lms/services/lti_h.py

@@ -14,14 +14,16 @@ def checkpoint_sync_data(assignment: Assignment | None, lti_user) -> dict | None
     if not (assignment and assignment.checkpoint):
         return None
 
+    role = "instructor" if lti_user.is_instructor else "student"
     return {
         "document_uri": assignment.document_url,
         "reveal_date": assignment.checkpoint.reveal_date.isoformat()
         if assignment.checkpoint.reveal_date
         else None,
-        "instructor_username": lti_user.h_user.username
-        if lti_user.is_instructor
-        else None,
+        "user": {
+            "username": lti_user.h_user.username,
+            "role": role,
+        },
     }
 
 
@@ -121,7 +123,7 @@ def _sync_checkpoints(self, groupings: list[Grouping], checkpoint_data: dict):
         self._h_api.sync_checkpoints(
             authority=self._authority,
             checkpoints=checkpoints,
-            instructor_username=checkpoint_data.get("instructor_username"),
+            user=checkpoint_data.get("user"),
         )
 
     def _group_upsert(self, grouping, ref):

lms/static/scripts/frontend_apps/components/BasicLTILaunchApp.tsx

@@ -15,6 +15,7 @@ import { apiCall } from '../utils/api';
 import ContentFrame from './ContentFrame';
 import InstructorToolbar from './InstructorToolbar';
 import LaunchErrorDialog from './LaunchErrorDialog';
+import StudentCheckpointBar from './StudentCheckpointBar';
 
 /**
  * Error states managed by this component that can arise during assignment
@@ -346,6 +347,7 @@ export default function BasicLTILaunchApp() {
         data-testid="content-wrapper"
       >
         <InstructorToolbar />
+        <StudentCheckpointBar />
         <ContentFrame url={contentURL ?? ''} />
       </div>
       {errorState && (

lms/static/scripts/frontend_apps/components/CheckpointBar.tsx

@@ -0,0 +1,28 @@
+import { formatDateTime } from '@hypothesis/frontend-shared';
+
+import type { CheckpointConfig } from '../config';
+import RevealAnnotationsButton from './RevealAnnotationsButton';
+
+export default function CheckpointBar({
+  checkpoint,
+}: {
+  checkpoint: CheckpointConfig;
+}) {
+  return (
+    <div className="p-2 flex items-center border-t">
+      <div className="text-sm" data-testid="checkpoint-type">
+        <div className="font-semibold">Checkpoint:</div>
+        <div>Manual</div>
+      </div>
+      {checkpoint.dueDate && (
+        <div className="text-sm mx-auto" data-testid="checkpoint-due-date">
+          <div className="font-semibold">Due Date:</div>
+          <div>{formatDateTime(checkpoint.dueDate)}</div>
+        </div>
+      )}
+      <div className="ml-auto">
+        <RevealAnnotationsButton checkpoint={checkpoint} />
+      </div>
+    </div>
+  );
+}

lms/static/scripts/frontend_apps/components/FilePickerApp.tsx

@@ -193,7 +193,6 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
       formFields,
       promptForTitle,
       promptForGradable,
-      hideAndRevealEnabled,
     },
   } = useConfig(['api', 'filePicker']);
 
@@ -242,9 +241,7 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
     promptForTitle ||
     promptForGradable ||
     autoGradingEnabled ||
-    // Show the details screen for new assignments so the Hide & Reveal option
-    // can be offered, but only where the feature is enabled.
-    (!isEditing && !!hideAndRevealEnabled);
+    !isEditing; // Always show details for new assignments (checkpoint option)
 
   let currentStep: PickerStep;
   if (editingContent) {
@@ -308,9 +305,7 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
         const data: DeepLinkingAPIData = {
           ...deepLinkingAPI.data,
           auto_grading_config: autoGradingConfigToSave,
-          ...(hideAndRevealEnabled
-            ? { checkpoint_enabled: checkpointEnabled }
-            : {}),
+          checkpoint_enabled: checkpointEnabled,
           content,
           group_set: groupConfig.useGroupSet ? groupConfig.groupSet : null,
           title,
@@ -339,7 +334,6 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
     [
       authToken,
       checkpointEnabled,
-      hideAndRevealEnabled,
       deepLinkingFields,
       deepLinkingAPI,
       groupConfig.groupSet,
@@ -561,7 +555,7 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
                         />
                       </>
                     )}
-                    {!isEditing && hideAndRevealEnabled && (
+                    {!isEditing && (
                       <>
                         <div className="sm:col-span-2 border-b" />
                         <PanelLabel isCurrentStep verticalAlign="center">
@@ -643,7 +637,7 @@ export default function FilePickerApp({ onSubmit }: FilePickerAppProps) {
                 formFields={formFields}
                 groupSet={groupConfig.useGroupSet ? groupConfig.groupSet : null}
                 autoGradingConfig={autoGradingConfigToSave}
-                {...(hideAndRevealEnabled ? { checkpointEnabled } : {})}
+                checkpointEnabled={checkpointEnabled}
               />
             )
           }