ydb-embedded-ui 1.14.1 → 2.0.0

package/dist/store/reducers/shardsWorkload.js

@@ -1,6 +1,9 @@
-import {createRequestActionTypes, createApiRequest} from '../utils';
 import '../../services/api';
 
+import {parseQueryAPIExecuteResponse} from '../../utils/query';
+
+import {createRequestActionTypes, createApiRequest} from '../utils';
+
 const SEND_SHARD_QUERY = createRequestActionTypes('query', 'SEND_SHARD_QUERY');
 const SET_SHARD_QUERY_OPTIONS = 'query/SET_SHARD_QUERY_OPTIONS';
 
@@ -76,6 +79,7 @@ const shardsWorkload = (state = initialState, action) => {
 export const sendShardQuery = ({database, path = '', sortOrder}) => {
     return createApiRequest({
         request: window.api.sendQuery({
+            schema: 'modern',
             query: createShardQuery(path, sortOrder, database),
             database,
             action: queryAction,
@@ -83,13 +87,7 @@ export const sendShardQuery = ({database, path = '', sortOrder}) => {
             concurrentId: 'topShards',
         }),
         actions: SEND_SHARD_QUERY,
-        dataHandler: (result) => {
-            if (result && typeof result === 'string') {
-                throw 'Unexpected token in JSON.';
-            }
-
-            return result;
-        },
+        dataHandler: parseQueryAPIExecuteResponse,
     });
 };
 

package/dist/types/api/query.ts

@@ -46,15 +46,12 @@ export interface ColumnType {
 // modern response
 
 export type ExecuteModernResponse = {
-    // either both fields exist, or neither one does
-    // they can be undefined for queries like `insert into`
-    result?: ArrayRow[];
-    columns?: ColumnType[];
+    result: ArrayRow[];
+    columns: ColumnType[];
 } & CommonFields;
 
 export type ExecuteClassicResponseDeep = {
-    // can be undefined for queries like `insert into`
-    result?: KeyValueRow[];
+    result: KeyValueRow[];
 } & CommonFields;
 
 // can be undefined for queries like `insert into`
@@ -63,19 +60,20 @@ export type ExecuteClassicResponsePlain = KeyValueRow[] | undefined;
 export type ExecuteClassicResponse = ExecuteClassicResponseDeep | ExecuteClassicResponsePlain;
 
 export type ExecuteYdbResponse = {
-    // can be undefined for queries like `insert into`
-    result?: KeyValueRow[];
+    result: KeyValueRow[];
 } & CommonFields;
 
-type ExecuteResponse<Schema extends Schemas> = (
-    Schema extends 'modern'
-        ? ExecuteModernResponse
-        : Schema extends 'ydb'
-            ? ExecuteYdbResponse
-            : Schema extends 'classic' | undefined
-                ? ExecuteClassicResponse
-                : unknown
-);
+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
 
@@ -107,9 +105,9 @@ type ExplainResponse = CommonFields;
 
 type DeprecatedExplainResponse<Action extends ExplainActions> = (
     Action extends 'explain-ast'
-        ? {ast: AST} & DeprecatedCommonFields
-        : Actions extends 'explain'
-            ? ({result: Plan} & DeprecatedCommonFields) | Plan
+        ? ({result: {ast: AST}} & Required<DeprecatedCommonFields>) | {ast: AST}
+        : Action extends 'explain'
+            ? ({result: Plan} & Required<DeprecatedCommonFields>) | Plan
             : unknown
 );
 
@@ -138,10 +136,23 @@ export type AnyExecuteResponse =
     | ExecuteModernResponse
     | ExecuteClassicResponse
     | ExecuteYdbResponse
-    | DeprecatedExecuteResponse;
+    | 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;

package/dist/types/assets.d.ts

@@ -9,4 +9,4 @@ declare module '*.jpeg';
 declare module '*.ico';
 
 declare type SVGIconData =
-    import('@yandex-cloud/uikit/build/esm/components/Icon/types').SVGIconData;
+    import('@gravity-ui/uikit/build/esm/components/Icon/types').SVGIconData;

package/dist/types/store/query.ts

@@ -5,5 +5,5 @@ export interface IQueryResult {
     columns?: ColumnType[];
     stats?: any;
     plan?: any;
-    ast?: any;
+    ast?: string;
 }

package/dist/utils/createToast.tsx

@@ -1,4 +1,4 @@
-import {Toaster} from '@yandex-cloud/uikit';
+import {Toaster} from '@gravity-ui/uikit';
 
 const toaster = new Toaster();
 

package/dist/utils/getNodesColumns.js

@@ -1,6 +1,6 @@
 import cn from 'bem-cn-lite';
 import DataTable from '@yandex-cloud/react-data-table';
-import {Button, Popover} from '@yandex-cloud/uikit';
+import {Button, Popover} from '@gravity-ui/uikit';
 
 import Icon from '../components/Icon/Icon';
 import EntityStatus from '../components/EntityStatus/EntityStatus';

package/dist/utils/i18n/i18n.ts

@@ -1,4 +1,4 @@
-import {I18N} from '@yandex-cloud/i18n';
+import {I18N} from '@gravity-ui/i18n';
 
 export enum Lang {
     En = 'en',

package/dist/utils/prepareQueryExplain.ts

@@ -59,8 +59,6 @@ export function preparePlan(plan: Plan) {
     const nodes: GraphNode[] = [];
     const links: Link[] = [];
 
-    let graphDepth = 0;
-
     function parsePlans(plans: Plan[] = [], from: string, curDepth: number) {
         const depth = curDepth + 1;
         plans.forEach((p) => {
@@ -77,7 +75,6 @@ export function preparePlan(plan: Plan) {
             };
             nodes.push(node);
             links.push({from, to: node.name});
-            graphDepth = Math.max(graphDepth, depth);
             parsePlans(p.Plans, node.name, depth);
         });
     }
@@ -96,6 +93,5 @@ export function preparePlan(plan: Plan) {
     return {
         nodes,
         links,
-        graphDepth,
     };
 }

package/dist/utils/query.test.ts

@@ -1,4 +1,7 @@
-import {parseQueryAPIExecuteResponse} from './query';
+import {
+    parseQueryAPIExecuteResponse,
+    parseQueryAPIExplainResponse,
+} from './query';
 
 describe('API utils', () => {
     describe('json/viewer/query', () => {
@@ -185,5 +188,60 @@ describe('API utils', () => {
                 });
             });
         });
+
+        describe('parseQueryAPIExplainResponse', () => {
+            it('should handle empty response', () => {
+                expect(parseQueryAPIExplainResponse(null)).toEqual({});
+            });
+
+            it('should accept stats without a plan', () => {
+                const stats = {metric: 'good'};
+                expect(parseQueryAPIExplainResponse({stats}).stats).toEqual(stats);
+            });
+
+            describe('old format', () => {
+                describe('explain', () => {
+                    it('should parse plan data in the root', () => {
+                        const plan = {foo: 'bar'};
+                        expect(parseQueryAPIExplainResponse(plan).plan).toEqual(plan);
+                    });
+
+                    it('should parse plan in the result field with stats', () => {
+                        const plan = {foo: 'bar'};
+                        const stats = {metric: 'good'};
+                        const actual = parseQueryAPIExplainResponse({result: plan, stats});
+                        expect(actual.plan).toEqual(plan);
+                        expect(actual.stats).toEqual(stats);
+                    });
+                });
+
+                describe('explain-ast', () => {
+                    it('should parse ast field in the root', () => {
+                        const ast = 'ast';
+                        expect(parseQueryAPIExplainResponse({ast}).ast).toBe(ast);
+                    });
+
+                    it('should parse ast in the result field with stats', () => {
+                        const ast = 'ast';
+                        const stats = {metric: 'good'};
+                        const actual = parseQueryAPIExplainResponse({result: {ast}, stats});
+                        expect(actual.ast).toBe(ast);
+                        expect(actual.stats).toEqual(stats);
+                    });
+                });
+            });
+
+            describe('new format', () => {
+                it('should parse explain response with stats', () => {
+                    const plan = {foo: 'bar'};
+                    const ast = 'ast';
+                    const stats = {metric: 'good'};
+                    const actual = parseQueryAPIExplainResponse({plan, ast, stats});
+                    expect(actual.plan).toEqual(plan);
+                    expect(actual.ast).toBe(ast);
+                    expect(actual.stats).toEqual(stats);
+                });
+            });
+        });
     });
 });

package/dist/utils/query.ts

@@ -1,14 +1,14 @@
 import {YQLType} from '../types';
 import type {
     AnyExecuteResponse,
+    AnyExplainResponse,
+    AnyResponse,
     CommonFields,
     DeepExecuteResponse,
     DeprecatedExecuteResponsePlain,
     ExecuteClassicResponsePlain,
     ExecuteModernResponse,
     KeyValueRow,
-    QueryAPIExecuteResponse,
-    Schemas,
 } from '../types/api/query';
 import type {IQueryResult} from '../types/store/query';
 
@@ -97,13 +97,13 @@ const isModern = (response: AnyExecuteResponse): response is ExecuteModernRespon
     Array.isArray((response as ExecuteModernResponse).columns)
 );
 
