Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make cron validate x100 faster #306

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open

Make cron validate x100 faster #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a8cf9b
refactor: extract preset-to-option logic to separate function
albertodiazdorado Dec 20, 2024
1889970
feat: load presets on module load
albertodiazdorado Dec 10, 2024
9dd8933
feat: improve performance by adding a cache mechanism
albertodiazdorado Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@ import checkDaysOfMonth from './fieldCheckers/dayOfMonthChecker'
import checkMonths from './fieldCheckers/monthChecker'
import checkDaysOfWeek from './fieldCheckers/dayOfWeekChecker'
import checkYears from './fieldCheckers/yearChecker'
import {
getOptionPreset,
registerOptionPreset,
validateOptions,
} from './option'
import { validateOptions } from './option'
import { InputOptions, Options } from './types'

export interface CronData {
Expand Down
357 changes: 192 additions & 165 deletions src/option.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,197 @@ export const registerOptionPreset = (
recursive: true,
})
}
function loadPresets() {
for (let index = 0; index < presets.length; index += 1) {
const { name, preset } = presets[index];
registerOptionPreset(name, preset)
}
}
loadPresets();

type OptionsCacheKey = string;
const optionsCache: Map<OptionsCacheKey, Options> = new Map();

function toOptionsCacheKey(presetId: string, override?: InputOptions["override"]) {
return presetId + (JSON.stringify(override) ?? "");
}

function presetToOptionsSchema(preset: OptionPreset) {
return yup
.object({
presetId: yup.string().required(),
preset: optionPresetSchema.required(),
useSeconds: yup.boolean().required(),
useYears: yup.boolean().required(),
useAliases: yup.boolean(),
useBlankDay: yup.boolean().required(),
allowOnlyOneBlankDayField: yup.boolean().required(),
allowStepping: yup.boolean(),
mustHaveBlankDayField: yup.boolean(),
useLastDayOfMonth: yup.boolean(),
useLastDayOfWeek: yup.boolean(),
useNearestWeekday: yup.boolean(),
useNthWeekdayOfMonth: yup.boolean(),
seconds: yup
.object({
lowerLimit: yup
.number()
.min(preset.seconds.minValue)
.max(preset.seconds.maxValue),
upperLimit: yup
.number()
.min(preset.seconds.minValue)
.max(preset.seconds.maxValue),
})
.required(),
minutes: yup
.object({
lowerLimit: yup
.number()
.min(preset.minutes.minValue)
.max(preset.minutes.maxValue),
upperLimit: yup
.number()
.min(preset.minutes.minValue)
.max(preset.minutes.maxValue),
})
.required(),
hours: yup
.object({
lowerLimit: yup
.number()
.min(preset.hours.minValue)
.max(preset.hours.maxValue),
upperLimit: yup
.number()
.min(preset.hours.minValue)
.max(preset.hours.maxValue),
})
.required(),
daysOfMonth: yup
.object({
lowerLimit: yup
.number()
.min(preset.daysOfMonth.minValue)
.max(preset.daysOfMonth.maxValue),
upperLimit: yup
.number()
.min(preset.daysOfMonth.minValue)
.max(preset.daysOfMonth.maxValue),
})
.required(),
months: yup
.object({
lowerLimit: yup
.number()
.min(preset.months.minValue)
.max(preset.months.maxValue),
upperLimit: yup
.number()
.min(preset.months.minValue)
.max(preset.months.maxValue),
})
.required(),
daysOfWeek: yup
.object({
lowerLimit: yup
.number()
.min(preset.daysOfWeek.minValue)
.max(preset.daysOfWeek.maxValue),
upperLimit: yup
.number()
.min(preset.daysOfWeek.minValue)
.max(preset.daysOfWeek.maxValue),
})
.required(),
years: yup
.object({
lowerLimit: yup
.number()
.min(preset.years.minValue)
.max(preset.years.maxValue),
upperLimit: yup
.number()
.min(preset.years.minValue)
.max(preset.years.maxValue),
})
.required(),
})
.required()
}

