COMP-697 report generation text changes and last generated timestamps (#670)

Author: tom0827

compliance-api/src/compliance_api/resources/document_job.py

@@ -36,7 +36,7 @@
 
 @cors_preflight("GET, OPTIONS")
 @API.route("/inspections/<int:inspection_record_id>/recent", methods=["GET", "OPTIONS"])
-class DocumentJobs(Resource):
+class DocumentJobRecent(Resource):
     """Resource for managing document jobs per inspection."""
 
     @staticmethod
@@ -56,6 +56,27 @@ def get(inspection_record_id):
         return schema.dump(document_job), HTTPStatus.OK
 
 
+@cors_preflight("GET, OPTIONS")
+@API.route("/inspections/<int:inspection_record_id>/last-generated", methods=["GET", "OPTIONS"])
+class DocumentJobLastGenerated(Resource):
+    """Resource for managing document jobs per inspection."""
+
+    @staticmethod
+    @API.response(code=200, description="Success", model=[DocumentJob])
+    @ApiHelper.swagger_decorators(
+        API, endpoint_description="Fetch most recent document job for user and inspection"
+    )
+    @auth.require
+    def get(inspection_record_id):
+        """Fetch the last time a document was generated for user and inspection."""
+        auth_user_guid = g.token_info.get("preferred_username")
+        current_staff_user = StaffUserService.get_user_by_auth_guid(auth_user_guid)
+        last_generated_time = DocumentJobService.get_last_generated_time_for_user(
+            current_staff_user.id, inspection_record_id
+        )
+        return {"last_generated_time": last_generated_time}, HTTPStatus.OK
+
+
 @cors_preflight("OPTIONS, DELETE, PUT")
 @API.route("/<int:job_id>", methods=["OPTIONS", "DELETE", "PUT"])
 class DocumentJobById(Resource):

compliance-api/src/compliance_api/services/document_job.py

@@ -29,6 +29,16 @@ def get_most_recent_document_job_for_user(user_id, inspection_record_id):
         })
         return jobs[-1] if jobs else None
 
+    @staticmethod
+    def get_last_generated_time_for_user(user_id, inspection_record_id):
+        """Get the last time a document was generated for a user."""
+        jobs = DocumentJob.query.filter_by(
+            user_id=user_id,
+            inspection_record_id=inspection_record_id,
+        ).order_by(DocumentJob.completed_at.desc()).all()
+        document_job = jobs[0] if jobs else None
+        return document_job.completed_at.isoformat() if document_job else None
+
     @staticmethod
     def update(document_job_id, user_id, update_data):
         """Update a document job by its ID."""

compliance-api/tests/integration/api/test_document_job.py

@@ -403,3 +403,104 @@ def test_get_document_job_requires_auth(client, inspection_record):
     url = urljoin(API_BASE_URL, f"document-jobs/inspections/{inspection_record.id}/recent")
     result = client.get(url)
     assert result.status_code in (HTTPStatus.UNAUTHORIZED, 401)
+
+
+def test_last_generated_success(client, created_staff, jwt, inspection_record, mock_track_service, mock_auth_service):
+    """Test getting last-generated time for user and inspection."""
+    staff_user = created_staff
+    # Create a document job for the staff user
+    now = datetime.now(timezone.utc)
+    job_data = {
+        "user_id": staff_user.id,
+        "inspection_record_id": inspection_record.id,
+        "status": DocumentJobStatusEnum.COMPLETED.value,
+        "download_name": "last_generated.pdf",
+        "relative_url": "documents/last_generated.pdf",
+        "started_at": now,
+        "completed_at": now,
+    }
+    DocumentJobService.create(job_data)
+
+    config = get_named_config("testing")
+    header_claims = make_header_claims(staff_user, config)
+    auth_header = factory_auth_header(jwt=jwt, claims=header_claims)
+
+    url = urljoin(API_BASE_URL, f"document-jobs/inspections/{inspection_record.id}/last-generated")
+    result = client.get(url, headers=auth_header)
+
+    assert result.status_code == HTTPStatus.OK
+    response_data = result.json
+    assert "last_generated_time" in response_data
+    assert response_data["last_generated_time"] == now.isoformat()
+
+
+def test_last_generated_requires_auth(client, inspection_record):
+    """Test last-generated endpoint requires auth."""
+    url = urljoin(API_BASE_URL, f"document-jobs/inspections/{inspection_record.id}/last-generated")
+    result = client.get(url)
+    assert result.status_code in (HTTPStatus.UNAUTHORIZED, 401)
+
+
+def test_last_generated_no_jobs_returns_null(
+    client,
+    created_staff,
+    jwt,
+    inspection_record,
+    mock_track_service,
+    mock_auth_service
+):
+    """Test last-generated returns null if no jobs exist for user/inspection."""
+    staff_user = created_staff
+    config = get_named_config("testing")
+    header_claims = make_header_claims(staff_user, config)
+    auth_header = factory_auth_header(jwt=jwt, claims=header_claims)
+
+    url = urljoin(API_BASE_URL, f"document-jobs/inspections/{inspection_record.id}/last-generated")
+    result = client.get(url, headers=auth_header)
+
+    assert result.status_code == HTTPStatus.OK
+    response_data = result.json
+    assert "last_generated_time" in response_data
+    assert response_data["last_generated_time"] is None
+
+
+def test_last_generated_other_user_job_returns_null(
+    client,
+    created_staff,
+    jwt,
+    inspection_record,
+    mock_track_service,
+    mock_auth_service
+):
+    """Test last-generated returns null if only a different user has a job for the inspection."""
+    staff_user = created_staff
+    # Create a different staff user
+    user_data = StaffScenario.default_data.value
+    auth_user_guid = f"other_{datetime.now().timestamp()}"
+    user_data["auth_user_guid"] = auth_user_guid
+    other_staff = StaffScenario.create(user_data)
+    assert other_staff.id != staff_user.id
+
+    # Create a document job for the other staff user
+    job_data = {
+        "user_id": other_staff.id,
+        "inspection_record_id": inspection_record.id,
+        "status": DocumentJobStatusEnum.COMPLETED.value,
+        "download_name": "other_user_last_generated.pdf",
+        "relative_url": "documents/other_user_last_generated.pdf",
+        "started_at": datetime.now(timezone.utc),
+        "completed_at": datetime.now(timezone.utc),
+    }
+    DocumentJobService.create(job_data)
+
+    config = get_named_config("testing")
+    header_claims = make_header_claims(staff_user, config)
+    auth_header = factory_auth_header(jwt=jwt, claims=header_claims)
+
+    url = urljoin(API_BASE_URL, f"document-jobs/inspections/{inspection_record.id}/last-generated")
+    result = client.get(url, headers=auth_header)
+
+    assert result.status_code == HTTPStatus.OK
+    response_data = result.json
+    assert "last_generated_time" in response_data
+    assert response_data["last_generated_time"] is None

compliance-web/src/components/App/Inspections/Profile/Reports/PreviewDownloadButton.tsx

@@ -32,6 +32,7 @@ import { AxiosError } from "axios";
 import { notify } from "@/store/snackbarStore";
 import {
   useDeleteDocumentJobs,
+  useLastGeneratedTimeForUser,
   useMostRecentDocumentJobForUser,
 } from "@/hooks/useDocumentJobs";
 import { DocumentJob, DocumentJobStatus } from "@/models/documentJob";
@@ -46,6 +47,11 @@ const PreviewDownloadButton = () => {
     inspectionReportsData?.id ?? 0
   );
 
+  const { data: lastGeneratedTimeObj } = useLastGeneratedTimeForUser(
+    inspectionReportsData?.id ?? 0
+  );
+  const lastGeneratedTime = lastGeneratedTimeObj?.last_generated_time;
+
   const [previewClicked, setPreviewClicked] = useState(false);
   const [generatingDocx, setGeneratingDocx] = useState(false);
   const [open, setOpen] = useState(false);
@@ -362,36 +368,43 @@ const PreviewDownloadButton = () => {
                       width: "100%",
                     }}
                   >
-                    {isCompleted ? (
-                      <Box
-                        sx={{
-                          display: "flex",
-                          flexDirection: "column",
-                          gap: 0.25,
-                          pl: 2,
-                        }}
-                      >
+                    <Box
+                      sx={{
+                        display: "flex",
+                        flexDirection: "column",
+                        gap: 0.25,
+                        pl: 2,
+                      }}
+                    >
+                      {isCompleted || lastGeneratedTime ? (
+                        <>
+                          <Typography
+                            variant="caption"
+                            color={BCDesignTokens.typographyColorPlaceholder}
+                          >
+                            Last PDF Generated:
+                          </Typography>
+                          <Typography
+                            variant="caption"
+                            color={BCDesignTokens.typographyColorPrimary}
+                          >
+                            {dateUtils.formatDate(
+                              isCompleted
+                                ? (documentJob?.completed_at ?? "")
+                                : (lastGeneratedTime ?? ""),
+                              "MMM D, YYYY hh:mm A"
+                            )}
+                          </Typography>
+                        </>
+                      ) : (
                         <Typography
                           variant="caption"
                           color={BCDesignTokens.typographyColorPlaceholder}
                         >
-                          Last PDF Generated:
-                        </Typography>
-                        <Typography
-                          variant="caption"
-                          color={BCDesignTokens.typographyColorPrimary}
-                        >
-                          {dateUtils.formatDate(
-                            documentJob?.completed_at ?? "",
-                            "MMM D, YYYY hh:mm A"
-                          )}
+                          Nothing generated yet
                         </Typography>
-                      </Box>
-                    ) : (
-                      <Typography variant="caption" px={2}>
-                        No PDF generated yet.
-                      </Typography>
-                    )}
+                      )}
+                    </Box>
                     <Link
                       onClick={
                         isCompleted ? handleDownloadReportFromURL : () => {}
@@ -407,7 +420,7 @@ const PreviewDownloadButton = () => {
                       }}
                     >
                       <DownloadRounded sx={{ fontSize: 16 }} />
-                      Download Last PDF
+                      Download
                     </Link>
                   </Box>
                 </Box>

compliance-web/src/hooks/useDocumentJobs.tsx

@@ -10,6 +10,14 @@ const fetchMostRecentDocumentJobForUser = (
   });
 };
 
+const fetchLastGeneratedTimeForUser = (
+  inspectionReportID: number
+): Promise<{ last_generated_time: string }> => {
+  return request({
+    url: `/document-jobs/inspections/${inspectionReportID}/last-generated`,
+  });
+};
+
 const updateDocumentJob = (
   jobId: string,
   data: Partial<DocumentJob>
@@ -59,6 +67,15 @@ export const useMostRecentDocumentJobForUser = (inspectionReportID: number) => {
   });
 };
 
+export const useLastGeneratedTimeForUser = (inspectionReportID: number) => {
+  return useQuery<{ last_generated_time: string }, Error>({
+    queryKey: ["lastGeneratedTime", inspectionReportID],
+    queryFn: () => fetchLastGeneratedTimeForUser(inspectionReportID ?? 0),
+    refetchInterval: 30000,
+    enabled: !!inspectionReportID,
+  });
+};
+
 export const useDeleteDocumentJobs = () => {
   return useMutation<void, Error, string>({
     mutationFn: (jobId: string) => deleteDocumentJob(jobId),