queryList.tsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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={triggerProps => (
  100. <DropdownTrigger
  101. {...triggerProps}
  102. aria-label={t('Query actions')}
  103. size="xs"
  104. borderless
  105. onClick={e => {
  106. e.stopPropagation();
  107. e.preventDefault();
  108. triggerProps.onClick?.(e);
  109. }}
  110. icon={<IconEllipsis direction="down" size="sm" />}
  111. data-test-id="menu-trigger"
  112. />
  113. )}
  114. position="bottom-end"
  115. offset={4}
  116. />
  117. );
  118. }
  119. renderPrebuiltQueries() {
  120. const {api, location, organization, savedQuerySearchQuery, router} = this.props;
  121. const views = getPrebuiltQueries(organization);
  122. const hasSearchQuery =
  123. typeof savedQuerySearchQuery === 'string' && savedQuerySearchQuery.length > 0;
  124. const needleSearch = hasSearchQuery ? savedQuerySearchQuery.toLowerCase() : '';
  125. const list = views.map((view, index) => {
  126. const eventView = EventView.fromNewQueryWithLocation(view, location);
  127. // if a search is performed on the list of queries, we filter
  128. // on the pre-built queries
  129. if (
  130. hasSearchQuery &&
  131. eventView.name &&
  132. !eventView.name.toLowerCase().includes(needleSearch)
  133. ) {
  134. return null;
  135. }
  136. const recentTimeline = t('Last ') + eventView.statsPeriod;
  137. const customTimeline =
  138. moment(eventView.start).format('MMM D, YYYY h:mm A') +
  139. ' - ' +
  140. moment(eventView.end).format('MMM D, YYYY h:mm A');
  141. const to = eventView.getResultsViewUrlTarget(organization.slug);
  142. const menuItems = [
  143. {
  144. key: 'add-to-dashboard',
  145. label: t('Add to Dashboard'),
  146. onAction: () =>
  147. handleAddQueryToDashboard({
  148. eventView,
  149. location,
  150. query: view,
  151. organization,
  152. yAxis: view?.yAxis,
  153. router,
  154. }),
  155. },
  156. ...(organization.features.includes('discover-query-builder-as-landing-page')
  157. ? [
  158. {
  159. key: 'set-as-default',
  160. label: t('Set as Default'),
  161. onAction: () => {
  162. handleUpdateHomepageQuery(api, organization, eventView.toNewQuery());
  163. trackAdvancedAnalyticsEvent('discover_v2.set_as_default', {
  164. organization,
  165. source: 'context-menu',
  166. type: 'prebuilt-query',
  167. });
  168. },
  169. },
  170. ]
  171. : []),
  172. ];
  173. return (
  174. <QueryCard
  175. key={`${index}-${eventView.name}`}
  176. to={to}
  177. title={eventView.name}
  178. subtitle={eventView.statsPeriod ? recentTimeline : customTimeline}
  179. queryDetail={eventView.query}
  180. createdBy={eventView.createdBy}
  181. renderGraph={() => (
  182. <MiniGraph
  183. location={location}
  184. eventView={eventView}
  185. organization={organization}
  186. referrer="api.discover.homepage.prebuilt"
  187. />
  188. )}
  189. onEventClick={() => {
  190. trackAdvancedAnalyticsEvent('discover_v2.prebuilt_query_click', {
  191. organization,
  192. query_name: eventView.name,
  193. });
  194. }}
  195. renderContextMenu={() => (
  196. <Feature organization={organization} features={['dashboards-edit']}>
  197. {({hasFeature}) => {
  198. return hasFeature && this.renderDropdownMenu(menuItems);
  199. }}
  200. </Feature>
  201. )}
  202. />
  203. );
  204. });
  205. return list;
  206. }
  207. renderSavedQueries() {
  208. const {api, savedQueries, location, organization, router} = this.props;
  209. if (!savedQueries || !Array.isArray(savedQueries) || savedQueries.length === 0) {
  210. return [];
  211. }
  212. return savedQueries.map((savedQuery, index) => {
  213. const eventView = EventView.fromSavedQuery(savedQuery);
  214. const recentTimeline = t('Last ') + eventView.statsPeriod;
  215. const customTimeline =
  216. moment(eventView.start).format('MMM D, YYYY h:mm A') +
  217. ' - ' +
  218. moment(eventView.end).format('MMM D, YYYY h:mm A');
  219. const to = eventView.getResultsViewShortUrlTarget(organization.slug);
  220. const dateStatus = <TimeSince date={savedQuery.dateUpdated} />;
  221. const referrer = `api.discover.${eventView.getDisplayMode()}-chart`;
  222. const menuItems = (canAddToDashboard: boolean): MenuItemProps[] => [
  223. ...(canAddToDashboard
  224. ? [
  225. {
  226. key: 'add-to-dashboard',
  227. label: t('Add to Dashboard'),
  228. onAction: () =>
  229. handleAddQueryToDashboard({
  230. eventView,
  231. location,
  232. query: savedQuery,
  233. organization,
  234. yAxis: savedQuery?.yAxis ?? eventView.yAxis,
  235. router,
  236. }),
  237. },
  238. ]
  239. : []),
  240. ...(organization.features.includes('discover-query-builder-as-landing-page')
  241. ? [
  242. {
  243. key: 'set-as-default',
  244. label: t('Set as Default'),
  245. onAction: () => {
  246. handleUpdateHomepageQuery(api, organization, eventView.toNewQuery());
  247. trackAdvancedAnalyticsEvent('discover_v2.set_as_default', {
  248. organization,
  249. source: 'context-menu',
  250. type: 'saved-query',
  251. });
  252. },
  253. },
  254. ]
  255. : []),
  256. {
  257. key: 'duplicate',
  258. label: t('Duplicate Query'),
  259. onAction: () =>
  260. this.handleDuplicateQuery(eventView, decodeList(savedQuery.yAxis)),
  261. },
  262. {
  263. key: 'delete',
  264. label: t('Delete Query'),
  265. priority: 'danger',
  266. onAction: () => this.handleDeleteQuery(eventView),
  267. },
  268. ];
  269. return (
  270. <QueryCard
  271. key={`${index}-${eventView.id}`}
  272. to={to}
  273. title={eventView.name}
  274. subtitle={eventView.statsPeriod ? recentTimeline : customTimeline}
  275. queryDetail={eventView.query}
  276. createdBy={eventView.createdBy}
  277. dateStatus={dateStatus}
  278. onEventClick={() => {
  279. trackAdvancedAnalyticsEvent('discover_v2.saved_query_click', {organization});
  280. }}
  281. renderGraph={() => (
  282. <MiniGraph
  283. location={location}
  284. eventView={eventView}
  285. organization={organization}
  286. referrer={referrer}
  287. yAxis={
  288. savedQuery.yAxis && savedQuery.yAxis.length
  289. ? savedQuery.yAxis
  290. : ['count()']
  291. }
  292. />
  293. )}
  294. renderContextMenu={() => (
  295. <Feature organization={organization} features={['dashboards-edit']}>
  296. {({hasFeature}) => this.renderDropdownMenu(menuItems(hasFeature))}
  297. </Feature>
  298. )}
  299. />
  300. );
  301. });
  302. }
  303. render() {
  304. const {pageLinks} = this.props;
  305. return (
  306. <Fragment>
  307. <QueryGrid>{this.renderQueries()}</QueryGrid>
  308. <PaginationRow
  309. pageLinks={pageLinks}
  310. onCursor={(cursor, path, query, direction) => {
  311. const offset = Number(cursor?.split(':')?.[1] ?? 0);
  312. const newQuery: Query & {cursor?: string} = {...query, cursor};
  313. const isPrevious = direction === -1;
  314. if (offset <= 0 && isPrevious) {
  315. delete newQuery.cursor;
  316. }
  317. browserHistory.push({
  318. pathname: path,
  319. query: newQuery,
  320. });
  321. }}
  322. />
  323. </Fragment>
  324. );
  325. }
  326. }
  327. const PaginationRow = styled(Pagination)`
  328. margin-bottom: 20px;
  329. `;
  330. const QueryGrid = styled('div')`
  331. display: grid;
  332. grid-template-columns: minmax(100px, 1fr);
  333. gap: ${space(2)};
  334. @media (min-width: ${p => p.theme.breakpoints.medium}) {
  335. grid-template-columns: repeat(2, minmax(100px, 1fr));
  336. }
  337. @media (min-width: ${p => p.theme.breakpoints.large}) {
  338. grid-template-columns: repeat(3, minmax(100px, 1fr));
  339. }
  340. `;
  341. const DropdownTrigger = styled(Button)`
  342. transform: translateX(${space(1)});
  343. `;
  344. const StyledEmptyStateWarning = styled(EmptyStateWarning)`
  345. grid-column: 1 / 4;
  346. `;
  347. export default withApi(QueryList);