add back max_ttl and put restart_requirement behind feature flag

coder · deansheather · Jul 20, 2023 · Jun 20, 2023 · Jun 20, 2023 · Jun 21, 2023
commit fd26e69bc1833d4dfc5624b1ed437d13167c015a
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -19,6 +19,7 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 		description                  string
 		icon                         string
 		defaultTTL                   time.Duration
+		maxTTL                       time.Duration
 		restartRequirementDaysOfWeek []string
 		restartRequirementWeeks      int64
 		failureTTL                   time.Duration
@@ -54,6 +55,7 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 				restartRequirementWeeks > 0 ||
 				!allowUserAutostart ||
 				!allowUserAutostop ||
+				maxTTL != 0 ||
 				failureTTL != 0 ||
 				inactivityTTL != 0
 			if requiresEntitlement {
@@ -101,6 +103,7 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 				Description:      description,
 				Icon:             icon,
 				DefaultTTLMillis: defaultTTL.Milliseconds(),
+				MaxTTLMillis:     maxTTL.Milliseconds(),
 				RestartRequirement: &codersdk.TemplateRestartRequirement{
 					DaysOfWeek: restartRequirementDaysOfWeek,
 					Weeks:      restartRequirementWeeks,
@@ -147,15 +150,24 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
 			Description: "Edit the template default time before shutdown - workspaces created from this template default to this value.",
 			Value:       clibase.DurationOf(&defaultTTL),
 		},
+		{
+			Flag:        "max-ttl",
+			Description: "Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.",
+			Value:       clibase.DurationOf(&maxTTL),
+		},
 		{
 			Flag:        "restart-requirement-weekdays",
 			Description: "Edit the template restart requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the restart requirement for the template), pass 'none'.",
-			Value:       clibase.StringArrayOf(&restartRequirementDaysOfWeek),
+			// TODO(@dean): unhide when we delete max_ttl
+			Hidden: true,
+			Value:  clibase.StringArrayOf(&restartRequirementDaysOfWeek),
 		},
 		{
 			Flag:        "restart-requirement-weeks",
 			Description: "Edit the template restart requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.",
-			Value:       clibase.Int64Of(&restartRequirementWeeks),
+			// TODO(@dean): unhide when we delete max_ttl
+			Hidden: true,
+			Value:  clibase.Int64Of(&restartRequirementWeeks),
 		},
 		{
 			Flag:        "failure-ttl",

diff --git a/cli/templateedit_test.go b/cli/templateedit_test.go
@@ -519,6 +519,207 @@ func TestTemplateEdit(t *testing.T) {
 			assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
 		})
 	})
