/** * Storage Tab — per-PV capacity usage view. * * Mirrors the GPU Instances Tab structure: * 1. Top filter bar (date range + scope) * 2. KPI row (GB-Days / GB-Hours / Active Volumes / Dangling Volumes) * 3. Daily bar chart with metric switch * 4. Bottom tab table grouped by Volume / User * * Talks to ``/usage/storage/{meta,breakdown}``. PV is lifecycle-gated * (capacity is metered from CREATED to DELETED regardless of attach state), * so there's no phase filter — just date / scope / volume / user. */ import useCoolColors from '@/hooks/use-cool-colors'; import { getGPUStackPlugin } from '@/plugins'; import { formatLargeNumber } from '@/utils'; import { SimpleCard } from '@gpustack/core-ui'; import { useAccess, useIntl } from '@umijs/max'; import { useMemoizedFn } from 'ahooks'; import { Tabs } from 'antd'; import dayjs from 'dayjs'; import React, { useEffect, useMemo, useState } from 'react'; import { queryStorageBreakdown, ResourceBreakdownRequest } from '../apis/resource'; import MetricChartCard from '../components/metric-chart-card'; import MetricLabel from '../components/metric-label'; import ResourceExportData from '../components/resource-export-data'; import ResourceFilterBar from '../components/resource-filter-bar'; import useResourceMeta from '../hooks/use-resource-meta'; import { exportBreakdownSheets, markDeletedNames, toExportColumns } from '../utils/export-breakdown'; import { bucketKey, generateBucketRange, Granularity } from '../utils/time-buckets'; import { buildTrendSeries } from '../utils/trend-series'; import useQueryStorageBreakdown from './services/use-query-storage-breakdown'; import StorageBreakdownTable from './tables/storage-breakdown-table'; import useStorageColumns from './tables/use-storage-columns'; type Scope = 'self' | 'all'; type Metric = 'storage_gb_days' | 'storage_gb_hours'; type GroupKey = 'volume' | 'user'; // Enterprise-provided extra bottom sub-tab (e.g. the Organization breakdown). // Registered on the enterprise plugin under ``usage.resourceBreakdownExtraTabs``; // empty when no plugin is loaded, so the OSS build renders nothing extra. interface ResourceBreakdownExtraTab { key: string; labelId: string; useVisible?: () => boolean; Component: React.ComponentType<{ tab: 'gpu-instances' | 'storage'; dateRange: [dayjs.Dayjs, dayjs.Dayjs]; scope: Scope; filters: { creator_ids?: number[]; instance_ids?: number[]; volume_ids?: number[]; organization_ids?: number[]; user_group_ids?: number[]; }; pageResetKey?: number; refreshKey?: number; }>; } const StorageTab: React.FC = () => { const access = useAccess(); const intl = useIntl(); // Factory kept for the grouped trend (sized to group count); 4-slot palette // for the KPI cards. const colorFactory = useCoolColors(); const coolColors = colorFactory(4); const METRIC_OPTIONS: { value: Metric; label: string }[] = useMemo( () => [ { value: 'storage_gb_days', label: intl.formatMessage({ id: 'usage.metric.gbDays' }) }, { value: 'storage_gb_hours', label: intl.formatMessage({ id: 'usage.metric.gbHours' }) } ], [intl] ); const TABLE_TABS: { key: GroupKey; label: string }[] = useMemo(() => { const tabs = [ { key: 'volume' as GroupKey, label: intl.formatMessage({ id: 'usage.tabs.storage' }) } ]; if (access.canSeeOrgAdmin) { tabs.push({ key: 'user' as GroupKey, label: intl.formatMessage({ id: 'usage.table.users' }) }); } return tabs; }, [intl, access.canSeeOrgAdmin]); // No All/My dropdown (matches the Tokens tab): managers see the org-wide // view and narrow it with the user filter, others only their own rows. const canManageUsers = !!access.canSeeOrgAdmin; const scope: Scope = canManageUsers ? 'all' : 'self'; const [dateRange, setDateRange] = useState<[dayjs.Dayjs, dayjs.Dayjs]>([ dayjs().subtract(29, 'day'), dayjs() ]); const [selectedUsers, setSelectedUsers] = useState([]); const [selectedVolumes, setSelectedVolumes] = useState([]); // Platform-wide "All" view only (enterprise-gated); empty otherwise. const [selectedOrganizations, setSelectedOrganizations] = useState( [] ); const [selectedUserGroups, setSelectedUserGroups] = useState([]); const [refreshKey, setRefreshKey] = useState(0); const [metric, setMetric] = useState('storage_gb_days'); const [granularity, setGranularity] = useState('day'); // Optional trend group-by (split the chart into one series per group). const [chartGroupBy, setChartGroupBy] = useState(null); // Widened to ``string``: enterprise extra tabs use arbitrary keys. const [activeTableTab, setActiveTableTab] = useState('volume'); const { creators: userOptions, volumes: volumeOptions, organizations, user_groups: userGroups } = useResourceMeta(scope); // Enterprise-provided extra bottom sub-tabs (empty in the OSS build). Call // each descriptor's ``useVisible`` in a stable order — the descriptor list is // registered once at plugin init, so its length never changes (rules of // hooks). const extraBreakdownTabs: ResourceBreakdownExtraTab[] = getGPUStackPlugin()?.usage?.resourceBreakdownExtraTabs ?? []; const extraTabVisible = extraBreakdownTabs.map( (t) => t.useVisible?.() ?? true ); // Bumped on any filter change to snap every mounted table back to page 1; // each table owns its own page/sort state otherwise. const [pageResetKey, setPageResetKey] = useState(0); const { detailData: chartData, loading: chartLoading, fetchData: fetchChartData } = useQueryStorageBreakdown({ key: 'storageBreakdownChart' }); const baseRequest = (): Omit => ({ start_date: dateRange[0].format('YYYY-MM-DD'), end_date: dateRange[1].format('YYYY-MM-DD'), scope, granularity, filters: selectedUsers.length || selectedVolumes.length || selectedOrganizations.length || selectedUserGroups.length ? { ...(selectedUsers.length ? { creator_ids: selectedUsers } : {}), ...(selectedVolumes.length ? { volume_ids: selectedVolumes } : {}), ...(selectedOrganizations.length ? { organization_ids: selectedOrganizations } : {}), ...(selectedUserGroups.length ? { user_group_ids: selectedUserGroups } : {}) } : undefined, page: 1, perPage: 50 }); const fetchChart = useMemoizedFn(() => fetchChartData({ ...baseRequest(), // Split each bucket by the chosen dimension when grouping. group_by: chartGroupBy ? ['date', chartGroupBy] : ['date'], // A trend is a time series, not a paginated table: always fetch the // whole range. The default order is metric-desc, so partial (current/ // recent) buckets have smaller values and would be pushed onto later // pages — dropping the newest hours from the chart under a small page. // ``page: -1`` is the backend's no-pagination sentinel. page: -1 }) ); useEffect(() => { fetchChart(); }, [ dateRange, selectedUsers, selectedVolumes, selectedOrganizations, selectedUserGroups, granularity, chartGroupBy, refreshKey ]); const summary = chartData?.summary; const summaryCards = useMemo( () => [ { label: formatLargeNumber( Math.round((summary?.storage_gb_days ?? 0) * 10) / 10 ) as string, value: ( ), color: coolColors[0] }, { label: formatLargeNumber( Math.round((summary?.storage_gb_hours ?? 0) * 10) / 10 ) as string, value: ( ), color: coolColors[1] }, { label: (summary?.active_volumes ?? 0).toString(), value: intl.formatMessage({ id: 'usage.tabs.storage' }), color: coolColors[2] }, { label: (summary?.active_users ?? 0).toString(), value: intl.formatMessage({ id: 'usage.metric.activeUsers' }), color: coolColors[3] } ], [summary, coolColors, intl] ); const xAxis = useMemo(() => { const keys = new Set( generateBucketRange( dateRange[0].format('YYYY-MM-DD'), dateRange[1].format('YYYY-MM-DD'), granularity ) ); chartData?.items?.forEach((i) => { if (i.date) keys.add(bucketKey(i.date, granularity)); }); return Array.from(keys).sort(); }, [chartData, dateRange, granularity]); const seriesData = useMemo( () => buildTrendSeries({ items: chartData?.items, metric, granularity, xAxis, groupBy: chartGroupBy, palette: colorFactory, singleName: METRIC_OPTIONS.find((m) => m.value === metric)?.label || metric }), [ chartData, metric, granularity, xAxis, chartGroupBy, colorFactory, METRIC_OPTIONS ] ); const chartGroupByOptions = useMemo( () => TABLE_TABS.map((t) => ({ value: t.key, label: t.label })), [TABLE_TABS, scope] ); // Columns for each bottom-table grouping — same factory the tables render // with — used to build the export sheets below. const volumeColumns = useStorageColumns('volume'); const userColumns = useStorageColumns('user'); // "Export Table Data" writes every bottom table at once — one sheet per // grouping (Storage / Users) — straight to a workbook, no preview dialog // (mirrors the Tokens tab's `useExportTable`). The User sheet is included // only when the org-wide view is available. const tableExportGroups = useMemo(() => { const groups = [ { key: 'volume' as GroupKey, columns: volumeColumns, sheetName: intl.formatMessage({ id: 'usage.tabs.storage' }) } ]; if (canManageUsers) { groups.push({ key: 'user' as GroupKey, columns: userColumns, sheetName: intl.formatMessage({ id: 'usage.table.users' }) }); } return groups; }, [volumeColumns, userColumns, canManageUsers, intl]); // Chart export still opens the preview modal (matches the Tokens tab); the // table export is direct, so this only ever holds 'chart'. const [exportMode, setExportMode] = useState<'chart' | null>(null); const dateSuffix = `${dateRange[0].format('YYYY-MM-DD')}_${dateRange[1].format( 'YYYY-MM-DD' )}`; const handleExportTable = async () => { const results = await Promise.all( tableExportGroups.map((g) => queryStorageBreakdown({ ...baseRequest(), group_by: [g.key], // A breakdown export is the full filtered set, not a page. // ``page: -1`` is the backend's no-pagination sentinel. page: -1 }) ) ); const deletedWord = intl.formatMessage({ id: 'usage.table.deleted' }); exportBreakdownSheets( tableExportGroups.map((g, i) => ({ rows: markDeletedNames(results[i]?.items ?? [], g.key, deletedWord), columns: toExportColumns(g.columns), sheetName: g.sheetName })), `storage_tables_${dateSuffix}.xlsx` ); }; const chartExportColumns = [ { title: intl.formatMessage({ id: 'usage.table.date' }), dataIndex: 'date', key: 'date' }, { title: intl.formatMessage({ id: 'usage.tabs.storage' }), dataIndex: 'volume_name', key: 'volume_name' }, // Owner User column — org admins only (members see just their own rows). ...(canManageUsers ? [ { title: intl.formatMessage({ id: 'usage.table.users' }), dataIndex: 'user_name', key: 'user_name' } ] : []), { title: intl.formatMessage({ id: 'usage.metric.gbDays' }), dataIndex: 'storage_gb_days', key: 'storage_gb_days', render: (v: number) => (v ?? 0).toFixed(2) }, { title: intl.formatMessage({ id: 'usage.metric.gbHours' }), dataIndex: 'storage_gb_hours', key: 'storage_gb_hours', render: (v: number) => (v ?? 0).toFixed(2) }, { title: intl.formatMessage({ id: 'usage.metric.activeVolumes' }), dataIndex: 'active_volumes', key: 'active_volumes' }, { title: intl.formatMessage({ id: 'usage.metric.activeUsers' }), dataIndex: 'active_users', key: 'active_users' } ]; // The preview modal now only backs the by-date chart export. const exportConfig = { groupBy: ['date', 'volume'], columns: chartExportColumns, fileName: `storage_chart_${dateSuffix}.xlsx`, sheetName: intl.formatMessage({ id: 'usage.tabs.storage' }) }; return (
{ setDateRange(dates); setPageResetKey((k) => k + 1); }} canManageUsers={canManageUsers} userOptions={userOptions} selectedUsers={selectedUsers} onUsersChange={(ids) => { setSelectedUsers(ids); setPageResetKey((k) => k + 1); }} resourceFilter={{ options: volumeOptions, value: selectedVolumes, onChange: (ids) => { setSelectedVolumes(ids); setPageResetKey((k) => k + 1); }, placeholder: intl.formatMessage({ id: 'usage.filter.storage' }) }} organizationOptions={organizations} userGroupOptions={userGroups} selectedOrganizations={selectedOrganizations} selectedUserGroups={selectedUserGroups} onOrganizationsChange={(ids) => { setSelectedOrganizations(ids); setPageResetKey((k) => k + 1); }} onUserGroupsChange={(ids) => { setSelectedUserGroups(ids); setPageResetKey((k) => k + 1); }} onRefresh={() => setRefreshKey((k) => k + 1)} onExportChart={() => setExportMode('chart')} onExportTable={handleExportTable} />
setMetric(v as Metric)} onGranularityChange={(v) => setGranularity(v as Granularity)} seriesData={seriesData} xAxisData={xAxis} groupBy={chartGroupBy} groupByOptions={chartGroupByOptions} onGroupByChange={(v) => setChartGroupBy(v as GroupKey | null)} loading={chartLoading} />
setActiveTableTab(k)} items={[ ...TABLE_TABS.map((t) => ({ key: t.key, label: t.label, // Keep every pane mounted so each table holds its own page/sort and // switching tabs neither refetches nor resets the other. forceRender: true, children: ( ) })), // Enterprise Organization breakdown sub-tab(s) — appended after the // built-in tabs; nothing here in the OSS build. ...extraBreakdownTabs .filter((_, i) => extraTabVisible[i]) .map((t) => ({ key: t.key, label: intl.formatMessage({ id: t.labelId }), forceRender: true, children: ( ) })) ]} /> setExportMode(null)} title={intl.formatMessage({ id: 'usage.export.chart' })} queryFn={queryStorageBreakdown} groupBy={exportConfig.groupBy} columns={exportConfig.columns} fileName={exportConfig.fileName} sheetName={exportConfig.sheetName} scope={scope} canManageUsers={canManageUsers} userOptions={userOptions} resourceFilter={{ options: volumeOptions, placeholder: intl.formatMessage({ id: 'usage.filter.storage' }), key: 'volume_ids' }} initialDateRange={dateRange} initialSelectedUsers={selectedUsers} initialSelectedResources={selectedVolumes} organizationOptions={organizations} userGroupOptions={userGroups} initialSelectedOrganizations={selectedOrganizations} initialSelectedUserGroups={selectedUserGroups} deletedNameFields={[ // The row's ``deleted`` is the grouped volume; the owner user // carries its own ``user_deleted``. { name: 'volume_name', id: 'volume_id', deletedFlag: 'deleted' }, ...(canManageUsers ? [ { name: 'user_name', id: 'user_id', deletedFlag: 'user_deleted' } ] : []) ]} />
); }; export default StorageTab;