55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374 | class ModuleProcessor(abc.ABC):
def __init__(self, kiara: "Kiara"):
self._kiara: Kiara = kiara
self._created_jobs: Dict[uuid.UUID, Dict[str, Any]] = {}
self._running_job_details: Dict[uuid.UUID, Dict[str, Any]] = {}
self._active_jobs: Dict[uuid.UUID, ActiveJob] = {}
self._failed_jobs: Dict[uuid.UUID, ActiveJob] = {}
self._finished_jobs: Dict[uuid.UUID, ActiveJob] = {}
self._output_refs: Dict[uuid.UUID, ValueMapWritable] = {}
self._job_records: Dict[uuid.UUID, JobRecord] = {}
self._listeners: List[JobStatusListener] = []
def _send_job_event(
self,
job_id: uuid.UUID,
old_status: Union[JobStatus, None],
new_status: JobStatus,
):
for listener in self._listeners:
listener.job_status_changed(
job_id=job_id, old_status=old_status, new_status=new_status
)
def register_job_status_listener(self, listener: JobStatusListener):
self._listeners.append(listener)
def get_job(self, job_id: uuid.UUID) -> ActiveJob:
if job_id in self._active_jobs.keys():
return self._active_jobs[job_id]
elif job_id in self._finished_jobs.keys():
return self._finished_jobs[job_id]
elif job_id in self._failed_jobs.keys():
return self._failed_jobs[job_id]
else:
raise Exception(f"No job with id '{job_id}' registered.")
def get_job_status(self, job_id: uuid.UUID) -> JobStatus:
job = self.get_job(job_id=job_id)
return job.status
def get_job_record(self, job_id: uuid.UUID) -> JobRecord:
if job_id in self._job_records.keys():
return self._job_records[job_id]
else:
raise Exception(f"No job record for job with id '{job_id}' registered.")
def create_job(
self, job_config: JobConfig, job_metadata: Union[None, Mapping[str, Any]]
) -> uuid.UUID:
environments = {
env_name: env.instance_id
for env_name, env in self._kiara.current_environments.items()
}
if job_metadata is None:
job_metadata = {}
result_pedigree = ValuePedigree(
kiara_id=self._kiara.id,
module_type=job_config.module_type,
module_config=job_config.module_config,
inputs=job_config.inputs,
environments=environments,
)
module = self._kiara.module_registry.create_module(manifest=job_config)
unique_result_values = module.characteristics.unique_result_values
outputs = ValueMapWritable.create_from_schema(
kiara=self._kiara,
schema=module.outputs_schema,
pedigree=result_pedigree,
unique_value_ids=unique_result_values,
)
job_id = ID_REGISTRY.generate(kiara_id=self._kiara.id)
job_log = JobLog()
job = ActiveJob(
job_id=job_id, job_config=job_config, job_log=job_log, results=None
)
ID_REGISTRY.update_metadata(job_id, obj=job)
job.job_log.add_log("job created")
job_details = {
"job_config": job_config,
"job": job,
"module": module,
"outputs": outputs,
"job_metadata": job_metadata,
}
self._created_jobs[job_id] = job_details
self._send_job_event(
job_id=job_id, old_status=None, new_status=JobStatus.CREATED
)
if is_develop():
dev_settings = get_dev_config()
if dev_settings.log.log_pre_run and (
not module.characteristics.is_internal
or dev_settings.log.pre_run.internal_modules
):
is_pipeline_step = job_metadata.get("is_pipeline_step", False)
if is_pipeline_step:
if dev_settings.log.pre_run.pipeline_steps:
step_id = job_metadata.get("step_id", None)
assert step_id is not None
title = (
f"Pre-run information for pipeline step: [i]{step_id}[/i]"
)
else:
title = None
else:
title = f"Pre-run information for module: [i]{module.module_type_name}[/i]"
if title:
from kiara.utils.debug import create_module_preparation_table
from kiara.utils.develop import log_dev_message
table = create_module_preparation_table(
kiara=self._kiara,
job_config=job_config,
job_id=job_id,
module=module,
)
log_dev_message(table, title=title)
return job_id
def queue_job(self, job_id: uuid.UUID) -> ActiveJob:
job_details = self._created_jobs.pop(job_id)
self._running_job_details[job_id] = job_details
job_config: JobConfig = job_details.get("job_config") # type: ignore
job: ActiveJob = job_details.get("job") # type: ignore
module: KiaraModule = job_details.get("module") # type: ignore
outputs: ValueMapWritable = job_details.get("outputs") # type: ignore
self._active_jobs[job_id] = job # type: ignore
self._output_refs[job_id] = outputs # type: ignore
input_values = self._kiara.data_registry.load_values(job_config.inputs)
if module.is_pipeline():
module._set_job_registry(self._kiara.job_registry) # type: ignore
try:
self._add_processing_task(
job_id=job_id,
module=module,
inputs=input_values,
outputs=outputs,
job_log=job.job_log,
)
return job
except Exception as e:
msg = str(e)
if not msg:
msg = repr(e)
job.error = msg
if isinstance(e, KiaraProcessingException):
e._module = module
e._inputs = ValueMapReadOnly.create_from_ids(
data_registry=self._kiara.data_registry, **job_config.inputs
)
job._exception = e
log_exception(e)
raise e
else:
kpe = KiaraProcessingException(
e,
module=module,
inputs=ValueMapReadOnly.create_from_ids(
self._kiara.data_registry, **job_config.inputs
),
)
job._exception = kpe
log_exception(kpe)
raise e
def job_status_updated(
self, job_id: uuid.UUID, status: Union[JobStatus, str, Exception]
):
job = self._active_jobs.get(job_id, None)
if job is None:
raise Exception(
f"Can't retrieve active job with id '{job_id}', no such job registered."
)
old_status = job.status
if status == JobStatus.SUCCESS:
self._active_jobs.pop(job_id)
job.job_log.add_log("job finished successfully")
job.status = JobStatus.SUCCESS
job.finished = datetime.now()
values = self._output_refs[job_id]
values.sync_values()
value_ids = values.get_all_value_ids()
job.results = value_ids
job.job_log.percent_finished = 100
job_record = JobRecord.from_active_job(active_job=job, kiara=self._kiara)
self._job_records[job_id] = job_record
self._finished_jobs[job_id] = job
elif status == JobStatus.FAILED or isinstance(status, (str, Exception)):
self._active_jobs.pop(job_id)
job.job_log.add_log("job failed")
job.status = JobStatus.FAILED
job.finished = datetime.now()
if isinstance(status, str):
job.error = status
elif isinstance(status, Exception):
msg = str(status)
job.error = msg
job._exception = status
self._failed_jobs[job_id] = job
log.debug(
"job.failed",
job_id=str(job.job_id),
msg=job.error,
module_type=job.job_config.module_type,
)
elif status == JobStatus.STARTED:
job.job_log.add_log("job started")
job.status = JobStatus.STARTED
job.started = datetime.now()
else:
raise ValueError(f"Invalid value for status: {status}")
log.debug(
"job.status_updated",
old_status=old_status.value,
new_status=job.status.value,
job_id=str(job.job_id),
module_type=job.job_config.module_type,
)
if status in [JobStatus.SUCCESS, JobStatus.FAILED]:
if is_develop():
dev_config = get_dev_config()
if dev_config.log.log_post_run:
details = self._running_job_details[job_id]
module: KiaraModule = details["module"]
skip = False
if (
module.characteristics.is_internal
and not dev_config.log.post_run.internal_modules
):
skip = True
is_pipeline_step = details["job_metadata"].get(
"is_pipeline_step", False
)
if is_pipeline_step and not dev_config.log.post_run.pipeline_steps:
skip = True
if not skip:
if is_pipeline_step:
step_id = details["job_metadata"]["step_id"]
title = f"Post-run information for pipeline step: {step_id}"
else:
title = f"Post-run information for module: {module.module_type_name}"
from kiara.utils.debug import create_post_run_table
from kiara.utils.develop import log_dev_message
rendered = create_post_run_table(
kiara=self._kiara,
job=job,
module=module,
job_config=details["job_config"],
)
log_dev_message(rendered, title=title)
self._running_job_details.pop(job_id)
self._send_job_event(
job_id=job_id, old_status=old_status, new_status=job.status
)
def wait_for(self, *job_ids: uuid.UUID):
"""Wait for the jobs with the specified ids, also optionally sync their outputs with the pipeline value state."""
self._wait_for(*job_ids)
for job_id in job_ids:
job = self._job_records.get(job_id, None)
if job is None:
_job = self._failed_jobs.get(job_id, None)
if _job is None:
raise Exception(f"Can't find job with id: {job_id}")
@abc.abstractmethod
def _wait_for(self, *job_ids: uuid.UUID):
pass
@abc.abstractmethod
def _add_processing_task(
self,
job_id: uuid.UUID,
module: "KiaraModule",
inputs: ValueMap,
outputs: ValueMapWritable,
job_log: JobLog,
) -> str:
pass
|