Inject listener into tunnelserver instead of hardcoding stdio

Author: janekbaraniewski

cmd/build.go

@@ -14,6 +14,7 @@ import (
 	config2 "github.com/loft-sh/devpod/pkg/devcontainer/config"
 	"github.com/loft-sh/devpod/pkg/image"
 	"github.com/loft-sh/devpod/pkg/provider"
+	"github.com/loft-sh/devpod/pkg/stdio"
 	workspace2 "github.com/loft-sh/devpod/pkg/workspace"
 	"github.com/loft-sh/log"
 	"github.com/pkg/errors"
@@ -229,8 +230,7 @@ func buildAgentClient(ctx context.Context, workspaceClient client.WorkspaceClien
 	// create container etc.
 	result, err := tunnelserver.RunUpServer(
 		cancelCtx,
-		stdoutReader,
-		stdinWriter,
+		stdio.NewStdioListener(stdoutReader, stdinWriter, false),
 		workspaceClient.AgentInjectGitCredentials(cliOptions),
 		workspaceClient.AgentInjectDockerCredentials(cliOptions),
 		workspaceClient.WorkspaceConfig(),

cmd/up.go

@@ -38,6 +38,7 @@ import (
 	"github.com/loft-sh/devpod/pkg/port"
 	provider2 "github.com/loft-sh/devpod/pkg/provider"
 	devssh "github.com/loft-sh/devpod/pkg/ssh"
+	"github.com/loft-sh/devpod/pkg/stdio"
 	"github.com/loft-sh/devpod/pkg/telemetry"
 	"github.com/loft-sh/devpod/pkg/tunnel"
 	"github.com/loft-sh/devpod/pkg/util"
@@ -442,8 +443,7 @@ func (cmd *UpCmd) devPodUpProxy(
 	// create container etc.
 	result, err := tunnelserver.RunUpServer(
 		cancelCtx,
-		stdoutReader,
-		stdinWriter,
+		stdio.NewStdioListener(stdoutReader, stdinWriter, false),
 		true,
 		true,
 		client.WorkspaceConfig(),
@@ -562,8 +562,7 @@ func (cmd *UpCmd) devPodUpMachine(
 		func(ctx context.Context, stdin io.WriteCloser, stdout io.Reader) (*config2.Result, error) {
 			return tunnelserver.RunUpServer(
 				ctx,
-				stdout,
-				stdin,
+				stdio.NewStdioListener(stdout, stdin, false),
 				client.AgentInjectGitCredentials(cmd.CLIOptions),
 				client.AgentInjectDockerCredentials(cmd.CLIOptions),
 				client.WorkspaceConfig(),

pkg/agent/tunnelserver/tunnelserver.go

@@ -6,7 +6,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
-	"io"
+	"net"
 	"os"
 	"path/filepath"
 	"strings"
@@ -23,15 +23,14 @@ import (
 	"github.com/loft-sh/devpod/pkg/netstat"
 	"github.com/loft-sh/devpod/pkg/platform"
 	provider2 "github.com/loft-sh/devpod/pkg/provider"
-	"github.com/loft-sh/devpod/pkg/stdio"
 	"github.com/loft-sh/log"
 	"github.com/moby/patternmatcher/ignorefile"
 	perrors "github.com/pkg/errors"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
 )
 
-func RunServicesServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, allowGitCredentials, allowDockerCredentials bool, forwarder netstat.Forwarder, workspace *provider2.Workspace, log log.Logger, options ...Option) error {
+func RunServicesServer(ctx context.Context, lis net.Listener, allowGitCredentials, allowDockerCredentials bool, forwarder netstat.Forwarder, workspace *provider2.Workspace, log log.Logger, options ...Option) error {
 	opts := append(options, []Option{
 		WithForwarder(forwarder),
 		WithAllowGitCredentials(allowGitCredentials),
@@ -40,21 +39,21 @@ func RunServicesServer(ctx context.Context, reader io.Reader, writer io.WriteClo
 	}...)
 	tunnelServ := New(log, opts...)
 
-	return tunnelServ.Run(ctx, reader, writer)
+	return tunnelServ.Run(ctx, lis)
 }
 
-func RunUpServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, allowGitCredentials, allowDockerCredentials bool, workspace *provider2.Workspace, log log.Logger, options ...Option) (*config.Result, error) {
+func RunUpServer(ctx context.Context, lis net.Listener, allowGitCredentials, allowDockerCredentials bool, workspace *provider2.Workspace, log log.Logger, options ...Option) (*config.Result, error) {
 	opts := append(options, []Option{
 		WithWorkspace(workspace),
 		WithAllowGitCredentials(allowGitCredentials),
 		WithAllowDockerCredentials(allowDockerCredentials),
 	}...)
 	tunnelServ := New(log, opts...)
 
-	return tunnelServ.RunWithResult(ctx, reader, writer)
+	return tunnelServ.RunWithResult(ctx, lis)
 }
 
-func RunSetupServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, allowGitCredentials, allowDockerCredentials bool, mounts []*config.Mount, log log.Logger, options ...Option) (*config.Result, error) {
+func RunSetupServer(ctx context.Context, lis net.Listener, allowGitCredentials, allowDockerCredentials bool, mounts []*config.Mount, log log.Logger, options ...Option) (*config.Result, error) {
 	opts := append(options, []Option{
 		WithMounts(mounts),
 		WithAllowGitCredentials(allowGitCredentials),
@@ -64,7 +63,7 @@ func RunSetupServer(ctx context.Context, reader io.Reader, writer io.WriteCloser
 	tunnelServ := New(log, opts...)
 	tunnelServ.allowPlatformOptions = true
 
-	return tunnelServ.RunWithResult(ctx, reader, writer)
+	return tunnelServ.RunWithResult(ctx, lis)
 }
 
 func New(log log.Logger, options ...Option) *tunnelServer {
@@ -96,8 +95,7 @@ type tunnelServer struct {
 	platformOptions *devpod.PlatformOptions
 }
 
-func (t *tunnelServer) RunWithResult(ctx context.Context, reader io.Reader, writer io.WriteCloser) (*config.Result, error) {
-	lis := stdio.NewStdioListener(reader, writer, false)
+func (t *tunnelServer) RunWithResult(ctx context.Context, lis net.Listener) (*config.Result, error) {
 	s := grpc.NewServer()
 	tunnel.RegisterTunnelServer(s, t)
 	reflection.Register(s)
@@ -114,8 +112,8 @@ func (t *tunnelServer) RunWithResult(ctx context.Context, reader io.Reader, writ
 	}
 }
 
-func (t *tunnelServer) Run(ctx context.Context, reader io.Reader, writer io.WriteCloser) error {
-	_, err := t.RunWithResult(ctx, reader, writer)
+func (t *tunnelServer) Run(ctx context.Context, lis net.Listener) error {
+	_, err := t.RunWithResult(ctx, lis)
 	return err
 }
 

pkg/devcontainer/setup.go

@@ -20,6 +20,7 @@ import (
 	"github.com/loft-sh/devpod/pkg/driver"
 	"github.com/loft-sh/devpod/pkg/ide"
 	provider2 "github.com/loft-sh/devpod/pkg/provider"
+	"github.com/loft-sh/devpod/pkg/stdio"
 	"github.com/loft-sh/log"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
@@ -127,8 +128,7 @@ func (r *runner) setupContainer(
 	runSetupServer := func(ctx context.Context, stdin io.WriteCloser, stdout io.Reader) (*config.Result, error) {
 		return tunnelserver.RunSetupServer(
 			ctx,
-			stdout,
-			stdin,
+			stdio.NewStdioListener(stdout, stdin, false),
 			r.WorkspaceConfig.Agent.InjectGitCredentials != "false",
 			r.WorkspaceConfig.Agent.InjectDockerCredentials != "false",
 			config.GetMounts(result),

pkg/tunnel/services.go

@@ -24,6 +24,7 @@ import (
 	"github.com/loft-sh/devpod/pkg/netstat"
 	"github.com/loft-sh/devpod/pkg/provider"
 	devssh "github.com/loft-sh/devpod/pkg/ssh"
+	"github.com/loft-sh/devpod/pkg/stdio"
 	"github.com/loft-sh/log"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
@@ -92,11 +93,11 @@ func RunServices(
 		go func() {
 			defer cancel()
 			defer stdinWriter.Close()
-			// forward credentials to container
+			// TODO: pass either stdio or network listener depending on whether or not we're using the platform
+			// Start local credentials server and forward credentials to container
 			err := tunnelserver.RunServicesServer(
 				cancelCtx,
-				stdoutReader,
-				stdinWriter,
+				stdio.NewStdioListener(stdoutReader, stdinWriter, false),
 				configureGitCredentials,
 				configureDockerCredentials,
 				forwarder,