feat(Tenant): pq groups info & overview

Author: ariser

src/components/InfoViewer/formatters/schema.ts

@@ -1,7 +1,10 @@
 import type {
     TCdcStreamDescription,
     TIndexDescription,
+    TPersQueueGroupDescription,
 } from '../../../types/api/schema';
+import {formatNumber} from '../../../utils';
+import {HOUR_IN_SECONDS} from '../../../utils/constants';
 
 import {createInfoFormatter} from '../utils';
 
@@ -24,3 +27,17 @@ export const formatCdcStreamItem = createInfoFormatter<TCdcStreamDescription>({
         Format: (value) => value?.substring('ECdcStreamFormat'.length),
     },
 });
+
+export const formatPQGroupItem = createInfoFormatter<TPersQueueGroupDescription>({
+    values: {
+        Partitions: (value) => formatNumber(value?.length || 0),
+        PQTabletConfig: (value) => {
+            const hours = Math.round(value.PartitionConfig.LifetimeSeconds / HOUR_IN_SECONDS * 100) / 100;
+            return `${formatNumber(hours)} hours`;
+        },
+    },
+    labels: {
+        Partitions: 'Partitions count',
+        PQTabletConfig: 'Retention',
+    },
+});

src/components/InfoViewer/schemaInfo/PersQueueGroupInfo.tsx

@@ -0,0 +1,34 @@
+import type {TEvDescribeSchemeResult} from '../../../types/api/schema';
+
+import {formatCommonItem, formatPQGroupItem} from '../formatters';
+import {InfoViewer, InfoViewerItem} from '..';
+
+interface PersQueueGrouopInfoProps {
+    data?: TEvDescribeSchemeResult;
+}
+
+export const PersQueueGroupInfo = ({data}: PersQueueGrouopInfoProps) => {
+    if (!data) {
+        return (
+            <div className="error">No PersQueueGroup data</div>
+        );
+    }
+
+    const pqGroup = data.PathDescription?.PersQueueGroup;
+    const info: Array<InfoViewerItem> = [];
+
+    info.push(formatCommonItem('PathType', data.PathDescription?.Self?.PathType));
+
+    info.push(formatPQGroupItem('Partitions', pqGroup?.Partitions || []));
+    info.push(formatPQGroupItem('PQTabletConfig', pqGroup?.PQTabletConfig || {PartitionConfig: {LifetimeSeconds: 0}}));
+
+    return (
+        <>
+            {info.length ? (
+                <InfoViewer info={info}></InfoViewer>
+            ) : (
+                <>Empty</>
+            )}
+        </>
+    );
+};

src/components/InfoViewer/schemaInfo/index.ts

@@ -1,2 +1,3 @@
 export * from './CDCStreamInfo';
 export * from './TableIndexInfo';
+export * from './PersQueueGroupInfo';

src/components/InfoViewer/schemaOverview/PersQueueGroupOverview.tsx

@@ -0,0 +1,35 @@
+import type {TEvDescribeSchemeResult} from '../../../types/api/schema';
+
+import {formatCommonItem, formatPQGroupItem} from '../formatters';
+import {InfoViewer, InfoViewerItem} from '..';
+
+interface PersQueueGroupOverviewProps {
+    data?: TEvDescribeSchemeResult;
+}
+
+export const PersQueueGroupOverview = ({data}: PersQueueGroupOverviewProps) => {
+    if (!data) {
+        return (
+            <div className="error">No PersQueueGroup data</div>
+        );
+    }
+
+    const pqGroup = data.PathDescription?.PersQueueGroup;
+    const info: Array<InfoViewerItem> = [];
+
+    info.push(formatCommonItem('PathType', data.PathDescription?.Self?.PathType));
+    info.push(formatCommonItem('CreateStep', data.PathDescription?.Self?.CreateStep));
+
+    info.push(formatPQGroupItem('Partitions', pqGroup?.Partitions || []));
+    info.push(formatPQGroupItem('PQTabletConfig', pqGroup?.PQTabletConfig || {PartitionConfig: {LifetimeSeconds: 0}}));
+
+    return (
+        <>
+            {info.length ? (
+                <InfoViewer info={info}></InfoViewer>
+            ) : (
+                <>Empty</>
+            )}
+        </>
+    );
+};

src/components/InfoViewer/schemaOverview/index.ts

@@ -1 +1,2 @@
 export * from './CDCStreamOverview';
+export * from './PersQueueGroupOverview';

src/containers/Tenant/Diagnostics/DiagnosticsPages.ts

@@ -99,6 +99,7 @@ const pathTypeToPages: Record<EPathType, Page[] | undefined> = {
     [EPathType.EPathTypeTableIndex]: DIR_PAGES,
 
     [EPathType.EPathTypeCdcStream]: TOPIC_PAGES,
+    [EPathType.EPathTypePersQueueGroup]: TOPIC_PAGES,
 };
 
 export const getPagesByType = (type?: EPathType) =>

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

