Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DW: Use 1-2 decimal places for all GiB and memory values, or 3 places for tooltips #2691

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ export const WorkloadResourceUsageBar: React.FC<WorkloadResourceUsageBarProps> =
content={
<Stack>
<StackItem>
{getColorSwatch('used')} {metricLabel} usage: {used} {unitLabel}
{getColorSwatch('used')} {metricLabel} usage: {roundNumber(used, 3)} {unitLabel}
</StackItem>
<StackItem>
{getColorSwatch('requested')} {metricLabel} requested: {requested} {unitLabel}
{getColorSwatch('requested')} {metricLabel} requested: {roundNumber(requested, 3)}{' '}
{unitLabel}
</StackItem>
</Stack>
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { CardBody, Gallery, GalleryItem } from '@patternfly/react-core';
import { CardBody, Gallery, GalleryItem, capitalize } from '@patternfly/react-core';
import { ChartBullet, ChartLegend } from '@patternfly/react-charts';
import {
chart_color_blue_300 as chartColorBlue300,
Expand All @@ -17,16 +17,16 @@ import EmptyStateErrorMessage from '~/components/EmptyStateErrorMessage';
import { LoadingState } from '~/pages/distributedWorkloads/components/LoadingState';

type RequestedResourcesBulletChartProps = {
title: string;
subTitle: string;
metricLabel: string;
unitLabel: string;
numRequestedByThisProject: number;
numRequestedByAllProjects: number;
numTotalSharedQuota: number;
};

const RequestedResourcesBulletChart: React.FC<RequestedResourcesBulletChartProps> = ({
title,
subTitle,
metricLabel,
unitLabel,
numRequestedByThisProject,
numRequestedByAllProjects,
numTotalSharedQuota,
Expand All @@ -44,14 +44,16 @@ const RequestedResourcesBulletChart: React.FC<RequestedResourcesBulletChartProps
tooltip?: string; // Falls back to `name: preciseValue` if omitted
hideValueInLegend?: boolean;
preciseValue: number;
roundedValue: number;
legendValue: number;
tooltipValue: number;
cappedValue: number;
};
const getDataItem = (
args: Omit<CappedBulletChartDataItem, 'roundedValue' | 'cappedValue'>,
args: Omit<CappedBulletChartDataItem, 'legendValue' | 'tooltipValue' | 'cappedValue'>,
): CappedBulletChartDataItem => ({
...args,
roundedValue: roundNumber(args.preciseValue),
legendValue: roundNumber(args.preciseValue),
tooltipValue: roundNumber(args.preciseValue, 3),
cappedValue: roundNumber(Math.min(args.preciseValue, maxDomain)),
});

Expand Down Expand Up @@ -89,17 +91,15 @@ const RequestedResourcesBulletChart: React.FC<RequestedResourcesBulletChartProps
const allData = [...segmentedMeasureData, ...qualitativeRangeData, ...warningMeasureData];
return (
<ChartBullet
title={title}
subTitle={subTitle}
ariaTitle={`Requested ${title} ${subTitle}`}
title={metricLabel}
subTitle={capitalize(unitLabel)}
ariaTitle={`Requested ${metricLabel} ${unitLabel}`}
ariaDesc="Bullet chart"
name={`requested-resources-chart-${title}`}
name={`requested-resources-chart-${metricLabel}`}
labels={({ datum }) => {
const matchingDataItem = allData.find(({ name }) => name === datum.name);
return (
matchingDataItem?.tooltip ||
`${matchingDataItem?.name}: ${matchingDataItem?.preciseValue}`
);
const { tooltip, name, tooltipValue } = matchingDataItem || {};
return tooltip || `${name}: ${tooltipValue} ${unitLabel}`;
}}
primarySegmentedMeasureData={segmentedMeasureData.map(({ name, cappedValue }) => ({
name,
Expand All @@ -119,8 +119,8 @@ const RequestedResourcesBulletChart: React.FC<RequestedResourcesBulletChartProps
legendOrientation="vertical"
legendComponent={
<ChartLegend
data={allData.map(({ name, hideValueInLegend, roundedValue }) => ({
name: hideValueInLegend ? name : `${name}: ${roundedValue}`,
data={allData.map(({ name, hideValueInLegend, legendValue }) => ({
name: hideValueInLegend ? name : `${name}: ${legendValue}`,
}))}
colorScale={allData.map(({ color }) => color)}
gutter={30}
Expand Down Expand Up @@ -164,17 +164,17 @@ export const RequestedResources: React.FC = () => {
<Gallery minWidths={{ default: '100%', md: '50%' }}>
<GalleryItem data-testid="requested-resources-cpu-chart-container">
<RequestedResourcesBulletChart
title="CPU"
subTitle="Cores"
metricLabel="CPU"
unitLabel="cores"
numRequestedByThisProject={requestedByThisProject.cpuCoresRequested}
numRequestedByAllProjects={requestedByAllProjects.cpuCoresRequested}
numTotalSharedQuota={totalSharedQuota.cpuCoresRequested}
/>
</GalleryItem>
<GalleryItem data-testid="requested-resources-memory-chart-container">
<RequestedResourcesBulletChart
title="Memory"
subTitle="GiB"
metricLabel="Memory"
unitLabel="GiB"
numRequestedByThisProject={bytesAsPreciseGiB(
requestedByThisProject.memoryBytesRequested,
)}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,75 +6,57 @@ import { WorkloadStatusType, getStatusInfo } from '~/concepts/distributedWorkloa
import EmptyStateErrorMessage from '~/components/EmptyStateErrorMessage';
import { LoadingState } from '~/pages/distributedWorkloads/components/LoadingState';
import { NoWorkloadState } from '~/pages/distributedWorkloads/components/NoWorkloadState';

//TODO: next 4 utility functions to be replaced or moved into a utility class
const memoryBytesToGibStr = (bytes: number, excludeUnit = false): string => {
const gib = bytes / 1073741824;
return `${truncateNumberToStr(gib)}${excludeUnit ? '' : 'GiB'}`;
};

const numberToCoreStr = (num: number): string => `${truncateNumberToStr(num)} cores`;

const truncateNumberToStr = (num: number): string => {
if (num > 0.001) {
return String(parseFloat(num.toFixed(3)));
}
if (num === 0) {
return '0';
}
return '< 0.001';
};

const truncateStr = (str: string, length: number): string => {
if (str.length <= length) {
return str;
}
return `${str.substring(0, length)}...`;
};
import { truncateString } from '~/utilities/string';
import { bytesAsPreciseGiB, roundNumber } from '~/utilities/number';
import { WorkloadWithUsage } from '~/api';
import { WorkloadKind } from '~/k8sTypes';

interface TopResourceConsumingWorkloadsChartProps {
label: string;
title: string;
subTitle?: string;
data: Array<{ name: string; usage: number }>;
dataStrConverter: (num: number) => string;
metricLabel: string;
unitLabel: string;
data: { totalUsage: number; topWorkloads: WorkloadWithUsage[] };
convertUnits?: (num?: number) => number;
}

const getWorkloadName = (workload: WorkloadKind | 'other') =>
workload === 'other' ? 'Other' : workload.metadata?.name || 'Unnamed';

const TopResourceConsumingWorkloadsChart: React.FC<TopResourceConsumingWorkloadsChartProps> = ({
label,
title,
subTitle = '',
data = [],
dataStrConverter,
metricLabel,
unitLabel,
data,
convertUnits = (num) => num || 0,
}) => (
<ChartDonut
ariaTitle={`${label} chart`}
ariaTitle={`${metricLabel} chart`}
constrainToVisibleArea
data={data.map((d: { name: string; usage: number }) => ({ x: d.name, y: d.usage }))}
data={data.topWorkloads.map(({ workload, usage }) => ({
x: getWorkloadName(workload),
y: roundNumber(convertUnits(usage), 3),
}))}
height={150}
labels={({ datum }) => `${datum.x}: ${dataStrConverter(0 + datum.y)}`}
labels={({ datum }) => `${datum.x}: ${datum.y} ${unitLabel}`}
legendComponent={
<ChartLegend
data={data.map((d: { name: string; usage: number }) => ({
...d,
name: truncateStr(d.name, 16),
data={data.topWorkloads.map(({ workload }) => ({
name: truncateString(getWorkloadName(workload), 16),
}))}
gutter={5}
labelComponent={<ChartLabel style={{ fontSize: 10 }} />}
itemsPerRow={Math.ceil(data.length / 2)}
itemsPerRow={Math.ceil(data.topWorkloads.length / 2)}
/>
}
legendOrientation="vertical"
legendPosition="right"
name={`topResourceConsuming${label}`}
name={`topResourceConsuming${metricLabel}`}
padding={{
bottom: 0,
left: 0,
right: 260, // Adjusted to accommodate legend
top: 0,
}}
subTitle={subTitle}
title={title}
subTitle={unitLabel}
title={String(roundNumber(convertUnits(data.totalUsage)))}
themeColor={ChartThemeColor.multi}
width={375}
/>
Expand Down Expand Up @@ -125,15 +107,9 @@ export const TopResourceConsumingWorkloads: React.FC = () => {
<CardTitle>CPU</CardTitle>
<CardBody>
<TopResourceConsumingWorkloadsChart
label="CPU"
title={truncateNumberToStr(topWorkloadsByUsage.cpuCoresUsed.totalUsage)}
subTitle="cores"
data={topWorkloadsByUsage.cpuCoresUsed.topWorkloads.map((data) => ({
name:
data.workload === 'other' ? 'other' : data.workload.metadata?.name || 'unnamed',
usage: data.usage || 0,
}))}
dataStrConverter={numberToCoreStr}
metricLabel="CPU"
unitLabel="cores"
data={topWorkloadsByUsage.cpuCoresUsed}
/>
</CardBody>
</Card>
Expand All @@ -143,15 +119,10 @@ export const TopResourceConsumingWorkloads: React.FC = () => {
<CardTitle>Memory</CardTitle>
<CardBody>
<TopResourceConsumingWorkloadsChart
label="Memory"
title={memoryBytesToGibStr(topWorkloadsByUsage.memoryBytesUsed.totalUsage, true)}
subTitle="GiB"
data={topWorkloadsByUsage.memoryBytesUsed.topWorkloads.map((data) => ({
name:
data.workload === 'other' ? 'other' : data.workload.metadata?.name || 'unnamed',
usage: data.usage || 0,
}))}
dataStrConverter={memoryBytesToGibStr}
metricLabel="Memory"
unitLabel="GiB"
data={topWorkloadsByUsage.memoryBytesUsed}
convertUnits={bytesAsPreciseGiB}
/>
</CardBody>
</Card>
Expand Down
7 changes: 7 additions & 0 deletions frontend/src/utilities/__tests__/number.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ describe('roundNumber', () => {
expect(roundNumber(0.09765625)).toBe(0.1);
expect(roundNumber(0.048828125)).toBe(0.05);
});

it('should round to custom precision if specified', () => {
expect(roundNumber(1, 3)).toBe(1);
expect(roundNumber(0.16, 3)).toBe(0.16);
expect(roundNumber(0.09765625, 3)).toBe(0.098);
expect(roundNumber(0.048828125, 3)).toBe(0.049);
});
});

describe('bytesAsPreciseGiB', () => {
Expand Down
8 changes: 6 additions & 2 deletions frontend/src/utilities/number.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ import { convertToUnit, MEMORY_UNITS_FOR_PARSING } from './valueUnits';
/**
* Returns the given number rounded to 1 decimal point, unless it is less than 0.1,
* then it will return 2 decimal points so the value is not rounded to zero.
* If precision is passed, the above logic is ignored and the specified precision is used.
*/
export const roundNumber = (value: number | typeof NaN): number => {
export const roundNumber = (
value: number | typeof NaN,
precision = value < 0.1 ? 2 : 1,
): number => {
if (Number.isNaN(value)) {
return 0;
}
return parseFloat(value.toFixed(value < 0.1 ? 2 : 1));
return parseFloat(value.toFixed(precision));
};

/**
Expand Down
10 changes: 10 additions & 0 deletions frontend/src/utilities/string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,13 @@ export const isS3PathValid = (path: string): boolean => {
const pattern = /^[a-zA-Z0-9\-_./]+$/;
return pattern.test(path) && !containsMultipleSlashesPattern(path);
};

/*
* Truncates a string to a specified number of characters with ellipses
*/
export const truncateString = (str: string, length: number): string => {
if (str.length <= length) {
return str;
}
return `${str.substring(0, length)}…`;
};
Loading