chore: remove deprecated types from query, refactor

Author: artemmufazalov

src/services/api.d.ts

@@ -38,14 +38,14 @@ interface Window {
             },
             axiosOptions?: AxiosOptions,
         ) => Promise<import('../types/api/query').QueryAPIResponse<Action, Schema>>;
-        getExplainQuery: (
+        getExplainQuery: <Action extends import('../types/api/query').ExplainActions = 'explain'>(
             query: string,
             database: string,
-        ) => Promise<import('../types/api/query').QueryAPIExplainResponse<'explain'>>;
+        ) => Promise<import('../types/api/query').ExplainResponse<Action>>;
         getExplainQueryAst: (
             query: string,
             database: string,
-        ) => Promise<import('../types/api/query').QueryAPIExplainResponse<'explain-ast'>>;
+        ) => Promise<import('../types/api/query').ExplainResponse<'explain-ast'>>;
         getHealthcheckInfo: (
             database: string,
         ) => Promise<import('../types/api/healthcheck').HealthCheckAPIResponse>;

src/types/api/query.ts

@@ -159,38 +159,7 @@ export interface ScanPlan {
     meta: PlanMeta;
 }
 
-// ====================
-// common
-
-type Plan = Record<string, any>;
-type AST = string;
-type Stats = Record<string, any>;
-
-export interface CommonFields {
-    ast?: AST;
-    plan?: Plan;
-    stats?: Stats;
-}
-
-interface DeprecatedCommonFields {
-    stats?: Stats;
-}
-
-export interface ErrorResponse {
-    error?: IssueMessage;
-    issues?: IssueMessage[];
-}
-
-export type ExecuteActions = 'execute-script' | 'execute' | 'execute-scan' | undefined;
-export type ExplainActions = 'explain' | 'explain-ast';
-export type Actions = ExecuteActions | ExplainActions;
-
-// undefined == 'classic'
-export type Schemas = 'classic' | 'modern' | 'ydb' | undefined;
-
-// ==== EXECUTE ====
-
-// common types
+// ==== Common types ====
 
 export type CellValue = string | number | null | undefined;
 
@@ -205,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;

src/types/store/explainQuery.ts

@@ -2,24 +2,24 @@ 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 {ErrorResponse} from '../api/query';
+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?: unknown;
+        tables?: PlanTable[];
         version?: string;
-        pristine?: unknown;
+        pristine?: ScanPlan | ScriptPlan;
     };
-    ast?: IQueryResult['ast'];
+    ast?: string;
 }
 
 export interface ExplainQueryState {
     loading: boolean;
     data?: PreparedExplainResponse['plan'];
-    dataAst?: IQueryResult['ast'];
+    dataAst?: PreparedExplainResponse['ast'];
     error?: string | ErrorResponse;
     errorAst?: string | ErrorResponse;
 }

src/types/store/query.ts

@@ -1,11 +1,18 @@
 import type {NetworkError} from '../api/error';
-import type {KeyValueRow, ColumnType, ErrorResponse} from '../api/query';
+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;
 }