traceSearchInput.tsx 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. import type React from 'react';
  2. import {Fragment, useCallback, useLayoutEffect, useRef, useState} from 'react';
  3. import styled from '@emotion/styled';
  4. import {InputGroup} from 'sentry/components/inputGroup';
  5. import LoadingIndicator from 'sentry/components/loadingIndicator';
  6. import {SearchBarTrailingButton} from 'sentry/components/searchBar';
  7. import {IconChevron, IconClose, IconSearch} from 'sentry/icons';
  8. import {t} from 'sentry/locale';
  9. import {space} from 'sentry/styles/space';
  10. import type {Organization} from 'sentry/types/organization';
  11. import {trackAnalytics} from 'sentry/utils/analytics';
  12. import useOrganization from 'sentry/utils/useOrganization';
  13. import {traceAnalytics} from '../traceAnalytics';
  14. import type {TraceTree} from '../traceModels/traceTree';
  15. import type {TraceTreeNode} from '../traceModels/traceTreeNode';
  16. import type {TraceSearchState} from '../traceState/traceSearch';
  17. import {useTraceState, useTraceStateDispatch} from '../traceState/traceStateProvider';
  18. interface TraceSearchInputProps {
  19. onTraceSearch: (
  20. query: string,
  21. node: TraceTreeNode<TraceTree.NodeValue> | null,
  22. behavior: 'track result' | 'persist'
  23. ) => void;
  24. organization: Organization;
  25. }
  26. const MIN_LOADING_TIME = 300;
  27. export function TraceSearchInput(props: TraceSearchInputProps) {
  28. const organization = useOrganization();
  29. const traceState = useTraceState();
  30. const traceDispatch = useTraceStateDispatch();
  31. const [status, setStatus] = useState<TraceSearchState['status']>();
  32. const timeoutRef = useRef<number | undefined>(undefined);
  33. const statusRef = useRef<TraceSearchState['status']>(status);
  34. statusRef.current = status;
  35. const traceStateRef = useRef(traceState);
  36. traceStateRef.current = traceState;
  37. const onTraceSearch = props.onTraceSearch;
  38. useLayoutEffect(() => {
  39. if (typeof timeoutRef.current === 'number') {
  40. window.clearTimeout(timeoutRef.current);
  41. }
  42. // if status is loading, show loading icon immediately
  43. // if previous status was loading, show loading icon for at least 500ms
  44. if (!statusRef.current && traceState.search.status) {
  45. setStatus([performance.now(), traceState.search.status[1]]);
  46. return;
  47. }
  48. const nextStatus = traceState.search.status;
  49. if (nextStatus) {
  50. const elapsed = performance.now() - nextStatus[0];
  51. if (elapsed > MIN_LOADING_TIME || nextStatus[1] === 'loading') {
  52. setStatus(nextStatus);
  53. return;
  54. }
  55. const schedule = nextStatus[0] + MIN_LOADING_TIME - performance.now();
  56. timeoutRef.current = window.setTimeout(() => {
  57. setStatus(nextStatus);
  58. }, schedule);
  59. } else {
  60. setStatus(nextStatus);
  61. }
  62. }, [traceState.search.status]);
  63. const onSearchFocus = useCallback(() => {
  64. traceAnalytics.trackSearchFocus(organization);
  65. if (traceStateRef.current.rovingTabIndex.node) {
  66. traceDispatch({type: 'clear roving index'});
  67. }
  68. }, [traceDispatch, organization]);
  69. const onChange = useCallback(
  70. (event: React.ChangeEvent<HTMLInputElement>) => {
  71. if (!event.target.value) {
  72. traceDispatch({type: 'clear query'});
  73. return;
  74. }
  75. traceDispatch({type: 'set query', query: event.target.value});
  76. onTraceSearch(
  77. event.target.value,
  78. traceStateRef.current.rovingTabIndex.node ?? traceStateRef.current.search.node,
  79. 'track result'
  80. );
  81. },
  82. [traceDispatch, onTraceSearch]
  83. );
  84. const onSearchClear = useCallback(() => {
  85. trackAnalytics('trace.trace_layout.search_clear', {
  86. organization,
  87. });
  88. traceDispatch({type: 'clear query'});
  89. }, [traceDispatch, organization]);
  90. const onKeyDown = useCallback(
  91. (event: React.KeyboardEvent<HTMLInputElement>) => {
  92. switch (event.key) {
  93. case 'ArrowDown':
  94. trackAnalytics('trace.trace_layout.search_match_navigate', {
  95. organization,
  96. direction: 'next',
  97. interaction: 'arrowKey',
  98. });
  99. traceDispatch({
  100. type: event.shiftKey ? 'go to last match' : 'go to next match',
  101. });
  102. break;
  103. case 'ArrowUp':
  104. trackAnalytics('trace.trace_layout.search_match_navigate', {
  105. organization,
  106. direction: 'prev',
  107. interaction: 'arrowKey',
  108. });
  109. traceDispatch({
  110. type: event.shiftKey ? 'go to first match' : 'go to previous match',
  111. });
  112. break;
  113. case 'Enter':
  114. trackAnalytics('trace.trace_layout.search_match_navigate', {
  115. organization,
  116. direction: event.shiftKey ? 'prev' : 'next',
  117. interaction: 'enterKey',
  118. });
  119. traceDispatch({
  120. type: event.shiftKey ? 'go to previous match' : 'go to next match',
  121. });
  122. break;
  123. default:
  124. }
  125. },
  126. [traceDispatch, organization]
  127. );
  128. const onNextSearchClick = useCallback(() => {
  129. trackAnalytics('trace.trace_layout.search_match_navigate', {
  130. organization,
  131. direction: 'next',
  132. interaction: 'click',
  133. });
  134. if (traceStateRef.current.rovingTabIndex.node) {
  135. traceDispatch({type: 'clear roving index'});
  136. }
  137. traceDispatch({type: 'go to next match'});
  138. }, [traceDispatch, organization]);
  139. const onPreviousSearchClick = useCallback(() => {
  140. trackAnalytics('trace.trace_layout.search_match_navigate', {
  141. organization,
  142. direction: 'prev',
  143. interaction: 'click',
  144. });
  145. if (traceStateRef.current.rovingTabIndex.node) {
  146. traceDispatch({type: 'clear roving index'});
  147. }
  148. traceDispatch({type: 'go to previous match'});
  149. }, [traceDispatch, organization]);
  150. const inputRef = useRef<HTMLInputElement>(null);
  151. useLayoutEffect(() => {
  152. if (inputRef.current) {
  153. inputRef.current.focus();
  154. inputRef.current.value = traceState.search.query ?? '';
  155. onChange({target: inputRef.current} as React.ChangeEvent<HTMLInputElement>);
  156. }
  157. }, [traceState.search.query, onChange]);
  158. return (
  159. <StyledSearchBar>
  160. <InputGroup.LeadingItems>
  161. <InvisiblePlaceholder />
  162. {status?.[1] === 'loading' ? (
  163. <StyledLoadingIndicator data-test-id="trace-search-loading" size={12} />
  164. ) : (
  165. <StyledSearchIcon
  166. data-test-id="trace-search-success"
  167. color="subText"
  168. size={'xs'}
  169. />
  170. )}
  171. </InputGroup.LeadingItems>
  172. <InputGroup.Input
  173. ref={inputRef}
  174. size="xs"
  175. type="text"
  176. name="query"
  177. autoComplete="off"
  178. placeholder={t('Search in trace')}
  179. defaultValue={traceState.search.query}
  180. onChange={onChange}
  181. onKeyDown={onKeyDown}
  182. onFocus={onSearchFocus}
  183. />
  184. <InputGroup.TrailingItems>
  185. <StyledTrailingText data-test-id="trace-search-result-iterator">
  186. {`${
  187. traceState.search.query && !traceState.search.results?.length
  188. ? t('no results')
  189. : traceState.search.query
  190. ? (traceState.search.resultIteratorIndex !== null
  191. ? traceState.search.resultIteratorIndex + 1
  192. : '-') + `/${traceState.search.results?.length ?? 0}`
  193. : ''
  194. }`}
  195. </StyledTrailingText>
  196. {traceState.search.query ? (
  197. <Fragment>
  198. <StyledSearchBarTrailingButton
  199. size="zero"
  200. borderless
  201. icon={<IconChevron size="xs" />}
  202. aria-label={t('Next')}
  203. disabled={status?.[1] === 'loading'}
  204. onClick={onPreviousSearchClick}
  205. />
  206. <StyledSearchBarTrailingButton
  207. size="zero"
  208. borderless
  209. icon={<IconChevron size="xs" direction="down" />}
  210. aria-label={t('Previous')}
  211. disabled={status?.[1] === 'loading'}
  212. onClick={onNextSearchClick}
  213. />
  214. <StyledSearchBarTrailingButton
  215. size="zero"
  216. borderless
  217. disabled={status?.[1] === 'loading'}
  218. onClick={onSearchClear}
  219. icon={<IconClose size="xs" />}
  220. aria-label={t('Clear')}
  221. />
  222. </Fragment>
  223. ) : null}
  224. </InputGroup.TrailingItems>
  225. </StyledSearchBar>
  226. );
  227. }
  228. const InvisiblePlaceholder = styled('div')`
  229. pointer-events: none;
  230. visibility: hidden;
  231. width: 12px;
  232. height: 12px;
  233. `;
  234. const StyledLoadingIndicator = styled(LoadingIndicator)`
  235. margin: 0;
  236. left: 0;
  237. top: 50%;
  238. position: absolute;
  239. transform: translate(-2px, -50%);
  240. animation: showLoadingIndicator 0.3s ease-in-out forwards;
  241. @keyframes showLoadingIndicator {
  242. from {
  243. opacity: 0;
  244. transform: translate(-2px, -50%) scale(0.86);
  245. }
  246. to {
  247. opacity: 1;
  248. transform: translate(-2px, -50%) scale(1);
  249. }
  250. }
  251. .loading-indicator {
  252. border-width: 2px;
  253. }
  254. .loading-message {
  255. display: none;
  256. }
  257. `;
  258. const StyledSearchIcon = styled(IconSearch)`
  259. position: absolute;
  260. left: 0;
  261. top: 50%;
  262. transform: scale(1) translateY(-50%);
  263. animation: showSearchIcon 0.3s ease-in-out forwards;
  264. @keyframes showSearchIcon {
  265. from {
  266. opacity: 0;
  267. transform: scale(0.86) translateY(-50%);
  268. }
  269. to {
  270. opacity: 1;
  271. transform: scale(1) translateY(-50%);
  272. }
  273. }
  274. `;
  275. const StyledSearchBarTrailingButton = styled(SearchBarTrailingButton)`
  276. padding: 0;
  277. &:last-child {
  278. svg {
  279. width: 10px;
  280. height: 10px;
  281. }
  282. }
  283. `;
  284. const StyledTrailingText = styled('span')`
  285. color: ${p => p.theme.subText};
  286. font-size: ${p => p.theme.fontSizeSmall};
  287. `;
  288. const StyledSearchBar = styled(InputGroup)`
  289. flex: 1 1 100%;
  290. margin-bottom: ${space(1)};
  291. > div > div:last-child {
  292. gap: ${space(0.25)};
  293. }
  294. `;