webVitalMeters.tsx 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. import {Fragment} from 'react';
  2. import styled from '@emotion/styled';
  3. import toUpper from 'lodash/toUpper';
  4. import InteractionStateLayer from 'sentry/components/interactionStateLayer';
  5. import ExternalLink from 'sentry/components/links/externalLink';
  6. import QuestionTooltip from 'sentry/components/questionTooltip';
  7. import {Tooltip} from 'sentry/components/tooltip';
  8. import {t, tct} from 'sentry/locale';
  9. import {space} from 'sentry/styles/space';
  10. import {TableData} from 'sentry/utils/discover/discoverQuery';
  11. import {getDuration} from 'sentry/utils/formatters';
  12. import {PERFORMANCE_SCORE_COLORS} from 'sentry/views/performance/browser/webVitals/utils/performanceScoreColors';
  13. import {
  14. scoreToStatus,
  15. STATUS_TEXT,
  16. } from 'sentry/views/performance/browser/webVitals/utils/scoreToStatus';
  17. import {
  18. ProjectScore,
  19. WebVitals,
  20. } from 'sentry/views/performance/browser/webVitals/utils/types';
  21. type Props = {
  22. onClick?: (webVital: WebVitals) => void;
  23. projectData?: TableData;
  24. projectScore?: ProjectScore;
  25. showTooltip?: boolean;
  26. transaction?: string;
  27. };
  28. const WEB_VITALS_METERS_CONFIG = {
  29. lcp: {
  30. name: t('Largest Contentful Paint'),
  31. formatter: (value: number) => getFormattedDuration(value / 1000),
  32. },
  33. fcp: {
  34. name: t('First Contentful Paint'),
  35. formatter: (value: number) => getFormattedDuration(value / 1000),
  36. },
  37. fid: {
  38. name: t('First Input Delay'),
  39. formatter: (value: number) => getFormattedDuration(value / 1000),
  40. },
  41. cls: {
  42. name: t('Cumulative Layout Shift'),
  43. formatter: (value: number) => Math.round(value * 100) / 100,
  44. },
  45. ttfb: {
  46. name: t('Time To First Byte'),
  47. formatter: (value: number) => getFormattedDuration(value / 1000),
  48. },
  49. };
  50. export default function WebVitalMeters({
  51. onClick,
  52. projectData,
  53. projectScore,
  54. showTooltip = true,
  55. }: Props) {
  56. if (!projectScore) {
  57. return null;
  58. }
  59. const webVitals = Object.keys(WEB_VITALS_METERS_CONFIG) as WebVitals[];
  60. return (
  61. <Container>
  62. <Flex>
  63. {webVitals.map(webVital => {
  64. const webVitalExists = projectScore[`${webVital}Score`] !== undefined;
  65. const formattedMeterValueText = webVitalExists ? (
  66. WEB_VITALS_METERS_CONFIG[webVital].formatter(
  67. projectData?.data?.[0]?.[`p75(measurements.${webVital})`] as number
  68. )
  69. ) : (
  70. <NoValue />
  71. );
  72. const headerText = WEB_VITALS_METERS_CONFIG[webVital].name;
  73. const meterBody = (
  74. <Fragment>
  75. <MeterBarBody>
  76. {showTooltip && (
  77. <StyledQuestionTooltip
  78. isHoverable
  79. size="xs"
  80. title={
  81. <span>
  82. {tct(
  83. `The p75 [webVital] value and aggregate [webVital] score of your selected project(s).
  84. Scores and values may share some (but not perfect) correlation.`,
  85. {
  86. webVital: toUpper(webVital),
  87. }
  88. )}
  89. <br />
  90. <ExternalLink href="https://docs.sentry.io/product/performance/web-vitals/#performance-score">
  91. {t('Find out how performance scores are calculated here.')}
  92. </ExternalLink>
  93. </span>
  94. }
  95. />
  96. )}
  97. <MeterHeader>{headerText}</MeterHeader>
  98. <MeterValueText>{formattedMeterValueText}</MeterValueText>
  99. </MeterBarBody>
  100. <MeterBarFooter score={projectScore[`${webVital}Score`]} />
  101. </Fragment>
  102. );
  103. return (
  104. <MeterBarContainer
  105. key={webVital}
  106. onClick={() => webVitalExists && onClick?.(webVital)}
  107. clickable={webVitalExists}
  108. >
  109. {webVitalExists && <InteractionStateLayer />}
  110. {webVitalExists && meterBody}
  111. {!webVitalExists && (
  112. <StyledTooltip
  113. title={tct('No [webVital] data found in this project.', {
  114. webVital: toUpper(webVital),
  115. })}
  116. >
  117. {meterBody}
  118. </StyledTooltip>
  119. )}
  120. </MeterBarContainer>
  121. );
  122. })}
  123. </Flex>
  124. </Container>
  125. );
  126. }
  127. export const getFormattedDuration = (value: number) => {
  128. return getDuration(value, value < 1 ? 0 : 2, true);
  129. };
  130. const Container = styled('div')`
  131. margin-bottom: ${space(1)};
  132. `;
  133. const Flex = styled('div')<{gap?: number}>`
  134. display: flex;
  135. flex-direction: row;
  136. justify-content: center;
  137. width: 100%;
  138. gap: ${p => (p.gap ? `${p.gap}px` : space(1))};
  139. align-items: center;
  140. flex-wrap: wrap;
  141. `;
  142. const MeterBarContainer = styled('div')<{clickable?: boolean}>`
  143. flex: 1;
  144. position: relative;
  145. padding: 0;
  146. cursor: ${p => (p.clickable ? 'pointer' : 'default')};
  147. min-width: 140px;
  148. `;
  149. const MeterBarBody = styled('div')`
  150. border: 1px solid ${p => p.theme.gray200};
  151. border-radius: ${p => p.theme.borderRadius} ${p => p.theme.borderRadius} 0 0;
  152. border-bottom: none;
  153. padding: ${space(1)} 0 ${space(0.5)} 0;
  154. `;
  155. const MeterHeader = styled('div')`
  156. font-size: ${p => p.theme.fontSizeSmall};
  157. color: ${p => p.theme.textColor};
  158. display: inline-block;
  159. text-align: center;
  160. width: 100%;
  161. `;
  162. const MeterValueText = styled('div')`
  163. font-size: ${p => p.theme.headerFontSize};
  164. color: ${p => p.theme.textColor};
  165. flex: 1;
  166. text-align: center;
  167. `;
  168. function MeterBarFooter({score}: {score: number | undefined}) {
  169. if (score === undefined) {
  170. return (
  171. <MeterBarFooterContainer status="none">{t('No Data')}</MeterBarFooterContainer>
  172. );
  173. }
  174. const status = scoreToStatus(score);
  175. return (
  176. <MeterBarFooterContainer status={status}>
  177. {STATUS_TEXT[status]} {score}
  178. </MeterBarFooterContainer>
  179. );
  180. }
  181. const MeterBarFooterContainer = styled('div')<{status: string}>`
  182. color: ${p => p.theme[PERFORMANCE_SCORE_COLORS[p.status].normal]};
  183. border-radius: 0 0 ${p => p.theme.borderRadius} ${p => p.theme.borderRadius};
  184. background-color: ${p => p.theme[PERFORMANCE_SCORE_COLORS[p.status].light]};
  185. border: solid 1px ${p => p.theme[PERFORMANCE_SCORE_COLORS[p.status].normal]};
  186. font-size: ${p => p.theme.fontSizeExtraSmall};
  187. padding: ${space(0.5)};
  188. text-align: center;
  189. `;
  190. const NoValueContainer = styled('span')`
  191. color: ${p => p.theme.gray300};
  192. font-size: ${p => p.theme.fontSizeExtraLarge};
  193. `;
  194. function NoValue() {
  195. return <NoValueContainer>{' \u2014 '}</NoValueContainer>;
  196. }
  197. const StyledTooltip = styled(Tooltip)`
  198. display: block;
  199. `;
  200. const StyledQuestionTooltip = styled(QuestionTooltip)`
  201. position: absolute;
  202. right: ${space(1)};
  203. `;