Skip to content

feat: allow disabling autostart and custom autostop for template - #6933

Merged
deansheather merged 13 commits into
mainfrom
dean/disable-template-autostart-autostop
Apr 4, 2023
Merged

deansheather merged 13 commits into
mainfrom
dean/disable-template-autostart-autostop

Conversation

@deansheather

@deansheather deansheather commented Mar 31, 2023 •

Copy link
Copy Markdown
Collaborator

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:

  • Frontend
  • Update template schedule endpoint tests

Relates to #6047
Relates to #6497

@deansheather deansheather self-assigned this Mar 31, 2023
@deansheather
deansheather requested review from johnstcn and mtojek April 4, 2023 06:33

@mtojek mtojek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. Autostart vs "auto start", it seems that we're using the first one.
  2. 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.
  3. Maybe try to split it into smaller chunks next time :)

Comment on lines +2 to +3
ADD COLUMN "allow_user_auto_start" boolean DEFAULT true NOT NULL,
ADD COLUMN "allow_user_auto_stop" boolean DEFAULT true NOT NULL;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You won't like this comment... In the codebase, we're using "autostart" and "autostop".

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nothing a sed can't fix :^)

Comment thread coderd/database/queries/templates.sql Outdated
updated_at = $2,
default_ttl = $3,
max_ttl = $4
allow_user_auto_start = $3,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, is it safe and backward-compatible to change the order of items here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't matter since the generated Golang query uses named parameters in a struct, not ordered parameters in a function.

Telemetry: api.Telemetry,
Auditor: &api.AGPL.Auditor,
TemplateScheduleStore: &api.AGPL.TemplateScheduleStore,
TemplateScheduleStore: api.AGPL.TemplateScheduleStore,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: is it intentional change?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread cli/server.go
return xerrors.Errorf("notify systemd: %w", err)
}

autobuildPoller := time.NewTicker(cfg.AutobuildPollInterval.Value())

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: why did you remove this part?

Maybe I have to go through the entire review to find the answer...

@johnstcn johnstcn Apr 4, 2023 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Might be more than a nit? I don't see any other calls to executor.New in the review.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

e.log.Error(e.ctx, "get workspaces for autostart or autostop", slog.Error(err))
return stats
}
workspaces := database.ConvertWorkspaceRows(workspaceRows)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@johnstcn johnstcn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the deletion in cli/server.go on line 1020 expected?

Comment on lines +201 to +214
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Comment thread coderd/templates_test.go Outdated
Comment on lines +615 to +616
allowAutoStart atomic.Bool
allowAutoStop atomic.Bool

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 👍

Comment thread cli/server.go
return xerrors.Errorf("notify systemd: %w", err)
}

autobuildPoller := time.NewTicker(cfg.AutobuildPollInterval.Value())

@johnstcn johnstcn Apr 4, 2023 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Might be more than a nit? I don't see any other calls to executor.New in the review.

Comment thread docs/workspaces.md Resolved
Comment thread coderd/coderd.go Resolved
@deansheather

Copy link
Copy Markdown
Collaborator Author

I'll make a ticket for doing frontend in a follow-up PR.

@deansheather

Copy link
Copy Markdown
Collaborator Author

Actually we can just reuse the other tickets.

@deansheather
deansheather enabled auto-merge (squash) April 4, 2023 12:41
@deansheather
deansheather merged commit e33941b into main Apr 4, 2023
@deansheather
deansheather deleted the dean/disable-template-autostart-autostop branch April 4, 2023 12:48
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants