feat: improve initial period selection #64

The new implementation finds the first period, which includes all dirty fields. The list of periods is traversed in reverse order.

Author: abichinger

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "Vue.volar",
+    "vitest.explorer",
     "Vue.vscode-typescript-vue-plugin",
     "dbaeumer.vscode-eslint",
   ]

.vscode/settings.json

@@ -1,9 +1,9 @@
 {
     "editor.formatOnSave": false,
-    "jest.autoRun": "off",
     "eslint.enable": true,
     "editor.codeActionsOnSave": [
         "source.organizeImports",
         "source.fixAll.eslint"
-    ]
+    ],
+    "vitest.workspaceConfig": "vitest.workspace.ts"
 }

core/src/components/__tests__/cron-core.spec.ts

@@ -1,9 +1,15 @@
 import { describe, expect, it } from 'vitest'
 
-import type { CronFormat } from '@/types'
+import type { CronFormat, Period } from '@/types'
 import { mount } from '@vue/test-utils'
 import { defineComponent, nextTick } from 'vue'
-import { cronCoreProps, setupCron, useCron } from '../cron-core'
+import {
+  cronCoreProps,
+  DefaultCronOptions,
+  findFirstPeriod,
+  setupCron,
+  useCron,
+} from '../cron-core'
 
 type UseCronReturn = ReturnType<typeof useCron>
 
@@ -133,3 +139,49 @@ it('setupCron events', async () => {
   expect(wrapper.emitted('update:model-value')![0]).toEqual(['5 12 * * *'])
   expect(wrapper.emitted('update:period')![0]).toEqual(['month'])
 })
+
+describe('findFirstPeriod', () => {
+  const periods: Period[] = [
+    { id: 'week', value: ['dayOfWeek', 'hour', 'minute'] },
+    { id: 'month', value: ['day', 'hour', 'minute'] },
+    { id: 'day', value: ['hour', 'minute'] },
+  ].reverse()
+  const options = new DefaultCronOptions()
+  const fields = options.fields('crontab', 'en')
+  const qFields = options.fields('quartz', 'en')
+
+  const tests = [
+    {
+      cron: '0 2 * * 0', // Every Sunday at 02:00
+      expected: 'week',
+    },
+    {
+      cron: '0 * * * *', // Every hour
+      expected: 'day',
+    },
+    {
+      cron: '0 2 1 * *', // Every 1st of the month at 02:00
+      expected: 'month',
+    },
+    {
+      cron: '* * * 1 *', // Every minute in January
+      expected: undefined,
+    },
+    {
+      cron: '* 0 2 1 * ?',
+      fields: qFields,
+      expected: 'month',
+    },
+    {
+      cron: '* * * * *',
+      periods: options.periods('crontab').reverse(),
+      expected: 'year',
+    },
+  ]
+
+  for (const t of tests) {
+    it(t.cron, () => {
+      expect(findFirstPeriod(t.periods ?? periods, t.cron, t.fields ?? fields)?.id).toBe(t.expected)
+    })
+  }
+})

core/src/components/cron-core.ts

@@ -36,7 +36,7 @@ function isDefined<T>(obj: T | undefined): obj is T {
   return obj !== undefined
 }
 
-class DefaultCronOptions {
+export class DefaultCronOptions {
   locale = 'en'
 
   format: CronFormat = 'crontab'
@@ -117,6 +117,23 @@ class DefaultCronOptions {
   }
 }
 
+export function findFirstPeriod(
+  periods: Period[],
+  cron: string,
+  fields: Field[],
+): Period | undefined {
+  const segments = cron.split(' ')
+  if (segments.length !== fields.length) {
+    return
+  }
+  const dirtyFields = fields.filter((_, i) => !['*', '?'].includes(segments[i])).map((f) => f.id)
+  // find the first period, which includes all dirty fields
+  return periods.find((p) => {
+    const visible = new Set(p.value)
+    return dirtyFields.every((fid) => visible.has(fid))
+  })
+}
+
 export function useCron(options: CronOptions) {
   const cronDefaults = new DefaultCronOptions()
 
@@ -133,7 +150,9 @@ export function useCron(options: CronOptions) {
     }
   })
   const initialPeriod =
-    periods.find((p) => p.id == options.initialPeriod) ?? periods[periods.length - 1]
+    (options.initialPeriod ? periods.find((p) => p.id == options.initialPeriod) : undefined) ??
+    findFirstPeriod([...periods].reverse(), initialValue, fields) ??
+    periods[periods.length - 1]
 
   const cron = ref(initialValue)
   const error = ref('')