Background
Apache DolphinScheduler's Timing Task Configuration uses a 7-position Crontab expression, corresponding to seconds, minutes, hours, day of the month, month, day of the week, and year.
In the daily development work of our team, the timing scheduling of workflows generally does not need to be detailed to the second level. However, there have been historical incidents of misconfiguration that led to failure times, such as workflows that should be executed every minute being mistakenly configured to execute every second, resulting in a large number of workflow instances being generated in a short period of time, affecting the availability of the Apache DolphinScheduler service and the Hadoop cluster where tasks are submitted.
Based on this, the team decided to restrict the Crontab expression in the timing task configuration module of DolphinScheduler, to prevent such incidents from happening at the platform level.
Solution
Our solution is to restrict the first position of the Crontab expression from both the front and back ends:
- The front end configuration does not provide the "every second" option
- The server-side interface returns an error when the first position is *
Front-end modification
In the front-end project, seconds, minutes, and hours are all unified templates (CrontabTime), so a new file is added: dolphinscheduler-ui/src/components/crontab/modules/second.tsx
Only two modes are retained: intervalTime and specificTime
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import _ from 'lodash'
import { defineComponent, onMounted, PropType, ref, toRefs, watch } from 'vue'
import { NInputNumber, NRadio, NRadioGroup, NSelect } from 'naive-ui'
import { useI18n } from 'vue-i18n'
import { ICrontabI18n } from '../types'
import { isStr, specificList } from '../common'
import styles from '../index.module.scss'
const props = {
timeMin: {
type: Number as PropType<number>,
default: 0
},
timeMax: {
type: Number as PropType<number>,
default: 60
},
intervalPerform: {
type: Number as PropType<number>,
default: 5
},
intervalStart: {
type: Number as PropType<number>,
default: 3
},
timeSpecial: {
type: Number as PropType<number | string>,
default: 60
},
timeValue: {
type: String as PropType<string>,
default: '*'
},
timeI18n: {
type: Object as PropType<ICrontabI18n>,
require: true
}
}
export default defineComponent({
name: 'CrontabSecond',
props,
emits: ['update:timeValue'],
setup(props, ctx) {
const options = Array.from({ length: 60 }, (x, i) => ({
label: i.toString(),
value: i
}))
const timeRef = ref()
const radioRef = ref()
const intervalStartRef = ref(props.intervalStart)
const intervalPerformRef = ref(props.intervalPerform)
const specificTimesRef = ref<Array<number>>([])
/**
* Parse parameter value
*/
const analyticalValue = () => {
const $timeVal = props.timeValue
// Interval time
const $interval = isStr($timeVal, '/')
// Specific time
const $specific = isStr($timeVal, ',')
// Positive integer (times)
if (
($timeVal.length === 1 ||
$timeVal.length === 2 ||
$timeVal.length === 4) &&
_.isInteger(parseInt($timeVal))
) {
radioRef.value = 'specificTime'
specificTimesRef.value = [parseInt($timeVal)]
return
}
// Interval times
if ($interval) {
radioRef.value = 'intervalTime'
intervalStartRef.value = parseInt($interval[0])
intervalPerformRef.value = parseInt($interval[1])
timeRef.value = `${intervalStartRef.value}/${intervalPerformRef.value}`
return
}
// Specific times
if ($specific) {
radioRef.value = 'specificTime'
specificTimesRef.value = $specific.map((item) => parseInt(item))
return
}
}
// Interval start time（1）
const onIntervalStart = (value: number | null) => {
intervalStartRef.value = value || 0
if (radioRef.value === 'intervalTime') {
timeRef.value = `${intervalStartRef.value}/${intervalPerformRef.value}`
}
}
// Interval execution time（2）
const onIntervalPerform = (value: number | null) => {
intervalPerformRef.value = value || 0
if (radioRef.value === 'intervalTime') {
timeRef.value = `${intervalStartRef.value}/${intervalPerformRef.value}`
}
}
// Specific time
const onSpecificTimes = (arr: Array<number>) => {
specificTimesRef.value = arr
if (radioRef.value === 'specificTime') {
specificReset()
}
}
// Reset interval time
const intervalReset = () => {
timeRef.value = `${intervalStartRef.value}/${intervalPerformRef.value}`
}
// Reset specific time
const specificReset = () => {
let timeValue = '0'
if (specificTimesRef.value.length) {
timeValue = specificTimesRef.value.join(',')
}
timeRef.value = timeValue
}
const updateRadioTime = (value: string) => {
switch (value) {
case 'intervalTime':
intervalReset()
break
case 'specificTime':
specificReset()
break
}
}
watch(
() => timeRef.value,
() => ctx.emit('update:timeValue', timeRef.value.toString())
)
onMounted(() => analyticalValue())
return {
options,
radioRef,
intervalStartRef,
intervalPerformRef,
specificTimesRef,
updateRadioTime,
onIntervalStart,
onIntervalPerform,
onSpecificTimes,
...toRefs(props)
}
},
render() {
const { t } = useI18n()
return (
<NRadioGroup
v-model:value={this.radioRef}
onUpdateValue={this.updateRadioTime}
>
<div class={styles['crontab-list']}>
<NRadio value={'intervalTime'} />
<div class={styles['crontab-list-item']}>
<div class={styles['item-text']}>{t(this.timeI18n!.every)}</div>
<div class={styles['number-input']}>
<NInputNumber
defaultValue={5}
min={this.timeMin}
max={this.timeMax}
v-model:value={this.intervalPerformRef}
onUpdateValue={this.onIntervalPerform}
/>
</div>
<div class={styles['item-text']}>
{t(this.timeI18n!.timeCarriedOut)}
</div>
<div class={styles['number-input']}>
<NInputNumber
defaultValue={3}
min={this.timeMin}
max={this.timeMax}
v-model:value={this.intervalStartRef}
onUpdateValue={this.onIntervalStart}
/>
</div>
<div class={styles['item-text']}>{t(this.timeI18n!.timeStart)}</div>
</div>
</div>
<div class={styles['crontab-list']}>
<NRadio value={'specificTime'} />
<div class={styles['crontab-list-item']}>
<div>{t(this.timeI18n!.specificTime)}</div>
<div class={styles['select-input']}>
<NSelect
multiple
options={specificList[this.timeSpecial]}
placeholder={t(this.timeI18n!.specificTimeTip)}
v-model:value={this.specificTimesRef}
onUpdateValue={this.onSpecificTimes}
/>
</div>
</div>
</div>
</NRadioGroup>
)
}
})
Server-side
Add Crontab expression validation (there are two places: one is the new POST interface, and the other is the modified PUT interface), directly add a validation method for these two places to call:
if (scheduleParam.getCrontab().startsWith("*")) {
logger.error("The crontab must not start with *");
putMsg(result, Status.CRONTAB_EVERY_SECOND_ERROR);
return result;
}
This concludes the article.
Top comments (0)