feat: archive template versions to hide them from the ui #10179
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| package cli | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "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) unarchiveTemplateVersion() *clibase.Cmd { | ||
| return r.setArchiveTemplateVersion(false) | ||
| } | ||
|
|
||
| func (r *RootCmd) archiveTemplateVersion() *clibase.Cmd { | ||
| return r.setArchiveTemplateVersion(true) | ||
| } | ||
|
|
||
| //nolint:revive | ||
| func (r *RootCmd) setArchiveTemplateVersion(archive bool) *clibase.Cmd { | ||
| presentVerb := "archive" | ||
| pastVerb := "archived" | ||
| if !archive { | ||
| presentVerb = "unarchive" | ||
| pastVerb = "unarchived" | ||
| } | ||
|
|
||
| client := new(codersdk.Client) | ||
| cmd := &clibase.Cmd{ | ||
| Use: presentVerb + " <template-name> [template-version-names...] ", | ||
| Short: strings.ToUpper(string(presentVerb[0])) + presentVerb[1:] + " a template version(s).", | ||
| Middleware: clibase.Chain( | ||
| r.InitClient(client), | ||
| ), | ||
| Options: clibase.OptionSet{ | ||
| cliui.SkipPromptOption(), | ||
| }, | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| var ( | ||
| ctx = inv.Context() | ||
| versions []codersdk.TemplateVersion | ||
| ) | ||
|
|
||
| organization, err := CurrentOrganization(inv, client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if len(inv.Args) == 0 { | ||
| return xerrors.Errorf("missing template name") | ||
| } | ||
| if len(inv.Args) < 2 { | ||
| return xerrors.Errorf("missing template version name(s)") | ||
| } | ||
|
|
||
| templateName := inv.Args[0] | ||
| template, err := client.TemplateByName(ctx, organization.ID, templateName) | ||
| if err != nil { | ||
| return xerrors.Errorf("get template by name: %w", err) | ||
| } | ||
| for _, versionName := range inv.Args[1:] { | ||
| version, err := client.TemplateVersionByOrganizationAndName(ctx, organization.ID, template.Name, versionName) | ||
| if err != nil { | ||
| return xerrors.Errorf("get template version by name %q: %w", versionName, err) | ||
| } | ||
| versions = append(versions, version) | ||
| } | ||
|
|
||
| for _, version := range versions { | ||
| if version.Archived == archive { | ||
| _, _ = fmt.Fprintln( | ||
| inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" already "+pastVerb), | ||
| ) | ||
| continue | ||
| } | ||
|
|
||
| err := client.SetArchiveTemplateVersion(ctx, version.ID, archive) | ||
| if err != nil { | ||
| return xerrors.Errorf("%s template version %q: %w", presentVerb, version.Name, err) | ||
| } | ||
|
|
||
| _, _ = fmt.Fprintln( | ||
| inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" "+pastVerb+" at "+cliui.Timestamp(time.Now())), | ||
| ) | ||
| } | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func (r *RootCmd) archiveTemplateVersions() *clibase.Cmd { | ||
| var all clibase.Bool | ||
| client := new(codersdk.Client) | ||
| cmd := &clibase.Cmd{ | ||
| Use: "archive [template-name...] ", | ||
| Short: "Archive unused failed template versions from a given template(s)", | ||
Emyrk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 archived.", | ||
| Flag: "all", | ||
| Value: &all, | ||
| }, | ||
| }, | ||
| Handler: func(inv *clibase.Invocation) error { | ||
| var ( | ||
| ctx = inv.Context() | ||
| templateNames = []string{} | ||
| templates = []codersdk.Template{} | ||
| ) | ||
|
|
||
| organization, err := CurrentOrganization(inv, client) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if len(inv.Args) > 0 { | ||
| templateNames = inv.Args | ||
|
|
||
| for _, templateName := range templateNames { | ||
| template, err := client.TemplateByName(ctx, organization.ID, templateName) | ||
| if err != nil { | ||
| return xerrors.Errorf("get template by name: %w", err) | ||
| } | ||
| templates = append(templates, template) | ||
| } | ||
| } else { | ||
| template, err := selectTemplate(inv, client, organization) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| templates = append(templates, template) | ||
| templateNames = append(templateNames, template.Name) | ||
| } | ||
|
|
||
| // Confirm archive of the template. | ||
| _, err = cliui.Prompt(inv, cliui.PromptOptions{ | ||
| Text: fmt.Sprintf("Archive template versions of these templates: %s?", pretty.Sprint(cliui.DefaultStyles.Code, strings.Join(templateNames, ", "))), | ||
| IsConfirm: true, | ||
| Default: cliui.ConfirmNo, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for _, template := range templates { | ||
| resp, err := client.ArchiveTemplateVersions(ctx, template.ID, all.Value()) | ||
| if err != nil { | ||
| return xerrors.Errorf("archive template %q: %w", template.Name, err) | ||
| } | ||
|
|
||
| _, _ = fmt.Fprintln( | ||
| inv.Stdout, fmt.Sprintf("Archived %d 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 { | ||
| data, err := json.Marshal(resp) | ||
| if err != nil { | ||
| return xerrors.Errorf("marshal verbose response: %w", err) | ||
| } | ||
| _, _ = fmt.Fprintln( | ||
| inv.Stdout, string(data), | ||
| ) | ||
| } | ||
| } | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| return cmd | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.