monitorForm.tsx 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. import {Component, Fragment} from 'react';
  2. import styled from '@emotion/styled';
  3. import {Observer} from 'mobx-react';
  4. import FieldGroup from 'sentry/components/forms/fieldGroup';
  5. import NumberField from 'sentry/components/forms/fields/numberField';
  6. import SelectField from 'sentry/components/forms/fields/selectField';
  7. import SentryProjectSelectorField from 'sentry/components/forms/fields/sentryProjectSelectorField';
  8. import TextField from 'sentry/components/forms/fields/textField';
  9. import Form, {FormProps} from 'sentry/components/forms/form';
  10. import FormModel from 'sentry/components/forms/model';
  11. import ExternalLink from 'sentry/components/links/externalLink';
  12. import {Panel, PanelBody, PanelHeader} from 'sentry/components/panels';
  13. import TextCopyInput from 'sentry/components/textCopyInput';
  14. import {t, tct, tn} from 'sentry/locale';
  15. import {PageFilters, Project, SelectValue} from 'sentry/types';
  16. import commonTheme from 'sentry/utils/theme';
  17. import withPageFilters from 'sentry/utils/withPageFilters';
  18. import withProjects from 'sentry/utils/withProjects';
  19. import {Monitor, MonitorConfig, MonitorTypes, ScheduleType} from './types';
  20. const SCHEDULE_TYPES: SelectValue<ScheduleType>[] = [
  21. {value: 'crontab', label: 'Crontab'},
  22. {value: 'interval', label: 'Interval'},
  23. ];
  24. const DEFAULT_MONITOR_TYPE = 'cron_job';
  25. const getIntervals = (n: number): SelectValue<string>[] => [
  26. {value: 'minute', label: tn('minute', 'minutes', n)},
  27. {value: 'hour', label: tn('hour', 'hours', n)},
  28. {value: 'day', label: tn('day', 'days', n)},
  29. {value: 'week', label: tn('week', 'weeks', n)},
  30. {value: 'month', label: tn('month', 'months', n)},
  31. {value: 'year', label: tn('year', 'years', n)},
  32. ];
  33. type Props = {
  34. apiEndpoint: string;
  35. apiMethod: FormProps['apiMethod'];
  36. onSubmitSuccess: FormProps['onSubmitSuccess'];
  37. projects: Project[];
  38. selection: PageFilters;
  39. monitor?: Monitor;
  40. submitLabel?: string;
  41. };
  42. type TransformedData = {
  43. config?: Partial<MonitorConfig>;
  44. };
  45. function transformData(_data: Record<string, any>, model: FormModel) {
  46. return model.fields.toJSON().reduce<TransformedData>((data, [k, v]) => {
  47. if (k.indexOf('config.') !== 0) {
  48. data[k] = v;
  49. return data;
  50. }
  51. if (!data.config) {
  52. data.config = {};
  53. }
  54. if (k === 'config.schedule.frequency' || k === 'config.schedule.interval') {
  55. if (!Array.isArray(data.config.schedule)) {
  56. data.config.schedule = [null, null];
  57. }
  58. }
  59. if (k === 'config.schedule.frequency') {
  60. data.config!.schedule![0] = parseInt(v as string, 10);
  61. } else if (k === 'config.schedule.interval') {
  62. data.config!.schedule![1] = v;
  63. } else {
  64. data.config[k.substr(7)] = v;
  65. }
  66. return data;
  67. }, {});
  68. }
  69. class MonitorForm extends Component<Props> {
  70. form = new FormModel({transformData});
  71. formDataFromConfig(type: MonitorTypes, config: MonitorConfig) {
  72. const rv = {};
  73. switch (type) {
  74. case 'cron_job':
  75. rv['config.schedule_type'] = config.schedule_type;
  76. rv['config.checkin_margin'] = config.checkin_margin;
  77. rv['config.max_runtime'] = config.max_runtime;
  78. switch (config.schedule_type) {
  79. case 'interval':
  80. rv['config.schedule.frequency'] = config.schedule[0];
  81. rv['config.schedule.interval'] = config.schedule[1];
  82. break;
  83. case 'crontab':
  84. default:
  85. rv['config.schedule'] = config.schedule;
  86. }
  87. break;
  88. default:
  89. }
  90. return rv;
  91. }
  92. render() {
  93. const {monitor, submitLabel} = this.props;
  94. const selectedProjectId = this.props.selection.projects[0];
  95. const selectedProject = selectedProjectId
  96. ? this.props.projects.find(p => p.id === selectedProjectId + '')
  97. : null;
  98. return (
  99. <Form
  100. allowUndo
  101. requireChanges
  102. apiEndpoint={this.props.apiEndpoint}
  103. apiMethod={this.props.apiMethod}
  104. model={this.form}
  105. initialData={
  106. monitor
  107. ? {
  108. name: monitor.name,
  109. type: monitor.type ?? DEFAULT_MONITOR_TYPE,
  110. project: monitor.project.slug,
  111. ...this.formDataFromConfig(monitor.type, monitor.config),
  112. }
  113. : {
  114. project: selectedProject ? selectedProject.slug : null,
  115. type: DEFAULT_MONITOR_TYPE,
  116. }
  117. }
  118. onSubmitSuccess={this.props.onSubmitSuccess}
  119. submitLabel={submitLabel}
  120. >
  121. <Panel>
  122. <PanelHeader>{t('Details')}</PanelHeader>
  123. <PanelBody>
  124. {monitor && (
  125. <FieldGroup label={t('ID')}>
  126. <div className="controls">
  127. <TextCopyInput>{monitor.id}</TextCopyInput>
  128. </div>
  129. </FieldGroup>
  130. )}
  131. <SentryProjectSelectorField
  132. name="project"
  133. label={t('Project')}
  134. projects={this.props.projects.filter(project => project.isMember)}
  135. valueIsSlug
  136. help={t(
  137. "Select the project which contains the recurring job you'd like to monitor."
  138. )}
  139. required
  140. />
  141. <TextField
  142. name="name"
  143. placeholder={t('My Cron Job')}
  144. label={t('Name your cron monitor')}
  145. required
  146. />
  147. </PanelBody>
  148. </Panel>
  149. <Panel>
  150. <PanelHeader>{t('Config')}</PanelHeader>
  151. <PanelBody>
  152. <NumberField
  153. name="config.max_runtime"
  154. label={t('Max Runtime')}
  155. help={t(
  156. "Set the number of minutes a recurring job is allowed to run before it's considered failed"
  157. )}
  158. placeholder="e.g. 30"
  159. />
  160. <SelectField
  161. name="config.schedule_type"
  162. label={t('Schedule Type')}
  163. options={SCHEDULE_TYPES}
  164. required
  165. />
  166. <Observer>
  167. {() => {
  168. switch (this.form.getValue('config.schedule_type')) {
  169. case 'crontab':
  170. return (
  171. <Fragment>
  172. <TextField
  173. name="config.schedule"
  174. label={t('Schedule')}
  175. placeholder="*/5 * * * *"
  176. required
  177. help={tct(
  178. 'Any schedule changes will be applied to the next check-in. See [link:Wikipedia] for crontab syntax.',
  179. {
  180. link: (
  181. <ExternalLink href="https://en.wikipedia.org/wiki/Cron" />
  182. ),
  183. }
  184. )}
  185. css={{input: {fontFamily: commonTheme.text.familyMono}}}
  186. />
  187. <NumberField
  188. name="config.checkin_margin"
  189. label={t('Check-in Margin')}
  190. help={t(
  191. "The max error margin (in minutes) before a check-in is considered missed. If you don't expect your job to start immediately at the scheduled time, expand this margin to account for delays."
  192. )}
  193. placeholder="e.g. 30"
  194. />
  195. </Fragment>
  196. );
  197. case 'interval':
  198. return (
  199. <Fragment>
  200. <CombinedField>
  201. <FieldGroup
  202. label={t('Frequency')}
  203. help={t(
  204. 'The amount of time between each job execution. Example, every 5 hours.'
  205. )}
  206. stacked
  207. required
  208. />
  209. <StyledNumberField
  210. name="config.schedule.frequency"
  211. label={t('Frequency')}
  212. placeholder="e.g. 1"
  213. hideLabel
  214. required
  215. />
  216. <StyledSelectField
  217. name="config.schedule.interval"
  218. label={t('Interval')}
  219. options={getIntervals(
  220. Number(this.form.getValue('config.schedule.frequency') ?? 1)
  221. )}
  222. hideLabel
  223. required
  224. />
  225. </CombinedField>
  226. <NumberField
  227. name="config.checkin_margin"
  228. label={t('Check-in Margin')}
  229. help={t(
  230. "The max error margin (in minutes) before a check-in is considered missed. If you don't expect your job to start immediately at the scheduled time, expand this margin to account for delays."
  231. )}
  232. placeholder="e.g. 30"
  233. />
  234. </Fragment>
  235. );
  236. default:
  237. return null;
  238. }
  239. }}
  240. </Observer>
  241. </PanelBody>
  242. </Panel>
  243. </Form>
  244. );
  245. }
  246. }
  247. const CombinedField = styled('div')`
  248. display: grid;
  249. grid-template-columns: 50% 1fr 1fr;
  250. align-items: center;
  251. border-bottom: 1px solid ${p => p.theme.innerBorder};
  252. `;
  253. const StyledNumberField = styled(NumberField)`
  254. padding: 0;
  255. border-bottom: none;
  256. `;
  257. const StyledSelectField = styled(SelectField)`
  258. padding-left: 0;
  259. `;
  260. export default withPageFilters(withProjects(MonitorForm));