ydb-embedded-ui 3.5.0 → 4.1.0

package/dist/store/reducers/{explainQuery.js → explainQuery.ts}

@@ -1,21 +1,33 @@
+import type {Reducer} from 'redux';
+import type {ExplainPlanNodeData, GraphNode, Link} from '@gravity-ui/paranoid';
 import _ from 'lodash';
 
 import '../../services/api';
+import type {ExplainActions} from '../../types/api/query';
+import type {
+    ExplainQueryAction,
+    ExplainQueryState,
+    PreparedExplainResponse,
+} from '../../types/store/explainQuery';
+import type {QueryRequestParams, QueryModes} from '../../types/store/query';
 
-import {getExplainNodeId, getMetaForExplainNode} from '../../utils';
 import {preparePlan} from '../../utils/prepareQueryExplain';
-import {parseQueryAPIExplainResponse} from '../../utils/query';
+import {parseQueryAPIExplainResponse, parseQueryExplainPlan} from '../../utils/query';
+import {parseQueryError} from '../../utils/error';
 
 import {createRequestActionTypes, createApiRequest} from '../utils';
 
-const GET_EXPLAIN_QUERY = createRequestActionTypes('query', 'GET_EXPLAIN_QUERY');
-const GET_EXPLAIN_QUERY_AST = createRequestActionTypes('query', 'GET_EXPLAIN_QUERY_AST');
+export const GET_EXPLAIN_QUERY = createRequestActionTypes('query', 'GET_EXPLAIN_QUERY');
+export const GET_EXPLAIN_QUERY_AST = createRequestActionTypes('query', 'GET_EXPLAIN_QUERY_AST');
 
 const initialState = {
     loading: false,
 };
 
