ydb-embedded-ui 3.5.0 → 4.0.0

package/dist/types/api/query.ts

@@ -1,34 +1,165 @@
-// common
+// ==== types from backend protos ====
+interface Position {
+    row?: number;
+    column?: number;
+    file?: string;
+}
 
-type Plan = Record<string, any>;
-type AST = string;
-type Stats = Record<string, any>;
+/** source: https://github.com/ydb-platform/ydb/blob/main/ydb/public/api/protos/ydb_issue_message.proto */
+export interface IssueMessage {
+    position?: Position;
+    end_position?: Position;
+    message?: string;
+    issue_code?: number;
+    severity?: number;
+    issues?: IssueMessage[];
+}
 
-export interface CommonFields {
-    ast?: AST;
-    plan?: Plan;
-    stats?: Stats;
+/** incomplete */
+interface TDqStageStats {}
+
+/** incomplete */
+interface TKqpStatsCompile {}
+
+interface TDqTableStats {
+    TablePath?: string;
+    /** uint64 */
+    ReadRows?: string;
+    /** uint64 */
+    ReadBytes?: string;
+    /** uint64 */
+    WriteRows?: string;
+    /** uint64 */
+    WriteBytes?: string;
+    /** uint64 */
+    EraseRows?: string;
+    /** uint64 */
+    EraseBytes?: string;
+    AffectedPartitions?: number;
+    Extra?: unknown;
 }
 
-interface DeprecatedCommonFields {
-    stats?: Stats;
+/** source: https://github.com/ydb-platform/ydb/blob/main/ydb/library/yql/dq/actors/protos/dq_stats.proto */
+interface TDqExecutionStats {
+    /** uint64 */
+    CpuTimeUs?: string;
+    /** uint64 */
+    DurationUs?: string;
+    /** uint64 */
+    ResultRows?: string;
+    /** uint64 */
+    ResultBytes?: string;
+
+    Tables?: TDqTableStats[];
+
+    /** uint64 */
+    ExecuterCpuTimeUs?: string;
+    /** uint64 */
+    StartTimeMs?: string;
+    /** uint64 */
+    FinishTimeMs?: string;
+    /** uint64 */
+    FirstRowTimeMs?: string;
+
+    Stages?: TDqStageStats[];
+    TxPlansWithStats?: string[];
+
+    Extra: unknown;
 }
 
-export interface ErrorResponse {
-    error?: any;
-    issues?: any;
+/** source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/kqp_stats.proto */
+export interface TKqpStatsQuery {
+    /** uint64 */
+    DurationUs?: string;
+    Compilation?: TKqpStatsCompile;
+
+    /** uint64 */
+    WorkerCpuTimeUs?: string;
+    /** uint64 */
+    ReadSetsCount?: string;
+    /** uint64 */
+    MaxShardProgramSize?: string;
+    /** uint64 */
+    MaxShardReplySize?: string;
+
+    Executions?: TDqExecutionStats[];
 }
 
-export type ExecuteActions = 'execute-script' | 'execute' | 'execute-scan' | undefined;
-export type ExplainActions = 'explain' | 'explain-ast';
-export type Actions = ExecuteActions | ExplainActions;
+// ==== Self-written types ====
+// ==== Meta version 0.2 ====
+// Backend code: https://github.com/ydb-platform/ydb/blob/main/ydb/core/kqp/opt/kqp_query_plan.cpp
 
-// undefined == 'classic'
-export type Schemas = 'classic' | 'modern' | 'ydb' | undefined;
+// ==== Plan ====
+export interface PlanMeta {
+    version: string;
+    type: 'script' | 'query';
+}
 
-// ==== EXECUTE ====
+export interface PlanTable {
+    name: string;
+    reads?: {
+        type: string;
+        lookup_by?: string[];
+        scan_by?: string[];
+        limit?: string;
+        reverse?: boolean;
+        columns?: string[];
+    }[];
+    writes?: {
+        type: string;
+        key?: string[];
+        columns?: string[];
+    }[];
+}
 
-// common types
+interface PlanNodeStats {
+    TotalCpuTimeUs?: number;
+    TotalTasks?: number;
+    TotalInputBytes?: number;
+    TotalInputRows?: number;
+    TotalOutputBytes?: number;
+    TotalDurationMs?: number;
+    TotalOutputRows?: number;
+}
+
+interface PlanNodeOperator {
+    Name: string;
+    Limit?: string;
+    ReadLimit?: string;
+    ReadColumns?: string[];
+    ReadRanges?: string[];
+    Table?: string;
+    Iterator?: string;
+}
+
+export interface PlanNode {
+    PlanNodeId?: number;
+    'Node Type'?: string;
+    Plans?: PlanNode[];
+    Operators?: PlanNodeOperator[];
+    Tables?: string[];
+    PlanNodeType?: string;
+    Stats?: PlanNodeStats;
+    'CTE Name'?: string;
+    'Subplan Name'?: string;
+    'Parent Relationship'?: string;
+}
+
+export interface ScriptPlan {
+    queries?: {
+        Plan?: PlanNode;
+        tables?: PlanTable[];
+    }[];
+    meta: PlanMeta;
+}
+
+export interface ScanPlan {
+    Plan?: PlanNode;
+    tables?: PlanTable[];
+    meta: PlanMeta;
+}
+
+// ==== Common types ====
 
 export type CellValue = string | number | null | undefined;
 
@@ -43,113 +174,91 @@ export interface ColumnType {
     type: string;
 }
 
-// modern response
-
-export type ExecuteModernResponse = {
-    result: ArrayRow[];
-    columns: ColumnType[];
-} & CommonFields;
-
-export type ExecuteClassicResponseDeep = {
-    result: KeyValueRow[];
-} & CommonFields;
-
-// can be undefined for queries like `insert into`
-export type ExecuteClassicResponsePlain = KeyValueRow[] | undefined;
-
-export type ExecuteClassicResponse = ExecuteClassicResponseDeep | ExecuteClassicResponsePlain;
-
-export type ExecuteYdbResponse = {
-    result: KeyValueRow[];
-} & CommonFields;
-
-// prettier-ignore
-type ExecuteResponse<Schema extends Schemas> =
-    | CommonFields // result can be undefined for queries like `insert into`
-    | (Schema extends 'modern'
-          ? ExecuteModernResponse
-          : Schema extends 'ydb'
-            ? ExecuteYdbResponse
-            : Schema extends 'classic' | undefined
-                ? ExecuteClassicResponse
-                : unknown);
-
-// deprecated response from older versions, backward compatibility
-
-type DeprecatedExecuteResponseValue =
-    | KeyValueRow[]
-    | string
-    // can be here because of a bug in the previous backend version
-    // should be ignored in parsing
-    | Plan;
-
-export type DeprecatedExecuteResponseDeep = {
-    // can be undefined for queries like `insert into`
-    result?: DeprecatedExecuteResponseValue;
-} & DeprecatedCommonFields;
-
-// can be undefined for queries like `insert into`
-export type DeprecatedExecuteResponsePlain = DeprecatedExecuteResponseValue | undefined;
-
-export type DeprecatedExecuteResponse =
-    | DeprecatedExecuteResponseDeep
-    | DeprecatedExecuteResponsePlain;
+/** undefined = 'classic' */
+export type Schemas = 'classic' | 'modern' | 'ydb' | undefined;
 
-// ==== EXPLAIN ====
+/**
+ * undefined = 'execute'
+ *
+ * execute and execute-script have similar responses
+ */
+export type ExecuteActions = 'execute' | 'execute-scan' | 'execute-script' | undefined;
 
-// modern response
+/** explain, explain-scan and explain-ast have similar responses */
+export type ExplainActions = 'explain' | 'explain-scan' | 'explain-script' | 'explain-ast';
 
-type ExplainResponse = CommonFields;
+export type Actions = ExecuteActions | ExplainActions;
 
-// deprecated response from older versions, backward compatibility
+// ==== Error response ====
 
-// prettier-ignore
-type DeprecatedExplainResponse<Action extends ExplainActions> = 
-    Action extends 'explain-ast'
-        ? ({result: {ast: AST}} & Required<DeprecatedCommonFields>) | {ast: AST}
-        : Action extends 'explain'
-            ? ({result: Plan} & Required<DeprecatedCommonFields>) | Plan
-            : unknown;
+export interface ErrorResponse {
+    error?: IssueMessage;
+    issues?: IssueMessage[];
+}
 
-// ==== COMBINED API RESPONSE ====
+// ==== Explain Responses ====
 
-export type QueryAPIExecuteResponse<Schema extends Schemas = undefined> =
-    | ExecuteResponse<Schema>
-    | DeprecatedExecuteResponse
-    | null;
+export interface ExplainScriptResponse {
+    plan?: ScriptPlan;
+}
 
-export type QueryAPIExplainResponse<Action extends ExplainActions> =
-    | ExplainResponse
-    | DeprecatedExplainResponse<Action>
-    | null;
+export interface ExplainScanResponse {
+    ast?: string;
+    plan?: ScanPlan;
+}
 
-// prettier-ignore
-export type QueryAPIResponse<Action extends Actions, Schema extends Schemas = undefined> = 
-    Action extends ExecuteActions
-        ? QueryAPIExecuteResponse<Schema>
-        : Action extends ExplainActions
-            ? QueryAPIExplainResponse<Action>
-            : unknown;
+export type ExplainResponse<Action extends ExplainActions> = Action extends 'explain-script'
+    ? ExplainScriptResponse
+    : ExplainScanResponse;
+
+// ==== Execute Responses ====
+
+type ResultFields<Schema extends Schemas> = Schema extends 'modern'
+    ? {
+          result?: ArrayRow[];
+          columns?: ColumnType[];
+      }
+    : {
+          result?: KeyValueRow[];
+      };
+
+export type ExecuteScanResponse<Schema extends Schemas> = {
+    plan?: ScanPlan;
+    ast?: string;
+    stats?: TKqpStatsQuery;
+} & ResultFields<Schema>;
+
+export type ExecuteScriptResponse<Schema extends Schemas> = {
+    plan?: ScriptPlan;
+    ast?: string;
+    stats?: TKqpStatsQuery;
+} & ResultFields<Schema>;
+
+export type ExecuteResponse<
+    Action extends ExecuteActions,
+    Schema extends Schemas,
+> = Action extends 'execute-scan' ? ExecuteScanResponse<Schema> : ExecuteScriptResponse<Schema>;
+
+// ==== Combined API response ====
+export type QueryAPIResponse<
+    Action extends Actions,
+    Schema extends Schemas,
+> = Action extends ExplainActions
+    ? ExplainResponse<Action>
+    : Action extends ExecuteActions
+    ? ExecuteResponse<Action, Schema>
+    : unknown;
+
+// ==== types to use in query result preparation ====
+export type AnyExplainResponse = ExplainScanResponse | ExplainScriptResponse;
+
+export type ExecuteModernResponse = ExecuteScanResponse<'modern'> | ExecuteScriptResponse<'modern'>;
+export type ExecuteClassicResponse =
+    | ExecuteScanResponse<'classic'>
+    | ExecuteScriptResponse<'classic'>;
+export type ExecuteYdbResponse = ExecuteScanResponse<'ydb'> | ExecuteScriptResponse<'ydb'>;
 
 export type AnyExecuteResponse =
     | ExecuteModernResponse
     | ExecuteClassicResponse
-    | ExecuteYdbResponse
-    | CommonFields
-    | DeprecatedExecuteResponse
-    | null;
-
-export type DeepExecuteResponse =
-    | ExecuteModernResponse
-    | ExecuteClassicResponseDeep
-    | ExecuteYdbResponse
-    | DeprecatedExecuteResponseDeep;
-
-export type AnyExplainResponse =
-    | ExplainResponse
-    | CommonFields
-    | DeprecatedExplainResponse<'explain'>
-    | DeprecatedExplainResponse<'explain-ast'>
-    | null;
-
-export type AnyResponse = AnyExecuteResponse | AnyExplainResponse;
+    | ExecuteYdbResponse;

package/dist/types/store/executeQuery.ts

@@ -2,19 +2,17 @@ import {
     SEND_QUERY,
     changeUserInput,
     saveQueryToHistory,
-    selectRunAction,
     goToPreviousQuery,
     setMonacoHotKey,
     goToNextQuery,
     MONACO_HOT_KEY_ACTIONS,
-    RUN_ACTIONS_VALUES,
 } from '../../store/reducers/executeQuery';
 import type {ApiRequestAction} from '../../store/utils';
+import type {ErrorResponse} from '../api/query';
 import type {ValueOf} from '../common';
-import type {IQueryResult} from './query';
+import type {IQueryResult, QueryError} from './query';
 
 export type MonacoHotKeyAction = ValueOf<typeof MONACO_HOT_KEY_ACTIONS>;
-export type RunAction = ValueOf<typeof RUN_ACTIONS_VALUES>;
 
 export interface ExecuteQueryState {
     loading: boolean;
@@ -23,14 +21,13 @@ export interface ExecuteQueryState {
         queries: string[];
         currentIndex: number;
     };
-    runAction: RunAction;
     monacoHotKey: null | MonacoHotKeyAction;
     data?: IQueryResult;
     stats?: IQueryResult['stats'];
-    error?: unknown;
+    error?: string | ErrorResponse;
 }
 
-type SendQueryAction = ApiRequestAction<typeof SEND_QUERY, IQueryResult, unknown>;
+type SendQueryAction = ApiRequestAction<typeof SEND_QUERY, IQueryResult, QueryError>;
 
 export type ExecuteQueryAction =
     | SendQueryAction
@@ -38,5 +35,4 @@ export type ExecuteQueryAction =
     | ReturnType<typeof goToPreviousQuery>
     | ReturnType<typeof changeUserInput>
     | ReturnType<typeof saveQueryToHistory>
-    | ReturnType<typeof selectRunAction>
     | ReturnType<typeof setMonacoHotKey>;

package/dist/types/store/explainQuery.ts

@@ -0,0 +1,38 @@
+import type {ExplainPlanNodeData, GraphNode, Link} from '@gravity-ui/paranoid';
+
+import {GET_EXPLAIN_QUERY, GET_EXPLAIN_QUERY_AST} from '../../store/reducers/explainQuery';
+import type {ApiRequestAction} from '../../store/utils';
+import type {PlanTable, ErrorResponse, ScanPlan, ScriptPlan} from '../api/query';
+import type {IQueryResult, QueryError} from './query';
+
+export interface PreparedExplainResponse {
+    plan?: {
+        links?: Link[];
+        nodes?: GraphNode<ExplainPlanNodeData>[];
+        tables?: PlanTable[];
+        version?: string;
+        pristine?: ScanPlan | ScriptPlan;
+    };
+    ast?: string;
+}
+
+export interface ExplainQueryState {
+    loading: boolean;
+    data?: PreparedExplainResponse['plan'];
+    dataAst?: PreparedExplainResponse['ast'];
+    error?: string | ErrorResponse;
+    errorAst?: string | ErrorResponse;
+}
+
+type GetExplainQueryAstAction = ApiRequestAction<
+    typeof GET_EXPLAIN_QUERY_AST,
+    IQueryResult,
+    QueryError
+>;
+type GetExplainQueryAction = ApiRequestAction<
+    typeof GET_EXPLAIN_QUERY,
+    PreparedExplainResponse,
+    QueryError
+>;
+
+export type ExplainQueryAction = GetExplainQueryAstAction | GetExplainQueryAction;

package/dist/types/store/query.ts

@@ -1,9 +1,29 @@
-import type {KeyValueRow, ColumnType} from '../api/query';
+import type {NetworkError} from '../api/error';
+import type {
+    KeyValueRow,
+    ColumnType,
+    ErrorResponse,
+    ScriptPlan,
+    ScanPlan,
+    TKqpStatsQuery,
+} from '../api/query';
 
 export interface IQueryResult {
     result?: KeyValueRow[];
     columns?: ColumnType[];
-    stats?: any;
-    plan?: any;
+    stats?: TKqpStatsQuery;
+    plan?: ScriptPlan | ScanPlan;
     ast?: string;
 }
+
+export interface QueryRequestParams {
+    database: string;
+    query: string;
+}
+
+export type QueryError = NetworkError | ErrorResponse;
+
+export enum QueryModes {
+    scan = 'scan',
+    script = 'script',
+}

package/dist/utils/constants.ts

@@ -94,6 +94,7 @@ export type IProblemFilterValues = typeof ALL | typeof PROBLEMS;
 export const THEME_KEY = 'theme';
 export const INVERTED_DISKS_KEY = 'invertedDisks';
 export const USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY = 'useNodesEndpointInDiagnostics';
+export const ENABLE_QUERY_MODES_FOR_EXPLAIN = 'enableQueryModesForExplain';
 export const SAVED_QUERIES_KEY = 'saved_queries';
 export const ASIDE_HEADER_COMPACT_KEY = 'asideHeaderCompact';
 export const QUERIES_HISTORY_KEY = 'queries_history';
@@ -118,6 +119,6 @@ export const DEFAULT_TABLE_SETTINGS = {
 } as const;
 
 export const TENANT_INITIAL_TAB_KEY = 'saved_tenant_initial_tab';
-export const QUERY_INITIAL_RUN_ACTION_KEY = 'query_initial_run_action';
+export const QUERY_INITIAL_MODE_KEY = 'query_initial_mode';
 
 export const PARTITIONS_SELECTED_COLUMNS_KEY = 'partitionsSelectedColumns';

package/dist/utils/error.ts

@@ -0,0 +1,25 @@
+import type {AxiosError} from 'axios';
+
+import type {IResponseError, NetworkError} from '../types/api/error';
+import type {ErrorResponse as QueryErrorResponse} from '../types/api/query';
+import type {QueryError} from '../types/store/query';
+
+type RequestError = NetworkError | IResponseError | AxiosError | QueryErrorResponse | unknown;
+
+const isNetworkError = (error: RequestError): error is NetworkError => {
+    return Boolean(
+        error &&
+            typeof error === 'object' &&
+            'message' in error &&
+            (error as {message: unknown}).message === 'Network Error',
+    );
+};
+
+export const parseQueryError = (error: QueryError): QueryErrorResponse | string | undefined => {
+    if (isNetworkError(error)) {
+        return error.message;
+    }
+
+    // 401 Unauthorized error is handled by GenericAPI
+    return error ?? 'Unauthorized';
+};

package/dist/utils/index.js

@@ -113,52 +113,3 @@ export const renderExplainNode = (node) => {
     const parts = node.name.split('|');
     return parts.length > 1 ? parts[1] : node.name;
 };
-
-export const getExplainNodeId = (...values) => {
-    return values.join('|');
-};
-
-const getStringFromProps = (props) => {
-    return props
-        .map(([name, value]) => {
-            return value && `${name}: ${Array.isArray(value) ? value.join(', ') : value}`;
-        })
-        .filter(Boolean)
-        .join('\n');
-};
-
-export const getMetaForExplainNode = (node) => {
-    switch (node.type) {
-        case 'MultiLookup':
-        case 'Lookup': {
-            return getStringFromProps([
-                ['lookup by', node.lookup_by],
-                ['columns', node.columns],
-            ]);
-        }
-        case 'FullScan':
-        case 'Scan': {
-            return getStringFromProps([
-                ['scan by', node.scan_by],
-                ['limit', node.limit],
-                ['columns', node.columns],
-            ]);
-        }
-        case 'Upsert':
-        case 'MultiUpsert': {
-            return getStringFromProps([
-                ['key', node.key],
-                ['columns', node.columns],
-            ]);
-        }
-        case 'Erase':
-        case 'MultiErase': {
-            return getStringFromProps([
-                ['key', node.key],
-                ['columns', node.columns],
-            ]);
-        }
-        default:
-            return '';
-    }
-};

package/dist/utils/prepareQueryExplain.ts

@@ -1,4 +1,4 @@
-import {
+import type {
     Link,
     GraphNode,
     TopologyNodeDataStats,
@@ -7,28 +7,11 @@ import {
     TopologyNodeDataStatsItem,
 } from '@gravity-ui/paranoid';
 
-interface PlanOperator {
-    Name: string;
-    [key: string]: any;
-}
-
-export interface Plan {
-    PlanNodeId: number;
-    'Node Type': string;
-    Plans?: Plan[];
-    Operators?: PlanOperator[];
-    Tables?: string[];
-    PlanNodeType?: string;
-    [key: string]: any;
-}
-
-export interface RootPlan {
-    Plan: Plan;
-}
+import type {PlanNode} from '../types/api/query';
 
 const CONNECTION_NODE_META_FIELDS = new Set(['PlanNodeId', 'PlanNodeType', 'Node Type', 'Plans']);
 
-function prepareStats(plan: Plan) {
+function prepareStats(plan: PlanNode) {
     const stats: TopologyNodeDataStats[] = [];
 
     if (plan.Operators) {
@@ -77,7 +60,7 @@ function prepareStats(plan: Plan) {
     return stats;
 }
 
-function getNodeType(plan: Plan) {
+function getNodeType(plan: PlanNode) {
     switch (plan.PlanNodeType) {
         case 'Connection':
             return 'connection';
@@ -90,11 +73,11 @@ function getNodeType(plan: Plan) {
     }
 }
 
-export function preparePlan(plan: Plan) {
-    const nodes: GraphNode[] = [];
+export function preparePlan(plan: PlanNode) {
+    const nodes: GraphNode<ExplainPlanNodeData>[] = [];
     const links: Link[] = [];
 
-    function parsePlans(plans: Plan[] = [], from: string) {
+    function parsePlans(plans: PlanNode[] = [], from: string) {
         plans.forEach((p) => {
             const node: GraphNode<ExplainPlanNodeData> = {
                 name: String(p.PlanNodeId),