Skip to content

add offset/limit parameters to operation/list handler #16161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adameat merged 1 commit into from
Mar 25, 2025
Merged

add offset/limit parameters to operation/list handler #16161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ydb/core/viewer/json_local_rpc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,7 @@ class TJsonLocalRpc : public TViewerPipeClient {
return false;
}
}
const auto& params(Event->Get()->Request.GetParams());
Params2Proto(params, request);
Params2Proto(Params, request);
if (!ValidateRequest(request)) {
return false;
}
Expand Down
34 changes: 33 additions & 1 deletion ydb/core/viewer/operation_list.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,27 @@ class TOperationList : public TOperationListRpc {
AllowedMethods = {HTTP_METHOD_GET};
}

bool ValidateRequest(Ydb::Operations::ListOperationsRequest& request) override {
if (!TBase::ValidateRequest(request)) {
return false;
}
ui64 offset = FromStringWithDefault<ui64>(Params.Get("offset"), 0);
ui64 limit = FromStringWithDefault<ui64>(Params.Get("limit"), 0);
if (offset >= 0 && limit > 0) {
if (offset % limit != 0) {
ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", "offset must be a multiple of limit"));
return false;
}
if (limit > 100) {
ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", "limit must be less than or equal to 100"));
return false;
}
request.set_page_size(limit);
request.set_page_token(std::to_string(offset / limit + 1));
}
return true;
}