function presetToOptions(preset: OptionPreset, override?: InputOptions["override"]) {

const unvalidatedConfig = {
presetId: preset.presetId,
preset,
...{
useSeconds: preset.useSeconds,
useYears: preset.useYears,
useAliases: preset.useAliases ?? false,
useBlankDay: preset.useBlankDay,
allowOnlyOneBlankDayField: preset.allowOnlyOneBlankDayField,
allowStepping: preset.allowStepping ?? true,
mustHaveBlankDayField: preset.mustHaveBlankDayField ?? false,
useLastDayOfMonth: preset.useLastDayOfMonth ?? false,
useLastDayOfWeek: preset.useLastDayOfWeek ?? false,
useNearestWeekday: preset.useNearestWeekday ?? false,
useNthWeekdayOfMonth: preset.useNthWeekdayOfMonth ?? false,
seconds: {
lowerLimit: preset.seconds.lowerLimit ?? preset.seconds.minValue,
upperLimit: preset.seconds.upperLimit ?? preset.seconds.maxValue,
},
minutes: {
lowerLimit: preset.minutes.lowerLimit ?? preset.minutes.minValue,
upperLimit: preset.minutes.upperLimit ?? preset.minutes.maxValue,
},
hours: {
lowerLimit: preset.hours.lowerLimit ?? preset.hours.minValue,
upperLimit: preset.hours.upperLimit ?? preset.hours.maxValue,
},
daysOfMonth: {
lowerLimit:
preset.daysOfMonth.lowerLimit ?? preset.daysOfMonth.minValue,
upperLimit:
preset.daysOfMonth.upperLimit ?? preset.daysOfMonth.maxValue,
},
months: {
lowerLimit: preset.months.lowerLimit ?? preset.months.minValue,
upperLimit: preset.months.upperLimit ?? preset.months.maxValue,
},
daysOfWeek: {
lowerLimit:
preset.daysOfWeek.lowerLimit ?? preset.daysOfWeek.minValue,
upperLimit:
preset.daysOfWeek.upperLimit ?? preset.daysOfWeek.maxValue,
},
years: {
lowerLimit: preset.years.lowerLimit ?? preset.years.minValue,
upperLimit: preset.years.upperLimit ?? preset.years.maxValue,
},
},
...override,
}

const optionsSchema = presetToOptionsSchema(preset);

const validatedConfig: Options = optionsSchema.validateSync(
unvalidatedConfig,
{
strict: false,
abortEarly: false,
stripUnknown: true,
recursive: true,
}
)

return validatedConfig
}

