detail.tsx 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. import React from 'react';
  2. import {browserHistory, PlainRoute, WithRouterProps} from 'react-router';
  3. import styled from '@emotion/styled';
  4. import isEqual from 'lodash/isEqual';
  5. import {
  6. createDashboard,
  7. deleteDashboard,
  8. updateDashboard,
  9. } from 'app/actionCreators/dashboards';
  10. import {addSuccessMessage} from 'app/actionCreators/indicator';
  11. import {Client} from 'app/api';
  12. import NotFound from 'app/components/errors/notFound';
  13. import LightWeightNoProjectMessage from 'app/components/lightWeightNoProjectMessage';
  14. import LoadingIndicator from 'app/components/loadingIndicator';
  15. import GlobalSelectionHeader from 'app/components/organizations/globalSelectionHeader';
  16. import {t} from 'app/locale';
  17. import {PageContent} from 'app/styles/organization';
  18. import space from 'app/styles/space';
  19. import {Organization} from 'app/types';
  20. import {trackAnalyticsEvent} from 'app/utils/analytics';
  21. import withApi from 'app/utils/withApi';
  22. import withOrganization from 'app/utils/withOrganization';
  23. import Controls from './controls';
  24. import Dashboard from './dashboard';
  25. import {DEFAULT_STATS_PERIOD, EMPTY_DASHBOARD} from './data';
  26. import OrgDashboards from './orgDashboards';
  27. import DashboardTitle from './title';
  28. import {DashboardDetails, DashboardState, Widget} from './types';
  29. import {cloneDashboard} from './utils';
  30. const UNSAVED_MESSAGE = t('You have unsaved changes, are you sure you want to leave?');
  31. type Props = {
  32. api: Client;
  33. organization: Organization;
  34. route: PlainRoute;
  35. } & WithRouterProps<{orgId: string; dashboardId: string}, {}>;
  36. type State = {
  37. dashboardState: DashboardState;
  38. modifiedDashboard: DashboardDetails | null;
  39. };
  40. class DashboardDetail extends React.Component<Props, State> {
  41. state: State = {
  42. dashboardState: 'view',
  43. modifiedDashboard: null,
  44. };
  45. componentDidMount() {
  46. const {route, router} = this.props;
  47. this.checkStateRoute();
  48. router.setRouteLeaveHook(route, this.onRouteLeave);
  49. window.addEventListener('beforeunload', this.onUnload);
  50. }
  51. componentWillUnmount() {
  52. window.removeEventListener('beforeunload', this.onUnload);
  53. }
  54. checkStateRoute() {
  55. if (this.isWidgetBuilderRouter && !this.isEditing) {
  56. const {router, organization, params} = this.props;
  57. const {dashboardId} = params;
  58. router.replace(`/organizations/${organization.slug}/dashboards/${dashboardId}/`);
  59. }
  60. }
  61. updateRouteAfterSavingWidget() {
  62. if (this.isWidgetBuilderRouter) {
  63. const {router, organization, params} = this.props;
  64. const {dashboardId} = params;
  65. router.replace(`/organizations/${organization.slug}/dashboards/${dashboardId}/`);
  66. }
  67. }
  68. get isEditing() {
  69. const {dashboardState} = this.state;
  70. return ['edit', 'create', 'pending_delete'].includes(dashboardState);
  71. }
  72. get isWidgetBuilderRouter() {
  73. const {location, params, organization} = this.props;
  74. const {dashboardId} = params;
  75. return (
  76. location.pathname ===
  77. `/organizations/${organization.slug}/dashboards/${dashboardId}/widget/new/`
  78. );
  79. }
  80. onEdit = (dashboard: State['modifiedDashboard']) => () => {
  81. if (!dashboard) {
  82. return;
  83. }
  84. trackAnalyticsEvent({
  85. eventKey: 'dashboards2.edit.start',
  86. eventName: 'Dashboards2: Edit start',
  87. organization_id: parseInt(this.props.organization.id, 10),
  88. });
  89. this.setState({
  90. dashboardState: 'edit',
  91. modifiedDashboard: cloneDashboard(dashboard),
  92. });
  93. };
  94. onRouteLeave = () => {
  95. if (!['view', 'pending_delete'].includes(this.state.dashboardState)) {
  96. return UNSAVED_MESSAGE;
  97. }
  98. return undefined;
  99. };
  100. onUnload = (event: BeforeUnloadEvent) => {
  101. if (['view', 'pending_delete'].includes(this.state.dashboardState)) {
  102. return;
  103. }
  104. event.preventDefault();
  105. event.returnValue = UNSAVED_MESSAGE;
  106. };
  107. onCreate = () => {
  108. trackAnalyticsEvent({
  109. eventKey: 'dashboards2.create.start',
  110. eventName: 'Dashboards2: Create start',
  111. organization_id: parseInt(this.props.organization.id, 10),
  112. });
  113. this.setState({
  114. dashboardState: 'create',
  115. modifiedDashboard: cloneDashboard(EMPTY_DASHBOARD),
  116. });
  117. };
  118. onCancel = () => {
  119. if (this.state.dashboardState === 'create') {
  120. trackAnalyticsEvent({
  121. eventKey: 'dashboards2.create.cancel',
  122. eventName: 'Dashboards2: Create cancel',
  123. organization_id: parseInt(this.props.organization.id, 10),
  124. });
  125. } else if (this.state.dashboardState === 'edit') {
  126. trackAnalyticsEvent({
  127. eventKey: 'dashboards2.edit.cancel',
  128. eventName: 'Dashboards2: Edit cancel',
  129. organization_id: parseInt(this.props.organization.id, 10),
  130. });
  131. }
  132. this.setState({
  133. dashboardState: 'view',
  134. modifiedDashboard: null,
  135. });
  136. };
  137. onDelete = (dashboard: State['modifiedDashboard']) => () => {
  138. const {api, organization, location} = this.props;
  139. if (!dashboard?.id) {
  140. return;
  141. }
  142. const previousDashboardState = this.state.dashboardState;
  143. this.setState(
  144. {
  145. dashboardState: 'pending_delete',
  146. },
  147. () => {
  148. trackAnalyticsEvent({
  149. eventKey: 'dashboards2.delete',
  150. eventName: 'Dashboards2: Delete',
  151. organization_id: parseInt(this.props.organization.id, 10),
  152. });
  153. deleteDashboard(api, organization.slug, dashboard.id)
  154. .then(() => {
  155. addSuccessMessage(t('Dashboard deleted'));
  156. browserHistory.replace({
  157. pathname: `/organizations/${organization.slug}/dashboards/`,
  158. query: {
  159. ...location.query,
  160. },
  161. });
  162. })
  163. .catch(() => {
  164. this.setState({
  165. dashboardState: previousDashboardState,
  166. });
  167. });
  168. }
  169. );
  170. };
  171. onCommit = ({
  172. dashboard,
  173. reloadData,
  174. }: {
  175. dashboard: State['modifiedDashboard'];
  176. reloadData: () => void;
  177. }) => () => {
  178. const {api, organization, location} = this.props;
  179. const {dashboardState, modifiedDashboard} = this.state;
  180. switch (dashboardState) {
  181. case 'create': {
  182. if (modifiedDashboard) {
  183. createDashboard(api, organization.slug, modifiedDashboard).then(
  184. (newDashboard: DashboardDetails) => {
  185. addSuccessMessage(t('Dashboard created'));
  186. trackAnalyticsEvent({
  187. eventKey: 'dashboards2.create.complete',
  188. eventName: 'Dashboards2: Create complete',
  189. organization_id: parseInt(organization.id, 10),
  190. });
  191. this.setState({
  192. dashboardState: 'view',
  193. modifiedDashboard: null,
  194. });
  195. // redirect to new dashboard
  196. browserHistory.replace({
  197. pathname: `/organizations/${organization.slug}/dashboards/${newDashboard.id}/`,
  198. query: {
  199. ...location.query,
  200. },
  201. });
  202. }
  203. );
  204. }
  205. break;
  206. }
  207. case 'edit': {
  208. if (modifiedDashboard) {
  209. // only update the dashboard if there are changes
  210. if (isEqual(dashboard, modifiedDashboard)) {
  211. this.setState({
  212. dashboardState: 'view',
  213. modifiedDashboard: null,
  214. });
  215. return;
  216. }
  217. updateDashboard(api, organization.slug, modifiedDashboard).then(
  218. (newDashboard: DashboardDetails) => {
  219. addSuccessMessage(t('Dashboard updated'));
  220. trackAnalyticsEvent({
  221. eventKey: 'dashboards2.edit.complete',
  222. eventName: 'Dashboards2: Edit complete',
  223. organization_id: parseInt(organization.id, 10),
  224. });
  225. this.setState({
  226. dashboardState: 'view',
  227. modifiedDashboard: null,
  228. });
  229. if (dashboard && newDashboard.id !== dashboard.id) {
  230. browserHistory.replace({
  231. pathname: `/organizations/${organization.slug}/dashboards/${newDashboard.id}/`,
  232. query: {
  233. ...location.query,
  234. },
  235. });
  236. return;
  237. }
  238. reloadData();
  239. }
  240. );
  241. return;
  242. }
  243. this.setState({
  244. dashboardState: 'view',
  245. modifiedDashboard: null,
  246. });
  247. break;
  248. }
  249. case 'view':
  250. default: {
  251. this.setState({
  252. dashboardState: 'view',
  253. modifiedDashboard: null,
  254. });
  255. break;
  256. }
  257. }
  258. };
  259. onWidgetChange = (widgets: Widget[]) => {
  260. const {modifiedDashboard} = this.state;
  261. if (modifiedDashboard === null) {
  262. return;
  263. }
  264. this.setState((prevState: State) => {
  265. return {
  266. ...prevState,
  267. modifiedDashboard: {
  268. ...prevState.modifiedDashboard!,
  269. widgets,
  270. },
  271. };
  272. });
  273. };
  274. setModifiedDashboard = (dashboard: DashboardDetails) => {
  275. this.setState({
  276. modifiedDashboard: dashboard,
  277. });
  278. };
  279. onSaveWidget = (widgets: Widget[]) => {
  280. const {modifiedDashboard} = this.state;
  281. if (modifiedDashboard === null) {
  282. return;
  283. }
  284. this.setState(
  285. (state: State) => ({
  286. ...state,
  287. modifiedDashboard: {
  288. ...state.modifiedDashboard!,
  289. widgets,
  290. },
  291. }),
  292. this.updateRouteAfterSavingWidget
  293. );
  294. };
  295. renderDetails({
  296. dashboard,
  297. dashboards,
  298. reloadData,
  299. error,
  300. }: Parameters<OrgDashboards['props']['children']>[0]) {
  301. const {organization, params} = this.props;
  302. const {modifiedDashboard, dashboardState} = this.state;
  303. const {dashboardId} = params;
  304. return (
  305. <GlobalSelectionHeader
  306. skipLoadLastUsed={organization.features.includes('global-views')}
  307. defaultSelection={{
  308. datetime: {
  309. start: null,
  310. end: null,
  311. utc: false,
  312. period: DEFAULT_STATS_PERIOD,
  313. },
  314. }}
  315. >
  316. <PageContent>
  317. <LightWeightNoProjectMessage organization={organization}>
  318. <StyledPageHeader>
  319. <DashboardTitle
  320. dashboard={modifiedDashboard || dashboard}
  321. onUpdate={this.setModifiedDashboard}
  322. isEditing={this.isEditing}
  323. />
  324. <Controls
  325. organization={organization}
  326. dashboards={dashboards}
  327. dashboard={dashboard}
  328. onEdit={this.onEdit(dashboard)}
  329. onCreate={this.onCreate}
  330. onCancel={this.onCancel}
  331. onCommit={this.onCommit({dashboard, reloadData})}
  332. onDelete={this.onDelete(dashboard)}
  333. dashboardState={dashboardState}
  334. />
  335. </StyledPageHeader>
  336. {error ? (
  337. <NotFound />
  338. ) : dashboard ? (
  339. <Dashboard
  340. dashboard={modifiedDashboard || dashboard}
  341. paramDashboardId={dashboardId}
  342. organization={organization}
  343. isEditing={this.isEditing}
  344. onUpdate={this.onWidgetChange}
  345. />
  346. ) : (
  347. <LoadingIndicator />
  348. )}
  349. </LightWeightNoProjectMessage>
  350. </PageContent>
  351. </GlobalSelectionHeader>
  352. );
  353. }
  354. renderWidgetBuilder(dashboard: DashboardDetails | null) {
  355. const {children} = this.props;
  356. const {modifiedDashboard} = this.state;
  357. return React.isValidElement(children)
  358. ? React.cloneElement(children, {
  359. dashboard: modifiedDashboard || dashboard,
  360. onSave: this.onSaveWidget,
  361. })
  362. : children;
  363. }
  364. render() {
  365. const {api, location, params, organization} = this.props;
  366. return (
  367. <OrgDashboards
  368. api={api}
  369. location={location}
  370. params={params}
  371. organization={organization}
  372. >
  373. {({dashboard, dashboards, error, reloadData}) => {
  374. if (this.isEditing && this.isWidgetBuilderRouter) {
  375. return this.renderWidgetBuilder(dashboard);
  376. }
  377. return this.renderDetails({dashboard, dashboards, error, reloadData});
  378. }}
  379. </OrgDashboards>
  380. );
  381. }
  382. }
  383. const StyledPageHeader = styled('div')`
  384. display: flex;
  385. align-items: center;
  386. justify-content: space-between;
  387. font-size: ${p => p.theme.headerFontSize};
  388. color: ${p => p.theme.textColor};
  389. height: 40px;
  390. margin-bottom: ${space(2)};
  391. @media (max-width: ${p => p.theme.breakpoints[2]}) {
  392. flex-direction: column;
  393. align-items: flex-start;
  394. height: auto;
  395. }
  396. `;
  397. export default withApi(withOrganization(DashboardDetail));