fix(TEvDescribeSchemeResult): support null value (#762)

Author: Raubzeug

src/containers/Tenant/Diagnostics/Overview/Overview.tsx

@@ -44,7 +44,7 @@ function Overview({type, tenantName}: OverviewProps) {
 
     const {autorefresh, currentSchemaPath} = useTypedSelector((state) => state.schema);
     const {
-        data,
+        data: rawData,
         additionalData,
         loading: overviewLoading,
         wasLoaded: overviewWasLoaded,
@@ -112,6 +112,7 @@ function Overview({type, tenantName}: OverviewProps) {
     useAutofetcher(fetchData, [fetchData], autorefresh);
 
     const renderContent = () => {
+        const data = rawData ?? undefined;
         // verbose mapping to guarantee a correct render for new path types
         // TS will error when a new type is added but not mapped here
         const pathTypeToComponent: Record<EPathType, (() => ReactNode) | undefined> = {
@@ -124,7 +125,7 @@ function Overview({type, tenantName}: OverviewProps) {
             [EPathType.EPathTypeColumnStore]: undefined,
             [EPathType.EPathTypeColumnTable]: undefined,
             [EPathType.EPathTypeCdcStream]: () => (
-                <ChangefeedInfo data={data} topic={additionalData?.[0]} />
+                <ChangefeedInfo data={data} topic={additionalData?.[0] ?? undefined} />
             ),
             [EPathType.EPathTypePersQueueGroup]: () => <TopicInfo data={data} />,
             [EPathType.EPathTypeExternalTable]: () => <ExternalTableInfo data={data} />,

src/containers/Tenant/Schema/SchemaTree/SchemaTree.tsx

@@ -28,6 +28,9 @@ export function SchemaTree(props: SchemaTreeProps) {
         window.api
             .getSchema({path}, {concurrentId: `NavigationTree.getSchema|${path}`})
             .then((data) => {
+                if (!data) {
+                    throw new Error(`no describe data about path ${path}`);
+                }
                 const {PathDescription: {Children = []} = {}} = data;
 
                 const preloadedData: Record<string, TEvDescribeSchemeResult> = {

src/services/api.ts

@@ -42,6 +42,7 @@ import {BINARY_DATA_IN_PLAIN_TEXT_DISPLAY} from '../utils/constants';
 import {parseMetaCluster} from './parsers/parseMetaCluster';
 import {parseMetaTenants} from './parsers/parseMetaTenants';
 import {settingsManager} from './settings';
+import {Nullable} from '../utils/typecheckers';
 
 type AxiosOptions = {
     concurrentId?: string;
@@ -179,7 +180,7 @@ export class YdbEmbeddedAPI extends AxiosWrapper {
         });
     }
     getSchema({path}: {path: string}, {concurrentId}: AxiosOptions = {}) {
-        return this.get<TEvDescribeSchemeResult>(
+        return this.get<Nullable<TEvDescribeSchemeResult>>(
             this.getPath('/viewer/json/describe'),
             {
                 path,
@@ -195,7 +196,7 @@ export class YdbEmbeddedAPI extends AxiosWrapper {
         );
     }
     getDescribe({path}: {path: string}, {concurrentId}: AxiosOptions = {}) {
-        return this.get<TEvDescribeSchemeResult>(
+        return this.get<Nullable<TEvDescribeSchemeResult>>(
             this.getPath('/viewer/json/describe'),
             {
                 path,
@@ -216,7 +217,7 @@ export class YdbEmbeddedAPI extends AxiosWrapper {
         );
     }
     getHeatmapData({path}: {path: string}) {
-        return this.get<TEvDescribeSchemeResult>(this.getPath('/viewer/json/describe'), {
+        return this.get<Nullable<TEvDescribeSchemeResult>>(this.getPath('/viewer/json/describe'), {
             path,
             enums: true,
             backup: false,
@@ -393,7 +394,7 @@ export class YdbEmbeddedAPI extends AxiosWrapper {
         );
     }
     getTabletDescribe(tenantId: TDomainKey) {
-        return this.get<TEvDescribeSchemeResult>(this.getPath('/viewer/json/describe'), {
+        return this.get<Nullable<TEvDescribeSchemeResult>>(this.getPath('/viewer/json/describe'), {
             schemeshard_id: tenantId?.SchemeShard,
             path_id: tenantId?.PathId,
         });

src/store/reducers/describe.ts

@@ -96,7 +96,7 @@ export function getDescribe({path}: {path: string}) {
         request,
         actions: FETCH_DESCRIBE,
         dataHandler: (data): IDescribeHandledResponse => {
-            const dataPath = data.Path;
+            const dataPath = data?.Path;
             const currentDescribe: IDescribeData = {};
             const newData: IDescribeData = {};
 
@@ -126,14 +126,14 @@ export function getDescribeBatched(paths: string[]) {
             const newData: IDescribeData = {};
 
             data.forEach((dataItem) => {
-                if (dataItem.Path) {
+                if (dataItem?.Path) {
                     newData[dataItem.Path] = dataItem;
                     currentDescribe[dataItem.Path] = dataItem;
                 }
             });
 
             return {
-                path: data[0].Path,
+                path: data[0]?.Path,
                 currentDescribe,
                 data: newData,
             };

src/store/reducers/heatmap.ts

@@ -63,10 +63,10 @@ export function getTabletsInfo({nodes, path}: IHeatmapApiRequestParams) {
             window.api.getHeatmapData({path}),
         ]),
         actions: FETCH_HEATMAP,
-        dataHandler: ([tabletsData = {}, describe = {}]) => {
+        dataHandler: ([tabletsData = {}, describe]) => {
             const {TabletStateInfo: tablets = []} = tabletsData;
             const TabletsMap: Map<string, IHeatmapTabletData> = new Map();
-            const {PathDescription = {}} = describe;
+            const {PathDescription = {}} = describe ?? {};
             const {
                 TablePartitions = [],
                 TablePartitionStats = [],

src/store/reducers/overview/overview.ts

@@ -22,7 +22,7 @@ const schema: Reducer<OverviewState, OverviewAction> = (state = initialState, ac
             };
         }
         case FETCH_OVERVIEW.SUCCESS: {
-            if (action.data.data.Path !== state.currentOverviewPath) {
+            if (action.data.data?.Path !== state.currentOverviewPath) {
                 return state;
             }
 

src/store/reducers/overview/types.ts

@@ -3,19 +3,20 @@ import type {IResponseError} from '../../../types/api/error';
 import type {TEvDescribeSchemeResult} from '../../../types/api/schema';
 
 import {FETCH_OVERVIEW, setDataWasNotLoaded, setCurrentOverviewPath} from './overview';
+import {Nullable} from '../../../utils/typecheckers';
 
 export interface OverviewState {
     loading: boolean;
     wasLoaded: boolean;
     currentOverviewPath?: string;
-    data?: TEvDescribeSchemeResult;
-    additionalData?: TEvDescribeSchemeResult[];
+    data?: Nullable<TEvDescribeSchemeResult>;
+    additionalData?: Nullable<TEvDescribeSchemeResult>[];
     error?: IResponseError;
 }
 
 export interface OverviewHandledResponse {
-    data: TEvDescribeSchemeResult;
-    additionalData?: TEvDescribeSchemeResult[];
+    data: Nullable<TEvDescribeSchemeResult>;
+    additionalData?: Nullable<TEvDescribeSchemeResult>[];
 }
 
 export type OverviewAction =

src/store/reducers/schema/schema.ts

@@ -125,12 +125,12 @@ export function getSchema({path}: {path: string}) {
         actions: FETCH_SCHEMA,
         dataHandler: (data): SchemaHandledResponse => {
             const newData: SchemaData = {};
-            if (data.Path) {
+            if (data?.Path) {
                 newData[data.Path] = data;
             }
             return {
-                path: data.Path,
-                currentSchema: data,
+                path: data?.Path,
+                currentSchema: data ?? undefined,
                 data: newData,
             };
         },

src/store/reducers/tablet.ts

@@ -125,7 +125,7 @@ export const getTabletDescribe = (tenantId: TDomainKey = {}) => {
         actions: FETCH_TABLET_DESCRIBE,
         dataHandler: (tabletDescribe): ITabletDescribeHandledResponse => {
             const {SchemeShard, PathId} = tenantId;
-            const tenantPath = tabletDescribe.Path || `${SchemeShard}:${PathId}`;
+            const tenantPath = tabletDescribe?.Path || `${SchemeShard}:${PathId}`;
 
             return {tenantPath};
         },

src/utils/typecheckers.ts

@@ -3,3 +3,5 @@
  */
 export const isEnumMember = <T extends Object>(object: T, value: any): value is T[keyof T] =>
     Object.values(object).includes(value);
+
+export type Nullable<T> = T | null;