ydb-embedded-ui 3.0.1 → 3.2.0

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

@@ -1,7 +1,20 @@
-import {createRequestActionTypes, createApiRequest} from '../utils';
+import type {Reducer} from 'redux';
 import '../../services/api';
 
-const FETCH_TABLETS = createRequestActionTypes('tablets', 'FETCH_TABLETS');
+import type {ETabletState, EType} from '../../types/api/tablet';
+import type {
+    ITabletsAction,
+    ITabletsApiRequestParams,
+    ITabletsState,
+} from '../../types/store/tablets';
+
+import {createRequestActionTypes, createApiRequest} from '../utils';
+
+export const FETCH_TABLETS = createRequestActionTypes('tablets', 'FETCH_TABLETS');
+
+const CLEAR_WAS_LOADING_TABLETS = 'tablets/CLEAR_WAS_LOADING_TABLETS';
+const SET_STATE_FILTER = 'tablets/SET_STATE_FILTER';
+const SET_TYPE_FILTER = 'tablets/SET_TYPE_FILTER';
 
 const initialState = {
     loading: true,
@@ -10,13 +23,12 @@ const initialState = {
     typeFilter: [],
 };
 
-const tablets = function z(state = initialState, action) {
+const tablets: Reducer<ITabletsState, ITabletsAction> = (state = initialState, action) => {
     switch (action.type) {
         case FETCH_TABLETS.REQUEST: {
             return {
                 ...state,
                 loading: true,
-                requestTime: new Date().getTime(),
             };
         }
         case FETCH_TABLETS.SUCCESS: {
@@ -35,20 +47,20 @@ const tablets = function z(state = initialState, action) {
                 loading: false,
             };
         }
-        case 'CLEAR_WAS_LOADING_TABLETS': {
+        case CLEAR_WAS_LOADING_TABLETS: {
             return {
                 ...state,
                 wasLoaded: false,
                 loading: true,
             };
         }
-        case 'SET_STATE_FILTER': {
+        case SET_STATE_FILTER: {
             return {
                 ...state,
                 stateFilter: action.data,
             };
         }
-        case 'SET_TYPE_FILTER': {
+        case SET_TYPE_FILTER: {
             return {
                 ...state,
                 typeFilter: action.data,
@@ -59,25 +71,26 @@ const tablets = function z(state = initialState, action) {
     }
 };
 
-export const setStateFilter = (stateFilter) => {
+export const setStateFilter = (stateFilter: ETabletState[]) => {
     return {
-        type: 'SET_STATE_FILTER',
+        type: SET_STATE_FILTER,
         data: stateFilter,
-    };
+    } as const;
 };
 
-export const setTypeFilter = (typeFilter) => {
+export const setTypeFilter = (typeFilter: EType[]) => {
     return {
-        type: 'SET_TYPE_FILTER',
+        type: SET_TYPE_FILTER,
         data: typeFilter,
-    };
+    } as const;
 };
 
-export const clearWasLoadingFlag = () => ({
-    type: 'CLEAR_WAS_LOADING_TABLETS',
-});
+export const clearWasLoadingFlag = () =>
+    ({
+        type: CLEAR_WAS_LOADING_TABLETS,
+    } as const);
 
-export function getTabletsInfo(data) {
+export function getTabletsInfo(data: ITabletsApiRequestParams) {
     return createApiRequest({
         request: window.api.getTabletsInfo(data),
         actions: FETCH_TABLETS,

package/dist/store/state-url-mapping.js

@@ -48,6 +48,22 @@ const paramSetup = {
         generalTab: {
             stateKey: 'tenant.diagnosticsTab',
         },
+        shardsDateFrom: {
+            stateKey: 'shardsWorkload.filters.from',
+            type: 'number',
+        },
+        shardsDateTo: {
+            stateKey: 'shardsWorkload.filters.to',
+            type: 'number',
+        },
+        topQueriesDateFrom: {
+            stateKey: 'executeTopQueries.filters.from',
+            type: 'number',
+        },
+        topQueriesDateTo: {
+            stateKey: 'executeTopQueries.filters.to',
+            type: 'number',
+        },
     },
 };
 

package/dist/types/api/compute.ts

@@ -0,0 +1,52 @@
+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
+
+export interface TComputeInfo {
+    Overall: EFlag;
+    Tenants?: TComputeTenantInfo[];
+    Errors?: string[];
+}
+
+interface TComputeTenantInfo {
+    Overall: EFlag;
+    Name: string;
+    Nodes?: TComputeNodeInfo[];
+}
+
+interface TComputeNodeInfo {
+    /** uint64 */
+    StartTime: string;
+    /** uint64 */
+    ChangeTime: string;
+    SystemLocation: TLegacyNodeLocation;
+    /** double */
+    LoadAverage: number[];
+    NumberOfCpus: number;
+    Overall: EFlag;
+    NodeId: number;
+    DataCenter: string;
+    Rack: string;
+    Host: string;
+    Version: string;
+    PoolStats?: TPoolStats[];
+    Endpoints?: TEndpoint[];
+    Roles?: string[];
+    /** uint64 */
+    MemoryUsed?: string;
+    /** uint64 */
+    MemoryLimit?: string;
+    Metrics: TMetrics;
+    Tablets?: TTabletStateInfo[];
+}
+
+// Tablets in compute nodes
+// Types for tabletInfo and tablets inside nodes and storage endpoints are in tablet.ts
+interface TTabletStateInfo {
+    Type: string;
+    State: EFlag;
+    Count: number;
+}

package/dist/types/api/consumer.ts

@@ -0,0 +1,257 @@
+/* eslint-disable camelcase */
+
+/**
+ * endpoint: /json/describe_consumer
+ *
+ * source: https://github.com/ydb-platform/ydb/blob/main/ydb/public/api/protos/ydb_topic.proto
+ *
+ * Original proto file doesn't specify optional fields, so every field is considered optional
+ */
+export interface DescribeConsumerResult {
+    self?: Entry;
+    consumer?: Consumer;
+    partitions?: PartitionInfo[];
+}
+
+/** Partition info types differs for consumer and topic, although they are very similar */
+export interface PartitionInfo {
+    /** int64  */
+    partition_id?: string;
+
+    /** Is partition open for write. */
+    active?: boolean;
+
+    /**
+     * int64
+     *
+     * Ids of partitions which was formed when this partition was split or merged.
+     */
+    child_partition_ids?: string[];
+
+    /**
+     * int64
+     *
+     * Ids of partitions from which this partition was formed by split or merge.
+     */
+    parent_partition_ids?: string[];
+
+    /** Stats for partition, filled only when include_stats in request is true. */
+    partition_stats?: PartitionStats;
+
+    /** Stats for consumer of this partition, filled only when include_stats in request is true. */
+    partition_consumer_stats?: PartitionConsumerStats;
+}
+
+interface PartitionConsumerStats {
+    /**
+     * int64
+     *
+     * Last read offset from this partition.
+     */
+    last_read_offset?: string;
+
+    /**
+     * int64
+     *
+     * Committed offset for this partition.
+     */
+    committed_offset?: string;
+
+    /** Reading this partition read session identifier. */
+    read_session_id?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of providing this partition to this session by server.
+     */
+    partition_read_session_create_time?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last read from this partition. */
+    last_read_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** How much bytes were read during several windows statistics from this partiton. */
+    bytes_read?: MultipleWindowsStat;
+
+    /** Read session name, provided by client. */
+    reader_name?: string;
+
+    /** Host where read session connected. */
+    connection_node_id?: number;
+}
+
+export interface PartitionStats {
+    /** Partition contains messages with offsets in range [start, end). */
+    partition_offsets?: OffsetsRange;
+
+    /**
+     * int64
+     *
+     * Approximate size of partition.
+     */
+    store_size_bytes?: string;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Timestamp of last write.
+     */
+    last_write_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** How much bytes were written during several windows in this partition. */
+    bytes_written?: MultipleWindowsStat;
+
+    /** Host where tablet for this partition works. Useful for debugging purposes. */
+    partition_node_id?: number;
+}
+
+interface OffsetsRange {
+    /** int64  */
+    start?: string;
+    /** int64  */
+    end?: string;
+}
+
+export interface Consumer {
+    /** Must have valid not empty name as a key. */
+    name?: string;
+
+    /** Consumer may be marked as 'important'. It means messages for this consumer will never expire due to retention. */
+    important?: boolean;
+
+    /**
+     * google.protobuf.Timestamp
+     *
+     * All messages with smaller server written_at timestamp will be skipped.
+     */
+    read_from?: string;
+
+    /**
+     * List of supported codecs by this consumer.
+     *
+     * supported_codecs on topic must be contained inside this list.
+     */
+    supported_codecs?: SupportedCodecs;
+
+    /** Attributes of consumer */
+    attributes?: Record<string, string>;
+
+    /** Filled only when requested statistics in Describe*Request. */
+    consumer_stats?: ConsumerStats;
+}
+
+interface ConsumerStats {
+    /**
+     * google.protobuf.Timestamp
+     *
+     * Minimal timestamp of last read from partitions.
+     */
+    min_partitions_last_read_time?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
+     */
+    max_read_time_lag?: string;
+
+    /**
+     * google.protobuf.Duration
+     *
+     * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
+     */
+    max_write_time_lag?: string;
+
+    /** Bytes read stastics. */
+    bytes_read?: MultipleWindowsStat;
+}
+
+export interface MultipleWindowsStat {
+    /** int64  */
+    per_minute?: string;
+    /** int64  */
+    per_hour?: string;
+    /** int64  */
+    per_day?: string;
+}
+
+export interface SupportedCodecs {
+    /** List of supported codecs. */
+    codecs?: number[];
+}
+
+export interface Entry {
+    /** For consumer will be topic-name/consumer-name */
+    name?: string;
+
+    owner?: string;
+    type?: Type;
+    effective_permissions?: Permissions[];
+    permissions?: Permissions[];
+
+    /**
+     * uint64
+     *
+     * Size of entry in bytes. Currently filled for:
+     * - TABLE;
+     * - DATABASE.
+     *
+     * Empty (zero) in other cases.
+     */
+    size_bytes?: string;
+
+    /** Virtual timestamp when the object was created */
+    created_at?: VirtualTimestamp;
+}
+
+interface Permissions {
+    subject?: string;
+    permission_names?: string[];
+}
+
+interface VirtualTimestamp {
+    /** uint64 */
+    plan_step?: string;
+    /** uint64 */
+    tx_id?: string;
+}
+
+enum Type {
+    TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED',
+    DIRECTORY = 'DIRECTORY',
+    TABLE = 'TABLE',
+    PERS_QUEUE_GROUP = 'PERS_QUEUE_GROUP',
+    DATABASE = 'DATABASE',
+    RTMR_VOLUME = 'RTMR_VOLUME',
+    BLOCK_STORE_VOLUME = 'BLOCK_STORE_VOLUME',
+    COORDINATION_NODE = 'COORDINATION_NODE',
+    COLUMN_STORE = 'COLUMN_STORE ',
+    COLUMN_TABLE = 'COLUMN_TABLE ',
+    SEQUENCE = 'SEQUENCE ',
+    REPLICATION = 'REPLICATION ',
+    TOPIC = 'TOPIC ',
+}

package/dist/types/api/enums.ts

@@ -1,6 +1,6 @@
 // Shows system status
-// Currently is used in response types of viewer/json/nodes and viewer/json/storage
-// Probably will appear in /viewer/json/tenantinfo /viewer/json/cluster /viewer/json/tabletinfo /viewer/json/compute
+// Currently is used in response types viewer/json/ storage, nodes, compute
+// pdiskinfo, vdiskinfo, tabletinfo, tenantinfo
 export enum EFlag {
     Grey = 'Grey',
     Green = 'Green',

package/dist/types/api/nodes.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 import {TTabletStateInfo} from './tablet';
 
+// 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[];
@@ -64,12 +67,12 @@ export interface TPoolStats {
     Threads?: number;
 }
 
-interface TEndpoint {
+export interface TEndpoint {
     Name?: string;
     Address?: string;
 }
 
-interface TLegacyNodeLocation {
+export interface TLegacyNodeLocation {
     DataCenter?: number;
     Room?: number;
     Rack?: number;

package/dist/types/api/pdisk.ts

@@ -1,5 +1,8 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/pdiskinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+
 export interface TPDiskStateInfo {
     PDiskId?: number;
     /** uint64 */

package/dist/types/api/schema.ts

@@ -37,6 +37,7 @@ enum EStatus {
     StatusResourceExhausted = 'StatusResourceExhausted',
 }
 
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/flat_scheme_op.proto
 // incomplete interface, only currently used fields are covered
 export interface TPathDescription {
     /** info about the path itself */

package/dist/types/api/storage.ts

@@ -1,6 +1,37 @@
 import {EFlag} from './enums';
 import {TVDiskStateInfo} from './vdisk';
 
+// endpoint: /viewer/json/storage
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
+export interface TStorageInfo {
+    Overall?: EFlag;
+    StoragePools?: TStoragePoolInfo[];
+    /** uint64 */
+    TotalGroups?: string;
+    /** uint64 */
+    FoundGroups?: string;
+}
+
+interface TStoragePoolInfo {
+    Overall?: EFlag;
+    Name?: string;
+    Kind?: string;
+    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
+    /** uint64 */
+    AcquiredUnits?: string;
+    AcquiredIOPS?: number;
+    /** uint64 */
+    AcquiredThroughput?: string;
+    /** uint64 */
+    AcquiredSize?: string;
+    MaximumIOPS?: number;
+    /** uint64 */
+    MaximumThroughput?: string;
+    /** uint64 */
+    MaximumSize?: string;
+}
+
 export interface TBSGroupStateInfo {
     GroupID?: number;
     ErasureSpecies?: string;
@@ -43,31 +74,3 @@ interface THiveStorageGroupStats {
     /** uint64 */
     AvailableSize?: string;
 }
-
-interface TStoragePoolInfo {
-    Overall?: EFlag;
-    Name?: string;
-    Kind?: string;
-    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
-    /** uint64 */
-    AcquiredUnits?: string;
-    AcquiredIOPS?: number;
-    /** uint64 */
-    AcquiredThroughput?: string;
-    /** uint64 */
-    AcquiredSize?: string;
-    MaximumIOPS?: number;
-    /** uint64 */
-    MaximumThroughput?: string;
-    /** uint64 */
-    MaximumSize?: string;
-}
-
-export interface TStorageInfo {
-    Overall?: EFlag;
-    StoragePools?: TStoragePoolInfo[];
-    /** uint64 */
-    TotalGroups?: string;
-    /** uint64 */
-    FoundGroups?: string;
-}

package/dist/types/api/tablet.ts

@@ -1,5 +1,21 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/tabletinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/sys_view.proto
+
+export interface TEvTabletStateResponse {
+    TabletStateInfo?: TTabletStateInfo[];
+
+    /** uint64 */
+    ResponseTime?: string;
+    /** uint64 */
+    ResponseDuration?: string;
+    /** uint64 */
+    ProcessDuration?: string;
+
+    Packed5?: unknown;
+}
+
 export interface TTabletStateInfo {
     /** uint64 */
     TabletId?: string;
@@ -37,7 +53,7 @@ interface TDomainKey {
     PathId?: string;
 }
 
-enum EType {
+export enum EType {
     'Unknown' = 'Unknown',
     'OldSchemeShard' = 'OldSchemeShard',
     'OldDataShard' = 'OldDataShard',
@@ -79,7 +95,7 @@ enum EType {
     'TypeInvalid' = 'TypeInvalid',
 }
 
-enum ETabletState {
+export enum ETabletState {
     'Created' = 'Created',
     'ResolveStateStorage' = 'ResolveStateStorage',
     'Candidate' = 'Candidate',

package/dist/types/api/tenant.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPoolStats, TSystemStateInfo} from './nodes';
 import {TTabletStateInfo} from './tablet';
 
+// endpoint: /viewer/json/tenantinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
 export interface TTenants {
     Tenants?: TTenant[];
 }
@@ -51,7 +54,7 @@ interface THiveDomainStatsStateCount {
     Count?: number;
 }
 
-interface TMetrics {
+export interface TMetrics {
     /** uint64 */
     CPU?: string;
     /** uint64 */