Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
ede9aab
feat(transport): add managed connection foundation
skevetter Sep 2, 2026
708ef50
refactor(ssh): migrate machine transport
skevetter Sep 2, 2026
bc08d60
refactor(ssh): migrate devcontainer transport
skevetter Sep 2, 2026
e420924
refactor(ssh): migrate workspace outer transport
skevetter Sep 2, 2026
143ae53
docs(transport): clarify bridge ownership
skevetter Sep 2, 2026
8063dc6
refactor(ssh): migrate generic tunnel transport
skevetter Sep 2, 2026
177a62c
test(transport): cover managed connections
skevetter Sep 2, 2026
6aef08a
test(ssh): validate session transport inputs
skevetter Sep 2, 2026
6049ed6
test(transport): cover lifecycle precedence
skevetter Sep 2, 2026
61f0b3e
test(transport): cover concurrent shutdown
skevetter Sep 2, 2026
04c4ef4
feat(client): add managed command transport
skevetter Sep 2, 2026
02f85d4
refactor(transport): remove legacy lifecycle code
skevetter Sep 2, 2026
cf8ae07
fix(transport): address review findings
skevetter Sep 2, 2026
52b0925
fix(transport): resolve lint findings
skevetter Sep 2, 2026
748d55f
fix(ssh): create session pipes before starting command
skevetter Sep 2, 2026
a5b3924
fix(tunnel): wait for config-update goroutine before closing ssh client
skevetter Sep 3, 2026
175564a
test(tunnel): make shutdown-ordering test deterministic
skevetter Sep 3, 2026
8833287
style: update comments
skevetter Sep 3, 2026
9d591f0
refactor(transport): stop storing context.Context on PersistentLifecycle
skevetter Sep 3, 2026
616bc94
style: trim NewPersistentLifecycle doc comment
skevetter Sep 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions cmd/machine/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"github.com/devsy-org/devsy/pkg/pty"
devssh "github.com/devsy-org/devsy/pkg/ssh"
devsshagent "github.com/devsy-org/devsy/pkg/ssh/agent"
"github.com/devsy-org/devsy/pkg/tunnel"
"github.com/devsy-org/devsy/pkg/transport"
"github.com/devsy-org/devsy/pkg/workspace"
"github.com/spf13/cobra"
"golang.org/x/crypto/ssh"
Expand Down Expand Up @@ -66,6 +66,7 @@ type StartSSHSessionOptions struct {
Command string
AgentForwarding bool
SessionOptions SSHSessionOptions
OpenTransport func(context.Context) (transport.ManagedConn, error)
Exec ExecFunc
Stderr io.Writer
}
Expand Down Expand Up @@ -180,18 +181,36 @@ func (cmd *SSHCmd) Run(ctx context.Context, args []string) error {
type ExecFunc func(ctx context.Context, stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func StartSSHSession(ctx context.Context, options StartSSHSessionOptions) error {
pb, err := tunnel.NewPipeBridge()
openTransport := options.OpenTransport
if openTransport == nil {
if options.Exec == nil {
return errors.New("open transport or exec function is required")
}
openTransport = func(ctx context.Context) (transport.ManagedConn, error) {
return transport.OpenCallbackConn(ctx, func(
ctx context.Context,
stdin io.Reader,
stdout io.Writer,
) error {
return options.Exec(ctx, stdin, stdout, options.Stderr)
}, transport.CallbackConnOptions{
LocalAddr: transport.NewAddr("machine"),
RemoteAddr: transport.NewAddr("provider"),
})
}
}

conn, err := openTransport(ctx)
if err != nil {
return err
}
defer pb.Close()

return pb.RunPair(ctx,
func(ctx context.Context, stdin, stdout *os.File) error {
return options.Exec(ctx, stdin, stdout, options.Stderr)
},
func(ctx context.Context, stdout, stdin *os.File) error {
sshClient, err := devssh.StdioClientWithUser(stdout, stdin, options.User)
return transport.RunManaged(transport.RunManagedOptions{
Parent: ctx,
Conn: conn,
TransportSide: transport.SideProvider,
Metadata: transport.LogMetadata{Mode: "machine", TransportImpl: "callback"},
Handler: func(ctx context.Context) error {
sshClient, err := devssh.ClientFromConn(conn, options.User, nil)
if err != nil {
return err
}
Expand All @@ -204,7 +223,7 @@ func StartSSHSession(ctx context.Context, options StartSSHSessionOptions) error
Stderr: options.Stderr,
})
},
)
})
}

func RunSSHSession(ctx context.Context, sshClient *ssh.Client, options RunSSHSessionOptions) error {
Expand Down
34 changes: 19 additions & 15 deletions cmd/workspace/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/devsy-org/devsy/pkg/log"
"github.com/devsy-org/devsy/pkg/provider"
devssh "github.com/devsy-org/devsy/pkg/ssh"
"github.com/devsy-org/devsy/pkg/transport"
"github.com/devsy-org/devsy/pkg/tunnel"
workspace2 "github.com/devsy-org/devsy/pkg/workspace"
"github.com/spf13/cobra"
Expand Down Expand Up @@ -355,24 +356,27 @@ func (cmd *SSHCmd) startProxyTunnel(
client client2.ProxyClient,
) error {
log.Debugf("start proxy tunnel")
return tunnel.NewTunnelWithMetadata(
ctx,
func(ctx context.Context, stdin io.Reader, stdout io.Writer) error {
return client.Ssh(ctx, client2.SshOptions{
User: cmd.User,
Stdin: stdin,
Stdout: stdout,
})
conn, err := client.OpenSSHTransport(ctx, client2.SSHTransportOptions{User: cmd.User})
if err != nil {
return err
}
return transport.RunManaged(transport.RunManagedOptions{
Parent: ctx,
Conn: conn,
TransportSide: transport.SideProvider,
Metadata: transport.LogMetadata{
Provider: client.Provider(), Mode: "proxy",
Workspace: client.Workspace(), TransportImpl: "callback",
},
func(ctx context.Context, containerClient *ssh.Client) error {
Handler: func(ctx context.Context) error {
containerClient, err := devssh.ClientFromConn(conn, cmd.User, nil)
if err != nil {
return err
}
defer func() { _ = containerClient.Close() }()
return cmd.startTunnel(ctx, devsyConfig, containerClient, client)
},
tunnel.TransportLogMetadata{
Provider: client.Provider(),
Mode: "proxy",
Workspace: client.Workspace(),
},
)
})
}

func (cmd *SSHCmd) retrieveEnVars() (map[string]string, error) {
Expand Down
2 changes: 1 addition & 1 deletion cmd/workspace/up/agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ func newAgentInjectFunc(
return func(
cancelCtx context.Context,
sshCmd string,
sshTunnelStdinReader, sshTunnelStdoutWriter *os.File,
sshTunnelStdinReader io.Reader, sshTunnelStdoutWriter io.Writer,
writer io.WriteCloser,
) error {
return agent.InjectAgent(cancelCtx, &agent.InjectOptions{
Expand Down
24 changes: 24 additions & 0 deletions pkg/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/provider"
"github.com/devsy-org/devsy/pkg/status"
"github.com/devsy-org/devsy/pkg/transport"
"golang.org/x/crypto/ssh"
)

Expand Down Expand Up @@ -56,6 +57,12 @@ type Client interface {

// Command creates an SSH tunnel into the workspace
Command(ctx context.Context, options CommandOptions) error

// OpenCommandTransport starts a long-lived command as a managed connection.
OpenCommandTransport(
ctx context.Context,
options CommandTransportOptions,
) (transport.ManagedConn, error)
}

// ProxyClient executes it's commands on the platform.
Expand All @@ -70,6 +77,13 @@ type ProxyClient interface {

// Ssh starts an ssh tunnel to the workspace container
Ssh(ctx context.Context, options SshOptions) error

// OpenSSHTransport starts an SSH transport whose stdin/stdout carry the
// persistent SSH protocol.
OpenSSHTransport(
ctx context.Context,
options SSHTransportOptions,
) (transport.ManagedConn, error)
}

// DaemonClient connects to workspaces through a shared daemon.
Expand Down Expand Up @@ -160,6 +174,11 @@ type CommandOptions struct {
Stderr io.Writer
}

type CommandTransportOptions struct {
Command string
Stderr io.Writer
}

type UpOptions struct {
provider.CLIOptions

Expand All @@ -176,6 +195,11 @@ type SshOptions struct {
Stdout io.Writer
}

type SSHTransportOptions struct {
User string
Stderr io.Writer
}

type Status string

const (
Expand Down
19 changes: 19 additions & 0 deletions pkg/client/clientimplementation/machine_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/devsy-org/devsy/pkg/log"
"github.com/devsy-org/devsy/pkg/options"
"github.com/devsy-org/devsy/pkg/provider"
"github.com/devsy-org/devsy/pkg/transport"
"github.com/devsy-org/devsy/pkg/types"
)

Expand Down Expand Up @@ -202,6 +203,24 @@ func (s *machineClient) Command(ctx context.Context, commandOptions client.Comma
})
}

func (s *machineClient) OpenCommandTransport(
ctx context.Context,
opt client.CommandTransportOptions,
) (transport.ManagedConn, error) {
return transport.OpenCallbackConn(
ctx,
func(ctx context.Context, stdin io.Reader, stdout io.Writer) error {
return s.Command(ctx, client.CommandOptions{
Command: opt.Command, Stdin: stdin, Stdout: stdout, Stderr: opt.Stderr,
})
},
transport.CallbackConnOptions{
LocalAddr: transport.NewAddr("machine"),
RemoteAddr: transport.NewAddr("provider:" + s.Provider()),
},
)
}

func (s *machineClient) Status(
ctx context.Context,
options client.StatusOptions,
Expand Down
28 changes: 27 additions & 1 deletion pkg/client/clientimplementation/proxy_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
platformclient "github.com/devsy-org/devsy/pkg/platform/client"
"github.com/devsy-org/devsy/pkg/provider"
"github.com/devsy-org/devsy/pkg/terminal"
"github.com/devsy-org/devsy/pkg/transport"
"github.com/devsy-org/devsy/pkg/types"
"github.com/gofrs/flock"
)
Expand Down Expand Up @@ -94,7 +95,11 @@ func (e *proxyExecutor) execute(ctx context.Context, params execParams) error {
// where the actionable error message usually lives.
func (e *proxyExecutor) executeWithJSONLog(ctx context.Context, params execParams) error {
writer, done := log.PipeJSONStream()
params.stderr = writer
if params.stderr == nil {
params.stderr = writer
} else {
params.stderr = io.MultiWriter(writer, params.stderr)
}
err := e.execute(ctx, params)
_ = writer.Close()
<-done
Expand Down Expand Up @@ -243,6 +248,27 @@ func (s *proxyClient) Ssh(ctx context.Context, opt client.SshOptions) error {
})
}

func (s *proxyClient) OpenSSHTransport(
ctx context.Context,
opt client.SSHTransportOptions,
) (transport.ManagedConn, error) {
return transport.OpenCallbackConn(
ctx,
func(ctx context.Context, stdin io.Reader, stdout io.Writer) error {
return s.executor.executeWithJSONLog(ctx, execParams{
command: s.config.Exec.Proxy.Ssh,
extraEnv: EncodeOptions(client.SshOptions{User: opt.User}, config.EnvFlagsSSH),
stdin: stdin,
stdout: stdout,
})
},
transport.CallbackConnOptions{
LocalAddr: transport.NewAddr("proxy"),
RemoteAddr: transport.NewAddr("provider:" + s.config.Name),
},
)
}

func (s *proxyClient) Stop(ctx context.Context, opt client.StopOptions) error {
s.m.Lock()
defer s.m.Unlock()
Expand Down
25 changes: 25 additions & 0 deletions pkg/client/clientimplementation/workspace_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"github.com/devsy-org/devsy/pkg/ssh"
"github.com/devsy-org/devsy/pkg/status"
"github.com/devsy-org/devsy/pkg/task"
"github.com/devsy-org/devsy/pkg/transport"
"github.com/devsy-org/devsy/pkg/types"
"github.com/gofrs/flock"
)
Expand Down Expand Up @@ -285,6 +286,30 @@ func (s *workspaceClient) Command(ctx context.Context, opt client.CommandOptions
})
}

func (s *workspaceClient) OpenCommandTransport(
ctx context.Context,
opt client.CommandTransportOptions,
) (transport.ManagedConn, error) {
environ, err := s.buildEnvironment(opt.Command)
if err != nil {
return nil, err
}
return transport.OpenCallbackConn(
ctx,
func(ctx context.Context, stdin io.Reader, stdout io.Writer) error {
return RunCommand(ctx, RunCommandOptions{
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: stdin, Stdout: stdout, Stderr: opt.Stderr,
})
},
transport.CallbackConnOptions{
LocalAddr: transport.NewAddr("workspace"),
RemoteAddr: transport.NewAddr("provider:" + s.Provider()),
},
)
}

func (s *workspaceClient) Status(
ctx context.Context,
opt client.StatusOptions,
Expand Down
3 changes: 1 addition & 2 deletions pkg/devcontainer/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
"strings"
Expand Down Expand Up @@ -526,7 +525,7 @@ func (r *runner) executeSetup(
agentInjectFunc := func(
cancelCtx context.Context,
sshCmd string,
sshTunnelStdinReader, sshTunnelStdoutWriter *os.File,
sshTunnelStdinReader io.Reader, sshTunnelStdoutWriter io.Writer,
writer io.WriteCloser,
) error {
return r.driver.CommandDevContainer(cancelCtx, &driver.CommandParams{
Expand Down
Loading
Loading