123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291 |
- import {
- Fragment,
- startTransition,
- type SyntheticEvent,
- useEffect,
- useMemo,
- useState,
- } from 'react';
- import styled from '@emotion/styled';
- import {navigateTo} from 'sentry/actionCreators/navigation';
- import {Button, LinkButton} from 'sentry/components/button';
- import ProjectBadge from 'sentry/components/idBadge/projectBadge';
- import LoadingIndicator from 'sentry/components/loadingIndicator';
- import {IconInfo, IconSettings, IconWarning} from 'sentry/icons';
- import {t} from 'sentry/locale';
- import {space} from 'sentry/styles/space';
- import type {MetricMeta, MRI} from 'sentry/types/metrics';
- import type {Project} from 'sentry/types/project';
- import {getReadableMetricType} from 'sentry/utils/metrics/formatters';
- import {formatMRI, parseMRI} from 'sentry/utils/metrics/mri';
- import {
- getMetricsTagsQueryKey,
- useMetricsTags,
- } from 'sentry/utils/metrics/useMetricsTags';
- import {useQueryClient} from 'sentry/utils/queryClient';
- import useOrganization from 'sentry/utils/useOrganization';
- import useRouter from 'sentry/utils/useRouter';
- const MAX_PROJECTS_TO_SHOW = 3;
- const MAX_TAGS_TO_SHOW = 5;
- const STANDARD_TAGS = ['release', 'environment', 'transaction', 'project'];
- function stopPropagationAndPreventDefault(e: SyntheticEvent) {
- e.stopPropagation();
- e.preventDefault();
- }
- export function MetricListItemDetails({
- metric,
- selectedProjects,
- onTagClick,
- isDuplicateWithDifferentUnit,
- }: {
- isDuplicateWithDifferentUnit: boolean;
- metric: MetricMeta;
- onTagClick: (mri: MRI, tag: string) => void;
- selectedProjects: Project[];
- }) {
- const router = useRouter();
- const organization = useOrganization();
- const queryClient = useQueryClient();
- const isCustomMetric = parseMRI(metric.mri)?.useCase === 'custom';
- const [showAllTags, setShowAllTags] = useState(false);
- const [showAllProjects, setShowAllProjects] = useState(false);
- const projectIds = useMemo(
- () => selectedProjects.map(project => parseInt(project.id, 10)),
- [selectedProjects]
- );
- const [isQueryEnabled, setIsQueryEnabled] = useState(() => {
- // We only wnat to disable the query if there is no data in the cache
- const queryKey = getMetricsTagsQueryKey(organization, metric.mri, {
- projects: projectIds,
- });
- const data = queryClient.getQueryData(queryKey);
- return !!data;
- });
- const {data: tagsData = [], isLoading: tagsIsLoading} = useMetricsTags(
- // TODO: improve useMetricsTag interface
- isQueryEnabled ? metric.mri : undefined,
- {
- projects: projectIds,
- }
- );
- useEffect(() => {
- // Start querying tags after a short delay to avoid querying
- // for every metric if a user quickly hovers over them
- const timeout = setTimeout(() => {
- startTransition(() => setIsQueryEnabled(true));
- }, 200);
- return () => clearTimeout(timeout);
- }, []);
- const metricProjects = selectedProjects.filter(project =>
- metric.projectIds.includes(parseInt(project.id, 10))
- );
- const truncatedProjects = showAllProjects
- ? metricProjects
- : metricProjects.slice(0, MAX_PROJECTS_TO_SHOW);
- // Display custom tags first, then sort alphabetically
- const sortedTags = useMemo(
- () =>
- tagsData.toSorted((a, b) => {
- const aIsStandard = STANDARD_TAGS.includes(a.key);
- const bIsStandard = STANDARD_TAGS.includes(b.key);
- if (aIsStandard && !bIsStandard) {
- return 1;
- }
- if (!aIsStandard && bIsStandard) {
- return -1;
- }
- return a.key.localeCompare(b.key);
- }),
- [tagsData]
- );
- const truncatedTags = showAllTags ? sortedTags : sortedTags.slice(0, MAX_TAGS_TO_SHOW);
- const firstMetricProject = metricProjects[0];
- return (
- <DetailsWrapper
- // Stop propagation and default behaviour to keep the focus in the combobox
- onMouseDown={stopPropagationAndPreventDefault}
- >
- <Header>
- <MetricName>
- {/* Add zero width spaces at delimiter characters for nice word breaks */}
- {formatMRI(metric.mri).replaceAll(/([\.\/-_])/g, '\u200b$1')}
- {isDuplicateWithDifferentUnit && (
- <Disclaimer textColor="yellow400">
- <IconWrapper>
- <IconWarning color="yellow400" size="xs" />
- </IconWrapper>
- {t(
- 'Metrics with the same name and different units were detected. Unwanted metrics can be disabled in settings.'
- )}
- </Disclaimer>
- )}
- {!isCustomMetric && (
- <Disclaimer>
- <IconWrapper>
- <IconInfo size="xs" />
- </IconWrapper>
- {t('Prone to client-side sampling')}
- </Disclaimer>
- )}
- </MetricName>
- {isCustomMetric &&
- (firstMetricProject ? (
- <LinkButton
- size="xs"
- to={`/settings/projects/${firstMetricProject.slug}/metrics/${encodeURIComponent(metric.mri)}`}
- aria-label={t('Open metric settings')}
- icon={<IconSettings />}
- borderless
- />
- ) : (
- // TODO: figure out when we can end up in this case
- <Button
- size="xs"
- onClick={() =>
- navigateTo(
- `/settings/projects/:projectId/metrics/${encodeURIComponent(metric.mri)}`,
- router
- )
- }
- aria-label={t('Open metric settings')}
- icon={<IconSettings />}
- borderless
- />
- ))}
- </Header>
- <DetailsGrid>
- <DetailsLabel>{t('Project')}</DetailsLabel>
- <DetailsValue>
- {truncatedProjects.map(project => (
- <ProjectBadge project={project} key={project.slug} avatarSize={12} />
- ))}
- {metricProjects.length > MAX_PROJECTS_TO_SHOW && !showAllProjects && (
- <Button priority="link" onClick={() => setShowAllProjects(true)}>
- {t('+%d more', metricProjects.length - MAX_PROJECTS_TO_SHOW)}
- </Button>
- )}
- </DetailsValue>
- <DetailsLabel>{t('Type')}</DetailsLabel>
- <DetailsValue>{getReadableMetricType(metric.type)}</DetailsValue>
- <DetailsLabel>{t('Unit')}</DetailsLabel>
- <DetailsValue>{metric.unit}</DetailsValue>
- <DetailsLabel>{t('Tags')}</DetailsLabel>
- <DetailsValue>
- {tagsIsLoading || !isQueryEnabled ? (
- <StyledLoadingIndicator mini size={12} />
- ) : truncatedTags.length === 0 ? (
- t('(None)')
- ) : (
- <Fragment>
- {truncatedTags.map((tag, index) => {
- const shouldAddDelimiter = index < truncatedTags.length - 1;
- return (
- <Fragment key={tag.key}>
- <TagWrapper>
- <Button
- priority="link"
- onClick={() => onTagClick(metric.mri, tag.key)}
- >
- {tag.key}
- </Button>
- {/* Make the comma stick to the Button when the text wraps to the next line */}
- {shouldAddDelimiter ? ',' : null}
- </TagWrapper>
- {shouldAddDelimiter ? ' ' : null}
- </Fragment>
- );
- })}
- <br />
- {tagsData.length > MAX_TAGS_TO_SHOW && !showAllTags && (
- <Button priority="link" onClick={() => setShowAllTags(true)}>
- {t('+%d more', tagsData.length - MAX_TAGS_TO_SHOW)}
- </Button>
- )}
- </Fragment>
- )}
- </DetailsValue>
- </DetailsGrid>
- </DetailsWrapper>
- );
- }
- const DetailsWrapper = styled('div')`
- width: 300px;
- line-height: 1.4;
- `;
- const Header = styled('div')`
- display: grid;
- grid-template-columns: 1fr max-content;
- align-items: center;
- gap: ${space(0.5)};
- padding: ${space(0.75)} ${space(0.25)} ${space(0.75)} ${space(1.5)};
- `;
- const MetricName = styled('div')`
- word-break: break-word;
- `;
- const DetailsGrid = styled('div')`
- display: grid;
- grid-template-columns: max-content 1fr;
- & > div:nth-child(4n + 1),
- & > div:nth-child(4n + 2) {
- background-color: ${p => p.theme.backgroundSecondary};
- }
- `;
- const StyledLoadingIndicator = styled(LoadingIndicator)`
- && {
- margin: ${space(0.75)} 0 0;
- height: 12px;
- width: 12px;
- }
- `;
- const DetailsLabel = styled('div')`
- color: ${p => p.theme.subText};
- padding: ${space(0.75)} ${space(1)} ${space(0.75)} ${space(1.5)};
- border-top-left-radius: ${p => p.theme.borderRadius};
- border-bottom-left-radius: ${p => p.theme.borderRadius};
- `;
- const DetailsValue = styled('div')`
- white-space: pre-wrap;
- padding: ${space(0.75)} ${space(1.5)} ${space(0.75)} ${space(1)};
- border-top-right-radius: ${p => p.theme.borderRadius};
- border-bottom-right-radius: ${p => p.theme.borderRadius};
- min-width: 0;
- `;
- const TagWrapper = styled('span')`
- white-space: nowrap;
- `;
- const Disclaimer = styled('div')<{textColor?: string}>`
- display: grid;
- gap: ${space(0.5)};
- grid-template-columns: max-content 1fr;
- font-size: ${p => p.theme.fontSizeSmall};
- color: ${p => (p.textColor ? p.theme[p.textColor] ?? null : null)};
- `;
- const IconWrapper = styled('div')`
- margin-top: 1px;
- `;
|