blob: d545a68e47961a6132800ce9930b05765707ebe1 [file] [log] [blame]
Earl Lee2e463fb2025-04-17 11:22:22 -07001// Package dockerimg
2package dockerimg
3
4import (
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00005 "archive/tar"
Earl Lee2e463fb2025-04-17 11:22:22 -07006 "bytes"
7 "context"
Philip Zeyliger5e227dd2025-04-21 15:55:29 -07008 "crypto/rand"
Earl Lee2e463fb2025-04-17 11:22:22 -07009 "crypto/sha256"
10 "encoding/hex"
11 "encoding/json"
12 "fmt"
13 "io"
14 "log/slog"
15 "net"
16 "net/http"
17 "os"
18 "os/exec"
19 "path/filepath"
20 "runtime"
21 "strings"
Josh Bleecher Snyder99570462025-05-05 10:26:14 -070022 "sync/atomic"
Earl Lee2e463fb2025-04-17 11:22:22 -070023 "time"
24
Sean McCullough7013e9e2025-05-14 02:03:58 +000025 "golang.org/x/crypto/ssh"
Josh Bleecher Snyder78707d62025-04-30 21:06:49 +000026 "sketch.dev/browser"
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -070027 "sketch.dev/embedded"
Sean McCulloughbaa2b592025-04-23 10:40:08 -070028 "sketch.dev/loop/server"
Earl Lee2e463fb2025-04-17 11:22:22 -070029 "sketch.dev/skribe"
30)
31
32// ContainerConfig holds all configuration for launching a container
33type ContainerConfig struct {
34 // SessionID is the unique identifier for this session
35 SessionID string
36
37 // LocalAddr is the initial address to use (though it may be overwritten later)
38 LocalAddr string
39
40 // SkabandAddr is the address of the skaband service if available
41 SkabandAddr string
42
David Crawshaw5a7b3692025-05-05 16:49:15 -070043 // Model is the name of the LLM model to use.
44 Model string
Earl Lee2e463fb2025-04-17 11:22:22 -070045
David Crawshaw5a7b3692025-05-05 16:49:15 -070046 // ModelURL is the URL of the LLM service.
47 ModelURL string
48
49 // ModelAPIKey is the API key for LLM service.
50 ModelAPIKey string
Earl Lee2e463fb2025-04-17 11:22:22 -070051
52 // Path is the local filesystem path to use
53 Path string
54
55 // GitUsername is the username to use for git operations
56 GitUsername string
57
58 // GitEmail is the email to use for git operations
59 GitEmail string
60
61 // OpenBrowser determines whether to open a browser automatically
62 OpenBrowser bool
63
64 // NoCleanup prevents container cleanup when set to true
65 NoCleanup bool
66
67 // ForceRebuild forces rebuilding of the Docker image even if it exists
68 ForceRebuild bool
69
Philip Zeyliger983b58a2025-07-02 19:42:08 -070070 // BaseImage is the base Docker image to use for layering the repo
71 BaseImage string
72
Earl Lee2e463fb2025-04-17 11:22:22 -070073 // Host directory to copy container logs into, if not set to ""
74 ContainerLogDest string
75
76 // Path to pre-built linux sketch binary, or build a new one if set to ""
77 SketchBinaryLinux string
78
79 // Sketch client public key.
80 SketchPubKey string
Philip Zeyligerd1402952025-04-23 03:54:37 +000081
Sean McCulloughbaa2b592025-04-23 10:40:08 -070082 // Host port for the container's ssh server
83 SSHPort int
84
Philip Zeyliger18532b22025-04-23 21:11:46 +000085 // Outside information to pass to the container
86 OutsideHostname string
87 OutsideOS string
88 OutsideWorkingDir string
Philip Zeyligerb74c4f62025-04-25 19:18:49 -070089
Pokey Rule0dcebe12025-04-28 14:51:04 +010090 // If true, exit after the first turn
91 OneShot bool
92
93 // Initial prompt
94 Prompt string
Philip Zeyliger1b47aa22025-04-28 19:25:38 +000095
David Crawshawb5f6a002025-05-05 08:27:16 -070096 // Verbose enables verbose output
97 Verbose bool
Philip Zeyliger1dc21372025-05-05 19:54:44 +000098
99 // DockerArgs are additional arguments to pass to the docker create command
100 DockerArgs string
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000101
Josh Bleecher Snyderac761c92025-05-16 18:58:45 +0000102 // Mounts specifies volumes to mount in the container in format /path/on/host:/path/in/container
103 Mounts []string
104
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000105 // ExperimentFlag contains the experimental features to enable
106 ExperimentFlag string
Philip Zeyliger613c0f52025-05-15 16:36:22 -0700107
108 // TermUI enables terminal UI
109 TermUI bool
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700110
Josh Bleecher Snyder33032d32025-05-30 16:28:21 +0000111 // Budget configuration
Philip Zeyligere6c294d2025-06-04 16:55:21 +0000112 MaxDollars float64
Josh Bleecher Snyder33032d32025-05-30 16:28:21 +0000113
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700114 GitRemoteUrl string
115
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000116 // Original git origin URL from the host repository
117 OriginalGitOrigin string
118
Josh Bleecher Snyder664404e2025-06-04 21:56:42 +0000119 // Upstream branch for git work
120 Upstream string
121
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700122 // Commit hash to checkout from GetRemoteUrl
123 Commit string
124
125 // Outtie's HTTP server
126 OutsideHTTP string
Philip Zeyligerbe7802a2025-06-04 20:15:25 +0000127
128 // Prefix for git branches created by sketch
129 BranchPrefix string
philip.zeyliger6d3de482025-06-10 19:38:14 -0700130
131 // LinkToGitHub enables GitHub branch linking in UI
132 LinkToGitHub bool
Philip Zeyligerd4be7a22025-06-15 09:39:00 -0700133
134 // SubtraceToken enables running sketch under subtrace.dev (development only)
135 SubtraceToken string
Philip Zeyliger194bfa82025-06-24 06:03:06 -0700136
137 // MCPServers contains MCP server configurations
138 MCPServers []string
Philip Zeyliger254c49f2025-07-17 17:26:24 -0700139
140 // PassthroughUpstream configures upstream remote for passthrough to innie
141 PassthroughUpstream bool
Josh Bleecher Snydere75d0ea2025-07-21 23:50:44 +0000142
143 // DumpAntCalls enables dumping raw communications with Claude to files
144 DumpAntCalls bool
Earl Lee2e463fb2025-04-17 11:22:22 -0700145}
146
147// LaunchContainer creates a docker container for a project, installs sketch and opens a connection to it.
148// It writes status to stdout.
David Crawshawb5f6a002025-05-05 08:27:16 -0700149func LaunchContainer(ctx context.Context, config ContainerConfig) error {
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700150 slog.Debug("Container Config", slog.String("config", fmt.Sprintf("%+v", config)))
Earl Lee2e463fb2025-04-17 11:22:22 -0700151 if _, err := exec.LookPath("docker"); err != nil {
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700152 if runtime.GOOS == "darwin" {
153 return fmt.Errorf("cannot find `docker` binary; run: brew install docker colima && colima start")
154 } else {
155 return fmt.Errorf("cannot find `docker` binary; install docker (e.g., apt-get install docker.io)")
156 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700157 }
158
159 if out, err := combinedOutput(ctx, "docker", "ps"); err != nil {
160 // `docker ps` provides a good error message here that can be
161 // easily chatgpt'ed by users, so send it to the user as-is:
162 // Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
163 return fmt.Errorf("docker ps: %s (%w)", out, err)
164 }
165
166 _, hostPort, err := net.SplitHostPort(config.LocalAddr)
167 if err != nil {
168 return err
169 }
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000170 // Bail early if sketch was started from a path that isn't in a git repo.
171 err = requireGitRepo(ctx, config.Path)
Earl Lee2e463fb2025-04-17 11:22:22 -0700172 if err != nil {
173 return err
174 }
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000175
176 // Best effort attempt to get repo root; fall back to current directory.
177 gitRoot := config.Path
178 if root, err := gitRepoRoot(ctx, config.Path); err == nil {
179 gitRoot = root
180 }
181
182 // Capture the original git origin URL before we set up the temporary git server
183 config.OriginalGitOrigin = getOriginalGitOrigin(ctx, gitRoot)
184
Philip Zeyliger254c49f2025-07-17 17:26:24 -0700185 // If we've got an upstream, let's configure
186 if config.OriginalGitOrigin != "" {
187 config.PassthroughUpstream = true
188 }
189
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700190 imgName, err := findOrBuildDockerImage(ctx, gitRoot, config.BaseImage, config.ForceRebuild, config.Verbose)
Earl Lee2e463fb2025-04-17 11:22:22 -0700191 if err != nil {
192 return err
193 }
194
Philip Zeyligerc72fff52025-04-29 20:17:54 +0000195 cntrName := "sketch-" + config.SessionID
Earl Lee2e463fb2025-04-17 11:22:22 -0700196 defer func() {
197 if config.NoCleanup {
198 return
199 }
200 if out, err := combinedOutput(ctx, "docker", "kill", cntrName); err != nil {
201 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
202 _ = out
203 }
204 if out, err := combinedOutput(ctx, "docker", "rm", cntrName); err != nil {
205 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
206 _ = out
207 }
208 }()
209
210 // errCh receives errors from operations that this function calls in separate goroutines.
211 errCh := make(chan error)
212
Josh Bleecher Snyder725cfe02025-07-18 01:31:06 +0000213 var upstream string
214 if out, err := combinedOutput(ctx, "git", "branch", "--show-current"); err != nil {
215 slog.DebugContext(ctx, "git branch --show-current failed (continuing)", "error", err)
216 } else {
217 upstream = strings.TrimSpace(string(out))
218 }
219
Earl Lee2e463fb2025-04-17 11:22:22 -0700220 // Start the git server
Josh Bleecher Snyder725cfe02025-07-18 01:31:06 +0000221 gitSrv, err := newGitServer(gitRoot, config.PassthroughUpstream, upstream)
Earl Lee2e463fb2025-04-17 11:22:22 -0700222 if err != nil {
223 return fmt.Errorf("failed to start git server: %w", err)
224 }
225 defer gitSrv.shutdown(ctx)
226
227 go func() {
228 errCh <- gitSrv.serve(ctx)
229 }()
230
philz24613202025-07-15 20:56:21 -0700231 // Check if we have any commits, and if not, create an empty initial commit
232 cmd := exec.CommandContext(ctx, "git", "rev-list", "--all", "--count")
233 countOut, err := cmd.CombinedOutput()
234 if err != nil {
235 return fmt.Errorf("git rev-list --all --count: %s: %w", countOut, err)
236 }
237 commitCount := strings.TrimSpace(string(countOut))
238 if commitCount == "0" {
239 slog.Info("No commits found, creating empty initial commit")
240 cmd = exec.CommandContext(ctx, "git", "commit", "--allow-empty", "-m", "Initial empty commit")
241 if commitOut, err := cmd.CombinedOutput(); err != nil {
242 return fmt.Errorf("git commit --allow-empty: %s: %w", commitOut, err)
243 }
244 }
245
Earl Lee2e463fb2025-04-17 11:22:22 -0700246 // Get the current host git commit
247 var commit string
Philip Zeyligera347b172025-06-04 16:18:57 +0000248 if out, err := combinedOutput(ctx, "git", "rev-parse", "HEAD"); err != nil {
249 return fmt.Errorf("git rev-parse HEAD: %w", err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700250 } else {
251 commit = strings.TrimSpace(string(out))
252 }
Josh Bleecher Snyder664404e2025-06-04 21:56:42 +0000253
Earl Lee2e463fb2025-04-17 11:22:22 -0700254 if out, err := combinedOutput(ctx, "git", "config", "http.receivepack", "true"); err != nil {
255 return fmt.Errorf("git config http.receivepack true: %s: %w", out, err)
256 }
257
258 relPath, err := filepath.Rel(gitRoot, config.Path)
259 if err != nil {
260 return err
261 }
262
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700263 config.OutsideHTTP = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s", gitSrv.pass, gitSrv.gitPort)
264 config.GitRemoteUrl = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s/.git", gitSrv.pass, gitSrv.gitPort)
Josh Bleecher Snyder664404e2025-06-04 21:56:42 +0000265 config.Upstream = upstream
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700266 config.Commit = commit
267
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -0700268 // Create the sketch container, copy over linux sketch
Earl Lee2e463fb2025-04-17 11:22:22 -0700269 if err := createDockerContainer(ctx, cntrName, hostPort, relPath, imgName, config); err != nil {
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +0000270 return fmt.Errorf("failed to create docker container: %w", err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700271 }
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -0700272 if err := copyEmbeddedLinuxBinaryToContainer(ctx, cntrName); err != nil {
273 return fmt.Errorf("failed to copy linux binary to container: %w", err)
David Crawshaw8bff16a2025-04-18 01:16:49 -0700274 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700275
David Crawshaw53786ef2025-04-24 12:52:51 -0700276 fmt.Printf("📦 running in container %s\n", cntrName)
Earl Lee2e463fb2025-04-17 11:22:22 -0700277
Philip Zeyligerd4be7a22025-06-15 09:39:00 -0700278 // Setup subtrace if token is provided (development only) - after container creation, before start
279 if config.SubtraceToken != "" {
280 fmt.Println("🔍 Setting up subtrace (development only)")
281 if err := setupSubtraceBeforeStart(ctx, cntrName, config.SubtraceToken); err != nil {
282 return fmt.Errorf("failed to setup subtrace: %w", err)
283 }
284 }
285
Earl Lee2e463fb2025-04-17 11:22:22 -0700286 // Start the sketch container
287 if out, err := combinedOutput(ctx, "docker", "start", cntrName); err != nil {
288 return fmt.Errorf("docker start: %s, %w", out, err)
289 }
290
291 // Copies structured logs from the container to the host.
292 copyLogs := func() {
293 if config.ContainerLogDest == "" {
294 return
295 }
296 out, err := combinedOutput(ctx, "docker", "logs", cntrName)
297 if err != nil {
298 fmt.Fprintf(os.Stderr, "docker logs failed: %v\n", err)
299 return
300 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700301 prefix := []byte("structured logs:")
302 for line := range bytes.Lines(out) {
303 rest, ok := bytes.CutPrefix(line, prefix)
304 if !ok {
Earl Lee2e463fb2025-04-17 11:22:22 -0700305 continue
306 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700307 logFile := string(bytes.TrimSpace(rest))
Earl Lee2e463fb2025-04-17 11:22:22 -0700308 srcPath := fmt.Sprintf("%s:%s", cntrName, logFile)
309 logFileName := filepath.Base(logFile)
310 dstPath := filepath.Join(config.ContainerLogDest, logFileName)
311 _, err := combinedOutput(ctx, "docker", "cp", srcPath, dstPath)
312 if err != nil {
313 fmt.Fprintf(os.Stderr, "docker cp %s %s failed: %v\n", srcPath, dstPath, err)
314 }
315 fmt.Fprintf(os.Stderr, "\ncopied container log %s to %s\n", srcPath, dstPath)
316 }
317 }
318
319 // NOTE: we want to see what the internal sketch binary prints
320 // regardless of the setting of the verbosity flag on the external
321 // binary, so reading "docker logs", which is the stdout/stderr of
322 // the internal binary is not conditional on the verbose flag.
323 appendInternalErr := func(err error) error {
324 if err == nil {
325 return nil
326 }
327 out, logsErr := combinedOutput(ctx, "docker", "logs", cntrName)
Philip Zeyligerd1402952025-04-23 03:54:37 +0000328 if logsErr != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700329 return fmt.Errorf("%w; and docker logs failed: %s, %v", err, out, logsErr)
330 }
331 out = bytes.TrimSpace(out)
332 if len(out) > 0 {
333 return fmt.Errorf("docker logs: %s;\n%w", out, err)
334 }
335 return err
336 }
337
338 // Get the sketch server port from the container
Sean McCulloughae3480f2025-04-23 15:28:20 -0700339 localAddr, err := getContainerPort(ctx, cntrName, "80")
Earl Lee2e463fb2025-04-17 11:22:22 -0700340 if err != nil {
341 return appendInternalErr(err)
342 }
343
Philip Zeyliger00442412025-05-14 11:03:23 -0700344 if config.Verbose {
345 fmt.Fprintf(os.Stderr, "Host web server: http://%s/\n", localAddr)
346 }
347
Sean McCulloughae3480f2025-04-23 15:28:20 -0700348 localSSHAddr, err := getContainerPort(ctx, cntrName, "22")
349 if err != nil {
350 return appendInternalErr(err)
351 }
352 sshHost, sshPort, err := net.SplitHostPort(localSSHAddr)
353 if err != nil {
David Crawshawb5f6a002025-05-05 08:27:16 -0700354 return appendInternalErr(fmt.Errorf("failed to split ssh host and port: %w", err))
Sean McCulloughae3480f2025-04-23 15:28:20 -0700355 }
Sean McCullough4854c652025-04-24 18:37:02 -0700356
Sean McCullough7013e9e2025-05-14 02:03:58 +0000357 var sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate []byte
Sean McCullough4854c652025-04-24 18:37:02 -0700358
banksean29d689f2025-06-23 15:41:26 +0000359 cst, err := NewLocalSSHimmer(cntrName, sshHost, sshPort)
Sean McCullough078e85a2025-05-08 17:28:34 -0700360 if err != nil {
361 return appendInternalErr(fmt.Errorf("NewContainerSSHTheather: %w", err))
362 }
363
364 sshErr := CheckSSHReachability(cntrName)
Sean McCullough15c95282025-05-08 16:48:38 -0700365 sshAvailable := false
366 sshErrMsg := ""
367 if sshErr != nil {
368 fmt.Println(sshErr.Error())
369 sshErrMsg = sshErr.Error()
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700370 // continue - ssh config is not required for the rest of sketch to function locally.
371 } else {
Sean McCullough15c95282025-05-08 16:48:38 -0700372 sshAvailable = true
Sean McCulloughea3fc202025-04-28 12:53:37 -0700373 // Note: The vscode: link uses an undocumented request parameter that I really had to dig to find:
374 // https://github.com/microsoft/vscode/blob/2b9486161abaca59b5132ce3c59544f3cc7000f6/src/vs/code/electron-main/app.ts#L878
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700375 fmt.Printf(`Connect to this container via any of these methods:
Sean McCullough4854c652025-04-24 18:37:02 -0700376🖥️ ssh %s
377🖥️ code --remote ssh-remote+root@%s /app -n
Sean McCulloughea3fc202025-04-28 12:53:37 -0700378🔗 vscode://vscode-remote/ssh-remote+root@%s/app?windowId=_blank
Sean McCullough4854c652025-04-24 18:37:02 -0700379`, cntrName, cntrName, cntrName)
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700380 sshUserIdentity = cst.userIdentity
381 sshServerIdentity = cst.serverIdentity
Sean McCullough7013e9e2025-05-14 02:03:58 +0000382
383 // Get the Container CA public key for mutual auth
384 if cst.containerCAPublicKey != nil {
385 containerCAPublicKey = ssh.MarshalAuthorizedKey(cst.containerCAPublicKey)
386 fmt.Println("🔒 SSH Mutual Authentication enabled (container will verify host)")
387 }
388
389 // Get the host certificate for mutual auth
390 hostCertificate = cst.hostCertificate
391
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700392 defer func() {
393 if err := cst.Cleanup(); err != nil {
394 appendInternalErr(err)
395 }
396 }()
397 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700398
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700399 // Tell the sketch container to Init(), which starts the SSH server
400 // and checks out the right commit.
401 // TODO: I'm trying to move as much configuration as possible into the command-line
402 // arguments to avoid splitting them up. "localAddr" is the only difficult one:
403 // we run (effectively) "docker run -p 0:80 image sketch -flags" and you can't
404 // get the port Docker chose until after the process starts. The SSH config is
405 // mostly available ahead of time, but whether it works ("sshAvailable"/"sshErrMsg")
406 // may also empirically need to be done after the SSH server is up and running.
Earl Lee2e463fb2025-04-17 11:22:22 -0700407 go func() {
408 // TODO: Why is this called in a goroutine? I have found that when I pull this out
409 // of the goroutine and call it inline, then the terminal UI clears itself and all
410 // the scrollback (which is not good, but also not fatal). I can't see why it does this
411 // though, since none of the calls in postContainerInitConfig obviously write to stdout
412 // or stderr.
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700413 if err := postContainerInitConfig(ctx, localAddr, sshAvailable, sshErrMsg, sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700414 slog.ErrorContext(ctx, "LaunchContainer.postContainerInitConfig", slog.String("err", err.Error()))
415 errCh <- appendInternalErr(err)
416 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700417
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700418 // We open the browser after the init config because the above waits for the web server to be serving.
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700419 ps1URL := "http://" + localAddr
420 if config.SkabandAddr != "" {
421 ps1URL = fmt.Sprintf("%s/s/%s", config.SkabandAddr, config.SessionID)
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700422 }
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700423 if config.OpenBrowser {
424 browser.Open(ps1URL)
425 }
426 gitSrv.ps1URL.Store(&ps1URL)
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700427 }()
Earl Lee2e463fb2025-04-17 11:22:22 -0700428
429 go func() {
430 cmd := exec.CommandContext(ctx, "docker", "attach", cntrName)
431 cmd.Stdin = os.Stdin
432 cmd.Stdout = os.Stdout
433 cmd.Stderr = os.Stderr
434 errCh <- run(ctx, "docker attach", cmd)
435 }()
436
437 defer copyLogs()
438
439 for {
440 select {
441 case <-ctx.Done():
442 return ctx.Err()
443 case err := <-errCh:
444 if err != nil {
445 return appendInternalErr(fmt.Errorf("container process: %w", err))
446 }
447 return nil
448 }
449 }
450}
451
452func combinedOutput(ctx context.Context, cmdName string, args ...string) ([]byte, error) {
453 cmd := exec.CommandContext(ctx, cmdName, args...)
Earl Lee2e463fb2025-04-17 11:22:22 -0700454 start := time.Now()
455
456 out, err := cmd.CombinedOutput()
457 if err != nil {
David Crawshawc7e77962025-05-03 13:20:18 -0700458 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700459 } else {
David Crawshawc7e77962025-05-03 13:20:18 -0700460 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700461 }
462 return out, err
463}
464
465func run(ctx context.Context, cmdName string, cmd *exec.Cmd) error {
466 start := time.Now()
467 err := cmd.Run()
468 if err != nil {
David Crawshawc7e77962025-05-03 13:20:18 -0700469 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700470 } else {
David Crawshawc7e77962025-05-03 13:20:18 -0700471 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700472 }
473 return err
474}
475
476type gitServer struct {
477 gitLn net.Listener
478 gitPort string
479 srv *http.Server
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700480 pass string
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700481 ps1URL atomic.Pointer[string]
Earl Lee2e463fb2025-04-17 11:22:22 -0700482}
483
484func (gs *gitServer) shutdown(ctx context.Context) {
485 gs.srv.Shutdown(ctx)
486 gs.gitLn.Close()
487}
488
489// Serve a git remote from the host for the container to fetch from and push to.
490func (gs *gitServer) serve(ctx context.Context) error {
491 slog.DebugContext(ctx, "starting git server", slog.String("git_remote_addr", "http://host.docker.internal:"+gs.gitPort+"/.git"))
492 return gs.srv.Serve(gs.gitLn)
493}
494
Josh Bleecher Snyder725cfe02025-07-18 01:31:06 +0000495func newGitServer(gitRoot string, configureUpstreamPassthrough bool, upstream string) (*gitServer, error) {
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700496 ret := &gitServer{
497 pass: rand.Text(),
498 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700499
Earl Lee2e463fb2025-04-17 11:22:22 -0700500 gitLn, err := net.Listen("tcp4", ":0")
501 if err != nil {
502 return nil, fmt.Errorf("git listen: %w", err)
503 }
504 ret.gitLn = gitLn
505
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700506 browserC := make(chan bool, 1) // channel of browser open requests
507
Josh Bleecher Snyder3e2111b2025-04-30 17:53:28 +0000508 go func() {
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700509 for range browserC {
510 browser.Open(*ret.ps1URL.Load())
Josh Bleecher Snyder3e2111b2025-04-30 17:53:28 +0000511 }
512 }()
513
Philip Zeyliger254c49f2025-07-17 17:26:24 -0700514 var hooksDir string
515 if configureUpstreamPassthrough {
Josh Bleecher Snyder725cfe02025-07-18 01:31:06 +0000516 hooksDir, err = setupHooksDir(upstream)
Philip Zeyliger254c49f2025-07-17 17:26:24 -0700517 if err != nil {
518 return nil, fmt.Errorf("failed to setup hooks directory: %w", err)
519 }
520 }
521
522 srv := http.Server{Handler: &gitHTTP{gitRepoRoot: gitRoot, hooksDir: hooksDir, pass: []byte(ret.pass), browserC: browserC}}
Earl Lee2e463fb2025-04-17 11:22:22 -0700523 ret.srv = &srv
524
525 _, gitPort, err := net.SplitHostPort(gitLn.Addr().String())
526 if err != nil {
527 return nil, fmt.Errorf("git port: %w", err)
528 }
529 ret.gitPort = gitPort
530 return ret, nil
531}
532
533func createDockerContainer(ctx context.Context, cntrName, hostPort, relPath, imgName string, config ContainerConfig) error {
David Crawshaw69c67312025-04-17 13:42:00 -0700534 cmdArgs := []string{
535 "create",
David Crawshaw66cf74e2025-05-05 08:48:39 -0700536 "-i",
Earl Lee2e463fb2025-04-17 11:22:22 -0700537 "--name", cntrName,
538 "-p", hostPort + ":80", // forward container port 80 to a host port
David Crawshaw3659d872025-05-05 17:52:23 -0700539 "-e", "SKETCH_MODEL_API_KEY=" + config.ModelAPIKey,
Earl Lee2e463fb2025-04-17 11:22:22 -0700540 }
Philip Zeyliger3d2eff02025-05-27 09:30:31 -0700541 if !(config.OneShot || !config.TermUI) {
David Crawshaw66cf74e2025-05-05 08:48:39 -0700542 cmdArgs = append(cmdArgs, "-t")
543 }
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +0000544
545 for _, envVar := range getEnvForwardingFromGitConfig(ctx) {
546 cmdArgs = append(cmdArgs, "-e", envVar)
547 }
David Crawshaw5a7b3692025-05-05 16:49:15 -0700548 if config.ModelURL != "" {
David Crawshaw3659d872025-05-05 17:52:23 -0700549 cmdArgs = append(cmdArgs, "-e", "SKETCH_MODEL_URL="+config.ModelURL)
Earl Lee2e463fb2025-04-17 11:22:22 -0700550 }
551 if config.SketchPubKey != "" {
552 cmdArgs = append(cmdArgs, "-e", "SKETCH_PUB_KEY="+config.SketchPubKey)
553 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700554 if config.SSHPort > 0 {
555 cmdArgs = append(cmdArgs, "-p", fmt.Sprintf("%d:22", config.SSHPort)) // forward container ssh port to host ssh port
556 } else {
Philip Zeyliger87d29ef2025-05-16 20:25:28 -0700557 cmdArgs = append(cmdArgs, "-p", "0:22") // use an ephemeral host port for ssh.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700558 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700559 // colima does this by default, but Linux docker seems to need this set explicitly
560 cmdArgs = append(cmdArgs, "--add-host", "host.docker.internal:host-gateway")
Josh Bleecher Snyderac761c92025-05-16 18:58:45 +0000561
David Crawshaw1bd636c2025-06-13 19:56:27 +0000562 // Add seccomp profile to prevent killing PID 1 (the sketch process itself)
563 // Write the seccomp profile to cache directory if it doesn't exist
564 seccompPath, err := ensureSeccompProfile(ctx)
565 if err != nil {
566 return fmt.Errorf("failed to create seccomp profile: %w", err)
567 }
568 cmdArgs = append(cmdArgs, "--security-opt", "seccomp="+seccompPath)
569
Philip Zeyligerd4be7a22025-06-15 09:39:00 -0700570 // Add subtrace environment variable if token is provided
571 if config.SubtraceToken != "" {
572 cmdArgs = append(cmdArgs, "-e", "SUBTRACE_TOKEN="+config.SubtraceToken)
573 cmdArgs = append(cmdArgs, "-e", "SUBTRACE_HTTP2=1")
574 }
575
Josh Bleecher Snyderac761c92025-05-16 18:58:45 +0000576 // Add volume mounts if specified
577 for _, mount := range config.Mounts {
578 if mount != "" {
579 cmdArgs = append(cmdArgs, "-v", mount)
580 }
581 }
Philip Zeyligerd4be7a22025-06-15 09:39:00 -0700582 cmdArgs = append(cmdArgs, imgName)
583
584 // Add command: either [sketch] or [subtrace run -- sketch]
585 if config.SubtraceToken != "" {
586 cmdArgs = append(cmdArgs, "/usr/local/bin/subtrace", "run", "--", "/bin/sketch")
587 } else {
588 cmdArgs = append(cmdArgs, "/bin/sketch")
589 }
590
591 // Add all sketch arguments
592 cmdArgs = append(cmdArgs,
Earl Lee2e463fb2025-04-17 11:22:22 -0700593 "-unsafe",
594 "-addr=:80",
595 "-session-id="+config.SessionID,
Philip Zeyligerd1402952025-04-23 03:54:37 +0000596 "-git-username="+config.GitUsername,
597 "-git-email="+config.GitEmail,
Philip Zeyliger18532b22025-04-23 21:11:46 +0000598 "-outside-hostname="+config.OutsideHostname,
599 "-outside-os="+config.OutsideOS,
600 "-outside-working-dir="+config.OutsideWorkingDir,
Josh Bleecher Snyder33032d32025-05-30 16:28:21 +0000601 fmt.Sprintf("-max-dollars=%f", config.MaxDollars),
Josh Bleecher Snyder3cae7d92025-04-30 09:54:29 -0700602 "-open=false",
Philip Zeyliger613c0f52025-05-15 16:36:22 -0700603 "-termui="+fmt.Sprintf("%t", config.TermUI),
Philip Zeyligercabfa552025-05-19 16:14:28 -0700604 "-verbose="+fmt.Sprintf("%t", config.Verbose),
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000605 "-x="+config.ExperimentFlag,
Philip Zeyligerbe7802a2025-06-04 20:15:25 +0000606 "-branch-prefix="+config.BranchPrefix,
philip.zeyliger6d3de482025-06-10 19:38:14 -0700607 "-link-to-github="+fmt.Sprintf("%t", config.LinkToGitHub),
Earl Lee2e463fb2025-04-17 11:22:22 -0700608 )
philip.zeyliger8773e682025-06-11 21:36:21 -0700609 // Set SSH connection string based on session ID for SSH Theater
610 cmdArgs = append(cmdArgs, "-ssh-connection-string=sketch-"+config.SessionID)
Josh Bleecher Snydera96f9d22025-07-11 02:47:33 +0000611 if relPath != "." {
612 cmdArgs = append(cmdArgs, "-C", relPath)
613 }
David Crawshaw5a7b3692025-05-05 16:49:15 -0700614 if config.Model != "" {
615 cmdArgs = append(cmdArgs, "-model="+config.Model)
616 }
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700617 if config.GitRemoteUrl != "" {
618 cmdArgs = append(cmdArgs, "-git-remote-url="+config.GitRemoteUrl)
619 if config.Commit == "" {
620 panic("Commit should have been set when GitRemoteUrl was set")
621 }
622 cmdArgs = append(cmdArgs, "-commit="+config.Commit)
Josh Bleecher Snyder664404e2025-06-04 21:56:42 +0000623 cmdArgs = append(cmdArgs, "-upstream="+config.Upstream)
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700624 }
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000625 if config.OriginalGitOrigin != "" {
626 cmdArgs = append(cmdArgs, "-original-git-origin="+config.OriginalGitOrigin)
627 }
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700628 if config.OutsideHTTP != "" {
629 cmdArgs = append(cmdArgs, "-outside-http="+config.OutsideHTTP)
630 }
Josh Bleecher Snydere3c2f222025-05-15 20:54:52 +0000631 cmdArgs = append(cmdArgs, "-skaband-addr="+config.SkabandAddr)
Pokey Rule0dcebe12025-04-28 14:51:04 +0100632 if config.Prompt != "" {
633 cmdArgs = append(cmdArgs, "-prompt", config.Prompt)
634 }
635 if config.OneShot {
636 cmdArgs = append(cmdArgs, "-one-shot")
Philip Zeyligerb74c4f62025-04-25 19:18:49 -0700637 }
Josh Bleecher Snydere3c2f222025-05-15 20:54:52 +0000638 if config.ModelURL == "" {
639 // Forward ANTHROPIC_API_KEY for direct use.
640 // TODO: have outtie run an http proxy?
641 // TODO: select and forward the relevant API key based on the model
642 cmdArgs = append(cmdArgs, "-llm-api-key="+os.Getenv("ANTHROPIC_API_KEY"))
643 }
Philip Zeyliger194bfa82025-06-24 06:03:06 -0700644 // Add MCP server configurations
645 for _, mcpServer := range config.MCPServers {
646 cmdArgs = append(cmdArgs, "-mcp", mcpServer)
647 }
Philip Zeyliger254c49f2025-07-17 17:26:24 -0700648 if config.PassthroughUpstream {
649 cmdArgs = append(cmdArgs, "-passthrough-upstream")
650 }
Josh Bleecher Snydere75d0ea2025-07-21 23:50:44 +0000651 if config.DumpAntCalls {
652 cmdArgs = append(cmdArgs, "-dump-ant-calls")
653 }
Philip Zeyliger1dc21372025-05-05 19:54:44 +0000654
655 // Add additional docker arguments if provided
656 if config.DockerArgs != "" {
657 // Parse space-separated docker arguments with support for quotes and escaping
658 args := parseDockerArgs(config.DockerArgs)
659 // Insert arguments after "create" but before other arguments
660 for i := len(args) - 1; i >= 0; i-- {
661 cmdArgs = append(cmdArgs[:1], append([]string{args[i]}, cmdArgs[1:]...)...)
662 }
663 }
664
Earl Lee2e463fb2025-04-17 11:22:22 -0700665 if out, err := combinedOutput(ctx, "docker", cmdArgs...); err != nil {
666 return fmt.Errorf("docker create: %s, %w", out, err)
667 }
668 return nil
669}
670
Sean McCulloughae3480f2025-04-23 15:28:20 -0700671func getContainerPort(ctx context.Context, cntrName, cntrPort string) (string, error) {
Earl Lee2e463fb2025-04-17 11:22:22 -0700672 localAddr := ""
Sean McCulloughae3480f2025-04-23 15:28:20 -0700673 if out, err := combinedOutput(ctx, "docker", "port", cntrName, cntrPort); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700674 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
675 } else {
676 v4, _, found := strings.Cut(string(out), "\n")
677 if !found {
678 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
679 }
680 localAddr = v4
681 if strings.HasPrefix(localAddr, "0.0.0.0") {
682 localAddr = "127.0.0.1" + strings.TrimPrefix(localAddr, "0.0.0.0")
683 }
684 }
685 return localAddr, nil
686}
687
688// Contact the container and configure it.
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700689func postContainerInitConfig(ctx context.Context, localAddr string, sshAvailable bool, sshError string, sshServerIdentity, sshAuthorizedKeys, sshContainerCAKey, sshHostCertificate []byte) error {
Earl Lee2e463fb2025-04-17 11:22:22 -0700690 localURL := "http://" + localAddr
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700691
692 initMsg, err := json.Marshal(
693 server.InitRequest{
Sean McCullough7013e9e2025-05-14 02:03:58 +0000694 HostAddr: localAddr,
695 SSHAuthorizedKeys: sshAuthorizedKeys,
696 SSHServerIdentity: sshServerIdentity,
697 SSHContainerCAKey: sshContainerCAKey,
698 SSHHostCertificate: sshHostCertificate,
699 SSHAvailable: sshAvailable,
700 SSHError: sshError,
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700701 })
Earl Lee2e463fb2025-04-17 11:22:22 -0700702 if err != nil {
703 return fmt.Errorf("init msg: %w", err)
704 }
705
Earl Lee2e463fb2025-04-17 11:22:22 -0700706 // Note: this /init POST is handled in loop/server/loophttp.go:
707 initMsgByteReader := bytes.NewReader(initMsg)
708 req, err := http.NewRequest("POST", localURL+"/init", initMsgByteReader)
709 if err != nil {
710 return err
711 }
712
713 var res *http.Response
714 for i := 0; ; i++ {
715 time.Sleep(100 * time.Millisecond)
716 // If you DON'T reset this byteReader, then subsequent retries may end up sending 0 bytes.
717 initMsgByteReader.Reset(initMsg)
718 res, err = http.DefaultClient.Do(req)
719 if err != nil {
David Crawshaw99231ba2025-05-03 10:48:26 -0700720 if i < 100 {
721 if i%10 == 0 {
722 slog.DebugContext(ctx, "postContainerInitConfig retrying", slog.Int("retry", i), slog.String("err", err.Error()))
723 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700724 continue
725 }
726 return fmt.Errorf("failed to %s/init sketch in container, NOT retrying: err: %v", localURL, err)
727 }
728 break
729 }
730 resBytes, _ := io.ReadAll(res.Body)
731 if res.StatusCode != http.StatusOK {
732 return fmt.Errorf("failed to initialize sketch in container, response status code %d: %s", res.StatusCode, resBytes)
733 }
734 return nil
735}
736
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700737func findOrBuildDockerImage(ctx context.Context, gitRoot, baseImage string, forceRebuild, verbose bool) (imgName string, err error) {
738 // Default to the published sketch image if no base image is specified
739 if baseImage == "" {
740 imageTag := dockerfileBaseHash()
741 baseImage = fmt.Sprintf("%s:%s", dockerImgName, imageTag)
Earl Lee2e463fb2025-04-17 11:22:22 -0700742 }
743
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700744 // Ensure the base image exists locally, pull if necessary
745 if err := ensureBaseImageExists(ctx, baseImage); err != nil {
746 return "", fmt.Errorf("failed to ensure base image %s exists: %w", baseImage, err)
747 }
748
749 // Get the base image container ID for caching
750 baseImageID, err := getDockerImageID(ctx, baseImage)
Earl Lee2e463fb2025-04-17 11:22:22 -0700751 if err != nil {
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700752 return "", fmt.Errorf("failed to get base image ID for %s: %w", baseImage, err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700753 }
754
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700755 // Create a cache key based on base image ID and working directory
756 // Docker naming conventions restrict you to 20 characters per path component
757 // and only allow lowercase letters, digits, underscores, and dashes, so encoding
758 // the hash and the repo directory is sadly a bit of a non-starter.
759 cacheKey := createCacheKey(baseImageID, gitRoot)
760 imgName = "sketch-" + cacheKey
Earl Lee2e463fb2025-04-17 11:22:22 -0700761
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700762 // Check if the cached image exists and is up to date
763 if !forceRebuild {
764 if exists, err := dockerImageExists(ctx, imgName); err != nil {
765 return "", fmt.Errorf("failed to check if image exists: %w", err)
766 } else if exists {
767 if verbose {
768 fmt.Printf("using cached image %s\n", imgName)
Kilian Lackhove23772f42025-06-18 20:28:58 +0200769 }
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700770 return imgName, nil
David Crawshawb5f6a002025-05-05 08:27:16 -0700771 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700772 }
773
Josh Bleecher Snyderd1171432025-07-18 15:04:05 +0000774 // Explain a bit what's happening, to help orient and de-FUD new users.
775 fmt.Println()
776 fmt.Println("┌──────────────────────────────────────────────────┐")
777 fmt.Println("│ Building Docker image (one-time) │")
778 fmt.Println("│ │")
779 fmt.Println("│ • Built and run locally │")
780 fmt.Println("│ • Packages your git repo into isolated container │")
781 fmt.Println("│ • Custom images: https://sketch.dev/docs/docker │")
782 fmt.Println("│ • Rebuild: sketch -rebuild │")
783 fmt.Println("└──────────────────────────────────────────────────┘")
784 fmt.Println()
785
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700786 if err := buildLayeredImage(ctx, imgName, baseImage, gitRoot, verbose); err != nil {
787 return "", fmt.Errorf("failed to build layered image: %w", err)
788 }
789
790 return imgName, nil
791}
792
793// ensureBaseImageExists checks if the base image exists locally and pulls it if not
794func ensureBaseImageExists(ctx context.Context, imageName string) error {
795 exists, err := dockerImageExists(ctx, imageName)
796 if err != nil {
797 return fmt.Errorf("failed to check if image exists: %w", err)
798 }
799
800 if !exists {
801 fmt.Printf("🐋 pulling base image %s...\n", imageName)
802 if out, err := combinedOutput(ctx, "docker", "pull", imageName); err != nil {
803 return fmt.Errorf("docker pull %s failed: %s: %w", imageName, out, err)
804 }
805 fmt.Printf("✅ successfully pulled %s\n", imageName)
806 }
807
808 return nil
809}
810
811// getDockerImageID gets the container ID for a Docker image
812func getDockerImageID(ctx context.Context, imageName string) (string, error) {
813 out, err := combinedOutput(ctx, "docker", "inspect", "--format", "{{.Id}}", imageName)
814 if err != nil {
815 return "", err
816 }
817 return strings.TrimSpace(string(out)), nil
818}
819
820// createCacheKey creates a cache key from base image ID and working directory
821func createCacheKey(baseImageID, gitRoot string) string {
822 h := sha256.New()
823 h.Write([]byte(baseImageID))
824 h.Write([]byte(gitRoot))
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000825 // one-time cache-busting for the transition from copying git repos to only copying git objects
826 h.Write([]byte("git-objects"))
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700827 return hex.EncodeToString(h.Sum(nil))[:12] // Use first 12 chars for shorter name
828}
829
830// dockerImageExists checks if a Docker image exists locally
831func dockerImageExists(ctx context.Context, imageName string) (bool, error) {
832 out, err := combinedOutput(ctx, "docker", "inspect", imageName)
833 if err != nil {
834 if strings.Contains(strings.ToLower(string(out)), "no such object") ||
835 strings.Contains(strings.ToLower(string(out)), "no such image") {
836 return false, nil
837 }
838 return false, err
839 }
840 return true, nil
841}
842
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000843// buildLayeredImage builds a new Docker image by layering the repo on top of the base image.
844//
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700845// TODO: git config stuff could be environment variables at runtime for email and username.
846// The git docs seem to say that http.postBuffer is a bug in our git proxy more than a thing
847// that's needed, but we haven't found the bug yet!
Philip Zeyliger882b1d12025-07-02 20:04:08 -0700848//
849// TODO: There is a caching tension. A base image is great for tools (like, some version
850// of Go). Then you want a git repo, which is much faster to incrementally fetch rather
851// than cloning every time. Then you want some build artifacts, like perhaps the
852// "go mod download" cache, or the "go build" cache or the "npm install" cache.
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000853// The implementation here copies the git objects into the base image.
854// That enables fast clones into the container, because most of the git objects are already there.
855// It also avoids copying uncommitted changes, configs/hooks, etc.
Josh Bleecher Snyderfa424f52025-07-11 18:43:55 +0000856// We also set up fake temporary Go module(s) so we can run "go mod download".
857// TODO: maybe 'go list ./...' and then do a build as well to populate the build cache.
858// TODO: 'npm install', etc? We have the rails for it.
Josh Bleecher Snyder369f2622025-07-15 00:02:59 +0000859// If /app/.git already exists, we fetch from the existing repo instead of cloning.
860// This lets advanced users arrange their git repo exactly as they desire.
Philip Zeyliger882b1d12025-07-02 20:04:08 -0700861// Note that buildx has some support for conditional COPY, but without buildx, which
862// we can't reliably depend on, we have to run the base image to inspect its file system,
863// and then we can decide what to do.
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000864//
865// We may in the future want to enable people to bring along uncommitted changes to tracked files.
866// To do that, we would run `git stash create` in outie at launch time, treat HEAD as the base commit,
867// and add in the stash commit as a new commit atop it.
868// That would accurately model the base commit as well as the uncommitted changes.
869// (This wouldn't happen here, but at agent/container initialization time.)
870//
871// repoPath is the current working directory where sketch is being run from.
872func buildLayeredImage(ctx context.Context, imgName, baseImage, gitRoot string, verbose bool) error {
Josh Bleecher Snyderfa424f52025-07-11 18:43:55 +0000873 goModules, err := collectGoModules(ctx, gitRoot)
874 if err != nil {
875 return fmt.Errorf("failed to collect go modules: %w", err)
876 }
877
878 buf := new(strings.Builder)
879 line := func(msg string, args ...any) {
880 fmt.Fprintf(buf, msg+"\n", args...)
881 }
882
883 line("FROM %s", baseImage)
884 line("COPY . /git-ref")
885
886 for _, module := range goModules {
887 line("RUN mkdir -p /go-module")
888 line("RUN git --git-dir=/git-ref --work-tree=/go-module cat-file blob %s > /go-module/go.mod", module.modSHA)
889 if module.sumSHA != "" {
890 line("RUN git --git-dir=/git-ref --work-tree=/go-module cat-file blob %s > /go-module/go.sum", module.sumSHA)
891 }
892 // drop any replaced modules
893 line("RUN cd /go-module && go mod edit -json | jq -r '.Replace? // [] | .[] | .Old.Path' | xargs -r -I{} go mod edit -dropreplace={} -droprequire={}")
894 // grab what’s left, best effort only to avoid breaking on (say) private modules
895 line("RUN cd /go-module && go mod download || true")
896 line("RUN rm -rf /go-module")
897 }
898
899 line("WORKDIR /app")
900 line(`CMD ["/bin/sketch"]`)
901 dockerfileContent := buf.String()
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700902
903 // Create a temporary directory for the Dockerfile
904 tmpDir, err := os.MkdirTemp("", "sketch-docker-*")
905 if err != nil {
906 return fmt.Errorf("failed to create temporary directory: %w", err)
907 }
908 defer os.RemoveAll(tmpDir)
909
910 dockerfilePath := filepath.Join(tmpDir, "Dockerfile")
911 if err := os.WriteFile(dockerfilePath, []byte(dockerfileContent), 0o666); err != nil {
912 return fmt.Errorf("failed to write Dockerfile: %w", err)
913 }
914
915 // Get git user info
Earl Lee2e463fb2025-04-17 11:22:22 -0700916 var gitUserEmail, gitUserName string
917 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil {
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700918 return fmt.Errorf("git user.email is not set. Please run 'git config --global user.email \"your.email@example.com\"' to set your email address")
Earl Lee2e463fb2025-04-17 11:22:22 -0700919 } else {
920 gitUserEmail = strings.TrimSpace(string(out))
921 }
922 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil {
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700923 return fmt.Errorf("git user.name is not set. Please run 'git config --global user.name \"Your Name\"' to set your name")
Earl Lee2e463fb2025-04-17 11:22:22 -0700924 } else {
925 gitUserName = strings.TrimSpace(string(out))
926 }
927
928 start := time.Now()
Philip Zeyliger2343f8a2025-06-17 06:16:19 -0700929 cmdArgs := []string{
930 "build",
Earl Lee2e463fb2025-04-17 11:22:22 -0700931 "-t", imgName,
932 "-f", dockerfilePath,
Philip Zeyliger2343f8a2025-06-17 06:16:19 -0700933 "--build-arg", "GIT_USER_EMAIL=" + gitUserEmail,
934 "--build-arg", "GIT_USER_NAME=" + gitUserName,
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700935 ".",
Philip Zeyliger2343f8a2025-06-17 06:16:19 -0700936 }
937
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000938 commonDir, err := gitCommonDir(ctx, gitRoot)
939 if err != nil {
940 return fmt.Errorf("failed to get git common dir: %w", err)
941 }
942
Philip Zeyliger2343f8a2025-06-17 06:16:19 -0700943 cmd := exec.CommandContext(ctx, "docker", cmdArgs...)
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000944 cmd.Dir = commonDir
David Crawshaw31f15242025-05-06 16:03:49 -0700945 // We print the docker build output whether or not the user
946 // has selected --verbose. Building an image takes a while
947 // and this gives good context.
David Crawshawb5f6a002025-05-05 08:27:16 -0700948 cmd.Stdout = os.Stdout
949 cmd.Stderr = os.Stderr
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700950 fmt.Printf("🏗️ building docker image %s from base %s...\n", imgName, baseImage)
Earl Lee2e463fb2025-04-17 11:22:22 -0700951
952 err = run(ctx, "docker build", cmd)
953 if err != nil {
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700954 return fmt.Errorf("docker build failed: %v", err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700955 }
956 fmt.Printf("built docker image %s in %s\n", imgName, time.Since(start).Round(time.Millisecond))
Philip Zeyliger983b58a2025-07-02 19:42:08 -0700957 return nil
Earl Lee2e463fb2025-04-17 11:22:22 -0700958}
959
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000960// requireGitRepo confirms that path is within a git repository.
961func requireGitRepo(ctx context.Context, path string) error {
962 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-dir")
Earl Lee2e463fb2025-04-17 11:22:22 -0700963 cmd.Dir = path
964 out, err := cmd.CombinedOutput()
965 if err != nil {
966 if strings.Contains(string(out), "not a git repository") {
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000967 return fmt.Errorf(`sketch needs to run from within a git repo, but %s is not part of a git repo.
Earl Lee2e463fb2025-04-17 11:22:22 -0700968Consider one of the following options:
969 - cd to a different dir that is already part of a git repo first, or
970 - to create a new git repo from this directory (%s), run this command:
971
972 git init . && git commit --allow-empty -m "initial commit"
973
974and try running sketch again.
975`, path, path)
976 }
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000977 return fmt.Errorf("git rev-parse --git-dir: %s: %w", out, err)
978 }
979 return nil
980}
981
982// gitRepoRoot attempts to find the git repository root directory.
983// Returns an error if not in a git repository or if it's a bare repository.
984// This is used to calculate relative paths for preserving user's working directory context.
985func gitRepoRoot(ctx context.Context, path string) (string, error) {
986 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--show-toplevel")
987 cmd.Dir = path
988 out, err := cmd.CombinedOutput()
989 if err != nil {
Marc-Antoine Ruel467c3962025-06-29 13:32:59 -0400990 return "", fmt.Errorf("git rev-parse --show-toplevel: %s: %w", out, err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700991 }
Marc-Antoine Ruel467c3962025-06-29 13:32:59 -0400992 // The returned path is absolute.
993 return strings.TrimSpace(string(out)), nil
Earl Lee2e463fb2025-04-17 11:22:22 -0700994}
995
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +0000996// gitCommonDir finds the git common directory for path.
997func gitCommonDir(ctx context.Context, path string) (string, error) {
998 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-common-dir")
999 cmd.Dir = path
1000 out, err := cmd.CombinedOutput()
1001 if err != nil {
1002 return "", fmt.Errorf("git rev-parse --git-common-dir: %s: %w", out, err)
1003 }
1004 gitCommonDir := strings.TrimSpace(string(out))
1005 if !filepath.IsAbs(gitCommonDir) {
1006 gitCommonDir = filepath.Join(path, gitCommonDir)
1007 }
1008 return gitCommonDir, nil
1009}
1010
Josh Bleecher Snyderfa424f52025-07-11 18:43:55 +00001011// goModuleInfo represents a Go module with its file paths and blob SHAs
1012type goModuleInfo struct {
1013 // modPath is the path to the go.mod file, for debugging
1014 modPath string
1015 // modSHA is the git blob SHA of the go.mod file
1016 modSHA string
1017 // sumSHA is the git blob SHA of the go.sum file, empty if no go.sum exists
1018 sumSHA string
1019}
1020
1021// collectGoModules returns all go.mod files in the git repository with their blob SHAs.
1022func collectGoModules(ctx context.Context, gitRoot string) ([]goModuleInfo, error) {
1023 cmd := exec.CommandContext(ctx, "git", "ls-files", "-z", "*.mod")
1024 cmd.Dir = gitRoot
1025 out, err := cmd.CombinedOutput()
1026 if err != nil {
1027 return nil, fmt.Errorf("git ls-files -z *.mod: %s: %w", out, err)
1028 }
1029
1030 modFiles := strings.Split(string(out), "\x00")
1031 var modules []goModuleInfo
1032 for _, file := range modFiles {
1033 if filepath.Base(file) != "go.mod" {
1034 continue
1035 }
1036
1037 modSHA, err := getGitBlobSHA(ctx, gitRoot, file)
1038 if err != nil {
1039 return nil, fmt.Errorf("failed to get blob SHA for %s: %w", file, err)
1040 }
1041
1042 // If corresponding go.sum exists, get its SHA
1043 sumFile := filepath.Join(filepath.Dir(file), "go.sum")
1044 sumSHA, _ := getGitBlobSHA(ctx, gitRoot, sumFile) // best effort
1045
1046 modules = append(modules, goModuleInfo{
1047 modPath: file,
1048 modSHA: modSHA,
1049 sumSHA: sumSHA,
1050 })
1051 }
1052
1053 return modules, nil
1054}
1055
1056// getGitBlobSHA returns the git blob SHA for a file at HEAD
1057func getGitBlobSHA(ctx context.Context, gitRoot, filePath string) (string, error) {
1058 cmd := exec.CommandContext(ctx, "git", "rev-parse", "HEAD:"+filePath)
1059 cmd.Dir = gitRoot
1060 out, err := cmd.CombinedOutput()
1061 if err != nil {
1062 return "", fmt.Errorf("git rev-parse HEAD:%s: %s: %w", filePath, out, err)
1063 }
1064 return strings.TrimSpace(string(out)), nil
1065}
1066
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +00001067// getEnvForwardingFromGitConfig retrieves environment variables to pass through to Docker
1068// from git config using the sketch.envfwd multi-valued key.
1069func getEnvForwardingFromGitConfig(ctx context.Context) []string {
1070 outb, err := exec.CommandContext(ctx, "git", "config", "--get-all", "sketch.envfwd").CombinedOutput()
1071 out := string(outb)
1072 if err != nil {
1073 if strings.Contains(out, "key does not exist") {
1074 return nil
1075 }
1076 slog.ErrorContext(ctx, "failed to get sketch.envfwd from git config", "err", err, "output", out)
1077 return nil
1078 }
1079
1080 var envVars []string
1081 for envVar := range strings.Lines(out) {
1082 envVar = strings.TrimSpace(envVar)
1083 if envVar == "" {
1084 continue
1085 }
1086 envVars = append(envVars, envVar+"="+os.Getenv(envVar))
1087 }
1088 return envVars
1089}
Philip Zeyliger1dc21372025-05-05 19:54:44 +00001090
Josh Bleecher Snyder784d5bd2025-07-11 00:09:30 +00001091// getOriginalGitOrigin returns the URL of the git remote 'origin' if it exists in the given directory
1092func getOriginalGitOrigin(ctx context.Context, dir string) string {
1093 cmd := exec.CommandContext(ctx, "git", "config", "--get", "remote.origin.url")
1094 cmd.Dir = dir
1095 out, err := cmd.Output()
1096 if err != nil {
1097 return ""
1098 }
1099 return strings.TrimSpace(string(out))
1100}
1101
Philip Zeyliger1dc21372025-05-05 19:54:44 +00001102// parseDockerArgs parses a string containing space-separated Docker arguments into an array of strings.
1103// It handles quoted arguments and escaped characters.
1104//
1105// Examples:
1106//
1107// --memory=2g --cpus=2 -> ["--memory=2g", "--cpus=2"]
1108// --label="my label" --env=FOO=bar -> ["--label=my label", "--env=FOO=bar"]
1109// --env="KEY=\"quoted value\"" -> ["--env=KEY=\"quoted value\""]
1110func parseDockerArgs(args string) []string {
1111 if args = strings.TrimSpace(args); args == "" {
1112 return []string{}
1113 }
1114
1115 var result []string
1116 var current strings.Builder
1117 inQuotes := false
1118 escapeNext := false
1119 quoteChar := rune(0)
1120
1121 for _, char := range args {
1122 if escapeNext {
1123 current.WriteRune(char)
1124 escapeNext = false
1125 continue
1126 }
1127
1128 if char == '\\' {
1129 escapeNext = true
1130 continue
1131 }
1132
1133 if char == '"' || char == '\'' {
1134 if !inQuotes {
1135 inQuotes = true
1136 quoteChar = char
1137 continue
1138 } else if char == quoteChar {
1139 inQuotes = false
1140 quoteChar = rune(0)
1141 continue
1142 }
1143 // Non-matching quote character inside quotes
1144 current.WriteRune(char)
1145 continue
1146 }
1147
1148 // Space outside of quotes is an argument separator
1149 if char == ' ' && !inQuotes {
1150 if current.Len() > 0 {
1151 result = append(result, current.String())
1152 current.Reset()
1153 }
1154 continue
1155 }
1156
1157 current.WriteRune(char)
1158 }
1159
1160 // Add the last argument if there is one
1161 if current.Len() > 0 {
1162 result = append(result, current.String())
1163 }
1164
1165 return result
1166}
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001167
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001168// copyEmbeddedLinuxBinaryToContainer copies the embedded linux binary to the container
1169func copyEmbeddedLinuxBinaryToContainer(ctx context.Context, containerName string) error {
Josh Bleecher Snyder5ae245b2025-07-08 22:00:24 +00001170 out, err := combinedOutput(ctx, "docker", "version", "--format", "{{.Server.Arch}}")
1171 if err != nil {
1172 return fmt.Errorf("failed to detect Docker server architecture: %s: %w", out, err)
1173 }
1174 arch := strings.TrimSpace(string(out))
1175
1176 bin := embedded.LinuxBinary(arch)
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001177 if bin == nil {
Josh Bleecher Snyder5ae245b2025-07-08 22:00:24 +00001178 return fmt.Errorf("no embedded linux binary for architecture %q", arch)
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001179 }
1180
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00001181 // Stream a tarball to docker cp.
1182 pr, pw := io.Pipe()
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001183
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00001184 errCh := make(chan error, 1)
1185 go func() {
1186 defer pw.Close()
1187 tw := tar.NewWriter(pw)
1188
1189 hdr := &tar.Header{
1190 Name: "bin/sketch", // final path inside the container
1191 Mode: 0o700,
1192 Size: int64(len(bin)),
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001193 }
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00001194 if err := tw.WriteHeader(hdr); err != nil {
1195 errCh <- fmt.Errorf("failed to write tar header: %w", err)
1196 return
1197 }
1198 if _, err := tw.Write(bin); err != nil {
1199 errCh <- fmt.Errorf("failed to write binary to tar: %w", err)
1200 return
1201 }
1202 if err := tw.Close(); err != nil {
1203 errCh <- fmt.Errorf("failed to close tar writer: %w", err)
1204 return
1205 }
1206 errCh <- nil
1207 }()
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001208
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00001209 cmd := exec.CommandContext(ctx, "docker", "cp", "-", containerName+":/")
1210 cmd.Stdin = pr
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001211
Josh Bleecher Snyderc9898fd2025-07-08 21:09:18 +00001212 out, cmdErr := cmd.CombinedOutput()
1213
1214 if tarErr := <-errCh; tarErr != nil {
1215 return tarErr
1216 }
1217 if cmdErr != nil {
1218 return fmt.Errorf("docker cp failed: %s: %w", out, cmdErr)
1219 }
Josh Bleecher Snyder1c18ec92025-07-08 10:55:54 -07001220 return nil
1221}
1222
David Crawshaw1bd636c2025-06-13 19:56:27 +00001223const seccompProfile = `{
1224 "defaultAction": "SCMP_ACT_ALLOW",
1225 "syscalls": [
1226 {
1227 "names": ["kill", "tkill", "tgkill", "pidfd_send_signal"],
1228 "action": "SCMP_ACT_ERRNO",
1229 "args": [
1230 {
1231 "index": 0,
1232 "value": 1,
1233 "op": "SCMP_CMP_EQ"
1234 }
1235 ]
1236 }
1237 ]
1238}`
1239
1240// ensureSeccompProfile creates the seccomp profile file in the sketch cache directory if it doesn't exist.
1241func ensureSeccompProfile(ctx context.Context) (seccompPath string, err error) {
1242 homeDir, err := os.UserHomeDir()
1243 if err != nil {
1244 return "", fmt.Errorf("failed to get home directory: %w", err)
1245 }
1246 cacheDir := filepath.Join(homeDir, ".cache", "sketch")
1247 if err := os.MkdirAll(cacheDir, 0o755); err != nil {
1248 return "", fmt.Errorf("failed to create cache directory: %w", err)
1249 }
1250 seccompPath = filepath.Join(cacheDir, "seccomp-no-kill-1.json")
1251
1252 curBytes, err := os.ReadFile(seccompPath)
1253 if err != nil && !os.IsNotExist(err) {
1254 return "", fmt.Errorf("failed to read seccomp profile file %s: %w", seccompPath, err)
1255 }
1256 if string(curBytes) == seccompProfile {
1257 return seccompPath, nil // File already exists and matches the expected profile
1258 }
1259
1260 if err := os.WriteFile(seccompPath, []byte(seccompProfile), 0o644); err != nil {
1261 return "", fmt.Errorf("failed to write seccomp profile to %s: %w", seccompPath, err)
1262 }
1263 slog.DebugContext(ctx, "created seccomp profile", "path", seccompPath)
1264 return seccompPath, nil
1265}