blob: d812987ddd798ad0e0f3539553b0dcaaab0e0838 [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"
Earl Lee2e463fb2025-04-17 11:22:22 -070024 "sketch.dev/skribe"
Philip Zeyliger5d6af872025-04-23 19:48:34 -070025 "sketch.dev/webui"
Earl Lee2e463fb2025-04-17 11:22:22 -070026)
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 Zeyliger18532b22025-04-23 21:11:46 +000081 // Outside information to pass to the container
82 OutsideHostname string
83 OutsideOS string
84 OutsideWorkingDir 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
David Crawshaw53786ef2025-04-24 12:52:51 -0700199 fmt.Printf("📦 running in container %s\n", cntrName)
Earl Lee2e463fb2025-04-17 11:22:22 -0700200
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 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700216 prefix := []byte("structured logs:")
217 for line := range bytes.Lines(out) {
218 rest, ok := bytes.CutPrefix(line, prefix)
219 if !ok {
Earl Lee2e463fb2025-04-17 11:22:22 -0700220 continue
221 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700222 logFile := string(bytes.TrimSpace(rest))
Earl Lee2e463fb2025-04-17 11:22:22 -0700223 srcPath := fmt.Sprintf("%s:%s", cntrName, logFile)
224 logFileName := filepath.Base(logFile)
225 dstPath := filepath.Join(config.ContainerLogDest, logFileName)
226 _, err := combinedOutput(ctx, "docker", "cp", srcPath, dstPath)
227 if err != nil {
228 fmt.Fprintf(os.Stderr, "docker cp %s %s failed: %v\n", srcPath, dstPath, err)
229 }
230 fmt.Fprintf(os.Stderr, "\ncopied container log %s to %s\n", srcPath, dstPath)
231 }
232 }
233
234 // NOTE: we want to see what the internal sketch binary prints
235 // regardless of the setting of the verbosity flag on the external
236 // binary, so reading "docker logs", which is the stdout/stderr of
237 // the internal binary is not conditional on the verbose flag.
238 appendInternalErr := func(err error) error {
239 if err == nil {
240 return nil
241 }
242 out, logsErr := combinedOutput(ctx, "docker", "logs", cntrName)
Philip Zeyligerd1402952025-04-23 03:54:37 +0000243 if logsErr != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700244 return fmt.Errorf("%w; and docker logs failed: %s, %v", err, out, logsErr)
245 }
246 out = bytes.TrimSpace(out)
247 if len(out) > 0 {
248 return fmt.Errorf("docker logs: %s;\n%w", out, err)
249 }
250 return err
251 }
252
253 // Get the sketch server port from the container
Sean McCulloughae3480f2025-04-23 15:28:20 -0700254 localAddr, err := getContainerPort(ctx, cntrName, "80")
Earl Lee2e463fb2025-04-17 11:22:22 -0700255 if err != nil {
256 return appendInternalErr(err)
257 }
258
Sean McCulloughae3480f2025-04-23 15:28:20 -0700259 localSSHAddr, err := getContainerPort(ctx, cntrName, "22")
260 if err != nil {
261 return appendInternalErr(err)
262 }
263 sshHost, sshPort, err := net.SplitHostPort(localSSHAddr)
264 if err != nil {
265 fmt.Println("Error splitting ssh host and port:", err)
266 }
267 fmt.Printf("ssh into this container with: ssh root@%s -p %s\n", sshHost, sshPort)
268
Earl Lee2e463fb2025-04-17 11:22:22 -0700269 // Tell the sketch container which git server port and commit to initialize with.
270 go func() {
271 // TODO: Why is this called in a goroutine? I have found that when I pull this out
272 // of the goroutine and call it inline, then the terminal UI clears itself and all
273 // the scrollback (which is not good, but also not fatal). I can't see why it does this
274 // though, since none of the calls in postContainerInitConfig obviously write to stdout
275 // or stderr.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700276 if err := postContainerInitConfig(ctx, localAddr, commit, gitSrv.gitPort, gitSrv.pass, config.SSHServerIdentity, config.SSHAuthorizedKeys); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700277 slog.ErrorContext(ctx, "LaunchContainer.postContainerInitConfig", slog.String("err", err.Error()))
278 errCh <- appendInternalErr(err)
279 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700280
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700281 // We open the browser after the init config because the above waits for the web server to be serving.
282 if config.OpenBrowser {
283 if config.SkabandAddr != "" {
284 OpenBrowser(ctx, fmt.Sprintf("%s/s/%s", config.SkabandAddr, config.SessionID))
285 } else {
286 OpenBrowser(ctx, "http://"+localAddr)
287 }
288 }
289 }()
Earl Lee2e463fb2025-04-17 11:22:22 -0700290
291 go func() {
292 cmd := exec.CommandContext(ctx, "docker", "attach", cntrName)
293 cmd.Stdin = os.Stdin
294 cmd.Stdout = os.Stdout
295 cmd.Stderr = os.Stderr
296 errCh <- run(ctx, "docker attach", cmd)
297 }()
298
299 defer copyLogs()
300
301 for {
302 select {
303 case <-ctx.Done():
304 return ctx.Err()
305 case err := <-errCh:
306 if err != nil {
307 return appendInternalErr(fmt.Errorf("container process: %w", err))
308 }
309 return nil
310 }
311 }
312}
313
314func combinedOutput(ctx context.Context, cmdName string, args ...string) ([]byte, error) {
315 cmd := exec.CommandContext(ctx, cmdName, args...)
316 // Really only needed for the "go build" command for the linux sketch binary
317 cmd.Env = append(os.Environ(), "GOOS=linux", "CGO_ENABLED=0")
318 start := time.Now()
319
320 out, err := cmd.CombinedOutput()
321 if err != nil {
322 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))))
323 } else {
324 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))))
325 }
326 return out, err
327}
328
329func run(ctx context.Context, cmdName string, cmd *exec.Cmd) error {
330 start := time.Now()
331 err := cmd.Run()
332 if err != nil {
333 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))))
334 } else {
335 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))))
336 }
337 return err
338}
339
340type gitServer struct {
341 gitLn net.Listener
342 gitPort string
343 srv *http.Server
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700344 pass string
Earl Lee2e463fb2025-04-17 11:22:22 -0700345}
346
347func (gs *gitServer) shutdown(ctx context.Context) {
348 gs.srv.Shutdown(ctx)
349 gs.gitLn.Close()
350}
351
352// Serve a git remote from the host for the container to fetch from and push to.
353func (gs *gitServer) serve(ctx context.Context) error {
354 slog.DebugContext(ctx, "starting git server", slog.String("git_remote_addr", "http://host.docker.internal:"+gs.gitPort+"/.git"))
355 return gs.srv.Serve(gs.gitLn)
356}
357
358func newGitServer(gitRoot string) (*gitServer, error) {
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700359 ret := &gitServer{
360 pass: rand.Text(),
361 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700362
Earl Lee2e463fb2025-04-17 11:22:22 -0700363 gitLn, err := net.Listen("tcp4", ":0")
364 if err != nil {
365 return nil, fmt.Errorf("git listen: %w", err)
366 }
367 ret.gitLn = gitLn
368
369 srv := http.Server{
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700370 Handler: &gitHTTP{gitRepoRoot: gitRoot, pass: []byte(ret.pass)},
Earl Lee2e463fb2025-04-17 11:22:22 -0700371 }
372 ret.srv = &srv
373
374 _, gitPort, err := net.SplitHostPort(gitLn.Addr().String())
375 if err != nil {
376 return nil, fmt.Errorf("git port: %w", err)
377 }
378 ret.gitPort = gitPort
379 return ret, nil
380}
381
382func createDockerContainer(ctx context.Context, cntrName, hostPort, relPath, imgName string, config ContainerConfig) error {
383 //, config.SessionID, config.GitUsername, config.GitEmail, config.SkabandAddr
384 // sessionID, gitUsername, gitEmail, skabandAddr string
David Crawshaw69c67312025-04-17 13:42:00 -0700385 cmdArgs := []string{
386 "create",
Earl Lee2e463fb2025-04-17 11:22:22 -0700387 "-it",
388 "--name", cntrName,
389 "-p", hostPort + ":80", // forward container port 80 to a host port
390 "-e", "ANTHROPIC_API_KEY=" + config.AntAPIKey,
391 }
392 if config.AntURL != "" {
393 cmdArgs = append(cmdArgs, "-e", "ANT_URL="+config.AntURL)
394 }
395 if config.SketchPubKey != "" {
396 cmdArgs = append(cmdArgs, "-e", "SKETCH_PUB_KEY="+config.SketchPubKey)
397 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700398 if config.SSHPort > 0 {
399 cmdArgs = append(cmdArgs, "-p", fmt.Sprintf("%d:22", config.SSHPort)) // forward container ssh port to host ssh port
400 } else {
401 cmdArgs = append(cmdArgs, "-p", "22") // use an ephemeral host port for ssh.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700402 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700403 if relPath != "." {
404 cmdArgs = append(cmdArgs, "-w", "/app/"+relPath)
405 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700406 // colima does this by default, but Linux docker seems to need this set explicitly
407 cmdArgs = append(cmdArgs, "--add-host", "host.docker.internal:host-gateway")
Earl Lee2e463fb2025-04-17 11:22:22 -0700408 cmdArgs = append(
409 cmdArgs,
410 imgName,
411 "/bin/sketch",
412 "-unsafe",
413 "-addr=:80",
414 "-session-id="+config.SessionID,
Philip Zeyligerd1402952025-04-23 03:54:37 +0000415 "-git-username="+config.GitUsername,
416 "-git-email="+config.GitEmail,
Philip Zeyliger18532b22025-04-23 21:11:46 +0000417 "-outside-hostname="+config.OutsideHostname,
418 "-outside-os="+config.OutsideOS,
419 "-outside-working-dir="+config.OutsideWorkingDir,
Earl Lee2e463fb2025-04-17 11:22:22 -0700420 )
421 if config.SkabandAddr != "" {
422 cmdArgs = append(cmdArgs, "-skaband-addr="+config.SkabandAddr)
423 }
424 if out, err := combinedOutput(ctx, "docker", cmdArgs...); err != nil {
425 return fmt.Errorf("docker create: %s, %w", out, err)
426 }
427 return nil
428}
429
430func buildLinuxSketchBin(ctx context.Context, path string) (string, error) {
David Crawshaw8a617cb2025-04-18 01:28:43 -0700431 homeDir, err := os.UserHomeDir()
David Crawshaw69c67312025-04-17 13:42:00 -0700432 if err != nil {
433 return "", err
434 }
David Crawshaw8a617cb2025-04-18 01:28:43 -0700435 linuxGopath := filepath.Join(homeDir, ".cache", "sketch", "linuxgo")
436 if err := os.MkdirAll(linuxGopath, 0o777); err != nil {
437 return "", err
438 }
439
440 verToInstall := "@latest"
441 if out, err := exec.Command("go", "list", "-m").CombinedOutput(); err != nil {
442 return "", fmt.Errorf("failed to run go list -m: %s: %v", out, err)
443 } else {
444 if strings.TrimSpace(string(out)) == "sketch.dev" {
David Crawshaw094e4d22025-04-24 11:35:14 -0700445 slog.DebugContext(ctx, "built linux agent from currently checked out module")
David Crawshaw8a617cb2025-04-18 01:28:43 -0700446 verToInstall = ""
447 }
448 }
David Crawshaw69c67312025-04-17 13:42:00 -0700449
Earl Lee2e463fb2025-04-17 11:22:22 -0700450 start := time.Now()
David Crawshaw8a617cb2025-04-18 01:28:43 -0700451 cmd := exec.CommandContext(ctx, "go", "install", "sketch.dev/cmd/sketch"+verToInstall)
David Crawshawb9eaef52025-04-17 15:23:18 -0700452 cmd.Env = append(
453 os.Environ(),
454 "GOOS=linux",
455 "CGO_ENABLED=0",
456 "GOTOOLCHAIN=auto",
David Crawshaw8a617cb2025-04-18 01:28:43 -0700457 "GOPATH="+linuxGopath,
Josh Bleecher Snyderfae17572025-04-21 11:48:05 -0700458 "GOBIN=",
David Crawshawb9eaef52025-04-17 15:23:18 -0700459 )
Earl Lee2e463fb2025-04-17 11:22:22 -0700460
Earl Lee2e463fb2025-04-17 11:22:22 -0700461 out, err := cmd.CombinedOutput()
462 if err != nil {
463 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))))
464 return "", fmt.Errorf("failed to build linux sketch binary: %s: %w", out, err)
465 } else {
466 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))))
467 }
468
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700469 var src string
470 if runtime.GOOS != "linux" {
471 src = filepath.Join(linuxGopath, "bin", "linux_"+runtime.GOARCH, "sketch")
472 } else {
473 // If we are already on Linux, there's no extra platform name in the path
474 src = filepath.Join(linuxGopath, "bin", "sketch")
475 }
476
David Crawshaw69c67312025-04-17 13:42:00 -0700477 dst := filepath.Join(path, "tmp-sketch-binary-linux")
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700478 if err := moveFile(src, dst); err != nil {
David Crawshaw69c67312025-04-17 13:42:00 -0700479 return "", err
480 }
481
David Crawshaw69c67312025-04-17 13:42:00 -0700482 return dst, nil
Earl Lee2e463fb2025-04-17 11:22:22 -0700483}
484
Sean McCulloughae3480f2025-04-23 15:28:20 -0700485func getContainerPort(ctx context.Context, cntrName, cntrPort string) (string, error) {
Earl Lee2e463fb2025-04-17 11:22:22 -0700486 localAddr := ""
Sean McCulloughae3480f2025-04-23 15:28:20 -0700487 if out, err := combinedOutput(ctx, "docker", "port", cntrName, cntrPort); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700488 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
489 } else {
490 v4, _, found := strings.Cut(string(out), "\n")
491 if !found {
492 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
493 }
494 localAddr = v4
495 if strings.HasPrefix(localAddr, "0.0.0.0") {
496 localAddr = "127.0.0.1" + strings.TrimPrefix(localAddr, "0.0.0.0")
497 }
498 }
499 return localAddr, nil
500}
501
502// Contact the container and configure it.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700503func postContainerInitConfig(ctx context.Context, localAddr, commit, gitPort, gitPass string, sshServerIdentity, sshAuthorizedKeys []byte) error {
Earl Lee2e463fb2025-04-17 11:22:22 -0700504 localURL := "http://" + localAddr
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700505
506 initMsg, err := json.Marshal(
507 server.InitRequest{
508 Commit: commit,
509 GitRemoteAddr: fmt.Sprintf("http://sketch:%s@host.docker.internal:%s/.git", gitPass, gitPort),
510 HostAddr: localAddr,
511 SSHAuthorizedKeys: sshAuthorizedKeys,
512 SSHServerIdentity: sshServerIdentity,
513 })
Earl Lee2e463fb2025-04-17 11:22:22 -0700514 if err != nil {
515 return fmt.Errorf("init msg: %w", err)
516 }
517
Earl Lee2e463fb2025-04-17 11:22:22 -0700518 // Note: this /init POST is handled in loop/server/loophttp.go:
519 initMsgByteReader := bytes.NewReader(initMsg)
520 req, err := http.NewRequest("POST", localURL+"/init", initMsgByteReader)
521 if err != nil {
522 return err
523 }
524
525 var res *http.Response
526 for i := 0; ; i++ {
527 time.Sleep(100 * time.Millisecond)
528 // If you DON'T reset this byteReader, then subsequent retries may end up sending 0 bytes.
529 initMsgByteReader.Reset(initMsg)
530 res, err = http.DefaultClient.Do(req)
531 if err != nil {
532 // In addition to "connection refused", we also occasionally see "EOF" errors that can succeed on retries.
533 if i < 100 && (strings.Contains(err.Error(), "connection refused") || strings.Contains(err.Error(), "EOF")) {
534 slog.DebugContext(ctx, "postContainerInitConfig retrying", slog.Int("retry", i), slog.String("err", err.Error()))
535 continue
536 }
537 return fmt.Errorf("failed to %s/init sketch in container, NOT retrying: err: %v", localURL, err)
538 }
539 break
540 }
541 resBytes, _ := io.ReadAll(res.Body)
542 if res.StatusCode != http.StatusOK {
543 return fmt.Errorf("failed to initialize sketch in container, response status code %d: %s", res.StatusCode, resBytes)
544 }
545 return nil
546}
547
548func findOrBuildDockerImage(ctx context.Context, stdout, stderr io.Writer, cwd, gitRoot, antURL, antAPIKey string, forceRebuild bool) (imgName string, err error) {
549 h := sha256.Sum256([]byte(gitRoot))
550 imgName = "sketch-" + hex.EncodeToString(h[:6])
551
552 var curImgInitFilesHash string
553 if out, err := combinedOutput(ctx, "docker", "inspect", "--format", "{{json .Config.Labels}}", imgName); err != nil {
554 if strings.Contains(string(out), "No such object") {
555 // Image does not exist, continue and build it.
556 curImgInitFilesHash = ""
557 } else {
558 return "", fmt.Errorf("docker inspect failed: %s, %v", out, err)
559 }
560 } else {
561 m := map[string]string{}
562 if err := json.Unmarshal(bytes.TrimSpace(out), &m); err != nil {
563 return "", fmt.Errorf("docker inspect output unparsable: %s, %v", out, err)
564 }
565 curImgInitFilesHash = m["sketch_context"]
566 }
567
568 candidates, err := findRepoDockerfiles(cwd, gitRoot)
569 if err != nil {
570 return "", fmt.Errorf("find dockerfile: %w", err)
571 }
572
573 var initFiles map[string]string
574 var dockerfilePath string
575
576 // TODO: prefer a "Dockerfile.sketch" so users can tailor any env to this tool.
577 if len(candidates) == 1 && strings.ToLower(filepath.Base(candidates[0])) == "dockerfile" {
578 dockerfilePath = candidates[0]
579 contents, err := os.ReadFile(dockerfilePath)
580 if err != nil {
581 return "", err
582 }
583 fmt.Printf("using %s as dev env\n", candidates[0])
584 if hashInitFiles(map[string]string{dockerfilePath: string(contents)}) == curImgInitFilesHash && !forceRebuild {
Earl Lee2e463fb2025-04-17 11:22:22 -0700585 return imgName, nil
586 }
587 } else {
588 initFiles, err = readInitFiles(os.DirFS(gitRoot))
589 if err != nil {
590 return "", err
591 }
592 subPathWorkingDir, err := filepath.Rel(gitRoot, cwd)
593 if err != nil {
594 return "", err
595 }
596 initFileHash := hashInitFiles(initFiles)
597 if curImgInitFilesHash == initFileHash && !forceRebuild {
Earl Lee2e463fb2025-04-17 11:22:22 -0700598 return imgName, nil
599 }
600
601 start := time.Now()
602 dockerfile, err := createDockerfile(ctx, http.DefaultClient, antURL, antAPIKey, initFiles, subPathWorkingDir)
603 if err != nil {
604 return "", fmt.Errorf("create dockerfile: %w", err)
605 }
606 dockerfilePath = filepath.Join(cwd, "tmp-sketch-dockerfile")
607 if err := os.WriteFile(dockerfilePath, []byte(dockerfile), 0o666); err != nil {
608 return "", err
609 }
610 defer os.Remove(dockerfilePath)
611
612 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))
613 }
614
615 var gitUserEmail, gitUserName string
616 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil {
617 return "", fmt.Errorf("git config: %s: %v", out, err)
618 } else {
619 gitUserEmail = strings.TrimSpace(string(out))
620 }
621 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil {
622 return "", fmt.Errorf("git config: %s: %v", out, err)
623 } else {
624 gitUserName = strings.TrimSpace(string(out))
625 }
626
627 start := time.Now()
628 cmd := exec.CommandContext(ctx,
629 "docker", "build",
630 "-t", imgName,
631 "-f", dockerfilePath,
632 "--build-arg", "GIT_USER_EMAIL="+gitUserEmail,
633 "--build-arg", "GIT_USER_NAME="+gitUserName,
634 ".",
635 )
636 cmd.Dir = gitRoot
637 cmd.Stdout = stdout
638 cmd.Stderr = stderr
Philip Zeyligercc3ba222025-04-23 14:52:21 -0700639 fmt.Printf("building docker image %s... (use -verbose to see build output)\n", imgName)
Philip Zeyligere4fa0e32025-04-23 14:15:55 -0700640 dockerfileContent, err := os.ReadFile(dockerfilePath)
641 if err != nil {
642 return "", fmt.Errorf("failed to read Dockerfile: %w", err)
643 }
Philip Zeyliger5d6af872025-04-23 19:48:34 -0700644 fmt.Fprintf(stdout, "Dockerfile:\n%s\n", string(dockerfileContent))
Earl Lee2e463fb2025-04-17 11:22:22 -0700645
646 err = run(ctx, "docker build", cmd)
647 if err != nil {
648 return "", fmt.Errorf("docker build failed: %v", err)
649 }
650 fmt.Printf("built docker image %s in %s\n", imgName, time.Since(start).Round(time.Millisecond))
651 return imgName, nil
652}
653
654func findRepoDockerfiles(cwd, gitRoot string) ([]string, error) {
655 files, err := findDirDockerfiles(cwd)
656 if err != nil {
657 return nil, err
658 }
659 if len(files) > 0 {
660 return files, nil
661 }
662
663 path := cwd
664 for path != gitRoot {
665 path = filepath.Dir(path)
666 files, err := findDirDockerfiles(path)
667 if err != nil {
668 return nil, err
669 }
670 if len(files) > 0 {
671 return files, nil
672 }
673 }
674 return files, nil
675}
676
677// findDirDockerfiles finds all "Dockerfile*" files in a directory.
678func findDirDockerfiles(root string) (res []string, err error) {
679 err = filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
680 if err != nil {
681 return err
682 }
683 if info.IsDir() && root != path {
684 return filepath.SkipDir
685 }
686 name := strings.ToLower(info.Name())
687 if name == "dockerfile" || strings.HasPrefix(name, "dockerfile.") {
688 res = append(res, path)
689 }
690 return nil
691 })
692 if err != nil {
693 return nil, err
694 }
695 return res, nil
696}
697
698func findGitRoot(ctx context.Context, path string) (string, error) {
699 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-common-dir")
700 cmd.Dir = path
701 out, err := cmd.CombinedOutput()
702 if err != nil {
703 if strings.Contains(string(out), "not a git repository") {
704 return "", fmt.Errorf(`sketch needs to run from within a git repo, but %s is not part of a git repo.
705Consider one of the following options:
706 - cd to a different dir that is already part of a git repo first, or
707 - to create a new git repo from this directory (%s), run this command:
708
709 git init . && git commit --allow-empty -m "initial commit"
710
711and try running sketch again.
712`, path, path)
713 }
714 return "", fmt.Errorf("git rev-parse --git-common-dir: %s: %w", out, err)
715 }
716 gitDir := strings.TrimSpace(string(out)) // location of .git dir, often as a relative path
717 absGitDir := filepath.Join(path, gitDir)
718 return filepath.Dir(absGitDir), err
719}
720
721func OpenBrowser(ctx context.Context, url string) {
722 var cmd *exec.Cmd
723 switch runtime.GOOS {
724 case "darwin":
725 cmd = exec.CommandContext(ctx, "open", url)
726 case "windows":
727 cmd = exec.CommandContext(ctx, "cmd", "/c", "start", url)
728 default: // Linux and other Unix-like systems
729 cmd = exec.CommandContext(ctx, "xdg-open", url)
730 }
731 if b, err := cmd.CombinedOutput(); err != nil {
732 fmt.Fprintf(os.Stderr, "failed to open browser: %v: %s\n", err, b)
733 }
734}
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700735
736// moveFile is like Python's shutil.move, in that it tries a rename, and, if that fails,
737// copies and deletes
738func moveFile(src, dst string) error {
739 if err := os.Rename(src, dst); err == nil {
740 return nil
741 }
742
743 stat, err := os.Stat(src)
744 if err != nil {
745 return err
746 }
747
748 sourceFile, err := os.Open(src)
749 if err != nil {
750 return err
751 }
752 defer sourceFile.Close()
753
754 destFile, err := os.Create(dst)
755 if err != nil {
756 return err
757 }
758 defer destFile.Close()
759
760 _, err = io.Copy(destFile, sourceFile)
761 if err != nil {
762 return err
763 }
764
765 sourceFile.Close()
766 destFile.Close()
767
768 os.Chmod(dst, stat.Mode())
769
770 return os.Remove(src)
771}