Skip to content

Commit 97f641e

Browse files
bisgaard-itisbisgaard-itis
committed
@sanderegg renmaing rpc methods
1 parent 26d92f1 commit 97f641e

File tree

8 files changed

+58
-66
lines changed

8 files changed

+58
-66
lines changed

‎packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/async_jobs/async_jobs.py‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
_RPC_METHOD_NAME_ADAPTER = TypeAdapter(RPCMethodName)
1818

1919

20-
async def abort(
20+
async def cancel(
2121
rabbitmq_rpc_client: RabbitMQRPCClient,
2222
*,
2323
rpc_namespace: RPCNamespace,
@@ -26,47 +26,47 @@ async def abort(
2626
) -> None:
2727
await rabbitmq_rpc_client.request(
2828
rpc_namespace,
29-
_RPC_METHOD_NAME_ADAPTER.validate_python("abort"),
29+
_RPC_METHOD_NAME_ADAPTER.validate_python("cancel"),
3030
job_id=job_id,
3131
job_id_data=job_id_data,
3232
timeout_s=_DEFAULT_TIMEOUT_S,
3333
)
3434

3535

36-
async def get_status(
36+
async def status(
3737
rabbitmq_rpc_client: RabbitMQRPCClient,
3838
*,
3939
rpc_namespace: RPCNamespace,
4040
job_id: AsyncJobId,
4141
job_id_data: AsyncJobNameData,
4242
) -> AsyncJobStatus:
43-
result = await rabbitmq_rpc_client.request(
43+
_result = await rabbitmq_rpc_client.request(
4444
rpc_namespace,
45-
_RPC_METHOD_NAME_ADAPTER.validate_python("get_status"),
45+
_RPC_METHOD_NAME_ADAPTER.validate_python("status"),
4646
job_id=job_id,
4747
job_id_data=job_id_data,
4848
timeout_s=_DEFAULT_TIMEOUT_S,
4949
)
50-
assert isinstance(result, AsyncJobStatus)
51-
return result
50+
assert isinstance(_result, AsyncJobStatus)
51+
return _result
5252

5353

54-
async def get_result(
54+
async def result(
5555
rabbitmq_rpc_client: RabbitMQRPCClient,
5656
*,
5757
rpc_namespace: RPCNamespace,
5858
job_id: AsyncJobId,
5959
job_id_data: AsyncJobNameData,
6060
) -> AsyncJobResult:
61-
result = await rabbitmq_rpc_client.request(
61+
_result = await rabbitmq_rpc_client.request(
6262
rpc_namespace,
63-
_RPC_METHOD_NAME_ADAPTER.validate_python("get_result"),
63+
_RPC_METHOD_NAME_ADAPTER.validate_python("result"),
6464
job_id=job_id,
6565
job_id_data=job_id_data,
6666
timeout_s=_DEFAULT_TIMEOUT_S,
6767
)
68-
assert isinstance(result, AsyncJobResult)
69-
return result
68+
assert isinstance(_result, AsyncJobResult)
69+
return _result
7070

7171

7272
async def list_jobs(
@@ -76,30 +76,30 @@ async def list_jobs(
7676
filter_: str,
7777
job_id_data: AsyncJobNameData,
7878
) -> list[AsyncJobGet]:
79-
result: list[AsyncJobGet] = await rabbitmq_rpc_client.request(
79+
_result: list[AsyncJobGet] = await rabbitmq_rpc_client.request(
8080
rpc_namespace,
8181
_RPC_METHOD_NAME_ADAPTER.validate_python("list_jobs"),
8282
filter_=filter_,
8383
job_id_data=job_id_data,
8484
timeout_s=_DEFAULT_TIMEOUT_S,
8585
)
86-
return result
86+
return _result
8787

8888

89-
async def submit_job(
89+
async def submit(
9090
rabbitmq_rpc_client: RabbitMQRPCClient,
9191
*,
9292
rpc_namespace: RPCNamespace,
9393
method_name: str,
9494
job_id_data: AsyncJobNameData,
9595
**kwargs,
9696
) -> AsyncJobGet:
97-
result = await rabbitmq_rpc_client.request(
97+
_result = await rabbitmq_rpc_client.request(
9898
rpc_namespace,
9999
_RPC_METHOD_NAME_ADAPTER.validate_python(method_name),
100100
job_id_data=job_id_data,
101101
**kwargs,
102102
timeout_s=_DEFAULT_TIMEOUT_S,
103103
)
104-
assert isinstance(result, AsyncJobGet) # nosec
105-
return result
104+
assert isinstance(_result, AsyncJobGet) # nosec
105+
return _result

‎packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/data_export.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
from pydantic import TypeAdapter
88

99
from ... import RabbitMQRPCClient
10-
from ..async_jobs.async_jobs import submit_job
10+
from ..async_jobs.async_jobs import submit
1111

1212

1313
async def start_data_export(
1414
rabbitmq_rpc_client: RabbitMQRPCClient, *, job_id_data: AsyncJobNameData, **kwargs
1515
) -> AsyncJobGet:
16-
return await submit_job(
16+
return await submit(
1717
rabbitmq_rpc_client,
1818
rpc_namespace=STORAGE_RPC_NAMESPACE,
1919
method_name=TypeAdapter(RPCMethodName).validate_python("start_data_export"),

‎packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/paths.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from models_library.users import UserID
1111

1212
from ..._client_rpc import RabbitMQRPCClient
13-
from ..async_jobs.async_jobs import submit_job
13+
from ..async_jobs.async_jobs import submit
1414

1515

1616
async def compute_path_size(
@@ -22,7 +22,7 @@ async def compute_path_size(
2222
path: Path,
2323
) -> tuple[AsyncJobGet, AsyncJobNameData]:
2424
job_id_data = AsyncJobNameData(user_id=user_id, product_name=product_name)
25-
async_job_rpc_get = await submit_job(
25+
async_job_rpc_get = await submit(
2626
rabbitmq_rpc_client=client,
2727
rpc_namespace=STORAGE_RPC_NAMESPACE,
2828
method_name=RPCMethodName("compute_path_size"),

‎services/storage/src/simcore_service_storage/api/rpc/_async_jobs.py‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ async def _assert_job_exists(
3939
job_ids = await celery_client.get_task_uuids(
4040
task_context=job_id_data.model_dump(),
4141
)
42-
if not job_id in job_ids:
42+
if job_id not in job_ids:
4343
raise JobMissingError(job_id=f"{job_id}")
4444

4545

4646
@router.expose(reraise_if_error_type=(JobSchedulerError, JobMissingError))
47-
async def abort(app: FastAPI, job_id: AsyncJobId, job_id_data: AsyncJobNameData):
47+
async def cancel(app: FastAPI, job_id: AsyncJobId, job_id_data: AsyncJobNameData):
4848
assert app # nosec
4949
assert job_id_data # nosec
5050
try:
@@ -60,7 +60,7 @@ async def abort(app: FastAPI, job_id: AsyncJobId, job_id_data: AsyncJobNameData)
6060

6161

6262
@router.expose(reraise_if_error_type=(JobSchedulerError, JobMissingError))
63-
async def get_status(
63+
async def status(
6464
app: FastAPI, job_id: AsyncJobId, job_id_data: AsyncJobNameData
6565
) -> AsyncJobStatus:
6666
assert app # nosec
@@ -93,7 +93,7 @@ async def get_status(
9393
JobMissingError,
9494
)
9595
)
96-
async def get_result(
96+
async def result(
9797
app: FastAPI, job_id: AsyncJobId, job_id_data: AsyncJobNameData
9898
) -> AsyncJobResult:
9999
assert app # nosec
@@ -104,31 +104,31 @@ async def get_result(
104104
await _assert_job_exists(
105105
job_id=job_id, job_id_data=job_id_data, celery_client=get_celery_client(app)
106106
)
107-
status = await get_celery_client(app).get_task_status(
107+
_status = await get_celery_client(app).get_task_status(
108108
task_context=job_id_data.model_dump(),
109109
task_uuid=job_id,
110110
)
111-
if not status.is_done:
111+
if not _status.is_done:
112112
raise JobNotDoneError(job_id=job_id)
113-
result = await get_celery_client(app).get_task_result(
113+
_result = await get_celery_client(app).get_task_result(
114114
task_context=job_id_data.model_dump(),
115115
task_uuid=job_id,
116116
)
117117
except CeleryError as exc:
118118
raise JobSchedulerError(exc=f"{exc}") from exc
119119

120-
if status.task_state == TaskState.ABORTED:
120+
if _status.task_state == TaskState.ABORTED:
121121
raise JobAbortedError(job_id=job_id)
122-
if status.task_state == TaskState.ERROR:
122+
if _status.task_state == TaskState.ERROR:
123123
exc_type = ""
124124
exc_msg = ""
125125
with log_catch(logger=_logger, reraise=False):
126-
task_error = TaskError.model_validate_json(result)
126+
task_error = TaskError.model_validate_json(_result)
127127
exc_type = task_error.exc_type
128128
exc_msg = task_error.exc_msg
129129
raise JobError(job_id=job_id, exc_type=exc_type, exc_msg=exc_msg)
130130

131-
return AsyncJobResult(result=result)
131+
return AsyncJobResult(result=_result)
132132

133133

134134
@router.expose(reraise_if_error_type=(JobSchedulerError,))

‎services/storage/tests/unit/test_data_export.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ async def test_start_data_export_access_error(
300300
faker: Faker,
301301
):
302302
with pytest.raises(AccessRightError):
303-
_ = await async_jobs.submit_job(
303+
_ = await async_jobs.submit(
304304
rpc_client,
305305
rpc_namespace=STORAGE_RPC_NAMESPACE,
306306
method_name="start_data_export",
@@ -330,7 +330,7 @@ async def test_abort_data_export_success(
330330
):
331331
assert mock_celery_client.get_task_uuids_object is not None
332332
assert not isinstance(mock_celery_client.get_task_uuids_object, Exception)
333-
await async_jobs.abort(
333+
await async_jobs.cancel(
334334
rpc_client,
335335
rpc_namespace=STORAGE_RPC_NAMESPACE,
336336
job_id_data=AsyncJobNameData(
@@ -364,7 +364,7 @@ async def test_abort_data_export_error(
364364
assert not isinstance(job_ids, Exception)
365365
_job_id = next(iter(job_ids)) if len(job_ids) > 0 else AsyncJobId(_faker.uuid4())
366366
with pytest.raises(expected_exception_type):
367-
await async_jobs.abort(
367+
await async_jobs.cancel(
368368
rpc_client,
369369
rpc_namespace=STORAGE_RPC_NAMESPACE,
370370
job_id_data=AsyncJobNameData(
@@ -396,7 +396,7 @@ async def test_get_data_export_status(
396396
assert job_ids is not None
397397
assert not isinstance(job_ids, Exception)
398398
_job_id = next(iter(job_ids)) if len(job_ids) > 0 else AsyncJobId(_faker.uuid4())
399-
result = await async_jobs.get_status(
399+
result = await async_jobs.status(
400400
rpc_client,
401401
rpc_namespace=STORAGE_RPC_NAMESPACE,
402402
job_id=_job_id,
@@ -435,7 +435,7 @@ async def test_get_data_export_status_error(
435435
assert not isinstance(job_ids, Exception)
436436
_job_id = next(iter(job_ids)) if len(job_ids) > 0 else AsyncJobId(_faker.uuid4())
437437
with pytest.raises(expected_exception_type):
438-
_ = await async_jobs.get_status(
438+
_ = await async_jobs.status(
439439
rpc_client,
440440
rpc_namespace=STORAGE_RPC_NAMESPACE,
441441
job_id=_job_id,
@@ -468,7 +468,7 @@ async def test_get_data_export_result_success(
468468
assert job_ids is not None
469469
assert not isinstance(job_ids, Exception)
470470
_job_id = next(iter(job_ids)) if len(job_ids) > 0 else AsyncJobId(_faker.uuid4())
471-
result = await async_jobs.get_result(
471+
result = await async_jobs.result(
472472
rpc_client,
473473
rpc_namespace=STORAGE_RPC_NAMESPACE,
474474
job_id=_job_id,
@@ -546,7 +546,7 @@ async def test_get_data_export_result_error(
546546
_job_id = next(iter(job_ids)) if len(job_ids) > 0 else AsyncJobId(_faker.uuid4())
547547

548548
with pytest.raises(expected_exception):
549-
_ = await async_jobs.get_result(
549+
_ = await async_jobs.result(
550550
rpc_client,
551551
rpc_namespace=STORAGE_RPC_NAMESPACE,
552552
job_id=_job_id,

‎services/web/server/src/simcore_service_webserver/tasks/_rest.py‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,7 @@
2727
parse_request_path_parameters_as,
2828
)
2929
from servicelib.aiohttp.rest_responses import create_data_response
30-
from servicelib.rabbitmq.rpc_interfaces.async_jobs.async_jobs import (
31-
abort,
32-
get_result,
33-
get_status,
34-
list_jobs,
35-
)
30+
from servicelib.rabbitmq.rpc_interfaces.async_jobs import async_jobs
3631

3732
from .._meta import API_VTAG
3833
from ..login.decorators import login_required
@@ -78,7 +73,7 @@ async def get_async_jobs(request: web.Request) -> web.Response:
7873

7974
rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
8075

81-
user_async_jobs = await list_jobs(
76+
user_async_jobs = await async_jobs.list_jobs(
8277
rabbitmq_rpc_client=rabbitmq_rpc_client,
8378
rpc_namespace=STORAGE_RPC_NAMESPACE,
8479
job_id_data=AsyncJobNameData(
@@ -118,7 +113,7 @@ async def get_async_job_status(request: web.Request) -> web.Response:
118113
rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
119114

120115
async_job_get = parse_request_path_parameters_as(_StorageAsyncJobId, request)
121-
async_job_rpc_status = await get_status(
116+
async_job_rpc_status = await async_jobs.status(
122117
rabbitmq_rpc_client=rabbitmq_rpc_client,
123118
rpc_namespace=STORAGE_RPC_NAMESPACE,
124119
job_id=async_job_get.task_id,
@@ -152,7 +147,7 @@ async def abort_async_job(request: web.Request) -> web.Response:
152147

153148
rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
154149
async_job_get = parse_request_path_parameters_as(_StorageAsyncJobId, request)
155-
await abort(
150+
await async_jobs.cancel(
156151
rabbitmq_rpc_client=rabbitmq_rpc_client,
157152
rpc_namespace=STORAGE_RPC_NAMESPACE,
158153
job_id=async_job_get.task_id,
@@ -178,7 +173,7 @@ class _PathParams(BaseModel):
178173

179174
rabbitmq_rpc_client = get_rabbitmq_rpc_client(request.app)
180175
async_job_get = parse_request_path_parameters_as(_PathParams, request)
181-
async_job_rpc_result = await get_result(
176+
async_job_rpc_result = await async_jobs.result(
182177
rabbitmq_rpc_client=rabbitmq_rpc_client,
183178
rpc_namespace=STORAGE_RPC_NAMESPACE,
184179
job_id=async_job_get.task_id,

‎services/web/server/tests/unit/with_dbs/01/storage/test_storage.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
from pytest_simcore.helpers.assert_checks import assert_status
2727
from servicelib.aiohttp import status
2828
from servicelib.rabbitmq.rpc_interfaces.async_jobs.async_jobs import (
29-
submit_job,
29+
submit,
3030
)
3131
from simcore_postgres_database.models.users import UserRole
3232

@@ -133,7 +133,7 @@ async def test_compute_path_size(
133133
backend_result_or_exception: Any,
134134
):
135135
create_storage_paths_rpc_client_mock(
136-
submit_job.__name__,
136+
submit.__name__,
137137
backend_result_or_exception,
138138
)
139139

0 commit comments

Comments
 (0)