+	// TODO(@dean): remove this test when we remove max_ttl
+	t.Run("MaxTTL", func(t *testing.T) {
+		t.Parallel()
+		t.Run("BlockedAGPL", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			inv, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, client, root)
+
+			ctx := testutil.Context(t, testutil.WaitLong)
+			err := inv.WithContext(ctx).Run()
+			require.Error(t, err)
+			require.ErrorContains(t, err, "appears to be an AGPL deployment")
+
+			// Assert that the template metadata did not change.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+
+		t.Run("BlockedNotEntitled", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Make a proxy server that will return a valid entitlements
+			// response, but without advanced scheduling entitlement.
+			proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.URL.Path == "/api/v2/entitlements" {
+					res := codersdk.Entitlements{
+						Features:         map[codersdk.FeatureName]codersdk.Feature{},
+						Warnings:         []string{},
+						Errors:           []string{},
+						HasLicense:       true,
+						Trial:            true,
+						RequireTelemetry: false,
+					}
+					for _, feature := range codersdk.FeatureNames {
+						res.Features[feature] = codersdk.Feature{
+							Entitlement: codersdk.EntitlementNotEntitled,
+							Enabled:     false,
+							Limit:       nil,
+							Actual:      nil,
+						}
+					}
+					httpapi.Write(r.Context(), w, http.StatusOK, res)
+					return
+				}
+
+				// Otherwise, proxy the request to the real API server.
+				httputil.NewSingleHostReverseProxy(client.URL).ServeHTTP(w, r)
+			}))
+			defer proxy.Close()
+
+			// Create a new client that uses the proxy server.
+			proxyURL, err := url.Parse(proxy.URL)
+			require.NoError(t, err)
+			proxyClient := codersdk.New(proxyURL)
+			proxyClient.SetSessionToken(client.SessionToken())
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			inv, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, proxyClient, root)
+
+			ctx := testutil.Context(t, testutil.WaitLong)
+			err = inv.WithContext(ctx).Run()
+			require.Error(t, err)
+			require.ErrorContains(t, err, "license is not entitled")
+
+			// Assert that the template metadata did not change.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+		t.Run("Entitled", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Make a proxy server that will return a valid entitlements
+			// response, including a valid advanced scheduling entitlement.
+			var updateTemplateCalled int64
+			proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.URL.Path == "/api/v2/entitlements" {
+					res := codersdk.Entitlements{
+						Features:         map[codersdk.FeatureName]codersdk.Feature{},
+						Warnings:         []string{},
+						Errors:           []string{},
+						HasLicense:       true,
+						Trial:            true,
+						RequireTelemetry: false,
+					}
+					for _, feature := range codersdk.FeatureNames {
+						var one int64 = 1
+						res.Features[feature] = codersdk.Feature{
+							Entitlement: codersdk.EntitlementNotEntitled,
+							Enabled:     true,
+							Limit:       &one,
+							Actual:      &one,
+						}
+					}
+					httpapi.Write(r.Context(), w, http.StatusOK, res)
+					return
+				}
+				if strings.HasPrefix(r.URL.Path, "/api/v2/templates/") {
+					body, err := io.ReadAll(r.Body)
+					require.NoError(t, err)
+					_ = r.Body.Close()
+
+					var req codersdk.UpdateTemplateMeta
+					err = json.Unmarshal(body, &req)
+					require.NoError(t, err)
+					assert.Equal(t, time.Hour.Milliseconds(), req.MaxTTLMillis)
+
+					r.Body = io.NopCloser(bytes.NewReader(body))
+					atomic.AddInt64(&updateTemplateCalled, 1)
+					// We still want to call the real route.
+				}
+
+				// Otherwise, proxy the request to the real API server.
+				httputil.NewSingleHostReverseProxy(client.URL).ServeHTTP(w, r)
+			}))
+			defer proxy.Close()
+
+			// Create a new client that uses the proxy server.
+			proxyURL, err := url.Parse(proxy.URL)
+			require.NoError(t, err)
+			proxyClient := codersdk.New(proxyURL)
+			proxyClient.SetSessionToken(client.SessionToken())
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			inv, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, proxyClient, root)
+
+			ctx := testutil.Context(t, testutil.WaitLong)
+			err = inv.WithContext(ctx).Run()
+			require.NoError(t, err)
+
+			require.EqualValues(t, 1, atomic.LoadInt64(&updateTemplateCalled))
+
+			// Assert that the template metadata did not change. We verify the
+			// correct request gets sent to the server already.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+	})
 	t.Run("AllowUserScheduling", func(t *testing.T) {
 		t.Parallel()
 		t.Run("BlockedAGPL", func(t *testing.T) {

diff --git a/cli/testdata/coder_templates_edit_--help.golden b/cli/testdata/coder_templates_edit_--help.golden
@@ -35,19 +35,14 @@ Edit the metadata of a template by name.
           Specify an inactivity TTL for workspaces created from this template.
           This licensed feature's default is 0h (off).
 
+      --max-ttl duration
+          Edit the template maximum time before shutdown - workspaces created
+          from this template must shutdown within the given duration after
+          starting. This is an enterprise-only feature.
+
       --name string
           Edit the template name.
 
-      --restart-requirement-weekdays string-array
-          Edit the template restart requirement weekdays - workspaces created
-          from this template must be restarted on the given weekdays. To unset
-          this value for the template (and disable the restart requirement for
-          the template), pass 'none'.
-
-      --restart-requirement-weeks int
-          Edit the template restart requirement weeks - workspaces created from
-          this template must be restarted on an n-weekly basis.
-
   -y, --yes bool
           Bypass prompts.
 

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/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -4745,6 +4745,7 @@ func (q *FakeQuerier) UpdateTemplateScheduleByID(_ context.Context, arg database
 		tpl.AllowUserAutostop = arg.AllowUserAutostop
 		tpl.UpdatedAt = database.Now()
 		tpl.DefaultTTL = arg.DefaultTTL
+		tpl.MaxTTL = arg.MaxTTL
 		tpl.RestartRequirementDaysOfWeek = arg.RestartRequirementDaysOfWeek
 		tpl.RestartRequirementWeeks = arg.RestartRequirementWeeks
 		tpl.FailureTTL = arg.FailureTTL

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000139_template_restart_requirement.down.sql b/coderd/database/migrations/000139_template_restart_requirement.down.sql
@@ -1,4 +1,3 @@
 ALTER TABLE templates
 	DROP COLUMN restart_requirement_days_of_week,
-	DROP COLUMN restart_requirement_weeks,
-	ADD COLUMN max_ttl bigint NOT NULL DEFAULT 0;
+	DROP COLUMN restart_requirement_weeks;
diff --git a/coderd/database/migrations/000139_template_restart_requirement.up.sql b/coderd/database/migrations/000139_template_restart_requirement.up.sql
@@ -1,7 +1,9 @@
 BEGIN;
 
 ALTER TABLE templates
-	DROP COLUMN max_ttl,
+	-- The max_ttl column will be dropped eventually when the new "restart
+	-- requirement" feature flag is fully rolled out.
+	-- DROP COLUMN max_ttl,
 	ADD COLUMN restart_requirement_days_of_week smallint NOT NULL DEFAULT 0,
 	ADD COLUMN restart_requirement_weeks bigint NOT NULL DEFAULT 0;