Commitd0ed107

authored

fix: Add command to reconnecting PTY (#1860)

Thisfixes#1708 and opens the door for PTYs to executenon-shell commands!

1 parent6052607 commitd0ed107Copy full SHA for d0ed107

File tree

+10

-8

lines changed

+10

-8

lines changed

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -456,8 +456,8 @@ func (a *agent) handleReconnectingPTY(ctx context.Context, rawID string, conn ne`
`456`	`456`
`457`	`457`	`// The ID format is referenced in conn.go.`
`458`	`458`	`// <uuid>:<height>:<width>`
`459`		`-idParts:=strings.Split(rawID,":")`
`460`		`-iflen(idParts)!=3 {`
	`459`	`+idParts:=strings.SplitN(rawID,":",4)`
	`460`	`+iflen(idParts)!=4 {`
`461`	`461`	`a.logger.Warn(ctx,"client sent invalid id format",slog.F("raw-id",rawID))`
`462`	`462`	`return`
`463`	`463`	`}`
`@@ -489,7 +489,7 @@ func (a *agent) handleReconnectingPTY(ctx context.Context, rawID string, conn ne`
`489`	`489`	`}`
`490`	`490`	`}else {`
`491`	`491`	`// Empty command will default to the users shell!`
`492`		`-cmd,err:=a.createCommand(ctx,"",nil)`
	`492`	`+cmd,err:=a.createCommand(ctx,idParts[3],nil)`
`493`	`493`	`iferr!=nil {`
`494`	`494`	`a.logger.Warn(ctx,"create reconnecting pty command",slog.Error(err))`
`495`	`495`	`return`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,7 @@ func TestAgent(t *testing.T) {`
`221`	`221`
`222`	`222`	`conn:=setupAgent(t, agent.Metadata{},0)`
`223`	`223`	`id:=uuid.NewString()`
`224`		`-netConn,err:=conn.ReconnectingPTY(id,100,100)`
	`224`	`+netConn,err:=conn.ReconnectingPTY(id,100,100,"/bin/bash")`
`225`	`225`	`require.NoError(t,err)`
`226`	`226`	`bufRead:=bufio.NewReader(netConn)`
`227`	`227`
`@@ -259,7 +259,7 @@ func TestAgent(t *testing.T) {`
`259`	`259`	`expectLine(matchEchoOutput)`
`260`	`260`
`261`	`261`	`_=netConn.Close()`
`262`		`-netConn,err=conn.ReconnectingPTY(id,100,100)`
	`262`	`+netConn,err=conn.ReconnectingPTY(id,100,100,"/bin/bash")`
`263`	`263`	`require.NoError(t,err)`
`264`	`264`	`bufRead=bufio.NewReader(netConn)`
`265`	`265`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,10 @@ type Conn struct {`
`34`	`34`
`35`	`35`	`// ReconnectingPTY returns a connection serving a TTY that can`
`36`	`36`	`// be reconnected to via ID.`
`37`		`-func (c*Conn)ReconnectingPTY(idstring,height,widthuint16) (net.Conn,error) {`
`38`		`-channel,err:=c.CreateChannel(context.Background(),fmt.Sprintf("%s:%d:%d",id,height,width),&peer.ChannelOptions{`
	`37`	`+//`
	`38`	`+// The command is optional and defaults to start a shell.`
	`39`	`+func (c*Conn)ReconnectingPTY(idstring,height,widthuint16,commandstring) (net.Conn,error) {`
	`40`	`+channel,err:=c.CreateChannel(context.Background(),fmt.Sprintf("%s:%d:%d:%s",id,height,width,command),&peer.ChannelOptions{`
`39`	`41`	`Protocol:ProtocolReconnectingPTY,`
`40`	`42`	`})`
`41`	`43`	`iferr!=nil {`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -381,7 +381,7 @@ func (api API) workspaceAgentPTY(rw http.ResponseWriter, r http.Request) {`
`381`	`381`	`return`
`382`	`382`	`}`
`383`	`383`	`deferagentConn.Close()`
`384`		`-ptNetConn,err:=agentConn.ReconnectingPTY(reconnect.String(),uint16(height),uint16(width))`
	`384`	`+ptNetConn,err:=agentConn.ReconnectingPTY(reconnect.String(),uint16(height),uint16(width),"")`
`385`	`385`	`iferr!=nil {`
`386`	`386`	`_=conn.Close(websocket.StatusInternalError,httpapi.WebsocketCloseSprintf("dial: %s",err))`
`387`	`387`	`return`

Comments

(0)