Skip to content

feat(dashboards): Add Big Number Widget threshold hover #79240

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 17, 2024
Merged

feat(dashboards): Add Big Number Widget threshold hover #79240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf4acb3
Simplify API
gggritso Oct 16, 2024
5ad461b
Remove default export
gggritso Oct 16, 2024
cf66a45
Add threshold wrappers
gggritso Oct 16, 2024
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
4 changes: 2 additions & 2 deletions static/app/views/dashboards/utils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ import {
WidgetType,
} from 'sentry/views/dashboards/types';

import ThresholdsHoverWrapper from './widgetBuilder/buildSteps/thresholdsStep/thresholdsHoverWrapper';
import {ThresholdsHoverWrapper} from './widgetBuilder/buildSteps/thresholdsStep/thresholdsHoverWrapper';
import type {ThresholdsConfig} from './widgetBuilder/buildSteps/thresholdsStep/thresholdsStep';
import {ThresholdMaxKeys} from './widgetBuilder/buildSteps/thresholdsStep/thresholdsStep';

Expand Down Expand Up @@ -188,7 +188,7 @@ export function getColoredWidgetIndicator(
}

return (
<ThresholdsHoverWrapper thresholds={thresholds} tableData={tableData}>
<ThresholdsHoverWrapper thresholds={thresholds} type={dataType}>
<CircleIndicator color={color} size={12} />
</ThresholdsHoverWrapper>
);
Expand Down
13 changes: 3 additions & 10 deletions ...c/app/views/dashboards/widgetBuilder/buildSteps/thresholdsStep/thresholdsHoverWrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,23 @@ import CircleIndicator from 'sentry/components/circleIndicator';
import {Hovercard} from 'sentry/components/hovercard';
import {t} from 'sentry/locale';
import {space} from 'sentry/styles/space';
import type {TableDataWithTitle} from 'sentry/utils/discover/discoverQuery';
import theme from 'sentry/utils/theme';

import type {ThresholdsConfig} from './thresholdsStep';

type Props = {
children: React.ReactNode;
tableData: TableDataWithTitle[];
thresholds: ThresholdsConfig;
type?: string;
};

function ThresholdsHoverWrapper({children, thresholds, tableData}: Props) {
export function ThresholdsHoverWrapper({children, thresholds, type}: Props) {
const {
unit,
max_values: {max1, max2},
} = thresholds;
const tableMeta = {...tableData[0].meta};
const fields = Object.keys(tableMeta);
const field = fields[0];
const dataType = tableMeta[field];
const formattedUnit =
unit && (dataType === 'duration' ? `${unit}s` : `/${unit.split('/')[1]}`);
unit && (type === 'duration' ? `${unit}s` : `/${unit.split('/')[1]}`);
const title = unit ? t(`Thresholds in %s`, formattedUnit) : t('Thresholds');

const notSetMsg = t('Not set');
Expand Down Expand Up @@ -87,5 +82,3 @@ const ContextTitle = styled('h6')`
const StyledIndicator = styled(CircleIndicator)`
margin-right: ${space(1)};
`;

export default ThresholdsHoverWrapper;
5 changes: 4 additions & 1 deletion static/app/views/dashboards/widgets/bigNumberWidget/bigNumberWidget.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ describe('BigNumberWidget', () => {
});

describe('Thresholds', () => {
it('Evaluates the current value against a threshold', () => {
it('Evaluates the current value against a threshold', async () => {
render(
<BigNumberWidget
data={[
Expand All @@ -245,6 +245,9 @@ describe('BigNumberWidget', () => {
);

expect(screen.getByRole('status')).toHaveAttribute('aria-label', 'meh');

await userEvent.hover(screen.getByRole('status'));
expect(await screen.findByText('Thresholds in /second')).toBeInTheDocument();
});

it('Normalizes the units', () => {
Expand Down
7 changes: 6 additions & 1 deletion static/app/views/dashboards/widgets/bigNumberWidget/thresholdsIndicator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import styled from '@emotion/styled';
import type {Polarity} from 'sentry/components/percentChange';

import {normalizeUnit} from '../../utils';
import {ThresholdsHoverWrapper} from '../../widgetBuilder/buildSteps/thresholdsStep/thresholdsHoverWrapper';
import type {Thresholds} from '../common/types';

interface ThresholdsIndicatorProps {
Expand Down Expand Up @@ -39,7 +40,11 @@ export function ThresholdsIndicator({

const colorName = COLOR_NAME_FOR_STATE[state];

return <Circle role="status" aria-label={state} color={theme[colorName]} />;
return (
<ThresholdsHoverWrapper thresholds={thresholds} type={type}>
<Circle role="status" aria-label={state} color={theme[colorName]} />
</ThresholdsHoverWrapper>
);
}

const Circle = styled('div')<{color: string}>`
Expand Down
Loading