-
Notifications
You must be signed in to change notification settings - Fork 5
/
service.py
460 lines (417 loc) · 15.3 KB
/
service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
import datetime
import logging
import time
from abc import ABC, abstractmethod
from concurrent.futures import Future, ThreadPoolExecutor
from http import HTTPStatus
from typing import Awaitable, Callable, Dict, List, Optional, Union
from fastapi import HTTPException
from antarest.core.config import Config
from antarest.core.interfaces.eventbus import Event, EventChannelDirectory, EventType, IEventBus
from antarest.core.jwt import DEFAULT_ADMIN_USER
from antarest.core.model import PermissionInfo, PublicMode
from antarest.core.requests import MustBeAuthenticatedError, RequestParameters, UserHasNotPermissionError
from antarest.core.tasks.model import (
CustomTaskEventMessages,
TaskDTO,
TaskEventPayload,
TaskJob,
TaskJobLog,
TaskListFilter,
TaskResult,
TaskStatus,
TaskType,
)
from antarest.core.tasks.repository import TaskJobRepository
from antarest.core.utils.fastapi_sqlalchemy import db
from antarest.core.utils.utils import retry
from antarest.worker.worker import WorkerTaskCommand, WorkerTaskResult
logger = logging.getLogger(__name__)
TaskUpdateNotifier = Callable[[str], None]
Task = Callable[[TaskUpdateNotifier], TaskResult]
class ITaskService(ABC):
@abstractmethod
def add_worker_task(
self,
task_type: TaskType,
task_queue: str,
task_args: Dict[str, Union[int, float, bool, str]],
name: Optional[str],
ref_id: Optional[str],
request_params: RequestParameters,
) -> Optional[str]:
raise NotImplementedError()
@abstractmethod
def add_task(
self,
action: Task,
name: Optional[str],
task_type: Optional[TaskType],
ref_id: Optional[str],
custom_event_messages: Optional[CustomTaskEventMessages],
request_params: RequestParameters,
) -> str:
raise NotImplementedError()
@abstractmethod
def status_task(
self,
task_id: str,
request_params: RequestParameters,
with_logs: bool = False,
) -> TaskDTO:
raise NotImplementedError()
@abstractmethod
def list_tasks(
self, task_filter: TaskListFilter, request_params: RequestParameters
) -> List[TaskDTO]:
raise NotImplementedError()
@abstractmethod
def await_task(
self, task_id: str, timeout_sec: Optional[int] = None
) -> None:
raise NotImplementedError()
# noinspection PyUnusedLocal
def noop_notifier(message: str) -> None:
pass
DEFAULT_AWAIT_MAX_TIMEOUT = 172800
class TaskJobService(ITaskService):
def __init__(
self,
config: Config,
repository: TaskJobRepository,
event_bus: IEventBus,
):
self.config = config
self.repo = repository
self.event_bus = event_bus
self.tasks: Dict[str, Future[None]] = {}
self.threadpool = ThreadPoolExecutor(
max_workers=config.tasks.max_workers, thread_name_prefix="taskjob_"
)
self.event_bus.add_listener(
self.create_task_event_callback(), [EventType.TASK_CANCEL_REQUEST]
)
self.remote_workers = config.tasks.remote_workers
# set the status of previously running job to FAILED due to server restart
self._fix_running_status()
def _create_worker_task(
self,
task_id: str,
task_type: str,
task_args: Dict[str, Union[int, float, bool, str]],
) -> Callable[[TaskUpdateNotifier], TaskResult]:
task_result_wrapper: List[TaskResult] = []
def _create_awaiter(
res_wrapper: List[TaskResult],
) -> Callable[[Event], Awaitable[None]]:
async def _await_task_end(event: Event) -> None:
task_event = WorkerTaskResult.parse_obj(event.payload)
if task_event.task_id == task_id:
res_wrapper.append(task_event.task_result)
return _await_task_end
# todo: Is `logger_` parameter required? (consider refactoring)
def _send_worker_task(logger_: TaskUpdateNotifier) -> TaskResult:
listener_id = self.event_bus.add_listener(
_create_awaiter(task_result_wrapper),
[EventType.WORKER_TASK_ENDED],
)
self.event_bus.queue(
Event(
type=EventType.WORKER_TASK,
payload=WorkerTaskCommand(
task_id=task_id,
task_type=task_type,
task_args=task_args,
),
# Use `NONE` for internal events
permissions=PermissionInfo(public_mode=PublicMode.NONE),
),
task_type,
)
while not task_result_wrapper:
time.sleep(1)
self.event_bus.remove_listener(listener_id)
return task_result_wrapper[0]
return _send_worker_task
def check_remote_worker_for_queue(self, task_queue: str) -> bool:
return any(task_queue in rw.queues for rw in self.remote_workers)
def add_worker_task(
self,
task_type: TaskType,
task_queue: str,
task_args: Dict[str, Union[int, float, bool, str]],
name: Optional[str],
ref_id: Optional[str],
request_params: RequestParameters,
) -> Optional[str]:
if not self.check_remote_worker_for_queue(task_queue):
logger.warning(
f"Failed to find configured remote worker for task queue {task_queue}"
)
return None
task = self._create_task(name, task_type, ref_id, request_params)
self._launch_task(
self._create_worker_task(str(task.id), task_queue, task_args),
task,
None,
request_params,
)
return str(task.id)
def add_task(
self,
action: Task,
name: Optional[str],
task_type: Optional[TaskType],
ref_id: Optional[str],
custom_event_messages: Optional[CustomTaskEventMessages],
request_params: RequestParameters,
) -> str:
task = self._create_task(name, task_type, ref_id, request_params)
self._launch_task(action, task, custom_event_messages, request_params)
return str(task.id)
def _create_task(
self,
name: Optional[str],
task_type: Optional[TaskType],
ref_id: Optional[str],
request_params: RequestParameters,
) -> TaskJob:
if not request_params.user:
raise MustBeAuthenticatedError()
return self.repo.save(
TaskJob(
name=name or "Unnamed",
owner_id=request_params.user.impersonator,
type=task_type,
ref_id=ref_id,
)
)
def _launch_task(
self,
action: Task,
task: TaskJob,
custom_event_messages: Optional[CustomTaskEventMessages],
request_params: RequestParameters,
) -> None:
if not request_params.user:
raise MustBeAuthenticatedError()
self.event_bus.push(
Event(
type=EventType.TASK_ADDED,
payload=TaskEventPayload(
id=task.id,
message=custom_event_messages.start
if custom_event_messages is not None
else f"Task {task.id} added",
).dict(),
permissions=PermissionInfo(
owner=request_params.user.impersonator
),
)
)
future = self.threadpool.submit(
self._run_task, action, task.id, custom_event_messages
)
self.tasks[task.id] = future
def create_task_event_callback(self) -> Callable[[Event], Awaitable[None]]:
async def task_event_callback(event: Event) -> None:
self._cancel_task(str(event.payload), dispatch=False)
return task_event_callback
def cancel_task(
self, task_id: str, params: RequestParameters, dispatch: bool = False
) -> None:
task = self.repo.get_or_raise(task_id)
if params.user and (
params.user.is_site_admin()
or task.owner_id == params.user.impersonator
):
self._cancel_task(task_id, dispatch)
else:
raise UserHasNotPermissionError()
def _cancel_task(self, task_id: str, dispatch: bool = False) -> None:
task = self.repo.get_or_raise(task_id)
if task_id in self.tasks:
self.tasks[task_id].cancel()
task.status = TaskStatus.CANCELLED.value
self.repo.save(task)
elif dispatch:
self.event_bus.push(
Event(
type=EventType.TASK_CANCEL_REQUEST,
payload=task_id,
# Use `NONE` for internal events
permissions=PermissionInfo(public_mode=PublicMode.NONE),
)
)
def status_task(
self,
task_id: str,
request_params: RequestParameters,
with_logs: bool = False,
) -> TaskDTO:
if not request_params.user:
raise MustBeAuthenticatedError()
if task := self.repo.get(task_id):
return task.to_dto(with_logs)
else:
raise HTTPException(
status_code=HTTPStatus.NOT_FOUND,
detail=f"Failed to retrieve task {task_id} in db",
)
def list_tasks(
self, task_filter: TaskListFilter, request_params: RequestParameters
) -> List[TaskDTO]:
return [
task.to_dto()
for task in self.list_db_tasks(task_filter, request_params)
]
def list_db_tasks(
self, task_filter: TaskListFilter, request_params: RequestParameters
) -> List[TaskJob]:
if not request_params.user:
raise MustBeAuthenticatedError()
user = (
None
if request_params.user.is_site_admin()
else request_params.user.impersonator
)
return self.repo.list(task_filter, user)
def await_task(
self, task_id: str, timeout_sec: Optional[int] = None
) -> None:
logger.info(f"Awaiting task {task_id}")
if task_id in self.tasks:
self.tasks[task_id].result(
timeout_sec or DEFAULT_AWAIT_MAX_TIMEOUT
)
else:
logger.warning(
f"Task {task_id} not handled by this worker, will poll for task completion from db"
)
end = time.time() + (timeout_sec or DEFAULT_AWAIT_MAX_TIMEOUT)
while time.time() < end:
with db():
task = self.repo.get(task_id)
if not task:
logger.error(f"Awaited task {task_id} was not found")
break
if TaskStatus(task.status).is_final():
break
time.sleep(2)
def _run_task(
self,
callback: Task,
task_id: str,
custom_event_messages: Optional[CustomTaskEventMessages] = None,
) -> None:
self.event_bus.push(
Event(
type=EventType.TASK_RUNNING,
payload=TaskEventPayload(
id=task_id,
message=custom_event_messages.running
if custom_event_messages is not None
else f"Task {task_id} is running",
).dict(),
permissions=PermissionInfo(public_mode=PublicMode.READ),
channel=EventChannelDirectory.TASK + task_id,
)
)
logger.info(f"Starting task {task_id}")
with db():
task = retry(lambda: self.repo.get_or_raise(task_id))
task.status = TaskStatus.RUNNING.value
self.repo.save(task)
logger.info(f"Task {task_id} set to RUNNING")
try:
with db():
result = callback(self._task_logger(task_id))
logger.info(f"Task {task_id} ended")
with db():
self._update_task_status(
task_id,
TaskStatus.COMPLETED
if result.success
else TaskStatus.FAILED,
result.success,
result.message,
result.return_value,
)
self.event_bus.push(
Event(
type=EventType.TASK_COMPLETED
if result.success
else EventType.TASK_FAILED,
payload=TaskEventPayload(
id=task_id,
message=custom_event_messages.end
if custom_event_messages is not None
else f'Task {task_id} {"completed" if result.success else "failed"}',
).dict(),
permissions=PermissionInfo(public_mode=PublicMode.READ),
channel=EventChannelDirectory.TASK + task_id,
)
)
except Exception as exc:
err_msg = f"Task {task_id} failed: Unhandled exception {exc}"
logger.error(err_msg, exc_info=exc)
with db():
self._update_task_status(
task_id,
TaskStatus.FAILED,
False,
f"{err_msg}\nSee the logs for detailed information and the error traceback.",
)
message = (
err_msg
if custom_event_messages is None
else custom_event_messages.end
)
self.event_bus.push(
Event(
type=EventType.TASK_FAILED,
payload=TaskEventPayload(
id=task_id, message=message
).dict(),
permissions=PermissionInfo(public_mode=PublicMode.READ),
channel=EventChannelDirectory.TASK + task_id,
)
)
def _task_logger(self, task_id: str) -> Callable[[str], None]:
def log_msg(message: str) -> None:
task = self.repo.get(task_id)
if task:
task.logs.append(TaskJobLog(message=message, task_id=task_id))
self.repo.save(task)
return log_msg
def _fix_running_status(self) -> None:
with db():
previous_tasks = self.list_db_tasks(
TaskListFilter(
status=[TaskStatus.RUNNING, TaskStatus.PENDING]
),
request_params=RequestParameters(user=DEFAULT_ADMIN_USER),
)
for task in previous_tasks:
self._update_task_status(
task.id,
TaskStatus.FAILED,
False,
"Task was interrupted due to server restart",
)
def _update_task_status(
self,
task_id: str,
status: TaskStatus,
result: bool,
message: str,
command_result: Optional[str] = None,
) -> None:
task = self.repo.get_or_raise(task_id)
task.status = status.value
task.result_msg = message
task.result_status = result
task.result = command_result
if status.is_final():
task.completion_date = datetime.datetime.now(datetime.timezone.utc)
self.repo.save(task)