Rename to "archive"

coder · Emyrk · Oct 5, 2023 · Oct 5, 2023 · Oct 5, 2023 · Oct 5, 2023
commit 9a416c3318d36447bbe4f70099467f1aa8a8f756
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
@@ -878,7 +878,7 @@ func (q *FakeQuerier) ArchiveUnusedTemplateVersions(_ context.Context, arg datab
 		usedVersions[tpl.ActiveVersionID] = true
 	}
 
-	var deleted []uuid.UUID
+	var archived []uuid.UUID
 	for i, v := range q.templateVersions {
 		if v.Archived {
 			continue
@@ -905,11 +905,11 @@ func (q *FakeQuerier) ArchiveUnusedTemplateVersions(_ context.Context, arg datab
 
 			v.Archived = true
 			q.templateVersions[i] = v
-			deleted = append(deleted, v.ID)
+			archived = append(archived, v.ID)
 		}
 	}
 
-	return deleted, nil
+	return archived, nil
 }
 
 func (*FakeQuerier) CleanTailnetCoordinators(_ context.Context) error {
@@ -2825,7 +2825,7 @@ func (q *FakeQuerier) GetTemplateVersionsByTemplateID(_ context.Context, arg dat
 		if templateVersion.TemplateID.UUID != arg.TemplateID {
 			continue
 		}
-		if arg.Deleted.Valid && arg.Deleted.Bool != templateVersion.Deleted {
+		if arg.Archived.Valid && arg.Archived.Bool != templateVersion.Archived {
 			continue
 		}
 		version = append(version, q.templateVersionWithUserNoLock(templateVersion))

diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/.../000162_delete_template_versions.down.sql → ...000162_archive_template_versions.down.sql b/.../000162_delete_template_versions.down.sql → ...000162_archive_template_versions.down.sql
diff --git a/...ns/000162_delete_template_versions.up.sql → ...s/000162_archive_template_versions.up.sql b/...ns/000162_delete_template_versions.up.sql → ...s/000162_archive_template_versions.up.sql
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversions.sql b/coderd/database/queries/templateversions.sql
@@ -150,7 +150,7 @@ SET
 	archived = true,
 	updated_at = sqlc.arg('updated_at')
 FROM
-	-- Delete all versions that are returned from this query.
+	-- Archive all versions that are returned from this query.
 	(
 		SELECT
 			scoped_template_versions.id

diff --git a/coderd/httpapi/queryparams.go b/coderd/httpapi/queryparams.go
@@ -79,6 +79,17 @@ func (p *QueryParamParser) Int(vals url.Values, def int, queryParam string) int
 	return v
 }
 
+func (p *QueryParamParser) Boolean(vals url.Values, def bool, queryParam string) bool {
+	v, err := parseQueryParam(p, vals, strconv.ParseBool, def, queryParam)
+	if err != nil {
+		p.Errors = append(p.Errors, codersdk.ValidationError{
+			Field:  queryParam,
+			Detail: fmt.Sprintf("Query param %q must be a valid boolean (%s)", queryParam, err.Error()),
+		})
+	}
+	return v
+}
+
 func (p *QueryParamParser) Required(queryParam string) *QueryParamParser {
 	p.RequiredParams[queryParam] = true
 	return p

diff --git a/coderd/httpapi/queryparams_test.go b/coderd/httpapi/queryparams_test.go
@@ -157,6 +157,48 @@ func TestParseQueryParams(t *testing.T) {
 		testQueryParams(t, expParams, parser, parser.String)
 	})
 
+	t.Run("Boolean", func(t *testing.T) {
+		t.Parallel()
+		expParams := []queryParamTestCase[bool]{
+			{
+				QueryParam: "valid_true",
+				Value:      "true",
+				Expected:   true,
+			},
+			{
+				QueryParam: "casing",
+				Value:      "True",
+				Expected:   true,
+			},
+			{
+				QueryParam: "all_caps",
+				Value:      "TRUE",
+				Expected:   true,
+			},
+			{
+				QueryParam: "no_value_true_def",
+				NoSet:      true,
+				Default:    true,
+				Expected:   true,
+			},
+			{
+				QueryParam: "no_value",
+				NoSet:      true,
+				Expected:   false,
+			},
+
+			{
+				QueryParam:            "invalid_boolean",
+				Value:                 "yes",
+				Expected:              false,
+				ExpectedErrorContains: "must be a valid boolean",
+			},
+		}
+
+		parser := httpapi.NewQueryParamParser()
+		testQueryParams(t, expParams, parser, parser.Boolean)
+	})
+
 	t.Run("Int", func(t *testing.T) {
 		t.Parallel()
 		expParams := []queryParamTestCase[int]{

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -193,11 +193,11 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 		})
 		return
 	}
-	if templateVersion.Deleted {
+	if templateVersion.Archived {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
-			Message: fmt.Sprintf("Template version %s is deleted.", createTemplate.VersionID),
+			Message: fmt.Sprintf("Template version %s is archived.", createTemplate.VersionID),
 			Validations: []codersdk.ValidationError{
-				{Field: "template_version_id", Detail: "Template version is deleted"},
+				{Field: "template_version_id", Detail: "Template version is archived"},
 			},
 		})
 		return

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -717,6 +717,17 @@ func (api *API) templateVersionsByTemplate(rw http.ResponseWriter, r *http.Reque
 		return
 	}
 
+	// If this throws an error, the boolean is false. Which is the default we want.
+	parser := httpapi.NewQueryParamParser()
+	includeArchived := parser.Boolean(r.URL.Query(), false, "include_archived")
+	if len(parser.Errors) > 0 {
+		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+			Message:     "Invalid query parameters.",
+			Validations: parser.Errors,
+		})
+		return
+	}
+
 	var err error
 	apiVersions := []codersdk.TemplateVersion{}
 	err = api.Database.InTx(func(store database.Store) error {
@@ -738,16 +749,21 @@ func (api *API) templateVersionsByTemplate(rw http.ResponseWriter, r *http.Reque
 			}
 		}
 
+		// Exclude archived templates versions
+		archiveFilter := sql.NullBool{
+			Bool:  false,
+			Valid: true,
+		}
+		if includeArchived {
+			archiveFilter = sql.NullBool{Valid: false}
+		}
+
 		versions, err := store.GetTemplateVersionsByTemplateID(ctx, database.GetTemplateVersionsByTemplateIDParams{
 			TemplateID: template.ID,
 			AfterID:    paginationParams.AfterID,
 			LimitOpt:   int32(paginationParams.Limit),
 			OffsetOpt:  int32(paginationParams.Offset),
-			// Exclude deleted templates versions
-			Deleted: sql.NullBool{
-				Bool:  false,
-				Valid: true,
-			},
+			Archived:   archiveFilter,
 		})
 		if errors.Is(err, sql.ErrNoRows) {
 			httpapi.Write(ctx, rw, http.StatusOK, apiVersions)
@@ -1033,7 +1049,7 @@ func (api *API) postArchiveTemplateVersions(rw http.ResponseWriter, r *http.Requ
 		status = database.NullProvisionerJobStatus{}
 	}
 
-	deleted, err := api.Database.ArchiveUnusedTemplateVersions(ctx, database.ArchiveUnusedTemplateVersionsParams{
+	archived, err := api.Database.ArchiveUnusedTemplateVersions(ctx, database.ArchiveUnusedTemplateVersionsParams{
 		UpdatedAt:  dbtime.Now(),
 		TemplateID: template.ID,
 		JobStatus:  status,
@@ -1055,7 +1071,7 @@ func (api *API) postArchiveTemplateVersions(rw http.ResponseWriter, r *http.Requ
 
 	httpapi.Write(ctx, rw, http.StatusOK, codersdk.ArchiveTemplateVersionsResponse{
 		TemplateID:  template.ID,
-		ArchivedIDs: deleted,
+		ArchivedIDs: archived,
 	})
 }
 
@@ -1478,6 +1494,7 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi
 			Username:  version.CreatedByUsername,
 			AvatarURL: version.CreatedByAvatarURL.String,
 		},
+		Archived: version.Archived,
 		Warnings: warnings,
 	}
 }