-const explainQuery = (state = initialState, action) => {
+const explainQuery: Reducer<ExplainQueryState, ExplainQueryAction> = (
+    state = initialState,
+    action,
+) => {
     switch (action.type) {
         case GET_EXPLAIN_QUERY.REQUEST: {
             return {
@@ -36,11 +48,10 @@ const explainQuery = (state = initialState, action) => {
                 error: undefined,
             };
         }
-        // 401 Unauthorized error is handled by GenericAPI
         case GET_EXPLAIN_QUERY.FAILURE: {
             return {
                 ...state,
-                error: action.error || 'Unauthorized',
+                error: parseQueryError(action.error),
                 loading: false,
             };
         }
@@ -63,7 +74,7 @@ const explainQuery = (state = initialState, action) => {
         case GET_EXPLAIN_QUERY_AST.FAILURE: {
             return {
                 ...state,
-                errorAst: action.error || 'Unauthorized',
+                errorAst: parseQueryError(action.error),
                 loadingAst: false,
             };
         }
@@ -73,7 +84,7 @@ const explainQuery = (state = initialState, action) => {
     }
 };
 
-export const getExplainQueryAst = ({query, database}) => {
+export const getExplainQueryAst = ({query, database}: QueryRequestParams) => {
     return createApiRequest({
         request: window.api.getExplainQueryAst(query, database),
         actions: GET_EXPLAIN_QUERY_AST,
@@ -82,74 +93,48 @@ export const getExplainQueryAst = ({query, database}) => {
 };
 
 export const explainVersions = {
-    v1: '0.1',
     v2: '0.2',
 };
 
 const supportedExplainQueryVersions = Object.values(explainVersions);
 
-export const getExplainQuery = ({query, database}) => {
+interface ExplainQueryParams extends QueryRequestParams {
+    mode?: QueryModes;
+}
+
+export const getExplainQuery = ({query, database, mode}: ExplainQueryParams) => {
+    const action: ExplainActions = mode ? `explain-${mode}` : 'explain';
+
     return createApiRequest({
-        request: window.api.getExplainQuery(query, database),
+        request: window.api.getExplainQuery(query, database, action),
         actions: GET_EXPLAIN_QUERY,
-        dataHandler: (response) => {
-            const {plan: result, ast} = parseQueryAPIExplainResponse(response);
+        dataHandler: (response): PreparedExplainResponse => {
+            const {plan: rawPlan, ast} = parseQueryAPIExplainResponse(response);
 
-            if (!result) {
+            if (!rawPlan) {
                 return {ast};
             }
 
-            let links = [];
-            let nodes = [];
-            const {tables, meta, Plan} = result;
+            const {tables, meta, Plan} = parseQueryExplainPlan(rawPlan);
 
             if (supportedExplainQueryVersions.indexOf(meta.version) === -1) {
+                // Do not prepare plan for not supported versions
                 return {
-                    pristine: result,
-                    version: meta.version,
+                    plan: {
+                        pristine: rawPlan,
+                        version: meta.version,
+                    },
+                    ast,
                 };
             }
-            if (meta.version === explainVersions.v2) {
+
+            let links: Link[] = [];
+            let nodes: GraphNode<ExplainPlanNodeData>[] = [];
+
+            if (Plan) {
                 const preparedPlan = preparePlan(Plan);
                 links = preparedPlan.links;
                 nodes = preparedPlan.nodes;
-            } else {
-                _.forEach(tables, (table) => {
-                    nodes.push({
-                        name: table.name,
-                    });
-
-                    const tableTypes = {};
-
-                    const {reads = [], writes = []} = table;
-                    let prevNodeId = table.name;
-
-                    _.forEach([...reads, ...writes], (node) => {
-                        if (tableTypes[node.type]) {
-                            tableTypes[node.type] = tableTypes[node.type] + 1;
-                        } else {
-                            tableTypes[node.type] = 1;
-                        }
-
-                        const nodeId = getExplainNodeId(
-                            table.name,
-                            node.type,
-                            tableTypes[node.type],
-                        );
-
-                        links.push({
-                            from: prevNodeId,
-                            to: nodeId,
-                        });
-                        nodes.push({
-                            name: nodeId,
-                            meta: getMetaForExplainNode(node),
-                            id: nodeId,
-                        });
-
-                        prevNodeId = nodeId;
-                    });
-                });
             }
 
             return {
@@ -158,7 +143,7 @@ export const getExplainQuery = ({query, database}) => {
                     nodes,
                     tables,
                     version: meta.version,
-                    pristine: result,
+                    pristine: rawPlan,
                 },
                 ast,
             };

package/dist/store/reducers/index.ts

@@ -1,7 +1,7 @@
 import {combineReducers} from 'redux';
 
 import nodes from './nodes';
-import cluster from './cluster';
+import cluster from './cluster/cluster';
 import tenant from './tenant';
 import storage from './storage';
 import node from './node';
@@ -15,7 +15,7 @@ import schema from './schema';
 import host from './host';
 import network from './network';
 import pool from './pool';
-import tenants from './tenants';
+import tenants from './tenants/tenants';
 import tablet from './tablet';
 import topic from './topic';
 import consumer from './consumer';
@@ -82,7 +82,8 @@ const combinedReducer = combineReducers({
     ...rootReducer,
 });
 
-export type IRootReducer = typeof combinedReducer;
-export type IRootState = ReturnType<IRootReducer>;
+export type RootReducer = typeof combinedReducer;
+export type RootState = ReturnType<RootReducer>;
+export type GetState = () => RootState;
 
 export default combinedReducer;

package/dist/store/reducers/settings.js

@@ -3,14 +3,16 @@ import {
     SAVED_QUERIES_KEY,
     THEME_KEY,
     TENANT_INITIAL_TAB_KEY,
-    QUERY_INITIAL_RUN_ACTION_KEY,
     INVERTED_DISKS_KEY,
     ASIDE_HEADER_COMPACT_KEY,
     USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY,
     PARTITIONS_SELECTED_COLUMNS_KEY,
+    QUERY_INITIAL_MODE_KEY,
+    ENABLE_QUERY_MODES_FOR_EXPLAIN,
 } from '../../utils/constants';
 import '../../services/api';
-import {getValueFromLS} from '../../utils/utils';
+import {getValueFromLS, parseJson} from '../../utils/utils';
+import {QueryModes} from '../../types/store/query';
 
 const CHANGE_PROBLEM_FILTER = 'settings/CHANGE_PROBLEM_FILTER';
 const SET_SETTING_VALUE = 'settings/SET_VALUE';
@@ -24,16 +26,6 @@ export function readSavedSettingsValue(key, defaultValue) {
     return savedValue ?? defaultValue;
 }
 
-// navigation managed its compact state internally before, and its approach is not compatible with settings
-// try reading the old localStorage entry to use it as a default value, for backward compatibility
-// assume it is safe to remove this code block if it is at least a few months old
-// there a two of these, search for a similar comment
-let legacyAsideNavCompactState = '';
-try {
-    legacyAsideNavCompactState = String(JSON.parse(getValueFromLS('nvAsideHeader')).isCompact);
-    localStorage.removeItem('nvAsideHeader');
-} catch {}
-
 export const initialState = {
     problemFilter: ALL,
     userSettings: {
@@ -44,13 +36,14 @@ export const initialState = {
             USE_NODES_ENDPOINT_IN_DIAGNOSTICS_KEY,
             'false',
         ),
+        [ENABLE_QUERY_MODES_FOR_EXPLAIN]: readSavedSettingsValue(
+            ENABLE_QUERY_MODES_FOR_EXPLAIN,
+            'false',
+        ),
         [SAVED_QUERIES_KEY]: readSavedSettingsValue(SAVED_QUERIES_KEY, '[]'),
         [TENANT_INITIAL_TAB_KEY]: readSavedSettingsValue(TENANT_INITIAL_TAB_KEY),
-        [QUERY_INITIAL_RUN_ACTION_KEY]: readSavedSettingsValue(QUERY_INITIAL_RUN_ACTION_KEY),
-        [ASIDE_HEADER_COMPACT_KEY]: readSavedSettingsValue(
-            ASIDE_HEADER_COMPACT_KEY,
-            legacyAsideNavCompactState || 'true',
-        ),
+        [QUERY_INITIAL_MODE_KEY]: readSavedSettingsValue(QUERY_INITIAL_MODE_KEY, QueryModes.script),
+        [ASIDE_HEADER_COMPACT_KEY]: readSavedSettingsValue(ASIDE_HEADER_COMPACT_KEY, 'true'),
         [PARTITIONS_SELECTED_COLUMNS_KEY]: readSavedSettingsValue(PARTITIONS_SELECTED_COLUMNS_KEY),
     },
     systemSettings,
@@ -97,6 +90,15 @@ export const getSettingValue = (state, name) => {
     return state.settings.userSettings[name];
 };
 
+/**
+ * Returns parsed settings value.
+ * If value cannot be parsed, returns initially stored string
+ */
+export const getParsedSettingValue = (state, name) => {
+    const value = state.settings.userSettings[name];
+    return parseJson(value);
+};
+
 export const changeFilter = (filter) => {
     return {
         type: CHANGE_PROBLEM_FILTER,

package/dist/store/reducers/{tenants.js → tenants/tenants.ts}

@@ -1,12 +1,15 @@
-import _ from 'lodash';
-import {createRequestActionTypes, createApiRequest} from '../utils';
-import '../../services/api';
+import type {Reducer} from 'redux';
 
-const FETCH_TENANTS = createRequestActionTypes('tenants', 'FETCH_TENANTS');
+import '../../../services/api';
+import {createRequestActionTypes, createApiRequest} from '../../utils';
 
-const initialState = {loading: true, wasLoaded: false, data: {}};
+import type {TenantsAction, TenantsState} from './types';
 
-const tenants = function (state = initialState, action) {
+export const FETCH_TENANTS = createRequestActionTypes('tenants', 'FETCH_TENANTS');
+
+const initialState = {loading: true, wasLoaded: false};
+
+const tenants: Reducer<TenantsState, TenantsAction> = (state = initialState, action) => {
     switch (action.type) {
         case FETCH_TENANTS.REQUEST: {
             return {
@@ -35,20 +38,22 @@ const tenants = function (state = initialState, action) {
     }
 };
 
-export function getTenantsInfo(clusterName) {
+export function getTenantsInfo(clusterName?: string) {
     return createApiRequest({
         request: window.api.getTenants(clusterName),
         actions: FETCH_TENANTS,
         dataHandler: (response, getState) => {
             const {singleClusterMode} = getState();
+
             if (singleClusterMode) {
                 return response.TenantInfo;
             } else {
-                return response.databases?.map((tenant) => {
+                return response.TenantInfo?.map((tenant) => {
                     const node = tenant.Nodes ? tenant.Nodes[0] : {};
                     const address =
                         node.Host && node.Endpoints
-                            ? _.find(node.Endpoints, {Name: 'http-mon'})?.Address
+                            ? node.Endpoints.find((endpoint) => endpoint.Name === 'http-mon')
+                                  ?.Address
                             : undefined;
                     const backend = node.Host ? `${node.Host}${address ? address : ''}` : undefined;
                     return {...tenant, backend};

package/dist/store/reducers/tenants/types.ts

@@ -0,0 +1,17 @@
+import {FETCH_TENANTS} from './tenants';
+
+import type {TTenant} from '../../../types/api/tenant';
+import type {ApiRequestAction} from '../../utils';
+
+export interface PreparedTenant extends TTenant {
+    backend?: string;
+}
+
+export interface TenantsState {
+    loading: boolean;
+    wasLoaded: boolean;
+    tenants?: PreparedTenant[];
+    error?: unknown;
+}
+
+export type TenantsAction = ApiRequestAction<typeof FETCH_TENANTS, PreparedTenant[], unknown>;

package/dist/store/utils.ts

@@ -4,6 +4,7 @@ import {AxiosResponse} from 'axios';
 import createToast from '../utils/createToast';
 
 import {SET_UNAUTHENTICATED} from './reducers/authentication';
+import type {GetState} from './reducers';
 
 export const nop = (result: any) => result;
 
@@ -24,7 +25,7 @@ const isAxiosResponse = (response: any): response is AxiosResponse =>
 type CreateApiRequestParams<Actions, Response, HandledResponse> = {
     actions: Actions;
     request: Promise<Response>;
-    dataHandler?: (data: Response, getState?: () => any) => HandledResponse;
+    dataHandler?: (data: Response, getState: GetState) => HandledResponse;
 };
 
 export function createApiRequest<
@@ -36,7 +37,7 @@ export function createApiRequest<
     request,
     dataHandler = nop,
 }: CreateApiRequestParams<Actions, Response, HandledResponse>) {
-    const doRequest = async function (dispatch: Dispatch, getState: () => any) {
+    const doRequest = async function (dispatch: Dispatch, getState: GetState) {
         dispatch({
             type: actions.REQUEST,
         });

package/dist/types/api/acl.ts

@@ -0,0 +1,25 @@
+/**
+ * endpoint: /viewer/json/acl
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ *
+ * incomplete, only fields that present for ACL requests
+ */
+export interface TMetaInfo {
+    Common: TMetaCommonInfo;
+}
+
+/** incomplete */
+export interface TMetaCommonInfo {
+    Path: string;
+    Owner?: string;
+    ACL?: TACE[];
+}
+
+interface TACE {
+    AccessType: string;
+    AccessRights?: string[];
+    Subject: string;
+    InheritanceType?: string[];
+    AccessRule: string;
+}

package/dist/types/api/cluster.ts

@@ -31,4 +31,7 @@ export interface TClusterInfo {
     Tenants?: string;
     /** uint64 */
     Tablets?: string;
+    
+    Balancer?: string; // additional
+    Solomon?: string; // additional
 }

package/dist/types/api/compute.ts

@@ -2,9 +2,11 @@ import {EFlag} from './enums';
 import {TEndpoint, TLegacyNodeLocation, TPoolStats} from './nodes';
 import {TMetrics} from './tenant';
 
-// endpoint: viewer/json/compute
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
-
+/**
+ * endpoint: viewer/json/compute
+ * 
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
 export interface TComputeInfo {
     Overall: EFlag;
     Tenants?: TComputeTenantInfo[];

package/dist/types/api/error.ts

@@ -4,3 +4,17 @@ export interface IResponseError {
     statusText?: string;
     isCancelled?: boolean;
 }
+
+// Error on offline backend or requests blocked by CORS
+export interface NetworkError {
+    code?: unknown;
+    columnNumber?: unknown;
+    config?: Record<string, unknown>;
+    description?: unknown;
+    fileName?: unknown;
+    lineNumber?: unknown;
+    message?: 'Network Error';
+    name?: string;
+    number?: unknown;
+    stack?: string;
+}

package/dist/types/api/netInfo.ts

@@ -0,0 +1,48 @@
+import type {EFlag} from './enums';
+
+/**
+ * endpoint: /viewer/json/netinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
+export interface TNetInfo {
+    Overall: EFlag;
+    Tenants?: TNetTenantInfo[];
+}
+
+interface TNetTenantInfo {
+    Overall: EFlag;
+    Name: string;
+    Nodes?: TNetNodeInfo[];
+}
+
+interface TNetNodeInfo {
+    NodeId: number;
+    Overall: EFlag;
+    Peers?: TNetNodePeerInfo[];
+    NodeType: ENodeType;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Port: number;
+}
+
+interface TNetNodePeerInfo {
+    NodeId: number;
+    PeerName: string;
+    Connected: boolean;
+    ConnectStatus: EFlag;
+    /** uint64 */
+    ChangeTime: string;
+    NodeType: ENodeType;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Port: number;
+}
+
+enum ENodeType {
+    UnknownNodeType,
+    Static,
+    Dynamic,
+}

package/dist/types/api/nodes.ts

@@ -3,9 +3,11 @@ import {TPDiskStateInfo} from './pdisk';
 import {TTabletStateInfo} from './tablet';
 import {TVDiskStateInfo} from './vdisk';
 
-// endpoint: /viewer/json/nodes
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
-
+/**
+ * endpoint: /viewer/json/nodes
+ * 
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+ */
 export interface TNodesInfo {
     Overall?: EFlag;
     Nodes?: TNodeInfo[];

package/dist/types/api/pdisk.ts

@@ -1,7 +1,16 @@
 import {EFlag} from './enums';
 
-// endpoint: /viewer/json/pdiskinfo
-// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+/**
+ * endpoint: /viewer/json/pdiskinfo
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
+export interface TEvPDiskStateResponse {
+    PDiskStateInfo?: TPDiskStateInfo[];
+    /** uint64 */
+    ResponseTime?: string;
+    ResponseDuration?: number;
+}
 
 export interface TPDiskStateInfo {
     PDiskId?: number;