refactor describe handler (#16766)

Author: adameat

ydb/core/viewer/json_pipe_req.cpp

@@ -896,6 +896,7 @@ void TViewerPipeClient::InitConfig(const TCgiParameters& params) {
     }
     if (!FromStringWithDefault<bool>(params.Get("ui64"), false)) {
         Proto2JsonConfig.StringifyNumbers = TProto2JsonConfig::EStringifyNumbersMode::StringifyInt64Always;
+        Proto2JsonConfig.StringifyNumbersRepeated = TProto2JsonConfig::EStringifyNumbersMode::StringifyInt64Always;
     }
     Proto2JsonConfig.MapAsObject = true;
     Proto2JsonConfig.ConvertAny = true;

ydb/core/viewer/viewer_describe.h

@@ -15,13 +15,10 @@ class TJsonDescribe : public TViewerPipeClient {
     using TThis = TJsonDescribe;
     using TBase = TViewerPipeClient;
     using TBase::ReplyAndPassAway;
-    TAutoPtr<TEvSchemeShard::TEvDescribeSchemeResult> SchemeShardResult;
-    TAutoPtr<TEvTxProxySchemeCache::TEvNavigateKeySetResult> CacheResult;
+    TRequestResponse<TEvSchemeShard::TEvDescribeSchemeResult> SchemeShardResult;
+    TRequestResponse<TEvTxProxySchemeCache::TEvNavigateKeySetResult> CacheResult;
     TAutoPtr<NKikimrViewer::TEvDescribeSchemeInfo> DescribeResult;
-    TJsonSettings JsonSettings;
-    ui32 Timeout = 0;
     bool ExpandSubElements = true;
-    int Requests = 0;
 
 public:
     TJsonDescribe(IViewer* viewer, NMon::TEvHttpInfo::TPtr& ev)
@@ -51,38 +48,36 @@ class TJsonDescribe : public TViewerPipeClient {
         if (NeedToRedirect()) {
             return;
         }
-        const auto& params(Event->Get()->Request.GetParams());
-        JsonSettings.EnumAsNumbers = !FromStringWithDefault<bool>(params.Get("enums"), false);
-        JsonSettings.UI64AsString = !FromStringWithDefault<bool>(params.Get("ui64"), false);
-        Timeout = FromStringWithDefault<ui32>(params.Get("timeout"), 10000);
-        ExpandSubElements = FromStringWithDefault<ui32>(params.Get("subs"), ExpandSubElements);
-        InitConfig(params);
-
-        if (params.Has("schemeshard_id")) {
+        // for describe we keep old behavior where enums is false by default - for compatibility reasons
+        if (FromStringWithDefault<bool>(Params.Get("enums"), false)) {
+            Proto2JsonConfig.EnumMode = TProto2JsonConfig::EnumValueMode::EnumName;
+        } else {
+            Proto2JsonConfig.EnumMode = TProto2JsonConfig::EnumValueMode::EnumNumber;
+        }
+        ExpandSubElements = FromStringWithDefault<ui32>(Params.Get("subs"), ExpandSubElements);
+        if (Params.Has("schemeshard_id")) {
             THolder<TEvSchemeShard::TEvDescribeScheme> request = MakeHolder<TEvSchemeShard::TEvDescribeScheme>();
-            FillParams(&request->Record, params);
-            ui64 schemeShardId = FromStringWithDefault<ui64>(params.Get("schemeshard_id"));
-            SendRequestToPipe(ConnectTabletPipe(schemeShardId), request.Release());
+            FillParams(&request->Record, Params);
+            ui64 schemeShardId = FromStringWithDefault<ui64>(Params.Get("schemeshard_id"));
+            SchemeShardResult = MakeRequestToTablet<TEvSchemeShard::TEvDescribeSchemeResult>(schemeShardId, request.Release());
         } else {
             THolder<TEvTxUserProxy::TEvNavigate> request = MakeHolder<TEvTxUserProxy::TEvNavigate>();
-            FillParams(request->Record.MutableDescribePath(), params);
+            FillParams(request->Record.MutableDescribePath(), Params);
             request->Record.SetUserToken(Event->Get()->UserToken);
-            SendRequest(MakeTxProxyID(), request.Release());
+            SchemeShardResult = MakeRequest<TEvSchemeShard::TEvDescribeSchemeResult>(MakeTxProxyID(), request.Release());
         }
-        ++Requests;
 
-        if (params.Has("path")) {
+        if (Params.Has("path")) {
             TAutoPtr<NSchemeCache::TSchemeCacheNavigate> request(new NSchemeCache::TSchemeCacheNavigate());
             NSchemeCache::TSchemeCacheNavigate::TEntry entry;
             entry.Operation = NSchemeCache::TSchemeCacheNavigate::OpList;
             entry.SyncVersion = false;
-            entry.Path = SplitPath(params.Get("path"));
+            entry.Path = SplitPath(Params.Get("path"));
             request->ResultSet.emplace_back(entry);
-            SendRequest(MakeSchemeCacheID(), new TEvTxProxySchemeCache::TEvNavigateKeySet(request));
-            ++Requests;
+            CacheResult = MakeRequest<TEvTxProxySchemeCache::TEvNavigateKeySetResult>(MakeSchemeCacheID(), new TEvTxProxySchemeCache::TEvNavigateKeySet(request));
         }
 
-        Become(&TThis::StateRequestedDescribe, TDuration::MilliSeconds(Timeout), new TEvents::TEvWakeup());
+        Become(&TThis::StateRequestedDescribe, Timeout, new TEvents::TEvWakeup());
     }
 
     STATEFN(StateRequestedDescribe) {
@@ -95,27 +90,13 @@ class TJsonDescribe : public TViewerPipeClient {
     }
 
     void Handle(TEvSchemeShard::TEvDescribeSchemeResult::TPtr& ev) {
-        SchemeShardResult = ev->Release();
-        if (SchemeShardResult->GetRecord().GetStatus() == NKikimrScheme::EStatus::StatusSuccess) {
-            ReplyAndPassAway();
-        } else {
-            RequestDone("TEvDescribeSchemeResult");
-        }
+        SchemeShardResult.Set(std::move(ev));
+        RequestDone();
     }
 
-    void Handle(TEvTxProxySchemeCache::TEvNavigateKeySetResult::TPtr &ev) {
-        CacheResult = ev->Release();
-        RequestDone("TEvNavigateKeySetResult");
-    }
-
-    void RequestDone(const char* name) {
-        --Requests;
-        if (Requests == 0) {
-            ReplyAndPassAway();
-        }
-        if (Requests < 0) {
-            BLOG_CRIT("Requests < 0 in RequestDone(" << name << ")");
-        }
+    void Handle(TEvTxProxySchemeCache::TEvNavigateKeySetResult::TPtr& ev) {
+        CacheResult.Set(std::move(ev));
+        RequestDone();
     }
 
     void FillDescription(NKikimrSchemeOp::TDirEntry* descr, ui64 schemeShardId) {
@@ -242,10 +223,10 @@ class TJsonDescribe : public TViewerPipeClient {
     }
 
     void ReplyAndPassAway() override {
-        TStringStream json;
-        if (SchemeShardResult != nullptr && SchemeShardResult->GetRecord().GetStatus() == NKikimrScheme::EStatus::StatusSuccess) {
+        NJson::TJsonValue json;
+        if (SchemeShardResult.IsOk()) {
             DescribeResult = GetSchemeShardDescribeSchemeInfo();
-        } else if (CacheResult != nullptr) {
+        } else if (CacheResult.IsOk()) {
             NSchemeCache::TSchemeCacheNavigate *navigate = CacheResult->Request.Get();
             Y_ABORT_UNLESS(navigate->ResultSet.size() == 1);
             if (navigate->ErrorCount == 0) {
@@ -282,8 +263,7 @@ class TJsonDescribe : public TViewerPipeClient {
             const auto *descriptor = NKikimrScheme::EStatus_descriptor();
             auto accessDeniedStatus = descriptor->FindValueByNumber(NKikimrScheme::StatusAccessDenied)->name();
             if (DescribeResult->GetStatus() == accessDeniedStatus) {
-                Send(Event->Sender, new NMon::TEvHttpInfoRes(Viewer->GetHTTPFORBIDDEN(Event->Get()), 0, NMon::IEvHttpInfoRes::EContentType::Custom));
-                PassAway();
+                ReplyAndPassAway(GetHTTPFORBIDDEN("text/plain", "Forbidden"));
                 return;
             }
             for (auto& child : *DescribeResult->MutablePathDescription()->MutableChildren()) {
@@ -294,16 +274,14 @@ class TJsonDescribe : public TViewerPipeClient {
                     child.ClearParentPathId();
                 }
             }
-            TProtoToJson::ProtoToJson(json, *DescribeResult, JsonSettings);
+            Proto2Json(*DescribeResult, json);
             DecodeExternalTableContent(json);
-        } else {
-            json << "null";
         }
 
-        ReplyAndPassAway(GetHTTPOKJSON(json.Str()));
+        ReplyAndPassAway(GetHTTPOKJSON(json));
     }
 
-    void DecodeExternalTableContent(TStringStream& json) const {
+    void DecodeExternalTableContent(NJson::TJsonValue& json) const {
         if (!DescribeResult) {
             return;
         }
@@ -318,29 +296,21 @@ class TJsonDescribe : public TViewerPipeClient {
         }
 
         NExternalSource::IExternalSourceFactory::TPtr externalSourceFactory{NExternalSource::CreateExternalSourceFactory({}, nullptr, 50000, nullptr, false, false, NYql::GetAllExternalDataSourceTypes())};
-        NJson::TJsonValue root;
         const auto& sourceType = DescribeResult->GetPathDescription().GetExternalTableDescription().GetSourceType();
         try {
-            NJson::ReadJsonTree(json.Str(), &root);
-            root["PathDescription"]["ExternalTableDescription"].EraseValue("Content");
+            json["PathDescription"]["ExternalTableDescription"].EraseValue("Content");
             auto source = externalSourceFactory->GetOrCreate(sourceType);
             auto parameters = source->GetParameters(content);
             for (const auto& [key, items]: parameters) {
                 NJson::TJsonValue array{NJson::EJsonValueType::JSON_ARRAY};
                 for (const auto& item: items) {
                     array.AppendValue(item);
                 }
-                root["PathDescription"]["ExternalTableDescription"]["Content"][key] = array;
+                json["PathDescription"]["ExternalTableDescription"]["Content"][key] = array;
             }
         } catch (...) {
             BLOG_CRIT("Сan't unpack content for external table: " << sourceType << ", error: " << CurrentExceptionMessage());
         }
-        json.Clear();
-        json << root;
-    }
-
-    void HandleTimeout() {
-        ReplyAndPassAway(GetHTTPGATEWAYTIMEOUT());
     }
 
     static YAML::Node GetSwagger() {
@@ -369,6 +339,7 @@ class TJsonDescribe : public TViewerPipeClient {
             .Name = "enums",
             .Description = "convert enums to strings",
             .Type = "boolean",
+            .Default = "false",
         });
         yaml.AddParameter({
             .Name = "ui64",