-const hasCommonFields = (data: AnyExecuteResponse): data is CommonFields => Boolean(
+const hasCommonFields = (data: AnyResponse): data is CommonFields => Boolean(
     data && typeof data === 'object' && ('ast' in data || 'plan' in data || 'stats' in data)
 );
 
 // complex logic because of the variety of possible responses
 // after all backends are updated to the latest version, it can be simplified
-export const parseQueryAPIExecuteResponse = <T extends Schemas>(data: QueryAPIExecuteResponse<T>): IQueryResult => {
+export const parseQueryAPIExecuteResponse = (data: AnyExecuteResponse): IQueryResult => {
     if (!data) {
         return {};
     }
@@ -128,6 +128,40 @@ export const parseQueryAPIExecuteResponse = <T extends Schemas>(data: QueryAPIEx
     };
 };
 
+// complex logic because of the variety of possible responses
+// after all backends are updated to the latest version, it can be simplified
+export const parseQueryAPIExplainResponse = (data: AnyExplainResponse): IQueryResult => {
+    if (!data) {
+        return {};
+    }
+
+    if ('ast' in data) {
+        return data;
+    }
+
+    if ('result' in data) {
+        const {result, ...restData} = data;
+
+        if ('ast' in data.result) {
+            return {
+                ast: result.ast,
+                ...restData,
+            };
+        }
+
+        return {
+            plan: data.result,
+            ...restData,
+        };
+    }
+
+    if (hasCommonFields(data)) {
+        return data;
+    }
+
+    return {plan: data};
+};
+
 export const prepareQueryResponse = (data?: KeyValueRow[]) => {
     if (!Array.isArray(data)) {
         return [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ydb-embedded-ui",
-  "version": "1.14.1",
+  "version": "2.0.0",
   "files": [
     "dist"
   ],
@@ -9,7 +9,7 @@
     "url": "git@github.com:ydb-platform/ydb-embedded-ui.git"
   },
   "dependencies": {
-    "@yandex-cloud/i18n": "0.6.0",
+    "@gravity-ui/i18n": "^1.0.0",
     "@yandex-cloud/paranoid": "^1.2.1",
     "@yandex-cloud/react-data-table": "0.2.1",
     "axios": "0.19.2",
@@ -36,7 +36,7 @@
     "reselect": "4.0.0",
     "sass": "1.32.8",
     "web-vitals": "1.1.2",
-    "ydb-ui-components": "2.4.1"
+    "ydb-ui-components": "3.0.1"
   },
   "scripts": {
     "start": "react-app-rewired start",
@@ -95,6 +95,11 @@
   "devDependencies": {
     "@commitlint/cli": "^15.0.0",
     "@commitlint/config-conventional": "^15.0.0",
+    "@gravity-ui/eslint-config": "^1.0.2",
+    "@gravity-ui/prettier-config": "^1.0.1",
+    "@gravity-ui/stylelint-config": "^1.0.1",
+    "@gravity-ui/tsconfig": "^1.0.0",
+    "@gravity-ui/uikit": "^3.0.1",
     "@testing-library/jest-dom": "^5.15.0",
     "@testing-library/react": "^11.2.7",
     "@testing-library/user-event": "^12.8.3",
@@ -107,12 +112,6 @@
     "@types/react-transition-group": "^4.4.4",
     "@types/react-virtualized-auto-sizer": "^1.0.1",
     "@yandex-cloud/axios-wrapper": "^1.0.2",
-    "@yandex-cloud/browserslist-config": "1.0.1",
-    "@yandex-cloud/eslint-config": "^1.0.0",
-    "@yandex-cloud/prettier-config": "^1.0.0",
-    "@yandex-cloud/stylelint-config": "^1.1.0",
-    "@yandex-cloud/tsconfig": "^1.0.0",
-    "@yandex-cloud/uikit": "^2.8.0",
     "copyfiles": "^2.4.1",
     "eslint-config-prettier": "^8.3.0",
     "husky": "^7.0.4",
@@ -128,7 +127,6 @@
     "typescript": "^4.5.5"
   },
   "peerDependencies": {
-    "@yandex-cloud/browserslist-config": "^1.0.1",
-    "@yandex-cloud/uikit": "^2.8.0"
+    "@gravity-ui/uikit": "^3.0.1"
   }
 }