feat: allow disabling autostart and custom autostop for template #6933
Conversation
There was a problem hiding this comment.
I can only imagine how much time you spent on wiring it all together :)
Anyway, I went through the source, but due to the massive size of the PR, please keep in mind that for sure I missed something.
General comments:
- Autostart vs "auto start", it seems that we're using the first one.
- I checked the main flow: set options via template settings, and make sure that the user can autostart or autostop the workspace. It seems 👍 to me.
- Maybe try to split it into smaller chunks next time :)
| ADD COLUMN "allow_user_auto_start" boolean DEFAULT true NOT NULL, | ||
| ADD COLUMN "allow_user_auto_stop" boolean DEFAULT true NOT NULL; |
There was a problem hiding this comment.
You won't like this comment... In the codebase, we're using "autostart" and "autostop".
There was a problem hiding this comment.
nothing a sed can't fix :^)
| @@ -115,8 +115,10 @@ UPDATE | |||
| templates | |||
| SET | |||
| updated_at = $2, | |||
| default_ttl = $3, | |||
| max_ttl = $4 | |||
| allow_user_auto_start = $3, | |||
There was a problem hiding this comment.
Oh, is it safe and backward-compatible to change the order of items here?
There was a problem hiding this comment.
It shouldn't matter since the generated Golang query uses named parameters in a struct, not ordered parameters in a function.
| @@ -227,7 +227,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request) | |||
| Provisioners: daemon.Provisioners, | |||
| Telemetry: api.Telemetry, | |||
| Auditor: &api.AGPL.Auditor, | |||
| TemplateScheduleStore: &api.AGPL.TemplateScheduleStore, | |||
| TemplateScheduleStore: api.AGPL.TemplateScheduleStore, | |||
There was a problem hiding this comment.
Yes, provisionerdserver was using a *atomic.Pointer[T] so we had to use & before since coderd was only using atomic.Pointer[T]. coderd now uses *atomic.Pointer[T] so we just copy the pointer here.
| @@ -1017,11 +1019,6 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd. | |||
| return xerrors.Errorf("notify systemd: %w", err) | |||
| } | |||
|
|
|||
| autobuildPoller := time.NewTicker(cfg.AutobuildPollInterval.Value()) | |||
There was a problem hiding this comment.
nit: why did you remove this part?
Maybe I have to go through the entire review to find the answer...
There was a problem hiding this comment.
executor.New in the review.
There was a problem hiding this comment.
Yeah this was a mistake, good catch to both of you. I removed this code and moved it somewhere else, and decided I wanted to move it back but forgot to put it back I guess.
| if err != nil { | ||
| e.log.Error(e.ctx, "get workspaces for autostart or autostop", slog.Error(err)) | ||
| return stats | ||
| } | ||
| workspaces := database.ConvertWorkspaceRows(workspaceRows) |
| func isEligibleForAutoStartStop(ws database.Workspace, priorHistory database.WorkspaceBuild, templateSchedule schedule.TemplateScheduleOptions) bool { | ||
| if ws.Deleted { | ||
| return false | ||
| } | ||
| if templateSchedule.UserAutoStartEnabled && ws.AutostartSchedule.Valid && ws.AutostartSchedule.String != "" { | ||
| return true | ||
| } | ||
| // Don't check the template schedule to see whether it allows autostop, this | ||
| // is done during the build when determining the deadline. | ||
| if priorHistory.Transition == database.WorkspaceTransitionStart && !priorHistory.Deadline.IsZero() { | ||
| return true | ||
| } | ||
|
|
||
| return false |
coderd/templates_test.go
Outdated
| allowAutoStart atomic.Bool | ||
| allowAutoStop atomic.Bool |
There was a problem hiding this comment.
When I initially looked at this, I was wondering whether it would make more sense to instead use a chan bool instead to assert the values passed to setFn. But this does seem to be simpler in some ways and, crucially, will fail quickly if it fails. Not so for a channel... so 👍
| @@ -1017,11 +1019,6 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd. | |||
| return xerrors.Errorf("notify systemd: %w", err) | |||
| } | |||
|
|
|||
| autobuildPoller := time.NewTicker(cfg.AutobuildPollInterval.Value()) | |||
There was a problem hiding this comment.
executor.New in the review.
|
I'll make a ticket for doing frontend in a follow-up PR. |
|
Actually we can just reuse the other tickets. |
Adds template controls for disabling autostart and for disabling user-customizable autostop for all workspaces on the template. Autostart preferences apply instantly, but autostop preferences will apply after workspaces are rebuilt.
TODO:
Relates to #6047
Relates to #6497