blob: 1aeb7e8739324c0137abe576f958c09f18159603 [file] [log] [blame]
Earl Lee2e463fb2025-04-17 11:22:22 -07001// Package dockerimg
2package dockerimg
3
4import (
5 "bytes"
6 "context"
Philip Zeyliger5e227dd2025-04-21 15:55:29 -07007 "crypto/rand"
Earl Lee2e463fb2025-04-17 11:22:22 -07008 "crypto/sha256"
9 "encoding/hex"
10 "encoding/json"
11 "fmt"
12 "io"
13 "log/slog"
14 "net"
15 "net/http"
16 "os"
17 "os/exec"
18 "path/filepath"
19 "runtime"
20 "strings"
21 "time"
22
Sean McCulloughbaa2b592025-04-23 10:40:08 -070023 "sketch.dev/loop/server"
David Crawshaw8bff16a2025-04-18 01:16:49 -070024 "sketch.dev/loop/webui"
Earl Lee2e463fb2025-04-17 11:22:22 -070025 "sketch.dev/skribe"
26)
27
28// ContainerConfig holds all configuration for launching a container
29type ContainerConfig struct {
30 // SessionID is the unique identifier for this session
31 SessionID string
32
33 // LocalAddr is the initial address to use (though it may be overwritten later)
34 LocalAddr string
35
36 // SkabandAddr is the address of the skaband service if available
37 SkabandAddr string
38
39 // AntURL is the URL of the LLM service.
40 AntURL string
41
42 // AntAPIKey is the API key for LLM service.
43 AntAPIKey string
44
45 // Path is the local filesystem path to use
46 Path string
47
48 // GitUsername is the username to use for git operations
49 GitUsername string
50
51 // GitEmail is the email to use for git operations
52 GitEmail string
53
54 // OpenBrowser determines whether to open a browser automatically
55 OpenBrowser bool
56
57 // NoCleanup prevents container cleanup when set to true
58 NoCleanup bool
59
60 // ForceRebuild forces rebuilding of the Docker image even if it exists
61 ForceRebuild bool
62
63 // Host directory to copy container logs into, if not set to ""
64 ContainerLogDest string
65
66 // Path to pre-built linux sketch binary, or build a new one if set to ""
67 SketchBinaryLinux string
68
69 // Sketch client public key.
70 SketchPubKey string
Philip Zeyligerd1402952025-04-23 03:54:37 +000071
Sean McCulloughbaa2b592025-04-23 10:40:08 -070072 // Host port for the container's ssh server
73 SSHPort int
74
75 // Public keys authorized to connect to the container's ssh server
76 SSHAuthorizedKeys []byte
77
78 // Private key used to identify the container's ssh server
79 SSHServerIdentity []byte
80
Philip Zeyligerd1402952025-04-23 03:54:37 +000081 // Host information to pass to the container
82 HostHostname string
83 HostOS string
84 HostWorkingDir string
Earl Lee2e463fb2025-04-17 11:22:22 -070085}
86
87// LaunchContainer creates a docker container for a project, installs sketch and opens a connection to it.
88// It writes status to stdout.
89func LaunchContainer(ctx context.Context, stdout, stderr io.Writer, config ContainerConfig) error {
90 if _, err := exec.LookPath("docker"); err != nil {
Philip Zeyliger5e227dd2025-04-21 15:55:29 -070091 if runtime.GOOS == "darwin" {
92 return fmt.Errorf("cannot find `docker` binary; run: brew install docker colima && colima start")
93 } else {
94 return fmt.Errorf("cannot find `docker` binary; install docker (e.g., apt-get install docker.io)")
95 }
Earl Lee2e463fb2025-04-17 11:22:22 -070096 }
97
98 if out, err := combinedOutput(ctx, "docker", "ps"); err != nil {
99 // `docker ps` provides a good error message here that can be
100 // easily chatgpt'ed by users, so send it to the user as-is:
101 // Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
102 return fmt.Errorf("docker ps: %s (%w)", out, err)
103 }
104
105 _, hostPort, err := net.SplitHostPort(config.LocalAddr)
106 if err != nil {
107 return err
108 }
109
110 gitRoot, err := findGitRoot(ctx, config.Path)
111 if err != nil {
112 return err
113 }
114
115 imgName, err := findOrBuildDockerImage(ctx, stdout, stderr, config.Path, gitRoot, config.AntURL, config.AntAPIKey, config.ForceRebuild)
116 if err != nil {
117 return err
118 }
119
120 linuxSketchBin := config.SketchBinaryLinux
121 if linuxSketchBin == "" {
122 linuxSketchBin, err = buildLinuxSketchBin(ctx, config.Path)
123 if err != nil {
124 return err
125 }
Josh Bleecher Snyder5544d142025-04-23 14:15:45 -0700126 defer os.Remove(linuxSketchBin) // in case of errors
Earl Lee2e463fb2025-04-17 11:22:22 -0700127 }
128
129 cntrName := imgName + "-" + config.SessionID
130 defer func() {
131 if config.NoCleanup {
132 return
133 }
134 if out, err := combinedOutput(ctx, "docker", "kill", cntrName); err != nil {
135 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
136 _ = out
137 }
138 if out, err := combinedOutput(ctx, "docker", "rm", cntrName); err != nil {
139 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
140 _ = out
141 }
142 }()
143
144 // errCh receives errors from operations that this function calls in separate goroutines.
145 errCh := make(chan error)
146
147 // Start the git server
148 gitSrv, err := newGitServer(gitRoot)
149 if err != nil {
150 return fmt.Errorf("failed to start git server: %w", err)
151 }
152 defer gitSrv.shutdown(ctx)
153
154 go func() {
155 errCh <- gitSrv.serve(ctx)
156 }()
157
158 // Get the current host git commit
159 var commit string
160 if out, err := combinedOutput(ctx, "git", "rev-parse", "HEAD"); err != nil {
161 return fmt.Errorf("git rev-parse HEAD: %w", err)
162 } else {
163 commit = strings.TrimSpace(string(out))
164 }
165 if out, err := combinedOutput(ctx, "git", "config", "http.receivepack", "true"); err != nil {
166 return fmt.Errorf("git config http.receivepack true: %s: %w", out, err)
167 }
168
169 relPath, err := filepath.Rel(gitRoot, config.Path)
170 if err != nil {
171 return err
172 }
173
174 // Create the sketch container
175 if err := createDockerContainer(ctx, cntrName, hostPort, relPath, imgName, config); err != nil {
176 return err
177 }
178
179 // Copy the sketch linux binary into the container
180 if out, err := combinedOutput(ctx, "docker", "cp", linuxSketchBin, cntrName+":/bin/sketch"); err != nil {
181 return fmt.Errorf("docker cp: %s, %w", out, err)
182 }
Josh Bleecher Snyder5544d142025-04-23 14:15:45 -0700183 os.Remove(linuxSketchBin) // in normal operations, the code below blocks, so actively delete now
Sean McCulloughf5bb3d32025-04-18 10:47:59 -0700184
185 // Make sure that the webui is built so we can copy the results to the container.
186 _, err = webui.Build()
187 if err != nil {
188 return fmt.Errorf("failed to build webui: %w", err)
189 }
190
David Crawshaw8bff16a2025-04-18 01:16:49 -0700191 webuiZipPath, err := webui.ZipPath()
192 if err != nil {
193 return err
194 }
195 if out, err := combinedOutput(ctx, "docker", "cp", webuiZipPath, cntrName+":/root/.cache/sketch/webui/"+filepath.Base(webuiZipPath)); err != nil {
196 return fmt.Errorf("docker cp: %s, %w", out, err)
197 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700198
199 fmt.Printf("starting container %s\ncommits made by the agent will be pushed to \033[1msketch/*\033[0m\n", cntrName)
200
201 // Start the sketch container
202 if out, err := combinedOutput(ctx, "docker", "start", cntrName); err != nil {
203 return fmt.Errorf("docker start: %s, %w", out, err)
204 }
205
206 // Copies structured logs from the container to the host.
207 copyLogs := func() {
208 if config.ContainerLogDest == "" {
209 return
210 }
211 out, err := combinedOutput(ctx, "docker", "logs", cntrName)
212 if err != nil {
213 fmt.Fprintf(os.Stderr, "docker logs failed: %v\n", err)
214 return
215 }
216 logLines := strings.Split(string(out), "\n")
217 for _, logLine := range logLines {
218 if !strings.HasPrefix(logLine, "structured logs:") {
219 continue
220 }
221 logFile := strings.TrimSpace(strings.TrimPrefix(logLine, "structured logs:"))
222 srcPath := fmt.Sprintf("%s:%s", cntrName, logFile)
223 logFileName := filepath.Base(logFile)
224 dstPath := filepath.Join(config.ContainerLogDest, logFileName)
225 _, err := combinedOutput(ctx, "docker", "cp", srcPath, dstPath)
226 if err != nil {
227 fmt.Fprintf(os.Stderr, "docker cp %s %s failed: %v\n", srcPath, dstPath, err)
228 }
229 fmt.Fprintf(os.Stderr, "\ncopied container log %s to %s\n", srcPath, dstPath)
230 }
231 }
232
233 // NOTE: we want to see what the internal sketch binary prints
234 // regardless of the setting of the verbosity flag on the external
235 // binary, so reading "docker logs", which is the stdout/stderr of
236 // the internal binary is not conditional on the verbose flag.
237 appendInternalErr := func(err error) error {
238 if err == nil {
239 return nil
240 }
241 out, logsErr := combinedOutput(ctx, "docker", "logs", cntrName)
Philip Zeyligerd1402952025-04-23 03:54:37 +0000242 if logsErr != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700243 return fmt.Errorf("%w; and docker logs failed: %s, %v", err, out, logsErr)
244 }
245 out = bytes.TrimSpace(out)
246 if len(out) > 0 {
247 return fmt.Errorf("docker logs: %s;\n%w", out, err)
248 }
249 return err
250 }
251
252 // Get the sketch server port from the container
Sean McCulloughae3480f2025-04-23 15:28:20 -0700253 localAddr, err := getContainerPort(ctx, cntrName, "80")
Earl Lee2e463fb2025-04-17 11:22:22 -0700254 if err != nil {
255 return appendInternalErr(err)
256 }
257
Sean McCulloughae3480f2025-04-23 15:28:20 -0700258 localSSHAddr, err := getContainerPort(ctx, cntrName, "22")
259 if err != nil {
260 return appendInternalErr(err)
261 }
262 sshHost, sshPort, err := net.SplitHostPort(localSSHAddr)
263 if err != nil {
264 fmt.Println("Error splitting ssh host and port:", err)
265 }
266 fmt.Printf("ssh into this container with: ssh root@%s -p %s\n", sshHost, sshPort)
267
Earl Lee2e463fb2025-04-17 11:22:22 -0700268 // Tell the sketch container which git server port and commit to initialize with.
269 go func() {
270 // TODO: Why is this called in a goroutine? I have found that when I pull this out
271 // of the goroutine and call it inline, then the terminal UI clears itself and all
272 // the scrollback (which is not good, but also not fatal). I can't see why it does this
273 // though, since none of the calls in postContainerInitConfig obviously write to stdout
274 // or stderr.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700275 if err := postContainerInitConfig(ctx, localAddr, commit, gitSrv.gitPort, gitSrv.pass, config.SSHServerIdentity, config.SSHAuthorizedKeys); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700276 slog.ErrorContext(ctx, "LaunchContainer.postContainerInitConfig", slog.String("err", err.Error()))
277 errCh <- appendInternalErr(err)
278 }
279 }()
280
281 if config.OpenBrowser {
282 OpenBrowser(ctx, "http://"+localAddr)
283 }
284
285 go func() {
286 cmd := exec.CommandContext(ctx, "docker", "attach", cntrName)
287 cmd.Stdin = os.Stdin
288 cmd.Stdout = os.Stdout
289 cmd.Stderr = os.Stderr
290 errCh <- run(ctx, "docker attach", cmd)
291 }()
292
293 defer copyLogs()
294
295 for {
296 select {
297 case <-ctx.Done():
298 return ctx.Err()
299 case err := <-errCh:
300 if err != nil {
301 return appendInternalErr(fmt.Errorf("container process: %w", err))
302 }
303 return nil
304 }
305 }
306}
307
308func combinedOutput(ctx context.Context, cmdName string, args ...string) ([]byte, error) {
309 cmd := exec.CommandContext(ctx, cmdName, args...)
310 // Really only needed for the "go build" command for the linux sketch binary
311 cmd.Env = append(os.Environ(), "GOOS=linux", "CGO_ENABLED=0")
312 start := time.Now()
313
314 out, err := cmd.CombinedOutput()
315 if err != nil {
316 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Now().Sub(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
317 } else {
318 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Now().Sub(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
319 }
320 return out, err
321}
322
323func run(ctx context.Context, cmdName string, cmd *exec.Cmd) error {
324 start := time.Now()
325 err := cmd.Run()
326 if err != nil {
327 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Now().Sub(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
328 } else {
329 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Now().Sub(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
330 }
331 return err
332}
333
334type gitServer struct {
335 gitLn net.Listener
336 gitPort string
337 srv *http.Server
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700338 pass string
Earl Lee2e463fb2025-04-17 11:22:22 -0700339}
340
341func (gs *gitServer) shutdown(ctx context.Context) {
342 gs.srv.Shutdown(ctx)
343 gs.gitLn.Close()
344}
345
346// Serve a git remote from the host for the container to fetch from and push to.
347func (gs *gitServer) serve(ctx context.Context) error {
348 slog.DebugContext(ctx, "starting git server", slog.String("git_remote_addr", "http://host.docker.internal:"+gs.gitPort+"/.git"))
349 return gs.srv.Serve(gs.gitLn)
350}
351
352func newGitServer(gitRoot string) (*gitServer, error) {
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700353 ret := &gitServer{
354 pass: rand.Text(),
355 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700356
Earl Lee2e463fb2025-04-17 11:22:22 -0700357 gitLn, err := net.Listen("tcp4", ":0")
358 if err != nil {
359 return nil, fmt.Errorf("git listen: %w", err)
360 }
361 ret.gitLn = gitLn
362
363 srv := http.Server{
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700364 Handler: &gitHTTP{gitRepoRoot: gitRoot, pass: []byte(ret.pass)},
Earl Lee2e463fb2025-04-17 11:22:22 -0700365 }
366 ret.srv = &srv
367
368 _, gitPort, err := net.SplitHostPort(gitLn.Addr().String())
369 if err != nil {
370 return nil, fmt.Errorf("git port: %w", err)
371 }
372 ret.gitPort = gitPort
373 return ret, nil
374}
375
376func createDockerContainer(ctx context.Context, cntrName, hostPort, relPath, imgName string, config ContainerConfig) error {
377 //, config.SessionID, config.GitUsername, config.GitEmail, config.SkabandAddr
378 // sessionID, gitUsername, gitEmail, skabandAddr string
David Crawshaw69c67312025-04-17 13:42:00 -0700379 cmdArgs := []string{
380 "create",
Earl Lee2e463fb2025-04-17 11:22:22 -0700381 "-it",
382 "--name", cntrName,
383 "-p", hostPort + ":80", // forward container port 80 to a host port
384 "-e", "ANTHROPIC_API_KEY=" + config.AntAPIKey,
385 }
386 if config.AntURL != "" {
387 cmdArgs = append(cmdArgs, "-e", "ANT_URL="+config.AntURL)
388 }
389 if config.SketchPubKey != "" {
390 cmdArgs = append(cmdArgs, "-e", "SKETCH_PUB_KEY="+config.SketchPubKey)
391 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700392 if config.SSHPort > 0 {
393 cmdArgs = append(cmdArgs, "-p", fmt.Sprintf("%d:22", config.SSHPort)) // forward container ssh port to host ssh port
394 } else {
395 cmdArgs = append(cmdArgs, "-p", "22") // use an ephemeral host port for ssh.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700396 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700397 if relPath != "." {
398 cmdArgs = append(cmdArgs, "-w", "/app/"+relPath)
399 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700400 // colima does this by default, but Linux docker seems to need this set explicitly
401 cmdArgs = append(cmdArgs, "--add-host", "host.docker.internal:host-gateway")
Earl Lee2e463fb2025-04-17 11:22:22 -0700402 cmdArgs = append(
403 cmdArgs,
404 imgName,
405 "/bin/sketch",
406 "-unsafe",
407 "-addr=:80",
408 "-session-id="+config.SessionID,
Philip Zeyligerd1402952025-04-23 03:54:37 +0000409 "-git-username="+config.GitUsername,
410 "-git-email="+config.GitEmail,
411 "-host-hostname="+config.HostHostname,
412 "-host-os="+config.HostOS,
413 "-host-working-dir="+config.HostWorkingDir,
Earl Lee2e463fb2025-04-17 11:22:22 -0700414 )
415 if config.SkabandAddr != "" {
416 cmdArgs = append(cmdArgs, "-skaband-addr="+config.SkabandAddr)
417 }
418 if out, err := combinedOutput(ctx, "docker", cmdArgs...); err != nil {
419 return fmt.Errorf("docker create: %s, %w", out, err)
420 }
421 return nil
422}
423
424func buildLinuxSketchBin(ctx context.Context, path string) (string, error) {
David Crawshaw8a617cb2025-04-18 01:28:43 -0700425 homeDir, err := os.UserHomeDir()
David Crawshaw69c67312025-04-17 13:42:00 -0700426 if err != nil {
427 return "", err
428 }
David Crawshaw8a617cb2025-04-18 01:28:43 -0700429 linuxGopath := filepath.Join(homeDir, ".cache", "sketch", "linuxgo")
430 if err := os.MkdirAll(linuxGopath, 0o777); err != nil {
431 return "", err
432 }
433
434 verToInstall := "@latest"
435 if out, err := exec.Command("go", "list", "-m").CombinedOutput(); err != nil {
436 return "", fmt.Errorf("failed to run go list -m: %s: %v", out, err)
437 } else {
438 if strings.TrimSpace(string(out)) == "sketch.dev" {
439 fmt.Printf("building linux agent from currently checked out module\n")
440 verToInstall = ""
441 }
442 }
David Crawshaw69c67312025-04-17 13:42:00 -0700443
Earl Lee2e463fb2025-04-17 11:22:22 -0700444 start := time.Now()
David Crawshaw8a617cb2025-04-18 01:28:43 -0700445 cmd := exec.CommandContext(ctx, "go", "install", "sketch.dev/cmd/sketch"+verToInstall)
David Crawshawb9eaef52025-04-17 15:23:18 -0700446 cmd.Env = append(
447 os.Environ(),
448 "GOOS=linux",
449 "CGO_ENABLED=0",
450 "GOTOOLCHAIN=auto",
David Crawshaw8a617cb2025-04-18 01:28:43 -0700451 "GOPATH="+linuxGopath,
Josh Bleecher Snyderfae17572025-04-21 11:48:05 -0700452 "GOBIN=",
David Crawshawb9eaef52025-04-17 15:23:18 -0700453 )
Earl Lee2e463fb2025-04-17 11:22:22 -0700454
455 fmt.Printf("building linux agent binary...\n")
456 out, err := cmd.CombinedOutput()
457 if err != nil {
458 slog.ErrorContext(ctx, "go", slog.Duration("elapsed", time.Now().Sub(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
459 return "", fmt.Errorf("failed to build linux sketch binary: %s: %w", out, err)
460 } else {
461 slog.DebugContext(ctx, "go", slog.Duration("elapsed", time.Now().Sub(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
462 }
463
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700464 var src string
465 if runtime.GOOS != "linux" {
466 src = filepath.Join(linuxGopath, "bin", "linux_"+runtime.GOARCH, "sketch")
467 } else {
468 // If we are already on Linux, there's no extra platform name in the path
469 src = filepath.Join(linuxGopath, "bin", "sketch")
470 }
471
David Crawshaw69c67312025-04-17 13:42:00 -0700472 dst := filepath.Join(path, "tmp-sketch-binary-linux")
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700473 if err := moveFile(src, dst); err != nil {
David Crawshaw69c67312025-04-17 13:42:00 -0700474 return "", err
475 }
476
Earl Lee2e463fb2025-04-17 11:22:22 -0700477 fmt.Printf("built linux agent binary in %s\n", time.Since(start).Round(100*time.Millisecond))
478
David Crawshaw69c67312025-04-17 13:42:00 -0700479 return dst, nil
Earl Lee2e463fb2025-04-17 11:22:22 -0700480}
481
Sean McCulloughae3480f2025-04-23 15:28:20 -0700482func getContainerPort(ctx context.Context, cntrName, cntrPort string) (string, error) {
Earl Lee2e463fb2025-04-17 11:22:22 -0700483 localAddr := ""
Sean McCulloughae3480f2025-04-23 15:28:20 -0700484 if out, err := combinedOutput(ctx, "docker", "port", cntrName, cntrPort); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700485 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
486 } else {
487 v4, _, found := strings.Cut(string(out), "\n")
488 if !found {
489 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
490 }
491 localAddr = v4
492 if strings.HasPrefix(localAddr, "0.0.0.0") {
493 localAddr = "127.0.0.1" + strings.TrimPrefix(localAddr, "0.0.0.0")
494 }
495 }
496 return localAddr, nil
497}
498
499// Contact the container and configure it.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700500func postContainerInitConfig(ctx context.Context, localAddr, commit, gitPort, gitPass string, sshServerIdentity, sshAuthorizedKeys []byte) error {
Earl Lee2e463fb2025-04-17 11:22:22 -0700501 localURL := "http://" + localAddr
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700502
503 initMsg, err := json.Marshal(
504 server.InitRequest{
505 Commit: commit,
506 GitRemoteAddr: fmt.Sprintf("http://sketch:%s@host.docker.internal:%s/.git", gitPass, gitPort),
507 HostAddr: localAddr,
508 SSHAuthorizedKeys: sshAuthorizedKeys,
509 SSHServerIdentity: sshServerIdentity,
510 })
Earl Lee2e463fb2025-04-17 11:22:22 -0700511 if err != nil {
512 return fmt.Errorf("init msg: %w", err)
513 }
514
Earl Lee2e463fb2025-04-17 11:22:22 -0700515 // Note: this /init POST is handled in loop/server/loophttp.go:
516 initMsgByteReader := bytes.NewReader(initMsg)
517 req, err := http.NewRequest("POST", localURL+"/init", initMsgByteReader)
518 if err != nil {
519 return err
520 }
521
522 var res *http.Response
523 for i := 0; ; i++ {
524 time.Sleep(100 * time.Millisecond)
525 // If you DON'T reset this byteReader, then subsequent retries may end up sending 0 bytes.
526 initMsgByteReader.Reset(initMsg)
527 res, err = http.DefaultClient.Do(req)
528 if err != nil {
529 // In addition to "connection refused", we also occasionally see "EOF" errors that can succeed on retries.
530 if i < 100 && (strings.Contains(err.Error(), "connection refused") || strings.Contains(err.Error(), "EOF")) {
531 slog.DebugContext(ctx, "postContainerInitConfig retrying", slog.Int("retry", i), slog.String("err", err.Error()))
532 continue
533 }
534 return fmt.Errorf("failed to %s/init sketch in container, NOT retrying: err: %v", localURL, err)
535 }
536 break
537 }
538 resBytes, _ := io.ReadAll(res.Body)
539 if res.StatusCode != http.StatusOK {
540 return fmt.Errorf("failed to initialize sketch in container, response status code %d: %s", res.StatusCode, resBytes)
541 }
542 return nil
543}
544
545func findOrBuildDockerImage(ctx context.Context, stdout, stderr io.Writer, cwd, gitRoot, antURL, antAPIKey string, forceRebuild bool) (imgName string, err error) {
546 h := sha256.Sum256([]byte(gitRoot))
547 imgName = "sketch-" + hex.EncodeToString(h[:6])
548
549 var curImgInitFilesHash string
550 if out, err := combinedOutput(ctx, "docker", "inspect", "--format", "{{json .Config.Labels}}", imgName); err != nil {
551 if strings.Contains(string(out), "No such object") {
552 // Image does not exist, continue and build it.
553 curImgInitFilesHash = ""
554 } else {
555 return "", fmt.Errorf("docker inspect failed: %s, %v", out, err)
556 }
557 } else {
558 m := map[string]string{}
559 if err := json.Unmarshal(bytes.TrimSpace(out), &m); err != nil {
560 return "", fmt.Errorf("docker inspect output unparsable: %s, %v", out, err)
561 }
562 curImgInitFilesHash = m["sketch_context"]
563 }
564
565 candidates, err := findRepoDockerfiles(cwd, gitRoot)
566 if err != nil {
567 return "", fmt.Errorf("find dockerfile: %w", err)
568 }
569
570 var initFiles map[string]string
571 var dockerfilePath string
572
573 // TODO: prefer a "Dockerfile.sketch" so users can tailor any env to this tool.
574 if len(candidates) == 1 && strings.ToLower(filepath.Base(candidates[0])) == "dockerfile" {
575 dockerfilePath = candidates[0]
576 contents, err := os.ReadFile(dockerfilePath)
577 if err != nil {
578 return "", err
579 }
580 fmt.Printf("using %s as dev env\n", candidates[0])
581 if hashInitFiles(map[string]string{dockerfilePath: string(contents)}) == curImgInitFilesHash && !forceRebuild {
582 fmt.Printf("using existing docker image %s\n", imgName)
583 return imgName, nil
584 }
585 } else {
586 initFiles, err = readInitFiles(os.DirFS(gitRoot))
587 if err != nil {
588 return "", err
589 }
590 subPathWorkingDir, err := filepath.Rel(gitRoot, cwd)
591 if err != nil {
592 return "", err
593 }
594 initFileHash := hashInitFiles(initFiles)
595 if curImgInitFilesHash == initFileHash && !forceRebuild {
596 fmt.Printf("using existing docker image %s\n", imgName)
597 return imgName, nil
598 }
599
600 start := time.Now()
601 dockerfile, err := createDockerfile(ctx, http.DefaultClient, antURL, antAPIKey, initFiles, subPathWorkingDir)
602 if err != nil {
603 return "", fmt.Errorf("create dockerfile: %w", err)
604 }
605 dockerfilePath = filepath.Join(cwd, "tmp-sketch-dockerfile")
606 if err := os.WriteFile(dockerfilePath, []byte(dockerfile), 0o666); err != nil {
607 return "", err
608 }
609 defer os.Remove(dockerfilePath)
610
611 fmt.Fprintf(stderr, "generated Dockerfile in %s:\n\t%s\n\n", time.Since(start).Round(time.Millisecond), strings.Replace(dockerfile, "\n", "\n\t", -1))
612 }
613
614 var gitUserEmail, gitUserName string
615 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil {
616 return "", fmt.Errorf("git config: %s: %v", out, err)
617 } else {
618 gitUserEmail = strings.TrimSpace(string(out))
619 }
620 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil {
621 return "", fmt.Errorf("git config: %s: %v", out, err)
622 } else {
623 gitUserName = strings.TrimSpace(string(out))
624 }
625
626 start := time.Now()
627 cmd := exec.CommandContext(ctx,
628 "docker", "build",
629 "-t", imgName,
630 "-f", dockerfilePath,
631 "--build-arg", "GIT_USER_EMAIL="+gitUserEmail,
632 "--build-arg", "GIT_USER_NAME="+gitUserName,
633 ".",
634 )
635 cmd.Dir = gitRoot
636 cmd.Stdout = stdout
637 cmd.Stderr = stderr
638 fmt.Printf("building docker image %s...\n", imgName)
Philip Zeyligere4fa0e32025-04-23 14:15:55 -0700639 dockerfileContent, err := os.ReadFile(dockerfilePath)
640 if err != nil {
641 return "", fmt.Errorf("failed to read Dockerfile: %w", err)
642 }
643 fmt.Printf("Dockerfile:\n%s", string(dockerfileContent))
Earl Lee2e463fb2025-04-17 11:22:22 -0700644
645 err = run(ctx, "docker build", cmd)
646 if err != nil {
647 return "", fmt.Errorf("docker build failed: %v", err)
648 }
649 fmt.Printf("built docker image %s in %s\n", imgName, time.Since(start).Round(time.Millisecond))
650 return imgName, nil
651}
652
653func findRepoDockerfiles(cwd, gitRoot string) ([]string, error) {
654 files, err := findDirDockerfiles(cwd)
655 if err != nil {
656 return nil, err
657 }
658 if len(files) > 0 {
659 return files, nil
660 }
661
662 path := cwd
663 for path != gitRoot {
664 path = filepath.Dir(path)
665 files, err := findDirDockerfiles(path)
666 if err != nil {
667 return nil, err
668 }
669 if len(files) > 0 {
670 return files, nil
671 }
672 }
673 return files, nil
674}
675
676// findDirDockerfiles finds all "Dockerfile*" files in a directory.
677func findDirDockerfiles(root string) (res []string, err error) {
678 err = filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
679 if err != nil {
680 return err
681 }
682 if info.IsDir() && root != path {
683 return filepath.SkipDir
684 }
685 name := strings.ToLower(info.Name())
686 if name == "dockerfile" || strings.HasPrefix(name, "dockerfile.") {
687 res = append(res, path)
688 }
689 return nil
690 })
691 if err != nil {
692 return nil, err
693 }
694 return res, nil
695}
696
697func findGitRoot(ctx context.Context, path string) (string, error) {
698 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-common-dir")
699 cmd.Dir = path
700 out, err := cmd.CombinedOutput()
701 if err != nil {
702 if strings.Contains(string(out), "not a git repository") {
703 return "", fmt.Errorf(`sketch needs to run from within a git repo, but %s is not part of a git repo.
704Consider one of the following options:
705 - cd to a different dir that is already part of a git repo first, or
706 - to create a new git repo from this directory (%s), run this command:
707
708 git init . && git commit --allow-empty -m "initial commit"
709
710and try running sketch again.
711`, path, path)
712 }
713 return "", fmt.Errorf("git rev-parse --git-common-dir: %s: %w", out, err)
714 }
715 gitDir := strings.TrimSpace(string(out)) // location of .git dir, often as a relative path
716 absGitDir := filepath.Join(path, gitDir)
717 return filepath.Dir(absGitDir), err
718}
719
720func OpenBrowser(ctx context.Context, url string) {
721 var cmd *exec.Cmd
722 switch runtime.GOOS {
723 case "darwin":
724 cmd = exec.CommandContext(ctx, "open", url)
725 case "windows":
726 cmd = exec.CommandContext(ctx, "cmd", "/c", "start", url)
727 default: // Linux and other Unix-like systems
728 cmd = exec.CommandContext(ctx, "xdg-open", url)
729 }
730 if b, err := cmd.CombinedOutput(); err != nil {
731 fmt.Fprintf(os.Stderr, "failed to open browser: %v: %s\n", err, b)
732 }
733}
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700734
735// moveFile is like Python's shutil.move, in that it tries a rename, and, if that fails,
736// copies and deletes
737func moveFile(src, dst string) error {
738 if err := os.Rename(src, dst); err == nil {
739 return nil
740 }
741
742 stat, err := os.Stat(src)
743 if err != nil {
744 return err
745 }
746
747 sourceFile, err := os.Open(src)
748 if err != nil {
749 return err
750 }
751 defer sourceFile.Close()
752
753 destFile, err := os.Create(dst)
754 if err != nil {
755 return err
756 }
757 defer destFile.Close()
758
759 _, err = io.Copy(destFile, sourceFile)
760 if err != nil {
761 return err
762 }
763
764 sourceFile.Close()
765 destFile.Close()
766
767 os.Chmod(dst, stat.Mode())
768
769 return os.Remove(src)
770}