async def get_task_by_request(self, request):
flow_id, run_number, step_name, task_id, attempt_id = \
get_pathspec_from_request(request)
run_id_key, run_id_value = translate_run_key(run_number)
task_id_key, task_id_value = translate_task_key(task_id)
conditions = [
"flow_id = %s", "{run_id_key} = %s".format(run_id_key=run_id_key),
"step_name = %s",
"{task_id_key} = %s".format(task_id_key=task_id_key)
]
values = [flow_id, run_id_value, step_name, task_id_value]
if attempt_id:
conditions.append("attempt_id = %s")
values.append(attempt_id)
# NOTE: Must enable joins so task has attempt_id present for filtering.
# Log cache action requires a task with an attempt_id,
# otherwise it defaults to attempt 0
db_response, *_ = await self.task_table.find_records(
fetch_single=True,
conditions=conditions,
values=values,
order=["attempt_id DESC"],
enable_joins=True,
expanded=True)
if db_response.response_code == 200:
return db_response.body
return None
async def get_metadata(self, request):
"""
---
description: Get all metadata of specified task
tags:
- Metadata
parameters:
- $ref: '#/definitions/Params/Path/flow_id'
- $ref: '#/definitions/Params/Path/run_number'
- $ref: '#/definitions/Params/Path/step_name'
- $ref: '#/definitions/Params/Path/task_id'
- $ref: '#/definitions/Params/Builtin/_page'
- $ref: '#/definitions/Params/Builtin/_limit'
- $ref: '#/definitions/Params/Builtin/_order'
- $ref: '#/definitions/Params/Builtin/_tags'
- $ref: '#/definitions/Params/Builtin/_group'
- $ref: '#/definitions/Params/Custom/flow_id'
- $ref: '#/definitions/Params/Custom/run_number'
- $ref: '#/definitions/Params/Custom/step_name'
- $ref: '#/definitions/Params/Custom/task_id'
- $ref: '#/definitions/Params/Custom/field_name'
- $ref: '#/definitions/Params/Custom/value'
- $ref: '#/definitions/Params/Custom/type'
- $ref: '#/definitions/Params/Custom/user_name'
- $ref: '#/definitions/Params/Custom/ts_epoch'
produces:
- application/json
responses:
"200":
description: Returns all metadata of specified task
schema:
$ref: '#/definitions/ResponsesMetadataList'
"405":
description: invalid HTTP Method
schema:
$ref: '#/definitions/ResponsesError405'
"""
flow_name = request.match_info.get("flow_id")
run_id_key, run_id_value = translate_run_key(
request.match_info.get("run_number"))
step_name = request.match_info.get("step_name")
task_id_key, task_id_value = translate_task_key(
request.match_info.get("task_id"))
return await find_records(request,
self._async_table,
initial_conditions=[
"flow_id = %s",
"{run_id_key} = %s".format(
run_id_key=run_id_key),
"step_name = %s",
"{task_id_key} = %s".format(
task_id_key=task_id_key)],
initial_values=[
flow_name, run_id_value, step_name, task_id_value],
allowed_order=self._async_table.keys,
allowed_group=self._async_table.keys,
allowed_filters=self._async_table.keys + ["attempt_id"]
)
async def get_task_attempt(self,
flow_id: str,
run_key: str,
step_name: str,
task_key: str,
attempt_id: int = None,
postprocess: Callable = None) -> DBResponse:
"""
Fetches task attempt from DB. Specifying attempt_id will fetch the specific attempt.
Otherwise the newest attempt is returned.
Parameters
----------
flow_id : str
Flow id of the task
run_key : str
Run number or run id of the task
step_name : str
Step name of the task
task_key : str
task id or task name
attempt_id : int (optional)
The specific attempt of the task to be fetched. If not provided, the latest attempt is returned.
postprocess : Callable
A callback function for refining results.
Receives DBResponse as an argument, and should return a DBResponse
Returns
-------
DBResponse
"""
run_id_key, run_id_value = translate_run_key(run_key)
task_id_key, task_id_value = translate_task_key(task_key)
conditions = [
"flow_id = %s",
"{run_id_column} = %s".format(run_id_column=run_id_key),
"step_name = %s",
"{task_id_column} = %s".format(task_id_column=task_id_key)
]
values = [flow_id, run_id_value, step_name, task_id_value]
if attempt_id:
conditions.append("attempt_id = %s")
values.append(attempt_id)
result, *_ = await self.find_records(conditions=conditions,
values=values,
order=["attempt_id DESC"],
fetch_single=True,
enable_joins=True,
expanded=True,
postprocess=postprocess)
return result
async def get_task(self, request):
"""
---
description: Get one task
tags:
- Task
parameters:
- $ref: '#/definitions/Params/Path/flow_id'
- $ref: '#/definitions/Params/Path/run_number'
- $ref: '#/definitions/Params/Path/step_name'
- $ref: '#/definitions/Params/Path/task_id'
- $ref: '#/definitions/Params/Custom/postprocess'
- $ref: '#/definitions/Params/Custom/invalidate'
produces:
- application/json
responses:
"200":
description: Returns one task
schema:
$ref: '#/definitions/ResponsesTask'
"405":
description: invalid HTTP Method
schema:
$ref: '#/definitions/ResponsesError405'
"""
flow_name = request.match_info.get("flow_id")
run_number = request.match_info.get("run_number")
run_id_key, run_id_value = translate_run_key(run_number)
step_name = request.match_info.get("step_name")
task_id_key, task_id_value = translate_task_key(
request.match_info.get("task_id"))
return await find_records(
request,
self._async_table,
fetch_single=True,
initial_conditions=[
"flow_id = %s",
"{run_id_key} = %s".format(run_id_key=run_id_key),
"step_name = %s",
"{task_id_key} = %s".format(task_id_key=task_id_key)
],
initial_values=[flow_name, run_id_value, step_name, task_id_value],
initial_order=["attempt_id DESC"],
enable_joins=True,
postprocess=postprocess_chain([
apply_run_tags_postprocess(flow_name, run_number,
self._async_run_table),
self.get_postprocessor(request)
]))
async def get_task_by_request(self, request):
flow_id, run_number, step_name, task_id, _ = \
get_pathspec_from_request(request)
run_id_key, run_id_value = translate_run_key(run_number)
task_id_key, task_id_value = translate_task_key(task_id)
conditions = [
"flow_id = %s",
"{run_id_key} = %s".format(run_id_key=run_id_key),
"step_name = %s",
"{task_id_key} = %s".format(task_id_key=task_id_key)
]
values = [flow_id, run_id_value, step_name, task_id_value]
db_response, *_ = await self.db.task_table_postgres.find_records(
fetch_single=True,
conditions=conditions,
values=values,
expanded=True
)
if db_response.response_code == 200:
return db_response.body
return None
async def get_task_attempts(self, request):
"""
---
description: Get all task attempts of specified step
tags:
- Task
parameters:
- $ref: '#/definitions/Params/Path/flow_id'
- $ref: '#/definitions/Params/Path/run_number'
- $ref: '#/definitions/Params/Path/step_name'
- $ref: '#/definitions/Params/Path/task_id'
- $ref: '#/definitions/Params/Builtin/_page'
- $ref: '#/definitions/Params/Builtin/_limit'
- $ref: '#/definitions/Params/Builtin/_order'
- $ref: '#/definitions/Params/Builtin/_tags'
- $ref: '#/definitions/Params/Builtin/_group'
- $ref: '#/definitions/Params/Custom/flow_id'
- $ref: '#/definitions/Params/Custom/run_number'
- $ref: '#/definitions/Params/Custom/step_name'
- $ref: '#/definitions/Params/Custom/task_id'
- $ref: '#/definitions/Params/Custom/user_name'
- $ref: '#/definitions/Params/Custom/ts_epoch'
- $ref: '#/definitions/Params/Custom/finished_at'
- $ref: '#/definitions/Params/Custom/duration'
- $ref: '#/definitions/Params/Custom/postprocess'
- $ref: '#/definitions/Params/Custom/invalidate'
produces:
- application/json
responses:
"200":
description: Returns all task attempts of specified step
schema:
$ref: '#/definitions/ResponsesTaskList'
"405":
description: invalid HTTP Method
schema:
$ref: '#/definitions/ResponsesError405'
"""
flow_name = request.match_info.get("flow_id")
run_number = request.match_info.get("run_number")
run_id_key, run_id_value = translate_run_key(run_number)
step_name = request.match_info.get("step_name")
task_id_key, task_id_value = translate_task_key(
request.match_info.get("task_id"))
return await find_records(
request,
self._async_table,
initial_conditions=[
"flow_id = %s",
"{run_id_key} = %s".format(run_id_key=run_id_key),
"step_name = %s",
"{task_id_key} = %s".format(task_id_key=task_id_key)
],
initial_values=[flow_name, run_id_value, step_name, task_id_value],
initial_order=["attempt_id DESC"],
allowed_order=self._async_table.keys +
["finished_at", "duration", "attempt_id"],
allowed_group=self._async_table.keys,
allowed_filters=self._async_table.keys +
["finished_at", "duration", "attempt_id"],
enable_joins=True,
postprocess=postprocess_chain([
apply_run_tags_postprocess(flow_name, run_number,
self._async_run_table),
self.get_postprocessor(request)
]))