Add created/updated job fields (#1907)

geopython · Jan 21, 2025 · 29b507f · 29b507f
1 parent 3d88f7d
commit 29b507f
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 9 deletions.
diff --git a/pygeoapi/api/processes.py b/pygeoapi/api/processes.py
@@ -319,8 +319,10 @@ def get_jobs(api: API, request: APIRequest,
             'message': job_['message'],
             'progress': job_['progress'],
             'parameters': job_.get('parameters'),
+            'created': job_['created'],
             'started': job_['started'],
-            'finished': job_['finished']
+            'finished': job_['finished'],
+            'updated': job_['updated']
         }
 
         # TODO: translate

diff --git a/pygeoapi/process/manager/base.py b/pygeoapi/process/manager/base.py
@@ -32,7 +32,6 @@
 # =================================================================
 
 import collections
-from datetime import datetime
 import json
 import logging
 from multiprocessing import dummy
@@ -50,7 +49,7 @@
     UnknownProcessError,
 )
 from pygeoapi.util import (
-    DATETIME_FORMAT,
+    get_current_datetime,
     JobStatus,
     ProcessExecutionMode,
     RequestedProcessExecutionMode,
@@ -284,6 +283,7 @@ def _execute_handler_sync(self, p: BaseProcessor, job_id: str,
                 }
 
             self.update_job(job_id, {
+                'updated': get_current_datetime(),
                 'status': current_status.value,
                 'message': 'Writing job output',
                 'progress': 95
@@ -305,8 +305,8 @@ def _execute_handler_sync(self, p: BaseProcessor, job_id: str,
             current_status = JobStatus.successful
 
             job_update_metadata = {
-                'finished': datetime.utcnow().strftime(
-                    DATETIME_FORMAT),
+                'finished': get_current_datetime(),
+                'updated': get_current_datetime(),
                 'status': current_status.value,
                 'location': str(job_filename),
                 'mimetype': jfmt,
@@ -336,8 +336,8 @@ def _execute_handler_sync(self, p: BaseProcessor, job_id: str,
             }
             LOGGER.exception(err)
             job_metadata = {
-                'finished': datetime.utcnow().strftime(
-                    DATETIME_FORMAT),
+                'finished': get_current_datetime(),
+                'updated': get_current_datetime(),
                 'status': current_status.value,
                 'location': None,
                 'mimetype': 'application/octet-stream',
@@ -432,7 +432,8 @@ def execute_process(
             'type': 'process',
             'identifier': job_id,
             'process_id': process_id,
-            'started': datetime.utcnow().strftime(DATETIME_FORMAT),
+            'created': get_current_datetime(),
+            'started': get_current_datetime(),
             'finished': None,
             'status': current_status.value,
             'location': None,

diff --git a/pygeoapi/util.py b/pygeoapi/util.py
@@ -35,7 +35,7 @@
 import functools
 from functools import partial
 from dataclasses import dataclass
-from datetime import date, datetime, time
+from datetime import date, datetime, time, timezone
 from decimal import Decimal
 from enum import Enum
 import json
@@ -302,6 +302,11 @@ def format_datetime(value: str, format_: str = DATETIME_FORMAT) -> str:
     return dateutil.parser.isoparse(value).strftime(format_)
 
 
+def get_current_datetime(tz: timezone = timezone.utc,
+                         format_: str = DATETIME_FORMAT) -> str:
+    return datetime.now(tz).strftime(format_)
+
+
 def file_modified_iso8601(filepath: Path) -> str:
     """
     Provide a file's ctime in ISO8601

diff --git a/tests/data/postgres_manager_full_structure.backup.sql b/tests/data/postgres_manager_full_structure.backup.sql
@@ -34,8 +34,10 @@ CREATE TABLE public.jobs (
     type character varying DEFAULT 'process'::character varying NOT NULL,
     identifier character varying NOT NULL,
     process_id character varying NOT NULL,
+    created timestamp without time zone,
     started timestamp without time zone,
     finished timestamp without time zone,
+    updated timestamp without time zone,
     status character varying NOT NULL,
     location character varying,
     mimetype character varying,

diff --git a/tests/test_manager.py b/tests/test_manager.py
@@ -84,8 +84,10 @@ def test_get_job_result_binary(config):
         "type": "process",
         "identifier": job_id,
         "process_id": "dummy",
+        "created": "2024-08-22T12:00:00.000000Z",
         "started": "2024-08-22T12:00:00.000000Z",
         "finished": "2024-08-22T12:00:01.000000Z",
+        "updated": "2024-08-22T12:00:01.000000Z",
         "status": "successful",
         "location": nc_file,
         "mimetype": "application/x-netcdf",