fix(pro): when running devpod ssh through another SSH client (--stdio)

pascalbreuninger · pascalbreuninger · commit 163a96b4c0dd · 2025-04-02T13:25:37.000+01:00
we skip the remote workspace check as we don't need to let users select
a remote one.
diff --git a/cmd/export.go b/cmd/export.go
@@ -49,7 +49,7 @@ func NewExportCmd(flags *flags.GlobalFlags) *cobra.Command {
 func (cmd *ExportCmd) Run(ctx context.Context, devPodConfig *config.Config, args []string) error {
 	// try to load workspace
 	logger := log.Default.ErrorStreamOnly()
-	client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, logger)
+	client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, logger)
 	if err != nil {
 		return err
 	}
diff --git a/cmd/logs.go b/cmd/logs.go
@@ -49,7 +49,7 @@ func (cmd *LogsCmd) Run(ctx context.Context, args []string) error {
 		return err
 	}
 
-	baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)
+	baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)
 	if err != nil {
 		return err
 	}
diff --git a/cmd/logs_daemon.go b/cmd/logs_daemon.go
@@ -42,7 +42,7 @@ func (cmd *LogsDaemonCmd) Run(ctx context.Context, args []string) error {
 		return err
 	}
 
-	baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)
+	baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)
 	if err != nil {
 		return err
 	} else if baseClient.WorkspaceConfig().Machine.ID == "" {
diff --git a/cmd/ping.go b/cmd/ping.go
@@ -43,7 +43,7 @@ func (cmd *PingCmd) Run(ctx context.Context, args []string) error {
 		return err
 	}
 
-	client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, log.Default.ErrorStreamOnly())
+	client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, false, log.Default.ErrorStreamOnly())
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pro/delete.go b/cmd/pro/delete.go
@@ -130,7 +130,7 @@ func cleanupLocalWorkspaces(ctx context.Context, devPodConfig *config.Config, wo
 			wg.Add(1)
 			go func(w provider.Workspace) {
 				defer wg.Done()
-				client, err := workspace.Get(ctx, devPodConfig, []string{w.ID}, true, owner, log)
+				client, err := workspace.Get(ctx, devPodConfig, []string{w.ID}, true, owner, false, log)
 				if err != nil {
 					log.Errorf("Failed to get workspace %s: %v", w.ID, err)
 					return
diff --git a/cmd/ssh.go b/cmd/ssh.go
@@ -76,8 +76,13 @@ func NewSSHCmd(f *flags.GlobalFlags) *cobra.Command {
 				return err
 			}
 
+			localOnly := false
+			if cmd.Stdio {
+				localOnly = true
+			}
+
 			ctx := cobraCmd.Context()
-			client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, log.Default.ErrorStreamOnly())
+			client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, localOnly, log.Default.ErrorStreamOnly())
 			if err != nil {
 				return err
 			}
diff --git a/cmd/status.go b/cmd/status.go
@@ -47,7 +47,7 @@ func NewStatusCmd(flags *flags.GlobalFlags) *cobra.Command {
 			}
 
 			logger := log.Default.ErrorStreamOnly()
-			client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, logger)
+			client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, logger)
 			if err != nil {
 				return err
 			}
diff --git a/cmd/stop.go b/cmd/stop.go
@@ -42,7 +42,7 @@ func NewStopCmd(flags *flags.GlobalFlags) *cobra.Command {
 				return fmt.Errorf("decode platform options: %w", err)
 			}
 
-			client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)
+			client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)
 			if err != nil {
 				return err
 			}
diff --git a/cmd/troubleshoot.go b/cmd/troubleshoot.go
@@ -99,7 +99,7 @@ func (cmd *TroubleshootCmd) Run(ctx context.Context, args []string) {
 		info.Errors = append(info.Errors, PrintableError{fmt.Errorf("collect platform info: %w", err)})
 	}
 
