feat(workspaces): persist operation journal

cmd/workspace/delete.go

@@ -87,38 +87,112 @@ func (cmd *DeleteCmd) Run(cobraCmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	var deleteErr error
-	var devsyConfig *config.Config
-	deleteErr = status.Run(
+	devsyConfig, err := cmd.loadConfig()
+	if err != nil {
+		return status.Run(ctx, reporter, status.Operation{Phase: status.PhaseDeletingWorkspace},
+			func(context.Context) error { return err })
+	}
+	if len(args) == 0 {
+		return cmd.deleteInteractively(ctx, reporter, devsyConfig)
+	}
+	targets := resolveDeleteTargets(ctx, devsyConfig, cmd.Owner, args)
+	if len(args) <= 1 {
+		reporter = withWorkspaceJournal(reporter, targets[journalWorkspaceKey(args)].ID)
+	}
+	deleteErr := status.Run(
 		ctx,
 		reporter,
 		status.Operation{Phase: status.PhaseDeletingWorkspace},
 		func(ctx context.Context) error {
-			var err error
-			devsyConfig, err = cmd.loadConfig()
-			if err != nil {
-				return err
-			}
 			if len(args) <= 1 {
-				return cmd.deleteSingle(status.WithReporter(ctx, reporter), devsyConfig, args)
+				return cmd.deleteSingle(
+					status.WithReporter(ctx, reporter),
+					devsyConfig,
+					targets[journalWorkspaceKey(args)],
+					args,
+				)
 			}
-			return cmd.deleteMultiple(status.WithReporter(ctx, reporter), devsyConfig, args)
+			return cmd.deleteMultiple(ctx, devsyConfig, reporter, targets, args)
 		},
 	)
-	if devsyConfig == nil {
-		return deleteErr
-	}
 
-	count, countErr := workspace.CountLocalWorkspaces(devsyConfig.DefaultContext)
-	if countErr != nil {
-		log.Debugf("skipping workspace count gauge: %v", countErr)
-	} else {
-		telemetry.FromContext(ctx).RecordWorkspaceGauge(count)
+	recordWorkspaceCount(ctx, devsyConfig)
+
+	return deleteErr
+}
+
+// deleteInteractively resolves the deletion target with a single interactive
+// selection and deletes that same client, so the operation is journaled under
+// the workspace that is actually deleted.
+func (cmd *DeleteCmd) deleteInteractively(
+	ctx context.Context,
+	reporter status.Reporter,
+	devsyConfig *config.Config,
+) error {
+	client, err := workspace.Get(ctx, workspace.GetOptions{
+		DevsyConfig: devsyConfig,
+		Owner:       cmd.Owner,
+	})
+	if err != nil {
+		return status.Run(
+			ctx,
+			reporter,
+			status.Operation{Phase: status.PhaseDeletingWorkspace},
+			func(context.Context) error { return err },
+		)
 	}
 
+	deleteErr := cmd.deleteResolved(ctx, reporter, devsyConfig, client)
+	recordWorkspaceCount(ctx, devsyConfig)
+
 	return deleteErr
 }
 
+// deleteResolved deletes an already-resolved workspace client and journals
+// the operation under the client's workspace ID.
+func (cmd *DeleteCmd) deleteResolved(
+	ctx context.Context,
+	reporter status.Reporter,
+	devsyConfig *config.Config,
+	client client2.BaseWorkspaceClient,
+) error {
+	reporter = withWorkspaceJournal(reporter, client.Workspace())
+	return status.Run(
+		ctx,
+		reporter,
+		status.Operation{Phase: status.PhaseDeletingWorkspace},
+		func(ctx context.Context) error {
+			_, err := cmd.deleteClient(status.WithReporter(ctx, reporter), devsyConfig, client)
+			return err
+		},
+	)
+}
+
+func (cmd *DeleteCmd) deleteClient(
+	ctx context.Context,
+	devsyConfig *config.Config,
+	client client2.BaseWorkspaceClient,
+) (string, error) {
+	return workspace.Delete(ctx, workspace.DeleteOptions{
+		DevsyConfig:    devsyConfig,
+		Client:         client,
+		IgnoreNotFound: cmd.IgnoreNotFound,
+		Force:          cmd.Force,
+		ClientDelete:   cmd.DeleteOptions,
+		Owner:          cmd.Owner,
+	})
+}
+
+// recordWorkspaceCount reports the remaining local workspace count as a gauge.
+func recordWorkspaceCount(ctx context.Context, devsyConfig *config.Config) {
+	count, err := workspace.CountLocalWorkspaces(devsyConfig.DefaultContext)
+	if err != nil {
+		log.Debugf("skipping workspace count gauge: %v", err)
+		return
+	}
+	telemetry.FromContext(ctx).RecordWorkspaceGauge(count)
+}
+
 func (cmd *DeleteCmd) loadConfig() (*config.Config, error) {
 	_, err := clientimplementation.DecodeOptionsFromEnv(
 		config.EnvFlagsDelete,
@@ -138,9 +212,10 @@ func (cmd *DeleteCmd) loadConfig() (*config.Config, error) {
 func (cmd *DeleteCmd) deleteSingle(
 	ctx context.Context,
 	devsyConfig *config.Config,
+	target resolvedDeleteTarget,
 	args []string,
 ) error {
-	name, err := cmd.deleteWorkspace(ctx, devsyConfig, args)
+	name, err := cmd.deleteTarget(ctx, devsyConfig, target, args)
 	if err != nil {
 		return err
 	}
@@ -153,11 +228,20 @@ func (cmd *DeleteCmd) deleteSingle(
 func (cmd *DeleteCmd) deleteMultiple(
 	ctx context.Context,
 	devsyConfig *config.Config,
+	reporter status.Reporter,
+	targets map[string]resolvedDeleteTarget,
 	args []string,
 ) error {
 	var errs []error
 	for _, arg := range args {
-		name, err := cmd.deleteWorkspace(ctx, devsyConfig, []string{arg})
+		target := targets[arg]
+		targetReporter := withWorkspaceJournal(reporter, target.ID)
+		name, err := cmd.deleteTarget(
+			status.WithReporter(ctx, targetReporter),
+			devsyConfig,
+			target,
+			[]string{arg},
+		)
 		if err != nil {
 			errs = append(errs, fmt.Errorf("failed to delete workspace %s: %w", arg, err))
 
@@ -178,6 +262,21 @@ func (cmd *DeleteCmd) deleteMultiple(
 	return nil
 }
 
+// deleteTarget deletes one workspace. When the target carries a pre-resolved
+// client, deletion reuses it so the deleted workspace and the journal key
+// cannot diverge; otherwise it resolves the raw arguments.
+func (cmd *DeleteCmd) deleteTarget(
+	ctx context.Context,
+	devsyConfig *config.Config,
+	target resolvedDeleteTarget,
+	args []string,
+) (string, error) {
+	if target.Client != nil {
+		return cmd.deleteClient(ctx, devsyConfig, target.Client)
+	}
+	return cmd.deleteWorkspace(ctx, devsyConfig, args)
+}
+
 func (cmd *DeleteCmd) deleteWorkspace(
 	ctx context.Context,
 	devsyConfig *config.Config,

cmd/workspace/delete_test.go

@@ -3,9 +3,17 @@ package workspace
 import (
 	"bytes"
 	"fmt"
+	"os"
 	"testing"
 
 	"github.com/devsy-org/devsy/cmd/flags"
+	client2 "github.com/devsy-org/devsy/pkg/client"
+	"github.com/devsy-org/devsy/pkg/config"
+	"github.com/devsy-org/devsy/pkg/log"
+	"github.com/devsy-org/devsy/pkg/platform"
+	"github.com/devsy-org/devsy/pkg/provider"
+	"github.com/devsy-org/devsy/pkg/status"
+	"github.com/devsy-org/devsy/pkg/workspacejournal"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -82,3 +90,132 @@ func TestDeleteCmd_Completion(t *testing.T) {
 	assert.Contains(t, completionOutput, fmt.Sprintf("%q", aliasRm))
 	assert.Contains(t, completionOutput, `"delete"`)
 }
+
+func TestDeleteCmd_DeleteResolvedJournalsUnderSelectedWorkspace(t *testing.T) {
+	log.Init(log.Config{Verbosity: 0})
+
+	home := t.TempDir()
+	t.Setenv("HOME", home)
+	t.Setenv("USERPROFILE", home)
+	config.ResetPathManager()
+	t.Cleanup(config.ResetPathManager)
+
+	fake := &fakeWorkspaceClient{
+		workspace: "chosen",
+		context:   testContext,
+		provider:  testProvider,
+		config:    &provider.Workspace{ID: "chosen", Context: testContext},
+	}
+	cmd := &DeleteCmd{
+		GlobalFlags:   &flags.GlobalFlags{ResultFormat: formatPlain},
+		DeleteOptions: client2.DeleteOptions{Force: true},
+	}
+	devsyConfig := &config.Config{
+		DefaultContext: testContext,
+		Contexts:       map[string]*config.ContextConfig{testContext: {}},
+	}
+	reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false)
+	require.NoError(t, err)
+
+	captureStdout(t, func() {
+		require.NoError(t, cmd.deleteResolved(t.Context(), reporter, devsyConfig, fake))
+	})
+	require.True(t, fake.deleted)
+
+	dir, err := workspacejournal.DefaultDir()
+	require.NoError(t, err)
+	events, err := workspacejournal.Read(dir, "chosen", workspacejournal.DefaultLimit)
+	require.NoError(t, err)
+	require.NotEmpty(t, events)
+
+	hasDeletePhase := false
+	for _, event := range events {
+		if event.Phase == status.PhaseDeletingWorkspace {
+			hasDeletePhase = true
+		}
+	}
+	assert.True(t, hasDeletePhase, "expected a delete-phase journal event, got %+v", events)
+}
+
+func TestDeleteCmd_DeleteMultipleReusesResolvedClients(t *testing.T) {
+	log.Init(log.Config{Verbosity: 0})
+
+	home := t.TempDir()
+	t.Setenv("HOME", home)
+	t.Setenv("USERPROFILE", home)
+	config.ResetPathManager()
+	t.Cleanup(config.ResetPathManager)
+
+	idA, idB := "chosen-a", "chosen-b"
+	argA, argB := "arg-a", "arg-b"
+	newFake := func(id string) *fakeWorkspaceClient {
+		return &fakeWorkspaceClient{
+			workspace: id,
+			context:   testContext,
+			provider:  testProvider,
+			config:    &provider.Workspace{ID: id, Context: testContext},
+		}
+	}
+	fakeA := newFake(idA)
+	fakeB := newFake(idB)
+	cmd := &DeleteCmd{
+		GlobalFlags:   &flags.GlobalFlags{ResultFormat: formatPlain},
+		DeleteOptions: client2.DeleteOptions{Force: true},
+	}
+	devsyConfig := &config.Config{
+		DefaultContext: testContext,
+		Contexts:       map[string]*config.ContextConfig{testContext: {}},
+	}
+	reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false)
+	require.NoError(t, err)
+
+	targets := map[string]resolvedDeleteTarget{
+		argA: {ID: idA, Client: fakeA},
+		argB: {ID: idB, Client: fakeB},
+	}
+	captureStdout(t, func() {
+		require.NoError(t, cmd.deleteMultiple(
+			t.Context(),
+			devsyConfig,
+			reporter,
+			targets,
+			[]string{argA, argB},
+		))
+	})
+	require.True(t, fakeA.deleted)
+	require.True(t, fakeB.deleted)
+
+	dir, err := workspacejournal.DefaultDir()
+	require.NoError(t, err)
+	for _, id := range []string{idA, idB} {
+		events, err := workspacejournal.Read(dir, id, workspacejournal.DefaultLimit)
+		require.NoError(t, err)
+		assert.NotEmpty(t, events, "expected journaled events under %s", id)
+	}
+}
+
+func TestResolveDeleteTargets_FallsBackToRawArgument(t *testing.T) {
+	log.Init(log.Config{Verbosity: 0})
+
+	home := t.TempDir()
+	t.Setenv("HOME", home)
+	t.Setenv("USERPROFILE", home)
+	config.ResetPathManager()
+	t.Cleanup(config.ResetPathManager)
+
+	missingArg := "missing"
+	devsyConfig := &config.Config{
+		DefaultContext: testContext,
+		Contexts:       map[string]*config.ContextConfig{testContext: {}},
+	}
+	targets := resolveDeleteTargets(
+		t.Context(),
+		devsyConfig,
+		platform.OwnerFilter(""),
+		[]string{missingArg},
+	)
+	target, ok := targets[missingArg]
+	require.True(t, ok)
+	assert.Equal(t, missingArg, target.ID)
+	assert.Nil(t, target.Client)
+}