Rename to archive

coder · Emyrk · Oct 5, 2023 · Oct 5, 2023 · Oct 5, 2023 · Oct 5, 2023
commit 02aa08524f632976fc54d405658d9f9747a565ad
diff --git a/cli/templates.go b/cli/templates.go
@@ -43,7 +43,7 @@ func (r *RootCmd) templates() *clibase.Cmd {
 			r.templateVersions(),
 			r.templateDelete(),
 			r.templatePull(),
-			r.templatePrune(),
+			r.archiveTemplateVersions(),
 		},
 	}
 

diff --git a/cli/templateprune.go → cli/templateversionarchive.go b/cli/templateprune.go → cli/templateversionarchive.go
@@ -6,31 +6,30 @@ import (
 	"strings"
 	"time"
 
-	"golang.org/x/xerrors"
-
 	"github.com/coder/pretty"
+	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/v2/cli/clibase"
 	"github.com/coder/coder/v2/cli/cliui"
 	"github.com/coder/coder/v2/codersdk"
 )
 
-func (r *RootCmd) templatePrune() *clibase.Cmd {
+func (r *RootCmd) archiveTemplateVersions() *clibase.Cmd {
 	var (
 		all clibase.Bool
 	)
 	client := new(codersdk.Client)
 	cmd := &clibase.Cmd{
-		Use:   "prune [name...]",
-		Short: "Prune unused failed template versions from a given template(s)",
+		Use:   "archive [name...] ",
+		Short: "Archive unused failed template versions from a given template(s)",
 		Middleware: clibase.Chain(
 			r.InitClient(client),
 		),
 		Options: clibase.OptionSet{
 			cliui.SkipPromptOption(),
 			clibase.Option{
 				Name:        "all",
-				Description: "Include all unused template versions. By default, only failed template versions are pruned.",
+				Description: "Include all unused template versions. By default, only failed template versions are archived.",
 				Flag:        "all",
 				Value:       &all,
 			},
@@ -67,9 +66,9 @@ func (r *RootCmd) templatePrune() *clibase.Cmd {
 				templateNames = append(templateNames, template.Name)
 			}
 
-			// Confirm prune of the template.
+			// Confirm archive of the template.
 			_, err = cliui.Prompt(inv, cliui.PromptOptions{
-				Text:      fmt.Sprintf("Prune template versions of these templates: %s?", pretty.Sprint(cliui.DefaultStyles.Code, strings.Join(templateNames, ", "))),
+				Text:      fmt.Sprintf("Archive template versions of these templates: %s?", pretty.Sprint(cliui.DefaultStyles.Code, strings.Join(templateNames, ", "))),
 				IsConfirm: true,
 				Default:   cliui.ConfirmNo,
 			})
@@ -78,13 +77,13 @@ func (r *RootCmd) templatePrune() *clibase.Cmd {
 			}
 
 			for _, template := range templates {
-				resp, err := client.PruneTemplateVersions(ctx, template.ID, all.Value())
+				resp, err := client.ArchiveTemplateVersions(ctx, template.ID, all.Value())
 				if err != nil {
-					return xerrors.Errorf("delete template %q: %w", template.Name, err)
+					return xerrors.Errorf("archive template versions for %q: %w", template.Name, err)
 				}
 
 				_, _ = fmt.Fprintln(
-					inv.Stdout, fmt.Sprintf("Deleted %s versions from "+pretty.Sprint(cliui.DefaultStyles.Keyword, template.Name)+" at "+cliui.Timestamp(time.Now()), len(resp.DeletedIDs)),
+					inv.Stdout, fmt.Sprintf("Archive %s versions from "+pretty.Sprint(cliui.DefaultStyles.Keyword, template.Name)+" at "+cliui.Timestamp(time.Now()), len(resp.ArchivedIDs)),
 				)
 
 				if ok, _ := inv.ParsedFlags().GetBool("verbose"); err == nil && ok {

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -671,7 +671,7 @@ func New(options *Options) *API {
 			r.Delete("/", api.deleteTemplate)
 			r.Patch("/", api.patchTemplateMeta)
 			r.Route("/versions", func(r chi.Router) {
-				r.Delete("/prune", api.deletePruneTemplateVersions)
+				r.Post("/archive", api.postArchiveTemplateVersions)
 				r.Get("/", api.templateVersionsByTemplate)
 				r.Patch("/", api.patchActiveTemplateVersion)
 				r.Get("/{templateversionname}", api.templateVersionByName)

diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
@@ -673,6 +673,17 @@ func (q *querier) AllUserIDs(ctx context.Context) ([]uuid.UUID, error) {
 	return q.db.AllUserIDs(ctx)
 }
 
+func (q *querier) ArchiveUnusedTemplateVersions(ctx context.Context, arg database.ArchiveUnusedTemplateVersionsParams) ([]uuid.UUID, error) {
+	tpl, err := q.db.GetTemplateByID(ctx, arg.TemplateID)
+	if err != nil {
+		return nil, err
+	}
+	if err := q.authorizeContext(ctx, rbac.ActionUpdate, tpl); err != nil {
+		return nil, err
+	}
+	return q.db.ArchiveUnusedTemplateVersions(ctx, arg)
+}
+
 func (q *querier) CleanTailnetCoordinators(ctx context.Context) error {
 	if err := q.authorizeContext(ctx, rbac.ActionDelete, rbac.ResourceTailnetCoordinator); err != nil {
 		return err
@@ -2242,17 +2253,6 @@ func (q *querier) InsertWorkspaceResourceMetadata(ctx context.Context, arg datab
 	return q.db.InsertWorkspaceResourceMetadata(ctx, arg)
 }
 
-func (q *querier) PruneUnusedTemplateVersions(ctx context.Context, arg database.PruneUnusedTemplateVersionsParams) ([]uuid.UUID, error) {
-	tpl, err := q.db.GetTemplateByID(ctx, arg.TemplateID)
-	if err != nil {
-		return nil, err
-	}
-	if err := q.authorizeContext(ctx, rbac.ActionUpdate, tpl); err != nil {
-		return nil, err
-	}
-	return q.db.PruneUnusedTemplateVersions(ctx, arg)
-}
-
 func (q *querier) RegisterWorkspaceProxy(ctx context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 	fetch := func(ctx context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 		return q.db.GetWorkspaceProxyByID(ctx, arg.ID)

diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -845,6 +845,73 @@ func (q *FakeQuerier) AllUserIDs(_ context.Context) ([]uuid.UUID, error) {
 	return userIDs, nil
 }
 
+func (q *FakeQuerier) ArchiveUnusedTemplateVersions(_ context.Context, arg database.ArchiveUnusedTemplateVersionsParams) ([]uuid.UUID, error) {
+	err := validateDatabaseType(arg)
+	if err != nil {
+		return nil, err
+	}
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+	type latestBuild struct {
+		Number  int32
+		Version uuid.UUID
+	}
+	latest := make(map[uuid.UUID]latestBuild)
+
+	for _, b := range q.workspaceBuilds {
+		v, ok := latest[b.WorkspaceID]
+		if ok || b.BuildNumber < v.Number {
+			// Not the latest
+			continue
+		}
+		latest[b.WorkspaceID] = latestBuild{
+			Number:  b.BuildNumber,
+			Version: b.TemplateVersionID,
+		}
+	}
+
+	usedVersions := make(map[uuid.UUID]bool)
+	for _, l := range latest {
+		usedVersions[l.Version] = true
+	}
+	for _, tpl := range q.templates {
+		usedVersions[tpl.ActiveVersionID] = true
+	}
+
+	var deleted []uuid.UUID
+	for i, v := range q.templateVersions {
+		if v.Archived {
+			continue
+		}
+
+		if _, ok := usedVersions[v.ID]; !ok {
+			var job *database.ProvisionerJob
+			for i, j := range q.provisionerJobs {
+				if v.JobID == j.ID {
+					job = &q.provisionerJobs[i]
+					break
+				}
+			}
+
+			if arg.JobStatus.Valid {
+				if job.JobStatus != arg.JobStatus.ProvisionerJobStatus {
+					continue
+				}
+			}
+
+			if job.JobStatus == database.ProvisionerJobStatusRunning || job.JobStatus == database.ProvisionerJobStatusPending {
+				continue
+			}
+
+			v.Archived = true
+			q.templateVersions[i] = v
+			deleted = append(deleted, v.ID)
+		}
+	}
+
+	return deleted, nil
+}
+
 func (*FakeQuerier) CleanTailnetCoordinators(_ context.Context) error {
 	return ErrUnimplemented
 }
@@ -5199,73 +5266,6 @@ func (q *FakeQuerier) InsertWorkspaceResourceMetadata(_ context.Context, arg dat
 	return metadata, nil
 }
 
-func (q *FakeQuerier) PruneUnusedTemplateVersions(_ context.Context, arg database.PruneUnusedTemplateVersionsParams) ([]uuid.UUID, error) {
-	err := validateDatabaseType(arg)
-	if err != nil {
-		return nil, err
-	}
-	q.mutex.Lock()
-	defer q.mutex.Unlock()
-	type latestBuild struct {
-		Number  int32
-		Version uuid.UUID
-	}
-	latest := make(map[uuid.UUID]latestBuild)
-
-	for _, b := range q.workspaceBuilds {
-		v, ok := latest[b.WorkspaceID]
-		if ok || b.BuildNumber < v.Number {
-			// Not the latest
-			continue
-		}
-		latest[b.WorkspaceID] = latestBuild{
-			Number:  b.BuildNumber,
-			Version: b.TemplateVersionID,
-		}
-	}
-
-	usedVersions := make(map[uuid.UUID]bool)
-	for _, l := range latest {
-		usedVersions[l.Version] = true
-	}
-	for _, tpl := range q.templates {
-		usedVersions[tpl.ActiveVersionID] = true
-	}
-
-	var deleted []uuid.UUID
-	for i, v := range q.templateVersions {
-		if v.Deleted {
-			continue
-		}
-
-		if _, ok := usedVersions[v.ID]; !ok {
-			var job *database.ProvisionerJob
-			for _, j := range q.provisionerJobs {
-				if v.JobID == j.ID {
-					job = &j
-					break
-				}
-			}
-
-			if arg.JobStatus.Valid {
-				if job.JobStatus != arg.JobStatus.ProvisionerJobStatus {
-					continue
-				}
-			}
-
-			if job.JobStatus == database.ProvisionerJobStatusRunning || job.JobStatus == database.ProvisionerJobStatusPending {
-				continue
-			}
-
-			v.Deleted = true
-			q.templateVersions[i] = v
-			deleted = append(deleted, v.ID)
-		}
-	}
-
-	return deleted, nil
-}
-
 func (q *FakeQuerier) RegisterWorkspaceProxy(_ context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()

diff --git a/coderd/database/dbmetrics/dbmetrics.go b/coderd/database/dbmetrics/dbmetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000162_delete_template_versions.down.sql b/coderd/database/migrations/000162_delete_template_versions.down.sql
@@ -4,7 +4,7 @@ BEGIN;
 DROP VIEW template_version_with_user;
 
 ALTER TABLE template_versions
-	DROP COLUMN deleted;
+	DROP COLUMN archived;
 
 -- Restore the old version of the template_version_with_user view.
 CREATE VIEW

diff --git a/coderd/database/migrations/000162_delete_template_versions.up.sql b/coderd/database/migrations/000162_delete_template_versions.up.sql
@@ -3,10 +3,9 @@ BEGIN;
 -- The view will be rebuilt with the new column
 DROP VIEW template_version_with_user;
 
--- Hard deleting can cause reference issues with audit logs,
--- so we only support soft deleting this resource at this time.
+-- Archived template versions are not visible or usable by default.
 ALTER TABLE template_versions
-    ADD COLUMN deleted BOOLEAN NOT NULL DEFAULT FALSE;
+    ADD COLUMN archived BOOLEAN NOT NULL DEFAULT FALSE;
 
 -- Restore the old version of the template_version_with_user view.
 CREATE VIEW
@@ -18,8 +17,8 @@ SELECT
 	coalesce(visible_users.username, '') AS created_by_username
 FROM
 	template_versions
-		LEFT JOIN
-	visible_users
+	LEFT JOIN
+		visible_users
 	ON
 			template_versions.created_by = visible_users.id;
 

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