-	workspaceClient, err := workspace.Get(ctx, info.Config, args, false, cmd.Owner, logger)
+	workspaceClient, err := workspace.Get(ctx, info.Config, args, false, cmd.Owner, false, logger)
 	if err == nil {
 		info.Workspace = workspaceClient.WorkspaceConfig()
 		info.WorkspaceStatus, err = workspaceClient.Status(ctx, client.StatusOptions{})
diff --git a/pkg/workspace/delete.go b/pkg/workspace/delete.go
@@ -14,7 +14,7 @@ import (
 
 func Delete(ctx context.Context, devPodConfig *config.Config, args []string, ignoreNotFound, force bool, deleteOptions client2.DeleteOptions, owner platform.OwnerFilter, log log.Logger) (string, error) {
 	// try to load workspace
-	client, err := Get(ctx, devPodConfig, args, false, owner, log)
+	client, err := Get(ctx, devPodConfig, args, false, owner, false, log)
 	if err != nil {
 		if len(args) == 0 {
 			return "", fmt.Errorf("cannot delete workspace because there was an error loading the workspace: %w. Please specify the id of the workspace you want to delete. E.g. 'devpod delete my-workspace --force'", err)
diff --git a/pkg/workspace/workspace.go b/pkg/workspace/workspace.go
@@ -133,7 +133,7 @@ func getWorkspaceClient(devPodConfig *config.Config, provider *providerpkg.Provi
 }
 
 // Get tries to retrieve an already existing workspace
-func Get(ctx context.Context, devPodConfig *config.Config, args []string, changeLastUsed bool, owner platform.OwnerFilter, log log.Logger) (client.BaseWorkspaceClient, error) {
+func Get(ctx context.Context, devPodConfig *config.Config, args []string, changeLastUsed bool, owner platform.OwnerFilter, localOnly bool, log log.Logger) (client.BaseWorkspaceClient, error) {
 	var (
 		provider  *providerpkg.ProviderConfig
 		workspace *providerpkg.Workspace
@@ -148,7 +148,11 @@ func Get(ctx context.Context, devPodConfig *config.Config, args []string, change
 			return nil, err
 		}
 	} else {
-		workspace = findWorkspace(ctx, devPodConfig, args, "", owner, log)
+		if localOnly {
+			workspace = findLocalWorkspace(ctx, devPodConfig, args, "", log)
+		} else {
+			workspace = findWorkspace(ctx, devPodConfig, args, "", owner, log)
+		}
 		if workspace == nil {
 			return nil, fmt.Errorf("workspace %s doesn't exist", args[0])
 		}
@@ -468,9 +472,9 @@ func resolveWorkspaceConfig(
 	return workspace, nil
 }
 
-func findWorkspace(ctx context.Context, devPodConfig *config.Config, args []string, workspaceID string, owner platform.OwnerFilter, log log.Logger) *providerpkg.Workspace {
+func ensureWorkspaceID(args []string, workspaceID string) string {
 	if len(args) == 0 && workspaceID == "" {
-		return nil
+		return ""
 	}
 
 	if workspaceID == "" {
@@ -481,6 +485,37 @@ func findWorkspace(ctx context.Context, devPodConfig *config.Config, args []stri
 		workspaceID = ToID(name)
 	}
 
+	return workspaceID
+}
+
+func findLocalWorkspace(ctx context.Context, devPodConfig *config.Config, args []string, workspaceID string, log log.Logger) *providerpkg.Workspace {
+	workspaceID = ensureWorkspaceID(args, workspaceID)
+	if workspaceID == "" {
+		return nil
+	}
+
+	allWorkspaces, err := ListLocalWorkspaces(devPodConfig.DefaultContext, false, log)
+	if err != nil {
+		log.Debugf("failed to list workspaces: %v", err)
+		return nil
+	}
+
+	for _, workspace := range allWorkspaces {
+		if workspace.ID != workspaceID {
+			continue
+		}
+		return workspace
+	}
+
+	return nil
+}
+
+func findWorkspace(ctx context.Context, devPodConfig *config.Config, args []string, workspaceID string, owner platform.OwnerFilter, log log.Logger) *providerpkg.Workspace {
+	workspaceID = ensureWorkspaceID(args, workspaceID)
+	if workspaceID == "" {
+		return nil
+	}
+
 	allWorkspaces, err := List(ctx, devPodConfig, false, owner, log)
 	if err != nil {
 		log.Debugf("failed to list workspaces: %v", err)

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func NewExportCmd(flags flags.GlobalFlags) cobra.Command {`
`49`	`49`	`func (cmd ExportCmd) Run(ctx context.Context, devPodConfig config.Config, args []string) error {`
`50`	`50`	`// try to load workspace`
`51`	`51`	`logger := log.Default.ErrorStreamOnly()`
`52`		`- client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, logger)`
	`52`	`+ client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, logger)`
`53`	`53`	`if err != nil {`
`54`	`54`	`return err`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func (cmd *LogsCmd) Run(ctx context.Context, args []string) error {`
`49`	`49`	`return err`
`50`	`50`	`}`
`51`	`51`
`52`		`- baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)`
	`52`	`+ baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)`
`53`	`53`	`if err != nil {`
`54`	`54`	`return err`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ func (cmd *LogsDaemonCmd) Run(ctx context.Context, args []string) error {`
`42`	`42`	`return err`
`43`	`43`	`}`
`44`	`44`
`45`		`- baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)`
	`45`	`+ baseClient, err := workspace.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)`
`46`	`46`	`if err != nil {`
`47`	`47`	`return err`
`48`	`48`	`} else if baseClient.WorkspaceConfig().Machine.ID == "" {`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ func (cmd *PingCmd) Run(ctx context.Context, args []string) error {`
`43`	`43`	`return err`
`44`	`44`	`}`
`45`	`45`
`46`		`- client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, log.Default.ErrorStreamOnly())`
	`46`	`+ client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, false, log.Default.ErrorStreamOnly())`
`47`	`47`	`if err != nil {`
`48`	`48`	`return err`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,8 +76,13 @@ func NewSSHCmd(f flags.GlobalFlags) cobra.Command {`
`76`	`76`	`return err`
`77`	`77`	`}`
`78`	`78`
	`79`	`+ localOnly := false`
	`80`	`+ if cmd.Stdio {`
	`81`	`+ localOnly = true`
	`82`	`+ }`
	`83`	`+`
`79`	`84`	`ctx := cobraCmd.Context()`
`80`		`- client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, log.Default.ErrorStreamOnly())`
	`85`	`+ client, err := workspace2.Get(ctx, devPodConfig, args, true, cmd.Owner, localOnly, log.Default.ErrorStreamOnly())`
`81`	`86`	`if err != nil {`
`82`	`87`	`return err`
`83`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func NewStatusCmd(flags flags.GlobalFlags) cobra.Command {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`logger := log.Default.ErrorStreamOnly()`
`50`		`- client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, logger)`
	`50`	`+ client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, logger)`
`51`	`51`	`if err != nil {`
`52`	`52`	`return err`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ func NewStopCmd(flags flags.GlobalFlags) cobra.Command {`
`42`	`42`	`return fmt.Errorf("decode platform options: %w", err)`
`43`	`43`	`}`
`44`	`44`
`45`		`- client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, log.Default)`
	`45`	`+ client, err := workspace2.Get(ctx, devPodConfig, args, false, cmd.Owner, false, log.Default)`
`46`	`46`	`if err != nil {`
`47`	`47`	`return err`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ func (cmd *TroubleshootCmd) Run(ctx context.Context, args []string) {`
`99`	`99`	`info.Errors = append(info.Errors, PrintableError{fmt.Errorf("collect platform info: %w", err)})`
`100`	`100`	`}`
`101`	`101`
`102`		`- workspaceClient, err := workspace.Get(ctx, info.Config, args, false, cmd.Owner, logger)`
	`102`	`+ workspaceClient, err := workspace.Get(ctx, info.Config, args, false, cmd.Owner, false, logger)`
`103`	`103`	`if err == nil {`
`104`	`104`	`info.Workspace = workspaceClient.WorkspaceConfig()`
`105`	`105`	`info.WorkspaceStatus, err = workspaceClient.Status(ctx, client.StatusOptions{})`