Simplify delete implementation

This commit is contained in:
Mislav Marohnić 2021-09-20 18:37:00 +02:00
parent c4f0eda96d
commit b894d3e134
2 changed files with 79 additions and 187 deletions

View file

@ -22,7 +22,10 @@ func chooseCodespace(ctx context.Context, apiClient *api.API, user *api.User) (*
if err != nil {
return nil, fmt.Errorf("error getting codespaces: %w", err)
}
return chooseCodespaceFromList(ctx, codespaces)
}
func chooseCodespaceFromList(ctx context.Context, codespaces []*api.Codespace) (*api.Codespace, error) {
if len(codespaces) == 0 {
return nil, errNoCodespaces
}

View file

@ -2,53 +2,57 @@ package main
import (
"context"
"errors"
"fmt"
"os"
"strings"
"sync"
"time"
"github.com/AlecAivazis/survey/v2"
"github.com/github/ghcs/cmd/ghcs/output"
"github.com/github/ghcs/internal/api"
"github.com/spf13/cobra"
"golang.org/x/sync/errgroup"
)
var now func() time.Time = time.Now
type deleteOptions struct {
deleteAll bool
skipConfirm bool
isInteractive bool
codespaceName string
repoFilter string
keepDays uint16
now func() time.Time
apiClient *api.API
}
func newDeleteCmd() *cobra.Command {
var (
codespace string
allCodespaces bool
repo string
force bool
keepThresholdDays int
)
opts := deleteOptions{
apiClient: api.New(os.Getenv("GITHUB_TOKEN")),
now: time.Now,
isInteractive: hasTTY,
}
log := output.NewLogger(os.Stdout, os.Stderr, false)
deleteCmd := &cobra.Command{
Use: "delete",
Short: "Delete a codespace",
RunE: func(cmd *cobra.Command, args []string) error {
switch {
case allCodespaces && repo != "":
return errors.New("both --all and --repo is not supported")
case allCodespaces:
return deleteAll(log, force, keepThresholdDays)
case repo != "":
return deleteByRepo(log, repo, force, keepThresholdDays)
default:
return delete_(log, codespace, force)
}
// switch {
// case allCodespaces && repo != "":
// return errors.New("both --all and --repo is not supported")
// case allCodespaces:
// return deleteAll(log, force, keepThresholdDays)
// case repo != "":
// return deleteByRepo(log, repo, force, keepThresholdDays)
log := output.NewLogger(os.Stdout, os.Stderr, false)
return delete(context.Background(), log, opts)
},
}
deleteCmd.Flags().StringVarP(&codespace, "codespace", "c", "", "Name of the codespace")
deleteCmd.Flags().BoolVar(&allCodespaces, "all", false, "Delete all codespaces")
deleteCmd.Flags().StringVarP(&repo, "repo", "r", "", "Delete all codespaces for a repository")
deleteCmd.Flags().BoolVarP(&force, "force", "f", false, "Delete codespaces with unsaved changes without confirmation")
deleteCmd.Flags().IntVar(&keepThresholdDays, "days", 0, "Minimum number of days since the codespace was created")
deleteCmd.Flags().StringVarP(&opts.codespaceName, "codespace", "c", "", "Delete codespace by `name`")
deleteCmd.Flags().BoolVar(&opts.deleteAll, "all", false, "Delete all codespaces")
deleteCmd.Flags().StringVarP(&opts.repoFilter, "repo", "r", "", "Delete codespaces for a repository")
deleteCmd.Flags().BoolVarP(&opts.skipConfirm, "force", "f", false, "Skip confirmation for codespaces that contain unsaved changes")
deleteCmd.Flags().Uint16Var(&opts.keepDays, "days", 0, "Delete codespaces older than `N` days")
return deleteCmd
}
@ -57,175 +61,78 @@ func init() {
rootCmd.AddCommand(newDeleteCmd())
}
func delete_(log *output.Logger, codespaceName string, force bool) error {
apiClient := api.New(os.Getenv("GITHUB_TOKEN"))
ctx := context.Background()
user, err := apiClient.GetUser(ctx)
func delete(ctx context.Context, log *output.Logger, opts deleteOptions) error {
user, err := opts.apiClient.GetUser(ctx)
if err != nil {
return fmt.Errorf("error getting user: %w", err)
}
codespace, token, err := getOrChooseCodespace(ctx, apiClient, user, codespaceName)
if err != nil {
return fmt.Errorf("get or choose codespace: %w", err)
}
confirmed, err := confirmDeletion(codespace, force)
if err != nil {
return fmt.Errorf("deletion could not be confirmed: %w", err)
}
if !confirmed {
return nil
}
if err := apiClient.DeleteCodespace(ctx, user, token, codespace.Name); err != nil {
return fmt.Errorf("error deleting codespace: %w", err)
}
log.Println("Codespace deleted.")
return list(&listOptions{})
}
func deleteAll(log *output.Logger, force bool, keepThresholdDays int) error {
apiClient := api.New(os.Getenv("GITHUB_TOKEN"))
ctx := context.Background()
user, err := apiClient.GetUser(ctx)
if err != nil {
return fmt.Errorf("error getting user: %w", err)
}
codespaces, err := apiClient.ListCodespaces(ctx, user)
codespaces, err := opts.apiClient.ListCodespaces(ctx, user)
if err != nil {
return fmt.Errorf("error getting codespaces: %w", err)
}
codespacesToDelete, err := filterCodespacesToDelete(codespaces, keepThresholdDays)
if err != nil {
return err
}
for _, c := range codespacesToDelete {
confirmed, err := confirmDeletion(c, force)
nameFilter := opts.codespaceName
if nameFilter == "" && !opts.deleteAll && opts.repoFilter == "" {
c, err := chooseCodespaceFromList(ctx, codespaces)
if err != nil {
return fmt.Errorf("deletion could not be confirmed: %w", err)
return fmt.Errorf("error choosing codespace: %w", err)
}
if !confirmed {
continue
}
token, err := apiClient.GetCodespaceToken(ctx, user.Login, c.Name)
if err != nil {
return fmt.Errorf("error getting codespace token: %w", err)
}
if err := apiClient.DeleteCodespace(ctx, user, token, c.Name); err != nil {
return fmt.Errorf("error deleting codespace: %w", err)
}
log.Printf("Codespace deleted: %s\n", c.Name)
nameFilter = c.Name
}
return list(&listOptions{})
}
func deleteByRepo(log *output.Logger, repo string, force bool, keepThresholdDays int) error {
apiClient := api.New(os.Getenv("GITHUB_TOKEN"))
ctx := context.Background()
user, err := apiClient.GetUser(ctx)
if err != nil {
return fmt.Errorf("error getting user: %w", err)
}
codespaces, err := apiClient.ListCodespaces(ctx, user)
if err != nil {
return fmt.Errorf("error getting codespaces: %w", err)
}
codespaces, err = filterCodespacesToDelete(codespaces, keepThresholdDays)
if err != nil {
return err
}
delete := func(name string) error {
token, err := apiClient.GetCodespaceToken(ctx, user.Login, name)
if err != nil {
return fmt.Errorf("error getting codespace token: %w", err)
}
if err := apiClient.DeleteCodespace(ctx, user, token, name); err != nil {
return fmt.Errorf("error deleting codespace: %w", err)
}
return nil
}
// Perform deletions in parallel, for performance,
// and to ensure all are attempted even if any one fails.
var (
found bool
mu sync.Mutex // guards errs, logger
errs []error
wg sync.WaitGroup
)
var codespacesToDelete []*api.Codespace
lastUpdatedCutoffTime := opts.now().AddDate(0, 0, -int(opts.keepDays))
for _, c := range codespaces {
if !strings.EqualFold(c.RepositoryNWO, repo) {
if nameFilter != "" && c.Name != nameFilter {
continue
}
confirmed, err := confirmDeletion(c, force)
if err != nil {
mu.Lock()
errs = append(errs, fmt.Errorf("deletion could not be confirmed: %w", err))
mu.Unlock()
if opts.repoFilter != "" && !strings.EqualFold(c.RepositoryNWO, opts.repoFilter) {
continue
}
if !confirmed {
continue
}
found = true
c := c
wg.Add(1)
go func() {
defer wg.Done()
err := delete(c.Name)
mu.Lock()
defer mu.Unlock()
if opts.keepDays > 0 {
t, err := time.Parse(time.RFC3339, c.LastUsedAt)
if err != nil {
errs = append(errs, err)
} else {
log.Printf("Codespace deleted: %s\n", c.Name)
return fmt.Errorf("error parsing last_used_at timestamp %q: %w", c.LastUsedAt, err)
}
if t.After(lastUpdatedCutoffTime) {
continue
}
}()
}
if !found {
return fmt.Errorf("no codespace was found for repository: %s", repo)
}
wg.Wait()
// Return first error, plus count of others.
if errs != nil {
err := errs[0]
if others := len(errs) - 1; others > 0 {
err = fmt.Errorf("%w (+%d more)", err, others)
}
return err
if nameFilter == "" || !opts.skipConfirm {
confirmed, err := confirmDeletion(c)
if err != nil {
return fmt.Errorf("deletion could not be confirmed: %w", err)
}
if !confirmed {
continue
}
}
codespacesToDelete = append(codespacesToDelete, c)
}
return nil
g := errgroup.Group{}
for _, c := range codespacesToDelete {
codespaceName := c.Name
g.Go(func() error {
token, err := opts.apiClient.GetCodespaceToken(ctx, user.Login, codespaceName)
if err != nil {
return fmt.Errorf("error getting codespace token: %w", err)
}
if err := opts.apiClient.DeleteCodespace(ctx, user, token, codespaceName); err != nil {
return fmt.Errorf("error deleting codespace: %w", err)
}
return nil
})
}
return g.Wait()
}
func confirmDeletion(codespace *api.Codespace, force bool) (bool, error) {
func confirmDeletion(codespace *api.Codespace) (bool, error) {
gs := codespace.Environment.GitStatus
hasUnsavedChanges := gs.HasUncommitedChanges || gs.HasUnpushedChanges
if force || !hasUnsavedChanges {
if !hasUnsavedChanges {
return true, nil
}
if !hasTTY {
@ -249,21 +156,3 @@ func confirmDeletion(codespace *api.Codespace, force bool) (bool, error) {
return confirmed.Confirmed, nil
}
func filterCodespacesToDelete(codespaces []*api.Codespace, keepThresholdDays int) ([]*api.Codespace, error) {
if keepThresholdDays < 0 {
return nil, fmt.Errorf("invalid value for threshold: %d", keepThresholdDays)
}
codespacesToDelete := []*api.Codespace{}
for _, codespace := range codespaces {
// get a date from a string representation
t, err := time.Parse(time.RFC3339, codespace.LastUsedAt)
if err != nil {
return nil, fmt.Errorf("error parsing last used at date: %w", err)
}
if t.Before(now().AddDate(0, 0, -keepThresholdDays)) && codespace.Environment.State == "Shutdown" {
codespacesToDelete = append(codespacesToDelete, codespace)
}
}
return codespacesToDelete, nil
}