export const validateOptions = (
inputOptions: InputOptions
): Result<Options, string[]> => {
try {
// load default presets
presets()

let preset: OptionPreset
if (inputOptions.preset) {
if (typeof inputOptions.preset === 'string') {
Expand All @@ -173,170 +356,14 @@ export const validateOptions = (
preset = optionPresets.default
}

const unvalidatedConfig = {
presetId: preset.presetId,
preset,
...{
useSeconds: preset.useSeconds,
useYears: preset.useYears,
useAliases: preset.useAliases ?? false,
useBlankDay: preset.useBlankDay,
allowOnlyOneBlankDayField: preset.allowOnlyOneBlankDayField,
allowStepping: preset.allowStepping ?? true,
mustHaveBlankDayField: preset.mustHaveBlankDayField ?? false,
useLastDayOfMonth: preset.useLastDayOfMonth ?? false,
useLastDayOfWeek: preset.useLastDayOfWeek ?? false,
useNearestWeekday: preset.useNearestWeekday ?? false,
useNthWeekdayOfMonth: preset.useNthWeekdayOfMonth ?? false,
seconds: {
lowerLimit: preset.seconds.lowerLimit ?? preset.seconds.minValue,
upperLimit: preset.seconds.upperLimit ?? preset.seconds.maxValue,
},
minutes: {
lowerLimit: preset.minutes.lowerLimit ?? preset.minutes.minValue,
upperLimit: preset.minutes.upperLimit ?? preset.minutes.maxValue,
},
hours: {
lowerLimit: preset.hours.lowerLimit ?? preset.hours.minValue,
upperLimit: preset.hours.upperLimit ?? preset.hours.maxValue,
},
daysOfMonth: {
lowerLimit:
preset.daysOfMonth.lowerLimit ?? preset.daysOfMonth.minValue,
upperLimit:
preset.daysOfMonth.upperLimit ?? preset.daysOfMonth.maxValue,
},
months: {
lowerLimit: preset.months.lowerLimit ?? preset.months.minValue,
upperLimit: preset.months.upperLimit ?? preset.months.maxValue,
},
daysOfWeek: {
lowerLimit:
preset.daysOfWeek.lowerLimit ?? preset.daysOfWeek.minValue,
upperLimit:
preset.daysOfWeek.upperLimit ?? preset.daysOfWeek.maxValue,
},
years: {
lowerLimit: preset.years.lowerLimit ?? preset.years.minValue,
upperLimit: preset.years.upperLimit ?? preset.years.maxValue,
},
},
...inputOptions.override,
}
const cacheKey = toOptionsCacheKey(preset.presetId, inputOptions.override);

const optionsSchema = yup
.object({
presetId: yup.string().required(),
preset: optionPresetSchema.required(),
useSeconds: yup.boolean().required(),
useYears: yup.boolean().required(),
useAliases: yup.boolean(),
useBlankDay: yup.boolean().required(),
allowOnlyOneBlankDayField: yup.boolean().required(),
allowStepping: yup.boolean(),
mustHaveBlankDayField: yup.boolean(),
useLastDayOfMonth: yup.boolean(),
useLastDayOfWeek: yup.boolean(),
useNearestWeekday: yup.boolean(),
useNthWeekdayOfMonth: yup.boolean(),
seconds: yup
.object({
lowerLimit: yup
.number()
.min(preset.seconds.minValue)
.max(preset.seconds.maxValue),
upperLimit: yup
.number()
.min(preset.seconds.minValue)
.max(preset.seconds.maxValue),
})
.required(),
minutes: yup
.object({
lowerLimit: yup
.number()
.min(preset.minutes.minValue)
.max(preset.minutes.maxValue),
upperLimit: yup
.number()
.min(preset.minutes.minValue)
.max(preset.minutes.maxValue),
})
.required(),
hours: yup
.object({
lowerLimit: yup
.number()
.min(preset.hours.minValue)
.max(preset.hours.maxValue),
upperLimit: yup
.number()
.min(preset.hours.minValue)
.max(preset.hours.maxValue),
})
.required(),
daysOfMonth: yup
.object({
lowerLimit: yup
.number()
.min(preset.daysOfMonth.minValue)
.max(preset.daysOfMonth.maxValue),
upperLimit: yup
.number()
.min(preset.daysOfMonth.minValue)
.max(preset.daysOfMonth.maxValue),
})
.required(),
months: yup
.object({
lowerLimit: yup
.number()
.min(preset.months.minValue)
.max(preset.months.maxValue),
upperLimit: yup
.number()
.min(preset.months.minValue)
.max(preset.months.maxValue),
})
.required(),
daysOfWeek: yup
.object({
lowerLimit: yup
.number()
.min(preset.daysOfWeek.minValue)
.max(preset.daysOfWeek.maxValue),
upperLimit: yup
.number()
.min(preset.daysOfWeek.minValue)
.max(preset.daysOfWeek.maxValue),
})
.required(),
years: yup
.object({
lowerLimit: yup
.number()
.min(preset.years.minValue)
.max(preset.years.maxValue),
upperLimit: yup
.number()
.min(preset.years.minValue)
.max(preset.years.maxValue),
})
.required(),
})
.required()

const validatedConfig: Options = optionsSchema.validateSync(
unvalidatedConfig,
{
strict: false,
abortEarly: false,
stripUnknown: true,
recursive: true,
}
)
const cachedOptions = optionsCache.get(cacheKey);
if (cachedOptions) return valid(cachedOptions);

return valid(validatedConfig)
const options = presetToOptions(preset, inputOptions.override);
optionsCache.set(cacheKey, options);
return valid(options);
} catch (validationError) {
return err((validationError as ValidationError).errors)
}
Expand Down
Loading