widgetBuilder.tsx 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216
  1. import {useEffect, useMemo, useState} from 'react';
  2. import {RouteComponentProps} from 'react-router';
  3. import styled from '@emotion/styled';
  4. import cloneDeep from 'lodash/cloneDeep';
  5. import isEmpty from 'lodash/isEmpty';
  6. import omit from 'lodash/omit';
  7. import set from 'lodash/set';
  8. import {validateWidget} from 'sentry/actionCreators/dashboards';
  9. import {addSuccessMessage} from 'sentry/actionCreators/indicator';
  10. import {fetchOrgMembers} from 'sentry/actionCreators/members';
  11. import {loadOrganizationTags} from 'sentry/actionCreators/tags';
  12. import DatePageFilter from 'sentry/components/datePageFilter';
  13. import EnvironmentPageFilter from 'sentry/components/environmentPageFilter';
  14. import * as Layout from 'sentry/components/layouts/thirds';
  15. import List from 'sentry/components/list';
  16. import ListItem from 'sentry/components/list/listItem';
  17. import LoadingError from 'sentry/components/loadingError';
  18. import PageFilterBar from 'sentry/components/organizations/pageFilterBar';
  19. import PageFiltersContainer from 'sentry/components/organizations/pageFilters/container';
  20. import ProjectPageFilter from 'sentry/components/projectPageFilter';
  21. import SentryDocumentTitle from 'sentry/components/sentryDocumentTitle';
  22. import {t} from 'sentry/locale';
  23. import {PageContent} from 'sentry/styles/organization';
  24. import space from 'sentry/styles/space';
  25. import {DateString, Organization, PageFilters, TagCollection} from 'sentry/types';
  26. import {defined, objectIsEmpty} from 'sentry/utils';
  27. import trackAdvancedAnalyticsEvent from 'sentry/utils/analytics/trackAdvancedAnalyticsEvent';
  28. import {CustomMeasurementsProvider} from 'sentry/utils/customMeasurements/customMeasurementsProvider';
  29. import EventView from 'sentry/utils/discover/eventView';
  30. import {
  31. explodeField,
  32. generateFieldAsString,
  33. getColumnsAndAggregates,
  34. getColumnsAndAggregatesAsStrings,
  35. QueryFieldValue,
  36. } from 'sentry/utils/discover/fields';
  37. import {MetricsCardinalityProvider} from 'sentry/utils/performance/contexts/metricsCardinality';
  38. import {MEPSettingProvider} from 'sentry/utils/performance/contexts/metricsEnhancedSetting';
  39. import useApi from 'sentry/utils/useApi';
  40. import withPageFilters from 'sentry/utils/withPageFilters';
  41. import withTags from 'sentry/utils/withTags';
  42. import {
  43. assignTempId,
  44. enforceWidgetHeightValues,
  45. generateWidgetsAfterCompaction,
  46. getDefaultWidgetHeight,
  47. } from 'sentry/views/dashboardsV2/layoutUtils';
  48. import {
  49. DashboardDetails,
  50. DashboardWidgetSource,
  51. DisplayType,
  52. Widget,
  53. WidgetQuery,
  54. WidgetType,
  55. } from 'sentry/views/dashboardsV2/types';
  56. import {MetricsDataSwitcher} from 'sentry/views/performance/landing/metricsDataSwitcher';
  57. import {DEFAULT_STATS_PERIOD} from '../data';
  58. import {getDatasetConfig} from '../datasetConfig/base';
  59. import {
  60. DashboardsMEPConsumer,
  61. DashboardsMEPProvider,
  62. } from '../widgetCard/dashboardsMEPContext';
  63. import {ColumnsStep} from './buildSteps/columnsStep';
  64. import {DataSetStep} from './buildSteps/dataSetStep';
  65. import {FilterResultsStep} from './buildSteps/filterResultsStep';
  66. import {GroupByStep} from './buildSteps/groupByStep';
  67. import {SortByStep} from './buildSteps/sortByStep';
  68. import {VisualizationStep} from './buildSteps/visualizationStep';
  69. import {YAxisStep} from './buildSteps/yAxisStep';
  70. import {Footer} from './footer';
  71. import {Header} from './header';
  72. import {
  73. DataSet,
  74. DEFAULT_RESULTS_LIMIT,
  75. generateOrderOptions,
  76. getIsTimeseriesChart,
  77. getParsedDefaultWidgetQuery,
  78. getResultsLimit,
  79. mapErrors,
  80. NEW_DASHBOARD_ID,
  81. normalizeQueries,
  82. } from './utils';
  83. import {WidgetLibrary} from './widgetLibrary';
  84. const WIDGET_TYPE_TO_DATA_SET = {
  85. [WidgetType.DISCOVER]: DataSet.EVENTS,
  86. [WidgetType.ISSUE]: DataSet.ISSUES,
  87. [WidgetType.RELEASE]: DataSet.RELEASES,
  88. };
  89. export const DATA_SET_TO_WIDGET_TYPE = {
  90. [DataSet.EVENTS]: WidgetType.DISCOVER,
  91. [DataSet.ISSUES]: WidgetType.ISSUE,
  92. [DataSet.RELEASES]: WidgetType.RELEASE,
  93. };
  94. interface RouteParams {
  95. dashboardId: string;
  96. orgId: string;
  97. widgetIndex?: string;
  98. }
  99. interface QueryData {
  100. queryConditions: string[];
  101. queryFields: string[];
  102. queryNames: string[];
  103. queryOrderby: string;
  104. }
  105. interface Props extends RouteComponentProps<RouteParams, {}> {
  106. dashboard: DashboardDetails;
  107. onSave: (widgets: Widget[]) => void;
  108. organization: Organization;
  109. selection: PageFilters;
  110. tags: TagCollection;
  111. displayType?: DisplayType;
  112. end?: DateString;
  113. start?: DateString;
  114. statsPeriod?: string | null;
  115. }
  116. interface State {
  117. dataSet: DataSet;
  118. displayType: Widget['displayType'];
  119. interval: Widget['interval'];
  120. limit: Widget['limit'];
  121. loading: boolean;
  122. prebuiltWidgetId: null | string;
  123. queries: Widget['queries'];
  124. queryConditionsValid: boolean;
  125. title: string;
  126. userHasModified: boolean;
  127. errors?: Record<string, any>;
  128. selectedDashboard?: DashboardDetails['id'];
  129. widgetToBeUpdated?: Widget;
  130. }
  131. function WidgetBuilder({
  132. dashboard,
  133. params,
  134. location,
  135. organization,
  136. selection,
  137. start,
  138. end,
  139. statsPeriod,
  140. onSave,
  141. route,
  142. router,
  143. tags,
  144. }: Props) {
  145. const {widgetIndex, orgId, dashboardId} = params;
  146. const {source, displayType, defaultTitle, limit} = location.query;
  147. const defaultWidgetQuery = getParsedDefaultWidgetQuery(
  148. location.query.defaultWidgetQuery
  149. );
  150. // defaultTableColumns can be a single string if location.query only contains
  151. // 1 value for this key. Ensure it is a string[]
  152. let {defaultTableColumns}: {defaultTableColumns: string[]} = location.query;
  153. if (typeof defaultTableColumns === 'string') {
  154. defaultTableColumns = [defaultTableColumns];
  155. }
  156. const isEditing = defined(widgetIndex);
  157. const widgetIndexNum = Number(widgetIndex);
  158. const isValidWidgetIndex =
  159. widgetIndexNum >= 0 &&
  160. widgetIndexNum < dashboard.widgets.length &&
  161. Number.isInteger(widgetIndexNum);
  162. const orgSlug = organization.slug;
  163. // Construct PageFilters object using statsPeriod/start/end props so we can
  164. // render widget graph using saved timeframe from Saved/Prebuilt Query
  165. const pageFilters: PageFilters = statsPeriod
  166. ? {...selection, datetime: {start: null, end: null, period: statsPeriod, utc: null}}
  167. : start && end
  168. ? {...selection, datetime: {start, end, period: null, utc: null}}
  169. : selection;
  170. // when opening from discover or issues page, the user selects the dashboard in the widget UI
  171. const notDashboardsOrigin = [
  172. DashboardWidgetSource.DISCOVERV2,
  173. DashboardWidgetSource.ISSUE_DETAILS,
  174. ].includes(source);
  175. const api = useApi();
  176. const [isSubmitting, setIsSubmitting] = useState(false);
  177. const [datasetConfig, setDataSetConfig] = useState<ReturnType<typeof getDatasetConfig>>(
  178. getDatasetConfig(WidgetType.DISCOVER)
  179. );
  180. const [state, setState] = useState<State>(() => {
  181. const defaultState: State = {
  182. title: defaultTitle ?? t('Custom Widget'),
  183. displayType:
  184. (displayType === DisplayType.TOP_N ? DisplayType.AREA : displayType) ??
  185. DisplayType.TABLE,
  186. interval: '5m',
  187. queries: [],
  188. limit: limit ? Number(limit) : undefined,
  189. errors: undefined,
  190. loading: !!notDashboardsOrigin,
  191. userHasModified: false,
  192. prebuiltWidgetId: null,
  193. dataSet: DataSet.EVENTS,
  194. queryConditionsValid: true,
  195. selectedDashboard: dashboard.id || NEW_DASHBOARD_ID,
  196. };
  197. if (defaultWidgetQuery) {
  198. defaultState.queries = [
  199. {
  200. ...defaultWidgetQuery,
  201. orderby:
  202. defaultWidgetQuery.orderby ||
  203. (datasetConfig.getTableSortOptions
  204. ? datasetConfig.getTableSortOptions(organization, defaultWidgetQuery)[0]
  205. .value
  206. : ''),
  207. },
  208. ];
  209. if (
  210. ![DisplayType.TABLE, DisplayType.TOP_N].includes(defaultState.displayType) &&
  211. !(
  212. getIsTimeseriesChart(defaultState.displayType) &&
  213. defaultState.queries[0].columns.length
  214. )
  215. ) {
  216. defaultState.queries[0].orderby = '';
  217. }
  218. } else {
  219. defaultState.queries = [{...datasetConfig.defaultWidgetQuery}];
  220. }
  221. return defaultState;
  222. });
  223. const [widgetToBeUpdated, setWidgetToBeUpdated] = useState<Widget | null>(null);
  224. // For analytics around widget library selection
  225. const [latestLibrarySelectionTitle, setLatestLibrarySelectionTitle] = useState<
  226. string | null
  227. >(null);
  228. useEffect(() => {
  229. trackAdvancedAnalyticsEvent('dashboards_views.widget_builder.opened', {
  230. organization,
  231. new_widget: !isEditing,
  232. });
  233. if (objectIsEmpty(tags)) {
  234. loadOrganizationTags(api, organization.slug, {
  235. ...selection,
  236. // Pin the request to 14d to avoid timeouts, see DD-967 for
  237. // more information
  238. datetime: {period: '14d', start: null, end: null, utc: null},
  239. });
  240. }
  241. if (isEditing && isValidWidgetIndex) {
  242. const widgetFromDashboard = dashboard.widgets[widgetIndexNum];
  243. let queries;
  244. let newDisplayType = widgetFromDashboard.displayType;
  245. let newLimit = widgetFromDashboard.limit;
  246. if (widgetFromDashboard.displayType === DisplayType.TOP_N) {
  247. newLimit = DEFAULT_RESULTS_LIMIT;
  248. newDisplayType = DisplayType.AREA;
  249. queries = normalizeQueries({
  250. displayType: newDisplayType,
  251. queries: widgetFromDashboard.queries,
  252. widgetType: widgetFromDashboard.widgetType ?? WidgetType.DISCOVER,
  253. }).map(query => ({
  254. ...query,
  255. // Use the last aggregate because that's where the y-axis is stored
  256. aggregates: query.aggregates.length
  257. ? [query.aggregates[query.aggregates.length - 1]]
  258. : [],
  259. }));
  260. } else {
  261. queries = normalizeQueries({
  262. displayType: newDisplayType,
  263. queries: widgetFromDashboard.queries,
  264. widgetType: widgetFromDashboard.widgetType ?? WidgetType.DISCOVER,
  265. });
  266. }
  267. setState({
  268. title: widgetFromDashboard.title,
  269. displayType: newDisplayType,
  270. interval: widgetFromDashboard.interval,
  271. queries,
  272. errors: undefined,
  273. loading: false,
  274. userHasModified: false,
  275. dataSet: widgetFromDashboard.widgetType
  276. ? WIDGET_TYPE_TO_DATA_SET[widgetFromDashboard.widgetType]
  277. : DataSet.EVENTS,
  278. limit: newLimit,
  279. prebuiltWidgetId: null,
  280. queryConditionsValid: true,
  281. });
  282. setDataSetConfig(getDatasetConfig(widgetFromDashboard.widgetType));
  283. setWidgetToBeUpdated(widgetFromDashboard);
  284. }
  285. // This should only run once on mount
  286. // eslint-disable-next-line react-hooks/exhaustive-deps
  287. }, []);
  288. useEffect(() => {
  289. fetchOrgMembers(api, organization.slug, selection.projects?.map(String));
  290. }, [selection.projects, api, organization.slug]);
  291. useEffect(() => {
  292. const onUnload = () => {
  293. if (!isSubmitting && state.userHasModified) {
  294. return t('You have unsaved changes, are you sure you want to leave?');
  295. }
  296. return undefined;
  297. };
  298. router.setRouteLeaveHook(route, onUnload);
  299. }, [isSubmitting, state.userHasModified, route, router]);
  300. const widgetType =
  301. state.dataSet === DataSet.EVENTS
  302. ? WidgetType.DISCOVER
  303. : state.dataSet === DataSet.ISSUES
  304. ? WidgetType.ISSUE
  305. : WidgetType.RELEASE;
  306. const currentWidget = {
  307. title: state.title,
  308. displayType: state.displayType,
  309. interval: state.interval,
  310. queries: state.queries,
  311. limit: state.limit,
  312. widgetType,
  313. };
  314. const currentDashboardId = state.selectedDashboard ?? dashboardId;
  315. const queryParamsWithoutSource = omit(location.query, 'source');
  316. const previousLocation = {
  317. pathname:
  318. defined(currentDashboardId) && currentDashboardId !== NEW_DASHBOARD_ID
  319. ? `/organizations/${orgId}/dashboard/${currentDashboardId}/`
  320. : `/organizations/${orgId}/dashboards/${NEW_DASHBOARD_ID}/`,
  321. query: isEmpty(queryParamsWithoutSource) ? undefined : queryParamsWithoutSource,
  322. };
  323. const isTimeseriesChart = getIsTimeseriesChart(state.displayType);
  324. const isTabularChart = [DisplayType.TABLE, DisplayType.TOP_N].includes(
  325. state.displayType
  326. );
  327. function updateFieldsAccordingToDisplayType(newDisplayType: DisplayType) {
  328. setState(prevState => {
  329. const newState = cloneDeep(prevState);
  330. if (!datasetConfig.supportedDisplayTypes.includes(newDisplayType)) {
  331. // Set to Events dataset if Display Type is not supported by
  332. // current dataset
  333. set(
  334. newState,
  335. 'queries',
  336. normalizeQueries({
  337. displayType: newDisplayType,
  338. queries: [{...getDatasetConfig(WidgetType.DISCOVER).defaultWidgetQuery}],
  339. widgetType: WidgetType.DISCOVER,
  340. })
  341. );
  342. set(newState, 'dataSet', DataSet.EVENTS);
  343. setDataSetConfig(getDatasetConfig(WidgetType.DISCOVER));
  344. return {...newState, errors: undefined};
  345. }
  346. const normalized = normalizeQueries({
  347. displayType: newDisplayType,
  348. queries: prevState.queries,
  349. widgetType: DATA_SET_TO_WIDGET_TYPE[prevState.dataSet],
  350. });
  351. if (newDisplayType === DisplayType.TOP_N) {
  352. // TOP N display should only allow a single query
  353. normalized.splice(1);
  354. }
  355. if (!prevState.userHasModified) {
  356. // Default widget provided by Add to Dashboard from Discover
  357. if (defaultWidgetQuery && defaultTableColumns) {
  358. // If switching to Table visualization, use saved query fields for Y-Axis if user has not made query changes
  359. // This is so the widget can reflect the same columns as the table in Discover without requiring additional user input
  360. if (newDisplayType === DisplayType.TABLE) {
  361. normalized.forEach(query => {
  362. const tableQuery = getColumnsAndAggregates(defaultTableColumns);
  363. query.columns = [...tableQuery.columns];
  364. query.aggregates = [...tableQuery.aggregates];
  365. query.fields = [...defaultTableColumns];
  366. query.orderby =
  367. defaultWidgetQuery.orderby ??
  368. (query.fields.length ? `${query.fields[0]}` : '-');
  369. });
  370. } else if (newDisplayType === displayType) {
  371. // When switching back to original display type, default fields back to the fields provided from the discover query
  372. normalized.forEach(query => {
  373. query.fields = [
  374. ...defaultWidgetQuery.columns,
  375. ...defaultWidgetQuery.aggregates,
  376. ];
  377. query.aggregates = [...defaultWidgetQuery.aggregates];
  378. query.columns = [...defaultWidgetQuery.columns];
  379. if (
  380. !!defaultWidgetQuery.orderby &&
  381. (displayType === DisplayType.TOP_N || defaultWidgetQuery.columns.length)
  382. ) {
  383. query.orderby = defaultWidgetQuery.orderby;
  384. }
  385. });
  386. }
  387. }
  388. }
  389. set(newState, 'queries', normalized);
  390. if (
  391. getIsTimeseriesChart(newDisplayType) &&
  392. normalized[0].columns.filter(column => !!column).length
  393. ) {
  394. // If a limit already exists (i.e. going between timeseries) then keep it,
  395. // otherwise calculate a limit
  396. newState.limit =
  397. prevState.limit ??
  398. Math.min(
  399. getResultsLimit(normalized.length, normalized[0].columns.length),
  400. DEFAULT_RESULTS_LIMIT
  401. );
  402. } else {
  403. newState.limit = undefined;
  404. }
  405. set(newState, 'userHasModified', true);
  406. return {...newState, errors: undefined};
  407. });
  408. }
  409. function getUpdateWidgetIndex() {
  410. if (!widgetToBeUpdated) {
  411. return -1;
  412. }
  413. return dashboard.widgets.findIndex(widget => {
  414. if (defined(widget.id)) {
  415. return widget.id === widgetToBeUpdated.id;
  416. }
  417. if (defined(widget.tempId)) {
  418. return widget.tempId === widgetToBeUpdated.tempId;
  419. }
  420. return false;
  421. });
  422. }
  423. function handleDisplayTypeOrTitleChange<
  424. F extends keyof Pick<State, 'displayType' | 'title'>
  425. >(field: F, value: State[F]) {
  426. trackAdvancedAnalyticsEvent('dashboards_views.widget_builder.change', {
  427. from: source,
  428. field,
  429. value,
  430. widget_type: widgetType,
  431. organization,
  432. new_widget: !isEditing,
  433. });
  434. setState(prevState => {
  435. const newState = cloneDeep(prevState);
  436. set(newState, field, value);
  437. if (field === 'title') {
  438. set(newState, 'userHasModified', true);
  439. }
  440. return {...newState, errors: undefined};
  441. });
  442. if (field === 'displayType' && value !== state.displayType) {
  443. updateFieldsAccordingToDisplayType(value as DisplayType);
  444. }
  445. }
  446. function handleDataSetChange(newDataSet: string) {
  447. trackAdvancedAnalyticsEvent('dashboards_views.widget_builder.change', {
  448. from: source,
  449. field: 'dataSet',
  450. value: newDataSet,
  451. widget_type: widgetType,
  452. organization,
  453. new_widget: !isEditing,
  454. });
  455. setState(prevState => {
  456. const newState = cloneDeep(prevState);
  457. newState.queries.splice(0, newState.queries.length);
  458. set(newState, 'dataSet', newDataSet);
  459. if (newDataSet === DataSet.ISSUES) {
  460. set(newState, 'displayType', DisplayType.TABLE);
  461. }
  462. const config = getDatasetConfig(DATA_SET_TO_WIDGET_TYPE[newDataSet]);
  463. setDataSetConfig(config);
  464. newState.queries.push(
  465. ...(widgetToBeUpdated?.widgetType &&
  466. WIDGET_TYPE_TO_DATA_SET[widgetToBeUpdated.widgetType] === newDataSet
  467. ? widgetToBeUpdated.queries
  468. : [{...config.defaultWidgetQuery}])
  469. );
  470. set(newState, 'userHasModified', true);
  471. return {...newState, errors: undefined};
  472. });
  473. }
  474. function handleAddSearchConditions() {
  475. setState(prevState => {
  476. const newState = cloneDeep(prevState);
  477. const config = getDatasetConfig(DATA_SET_TO_WIDGET_TYPE[prevState.dataSet]);
  478. const query = cloneDeep(config.defaultWidgetQuery);
  479. query.fields = prevState.queries[0].fields;
  480. query.aggregates = prevState.queries[0].aggregates;
  481. query.columns = prevState.queries[0].columns;
  482. query.orderby = prevState.queries[0].orderby;
  483. newState.queries.push(query);
  484. return newState;
  485. });
  486. }
  487. function handleQueryRemove(index: number) {
  488. setState(prevState => {
  489. const newState = cloneDeep(prevState);
  490. newState.queries.splice(index, 1);
  491. return {...newState, errors: undefined};
  492. });
  493. }
  494. function handleQueryChange(queryIndex: number, newQuery: WidgetQuery) {
  495. setState(prevState => {
  496. const newState = cloneDeep(prevState);
  497. set(newState, `queries.${queryIndex}`, newQuery);
  498. set(newState, 'userHasModified', true);
  499. return {...newState, errors: undefined};
  500. });
  501. }
  502. function getHandleColumnFieldChange(isMetricsData?: boolean) {
  503. function handleColumnFieldChange(newFields: QueryFieldValue[]) {
  504. const fieldStrings = newFields.map(generateFieldAsString);
  505. const splitFields = getColumnsAndAggregatesAsStrings(newFields);
  506. const newState = cloneDeep(state);
  507. let newQuery = cloneDeep(newState.queries[0]);
  508. newQuery.fields = fieldStrings;
  509. newQuery.aggregates = splitFields.aggregates;
  510. newQuery.columns = splitFields.columns;
  511. newQuery.fieldAliases = splitFields.fieldAliases;
  512. if (datasetConfig.handleColumnFieldChangeOverride) {
  513. newQuery = datasetConfig.handleColumnFieldChangeOverride(newQuery);
  514. }
  515. if (datasetConfig.handleOrderByReset) {
  516. // If widget is metric backed, don't default to sorting by transaction unless its the only column
  517. // Sorting by transaction is not supported in metrics
  518. if (
  519. isMetricsData &&
  520. fieldStrings.some(
  521. fieldString => !['transaction', 'title'].includes(fieldString)
  522. )
  523. ) {
  524. newQuery = datasetConfig.handleOrderByReset(
  525. newQuery,
  526. fieldStrings.filter(
  527. fieldString => !['transaction', 'title'].includes(fieldString)
  528. )
  529. );
  530. } else {
  531. newQuery = datasetConfig.handleOrderByReset(newQuery, fieldStrings);
  532. }
  533. }
  534. set(newState, 'queries', [newQuery]);
  535. set(newState, 'userHasModified', true);
  536. setState(newState);
  537. }
  538. return handleColumnFieldChange;
  539. }
  540. function handleYAxisChange(newFields: QueryFieldValue[]) {
  541. const fieldStrings = newFields.map(generateFieldAsString);
  542. const newState = cloneDeep(state);
  543. const newQueries = state.queries.map(query => {
  544. let newQuery = cloneDeep(query);
  545. if (state.displayType === DisplayType.TOP_N) {
  546. // Top N queries use n-1 fields for columns and the nth field for y-axis
  547. newQuery.fields = [
  548. ...(newQuery.fields?.slice(0, newQuery.fields.length - 1) ?? []),
  549. ...fieldStrings,
  550. ];
  551. newQuery.aggregates = [
  552. ...newQuery.aggregates.slice(0, newQuery.aggregates.length - 1),
  553. ...fieldStrings,
  554. ];
  555. } else {
  556. newQuery.fields = [...newQuery.columns, ...fieldStrings];
  557. newQuery.aggregates = fieldStrings;
  558. }
  559. if (datasetConfig.handleOrderByReset) {
  560. newQuery = datasetConfig.handleOrderByReset(newQuery, fieldStrings);
  561. }
  562. return newQuery;
  563. });
  564. set(newState, 'queries', newQueries);
  565. set(newState, 'userHasModified', true);
  566. const groupByFields = newState.queries[0].columns.filter(
  567. field => !(field === 'equation|')
  568. );
  569. if (groupByFields.length === 0) {
  570. set(newState, 'limit', undefined);
  571. } else {
  572. set(
  573. newState,
  574. 'limit',
  575. Math.min(
  576. newState.limit ?? DEFAULT_RESULTS_LIMIT,
  577. getResultsLimit(newQueries.length, newQueries[0].aggregates.length)
  578. )
  579. );
  580. }
  581. setState(newState);
  582. }
  583. function handleGroupByChange(newFields: QueryFieldValue[]) {
  584. const fieldStrings = newFields.map(generateFieldAsString);
  585. const newState = cloneDeep(state);
  586. const newQueries = state.queries.map(query => {
  587. const newQuery = cloneDeep(query);
  588. newQuery.columns = fieldStrings;
  589. if (!fieldStrings.length) {
  590. // The grouping was cleared, so clear the orderby
  591. newQuery.orderby = '';
  592. } else if (!newQuery.orderby) {
  593. const orderOptions = generateOrderOptions({
  594. widgetType: widgetType ?? WidgetType.DISCOVER,
  595. columns: query.columns,
  596. aggregates: query.aggregates,
  597. });
  598. let orderOption: string;
  599. // If no orderby options are available because of DISABLED_SORTS
  600. if (!orderOptions.length) {
  601. newQuery.orderby = '';
  602. } else {
  603. orderOption = orderOptions[0].value;
  604. newQuery.orderby = `-${orderOption}`;
  605. }
  606. }
  607. return newQuery;
  608. });
  609. set(newState, 'userHasModified', true);
  610. set(newState, 'queries', newQueries);
  611. const groupByFields = newState.queries[0].columns.filter(
  612. field => !(field === 'equation|')
  613. );
  614. if (groupByFields.length === 0) {
  615. set(newState, 'limit', undefined);
  616. } else {
  617. set(
  618. newState,
  619. 'limit',
  620. Math.min(
  621. newState.limit ?? DEFAULT_RESULTS_LIMIT,
  622. getResultsLimit(newQueries.length, newQueries[0].aggregates.length)
  623. )
  624. );
  625. }
  626. setState(newState);
  627. }
  628. function handleLimitChange(newLimit: number) {
  629. setState(prevState => ({...prevState, limit: newLimit}));
  630. }
  631. function handleSortByChange(newSortBy: string) {
  632. const newState = cloneDeep(state);
  633. state.queries.forEach((query, index) => {
  634. const newQuery = cloneDeep(query);
  635. newQuery.orderby = newSortBy;
  636. set(newState, `queries.${index}`, newQuery);
  637. });
  638. set(newState, 'userHasModified', true);
  639. setState(newState);
  640. }
  641. function handleDelete() {
  642. if (!isEditing) {
  643. return;
  644. }
  645. setIsSubmitting(true);
  646. let nextWidgetList = [...dashboard.widgets];
  647. const updateWidgetIndex = getUpdateWidgetIndex();
  648. nextWidgetList.splice(updateWidgetIndex, 1);
  649. nextWidgetList = generateWidgetsAfterCompaction(nextWidgetList);
  650. onSave(nextWidgetList);
  651. router.push(previousLocation);
  652. }
  653. async function handleSave() {
  654. const widgetData: Widget = assignTempId(currentWidget);
  655. if (widgetToBeUpdated) {
  656. widgetData.layout = widgetToBeUpdated?.layout;
  657. }
  658. // Only Time Series charts shall have a limit
  659. if (!isTimeseriesChart) {
  660. widgetData.limit = undefined;
  661. }
  662. if (!(await dataIsValid(widgetData))) {
  663. return;
  664. }
  665. if (latestLibrarySelectionTitle) {
  666. // User has selected a widget library in this session
  667. trackAdvancedAnalyticsEvent('dashboards_views.widget_library.add_widget', {
  668. organization,
  669. title: latestLibrarySelectionTitle,
  670. });
  671. }
  672. setIsSubmitting(true);
  673. if (notDashboardsOrigin) {
  674. submitFromSelectedDashboard(widgetData);
  675. return;
  676. }
  677. if (widgetToBeUpdated) {
  678. let nextWidgetList = [...dashboard.widgets];
  679. const updateWidgetIndex = getUpdateWidgetIndex();
  680. const nextWidgetData = {...widgetData, id: widgetToBeUpdated.id};
  681. // Only modify and re-compact if the default height has changed
  682. if (
  683. getDefaultWidgetHeight(widgetToBeUpdated.displayType) !==
  684. getDefaultWidgetHeight(widgetData.displayType)
  685. ) {
  686. nextWidgetList[updateWidgetIndex] = enforceWidgetHeightValues(nextWidgetData);
  687. nextWidgetList = generateWidgetsAfterCompaction(nextWidgetList);
  688. } else {
  689. nextWidgetList[updateWidgetIndex] = nextWidgetData;
  690. }
  691. onSave(nextWidgetList);
  692. addSuccessMessage(t('Updated widget.'));
  693. goToDashboards(dashboardId ?? NEW_DASHBOARD_ID);
  694. trackAdvancedAnalyticsEvent('dashboards_views.widget_builder.save', {
  695. organization,
  696. data_set: widgetData.widgetType ?? WidgetType.DISCOVER,
  697. new_widget: false,
  698. });
  699. return;
  700. }
  701. onSave([...dashboard.widgets, widgetData]);
  702. addSuccessMessage(t('Added widget.'));
  703. goToDashboards(dashboardId ?? NEW_DASHBOARD_ID);
  704. trackAdvancedAnalyticsEvent('dashboards_views.widget_builder.save', {
  705. organization,
  706. data_set: widgetData.widgetType ?? WidgetType.DISCOVER,
  707. new_widget: true,
  708. });
  709. }
  710. async function dataIsValid(widgetData: Widget): Promise<boolean> {
  711. setState({...state, loading: true});
  712. try {
  713. await validateWidget(api, organization.slug, widgetData);
  714. return true;
  715. } catch (error) {
  716. setState({
  717. ...state,
  718. loading: false,
  719. errors: {...state.errors, ...mapErrors(error?.responseJSON ?? {}, {})},
  720. });
  721. return false;
  722. }
  723. }
  724. function submitFromSelectedDashboard(widgetData: Widget) {
  725. if (!state.selectedDashboard) {
  726. return;
  727. }
  728. const queryData: QueryData = {
  729. queryNames: [],
  730. queryConditions: [],
  731. queryFields: [
  732. ...widgetData.queries[0].columns,
  733. ...widgetData.queries[0].aggregates,
  734. ],
  735. queryOrderby: widgetData.queries[0].orderby,
  736. };
  737. widgetData.queries.forEach(query => {
  738. queryData.queryNames.push(query.name);
  739. queryData.queryConditions.push(query.conditions);
  740. });
  741. const pathQuery = {
  742. displayType: widgetData.displayType,
  743. interval: widgetData.interval,
  744. title: widgetData.title,
  745. ...queryData,
  746. // Propagate page filters
  747. project: pageFilters.projects,
  748. environment: pageFilters.environments,
  749. ...omit(pageFilters.datetime, 'period'),
  750. statsPeriod: pageFilters.datetime?.period,
  751. };
  752. addSuccessMessage(t('Added widget.'));
  753. goToDashboards(state.selectedDashboard, pathQuery);
  754. }
  755. function goToDashboards(id: string, query?: Record<string, any>) {
  756. const pathQuery =
  757. !isEmpty(queryParamsWithoutSource) || query
  758. ? {
  759. ...queryParamsWithoutSource,
  760. ...query,
  761. }
  762. : undefined;
  763. if (id === NEW_DASHBOARD_ID) {
  764. router.push({
  765. pathname: `/organizations/${organization.slug}/dashboards/new/`,
  766. query: pathQuery,
  767. });
  768. return;
  769. }
  770. router.push({
  771. pathname: `/organizations/${organization.slug}/dashboard/${id}/`,
  772. query: pathQuery,
  773. });
  774. }
  775. function isFormInvalid() {
  776. if (
  777. (notDashboardsOrigin && !state.selectedDashboard) ||
  778. !state.queryConditionsValid
  779. ) {
  780. return true;
  781. }
  782. return false;
  783. }
  784. function setQueryConditionsValid(validSearch: boolean) {
  785. setState({...state, queryConditionsValid: validSearch});
  786. }
  787. const canAddSearchConditions =
  788. [DisplayType.LINE, DisplayType.AREA, DisplayType.BAR].includes(state.displayType) &&
  789. state.queries.length < 3;
  790. const hideLegendAlias = [
  791. DisplayType.TABLE,
  792. DisplayType.WORLD_MAP,
  793. DisplayType.BIG_NUMBER,
  794. ].includes(state.displayType);
  795. // Tabular visualizations will always have only one query and that query cannot be deleted,
  796. // so we will always have the first query available to get data from.
  797. const {columns, aggregates, fields, fieldAliases = []} = state.queries[0];
  798. const explodedColumns = useMemo(() => {
  799. return columns.map((field, index) =>
  800. explodeField({field, alias: fieldAliases[index]})
  801. );
  802. }, [columns, fieldAliases]);
  803. const explodedAggregates = useMemo(() => {
  804. return aggregates.map((field, index) =>
  805. explodeField({field, alias: fieldAliases[index]})
  806. );
  807. }, [aggregates, fieldAliases]);
  808. const explodedFields = defined(fields)
  809. ? fields.map((field, index) => explodeField({field, alias: fieldAliases[index]}))
  810. : [...explodedColumns, ...explodedAggregates];
  811. const groupByValueSelected = currentWidget.queries.some(query => {
  812. const noEmptyColumns = query.columns.filter(column => !!column);
  813. return noEmptyColumns.length > 0;
  814. });
  815. // The SortBy field shall only be displayed in tabular visualizations or
  816. // on time-series visualizations when at least one groupBy value is selected
  817. const displaySortByStep = (isTimeseriesChart && groupByValueSelected) || isTabularChart;
  818. if (isEditing && !isValidWidgetIndex) {
  819. return (
  820. <SentryDocumentTitle title={dashboard.title} orgSlug={orgSlug}>
  821. <PageContent>
  822. <LoadingError message={t('The widget you want to edit was not found.')} />
  823. </PageContent>
  824. </SentryDocumentTitle>
  825. );
  826. }
  827. return (
  828. <SentryDocumentTitle title={dashboard.title} orgSlug={orgSlug}>
  829. <PageFiltersContainer
  830. defaultSelection={{
  831. datetime: {start: null, end: null, utc: null, period: DEFAULT_STATS_PERIOD},
  832. }}
  833. >
  834. <CustomMeasurementsProvider organization={organization} selection={selection}>
  835. <DashboardsMEPProvider>
  836. <MetricsCardinalityProvider organization={organization} location={location}>
  837. <MetricsDataSwitcher
  838. organization={organization}
  839. eventView={EventView.fromLocation(location)}
  840. location={location}
  841. hideLoadingIndicator
  842. >
  843. {metricsDataSide => (
  844. <MEPSettingProvider
  845. location={location}
  846. forceTransactions={metricsDataSide.forceTransactionsOnly}
  847. >
  848. <PageContentWithoutPadding>
  849. <Header
  850. orgSlug={orgSlug}
  851. title={state.title}
  852. dashboardTitle={dashboard.title}
  853. goBackLocation={previousLocation}
  854. onChangeTitle={newTitle => {
  855. handleDisplayTypeOrTitleChange('title', newTitle);
  856. }}
  857. />
  858. <Body>
  859. <MainWrapper>
  860. <Main>
  861. {!organization.features.includes(
  862. 'dashboards-top-level-filter'
  863. ) && (
  864. <StyledPageFilterBar condensed>
  865. <ProjectPageFilter />
  866. <EnvironmentPageFilter />
  867. <DatePageFilter alignDropdown="left" />
  868. </StyledPageFilterBar>
  869. )}
  870. <BuildSteps symbol="colored-numeric">
  871. <VisualizationStep
  872. location={location}
  873. widget={currentWidget}
  874. dashboardFilters={dashboard.filters}
  875. organization={organization}
  876. pageFilters={pageFilters}
  877. displayType={state.displayType}
  878. error={state.errors?.displayType}
  879. onChange={newDisplayType => {
  880. handleDisplayTypeOrTitleChange(
  881. 'displayType',
  882. newDisplayType
  883. );
  884. }}
  885. noDashboardsMEPProvider
  886. isWidgetInvalid={!state.queryConditionsValid}
  887. />
  888. <DataSetStep
  889. dataSet={state.dataSet}
  890. displayType={state.displayType}
  891. onChange={handleDataSetChange}
  892. />
  893. {isTabularChart && (
  894. <DashboardsMEPConsumer>
  895. {({isMetricsData}) => (
  896. <ColumnsStep
  897. dataSet={state.dataSet}
  898. queries={state.queries}
  899. displayType={state.displayType}
  900. widgetType={widgetType}
  901. queryErrors={state.errors?.queries}
  902. onQueryChange={handleQueryChange}
  903. handleColumnFieldChange={getHandleColumnFieldChange(
  904. isMetricsData
  905. )}
  906. explodedFields={explodedFields}
  907. tags={tags}
  908. organization={organization}
  909. />
  910. )}
  911. </DashboardsMEPConsumer>
  912. )}
  913. {![DisplayType.TABLE].includes(state.displayType) && (
  914. <YAxisStep
  915. dataSet={state.dataSet}
  916. displayType={state.displayType}
  917. widgetType={widgetType}
  918. queryErrors={state.errors?.queries}
  919. onYAxisChange={newFields => {
  920. handleYAxisChange(newFields);
  921. }}
  922. aggregates={explodedAggregates}
  923. tags={tags}
  924. organization={organization}
  925. />
  926. )}
  927. <FilterResultsStep
  928. queries={state.queries}
  929. hideLegendAlias={hideLegendAlias}
  930. canAddSearchConditions={canAddSearchConditions}
  931. organization={organization}
  932. queryErrors={state.errors?.queries}
  933. onAddSearchConditions={handleAddSearchConditions}
  934. onQueryChange={handleQueryChange}
  935. onQueryRemove={handleQueryRemove}
  936. selection={pageFilters}
  937. widgetType={widgetType}
  938. dashboardFilters={dashboard.filters}
  939. location={location}
  940. onQueryConditionChange={setQueryConditionsValid}
  941. />
  942. {isTimeseriesChart && (
  943. <GroupByStep
  944. columns={columns
  945. .filter(field => !(field === 'equation|'))
  946. .map((field, index) =>
  947. explodeField({field, alias: fieldAliases[index]})
  948. )}
  949. onGroupByChange={handleGroupByChange}
  950. organization={organization}
  951. tags={tags}
  952. dataSet={state.dataSet}
  953. />
  954. )}
  955. {displaySortByStep && (
  956. <SortByStep
  957. limit={state.limit}
  958. displayType={state.displayType}
  959. queries={state.queries}
  960. dataSet={state.dataSet}
  961. error={state.errors?.orderby}
  962. onSortByChange={handleSortByChange}
  963. onLimitChange={handleLimitChange}
  964. organization={organization}
  965. widgetType={widgetType}
  966. tags={tags}
  967. />
  968. )}
  969. </BuildSteps>
  970. </Main>
  971. <Footer
  972. goBackLocation={previousLocation}
  973. isEditing={isEditing}
  974. onSave={handleSave}
  975. onDelete={handleDelete}
  976. invalidForm={isFormInvalid()}
  977. />
  978. </MainWrapper>
  979. <Side>
  980. <WidgetLibrary
  981. organization={organization}
  982. selectedWidgetId={
  983. state.userHasModified ? null : state.prebuiltWidgetId
  984. }
  985. onWidgetSelect={prebuiltWidget => {
  986. setLatestLibrarySelectionTitle(prebuiltWidget.title);
  987. setDataSetConfig(
  988. getDatasetConfig(
  989. prebuiltWidget.widgetType || WidgetType.DISCOVER
  990. )
  991. );
  992. const {id, ...prebuiltWidgetProps} = prebuiltWidget;
  993. setState({
  994. ...state,
  995. ...prebuiltWidgetProps,
  996. dataSet: prebuiltWidget.widgetType
  997. ? WIDGET_TYPE_TO_DATA_SET[prebuiltWidget.widgetType]
  998. : DataSet.EVENTS,
  999. userHasModified: false,
  1000. prebuiltWidgetId: id || null,
  1001. });
  1002. }}
  1003. bypassOverwriteModal={!state.userHasModified}
  1004. />
  1005. </Side>
  1006. </Body>
  1007. </PageContentWithoutPadding>
  1008. </MEPSettingProvider>
  1009. )}
  1010. </MetricsDataSwitcher>
  1011. </MetricsCardinalityProvider>
  1012. </DashboardsMEPProvider>
  1013. </CustomMeasurementsProvider>
  1014. </PageFiltersContainer>
  1015. </SentryDocumentTitle>
  1016. );
  1017. }
  1018. export default withPageFilters(withTags(WidgetBuilder));
  1019. const PageContentWithoutPadding = styled(PageContent)`
  1020. padding: 0;
  1021. `;
  1022. const StyledPageFilterBar = styled(PageFilterBar)`
  1023. margin-bottom: ${space(2)};
  1024. `;
  1025. const BuildSteps = styled(List)`
  1026. gap: ${space(4)};
  1027. max-width: 100%;
  1028. `;
  1029. const Body = styled(Layout.Body)`
  1030. && {
  1031. gap: 0;
  1032. padding: 0;
  1033. }
  1034. grid-template-rows: 1fr;
  1035. @media (min-width: ${p => p.theme.breakpoints.large}) {
  1036. grid-template-columns: minmax(100px, auto) 400px;
  1037. }
  1038. @media (min-width: ${p => p.theme.breakpoints.xlarge}) {
  1039. grid-template-columns: 1fr;
  1040. }
  1041. `;
  1042. // HACK: Since we add 30px of padding to the ListItems
  1043. // there is 30px of overlap when the screen is just above 1200px.
  1044. // When we're up to 1230px (1200 + 30 to account for the padding)
  1045. // we decrease the width of ListItems by 30px
  1046. const Main = styled(Layout.Main)`
  1047. max-width: 1000px;
  1048. flex: 1;
  1049. padding: ${space(4)} ${space(2)};
  1050. @media (min-width: ${p => p.theme.breakpoints.medium}) {
  1051. padding: ${space(4)};
  1052. }
  1053. @media (max-width: calc(${p => p.theme.breakpoints.large} + ${space(4)})) {
  1054. ${ListItem} {
  1055. width: calc(100% - ${space(4)});
  1056. }
  1057. }
  1058. `;
  1059. const Side = styled(Layout.Side)`
  1060. padding: ${space(4)} ${space(2)};
  1061. @media (max-width: ${p => p.theme.breakpoints.large}) {
  1062. border-top: 1px solid ${p => p.theme.gray200};
  1063. grid-row: 2/2;
  1064. grid-column: 1/-1;
  1065. max-width: 100%;
  1066. }
  1067. @media (min-width: ${p => p.theme.breakpoints.large}) {
  1068. border-left: 1px solid ${p => p.theme.gray200};
  1069. /* to be consistent with Layout.Body in other verticals */
  1070. padding-right: ${space(4)};
  1071. max-width: 400px;
  1072. }
  1073. `;
  1074. const MainWrapper = styled('div')`
  1075. display: flex;
  1076. flex-direction: column;
  1077. @media (max-width: ${p => p.theme.breakpoints.large}) {
  1078. grid-column: 1/-1;
  1079. }
  1080. `;