PS-13958 Improve job management (#214)

* Adding ability to list and restart jobs

Author: hiiamelliott

CHANGELOG.md

@@ -8,6 +8,14 @@ All notable changes to the `python-domino` library will be documented in this fi
 
 ### Changed
 
+## 1.4.5
+
+### Added
+* PS-13958 `jobs_list()` function lists recent jobs in a project
+* PS-13958 `job_restart()` function allows re-running a previous job
+
+### Changed
+
 ## 1.4.4
 
 ### Added

README.adoc

@@ -593,12 +593,26 @@ Stop the Job (execution) in the project.
 * _job_id (string):_ Job identifier.
 * _commit_results (boolean):_ (Defaults to `true`) If `false`, the job results are not committed.
 
+==== jobs_list(project_id, page_size=None):
+
+Lists job history for a given project_id
+
+* _project_id (string):_ The project to query.
+* _page_size (string):_ How many results to return (default: 3).
+
 ==== job_status(job_id):
 
 Get the status of a job.
 
 * _job_id (string):_ Job identifier.
 
+==== job_restart(job_id, should_use_original_input_commit=True):
+
+Restart a previous job
+
+* _job_id (string):_ ID of the original job. This can be obtained with `jobs_list()`.
+* _should_use_original_input_commit (bool):_ Should the new job run use the original code, or the current version?
+
 ==== job_start_blocking(poll_freq=5, max_poll_time=6000, **kwargs):
 
 Start a job and poll until the job is finished.

README.md

@@ -604,12 +604,28 @@ Stop the Job (execution) in the project.
 -   *commit_results (boolean):* (Defaults to `true`) If `false`, the
     job results are not committed.
 
+### jobs_list(project_id, page_size=None):
+
+Lists job history for a given project_id
+
+-   *project_id (string):* The project to query.
+
+-   *page_size (string):* How many results to return (default: 3).
+
 ### job_status(job_id):
 
 Get the status of a job.
 
 -   *job_id (string):* Job identifier.
 
+### job_restart(job_id, should_use_original_input_commit=True):
+
+Restart a previous job
+
+-   *job_id (string):* ID of the original job. This can be obtained with `jobs_list()`.
+
+-   *should_use_original_input_commit (bool):* Should the new job run use the original code, or the current version?
+
 ### job_start_blocking(poll_freq=5, max_poll_time=6000, \*\*kwargs):
 
 Start a job and poll until the job is finished. Additionally, this

domino/_version.py

@@ -1 +1 @@
-__version__ = "1.4.4"
+__version__ = "1.4.5"

domino/domino.py

@@ -617,6 +617,17 @@ def job_stop(self, job_id: str, commit_results: bool = True):
         response = self.request_manager.post(url, json=request)
         return response
 
+    def jobs_list(self, project_id: str, page_size=None):
+        """
+        Lists job history for a given project_id
+        :param project_id: The project to query
+        :param page_size: The number of jobs to return (default: 3)
+        :return: The details
+        """
+        url = self._routes.jobs_list(project_id, page_size)
+        return self._get(url)
+
+
     def job_status(self, job_id: str) -> dict:
         """
         Gets the status of job with given job_id
@@ -625,6 +636,24 @@ def job_status(self, job_id: str) -> dict:
         """
         return self.request_manager.get(self._routes.job_status(job_id)).json()
 
+    def job_restart(
+            self,
+            job_id:str,
+            should_use_original_input_commit: bool = True
+        ):
+        """
+        Restarts a previous job
+        :param job_id:                              ID of the original job that should be restarted
+        :param should_use_original_input_commit:    Should the new job run use the original code, or the current version?
+        """
+        url = self._routes.job_restart()
+        request = {
+            "jobId": job_id,
+            "shouldUseOriginalInputCommit": should_use_original_input_commit
+        }
+        response = self.request_manager.post(url, json=request)
+        return response
+
     def job_runtime_execution_details(self, job_id: str) -> dict:
         """
         Gets the runtime execution details of job with given job_id

domino/routes.py

@@ -175,9 +175,16 @@ def job_start(self):
     def job_stop(self):
         return f"{self.host}/v4/jobs/stop"
 
+    def jobs_list(self, project_id, page_size: Optional[str]):
+        page_size_query = f"&page_size={page_size}" if page_size else ""
+        return f"{self.host}/v4/jobs?projectId={project_id}{page_size_query}"
+
     def job_status(self, job_id):
         return f"{self.host}/v4/jobs/{job_id}"
 
+    def job_restart(self):
+        return f"{self.host}/v4/jobs/restart"
+
     def job_runtime_execution_details(self, job_id):
         return f"{self.host}/v4/jobs/{job_id}/runtimeExecutionDetails"