Skip to content

improve vdisk evict swagger and parameters handling #18345

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
May 16, 2025
Merged

improve vdisk evict swagger and parameters handling #18345

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
90 changes: 22 additions & 68 deletions ydb/core/viewer/vdisk_evict.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ class TJsonVDiskEvict : public TViewerPipeClient {
protected:
using TThis = TJsonVDiskEvict;
using TBase = TViewerPipeClient;
IViewer* Viewer;
NMon::TEvHttpInfo::TPtr Event;
ui32 Timeout = 0;
ui32 ActualRetries = 0;
ui32 Retries = 0;
TDuration RetryPeriod = TDuration::MilliSeconds(500);
Expand All @@ -42,23 +39,19 @@ class TJsonVDiskEvict : public TViewerPipeClient {

public:
TJsonVDiskEvict(IViewer* viewer, NMon::TEvHttpInfo::TPtr& ev)
: Viewer(viewer)
, Event(ev)
: TViewerPipeClient(viewer, ev)
{}

inline ui32 GetRequiredParam(const TCgiParameters& params, const std::string& name, ui32& obj) {
if (!TryFromString<ui32>(params.Get(name), obj)) {
TBase::Send(Event->Sender, new NMon::TEvHttpInfoRes(
Viewer->GetHTTPBADREQUEST(Event->Get(), "text/plain", TStringBuilder() << "field '" << name << "' or 'vdisk_id' are required"),
0, NMon::IEvHttpInfoRes::EContentType::Custom));
TBase::ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", TStringBuilder() << "field '" << name << "' is required"));
return false;
}
return true;
}

void Bootstrap() override {
const auto& params(Event->Get()->Request.GetParams());
TString vdisk_id = params.Get("vdisk_id");
TString vdisk_id = Params.Get("vdisk_id");
if (vdisk_id) {
TVector<TString> parts = StringSplitter(vdisk_id).Split('-').SkipEmpty();
if (parts.size() == 5) {
Expand All @@ -71,40 +64,33 @@ class TJsonVDiskEvict : public TViewerPipeClient {
if (parts.size() != 5 || GroupId == Max<ui32>()
|| GroupGeneration == Max<ui32>() || FailRealmIdx == Max<ui32>()
|| FailDomainIdx == Max<ui32>() || VdiskIdx == Max<ui32>()) {
TBase::Send(Event->Sender, new NMon::TEvHttpInfoRes(
Viewer->GetHTTPBADREQUEST(Event->Get(), "text/plain", TStringBuilder() << "Unable to parse the 'vdisk_id' parameter"),
0, NMon::IEvHttpInfoRes::EContentType::Custom));
return PassAway();
return TBase::ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", "Unable to parse the 'vdisk_id' parameter"), "BadRequest");
}
} else if (!GetRequiredParam(params, "group_id", GroupId)
|| !GetRequiredParam(params, "group_generation_id", GroupGeneration)
|| !GetRequiredParam(params, "fail_realm_idx", FailRealmIdx)
|| !GetRequiredParam(params, "fail_domain_idx", FailDomainIdx)
|| !GetRequiredParam(params, "vdisk_idx", VdiskIdx)) {
return PassAway();
} else if (!GetRequiredParam(Params, "group_id", GroupId)
|| !GetRequiredParam(Params, "group_generation_id", GroupGeneration)
|| !GetRequiredParam(Params, "fail_realm_idx", FailRealmIdx)
|| !GetRequiredParam(Params, "fail_domain_idx", FailDomainIdx)
|| !GetRequiredParam(Params, "vdisk_idx", VdiskIdx)) {
return;
//return TBase::ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", "Parameter 'vdisk_id' is required"), "BadRequest");
}

if (Event->Get()->Request.GetMethod() != HTTP_METHOD_POST) {
TBase::Send(Event->Sender, new NMon::TEvHttpInfoRes(
Viewer->GetHTTPBADREQUEST(Event->Get(), "text/plain", "Only POST method is allowed"),
0, NMon::IEvHttpInfoRes::EContentType::Custom));
return PassAway();
return TBase::ReplyAndPassAway(GetHTTPBADREQUEST("text/plain", "Only POST method is allowed"), "BadRequest");
}
TBase::InitConfig(params);

Force = FromStringWithDefault<bool>(params.Get("force"), false);
Timeout = FromStringWithDefault<ui32>(params.Get("timeout"), 10000);
Retries = FromStringWithDefault<ui32>(params.Get("retries"), 0);
RetryPeriod = TDuration::MilliSeconds(FromStringWithDefault<ui32>(params.Get("retry_period"), RetryPeriod.MilliSeconds()));
Force = FromStringWithDefault<bool>(Params.Get("force"), false);
Retries = FromStringWithDefault<ui32>(Params.Get("retries"), 0);
RetryPeriod = TDuration::MilliSeconds(FromStringWithDefault<ui32>(Params.Get("retry_period"), RetryPeriod.MilliSeconds()));

if (Force && !Viewer->CheckAccessAdministration(Event->Get())) {
TBase::Send(Event->Sender, new NMon::TEvHttpInfoRes(Viewer->GetHTTPFORBIDDEN(Event->Get()), 0, NMon::IEvHttpInfoRes::EContentType::Custom));
return TBase::ReplyAndPassAway(GetHTTPFORBIDDEN(), "BadRequest");
return PassAway();
}

SendRequest();

TBase::Become(&TThis::StateWork, TDuration::MilliSeconds(Timeout), new TEvents::TEvWakeup());
TBase::Become(&TThis::StateWork, Timeout, new TEvents::TEvWakeup());
}

STATEFN(StateWork) {
Expand Down Expand Up @@ -145,12 +131,6 @@ class TJsonVDiskEvict : public TViewerPipeClient {
SendRequest();
}

void HandleTimeout() {
Send(Event->Sender, new NMon::TEvHttpInfoRes(
Viewer->GetHTTPGATEWAYTIMEOUT(Event->Get(), "text/plain", "Timeout receiving response from BSC"),
0, NMon::IEvHttpInfoRes::EContentType::Custom));
}

void PassAway() override {
TBase::PassAway();
}
Expand All @@ -175,8 +155,7 @@ class TJsonVDiskEvict : public TViewerPipeClient {
json["result"] = false;
json["error"] = "No response was received from BSC";
}
TBase::Send(Event->Sender, new NMon::TEvHttpInfoRes(Viewer->GetHTTPOKJSON(Event->Get(), NJson::WriteJson(json)), 0, NMon::IEvHttpInfoRes::EContentType::Custom));
PassAway();
TBase::ReplyAndPassAway(GetHTTPOKJSON(json));
}

static YAML::Node GetSwagger() {
Expand All @@ -190,43 +169,18 @@ class TJsonVDiskEvict : public TViewerPipeClient {
- name: vdisk_id
in: query
description: vdisk identifier
required: false
required: true
type: string
- name: group_id
in: query
description: group identifier
required: false
type: integer
- name: group_generation_id
in: query
description: group generation identifier
required: false
type: integer
- name: fail_realm_idx
in: query
description: fail realm identifier
required: false
type: integer
- name: fail_domain_ids
in: query
description: fail domain identifier
required: false
type: integer
- name: vdisk_idx
- name: force
in: query
description: vdisk idx identifier
description: attempt forced operation, ignore warnings
required: false
type: integer
type: boolean
- name: timeout
in: query
description: timeout in ms
required: false
type: integer
- name: force
in: query
description: attempt forced operation, ignore warnings
required: false
type: boolean
responses:
200:
description: OK
Expand Down
Loading