static YAML::Node GetSwagger() {
YAML::Node node = YAML::Load(R"___(
get:
Expand All @@ -42,7 +63,8 @@ class TOperationList : public TOperationListRpc {
kind:
* `ss/backgrounds`
* `export`
* `import`
* `import/S3`
* `import/YT`
* `buildindex`
* `scriptexec`
required: true
Expand All @@ -57,6 +79,16 @@ class TOperationList : public TOperationListRpc {
description: page token
required: false
type: string
- name: offset
in: query
description: offset. must be a multiple of limit
required: false
type: integer
- name: limit
in: query
description: limit. must be less than or equal to 100
required: false
type: integer
responses:
200:
description: OK
Expand Down
218 changes: 148 additions & 70 deletions ydb/core/viewer/tests/canondata/result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
"status_code": 200,
"text": "1\n"
},
"test.test_operations_list": {
"next_page_token": "1",
"status": "SUCCESS"
},
"test.test_operations_list_page": {
"next_page_token": "1",
"status": "SUCCESS"
},
"test.test_operations_list_page_bad": {
"status_code": 400,
"text": "offset must be a multiple of limit"
},
"test.test_pqrb_tablet": {
"response_create_topic": {
"version": "not-zero-number"
Expand Down Expand Up @@ -506,6 +518,142 @@
],
"TotalGroups": 5
},
"test.test_topic_data": {
"response_compressed": {
"EndOffset": 21,
"Messages": [
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTA=",
"Offset": 11,
"OriginalSize": 20,
"SeqNo": 12,
"StorageSize": 38
},
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTE=",
"Offset": 12,
"OriginalSize": 20,
"SeqNo": 13,
"StorageSize": 38
},
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTI=",
"Offset": 13,
"OriginalSize": 20,
"SeqNo": 14,
"StorageSize": 38
},
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTM=",
"Offset": 14,
"OriginalSize": 20,
"SeqNo": 15,
"StorageSize": 38
},
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTQ=",
"Offset": 15,
"OriginalSize": 20,
"SeqNo": 16,
"StorageSize": 38
}
],
"StartOffset": 0,
"Truncated": true
},
"response_metadata": {
"EndOffset": 21,
"Messages": [
{
"Codec": 1,
"Message": "bWVzc2FnZV93aXRoX21ldGE=",
"MessageMetadata": [
{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
}
],
"Offset": 10,
"OriginalSize": 17,
"SeqNo": 11,
"StorageSize": 37
}
],
"StartOffset": 0,
"Truncated": true
},
"response_not_truncated": {
"EndOffset": 21,
"Messages": [
{
"Codec": 1,
"Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTk=",
"Offset": 20,
"OriginalSize": 20,
"SeqNo": 21,
"StorageSize": 38
}
],
"StartOffset": 0,
"Truncated": false
},
"response_read": {
"EndOffset": 21,
"Messages": [
{
"Codec": 0,
"Message": "bWVzc2FnZS0w",
"Offset": 0,
"OriginalSize": 9,
"SeqNo": 1,
"StorageSize": 9
},
{
"Codec": 0,
"Message": "bWVzc2FnZS0x",
"Offset": 1,
"OriginalSize": 9,
"SeqNo": 2,
"StorageSize": 9
},
{
"Codec": 0,
"Message": "bWVzc2FnZS0y",
"Offset": 2,
"OriginalSize": 9,
"SeqNo": 3,
"StorageSize": 9
},
{
"Codec": 0,
"Message": "bWVzc2FnZS0z",
"Offset": 3,
"OriginalSize": 9,
"SeqNo": 4,
"StorageSize": 9
},
{
"Codec": 0,
"Message": "bWVzc2FnZS00",
"Offset": 4,
"OriginalSize": 9,
"SeqNo": 5,
"StorageSize": 9
}
],
"StartOffset": 0,
"Truncated": true
}
},
"test.test_viewer_acl": {
"/Root": {
"Common": {
Expand Down Expand Up @@ -4943,75 +5091,5 @@
},
"test.test_wait_for_cluster_ready": {
"wait_good": true
},
"test.test_topic_data": {
"response_read": {
"Messages": [
{
"Codec": 0, "StorageSize": 9, "SeqNo": 1, "Message": "bWVzc2FnZS0w", "OriginalSize": 9, "Offset": 0
},
{
"Codec": 0, "StorageSize": 9, "SeqNo": 2, "Message": "bWVzc2FnZS0x", "OriginalSize": 9, "Offset": 1
},
{
"Codec": 0, "StorageSize": 9, "SeqNo": 3, "Message": "bWVzc2FnZS0y", "OriginalSize": 9, "Offset": 2
},
{
"Codec": 0, "StorageSize": 9, "SeqNo": 4, "Message": "bWVzc2FnZS0z", "OriginalSize": 9, "Offset": 3
},
{
"Codec": 0, "StorageSize": 9, "SeqNo": 5, "Message": "bWVzc2FnZS00", "OriginalSize": 9, "Offset": 4
}
],
"StartOffset": 0,
"EndOffset": 21,
"Truncated": true
},
"response_metadata": {
"Messages": [
{
"Codec": 1, "StorageSize": 37, "SeqNo": 11,
"MessageMetadata": [
{"Value": "value1", "Key": "key1"},
{"Value": "value2", "Key": "key2"}],
"Message": "bWVzc2FnZV93aXRoX21ldGE=", "OriginalSize": 17, "Offset": 10
}
],
"StartOffset": 0,
"EndOffset": 21,
"Truncated": true
},
"response_compressed": {
"Messages": [
{
"Codec": 1, "StorageSize": 38, "SeqNo": 12, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTA=", "OriginalSize": 20, "Offset": 11
},
{
"Codec": 1, "StorageSize": 38, "SeqNo": 13, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTE=", "OriginalSize": 20, "Offset": 12
},
{
"Codec": 1, "StorageSize": 38, "SeqNo": 14, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTI=", "OriginalSize": 20, "Offset": 13
},
{
"Codec": 1, "StorageSize": 38, "SeqNo": 15, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTM=", "OriginalSize": 20, "Offset": 14
},
{
"Codec": 1, "StorageSize": 38, "SeqNo": 16, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTQ=", "OriginalSize": 20, "Offset": 15
}
],
"StartOffset": 0,
"EndOffset": 21,
"Truncated": true
},
"response_not_truncated": {
"Messages": [
{
"Codec": 1, "StorageSize": 38, "SeqNo": 21, "Message": "Y29tcHJlc3NlZC1tZXNzYWdlLTk=", "OriginalSize": 20, "Offset": 20
}
],
"StartOffset": 0,
"EndOffset": 21,
"Truncated": false
}
}
}
25 changes: 25 additions & 0 deletions ydb/core/viewer/tests/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,6 +577,31 @@ def test_viewer_nodes_issue_14992():
return result


def test_operations_list():
return get_viewer_normalized("/operation/list", {
'database': dedicated_db,
'kind': 'import/s3'
})


def test_operations_list_page():
return get_viewer_normalized("/operation/list", {
'database': dedicated_db,
'kind': 'import/s3',
'offset': 50,
'limit': 50
})


def test_operations_list_page_bad():
return get_viewer_normalized("/operation/list", {
'database': dedicated_db,
'kind': 'import/s3',
'offset': 10,
'limit': 50
})


def test_topic_data():
grpc_port = cluster.nodes[1].grpc_port

Expand Down
Loading