ydb-embedded-ui 4.21.1 → 4.23.0

package/dist/types/api/nodes.ts

@@ -26,6 +26,9 @@ export interface TNodeInfo {
     Tablets?: TTabletStateInfo[];
 }
 
+/**
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+ */
 export interface TSystemStateInfo {
     /** uint64 */
     StartTime?: string;
@@ -62,6 +65,20 @@ export interface TSystemStateInfo {
     /** double */
     MaxDiskUsage?: number;
     Location?: TNodeLocation;
+
+    /**
+     * int64
+     *
+     * a positive value means the peer is ahead in time; a negative value means it's behind
+     */
+    MaxClockSkewWithPeerUs?: string;
+    MaxClockSkewPeerId?: number;
+
+    /** uint64 */
+    DisconnectTime?: string;
+
+    SharedCacheStats?: TNodeSharedCache;
+    TotalSessions?: number;
 }
 
 export interface TPoolStats {
@@ -97,6 +114,13 @@ interface TNodeLocation {
     Unit?: string;
 }
 
+interface TNodeSharedCache {
+    /** uint64 */
+    UsedBytes: string;
+    /** uint64 */
+    LimitBytes: string;
+}
+
 enum EConfigState {
     'Consistent' = 'Consistent',
     'Outdated' = 'Outdated',

package/dist/types/api/query.ts

@@ -180,7 +180,7 @@ export interface ColumnType {
 }
 
 /** undefined = 'classic' */
-export type Schemas = 'classic' | 'modern' | 'ydb' | undefined;
+export type Schemas = 'classic' | 'modern' | 'ydb' | 'multi' | undefined;
 
 /** undefined = 'execute' */
 export type ExecuteActions =
@@ -231,16 +231,29 @@ export type ExplainResponse<Action extends ExplainActions> = Action extends 'exp
     ? ExplainScriptResponse
     : ExplainQueryResponse;
 
+// ==== Execute Results ====
+
+interface ModernSchemaResult {
+    result?: ArrayRow[];
+    columns?: ColumnType[];
+}
+interface MultiSchemaResult {
+    result?: {
+        rows?: ArrayRow[] | null;
+        columns?: ColumnType[];
+    }[];
+}
+interface DefaultSchemaResult {
+    result?: KeyValueRow[];
+}
+
 // ==== Execute Responses ====
 
 type ResultFields<Schema extends Schemas> = Schema extends 'modern'
-    ? {
-          result?: ArrayRow[];
-          columns?: ColumnType[];
-      }
-    : {
-          result?: KeyValueRow[];
-      };
+    ? ModernSchemaResult
+    : Schema extends 'multi'
+    ? MultiSchemaResult
+    : DefaultSchemaResult;
 
 /**
  * meta.type = 'query'
@@ -287,6 +300,7 @@ export type AnyExplainResponse = ExplainQueryResponse | ExplainScriptResponse;
 export type ExecuteModernResponse =
     | ExecuteQueryResponse<'modern'>
     | ExecuteScriptResponse<'modern'>;
+export type ExecuteMultiResponse = ExecuteQueryResponse<'multi'> | ExecuteScriptResponse<'multi'>;
 export type ExecuteClassicResponse =
     | ExecuteQueryResponse<'classic'>
     | ExecuteScriptResponse<'classic'>;
@@ -294,5 +308,6 @@ export type ExecuteYdbResponse = ExecuteQueryResponse<'ydb'> | ExecuteScriptResp
 
 export type AnyExecuteResponse =
     | ExecuteModernResponse
+    | ExecuteMultiResponse
     | ExecuteClassicResponse
     | ExecuteYdbResponse;

package/dist/types/store/query.ts

@@ -11,7 +11,13 @@ import type {
 } from '../api/query';
 import type {ValueOf} from '../common';
 
+export interface ParsedResultSet {
+    columns?: ColumnType[];
+    result?: KeyValueRow[];
+}
+
 export interface IQueryResult {
+    resultSets?: ParsedResultSet[];
     result?: KeyValueRow[];
     columns?: ColumnType[];
     stats?: TKqpStatsQuery;

package/dist/utils/constants.ts

@@ -133,3 +133,6 @@ export const TENANT_INITIAL_PAGE_KEY = 'saved_tenant_initial_tab';
 
 // Send filters and sort params to backend for Nodes and Storage tables
 export const USE_BACKEND_PARAMS_FOR_TABLES_KEY = 'useBackendParamsForTables';
+
+// Enable schema that supports multiple resultsets
+export const QUERY_USE_MULTI_SCHEMA_KEY = 'queryUseMultiSchema';

package/dist/utils/developerUI/__test__/developerUI.test.ts

@@ -0,0 +1,50 @@
+import {
+    createDeveloperUILinkWithNodeId,
+    createPDiskDeveloperUILink,
+    createVDiskDeveloperUILink,
+} from '../developerUI';
+
+describe('Developer UI links generators', () => {
+    describe('createDeveloperUILinkWithNodeId', () => {
+        it('should create relative link with no host', () => {
+            expect(createDeveloperUILinkWithNodeId(1)).toBe('/node/1/');
+        });
+        it('should create relative link with existing relative path with nodeId', () => {
+            expect(createDeveloperUILinkWithNodeId(1, '/node/3/')).toBe('/node/1/');
+        });
+        it('should create full link with host', () => {
+            expect(
+                createDeveloperUILinkWithNodeId(
+                    1,
+                    'http://ydb-vla-dev02-001.search.yandex.net:8765',
+                ),
+            ).toBe('http://ydb-vla-dev02-001.search.yandex.net:8765/node/1/');
+        });
+        it('should create full link with host with existing node path with nodeId', () => {
+            expect(
+                createDeveloperUILinkWithNodeId(
+                    1,
+                    'http://ydb-vla-dev02-001.search.yandex.net:8765/node/3',
+                ),
+            ).toBe('http://ydb-vla-dev02-001.search.yandex.net:8765/node/1/');
+        });
+    });
+    describe('createPDiskDeveloperUILink', () => {
+        it('should create link with pDiskId and nodeId', () => {
+            expect(createPDiskDeveloperUILink({nodeId: 1, pDiskId: 1})).toBe(
+                '/node/1/actors/pdisks/pdisk000000001',
+            );
+        });
+    });
+    describe('createVDiskDeveloperUILink', () => {
+        it('should create link with pDiskId, vDiskSlotId nodeId', () => {
+            expect(
+                createVDiskDeveloperUILink({
+                    nodeId: 1,
+                    pDiskId: 1,
+                    vDiskSlotId: 1,
+                }),
+            ).toBe('/node/1/actors/vdisks/vdisk000000001_000000001');
+        });
+    });
+});

package/dist/utils/developerUI/developerUI.ts

@@ -0,0 +1,42 @@
+import {backend} from '../../store';
+import {pad9} from '../utils';
+
+// Current node connects with target node by itself using nodeId
+export const createDeveloperUILinkWithNodeId = (nodeId: number | string, host = backend) => {
+    const nodePathRegexp = /\/node\/\d+\/?$/g;
+
+    // In case current backend is already relative node path ({host}/node/{nodeId})
+    // We replace existing nodeId path with new nodeId path
+    if (nodePathRegexp.test(String(host))) {
+        return String(host).replace(nodePathRegexp, `/node/${nodeId}/`);
+    }
+
+    return `${host ?? ''}/node/${nodeId}/`;
+};
+
+interface PDiskDeveloperUILinkParams {
+    nodeId: number | string;
+    pDiskId: number | string;
+    host?: string;
+}
+
+export const createPDiskDeveloperUILink = ({nodeId, pDiskId, host}: PDiskDeveloperUILinkParams) => {
+    const pdiskPath = 'actors/pdisks/pdisk' + pad9(pDiskId);
+
+    return createDeveloperUILinkWithNodeId(nodeId, host) + pdiskPath;
+};
+
+interface VDiskDeveloperUILinkParams extends PDiskDeveloperUILinkParams {
+    vDiskSlotId: number | string;
+}
+
+export const createVDiskDeveloperUILink = ({
+    nodeId,
+    pDiskId,
+    vDiskSlotId,
+    host,
+}: VDiskDeveloperUILinkParams) => {
+    const vdiskPath = 'actors/vdisks/vdisk' + pad9(pDiskId) + '_' + pad9(vDiskSlotId);
+
+    return createDeveloperUILinkWithNodeId(nodeId, host) + vdiskPath;
+};

package/dist/utils/diagnostics.ts

@@ -3,6 +3,7 @@ import {ValueOf} from '../types/common';
 const TOP_SHARDS_SORT_VALUES = {
     CPUCores: 'CPUCores',
     DataSize: 'DataSize',
+    InFlightTxCount: 'InFlightTxCount',
 } as const;
 
 const TOP_QUERIES_SORT_VALUES = {

package/dist/utils/hooks/index.ts

@@ -3,6 +3,7 @@ export * from './useTypedSelector';
 export * from './useSetting';
 export * from './useQueryModes';
 export * from './useTableSort';
+export * from './useSearchQuery';
 
 export * from './useNodesRequestParams';
 export * from './useStorageRequestParams';

package/dist/utils/hooks/useSearchQuery.ts

@@ -0,0 +1,9 @@
+import {useLocation} from 'react-router';
+
+import {parseQuery} from '../../routes';
+
+export const useSearchQuery = () => {
+    const location = useLocation();
+
+    return parseQuery(location);
+};

package/dist/utils/query.ts

@@ -2,7 +2,10 @@ import {YQLType} from '../types';
 import type {
     AnyExecuteResponse,
     AnyExplainResponse,
+    ArrayRow,
+    ColumnType,
     ExecuteModernResponse,
+    ExecuteMultiResponse,
     KeyValueRow,
     QueryPlan,
     ScriptPlan,
@@ -76,34 +79,74 @@ export const getColumnType = (type: string) => {
     }
 };
 
-/** parse response result field from ArrayRow to KeyValueRow */
+/** parse response result from ArrayRow to KeyValueRow */
+const parseModernResult = (rows: ArrayRow[], columns: ColumnType[]) => {
+    return rows.map((row) => {
+        return row.reduce<KeyValueRow>((newRow, cellData, columnIndex) => {
+            const {name} = columns[columnIndex];
+            newRow[name] = cellData;
+            return newRow;
+        }, {});
+    });
+};
+
 const parseExecuteModernResponse = (data: ExecuteModernResponse): IQueryResult => {
     const {result, columns, ...restData} = data;
 
     return {
-        result:
-            result &&
-            columns &&
-            result.map((row) => {
-                return row.reduce((newRow, cellData, columnIndex) => {
-                    const {name} = columns[columnIndex];
-                    newRow[name] = cellData;
-                    return newRow;
-                }, {} as KeyValueRow);
-            }),
+        result: result && columns && parseModernResult(result, columns),
         columns,
         ...restData,
     };
 };
 
+const parseExecuteMultiResponse = (data: ExecuteMultiResponse): IQueryResult => {
+    const {result, ...restData} = data;
+
+    const parsedResult = result?.map((resultSet) => {
+        const {rows, columns} = resultSet;
+
+        let parsedRows: KeyValueRow[] | undefined;
+
+        if (columns) {
+            // Result shouldn't be null if there are columns
+            parsedRows = [];
+        }
+
+        if (rows && columns) {
+            parsedRows = parseModernResult(rows, columns);
+        }
+
+        return {
+            columns: columns,
+            result: parsedRows,
+        };
+    });
+
+    return {
+        resultSets: parsedResult, // use a separate field to make result compatible
+        ...restData,
+    };
+};
+
 const isModern = (response: AnyExecuteResponse): response is ExecuteModernResponse =>
     Boolean(
         response &&
             !Array.isArray(response) &&
-            Array.isArray((response as ExecuteModernResponse).result) &&
+            Array.isArray(response.result) &&
             Array.isArray((response as ExecuteModernResponse).columns),
     );
 
+const isMulti = (response: AnyExecuteResponse): response is ExecuteMultiResponse =>
+    Boolean(
+        response &&
+            !Array.isArray(response) &&
+            Array.isArray(response.result) &&
+            typeof response.result[0] === 'object' &&
+            'rows' in response.result[0] &&
+            'columns' in response.result[0],
+    );
+
 type UnsupportedQueryResponseFormat =
     | Array<unknown>
     | string
@@ -122,12 +165,17 @@ const isUnsupportedType = (
     );
 };
 
+// Although schema is set in request, if schema is not supported default schema for the version will be used
+// So we should additionally parse response
 export const parseQueryAPIExecuteResponse = (
     data: AnyExecuteResponse | UnsupportedQueryResponseFormat,
 ): IQueryResult => {
     if (isUnsupportedType(data)) {
         return {};
     }
+    if (isMulti(data)) {
+        return parseExecuteMultiResponse(data);
+    }
     if (isModern(data)) {
         return parseExecuteModernResponse(data);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ydb-embedded-ui",
-  "version": "4.21.1",
+  "version": "4.23.0",
   "files": [
     "dist"
   ],

package/dist/utils/developerUI.ts

@@ -1,32 +0,0 @@
-import {backend} from '../store';
-import {pad9} from './utils';
-
-// Current node connects with target node by itself using nodeId
-export const createDeveloperUILinkWithNodeId = (nodeId: number | string) => {
-    return `${backend}/node/${nodeId}/`;
-};
-
-interface PDiskDeveloperUILinkParams {
-    nodeId: number | string;
-    pDiskId: number | string;
-}
-
-export const createPDiskDeveloperUILink = ({nodeId, pDiskId}: PDiskDeveloperUILinkParams) => {
-    const pdiskPath = 'actors/pdisks/pdisk' + pad9(pDiskId);
-
-    return createDeveloperUILinkWithNodeId(nodeId) + pdiskPath;
-};
-
-interface VDiskDeveloperUILinkParams extends PDiskDeveloperUILinkParams {
-    vDiskSlotId: number | string;
-}
-
-export const createVDiskDeveloperUILink = ({
-    nodeId,
-    pDiskId,
-    vDiskSlotId,
-}: VDiskDeveloperUILinkParams) => {
-    const vdiskPath = 'actors/vdisks/vdisk' + pad9(pDiskId) + '_' + pad9(vDiskSlotId);
-
-    return createDeveloperUILinkWithNodeId(nodeId) + vdiskPath;
-};

package/dist/utils/index.js

@@ -1,9 +0,0 @@
-// determine how many nodes have status Connected "true"
-export const getConnectedNodesCount = (nodeStateInfo) => {
-    return nodeStateInfo?.reduce((acc, item) => (item.Connected ? acc + 1 : acc), 0);
-};
-
-export const renderExplainNode = (node) => {
-    const parts = node.name.split('|');
-    return parts.length > 1 ? parts[1] : node.name;
-};