@@ -9,6 +9,7 @@ import SchemaInfoViewer from '../../Schema/SchemaInfoViewer/SchemaInfoViewer';
 import {
     CDCStreamInfo,
     TableIndexInfo,
+    PersQueueGroupInfo,
 } from '../../../../components/InfoViewer/schemaInfo';
 
 import {EPathType} from '../../../../types/api/schema';
@@ -129,6 +130,7 @@ function Overview(props: OverviewProps) {
             [EPathType.EPathTypeColumnStore]: undefined,
             [EPathType.EPathTypeColumnTable]: undefined,
             [EPathType.EPathTypeCdcStream]: () => <CDCStreamInfo data={schemaData} />,
+            [EPathType.EPathTypePersQueueGroup]: () => <PersQueueGroupInfo data={schemaData} />,
         };
 
         return (props.type && pathTypeToComponent[props.type]?.()) || (

src/containers/Tenant/ObjectSummary/ObjectSummary.tsx

@@ -14,7 +14,10 @@ import Acl from '../Acl/Acl';
 import SchemaViewer from '../Schema/SchemaViewer/SchemaViewer';
 import CopyToClipboard from '../../../components/CopyToClipboard/CopyToClipboard';
 import InfoViewer from '../../../components/InfoViewer/InfoViewer';
-import {CDCStreamOverview} from '../../../components/InfoViewer/schemaOverview';
+import {
+    CDCStreamOverview,
+    PersQueueGroupOverview,
+} from '../../../components/InfoViewer/schemaOverview';
 import Icon from '../../../components/Icon/Icon';
 
 import {EPathSubType, EPathType, TDirEntry} from '../../../types/api/schema';
@@ -164,6 +167,7 @@ function ObjectSummary(props: ObjectSummaryProps) {
             [EPathType.EPathTypeColumnStore]: undefined,
             [EPathType.EPathTypeColumnTable]: undefined,
             [EPathType.EPathTypeCdcStream]: () => <CDCStreamOverview data={data[currentSchemaPath]} />,
+            [EPathType.EPathTypePersQueueGroup]: () => <PersQueueGroupOverview data={data[currentSchemaPath]} />,
         };
 
         let component = currentSchemaData?.PathType && pathTypeToComponent[currentSchemaData.PathType]?.();

src/containers/Tenant/utils/schema.ts

@@ -29,6 +29,7 @@ const pathTypeToNodeType: Record<EPathType, NavigationTreeNodeType | undefined>
     [EPathType.EPathTypeColumnTable]: 'column_table',
 
     [EPathType.EPathTypeCdcStream]: 'topic',
+    [EPathType.EPathTypePersQueueGroup]: 'topic',
 };
 
 export const mapPathTypeToNavigationTreeType = (
@@ -51,6 +52,7 @@ const pathTypeToIsTable: Record<EPathType, boolean> = {
     [EPathType.EPathTypeExtSubDomain]: false,
     [EPathType.EPathTypeColumnStore]: false,
     [EPathType.EPathTypeCdcStream]: false,
+    [EPathType.EPathTypePersQueueGroup]: false,
 };
 
 export const isTableType = (pathType?: EPathType) =>
@@ -82,6 +84,7 @@ const pathTypeToIsColumn: Record<EPathType, boolean> = {
     [EPathType.EPathTypeTableIndex]: false,
     [EPathType.EPathTypeExtSubDomain]: false,
     [EPathType.EPathTypeCdcStream]: false,
+    [EPathType.EPathTypePersQueueGroup]: false,
 };
 
 export const isColumnEntityType = (type?: EPathType) =>

src/types/api/schema.ts

@@ -58,6 +58,7 @@ interface TPathDescription {
     TableIndex?: TIndexDescription;
 
     CdcStreamDescription?: TCdcStreamDescription;
+    PersQueueGroup?: TPersQueueGroupDescription;
 }
 
 export interface TDirEntry {
@@ -253,7 +254,7 @@ export enum EPathType {
     EPathTypeInvalid = 'EPathTypeInvalid',
     EPathTypeDir = 'EPathTypeDir',
     EPathTypeTable = 'EPathTypeTable',
-
+    EPathTypePersQueueGroup = 'EPathTypePersQueueGroup',
     EPathTypeSubDomain = 'EPathTypeSubDomain',
 
     EPathTypeTableIndex = 'EPathTypeTableIndex',
@@ -304,3 +305,195 @@ interface TPathVersion {
     /** uint64 */
     GeneralVersion?: string;
 }
+
+interface TPartitionKeyRange {
+    // Inclusive left border. Emptiness means -inf.
+    FromBound?: string;
+    // Exclusive right border. Emptiness means +inf.
+    ToBound?: string;
+}
+
+interface TPartition {
+    PartitionId?: number;
+    /** uint64 */
+    TabletId?: string;
+    KeyRange?: TPartitionKeyRange;
+}
+
+interface TPartitionToAdd {
+    PartitionId?: number;
+    GroupId?: number;
+}
+
+interface TCodecs {
+    /** int64 */
+    Ids?: string[];
+    Codecs?: string[];
+}
+
+interface TKeyComponentSchema {
+    Name?: string;
+    TypeId?: number;
+}
+
+enum EMeteringMode {
+    METERING_MODE_RESERVED_CAPACITY = 'METERING_MODE_RESERVED_CAPACITY',
+    METERING_MODE_REQUEST_UNITS = 'METERING_MODE_REQUEST_UNITS',
+}
+
+interface TReadQuota {
+    ClientId?: string;
+    /** uint64 */
+    SpeedInBytesPerSecond?: string;
+    /** uint64 */
+    BurstSize?: string;
+}
+
+interface TChannelProfile {
+    PoolKind?: string;
+    /** uint64 */
+    Size?: string;
+    ReadIops?: number;
+    ReadBandwidth?: number;
+    WriteIops?: number;
+    WriteBandwidth?: number;
+}
+
+interface IamCredentials {
+    Endpoint?: string;
+    ServiceAccountKey?: string;
+}
+
+interface TCredentials {
+    OauthToken?: string;
+    JwtParams?: string;
+    Iam?: IamCredentials;
+}
+
+interface TMirrorPartitionConfig {
+    Endpoint?: string;
+    EndpointPort?: number;
+    Topic?: string;
+    Consumer?: string;
+    /** uint64 */
+    ReadFromTimestampsMs?: string;
+    Credentials?: TCredentials;
+    Database?: string;
+    UseSecureConnection?: boolean;
+    SyncWriteTime?: boolean;
+}
+
+interface TPQPartitionConfig {
+    MaxCountInPartition?: number;
+    /** int64 */
+    MaxSizeInPartition?: string;
+    LifetimeSeconds: number;
+    /** uint64 */
+    StorageLimitBytes?: string;
+
+    ImportantClientId?: string[];
+    LowWatermark?: number;
+    SourceIdLifetimeSeconds?: number;
+    SourceIdMaxCounts?: number;
+
+    /** uint64 */
+    WriteSpeedInBytesPerSecond?: string;
+    /** uint64 */
+    BurstSize?: string;
+
+    ReadQuota?: TReadQuota[];
+    /** uint64 */
+    MaxWriteInflightSize?: string;
+    /** uint64 */
+    BorderWriteInflightSize?: string;
+
+    NumChannels?: number;
+
+    TotalPartitions?: number;
+
+    ExplicitChannelProfiles?: TChannelProfile[];
+
+    MirrorFrom?: TMirrorPartitionConfig;
+};
+
+interface TPQTabletConfig {
+    /** uint64 */
+    CacheSize?: string;
+    PartitionConfig: TPQPartitionConfig;
+    /** @deprecated use Partitions */
+    PartitionIds?: number[];
+    TopicName?: string;
+    Version?: number;
+    LocalDC?: boolean;
+    RequireAuthWrite?: boolean;
+    RequireAuthRead?: boolean;
+    Producer?: string;
+    Ident?: string;
+    Topic?: string;
+    DC?: string;
+
+    ReadRules?: string[];
+    /** uint64[] */
+    ReadFromTimestampsMs?: number[];
+    /** uint64[] */
+    ConsumerFormatVersions?: number[];
+    
+    ConsumerCodecs?: TCodecs[];
+    ReadRuleServiceTypes?: string;
+
+    /** uint64 */
+    FormatVersion?: string;
+    Codecs?: TCodecs;
+
+    /** uint64[] */
+    ReadRuleVersions?: string[];
+    /** uint64[] */
+    ReadRuleGenerations?: string[];
+
+    TopicPath?: string;
+
+    YcCloudId?: string;
+    YcFolderId?: string;
+    YdbDatabaseId?: string;
+    YdbDatabasePath?: string;
+    FederationAccount?: string;
+
+    PartitionKeySchema?: TKeyComponentSchema[];
+
+    Partitions?: TPartition[];
+    
+    MeteringMode?: EMeteringMode;
+}
+
+interface TMessageGroup {
+    // Id of message group (SourceId)
+    Id?: string;
+    // Range of the key to which it is allowed to write.
+    KeyRange?: TPartitionKeyRange;
+}
+
+interface TBootstrapConfig {
+    ExplicitMessageGroups?: TMessageGroup[];
+}
+
+export interface TPersQueueGroupDescription {
+    Name: string;
+    /** uint64 */
+    PathId?: string;
+    TotalGroupCount: number;
+    
+    PartitionsToAdd?: TPartitionToAdd[];
+    PartitionsToDelete?: number[];
+    NextPartitionId?: number;
+    PartitionPerTablet?: number;
+    PQTabletConfig: TPQTabletConfig;
+    Partitions?: TPartition[];
+    /** uint64 */
+    AlterVersion?: string;
+    /** uint64 */
+    BalancerTabletID?: string;
+
+    PartitionBoundaries?: any;
+
+    BootstrapConfig?: TBootstrapConfig;
+}