landing.tsx 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. import {browserHistory, RouteComponentProps} from 'react-router';
  2. import styled from '@emotion/styled';
  3. import isEqual from 'lodash/isEqual';
  4. import pick from 'lodash/pick';
  5. import {stringify} from 'query-string';
  6. import Feature from 'sentry/components/acl/feature';
  7. import Alert from 'sentry/components/alert';
  8. import GuideAnchor from 'sentry/components/assistant/guideAnchor';
  9. import AsyncComponent from 'sentry/components/asyncComponent';
  10. import Button from 'sentry/components/button';
  11. import DropdownControl, {DropdownItem} from 'sentry/components/dropdownControl';
  12. import {Title} from 'sentry/components/layouts/thirds';
  13. import NoProjectMessage from 'sentry/components/noProjectMessage';
  14. import SearchBar from 'sentry/components/searchBar';
  15. import SentryDocumentTitle from 'sentry/components/sentryDocumentTitle';
  16. import Switch from 'sentry/components/switchButton';
  17. import {t} from 'sentry/locale';
  18. import ConfigStore from 'sentry/stores/configStore';
  19. import {PageContent} from 'sentry/styles/organization';
  20. import space from 'sentry/styles/space';
  21. import {Organization, SavedQuery, SelectValue} from 'sentry/types';
  22. import {trackAnalyticsEvent} from 'sentry/utils/analytics';
  23. import EventView from 'sentry/utils/discover/eventView';
  24. import {decodeScalar} from 'sentry/utils/queryString';
  25. import withOrganization from 'sentry/utils/withOrganization';
  26. import Banner from './banner';
  27. import {DEFAULT_EVENT_VIEW} from './data';
  28. import QueryList from './queryList';
  29. import {getPrebuiltQueries, setRenderPrebuilt, shouldRenderPrebuilt} from './utils';
  30. const SORT_OPTIONS: SelectValue<string>[] = [
  31. {label: t('My Queries'), value: 'myqueries'},
  32. {label: t('Recently Edited'), value: '-dateUpdated'},
  33. {label: t('Query Name (A-Z)'), value: 'name'},
  34. {label: t('Date Created (Newest)'), value: '-dateCreated'},
  35. {label: t('Date Created (Oldest)'), value: 'dateCreated'},
  36. {label: t('Most Outdated'), value: 'dateUpdated'},
  37. {label: t('Most Popular'), value: 'mostPopular'},
  38. {label: t('Recently Viewed'), value: 'recentlyViewed'},
  39. ];
  40. type Props = {
  41. organization: Organization;
  42. } & RouteComponentProps<{}, {}> &
  43. AsyncComponent['props'];
  44. type State = {
  45. savedQueries: SavedQuery[] | null;
  46. savedQueriesPageLinks: string;
  47. } & AsyncComponent['state'];
  48. class DiscoverLanding extends AsyncComponent<Props, State> {
  49. state: State = {
  50. // AsyncComponent state
  51. loading: true,
  52. reloading: false,
  53. error: false,
  54. errors: {},
  55. // local component state
  56. renderPrebuilt: shouldRenderPrebuilt(),
  57. savedQueries: null,
  58. savedQueriesPageLinks: '',
  59. };
  60. shouldReload = true;
  61. getSavedQuerySearchQuery(): string {
  62. const {location} = this.props;
  63. return decodeScalar(location.query.query, '').trim();
  64. }
  65. getActiveSort() {
  66. const {location} = this.props;
  67. const urlSort = decodeScalar(location.query.sort, 'myqueries');
  68. return SORT_OPTIONS.find(item => item.value === urlSort) || SORT_OPTIONS[0];
  69. }
  70. getEndpoints(): ReturnType<AsyncComponent['getEndpoints']> {
  71. const {organization, location} = this.props;
  72. const views = getPrebuiltQueries(organization);
  73. const searchQuery = this.getSavedQuerySearchQuery();
  74. const cursor = decodeScalar(location.query.cursor);
  75. let perPage = 9;
  76. const canRenderPrebuilt = this.state
  77. ? this.state.renderPrebuilt
  78. : shouldRenderPrebuilt();
  79. if (!cursor && canRenderPrebuilt) {
  80. // invariant: we're on the first page
  81. if (searchQuery && searchQuery.length > 0) {
  82. const needleSearch = searchQuery.toLowerCase();
  83. const numOfPrebuiltQueries = views.reduce((sum, view) => {
  84. const eventView = EventView.fromNewQueryWithLocation(view, location);
  85. // if a search is performed on the list of queries, we filter
  86. // on the pre-built queries
  87. if (eventView.name && eventView.name.toLowerCase().includes(needleSearch)) {
  88. return sum + 1;
  89. }
  90. return sum;
  91. }, 0);
  92. perPage = Math.max(1, perPage - numOfPrebuiltQueries);
  93. } else {
  94. perPage = Math.max(1, perPage - views.length);
  95. }
  96. }
  97. const queryParams: Props['location']['query'] = {
  98. cursor,
  99. query: `version:2 name:"${searchQuery}"`,
  100. per_page: perPage.toString(),
  101. sortBy: this.getActiveSort().value,
  102. };
  103. if (!cursor) {
  104. delete queryParams.cursor;
  105. }
  106. return [
  107. [
  108. 'savedQueries',
  109. `/organizations/${organization.slug}/discover/saved/`,
  110. {
  111. query: queryParams,
  112. },
  113. ],
  114. ];
  115. }
  116. componentDidUpdate(prevProps: Props) {
  117. const PAYLOAD_KEYS = ['sort', 'cursor', 'query'] as const;
  118. const payloadKeysChanged = !isEqual(
  119. pick(prevProps.location.query, PAYLOAD_KEYS),
  120. pick(this.props.location.query, PAYLOAD_KEYS)
  121. );
  122. // if any of the query strings relevant for the payload has changed,
  123. // we re-fetch data
  124. if (payloadKeysChanged) {
  125. this.fetchData();
  126. }
  127. }
  128. handleQueryChange = () => {
  129. this.fetchData({reloading: true});
  130. };
  131. handleSearchQuery = (searchQuery: string) => {
  132. const {location} = this.props;
  133. browserHistory.push({
  134. pathname: location.pathname,
  135. query: {
  136. ...location.query,
  137. cursor: undefined,
  138. query: String(searchQuery).trim() || undefined,
  139. },
  140. });
  141. };
  142. handleSortChange = (value: string) => {
  143. const {location} = this.props;
  144. trackAnalyticsEvent({
  145. eventKey: 'discover_v2.change_sort',
  146. eventName: 'Discoverv2: Sort By Changed',
  147. organization_id: parseInt(this.props.organization.id, 10),
  148. sort: value,
  149. });
  150. browserHistory.push({
  151. pathname: location.pathname,
  152. query: {
  153. ...location.query,
  154. cursor: undefined,
  155. sort: value,
  156. },
  157. });
  158. };
  159. renderBanner() {
  160. const {location, organization} = this.props;
  161. const eventView = EventView.fromNewQueryWithLocation(DEFAULT_EVENT_VIEW, location);
  162. const to = eventView.getResultsViewUrlTarget(organization.slug);
  163. const resultsUrl = `${to.pathname}?${stringify(to.query)}`;
  164. return <Banner organization={organization} resultsUrl={resultsUrl} />;
  165. }
  166. renderActions() {
  167. const activeSort = this.getActiveSort();
  168. const {renderPrebuilt, savedQueries} = this.state;
  169. return (
  170. <StyledActions>
  171. <StyledSearchBar
  172. defaultQuery=""
  173. query={this.getSavedQuerySearchQuery()}
  174. placeholder={t('Search saved queries')}
  175. onSearch={this.handleSearchQuery}
  176. />
  177. <PrebuiltSwitch>
  178. <SwitchLabel>Show Prebuilt</SwitchLabel>
  179. <Switch
  180. isActive={renderPrebuilt}
  181. isDisabled={renderPrebuilt && (savedQueries ?? []).length === 0}
  182. size="lg"
  183. toggle={this.togglePrebuilt}
  184. />
  185. </PrebuiltSwitch>
  186. <DropdownControl buttonProps={{prefix: t('Sort By')}} label={activeSort.label}>
  187. {SORT_OPTIONS.map(({label, value}) => (
  188. <DropdownItem
  189. key={value}
  190. onSelect={this.handleSortChange}
  191. eventKey={value}
  192. isActive={value === activeSort.value}
  193. >
  194. {label}
  195. </DropdownItem>
  196. ))}
  197. </DropdownControl>
  198. </StyledActions>
  199. );
  200. }
  201. togglePrebuilt = () => {
  202. const {renderPrebuilt} = this.state;
  203. this.setState({renderPrebuilt: !renderPrebuilt}, () => {
  204. setRenderPrebuilt(!renderPrebuilt);
  205. this.fetchData({reloading: true});
  206. });
  207. };
  208. onGoLegacyDiscover = () => {
  209. localStorage.setItem('discover:version', '1');
  210. const user = ConfigStore.get('user');
  211. trackAnalyticsEvent({
  212. eventKey: 'discover_v2.opt_out',
  213. eventName: 'Discoverv2: Go to discover',
  214. organization_id: parseInt(this.props.organization.id, 10),
  215. user_id: parseInt(user.id, 10),
  216. });
  217. };
  218. renderNoAccess() {
  219. return (
  220. <PageContent>
  221. <Alert type="warning">{t("You don't have access to this feature")}</Alert>
  222. </PageContent>
  223. );
  224. }
  225. renderBody() {
  226. const {location, organization} = this.props;
  227. const {savedQueries, savedQueriesPageLinks, renderPrebuilt} = this.state;
  228. return (
  229. <QueryList
  230. pageLinks={savedQueriesPageLinks}
  231. savedQueries={savedQueries ?? []}
  232. savedQuerySearchQuery={this.getSavedQuerySearchQuery()}
  233. renderPrebuilt={renderPrebuilt}
  234. location={location}
  235. organization={organization}
  236. onQueryChange={this.handleQueryChange}
  237. />
  238. );
  239. }
  240. render() {
  241. const {location, organization} = this.props;
  242. const eventView = EventView.fromNewQueryWithLocation(DEFAULT_EVENT_VIEW, location);
  243. const to = eventView.getResultsViewUrlTarget(organization.slug);
  244. return (
  245. <Feature
  246. organization={organization}
  247. features={['discover-query']}
  248. renderDisabled={this.renderNoAccess}
  249. >
  250. <SentryDocumentTitle title={t('Discover')} orgSlug={organization.slug}>
  251. <StyledPageContent>
  252. <NoProjectMessage organization={organization}>
  253. <PageContent>
  254. <StyledPageHeader>
  255. <Title>
  256. <GuideAnchor target="discover_landing_header">
  257. {t('Discover')}
  258. </GuideAnchor>
  259. </Title>
  260. <StyledButton
  261. data-test-id="build-new-query"
  262. to={to}
  263. priority="primary"
  264. onClick={() => {
  265. trackAnalyticsEvent({
  266. eventKey: 'discover_v2.build_new_query',
  267. eventName: 'Discoverv2: Build a new Discover Query',
  268. organization_id: parseInt(this.props.organization.id, 10),
  269. });
  270. }}
  271. >
  272. {t('Build a new query')}
  273. </StyledButton>
  274. </StyledPageHeader>
  275. {this.renderBanner()}
  276. {this.renderActions()}
  277. {this.renderComponent()}
  278. </PageContent>
  279. </NoProjectMessage>
  280. </StyledPageContent>
  281. </SentryDocumentTitle>
  282. </Feature>
  283. );
  284. }
  285. }
  286. const StyledPageContent = styled(PageContent)`
  287. padding: 0;
  288. `;
  289. const PrebuiltSwitch = styled('div')`
  290. display: flex;
  291. `;
  292. const SwitchLabel = styled('div')`
  293. padding-right: 8px;
  294. `;
  295. const StyledPageHeader = styled('div')`
  296. display: flex;
  297. align-items: flex-end;
  298. font-size: ${p => p.theme.headerFontSize};
  299. color: ${p => p.theme.textColor};
  300. justify-content: space-between;
  301. margin-bottom: ${space(2)};
  302. `;
  303. const StyledSearchBar = styled(SearchBar)`
  304. flex-grow: 1;
  305. `;
  306. const StyledActions = styled('div')`
  307. display: grid;
  308. gap: ${space(2)};
  309. grid-template-columns: auto max-content min-content;
  310. align-items: center;
  311. margin-bottom: ${space(2)};
  312. @media (max-width: ${p => p.theme.breakpoints[0]}) {
  313. grid-template-columns: auto;
  314. }
  315. `;
  316. const StyledButton = styled(Button)`
  317. white-space: nowrap;
  318. `;
  319. export default withOrganization(DiscoverLanding);
  320. export {DiscoverLanding};