Move SSHAuthSockID to CLi options

loft-sh · Dec 18, 2024 · 990cb47 · 990cb47
1 parent 9e40c61
commit 990cb47
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 41 deletions.
diff --git a/cmd/agent/container_tunnel.go b/cmd/agent/container_tunnel.go
@@ -135,7 +135,7 @@ func startDevContainer(ctx context.Context, workspaceConfig *provider2.AgentWork
 
 func StartContainer(ctx context.Context, runner devcontainer.Runner, log log.Logger, workspaceConfig *provider2.AgentWorkspaceInfo) (*config.Result, error) {
 	log.Debugf("Starting DevPod container...")
-	result, err := runner.Up(ctx, devcontainer.UpOptions{NoBuild: true, AuthSockID: workspaceConfig.AuthSockID}, workspaceConfig.InjectTimeout)
+	result, err := runner.Up(ctx, devcontainer.UpOptions{NoBuild: true}, workspaceConfig.InjectTimeout)
 	if err != nil {
 		return result, err
 	}

diff --git a/cmd/agent/workspace/up.go b/cmd/agent/workspace/up.go
@@ -99,6 +99,7 @@ func (cmd *UpCmd) Run(ctx context.Context) error {
 }
 
 func (cmd *UpCmd) up(ctx context.Context, workspaceInfo *provider2.AgentWorkspaceInfo, tunnelClient tunnel.TunnelClient, logger log.Logger) error {
+
 	// create devcontainer
 	result, err := cmd.devPodUp(ctx, workspaceInfo, logger)
 	if err != nil {
@@ -128,7 +129,6 @@ func (cmd *UpCmd) devPodUp(ctx context.Context, workspaceInfo *provider2.AgentWo
 	result, err := runner.Up(ctx, devcontainer.UpOptions{
 		CLIOptions:    workspaceInfo.CLIOptions,
 		RegistryCache: workspaceInfo.RegistryCache,
-		AuthSockID:    workspaceInfo.AuthSockID,
 	}, workspaceInfo.InjectTimeout)
 	if err != nil {
 		return nil, err

diff --git a/cmd/up.go b/cmd/up.go
@@ -169,8 +169,11 @@ func (cmd *UpCmd) Run(
 	if cmd.IDE != "" {
 		targetIDE = cmd.IDE
 	}
-	if ide.ReusesAuthSock(targetIDE) {
-		cmd.AuthSockID = RandStringBytes(10)
+	if !cmd.Proxy && ide.ReusesAuthSock(targetIDE) {
+		cmd.SSHAuthSockID = RandStringBytes(10)
+		log.Debug("Reusing SSH_AUTH_SOCK", cmd.SSHAuthSockID)
+	} else if cmd.Proxy && ide.ReusesAuthSock(targetIDE) {
+		log.Info("Reusing SSH_AUTH_SOCK is not supported with proxy mode, consider launching the IDE from the platform UI")
 	}
 
 	// run devpod agent up
@@ -296,7 +299,7 @@ func (cmd *UpCmd) Run(
 				ideConfig.Options,
 				cmd.GitUsername,
 				cmd.GitToken,
-				cmd.AuthSockID,
+				cmd.SSHAuthSockID,
 				log,
 			)
 		case string(config.IDERustRover):
@@ -333,7 +336,7 @@ func (cmd *UpCmd) Run(
 				ideConfig.Options,
 				cmd.GitUsername,
 				cmd.GitToken,
-				cmd.AuthSockID,
+				cmd.SSHAuthSockID,
 				log,
 			)
 		case string(config.IDEJupyterDesktop):
@@ -346,7 +349,7 @@ func (cmd *UpCmd) Run(
 				ideConfig.Options,
 				cmd.GitUsername,
 				cmd.GitToken,
-				cmd.AuthSockID,
+				cmd.SSHAuthSockID,
 				log)
 		case string(config.IDEMarimo):
 			return startMarimoInBrowser(
@@ -358,7 +361,7 @@ func (cmd *UpCmd) Run(
 				ideConfig.Options,
 				cmd.GitUsername,
 				cmd.GitToken,
-				cmd.AuthSockID,
+				cmd.SSHAuthSockID,
 				log)
 		}
 	}

diff --git a/docs/internal/networking.md b/docs/internal/networking.md
diff --git a/pkg/client/clientimplementation/workspace_client.go b/pkg/client/clientimplementation/workspace_client.go
@@ -206,10 +206,6 @@ func (s *workspaceClient) agentInfo(cliOptions provider.CLIOptions) (string, *pr
 	// Set registry cache from context option
 	agentInfo.RegistryCache = s.devPodConfig.ContextOption(config.ContextOptionRegistryCache)
 
-	if cliOptions.AuthSockID != "" {
-		agentInfo.AuthSockID = cliOptions.AuthSockID
-	}
-
 	// marshal config
 	out, err := json.Marshal(agentInfo)
 	if err != nil {

diff --git a/pkg/devcontainer/run.go b/pkg/devcontainer/run.go
@@ -88,7 +88,6 @@ type UpOptions struct {
 	NoBuild       bool
 	ForceBuild    bool
 	RegistryCache string
-	AuthSockID    string
 }
 
 func (r *runner) Up(ctx context.Context, options UpOptions, timeout time.Duration) (*config.Result, error) {

diff --git a/pkg/devcontainer/setup.go b/pkg/devcontainer/setup.go
@@ -99,7 +99,7 @@ func (r *runner) setupContainer(
 	// ssh tunnel
 	sshTunnelCmd := fmt.Sprintf("'%s' helper ssh-server --stdio", agent.ContainerDevPodHelperLocation)
 	if ide.ReusesAuthSock(r.WorkspaceConfig.Workspace.IDE.Name) {
-		sshTunnelCmd += fmt.Sprintf(" --reuse-sock=%s", r.WorkspaceConfig.AuthSockID)
+		sshTunnelCmd += fmt.Sprintf(" --reuse-sock=%s", r.WorkspaceConfig.CLIOptions.SSHAuthSockID)
 	}
 	if r.Log.GetLevel() == logrus.DebugLevel {
 		sshTunnelCmd += " --debug"

diff --git a/pkg/provider/workspace.go b/pkg/provider/workspace.go
@@ -191,9 +191,6 @@ type AgentWorkspaceInfo struct {
 
 	// RegistryCache defines the registry to use for caching builds
 	RegistryCache string `json:"registryCache,omitempty"`
-
-	// ID to use when looking for SSH_AUTH_SOCK, defaults to a new random ID if not set (only used for browser IDEs)
-	AuthSockID string `json:"authSockID,omitempty"`
 }
 
 type CLIOptions struct {
@@ -220,6 +217,7 @@ type CLIOptions struct {
 	GitCloneStrategy           git.CloneStrategy `json:"gitCloneStrategy,omitempty"`
 	FallbackImage              string            `json:"fallbackImage,omitempty"`
 	GitSSHSigningKey           string            `json:"gitSshSigningKey,omitempty"`
+	SSHAuthSockID              string            `json:"sshAuthSockID,omitempty"` // ID to use when looking for SSH_AUTH_SOCK, defaults to a new random ID if not set (only used for browser IDEs)
 
 	// build options
 	Repository string   `json:"repository,omitempty"`
@@ -231,7 +229,6 @@ type CLIOptions struct {
 	ForceDockerless       bool   `json:"forceDockerless,omitempty"`
 	ForceInternalBuildKit bool   `json:"forceInternalBuildKit,omitempty"`
 	SSHKey                string `json:"sshkey,omitempty"`
-	AuthSockID            string `json:"authSockID,omitempty"`
 }
 
 type BuildOptions struct {