Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 5 additions & 4 deletions cmd/machine/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,11 @@ func (cmd *SSHCmd) Run(ctx context.Context, args []string) error {
return devagent.InjectAgent(ctx, &devagent.InjectOptions{
Exec: func(ctx context.Context, command string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error {
return machineClient.Command(ctx, client.CommandOptions{
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
RawStdout: true,
})
},
IsLocal: machineClient.AgentLocal(),
Expand Down
9 changes: 5 additions & 4 deletions cmd/workspace/logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,11 @@ func injectLogsAgent(ctx context.Context, params injectLogsAgentParams) error {
return agent.InjectAgent(ctx, &agent.InjectOptions{
Exec: func(ctx context.Context, command string, stdinR io.Reader, stdoutW io.Writer, stderrW io.Writer) error {
return params.client.Command(ctx, clientpkg.CommandOptions{
Command: command,
Stdin: stdinR,
Stdout: stdoutW,
Stderr: stderrW,
Command: command,
Stdin: stdinR,
Stdout: stdoutW,
Stderr: stderrW,
RawStdout: true,
})
},
IsLocal: params.client.AgentLocal(),
Expand Down
9 changes: 5 additions & 4 deletions cmd/workspace/up/agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -255,10 +255,11 @@ func newAgentInjectFunc(
return agent.InjectAgent(cancelCtx, &agent.InjectOptions{
Exec: func(ctx context.Context, command string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error {
return client.Command(ctx, client2.CommandOptions{
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
RawStdout: true,
})
},
IsLocal: client.AgentLocal(),
Expand Down
1 change: 1 addition & 0 deletions pkg/agent/delivery/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ func CommandFunc(
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
RawStdout: true,
})
}
}
Expand Down
15 changes: 15 additions & 0 deletions pkg/agent/delivery/factory_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ import (

const testKubernetesInstallPath = "/home/vscode/.local/bin/devsy"

func TestCommandFuncPreservesProtocolStdout(t *testing.T) {
var got *driver.CommandParams
execFn := CommandFunc(func(_ context.Context, params *driver.CommandParams) error {
got = params
return nil
}, "workspace-id")

err := execFn(context.Background(), "test-command", nil, io.Discard, io.Discard)
require.NoError(t, err)
require.NotNil(t, got)
assert.Equal(t, "workspace-id", got.WorkspaceID)
assert.Equal(t, "test-command", got.Command)
assert.True(t, got.RawStdout)
}

func TestNewAgentDelivery_LocalDocker(t *testing.T) {
opts := FactoryOptions{
WorkspaceConfig: &provider.AgentWorkspaceInfo{
Expand Down
9 changes: 5 additions & 4 deletions pkg/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,11 @@ type StatusOptions struct {
}

type CommandOptions struct {
Command string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
Command string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
RawStdout bool
}

type CommandTransportOptions struct {
Expand Down
14 changes: 9 additions & 5 deletions pkg/client/clientimplementation/machine_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ type execConfig struct {
stderr io.Writer
extraEnv map[string]string
stdin io.Reader
rawStdout bool
withProgress bool
startMsg string
doneMsg string
Expand All @@ -87,6 +88,7 @@ func (e *machineExecutor) execute(ctx context.Context, cfg execConfig) error {
Stderr: cfg.stderr,
ExtraEnv: cfg.extraEnv,
Stdin: cfg.stdin,
RawStdout: cfg.rawStdout,
})
if err != nil {
return err
Expand Down Expand Up @@ -192,11 +194,12 @@ func (s *machineClient) Stop(ctx context.Context, options client.StopOptions) er

func (s *machineClient) Command(ctx context.Context, commandOptions client.CommandOptions) error {
return s.executor.execute(ctx, execConfig{
name: "command",
command: s.config.Exec.Command,
stdout: commandOptions.Stdout,
stderr: commandOptions.Stderr,
stdin: commandOptions.Stdin,
name: "command",
command: s.config.Exec.Command,
stdout: commandOptions.Stdout,
stderr: commandOptions.Stderr,
stdin: commandOptions.Stdin,
rawStdout: commandOptions.RawStdout,
extraEnv: map[string]string{
provider.CommandEnv: commandOptions.Command,
},
Expand All @@ -212,6 +215,7 @@ func (s *machineClient) OpenCommandTransport(
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,
RawStdout: true,
})
},
transport.CallbackConnOptions{
Expand Down
39 changes: 22 additions & 17 deletions pkg/client/clientimplementation/proxy_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,12 @@ type proxyExecutor struct {
}

type execParams struct {
command types.StrArray
extraEnv map[string]string
stdin io.Reader
stdout io.Writer
stderr io.Writer
command types.StrArray
extraEnv map[string]string
stdin io.Reader
stdout io.Writer
stderr io.Writer
rawStdout bool
}

// execute runs a proxy command with common settings.
Expand All @@ -83,6 +84,7 @@ func (e *proxyExecutor) execute(ctx context.Context, params execParams) error {
Stdin: params.stdin,
Stdout: params.stdout,
Stderr: params.stderr,
RawStdout: params.rawStdout,
})
}

Expand Down Expand Up @@ -241,10 +243,11 @@ func (s *proxyClient) Create(

func (s *proxyClient) Ssh(ctx context.Context, opt client.SshOptions) error {
return s.executor.executeWithJSONLog(ctx, execParams{
command: s.config.Exec.Proxy.Ssh,
extraEnv: EncodeOptions(opt, config.EnvFlagsSSH),
stdin: opt.Stdin,
stdout: opt.Stdout,
command: s.config.Exec.Proxy.Ssh,
extraEnv: EncodeOptions(opt, config.EnvFlagsSSH),
stdin: opt.Stdin,
stdout: opt.Stdout,
rawStdout: true,
})
}

Expand All @@ -256,10 +259,11 @@ func (s *proxyClient) OpenSSHTransport(
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,
command: s.config.Exec.Proxy.Ssh,
extraEnv: EncodeOptions(client.SshOptions{User: opt.User}, config.EnvFlagsSSH),
stdin: stdin,
stdout: stdout,
rawStdout: true,
})
},
transport.CallbackConnOptions{
Expand Down Expand Up @@ -291,10 +295,11 @@ func (s *proxyClient) Up(ctx context.Context, opt client.UpOptions) error {
}

return s.executor.executeWithJSONLog(ctx, execParams{
command: s.config.Exec.Proxy.Up,
extraEnv: opts,
stdin: opt.Stdin,
stdout: opt.Stdout,
command: s.config.Exec.Proxy.Up,
extraEnv: opts,
stdin: opt.Stdin,
stdout: opt.Stdout,
rawStdout: true,
})
}

Expand Down
76 changes: 53 additions & 23 deletions pkg/client/clientimplementation/workspace_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,12 @@ func (s *workspaceClient) Command(ctx context.Context, opt client.CommandOptions
}

return RunCommand(ctx, RunCommandOptions{
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: opt.Stdin,
Stdout: opt.Stdout,
Stderr: opt.Stderr,
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: opt.Stdin,
Stdout: opt.Stdout,
Stderr: opt.Stderr,
RawStdout: opt.RawStdout,
})
}

Expand All @@ -303,6 +304,7 @@ func (s *workspaceClient) OpenCommandTransport(
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: stdin, Stdout: stdout, Stderr: opt.Stderr,
RawStdout: true,
})
},
transport.CallbackConnOptions{
Expand Down Expand Up @@ -835,6 +837,7 @@ type WorkspaceCommandConfig struct {
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
RawStdout bool
Command types.StrArray
Workspace *provider.Workspace
Machine *provider.Machine
Expand All @@ -855,23 +858,25 @@ func RunCommandWithBinaries(ctx context.Context, cfg WorkspaceCommandConfig) err
}

return RunCommand(ctx, RunCommandOptions{
Command: cfg.Command,
Environ: environ,
Stdin: cfg.Stdin,
Stdout: cfg.Stdout,
Stderr: cfg.Stderr,
Command: cfg.Command,
Environ: environ,
Stdin: cfg.Stdin,
Stdout: cfg.Stdout,
Stderr: cfg.Stderr,
RawStdout: cfg.RawStdout,
})
}

type RunCommandOptions struct {
Command types.StrArray
Environ []string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
Command types.StrArray
Environ []string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
RawStdout bool
}

func RunCommand(ctx context.Context, opts RunCommandOptions) error {
func RunCommand(ctx context.Context, opts RunCommandOptions) (retErr error) {
if len(opts.Command) == 0 {
return nil
}
Expand All @@ -881,11 +886,21 @@ func RunCommand(ctx context.Context, opts RunCommandOptions) error {
}

redactor := secrets.NewEnvironmentRedactor(opts.Environ)
stdout := &subprocess.StreamingRedactingWriter{Next: opts.Stdout, Redactor: redactor}
stdout := opts.Stdout
var redactingStdout *subprocess.StreamingRedactingWriter
if !opts.RawStdout {
redactingStdout = &subprocess.StreamingRedactingWriter{
Next: opts.Stdout,
Redactor: redactor,
}
stdout = redactingStdout
}
stderr := &subprocess.StreamingRedactingWriter{Next: opts.Stderr, Redactor: redactor}
defer func() {
_ = stdout.Flush()
_ = stderr.Flush()
flushErr := flushCommandOutput(redactingStdout, stderr)
if retErr == nil {
retErr = flushErr
}
}()

if len(opts.Command) == 1 {
Expand Down Expand Up @@ -920,6 +935,20 @@ func RunCommand(ctx context.Context, opts RunCommandOptions) error {
return nil
}

func flushCommandOutput(stdout, stderr *subprocess.StreamingRedactingWriter) error {
var stdoutErr error
if stdout != nil {
if err := stdout.Flush(); err != nil {
stdoutErr = fmt.Errorf("flush provider stdout: %w", err)
}
}
var stderrErr error
if err := stderr.Flush(); err != nil {
stderrErr = fmt.Errorf("flush provider stderr: %w", err)
}
return errors.Join(stdoutErr, stderrErr)
}

// providerAction extracts the provider action from the environment variables.
func providerAction(environ []string) string {
for _, kv := range environ {
Expand Down Expand Up @@ -1202,10 +1231,11 @@ func runAgentInjection(ctx context.Context, cfg workspaceInjectionConfig) chan e
errChan <- agent.InjectAgent(ctx, &agent.InjectOptions{
Exec: func(ctx context.Context, command string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error {
return cfg.workspaceClient.Command(ctx, client.CommandOptions{
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
Command: command,
Stdin: stdin,
Stdout: stdout,
Stderr: stderr,
RawStdout: true,
})
},
IsLocal: cfg.workspaceClient.AgentLocal(),
Expand Down
Loading
Loading