feat: add template activity_bump property

coder · deansheather · Feb 13, 2024 · Jan 22, 2024 · Jan 22, 2024 · Jan 22, 2024
commit 359d188779df86ee97ccfb36bb0c167ea28f16ea
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -23,6 +23,7 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 		description                    string
 		icon                           string
 		defaultTTL                     time.Duration
+		activityBump                   time.Duration
 		maxTTL                         time.Duration
 		autostopRequirementDaysOfWeek  []string
 		autostopRequirementWeeks       int64
@@ -108,6 +109,10 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 				defaultTTL = time.Duration(template.DefaultTTLMillis) * time.Millisecond
 			}
 
+			if !userSetOption(inv, "activity-bump") {
+				activityBump = time.Duration(template.ActivityBumpMillis) * time.Millisecond
+			}
+
 			if !userSetOption(inv, "allow-user-autostop") {
 				allowUserAutostop = template.AllowUserAutostop
 			}
@@ -168,12 +173,13 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 			}
 
 			req := codersdk.UpdateTemplateMeta{
-				Name:             name,
-				DisplayName:      displayName,
-				Description:      description,
-				Icon:             icon,
-				DefaultTTLMillis: defaultTTL.Milliseconds(),
-				MaxTTLMillis:     maxTTL.Milliseconds(),
+				Name:               name,
+				DisplayName:        displayName,
+				Description:        description,
+				Icon:               icon,
+				DefaultTTLMillis:   defaultTTL.Milliseconds(),
+				ActivityBumpMillis: activityBump.Milliseconds(),
+				MaxTTLMillis:       maxTTL.Milliseconds(),
 				AutostopRequirement: &codersdk.TemplateAutostopRequirement{
 					DaysOfWeek: autostopRequirementDaysOfWeek,
 					Weeks:      autostopRequirementWeeks,
@@ -233,6 +239,11 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 			Description: "Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to \"Default autostop\" in the UI.",
 			Value:       clibase.DurationOf(&defaultTTL),
 		},
+		{
+			Flag:        "activity-bump",
+			Description: "Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to \"Activity bump\" in the UI.",
+			Value:       clibase.DurationOf(&activityBump),
+		},
 		{
 			Flag:        "max-ttl",
 			Description: "Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to \"Max lifetime\" in the UI.",

diff --git a/cli/templateedit_test.go b/cli/templateedit_test.go
@@ -93,6 +93,7 @@ func TestTemplateEdit(t *testing.T) {
 			"--description", template.Description,
 			"--icon", template.Icon,
 			"--default-ttl", (time.Duration(template.DefaultTTLMillis) * time.Millisecond).String(),
+			"--activity-bump", (time.Duration(template.ActivityBumpMillis) * time.Millisecond).String(),
 			"--allow-user-cancel-workspace-jobs=" + strconv.FormatBool(template.AllowUserCancelWorkspaceJobs),
 		}
 		inv, root := clitest.New(t, cmdArgs...)

diff --git a/cli/testdata/coder_templates_edit_--help.golden b/cli/testdata/coder_templates_edit_--help.golden
@@ -6,6 +6,11 @@ USAGE:
   Edit the metadata of a template by name.
 
 OPTIONS:
+      --activity-bump duration
+          Edit the template activity bump - workspaces created from this
+          template will have their shutdown time bumped by this value when
+          activity is detected. Maps to "Activity bump" in the UI.
+
       --allow-user-autostart bool (default: true)
           Allow users to configure autostart for workspaces on this template.
           This can only be disabled in enterprise.

diff --git a/coderd/agentapi/activitybump_test.go b/coderd/agentapi/activitybump_test.go
@@ -41,6 +41,7 @@ func Test_ActivityBumpWorkspace(t *testing.T) {
 		maxDeadlineOffset             *time.Duration
 		workspaceTTL                  time.Duration
 		templateTTL                   time.Duration
+		templateActivityBump          time.Duration
 		templateDisallowsUserAutostop bool
 		expectedBump                  time.Duration
 		// If the tests get queued, we need to be able to set the next autostart
@@ -137,6 +138,16 @@ func Test_ActivityBumpWorkspace(t *testing.T) {
 			expectedBump:                  10*time.Hour + (time.Minute * 30),
 			nextAutostart:                 func(now time.Time) time.Time { return now.Add(time.Minute * 30) },
 		},
+		{
+			// Custom activity bump duration specified on the template.
+			name:                 "TemplateCustomActivityBump",
+			transition:           database.WorkspaceTransitionStart,
+			jobCompletedAt:       sql.NullTime{Valid: true, Time: dbtime.Now().Add(-30 * time.Minute)},
+			buildDeadlineOffset:  ptr.Ref(-30 * time.Minute),
+			workspaceTTL:         8 * time.Hour,
+			templateActivityBump: 5 * time.Hour, // instead of default 1h
+			expectedBump:         5 * time.Hour,
+		},
 	} {
 		tt := tt
 		for _, tz := range timezones {
@@ -186,11 +197,16 @@ func Test_ActivityBumpWorkspace(t *testing.T) {
 					buildID = uuid.New()
 				)
 
+				activityBump := 1 * time.Hour
+				if tt.templateActivityBump != 0 {
+					activityBump = tt.templateActivityBump
+				}
 				require.NoError(t, db.UpdateTemplateScheduleByID(ctx, database.UpdateTemplateScheduleByIDParams{
 					ID:                template.ID,
 					UpdatedAt:         dbtime.Now(),
 					AllowUserAutostop: !tt.templateDisallowsUserAutostop,
 					DefaultTTL:        int64(tt.templateTTL),
+					ActivityBump:      int64(activityBump),
 				}), "unexpected error updating template schedule")
 
 				var buildNumber int32 = 1

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -839,10 +839,11 @@ func (q *FakeQuerier) ActivityBumpWorkspace(ctx context.Context, arg database.Ac
 		if err != nil {
 			return err
 		}
+		activityBump := time.Duration(template.ActivityBump)
 
 		var ttlDur time.Duration
-		if now.Add(time.Hour).After(arg.NextAutostart) && arg.NextAutostart.After(now) {
-			// Extend to TTL
+		if now.Add(activityBump).After(arg.NextAutostart) && arg.NextAutostart.After(now) {
+			// Extend to TTL (NOT activity bump)
 			add := arg.NextAutostart.Sub(now)
 			if workspace.Ttl.Valid && template.AllowUserAutostop {
 				add += time.Duration(workspace.Ttl.Int64)
@@ -851,7 +852,8 @@ func (q *FakeQuerier) ActivityBumpWorkspace(ctx context.Context, arg database.Ac
 			}
 			ttlDur = add
 		} else {
-			ttlDur = time.Hour
+			// Otherwise, default to regular activity bump duration.
+			ttlDur = activityBump
 		}
 
 		// Only bump if 5% of the deadline has passed.
@@ -6423,6 +6425,7 @@ func (q *FakeQuerier) UpdateTemplateScheduleByID(_ context.Context, arg database
 		tpl.AllowUserAutostop = arg.AllowUserAutostop
 		tpl.UpdatedAt = dbtime.Now()
 		tpl.DefaultTTL = arg.DefaultTTL
+		tpl.ActivityBump = arg.ActivityBump
 		tpl.UseMaxTtl = arg.UseMaxTtl
 		tpl.MaxTTL = arg.MaxTTL
 		tpl.AutostopRequirementDaysOfWeek = arg.AutostopRequirementDaysOfWeek

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000186_template_activity_bump_duration.down.sql b/coderd/database/migrations/000186_template_activity_bump_duration.down.sql
@@ -0,0 +1,19 @@
+DROP VIEW template_with_users;
+
+ALTER TABLE templates DROP COLUMN activity_bump;
+
+CREATE VIEW
+    template_with_users
+AS
+    SELECT
+        templates.*,
+		coalesce(visible_users.avatar_url, '') AS created_by_avatar_url,
+		coalesce(visible_users.username, '') AS created_by_username
+    FROM
+        templates
+    LEFT JOIN
+		visible_users
+	ON
+	    templates.created_by = visible_users.id;
+
+COMMENT ON VIEW template_with_users IS 'Joins in the username + avatar url of the created by user.';
diff --git a/coderd/database/migrations/000186_template_activity_bump_duration.up.sql b/coderd/database/migrations/000186_template_activity_bump_duration.up.sql
@@ -0,0 +1,19 @@
+ALTER TABLE templates ADD COLUMN activity_bump bigint DEFAULT '3600000000000'::bigint NOT NULL; -- 1 hour
+
+DROP VIEW template_with_users;
+
+CREATE VIEW
+    template_with_users
+AS
+    SELECT
+        templates.*,
+		coalesce(visible_users.avatar_url, '') AS created_by_avatar_url,
+		coalesce(visible_users.username, '') AS created_by_username
+    FROM
+        templates
+    LEFT JOIN
+		visible_users
+	ON
+	    templates.created_by = visible_users.id;
+
+COMMENT ON VIEW template_with_users IS 'Joins in the username + avatar url of the created by user.';
diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -90,6 +90,7 @@ func (q *sqlQuerier) GetAuthorizedTemplates(ctx context.Context, arg GetTemplate
 			&i.RequireActiveVersion,
 			&i.Deprecated,
 			&i.UseMaxTtl,
+			&i.ActivityBump,
 			&i.CreatedByAvatarURL,
 			&i.CreatedByUsername,
 		); err != nil {

diff --git a/coderd/database/models.go b/coderd/database/models.go