Merge pull request #574 from wri/show_error_message

Show associated error message in job info if status is 'error' for a OTF list request
wri · Aug 15, 2024 · ae83db0 · ae83db0
2 parents e9041cf + fc18d5f
commit ae83db0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/app/models/pydantic/user_job.py b/app/models/pydantic/user_job.py
@@ -8,8 +8,9 @@
 
 class UserJob(BaseModel):
     job_id: UUID
-    job_link: Optional[str]
-    status: str = "pending"
+    job_link: Optional[str]   # Full URL to check the job status
+    status: str = "pending"   # Can be pending, success, partial_success, failure, and error
+    message: Optional[str]    # Error message when status is "error"
     download_link: Optional[str] = None
     failed_geometries_link: Optional[str] = None
     progress: Optional[str] = "0%"

diff --git a/app/routes/jobs/job.py b/app/routes/jobs/job.py
@@ -68,7 +68,8 @@ async def _get_user_job(job_id: UUID) -> UserJob:
             logger.error(f"Analysis service returned an unexpected response: {output}")
             return UserJob(
                 job_id=job_id,
-                status="failed",
+                status="error",
+                message=output["message"],
                 download_link=None,
                 failed_geometries_link=None,
                 progress="0%",