queryList.tsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. import {Component, Fragment} from 'react';
  2. import {browserHistory, InjectedRouter} from 'react-router';
  3. import styled from '@emotion/styled';
  4. import {Location, Query} from 'history';
  5. import moment from 'moment';
  6. import {resetPageFilters} from 'sentry/actionCreators/pageFilters';
  7. import {Client} from 'sentry/api';
  8. import Feature from 'sentry/components/acl/feature';
  9. import Button from 'sentry/components/button';
  10. import DropdownMenuControl from 'sentry/components/dropdownMenuControl';
  11. import {MenuItemProps} from 'sentry/components/dropdownMenuItem';
  12. import EmptyStateWarning from 'sentry/components/emptyStateWarning';
  13. import Pagination from 'sentry/components/pagination';
  14. import TimeSince from 'sentry/components/timeSince';
  15. import {IconEllipsis} from 'sentry/icons';
  16. import {t} from 'sentry/locale';
  17. import space from 'sentry/styles/space';
  18. import {Organization, SavedQuery} from 'sentry/types';
  19. import trackAdvancedAnalyticsEvent from 'sentry/utils/analytics/trackAdvancedAnalyticsEvent';
  20. import EventView from 'sentry/utils/discover/eventView';
  21. import parseLinkHeader from 'sentry/utils/parseLinkHeader';
  22. import {decodeList} from 'sentry/utils/queryString';
  23. import withApi from 'sentry/utils/withApi';
  24. import {
  25. handleCreateQuery,
  26. handleDeleteQuery,
  27. handleUpdateHomepageQuery,
  28. } from './savedQuery/utils';
  29. import MiniGraph from './miniGraph';
  30. import QueryCard from './querycard';
  31. import {getPrebuiltQueries, handleAddQueryToDashboard} from './utils';
  32. type Props = {
  33. api: Client;
  34. location: Location;
  35. onQueryChange: () => void;
  36. organization: Organization;
  37. pageLinks: string;
  38. renderPrebuilt: boolean;
  39. router: InjectedRouter;
  40. savedQueries: SavedQuery[];
  41. savedQuerySearchQuery: string;
  42. };
  43. class QueryList extends Component<Props> {
  44. componentDidMount() {
  45. /**
  46. * We need to reset global selection here because the saved queries can define their own projects
  47. * in the query. This can lead to mismatched queries for the project
  48. */
  49. resetPageFilters();
  50. }
  51. handleDeleteQuery = (eventView: EventView) => {
  52. const {api, organization, onQueryChange, location, savedQueries} = this.props;
  53. handleDeleteQuery(api, organization, eventView).then(() => {
  54. if (savedQueries.length === 1 && location.query.cursor) {
  55. browserHistory.push({
  56. pathname: location.pathname,
  57. query: {...location.query, cursor: undefined},
  58. });
  59. } else {
  60. onQueryChange();
  61. }
  62. });
  63. };
  64. handleDuplicateQuery = (eventView: EventView, yAxis: string[]) => {
  65. const {api, location, organization, onQueryChange} = this.props;
  66. eventView = eventView.clone();
  67. eventView.name = `${eventView.name} copy`;
  68. handleCreateQuery(api, organization, eventView, yAxis).then(() => {
  69. onQueryChange();
  70. browserHistory.push({
  71. pathname: location.pathname,
  72. query: {},
  73. });
  74. });
  75. };
  76. renderQueries() {
  77. const {pageLinks, renderPrebuilt} = this.props;
  78. const links = parseLinkHeader(pageLinks || '');
  79. let cards: React.ReactNode[] = [];
  80. // If we're on the first page (no-previous page exists)
  81. // include the pre-built queries.
  82. if (renderPrebuilt && (!links.previous || links.previous.results === false)) {
  83. cards = cards.concat(this.renderPrebuiltQueries());
  84. }
  85. cards = cards.concat(this.renderSavedQueries());
  86. if (cards.filter(x => x).length === 0) {
  87. return (
  88. <StyledEmptyStateWarning>
  89. <p>{t('No saved queries match that filter')}</p>
  90. </StyledEmptyStateWarning>
  91. );
  92. }
  93. return cards;
  94. }
  95. renderDropdownMenu(items: MenuItemProps[]) {
  96. return (
  97. <DropdownMenuControl
  98. items={items}
  99. trigger={({props: triggerProps, ref: triggerRef}) => (
  100. <DropdownTrigger
  101. ref={triggerRef}
  102. {...triggerProps}
  103. aria-label={t('Query actions')}
  104. size="xs"
  105. borderless
  106. onClick={e => {
  107. e.stopPropagation();
  108. e.preventDefault();
  109. triggerProps.onClick?.(e);
  110. }}
  111. icon={<IconEllipsis direction="down" size="sm" />}
  112. data-test-id="menu-trigger"
  113. />
  114. )}
  115. placement="bottom right"
  116. offset={4}
  117. />
  118. );
  119. }
  120. renderPrebuiltQueries() {
  121. const {api, location, organization, savedQuerySearchQuery, router} = this.props;
  122. const views = getPrebuiltQueries(organization);
  123. const hasSearchQuery =
  124. typeof savedQuerySearchQuery === 'string' && savedQuerySearchQuery.length > 0;
  125. const needleSearch = hasSearchQuery ? savedQuerySearchQuery.toLowerCase() : '';
  126. const list = views.map((view, index) => {
  127. const eventView = EventView.fromNewQueryWithLocation(view, location);
  128. // if a search is performed on the list of queries, we filter
  129. // on the pre-built queries
  130. if (
  131. hasSearchQuery &&
  132. eventView.name &&
  133. !eventView.name.toLowerCase().includes(needleSearch)
  134. ) {
  135. return null;
  136. }
  137. const recentTimeline = t('Last ') + eventView.statsPeriod;
  138. const customTimeline =
  139. moment(eventView.start).format('MMM D, YYYY h:mm A') +
  140. ' - ' +
  141. moment(eventView.end).format('MMM D, YYYY h:mm A');
  142. const to = eventView.getResultsViewUrlTarget(organization.slug);
  143. const menuItems = [
  144. {
  145. key: 'add-to-dashboard',
  146. label: t('Add to Dashboard'),
  147. onAction: () =>
  148. handleAddQueryToDashboard({
  149. eventView,
  150. location,
  151. query: view,
  152. organization,
  153. yAxis: view?.yAxis,
  154. router,
  155. }),
  156. },
  157. ...(organization.features.includes('discover-query-builder-as-landing-page')
  158. ? [
  159. {
  160. key: 'set-as-default',
  161. label: t('Use as Discover Home'),
  162. onAction: () => {
  163. handleUpdateHomepageQuery(api, organization, eventView.toNewQuery());
  164. },
  165. },
  166. ]
  167. : []),
  168. ];
  169. return (
  170. <QueryCard
  171. key={`${index}-${eventView.name}`}
  172. to={to}
  173. title={eventView.name}
  174. subtitle={eventView.statsPeriod ? recentTimeline : customTimeline}
  175. queryDetail={eventView.query}
  176. createdBy={eventView.createdBy}
  177. renderGraph={() => (
  178. <MiniGraph
  179. location={location}
  180. eventView={eventView}
  181. organization={organization}
  182. referrer="api.discover.homepage.prebuilt"
  183. />
  184. )}
  185. onEventClick={() => {
  186. trackAdvancedAnalyticsEvent('discover_v2.prebuilt_query_click', {
  187. organization,
  188. query_name: eventView.name,
  189. });
  190. }}
  191. renderContextMenu={() => (
  192. <Feature organization={organization} features={['dashboards-edit']}>
  193. {({hasFeature}) => {
  194. return hasFeature && this.renderDropdownMenu(menuItems);
  195. }}
  196. </Feature>
  197. )}
  198. />
  199. );
  200. });
  201. return list;
  202. }
  203. renderSavedQueries() {
  204. const {api, savedQueries, location, organization, router} = this.props;
  205. if (!savedQueries || !Array.isArray(savedQueries) || savedQueries.length === 0) {
  206. return [];
  207. }
  208. return savedQueries.map((savedQuery, index) => {
  209. const eventView = EventView.fromSavedQuery(savedQuery);
  210. const recentTimeline = t('Last ') + eventView.statsPeriod;
  211. const customTimeline =
  212. moment(eventView.start).format('MMM D, YYYY h:mm A') +
  213. ' - ' +
  214. moment(eventView.end).format('MMM D, YYYY h:mm A');
  215. const to = eventView.getResultsViewShortUrlTarget(organization.slug);
  216. const dateStatus = <TimeSince date={savedQuery.dateUpdated} />;
  217. const referrer = `api.discover.${eventView.getDisplayMode()}-chart`;
  218. const menuItems = (canAddToDashboard: boolean): MenuItemProps[] => [
  219. ...(canAddToDashboard
  220. ? [
  221. {
  222. key: 'add-to-dashboard',
  223. label: t('Add to Dashboard'),
  224. onAction: () =>
  225. handleAddQueryToDashboard({
  226. eventView,
  227. location,
  228. query: savedQuery,
  229. organization,
  230. yAxis: savedQuery?.yAxis ?? eventView.yAxis,
  231. router,
  232. }),
  233. },
  234. ]
  235. : []),
  236. ...(organization.features.includes('discover-query-builder-as-landing-page')
  237. ? [
  238. {
  239. key: 'set-as-default',
  240. label: t('Use as Discover Home'),
  241. onAction: () => {
  242. handleUpdateHomepageQuery(api, organization, eventView.toNewQuery());
  243. },
  244. },
  245. ]
  246. : []),
  247. {
  248. key: 'duplicate',
  249. label: t('Duplicate Query'),
  250. onAction: () =>
  251. this.handleDuplicateQuery(eventView, decodeList(savedQuery.yAxis)),
  252. },
  253. {
  254. key: 'delete',
  255. label: t('Delete Query'),
  256. priority: 'danger',
  257. onAction: () => this.handleDeleteQuery(eventView),
  258. },
  259. ];
  260. return (
  261. <QueryCard
  262. key={`${index}-${eventView.id}`}
  263. to={to}
  264. title={eventView.name}
  265. subtitle={eventView.statsPeriod ? recentTimeline : customTimeline}
  266. queryDetail={eventView.query}
  267. createdBy={eventView.createdBy}
  268. dateStatus={dateStatus}
  269. onEventClick={() => {
  270. trackAdvancedAnalyticsEvent('discover_v2.saved_query_click', {organization});
  271. }}
  272. renderGraph={() => (
  273. <MiniGraph
  274. location={location}
  275. eventView={eventView}
  276. organization={organization}
  277. referrer={referrer}
  278. yAxis={
  279. savedQuery.yAxis && savedQuery.yAxis.length
  280. ? savedQuery.yAxis
  281. : ['count()']
  282. }
  283. />
  284. )}
  285. renderContextMenu={() => (
  286. <Feature organization={organization} features={['dashboards-edit']}>
  287. {({hasFeature}) => this.renderDropdownMenu(menuItems(hasFeature))}
  288. </Feature>
  289. )}
  290. />
  291. );
  292. });
  293. }
  294. render() {
  295. const {pageLinks} = this.props;
  296. return (
  297. <Fragment>
  298. <QueryGrid>{this.renderQueries()}</QueryGrid>
  299. <PaginationRow
  300. pageLinks={pageLinks}
  301. onCursor={(cursor, path, query, direction) => {
  302. const offset = Number(cursor?.split(':')?.[1] ?? 0);
  303. const newQuery: Query & {cursor?: string} = {...query, cursor};
  304. const isPrevious = direction === -1;
  305. if (offset <= 0 && isPrevious) {
  306. delete newQuery.cursor;
  307. }
  308. browserHistory.push({
  309. pathname: path,
  310. query: newQuery,
  311. });
  312. }}
  313. />
  314. </Fragment>
  315. );
  316. }
  317. }
  318. const PaginationRow = styled(Pagination)`
  319. margin-bottom: 20px;
  320. `;
  321. const QueryGrid = styled('div')`
  322. display: grid;
  323. grid-template-columns: minmax(100px, 1fr);
  324. gap: ${space(2)};
  325. @media (min-width: ${p => p.theme.breakpoints.medium}) {
  326. grid-template-columns: repeat(2, minmax(100px, 1fr));
  327. }
  328. @media (min-width: ${p => p.theme.breakpoints.large}) {
  329. grid-template-columns: repeat(3, minmax(100px, 1fr));
  330. }
  331. `;
  332. const DropdownTrigger = styled(Button)`
  333. transform: translateX(${space(1)});
  334. `;
  335. const StyledEmptyStateWarning = styled(EmptyStateWarning)`
  336. grid-column: 1 / 4;
  337. `;
  338. export default withApi(QueryList);