add plan.svg to benchmark report (#8464)

Author: iddqdex

ydb/core/fq/libs/compute/common/utils.cpp

@@ -1,5 +1,5 @@
 #include "utils.h"
-#include "plan2svg.h"
+#include <ydb/public/lib/ydb_cli/common/plan2svg.h>
 
 #include <library/cpp/json/json_reader.h>
 #include <library/cpp/json/json_writer.h>

ydb/core/fq/libs/compute/common/ya.make

@@ -2,7 +2,6 @@ LIBRARY()
 
 SRCS(
     pinger.cpp
-    plan2svg.cpp
     run_actor_params.cpp
     utils.cpp
 )
@@ -20,6 +19,7 @@ PEERDIR(
     ydb/library/yql/providers/generic/connector/api/service/protos
     ydb/library/yql/providers/generic/connector/libcpp
     ydb/library/yql/providers/s3/actors_factory
+    ydb/public/lib/ydb_cli/common
 )
 
 YQL_LAST_ABI_VERSION()

ydb/public/lib/ydb_cli/commands/ydb_benchmark.cpp

@@ -1,7 +1,8 @@
 #include "ydb_benchmark.h"
 #include "benchmark_utils.h"
-#include <ydb/public/lib/ydb_cli/common/pretty_table.h>
 #include <ydb/public/lib/ydb_cli/common/format.h>
+#include <ydb/public/lib/ydb_cli/common/plan2svg.h>
+#include <ydb/public/lib/ydb_cli/common/pretty_table.h>
 #include <library/cpp/json/json_writer.h>
 #include <util/string/printf.h>
 #include <util/folder/path.h>
@@ -93,7 +94,7 @@ TString TWorkloadCommandBenchmark::PatchQuery(const TStringBuf& original) const
 
     std::vector<TStringBuf> lines;
     for (auto& line : StringSplitter(result).Split('\n').SkipEmpty()) {
-        if (line.StartsWith("--")) {
+        if (line.StartsWith("--") && !line.StartsWith("--!")) {
             continue;
         }
 
@@ -386,6 +387,12 @@ bool TWorkloadCommandBenchmark::RunBench(TClient& client, NYdbWorkload::IWorkloa
                     TFileOutput out(PlanFileName + ".ast");
                     out << res.GetPlanAst();
                 }
+                {
+                    TPlanVisualizer pv;
+                    pv.LoadPlans(res.GetQueryPlan());
+                    TFileOutput out(PlanFileName + ".svg");
+                    out << pv.PrintSvgSafe();
+                }
                 planSaved = true;
             }
         }

ydb/core/fq/libs/compute/common/plan2svg.cpp renamed to ydb/public/lib/ydb_cli/common/plan2svg.cpp

@@ -13,6 +13,7 @@ SRCS(
     parameter_stream.cpp
     parameters.cpp
     pg_dump_parser.cpp
+    plan2svg.cpp
     pretty_table.cpp
     print_operation.cpp
     print_utils.cpp

ydb/core/fq/libs/compute/common/plan2svg.h renamed to ydb/public/lib/ydb_cli/common/plan2svg.h

@@ -26,10 +26,11 @@ def get_cli_command() -> list[str]:
             return [cli]
 
     class QueuePlan:
-        def __init__(self, plan: dict | None = None, table: str | None = None, ast: str | None = None) -> None:
+        def __init__(self, plan: dict | None = None, table: str | None = None, ast: str | None = None, svg: str | None = None) -> None:
             self.plan = plan
             self.table = table
             self.ast = ast
+            self.svg = svg
 
     class WorkloadRunResult:
         def __init__(
@@ -115,6 +116,9 @@ def _try_extract_error_message(stderr: str) -> str:
             if (os.path.exists(plan_path + '.ast')):
                 with open(plan_path + '.ast') as f:
                     plan.ast = f.read()
+            if (os.path.exists(plan_path + '.svg')):
+                with open(plan_path + '.svg') as f:
+                    plan.svg = f.read()
 
             return YdbCliHelper.WorkloadRunResult(
                 stats=stats,

ydb/public/lib/ydb_cli/common/ya.make

@@ -46,6 +46,8 @@ def _get_duraton(stats, field):
                 allure.attach(result.plan.table, 'Plan table', attachment_type=allure.attachment_type.TEXT)
             if result.plan.ast is not None:
                 allure.attach(result.plan.ast, 'Plan ast', attachment_type=allure.attachment_type.TEXT)
+            if result.plan.svg is not None:
+                allure.attach(result.plan.svg, 'Plan svg', attachment_type=allure.attachment_type.SVG)
 
         if result.stdout is not None:
             allure.attach(result.stdout, 'Stdout', attachment_type=allure.attachment_type.TEXT)