From 3915d25d8447ade405f473edba3a7c77c06bb636 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 7 Nov 2025 22:30:54 -0500 Subject: [PATCH 1/4] refactor: rename cron entry to cron task This naming better suits what it is we are fetching. --- docs/appendices/0.23.0-migration-guide.md | 2 +- docs/development/plugin-triggers.md | 4 +-- docs/processes/scheduled-cron-tasks.md | 6 ++-- plugins/cron/cron.go | 12 +++---- plugins/cron/report.go | 2 +- plugins/cron/subcommands.go | 20 +++++------ plugins/cron/templates/cron.tmpl | 4 +-- plugins/cron/triggers.go | 4 +-- plugins/scheduler-docker-local/functions.go | 10 +++--- plugins/scheduler-docker-local/triggers.go | 2 +- plugins/scheduler-k3s/triggers.go | 40 ++++++++++----------- 11 files changed, 53 insertions(+), 53 deletions(-) diff --git a/docs/appendices/0.23.0-migration-guide.md b/docs/appendices/0.23.0-migration-guide.md index b46cb8bc4..2853eafde 100644 --- a/docs/appendices/0.23.0-migration-guide.md +++ b/docs/appendices/0.23.0-migration-guide.md @@ -4,5 +4,5 @@ - The `plugin:list` command no longer outputs the version for the `plugn` binary. - Users building docker images that run Dokku will need to use a new sudoer wrapper for the `docker-image-labeler` binary to work correctly. A reference version has been placed in the `docker` skeleton directory. This should only impact platform developers, and users of our Docker image will already have the file available. -- The `dokku` user's cron is now in use by Dokku itself. Customizations will be overwritten. Users are encouraged to use a cron entry in `/etc/cron.d/dokku` to avoid this issue. +- The `dokku` user's cron is now in use by Dokku itself. Customizations will be overwritten. Users are encouraged to use a cron file at `/etc/cron.d/dokku` to avoid this issue. - As of 0.23.0, Dokku will now inject the `max-size` log driver option for applications. This is restricted to app-configured log driver values empty, `local` or `json-file` in 0.23.1 to increase setup compatibility. Users who configure alternative log drivers at the system level will need to either set the global `max-size` property to `unlimited` or switch to the built-in `vector` logging support. diff --git a/docs/development/plugin-triggers.md b/docs/development/plugin-triggers.md index 43bbab731..1d202951c 100644 --- a/docs/development/plugin-triggers.md +++ b/docs/development/plugin-triggers.md @@ -582,7 +582,7 @@ APP="$1"; PROPERTY="$2" ### `cron-entries` -- Description: Allows injecting cron entries into the written out scheduled cron task list. Each entry is newline delimited, and individual entries come in the form `$SCHEDULE;$FULL_COMMAND;$ARBITRARY_DATA`. Individual implementations of cron writing can decide whether and how to include these cron entries. The `ARBITRARY_DATA` includes the log file path for the basic `docker-local` cron implementation. +- Description: Allows injecting cron tasks into the written out scheduled cron task list. Each entry is newline delimited, and individual tasks come in the form `$SCHEDULE;$FULL_COMMAND;$ARBITRARY_DATA`. Individual implementations of cron writing can decide whether and how to include these cron tasks. The `ARBITRARY_DATA` includes the log file path for the basic `docker-local` cron implementation. - Invoked by: - Arguments: `$DOKKU_SCHEDULER` - Example: @@ -2450,7 +2450,7 @@ DOKKU_SCHEDULER="$1"; APP="$2"; > The scheduler plugin trigger apis are under development and may change > between minor releases until the 1.0 release. -- Description: Force triggers writing out cron entries. Arguments are optional. +- Description: Force triggers writing out cron tasks. Arguments are optional. - Invoked by: `ps:start`, `ps:stop`, `cron:set` - Arguments: `$DOKKU_SCHEDULER $APP` - Example: diff --git a/docs/processes/scheduled-cron-tasks.md b/docs/processes/scheduled-cron-tasks.md index 76c3f2232..0fe1d3cbe 100644 --- a/docs/processes/scheduled-cron-tasks.md +++ b/docs/processes/scheduled-cron-tasks.md @@ -31,12 +31,12 @@ The `app.json` file for a given app can define a special `cron` key that contain } ``` -A cron entry takes the following properties: +A cron task takes the following properties: - `command`: A command to be run within the built app image. Specified commands can also be `Procfile` entries. - `schedule`: A [cron-compatible](https://en.wikipedia.org/wiki/Cron#Overview) scheduling definition upon which to run the command. Seconds are generally not supported. -Zero or more cron commands can be specified per app. Cron entries are validated after the build artifact is created but before the app is deployed, and the cron schedule is updated during the post-deploy phase. +Zero or more cron commands can be specified per app. Cron tasks are validated after the build artifact is created but before the app is deployed, and the cron schedule is updated during the post-deploy phase. See the [app.json location documentation](/docs/advanced-usage/deployment-tasks.md#changing-the-appjson-location) for more information on where to place your `app.json` file. @@ -218,7 +218,7 @@ For tasks that will properly resume, you _should_ use the above method, as runni Regularly scheduled tasks can be a bit of a pain with Dokku. The following are general recommendations to follow to help ensure successful task runs. -- Use the `dokku` user in your cron entry. +- Use the `dokku` user in your cron task. - If you do not, the `dokku` binary will attempt to execute with `sudo`, and your cron run with fail with `sudo: no tty present and no askpass program specified`. - Add a `MAILTO` environment variable to ship cron emails to yourself. - Add a `PATH` environment variable or specify the full path to binaries on the host. diff --git a/plugins/cron/cron.go b/plugins/cron/cron.go index 12754f846..f5a74e0bd 100644 --- a/plugins/cron/cron.go +++ b/plugins/cron/cron.go @@ -66,15 +66,15 @@ func (t TemplateCommand) CronCommand() string { return fmt.Sprintf("dokku run --cron-id %s %s %s", t.ID, t.App, t.Command) } -// FetchCronEntriesInput is the input for the FetchCronEntries function -type FetchCronEntriesInput struct { +// FetchCronTasksInput is the input for the FetchCronTasks function +type FetchCronTasksInput struct { AppName string AppJSON *appjson.AppJSON WarnToFailure bool } -// FetchCronEntries returns a list of cron commands for a given app -func FetchCronEntries(input FetchCronEntriesInput) ([]TemplateCommand, error) { +// FetchCronTasks returns a list of cron commands for a given app +func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { appName := input.AppName commands := []TemplateCommand{} isMaintenance := reportComputedMaintenance(appName) == "true" @@ -129,10 +129,10 @@ func FetchCronEntries(input FetchCronEntriesInput) ([]TemplateCommand, error) { return commands, nil } -// FetchGlobalCronEntries returns a list of global cron commands +// FetchGlobalCronTasks returns a list of global cron commands // This function should only be used for the cron:list --global command // and not internally by the cron plugin -func FetchGlobalCronEntries() ([]TemplateCommand, error) { +func FetchGlobalCronTasks() ([]TemplateCommand, error) { commands := []TemplateCommand{} response, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{ Trigger: "cron-entries", diff --git a/plugins/cron/report.go b/plugins/cron/report.go index 3514b8f53..acf9760cb 100644 --- a/plugins/cron/report.go +++ b/plugins/cron/report.go @@ -41,7 +41,7 @@ func reportMailto(_ string) string { } func reportTasks(appName string) string { - c, _ := FetchCronEntries(FetchCronEntriesInput{AppName: appName}) + c, _ := FetchCronTasks(FetchCronTasksInput{AppName: appName}) return strconv.Itoa(len(c)) } diff --git a/plugins/cron/subcommands.go b/plugins/cron/subcommands.go index f8d0e941e..5b7057619 100644 --- a/plugins/cron/subcommands.go +++ b/plugins/cron/subcommands.go @@ -22,10 +22,10 @@ func CommandList(appName string, format string) error { return fmt.Errorf("Invalid format specified, supported formats: json, stdout") } - var entries []TemplateCommand + var tasks []TemplateCommand if appName == "--global" { var err error - entries, err = FetchGlobalCronEntries() + tasks, err = FetchGlobalCronTasks() if err != nil { return err } @@ -34,7 +34,7 @@ func CommandList(appName string, format string) error { if err := common.VerifyAppName(appName); err != nil { return err } - entries, err = FetchCronEntries(FetchCronEntriesInput{AppName: appName}) + tasks, err = FetchCronTasks(FetchCronTasksInput{AppName: appName}) if err != nil { return err } @@ -42,8 +42,8 @@ func CommandList(appName string, format string) error { if format == "stdout" { output := []string{"ID | Schedule | Maintenance | Command"} - for _, entry := range entries { - output = append(output, fmt.Sprintf("%s | %s | %t | %s", entry.ID, entry.Schedule, entry.Maintenance, entry.Command)) + for _, task := range tasks { + output = append(output, fmt.Sprintf("%s | %s | %t | %s", task.ID, task.Schedule, task.Maintenance, task.Command)) } result := columnize.SimpleFormat(output) @@ -51,7 +51,7 @@ func CommandList(appName string, format string) error { return nil } - out, err := json.Marshal(entries) + out, err := json.Marshal(tasks) if err != nil { return err } @@ -88,7 +88,7 @@ func CommandRun(appName string, cronID string, detached bool) error { return err } - entries, err := FetchCronEntries(FetchCronEntriesInput{AppName: appName}) + tasks, err := FetchCronTasks(FetchCronTasksInput{AppName: appName}) if err != nil { return err } @@ -98,9 +98,9 @@ func CommandRun(appName string, cronID string, detached bool) error { } command := "" - for _, entry := range entries { - if entry.ID == cronID { - command = entry.Command + for _, task := range tasks { + if task.ID == cronID { + command = task.Command } } diff --git a/plugins/cron/templates/cron.tmpl b/plugins/cron/templates/cron.tmpl index 5c510dcae..c38d40499 100644 --- a/plugins/cron/templates/cron.tmpl +++ b/plugins/cron/templates/cron.tmpl @@ -7,6 +7,6 @@ MAILTO={{ .Mailto }} PATH=/usr/local/bin:/usr/bin:/bin SHELL=/bin/bash -{{ range $entry := .Commands -}} -{{ $entry.Schedule }} {{ $entry.CronCommand }} +{{ range $task := .Commands -}} +{{ $task.Schedule }} {{ $task.CronCommand }} {{ end -}} diff --git a/plugins/cron/triggers.go b/plugins/cron/triggers.go index 499405913..e19097bbd 100644 --- a/plugins/cron/triggers.go +++ b/plugins/cron/triggers.go @@ -24,7 +24,7 @@ func TriggerCronGetProperty(appName string, key string) error { return nil } -// TriggerAppJSONIsValid validates the cron entries for a given app +// TriggerAppJSONIsValid validates the cron tasks for a given app func TriggerAppJSONIsValid(appName string, appJSONPath string) error { if !common.FileExists(appJSONPath) { return nil @@ -35,7 +35,7 @@ func TriggerAppJSONIsValid(appName string, appJSONPath string) error { return err } - _, err = FetchCronEntries(FetchCronEntriesInput{ + _, err = FetchCronTasks(FetchCronTasksInput{ AppName: appName, AppJSON: &appJSON, WarnToFailure: true, diff --git a/plugins/scheduler-docker-local/functions.go b/plugins/scheduler-docker-local/functions.go index e11d7c035..316192d31 100644 --- a/plugins/scheduler-docker-local/functions.go +++ b/plugins/scheduler-docker-local/functions.go @@ -38,7 +38,7 @@ func deleteCrontab() error { return nil } -func generateCronEntries() ([]cron.TemplateCommand, error) { +func generateCronTasks() ([]cron.TemplateCommand, error) { apps, _ := common.UnfilteredDokkuApps() g := new(errgroup.Group) @@ -52,7 +52,7 @@ func generateCronEntries() ([]cron.TemplateCommand, error) { return nil } - c, err := cron.FetchCronEntries(cron.FetchCronEntriesInput{AppName: appName}) + c, err := cron.FetchCronTasks(cron.FetchCronTasksInput{AppName: appName}) if err != nil { results <- []cron.TemplateCommand{} common.LogWarn(err.Error()) @@ -116,13 +116,13 @@ func generateCronEntries() ([]cron.TemplateCommand, error) { return commands, nil } -func writeCronEntries(scheduler string) error { +func writeCronTasks(scheduler string) error { // allow empty scheduler, which means all apps (used by letsencrypt) if scheduler != "docker-local" && scheduler != "" { return nil } - commands, err := generateCronEntries() + commands, err := generateCronTasks() if err != nil { return err } @@ -154,7 +154,7 @@ func writeCronEntries(scheduler string) error { return err } - tmpFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("dokku-%s-%s", common.MustGetEnv("DOKKU_PID"), "WriteCronEntries")) + tmpFile, err := os.CreateTemp(os.TempDir(), fmt.Sprintf("dokku-%s-%s", common.MustGetEnv("DOKKU_PID"), "WriteCronTasks")) if err != nil { return fmt.Errorf("Cannot create temporary schedule file: %v", err) } diff --git a/plugins/scheduler-docker-local/triggers.go b/plugins/scheduler-docker-local/triggers.go index 4f9fded0d..3bd78229d 100644 --- a/plugins/scheduler-docker-local/triggers.go +++ b/plugins/scheduler-docker-local/triggers.go @@ -2,5 +2,5 @@ package schedulerdockerlocal // TriggerSchedulerCronWrite force updates the cron file for all apps func TriggerSchedulerCronWrite(scheduler string) error { - return writeCronEntries(scheduler) + return writeCronTasks(scheduler) } diff --git a/plugins/scheduler-k3s/triggers.go b/plugins/scheduler-k3s/triggers.go index b89aa017c..5be47ea33 100644 --- a/plugins/scheduler-k3s/triggers.go +++ b/plugins/scheduler-k3s/triggers.go @@ -312,15 +312,15 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e workingDir := common.GetWorkingDir(appName, image) - allCronEntries, err := cron.FetchCronEntries(cron.FetchCronEntriesInput{AppName: appName}) + allCronTasks, err := cron.FetchCronTasks(cron.FetchCronTasksInput{AppName: appName}) if err != nil { - return fmt.Errorf("Error fetching cron entries: %w", err) + return fmt.Errorf("Error fetching cron tasks: %w", err) } - // remove maintenance cron entries - cronEntries := []cron.TemplateCommand{} - for _, cronEntry := range allCronEntries { - if !cronEntry.Maintenance { - cronEntries = append(cronEntries, cronEntry) + // remove maintenance cron tasks + cronTasks := []cron.TemplateCommand{} + for _, cronTask := range allCronTasks { + if !cronTask.Maintenance { + cronTasks = append(cronTasks, cronTask) } } @@ -605,13 +605,13 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e if err != nil { return fmt.Errorf("Error listing cron jobs: %w", err) } - for _, cronEntry := range cronEntries { + for _, cronTask := range cronTasks { // todo: implement deployment annotations // todo: implement pod annotations // todo: implement volumes suffix := "" for _, cronJob := range cronJobs { - if cronJob.Labels["dokku.com/cron-id"] == cronEntry.ID { + if cronJob.Labels["dokku.com/cron-id"] == cronTask.ID { var ok bool suffix, ok = cronJob.Annotations["dokku.com/job-suffix"] if !ok { @@ -628,22 +628,22 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e suffix = strings.ToLower(fmt.Sprintf("%X", b)) } - words, err := shellquote.Split(cronEntry.Command) + words, err := shellquote.Split(cronTask.Command) if err != nil { return fmt.Errorf("Error parsing cron command: %w", err) } - processResources, err := getProcessResources(appName, cronEntry.ID) + processResources, err := getProcessResources(appName, cronTask.ID) if err != nil { return fmt.Errorf("Error getting process resources: %w", err) } - annotations, err := getAnnotations(appName, cronEntry.ID) + annotations, err := getAnnotations(appName, cronTask.ID) if err != nil { return fmt.Errorf("Error getting process annotations: %w", err) } - labels, err := getLabels(appName, cronEntry.ID) + labels, err := getLabels(appName, cronTask.ID) if err != nil { return fmt.Errorf("Error getting process labels: %w", err) } @@ -652,8 +652,8 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e Args: words, Annotations: annotations, Cron: ProcessCron{ - ID: cronEntry.ID, - Schedule: cronEntry.Schedule, + ID: cronTask.ID, + Schedule: cronTask.Schedule, Suffix: suffix, }, Labels: labels, @@ -662,10 +662,10 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e Resources: processResources, Volumes: processVolumes, } - values.Processes[cronEntry.ID] = processValues + values.Processes[cronTask.ID] = processValues } - if len(cronEntries) > 0 { + if len(cronTasks) > 0 { b, err := templates.ReadFile("templates/chart/cron-job.yaml") if err != nil { return fmt.Errorf("Error reading cron job template: %w", err) @@ -1443,14 +1443,14 @@ func TriggerSchedulerRunList(scheduler string, appName string, format string) er return fmt.Errorf("Error getting cron jobs: %w", err) } - type CronJobEntry struct { + type CronJobTask struct { ID string `json:"id"` AppName string `json:"app"` Command string `json:"command"` Schedule string `json:"schedule"` } - data := []CronJobEntry{} + data := []CronJobTask{} lines := []string{"ID | Schedule | Command"} for _, cronJob := range cronJobs { command := "" @@ -1467,7 +1467,7 @@ func TriggerSchedulerRunList(scheduler string, appName string, format string) er } lines = append(lines, fmt.Sprintf("%s | %s | %s", cronID, cronJob.Spec.Schedule, command)) - data = append(data, CronJobEntry{ + data = append(data, CronJobTask{ ID: cronID, AppName: appName, Command: command, From b598af67b944606abef7e887e8140d204da9a571 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 7 Nov 2025 22:32:44 -0500 Subject: [PATCH 2/4] refactor: rename CronCommand to DokkuRunCommand This better reflects what it does. --- plugins/cron/cron.go | 4 ++-- plugins/cron/templates/cron.tmpl | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/cron/cron.go b/plugins/cron/cron.go index f5a74e0bd..6d0025ff7 100644 --- a/plugins/cron/cron.go +++ b/plugins/cron/cron.go @@ -54,8 +54,8 @@ type TemplateCommand struct { Maintenance bool `json:"maintenance"` } -// CronCommand returns the command to run for a given cron command -func (t TemplateCommand) CronCommand() string { +// DokkuRunCommand returns the dokku run command to execute for a given cron task +func (t TemplateCommand) DokkuRunCommand() string { if t.AltCommand != "" { if t.LogFile != "" { return fmt.Sprintf("%s &>> %s", t.AltCommand, t.LogFile) diff --git a/plugins/cron/templates/cron.tmpl b/plugins/cron/templates/cron.tmpl index c38d40499..3f186e97b 100644 --- a/plugins/cron/templates/cron.tmpl +++ b/plugins/cron/templates/cron.tmpl @@ -8,5 +8,5 @@ PATH=/usr/local/bin:/usr/bin:/bin SHELL=/bin/bash {{ range $task := .Commands -}} -{{ $task.Schedule }} {{ $task.CronCommand }} +{{ $task.Schedule }} {{ $task.DokkuRunCommand }} {{ end -}} From 82cab643a8265554169f78121677874e2878b579 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 7 Nov 2025 22:36:00 -0500 Subject: [PATCH 3/4] chore: standardize on cron task vs any other naming --- docs/processes/scheduled-cron-tasks.md | 2 +- plugins/app-json/appjson.go | 8 ++++---- plugins/cron/cron.go | 20 ++++++++++---------- plugins/cron/subcommands.go | 2 +- plugins/scheduler-k3s/triggers.go | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/processes/scheduled-cron-tasks.md b/docs/processes/scheduled-cron-tasks.md index 0fe1d3cbe..f647b6edb 100644 --- a/docs/processes/scheduled-cron-tasks.md +++ b/docs/processes/scheduled-cron-tasks.md @@ -36,7 +36,7 @@ A cron task takes the following properties: - `command`: A command to be run within the built app image. Specified commands can also be `Procfile` entries. - `schedule`: A [cron-compatible](https://en.wikipedia.org/wiki/Cron#Overview) scheduling definition upon which to run the command. Seconds are generally not supported. -Zero or more cron commands can be specified per app. Cron tasks are validated after the build artifact is created but before the app is deployed, and the cron schedule is updated during the post-deploy phase. +Zero or more cron tasks can be specified per app. Cron tasks are validated after the build artifact is created but before the app is deployed, and the cron schedule is updated during the post-deploy phase. See the [app.json location documentation](/docs/advanced-usage/deployment-tasks.md#changing-the-appjson-location) for more information on where to place your `app.json` file. diff --git a/plugins/app-json/appjson.go b/plugins/app-json/appjson.go index 75f0ccced..d251da4ea 100644 --- a/plugins/app-json/appjson.go +++ b/plugins/app-json/appjson.go @@ -25,8 +25,8 @@ var ( // AppJSON is a struct that represents an app.json file as understood by Dokku type AppJSON struct { - // Cron is a list of cron commands to execute - Cron []CronCommand `json:"cron"` + // Cron is a list of cron tasks to execute + Cron []CronTask `json:"cron"` // Formation is a map of process types to scale Formation map[string]Formation `json:"formation"` @@ -50,8 +50,8 @@ type AppJSON struct { } `json:"scripts"` } -// CronCommand is a struct that represents a single cron command from an app.json file -type CronCommand struct { +// CronTask is a struct that represents a single cron task from an app.json file +type CronTask struct { // Command is the command to execute Command string `json:"command"` diff --git a/plugins/cron/cron.go b/plugins/cron/cron.go index 6d0025ff7..d1f19015e 100644 --- a/plugins/cron/cron.go +++ b/plugins/cron/cron.go @@ -27,18 +27,18 @@ var ( } ) -// TemplateCommand is a struct that represents a cron command +// TemplateCommand is a struct that represents a cron task type TemplateCommand struct { - // ID is a unique identifier for the cron command + // ID is a unique identifier for the cron task ID string `json:"id"` - // App is the app the cron command belongs to + // App is the app the cron task belongs to App string `json:"app,omitempty"` // Command is the command to run Command string `json:"command"` - // Global is whether the cron command is global + // Global is whether the cron task is global Global bool `json:"global,omitempty"` // Schedule is the cron schedule @@ -50,7 +50,7 @@ type TemplateCommand struct { // LogFile is the log file to write to LogFile string `json:"-"` - // Maintenance is whether the cron command is in maintenance mode + // Maintenance is whether the cron task is in maintenance mode Maintenance bool `json:"maintenance"` } @@ -73,7 +73,7 @@ type FetchCronTasksInput struct { WarnToFailure bool } -// FetchCronTasks returns a list of cron commands for a given app +// FetchCronTasks returns a list of cron tasks for a given app func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { appName := input.AppName commands := []TemplateCommand{} @@ -95,10 +95,10 @@ func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { for i, c := range input.AppJSON.Cron { if c.Command == "" { if input.WarnToFailure { - return commands, fmt.Errorf("Missing cron command for app %s (index %d)", appName, i) + return commands, fmt.Errorf("Missing cron task command for app %s (index %d)", appName, i) } - common.LogWarn(fmt.Sprintf("Missing cron command for app %s (index %d)", appName, i)) + common.LogWarn(fmt.Sprintf("Missing cron task command for app %s (index %d)", appName, i)) continue } @@ -129,7 +129,7 @@ func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { return commands, nil } -// FetchGlobalCronTasks returns a list of global cron commands +// FetchGlobalCronTasks returns a list of global cron tasks // This function should only be used for the cron:list --global command // and not internally by the cron plugin func FetchGlobalCronTasks() ([]TemplateCommand, error) { @@ -167,6 +167,6 @@ func FetchGlobalCronTasks() ([]TemplateCommand, error) { } // GenerateCommandID creates a unique ID for a given app/command/schedule combination -func GenerateCommandID(appName string, c appjson.CronCommand) string { +func GenerateCommandID(appName string, c appjson.CronTask) string { return base36.EncodeToStringLc([]byte(appName + "===" + c.Command + "===" + c.Schedule)) } diff --git a/plugins/cron/subcommands.go b/plugins/cron/subcommands.go index 5b7057619..7bd416192 100644 --- a/plugins/cron/subcommands.go +++ b/plugins/cron/subcommands.go @@ -82,7 +82,7 @@ func CommandReport(appName string, format string, infoFlag string) error { return ReportSingleApp(appName, format, infoFlag) } -// CommandRun executes a cron command on the fly +// CommandRun executes a cron task on the fly func CommandRun(appName string, cronID string, detached bool) error { if err := common.VerifyAppName(appName); err != nil { return err diff --git a/plugins/scheduler-k3s/triggers.go b/plugins/scheduler-k3s/triggers.go index 5be47ea33..a46e477e8 100644 --- a/plugins/scheduler-k3s/triggers.go +++ b/plugins/scheduler-k3s/triggers.go @@ -630,7 +630,7 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e words, err := shellquote.Split(cronTask.Command) if err != nil { - return fmt.Errorf("Error parsing cron command: %w", err) + return fmt.Errorf("Error parsing cron task command: %w", err) } processResources, err := getProcessResources(appName, cronTask.ID) From 791f53ab47bacc3526455bf80a2d87ccec5a78ef Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 7 Nov 2025 22:40:53 -0500 Subject: [PATCH 4/4] refactor: rename command to task in cron code --- plugins/cron/cron.go | 36 ++++++++++----------- plugins/cron/subcommands.go | 2 +- plugins/cron/templates/cron.tmpl | 2 +- plugins/scheduler-docker-local/functions.go | 36 ++++++++++----------- plugins/scheduler-k3s/triggers.go | 2 +- 5 files changed, 39 insertions(+), 39 deletions(-) diff --git a/plugins/cron/cron.go b/plugins/cron/cron.go index d1f19015e..172ffd95d 100644 --- a/plugins/cron/cron.go +++ b/plugins/cron/cron.go @@ -27,8 +27,8 @@ var ( } ) -// TemplateCommand is a struct that represents a cron task -type TemplateCommand struct { +// CronTask is a struct that represents a cron task +type CronTask struct { // ID is a unique identifier for the cron task ID string `json:"id"` @@ -55,7 +55,7 @@ type TemplateCommand struct { } // DokkuRunCommand returns the dokku run command to execute for a given cron task -func (t TemplateCommand) DokkuRunCommand() string { +func (t CronTask) DokkuRunCommand() string { if t.AltCommand != "" { if t.LogFile != "" { return fmt.Sprintf("%s &>> %s", t.AltCommand, t.LogFile) @@ -74,28 +74,28 @@ type FetchCronTasksInput struct { } // FetchCronTasks returns a list of cron tasks for a given app -func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { +func FetchCronTasks(input FetchCronTasksInput) ([]CronTask, error) { appName := input.AppName - commands := []TemplateCommand{} + tasks := []CronTask{} isMaintenance := reportComputedMaintenance(appName) == "true" if input.AppJSON == nil { appJSON, err := appjson.GetAppJSON(appName) if err != nil { - return commands, fmt.Errorf("Unable to fetch app.json for app %s: %s", appName, err.Error()) + return tasks, fmt.Errorf("Unable to fetch app.json for app %s: %s", appName, err.Error()) } input.AppJSON = &appJSON } if input.AppJSON.Cron == nil { - return commands, nil + return tasks, nil } for i, c := range input.AppJSON.Cron { if c.Command == "" { if input.WarnToFailure { - return commands, fmt.Errorf("Missing cron task command for app %s (index %d)", appName, i) + return tasks, fmt.Errorf("Missing cron task command for app %s (index %d)", appName, i) } common.LogWarn(fmt.Sprintf("Missing cron task command for app %s (index %d)", appName, i)) @@ -104,7 +104,7 @@ func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { if c.Schedule == "" { if input.WarnToFailure { - return commands, fmt.Errorf("Missing cron schedule for app %s (index %d)", appName, i) + return tasks, fmt.Errorf("Missing cron schedule for app %s (index %d)", appName, i) } common.LogWarn(fmt.Sprintf("Missing cron schedule for app %s (index %d)", appName, i)) @@ -114,10 +114,10 @@ func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { parser := cronparser.NewParser(cronparser.Minute | cronparser.Hour | cronparser.Dom | cronparser.Month | cronparser.Dow | cronparser.Descriptor) _, err := parser.Parse(c.Schedule) if err != nil { - return commands, fmt.Errorf("Invalid cron schedule for app %s (schedule %s): %s", appName, c.Schedule, err.Error()) + return tasks, fmt.Errorf("Invalid cron schedule for app %s (schedule %s): %s", appName, c.Schedule, err.Error()) } - commands = append(commands, TemplateCommand{ + tasks = append(tasks, CronTask{ App: appName, Command: c.Command, Schedule: c.Schedule, @@ -126,14 +126,14 @@ func FetchCronTasks(input FetchCronTasksInput) ([]TemplateCommand, error) { }) } - return commands, nil + return tasks, nil } // FetchGlobalCronTasks returns a list of global cron tasks // This function should only be used for the cron:list --global command // and not internally by the cron plugin -func FetchGlobalCronTasks() ([]TemplateCommand, error) { - commands := []TemplateCommand{} +func FetchGlobalCronTasks() ([]CronTask, error) { + tasks := []CronTask{} response, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{ Trigger: "cron-entries", Args: []string{"docker-local"}, @@ -150,7 +150,7 @@ func FetchGlobalCronTasks() ([]TemplateCommand, error) { } id := base36.EncodeToStringLc([]byte(strings.Join(parts, ";;;"))) - command := TemplateCommand{ + task := CronTask{ ID: id, Schedule: parts[0], Command: parts[1], @@ -159,11 +159,11 @@ func FetchGlobalCronTasks() ([]TemplateCommand, error) { Global: true, } if len(parts) == 3 { - command.LogFile = parts[2] + task.LogFile = parts[2] } - commands = append(commands, command) + tasks = append(tasks, task) } - return commands, nil + return tasks, nil } // GenerateCommandID creates a unique ID for a given app/command/schedule combination diff --git a/plugins/cron/subcommands.go b/plugins/cron/subcommands.go index 7bd416192..1cc89342f 100644 --- a/plugins/cron/subcommands.go +++ b/plugins/cron/subcommands.go @@ -22,7 +22,7 @@ func CommandList(appName string, format string) error { return fmt.Errorf("Invalid format specified, supported formats: json, stdout") } - var tasks []TemplateCommand + var tasks []CronTask if appName == "--global" { var err error tasks, err = FetchGlobalCronTasks() diff --git a/plugins/cron/templates/cron.tmpl b/plugins/cron/templates/cron.tmpl index 3f186e97b..75577e6ee 100644 --- a/plugins/cron/templates/cron.tmpl +++ b/plugins/cron/templates/cron.tmpl @@ -7,6 +7,6 @@ MAILTO={{ .Mailto }} PATH=/usr/local/bin:/usr/bin:/bin SHELL=/bin/bash -{{ range $task := .Commands -}} +{{ range $task := .Tasks -}} {{ $task.Schedule }} {{ $task.DokkuRunCommand }} {{ end -}} diff --git a/plugins/scheduler-docker-local/functions.go b/plugins/scheduler-docker-local/functions.go index 316192d31..977a8904c 100644 --- a/plugins/scheduler-docker-local/functions.go +++ b/plugins/scheduler-docker-local/functions.go @@ -38,23 +38,23 @@ func deleteCrontab() error { return nil } -func generateCronTasks() ([]cron.TemplateCommand, error) { +func generateCronTasks() ([]cron.CronTask, error) { apps, _ := common.UnfilteredDokkuApps() g := new(errgroup.Group) - results := make(chan []cron.TemplateCommand, len(apps)+1) + results := make(chan []cron.CronTask, len(apps)+1) for _, appName := range apps { appName := appName g.Go(func() error { scheduler := common.GetAppScheduler(appName) if scheduler != "docker-local" { - results <- []cron.TemplateCommand{} + results <- []cron.CronTask{} return nil } c, err := cron.FetchCronTasks(cron.FetchCronTasksInput{AppName: appName}) if err != nil { - results <- []cron.TemplateCommand{} + results <- []cron.CronTask{} common.LogWarn(err.Error()) return nil } @@ -65,55 +65,55 @@ func generateCronTasks() ([]cron.TemplateCommand, error) { } g.Go(func() error { - commands := []cron.TemplateCommand{} + tasks := []cron.CronTask{} response, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{ Trigger: "cron-entries", Args: []string{"docker-local"}, }) for _, line := range strings.Split(response.StdoutContents(), "\n") { if strings.TrimSpace(line) == "" { - results <- []cron.TemplateCommand{} + results <- []cron.CronTask{} return nil } parts := strings.Split(line, ";") if len(parts) != 2 && len(parts) != 3 { - results <- []cron.TemplateCommand{} + results <- []cron.CronTask{} return fmt.Errorf("Invalid injected cron task: %v", line) } id := base36.EncodeToStringLc([]byte(strings.Join(parts, ";;;"))) - command := cron.TemplateCommand{ + task := cron.CronTask{ ID: id, Schedule: parts[0], AltCommand: parts[1], Maintenance: false, } if len(parts) == 3 { - command.LogFile = parts[2] + task.LogFile = parts[2] } - commands = append(commands, command) + tasks = append(tasks, task) } - results <- commands + results <- tasks return nil }) err := g.Wait() close(results) - commands := []cron.TemplateCommand{} + tasks := []cron.CronTask{} if err != nil { - return commands, err + return tasks, err } for result := range results { c := result if len(c) > 0 && !c[0].Maintenance { - commands = append(commands, c...) + tasks = append(tasks, c...) } } - return commands, nil + return tasks, nil } func writeCronTasks(scheduler string) error { @@ -122,12 +122,12 @@ func writeCronTasks(scheduler string) error { return nil } - commands, err := generateCronTasks() + tasks, err := generateCronTasks() if err != nil { return err } - if len(commands) == 0 { + if len(tasks) == 0 { return deleteCrontab() } @@ -144,7 +144,7 @@ func writeCronTasks(scheduler string) error { mailto := mailtoResults.StdoutContents() data := map[string]interface{}{ - "Commands": commands, + "Tasks": tasks, "Mailfrom": mailfrom, "Mailto": mailto, } diff --git a/plugins/scheduler-k3s/triggers.go b/plugins/scheduler-k3s/triggers.go index a46e477e8..def82453f 100644 --- a/plugins/scheduler-k3s/triggers.go +++ b/plugins/scheduler-k3s/triggers.go @@ -317,7 +317,7 @@ func TriggerSchedulerDeploy(scheduler string, appName string, imageTag string) e return fmt.Errorf("Error fetching cron tasks: %w", err) } // remove maintenance cron tasks - cronTasks := []cron.TemplateCommand{} + cronTasks := []cron.CronTask{} for _, cronTask := range allCronTasks { if !cronTask.Maintenance { cronTasks = append(cronTasks, cronTask)