feat: workspace bash background parameter

hugodutka · hugodutka · commit d10a6054f1bd · 2025-07-24T16:56:31.000Z
diff --git a/codersdk/toolsdk/bash.go b/codersdk/toolsdk/bash.go
@@ -3,6 +3,8 @@ package toolsdk
 import (
 	"bytes"
 	"context"
+	_ "embed"
+	"encoding/base64"
 	"errors"
 	"fmt"
 	"io"
@@ -18,19 +20,24 @@ import (
 	"github.com/coder/coder/v2/cli/cliui"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/codersdk/workspacesdk"
+	"github.com/coder/coder/v2/cryptorand"
 )
 
 type WorkspaceBashArgs struct {
-	Workspace string `json:"workspace"`
-	Command   string `json:"command"`
-	TimeoutMs int    `json:"timeout_ms,omitempty"`
+	Workspace  string `json:"workspace"`
+	Command    string `json:"command"`
+	TimeoutMs  int    `json:"timeout_ms,omitempty"`
+	Background bool   `json:"background,omitempty"`
 }
 
 type WorkspaceBashResult struct {
 	Output   string `json:"output"`
 	ExitCode int    `json:"exit_code"`
 }
 
+//go:embed resources/background.sh
+var backgroundScript string
+
 var WorkspaceBash = Tool[WorkspaceBashArgs, WorkspaceBashResult]{
 	Tool: aisdk.Tool{
 		Name: ToolNameWorkspaceBash,
@@ -53,6 +60,7 @@ If the command times out, all output captured up to that point is returned with
 Examples:
 - workspace: "my-workspace", command: "ls -la"
 - workspace: "john/dev-env", command: "git status", timeout_ms: 30000
+- workspace: "my-workspace", command: "npm run dev", background: true
 - workspace: "my-workspace.main", command: "docker ps"`,
 		Schema: aisdk.Schema{
 			Properties: map[string]any{
@@ -70,6 +78,10 @@ Examples:
 					"default":     60000,
 					"minimum":     1,
 				},
+				"background": map[string]any{
+					"type":        "boolean",
+					"description": "Whether to run the command in the background. The command will not be affected by the timeout.",
+				},
 			},
 			Required: []string{"workspace", "command"},
 		},
@@ -82,7 +94,7 @@ Examples:
 			return WorkspaceBashResult{}, xerrors.New("command cannot be empty")
 		}
 
-		ctx, cancel := context.WithTimeoutCause(ctx, 5*time.Minute, errors.New("MCP handler timeout after 5 min"))
+		ctx, cancel := context.WithTimeoutCause(ctx, 5*time.Minute, xerrors.New("MCP handler timeout after 5 min"))
 		defer cancel()
 
 		// Normalize workspace input to handle various formats
@@ -137,23 +149,41 @@ Examples:
 
 		// Set default timeout if not specified (60 seconds)
 		timeoutMs := args.TimeoutMs
+		defaultTimeoutMs := 60000
 		if timeoutMs <= 0 {
-			timeoutMs = 60000
+			timeoutMs = defaultTimeoutMs
+		}
+		command := args.Command
+		if args.Background {
+			// Background commands are not affected by the timeout
+			timeoutMs = defaultTimeoutMs
+			encodedCommand := base64.StdEncoding.EncodeToString([]byte(args.Command))
+			encodedScript := base64.StdEncoding.EncodeToString([]byte(backgroundScript))
+			commandID, err := cryptorand.StringCharset(cryptorand.Human, 8)
+			if err != nil {
+				return WorkspaceBashResult{}, xerrors.Errorf("failed to generate command ID: %w", err)
+			}
+			command = fmt.Sprintf(
+				"ARG_COMMAND=\"$(echo -n %s | base64 -d)\" ARG_COMMAND_ID=%s bash -c \"$(echo -n %s | base64 -d)\"",
+				encodedCommand,
+				commandID,
+				encodedScript,
+			)
 		}
 
 		// Create context with timeout
 		ctx, cancel = context.WithTimeout(ctx, time.Duration(timeoutMs)*time.Millisecond)
 		defer cancel()
 
 		// Execute command with timeout handling
-		output, err := executeCommandWithTimeout(ctx, session, args.Command)
+		output, err := executeCommandWithTimeout(ctx, session, command)
 		outputStr := strings.TrimSpace(string(output))
 
 		// Handle command execution results
 		if err != nil {
 			// Check if the command timed out
 			if errors.Is(context.Cause(ctx), context.DeadlineExceeded) {
-				outputStr += "\nCommand cancelled due to timeout"
+				outputStr += "\nCommand canceled due to timeout"
 				return WorkspaceBashResult{
 					Output:   outputStr,
 					ExitCode: 124,
@@ -386,7 +416,7 @@ func executeCommandWithTimeout(ctx context.Context, session *gossh.Session, comm
 		// Command completed normally
 		return safeWriter.Bytes(), err
 	case <-ctx.Done():
-		// Context was cancelled (timeout or other cancellation)
+		// Context was canceled (timeout or other cancellation)
 		// Close the session to stop the command
 		_ = session.Close()
 
diff --git a/codersdk/toolsdk/bash_test.go b/codersdk/toolsdk/bash_test.go
@@ -335,6 +335,6 @@ func TestWorkspaceBashTimeoutIntegration(t *testing.T) {
 		require.Equal(t, "normal command", result.Output)
 
 		// Should NOT contain timeout message
-		require.NotContains(t, result.Output, "Command cancelled due to timeout")
+		require.NotContains(t, result.Output, "Command canceled due to timeout")
 	})
 }
diff --git a/codersdk/toolsdk/resources/background.sh b/codersdk/toolsdk/resources/background.sh
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# This script is used to run a command in the background.
+
+set -o errexit
+set -o pipefail
+
+set -o nounset
+
+COMMAND="$ARG_COMMAND"
+COMMAND_ID="$ARG_COMMAND_ID"
+
+set +o nounset
+
+LOG_DIR="/tmp/mcp-bg"
+LOG_PATH="$LOG_DIR/$COMMAND_ID.log"
+mkdir -p "$LOG_DIR"
+
+nohup bash -c "$COMMAND" >"$LOG_PATH" 2>&1 &
+COMMAND_PID="$!"
+
+echo "Command started with PID: $COMMAND_PID"
+echo "Log path: $LOG_PATH"

Original file line number	Diff line number	Diff line change
`@@ -335,6 +335,6 @@ func TestWorkspaceBashTimeoutIntegration(t *testing.T) {`
`335`	`335`	`require.Equal(t, "normal command", result.Output)`
`336`	`336`
`337`	`337`	`// Should NOT contain timeout message`
`338`		`- require.NotContains(t, result.Output, "Command cancelled due to timeout")`
	`338`	`+ require.NotContains(t, result.Output, "Command canceled due to timeout")`
`339`	`339`	`})`
`340`	`340`	`}`