| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 1 | // Package dockerimg |
| 2 | package dockerimg |
| 3 | |
| 4 | import ( |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 5 | "archive/tar" |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 6 | "bytes" |
| 7 | "context" |
| Philip Zeyliger | 5e227dd | 2025-04-21 15:55:29 -0700 | [diff] [blame] | 8 | "crypto/rand" |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 9 | "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 Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 22 | "sync/atomic" |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 23 | "time" |
| 24 | |
| Sean McCullough | 7013e9e | 2025-05-14 02:03:58 +0000 | [diff] [blame] | 25 | "golang.org/x/crypto/ssh" |
| Josh Bleecher Snyder | 78707d6 | 2025-04-30 21:06:49 +0000 | [diff] [blame] | 26 | "sketch.dev/browser" |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 27 | "sketch.dev/embedded" |
| Sean McCullough | baa2b59 | 2025-04-23 10:40:08 -0700 | [diff] [blame] | 28 | "sketch.dev/loop/server" |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 29 | "sketch.dev/skribe" |
| 30 | ) |
| 31 | |
| 32 | // ContainerConfig holds all configuration for launching a container |
| 33 | type 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 Crawshaw | 5a7b369 | 2025-05-05 16:49:15 -0700 | [diff] [blame] | 43 | // Model is the name of the LLM model to use. |
| 44 | Model string |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 45 | |
| David Crawshaw | 5a7b369 | 2025-05-05 16:49:15 -0700 | [diff] [blame] | 46 | // 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 51 | |
| 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 Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 70 | // BaseImage is the base Docker image to use for layering the repo |
| 71 | BaseImage string |
| 72 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 73 | // 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 Zeyliger | d140295 | 2025-04-23 03:54:37 +0000 | [diff] [blame] | 81 | |
| Sean McCullough | baa2b59 | 2025-04-23 10:40:08 -0700 | [diff] [blame] | 82 | // Host port for the container's ssh server |
| 83 | SSHPort int |
| 84 | |
| Philip Zeyliger | 18532b2 | 2025-04-23 21:11:46 +0000 | [diff] [blame] | 85 | // Outside information to pass to the container |
| 86 | OutsideHostname string |
| 87 | OutsideOS string |
| 88 | OutsideWorkingDir string |
| Philip Zeyliger | b74c4f6 | 2025-04-25 19:18:49 -0700 | [diff] [blame] | 89 | |
| Pokey Rule | 0dcebe1 | 2025-04-28 14:51:04 +0100 | [diff] [blame] | 90 | // If true, exit after the first turn |
| 91 | OneShot bool |
| 92 | |
| 93 | // Initial prompt |
| 94 | Prompt string |
| Philip Zeyliger | 1b47aa2 | 2025-04-28 19:25:38 +0000 | [diff] [blame] | 95 | |
| David Crawshaw | b5f6a00 | 2025-05-05 08:27:16 -0700 | [diff] [blame] | 96 | // Verbose enables verbose output |
| 97 | Verbose bool |
| Philip Zeyliger | 1dc2137 | 2025-05-05 19:54:44 +0000 | [diff] [blame] | 98 | |
| 99 | // DockerArgs are additional arguments to pass to the docker create command |
| 100 | DockerArgs string |
| Josh Bleecher Snyder | b1cca6f | 2025-05-06 01:52:55 +0000 | [diff] [blame] | 101 | |
| Josh Bleecher Snyder | ac761c9 | 2025-05-16 18:58:45 +0000 | [diff] [blame] | 102 | // Mounts specifies volumes to mount in the container in format /path/on/host:/path/in/container |
| 103 | Mounts []string |
| 104 | |
| Josh Bleecher Snyder | b1cca6f | 2025-05-06 01:52:55 +0000 | [diff] [blame] | 105 | // ExperimentFlag contains the experimental features to enable |
| 106 | ExperimentFlag string |
| Philip Zeyliger | 613c0f5 | 2025-05-15 16:36:22 -0700 | [diff] [blame] | 107 | |
| 108 | // TermUI enables terminal UI |
| 109 | TermUI bool |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 110 | |
| Josh Bleecher Snyder | 33032d3 | 2025-05-30 16:28:21 +0000 | [diff] [blame] | 111 | // Budget configuration |
| Philip Zeyliger | e6c294d | 2025-06-04 16:55:21 +0000 | [diff] [blame] | 112 | MaxDollars float64 |
| Josh Bleecher Snyder | 33032d3 | 2025-05-30 16:28:21 +0000 | [diff] [blame] | 113 | |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 114 | GitRemoteUrl string |
| 115 | |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 116 | // Original git origin URL from the host repository |
| 117 | OriginalGitOrigin string |
| 118 | |
| Josh Bleecher Snyder | 664404e | 2025-06-04 21:56:42 +0000 | [diff] [blame] | 119 | // Upstream branch for git work |
| 120 | Upstream string |
| 121 | |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 122 | // Commit hash to checkout from GetRemoteUrl |
| 123 | Commit string |
| 124 | |
| 125 | // Outtie's HTTP server |
| 126 | OutsideHTTP string |
| Philip Zeyliger | be7802a | 2025-06-04 20:15:25 +0000 | [diff] [blame] | 127 | |
| 128 | // Prefix for git branches created by sketch |
| 129 | BranchPrefix string |
| philip.zeyliger | 6d3de48 | 2025-06-10 19:38:14 -0700 | [diff] [blame] | 130 | |
| 131 | // LinkToGitHub enables GitHub branch linking in UI |
| 132 | LinkToGitHub bool |
| Philip Zeyliger | d4be7a2 | 2025-06-15 09:39:00 -0700 | [diff] [blame] | 133 | |
| 134 | // SubtraceToken enables running sketch under subtrace.dev (development only) |
| 135 | SubtraceToken string |
| Philip Zeyliger | 194bfa8 | 2025-06-24 06:03:06 -0700 | [diff] [blame] | 136 | |
| 137 | // MCPServers contains MCP server configurations |
| 138 | MCPServers []string |
| Philip Zeyliger | 254c49f | 2025-07-17 17:26:24 -0700 | [diff] [blame] | 139 | |
| 140 | // PassthroughUpstream configures upstream remote for passthrough to innie |
| 141 | PassthroughUpstream bool |
| Josh Bleecher Snyder | e75d0ea | 2025-07-21 23:50:44 +0000 | [diff] [blame] | 142 | |
| Josh Bleecher Snyder | 57afbca | 2025-07-23 13:29:59 -0700 | [diff] [blame] | 143 | // DumpLLM requests dumping of raw communications with LLM services to files |
| 144 | DumpLLM bool |
| Josh Bleecher Snyder | 1e55167 | 2025-07-30 03:16:54 +0000 | [diff] [blame] | 145 | |
| 146 | // FetchOnLaunch enables git fetch during initialization |
| 147 | FetchOnLaunch bool |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | // LaunchContainer creates a docker container for a project, installs sketch and opens a connection to it. |
| 151 | // It writes status to stdout. |
| David Crawshaw | b5f6a00 | 2025-05-05 08:27:16 -0700 | [diff] [blame] | 152 | func LaunchContainer(ctx context.Context, config ContainerConfig) error { |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 153 | slog.Debug("Container Config", slog.String("config", fmt.Sprintf("%+v", config))) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 154 | if _, err := exec.LookPath("docker"); err != nil { |
| Philip Zeyliger | 5e227dd | 2025-04-21 15:55:29 -0700 | [diff] [blame] | 155 | if runtime.GOOS == "darwin" { |
| 156 | return fmt.Errorf("cannot find `docker` binary; run: brew install docker colima && colima start") |
| 157 | } else { |
| 158 | return fmt.Errorf("cannot find `docker` binary; install docker (e.g., apt-get install docker.io)") |
| 159 | } |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | if out, err := combinedOutput(ctx, "docker", "ps"); err != nil { |
| 163 | // `docker ps` provides a good error message here that can be |
| 164 | // easily chatgpt'ed by users, so send it to the user as-is: |
| 165 | // Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? |
| 166 | return fmt.Errorf("docker ps: %s (%w)", out, err) |
| 167 | } |
| 168 | |
| 169 | _, hostPort, err := net.SplitHostPort(config.LocalAddr) |
| 170 | if err != nil { |
| 171 | return err |
| 172 | } |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 173 | // Bail early if sketch was started from a path that isn't in a git repo. |
| 174 | err = requireGitRepo(ctx, config.Path) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 175 | if err != nil { |
| 176 | return err |
| 177 | } |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 178 | |
| 179 | // Best effort attempt to get repo root; fall back to current directory. |
| 180 | gitRoot := config.Path |
| 181 | if root, err := gitRepoRoot(ctx, config.Path); err == nil { |
| 182 | gitRoot = root |
| 183 | } |
| 184 | |
| 185 | // Capture the original git origin URL before we set up the temporary git server |
| 186 | config.OriginalGitOrigin = getOriginalGitOrigin(ctx, gitRoot) |
| 187 | |
| Philip Zeyliger | 254c49f | 2025-07-17 17:26:24 -0700 | [diff] [blame] | 188 | // If we've got an upstream, let's configure |
| 189 | if config.OriginalGitOrigin != "" { |
| 190 | config.PassthroughUpstream = true |
| 191 | } |
| 192 | |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 193 | imgName, err := findOrBuildDockerImage(ctx, gitRoot, config.BaseImage, config.ForceRebuild, config.Verbose) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 194 | if err != nil { |
| 195 | return err |
| 196 | } |
| 197 | |
| Philip Zeyliger | c72fff5 | 2025-04-29 20:17:54 +0000 | [diff] [blame] | 198 | cntrName := "sketch-" + config.SessionID |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 199 | defer func() { |
| 200 | if config.NoCleanup { |
| 201 | return |
| 202 | } |
| 203 | if out, err := combinedOutput(ctx, "docker", "kill", cntrName); err != nil { |
| 204 | // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err) |
| 205 | _ = out |
| 206 | } |
| 207 | if out, err := combinedOutput(ctx, "docker", "rm", cntrName); err != nil { |
| 208 | // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err) |
| 209 | _ = out |
| 210 | } |
| 211 | }() |
| 212 | |
| 213 | // errCh receives errors from operations that this function calls in separate goroutines. |
| 214 | errCh := make(chan error) |
| 215 | |
| Josh Bleecher Snyder | 725cfe0 | 2025-07-18 01:31:06 +0000 | [diff] [blame] | 216 | var upstream string |
| 217 | if out, err := combinedOutput(ctx, "git", "branch", "--show-current"); err != nil { |
| 218 | slog.DebugContext(ctx, "git branch --show-current failed (continuing)", "error", err) |
| 219 | } else { |
| 220 | upstream = strings.TrimSpace(string(out)) |
| 221 | } |
| 222 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 223 | // Start the git server |
| Josh Bleecher Snyder | 725cfe0 | 2025-07-18 01:31:06 +0000 | [diff] [blame] | 224 | gitSrv, err := newGitServer(gitRoot, config.PassthroughUpstream, upstream) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 225 | if err != nil { |
| 226 | return fmt.Errorf("failed to start git server: %w", err) |
| 227 | } |
| 228 | defer gitSrv.shutdown(ctx) |
| 229 | |
| 230 | go func() { |
| 231 | errCh <- gitSrv.serve(ctx) |
| 232 | }() |
| 233 | |
| philz | 2461320 | 2025-07-15 20:56:21 -0700 | [diff] [blame] | 234 | // Check if we have any commits, and if not, create an empty initial commit |
| 235 | cmd := exec.CommandContext(ctx, "git", "rev-list", "--all", "--count") |
| 236 | countOut, err := cmd.CombinedOutput() |
| 237 | if err != nil { |
| 238 | return fmt.Errorf("git rev-list --all --count: %s: %w", countOut, err) |
| 239 | } |
| 240 | commitCount := strings.TrimSpace(string(countOut)) |
| 241 | if commitCount == "0" { |
| 242 | slog.Info("No commits found, creating empty initial commit") |
| 243 | cmd = exec.CommandContext(ctx, "git", "commit", "--allow-empty", "-m", "Initial empty commit") |
| 244 | if commitOut, err := cmd.CombinedOutput(); err != nil { |
| 245 | return fmt.Errorf("git commit --allow-empty: %s: %w", commitOut, err) |
| 246 | } |
| 247 | } |
| 248 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 249 | // Get the current host git commit |
| 250 | var commit string |
| Philip Zeyliger | a347b17 | 2025-06-04 16:18:57 +0000 | [diff] [blame] | 251 | if out, err := combinedOutput(ctx, "git", "rev-parse", "HEAD"); err != nil { |
| 252 | return fmt.Errorf("git rev-parse HEAD: %w", err) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 253 | } else { |
| 254 | commit = strings.TrimSpace(string(out)) |
| 255 | } |
| Josh Bleecher Snyder | 664404e | 2025-06-04 21:56:42 +0000 | [diff] [blame] | 256 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 257 | if out, err := combinedOutput(ctx, "git", "config", "http.receivepack", "true"); err != nil { |
| 258 | return fmt.Errorf("git config http.receivepack true: %s: %w", out, err) |
| 259 | } |
| 260 | |
| 261 | relPath, err := filepath.Rel(gitRoot, config.Path) |
| 262 | if err != nil { |
| 263 | return err |
| 264 | } |
| 265 | |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 266 | config.OutsideHTTP = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s", gitSrv.pass, gitSrv.gitPort) |
| 267 | config.GitRemoteUrl = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s/.git", gitSrv.pass, gitSrv.gitPort) |
| Josh Bleecher Snyder | 664404e | 2025-06-04 21:56:42 +0000 | [diff] [blame] | 268 | config.Upstream = upstream |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 269 | config.Commit = commit |
| 270 | |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 271 | // Create the sketch container, copy over linux sketch |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 272 | if err := createDockerContainer(ctx, cntrName, hostPort, relPath, imgName, config); err != nil { |
| Josh Bleecher Snyder | 2772f63 | 2025-05-01 21:42:35 +0000 | [diff] [blame] | 273 | return fmt.Errorf("failed to create docker container: %w", err) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 274 | } |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 275 | if err := copyEmbeddedLinuxBinaryToContainer(ctx, cntrName); err != nil { |
| 276 | return fmt.Errorf("failed to copy linux binary to container: %w", err) |
| David Crawshaw | 8bff16a | 2025-04-18 01:16:49 -0700 | [diff] [blame] | 277 | } |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 278 | |
| David Crawshaw | 53786ef | 2025-04-24 12:52:51 -0700 | [diff] [blame] | 279 | fmt.Printf("📦 running in container %s\n", cntrName) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 280 | |
| Philip Zeyliger | d4be7a2 | 2025-06-15 09:39:00 -0700 | [diff] [blame] | 281 | // Setup subtrace if token is provided (development only) - after container creation, before start |
| 282 | if config.SubtraceToken != "" { |
| 283 | fmt.Println("🔍 Setting up subtrace (development only)") |
| 284 | if err := setupSubtraceBeforeStart(ctx, cntrName, config.SubtraceToken); err != nil { |
| 285 | return fmt.Errorf("failed to setup subtrace: %w", err) |
| 286 | } |
| 287 | } |
| 288 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 289 | // Start the sketch container |
| 290 | if out, err := combinedOutput(ctx, "docker", "start", cntrName); err != nil { |
| 291 | return fmt.Errorf("docker start: %s, %w", out, err) |
| 292 | } |
| 293 | |
| 294 | // Copies structured logs from the container to the host. |
| 295 | copyLogs := func() { |
| 296 | if config.ContainerLogDest == "" { |
| 297 | return |
| 298 | } |
| 299 | out, err := combinedOutput(ctx, "docker", "logs", cntrName) |
| 300 | if err != nil { |
| 301 | fmt.Fprintf(os.Stderr, "docker logs failed: %v\n", err) |
| 302 | return |
| 303 | } |
| Josh Bleecher Snyder | 7660e4e | 2025-04-24 10:34:17 -0700 | [diff] [blame] | 304 | prefix := []byte("structured logs:") |
| 305 | for line := range bytes.Lines(out) { |
| 306 | rest, ok := bytes.CutPrefix(line, prefix) |
| 307 | if !ok { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 308 | continue |
| 309 | } |
| Josh Bleecher Snyder | 7660e4e | 2025-04-24 10:34:17 -0700 | [diff] [blame] | 310 | logFile := string(bytes.TrimSpace(rest)) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 311 | srcPath := fmt.Sprintf("%s:%s", cntrName, logFile) |
| 312 | logFileName := filepath.Base(logFile) |
| 313 | dstPath := filepath.Join(config.ContainerLogDest, logFileName) |
| 314 | _, err := combinedOutput(ctx, "docker", "cp", srcPath, dstPath) |
| 315 | if err != nil { |
| 316 | fmt.Fprintf(os.Stderr, "docker cp %s %s failed: %v\n", srcPath, dstPath, err) |
| 317 | } |
| 318 | fmt.Fprintf(os.Stderr, "\ncopied container log %s to %s\n", srcPath, dstPath) |
| 319 | } |
| 320 | } |
| 321 | |
| 322 | // NOTE: we want to see what the internal sketch binary prints |
| 323 | // regardless of the setting of the verbosity flag on the external |
| 324 | // binary, so reading "docker logs", which is the stdout/stderr of |
| 325 | // the internal binary is not conditional on the verbose flag. |
| 326 | appendInternalErr := func(err error) error { |
| 327 | if err == nil { |
| 328 | return nil |
| 329 | } |
| 330 | out, logsErr := combinedOutput(ctx, "docker", "logs", cntrName) |
| Philip Zeyliger | d140295 | 2025-04-23 03:54:37 +0000 | [diff] [blame] | 331 | if logsErr != nil { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 332 | return fmt.Errorf("%w; and docker logs failed: %s, %v", err, out, logsErr) |
| 333 | } |
| 334 | out = bytes.TrimSpace(out) |
| 335 | if len(out) > 0 { |
| 336 | return fmt.Errorf("docker logs: %s;\n%w", out, err) |
| 337 | } |
| 338 | return err |
| 339 | } |
| 340 | |
| 341 | // Get the sketch server port from the container |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 342 | localAddr, err := getContainerPort(ctx, cntrName, "80") |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 343 | if err != nil { |
| 344 | return appendInternalErr(err) |
| 345 | } |
| 346 | |
| Philip Zeyliger | 0044241 | 2025-05-14 11:03:23 -0700 | [diff] [blame] | 347 | if config.Verbose { |
| 348 | fmt.Fprintf(os.Stderr, "Host web server: http://%s/\n", localAddr) |
| 349 | } |
| 350 | |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 351 | localSSHAddr, err := getContainerPort(ctx, cntrName, "22") |
| 352 | if err != nil { |
| 353 | return appendInternalErr(err) |
| 354 | } |
| 355 | sshHost, sshPort, err := net.SplitHostPort(localSSHAddr) |
| 356 | if err != nil { |
| David Crawshaw | b5f6a00 | 2025-05-05 08:27:16 -0700 | [diff] [blame] | 357 | return appendInternalErr(fmt.Errorf("failed to split ssh host and port: %w", err)) |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 358 | } |
| Sean McCullough | 4854c65 | 2025-04-24 18:37:02 -0700 | [diff] [blame] | 359 | |
| Sean McCullough | 7013e9e | 2025-05-14 02:03:58 +0000 | [diff] [blame] | 360 | var sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate []byte |
| Sean McCullough | 4854c65 | 2025-04-24 18:37:02 -0700 | [diff] [blame] | 361 | |
| banksean | 29d689f | 2025-06-23 15:41:26 +0000 | [diff] [blame] | 362 | cst, err := NewLocalSSHimmer(cntrName, sshHost, sshPort) |
| Sean McCullough | 078e85a | 2025-05-08 17:28:34 -0700 | [diff] [blame] | 363 | if err != nil { |
| 364 | return appendInternalErr(fmt.Errorf("NewContainerSSHTheather: %w", err)) |
| 365 | } |
| 366 | |
| 367 | sshErr := CheckSSHReachability(cntrName) |
| Sean McCullough | 15c9528 | 2025-05-08 16:48:38 -0700 | [diff] [blame] | 368 | sshAvailable := false |
| 369 | sshErrMsg := "" |
| 370 | if sshErr != nil { |
| 371 | fmt.Println(sshErr.Error()) |
| 372 | sshErrMsg = sshErr.Error() |
| Sean McCullough | f5e28f6 | 2025-04-25 10:48:00 -0700 | [diff] [blame] | 373 | // continue - ssh config is not required for the rest of sketch to function locally. |
| 374 | } else { |
| Sean McCullough | 15c9528 | 2025-05-08 16:48:38 -0700 | [diff] [blame] | 375 | sshAvailable = true |
| Sean McCullough | ea3fc20 | 2025-04-28 12:53:37 -0700 | [diff] [blame] | 376 | // Note: The vscode: link uses an undocumented request parameter that I really had to dig to find: |
| 377 | // https://github.com/microsoft/vscode/blob/2b9486161abaca59b5132ce3c59544f3cc7000f6/src/vs/code/electron-main/app.ts#L878 |
| Sean McCullough | f5e28f6 | 2025-04-25 10:48:00 -0700 | [diff] [blame] | 378 | fmt.Printf(`Connect to this container via any of these methods: |
| Sean McCullough | 4854c65 | 2025-04-24 18:37:02 -0700 | [diff] [blame] | 379 | 🖥️ ssh %s |
| 380 | 🖥️ code --remote ssh-remote+root@%s /app -n |
| Sean McCullough | ea3fc20 | 2025-04-28 12:53:37 -0700 | [diff] [blame] | 381 | 🔗 vscode://vscode-remote/ssh-remote+root@%s/app?windowId=_blank |
| Sean McCullough | 4854c65 | 2025-04-24 18:37:02 -0700 | [diff] [blame] | 382 | `, cntrName, cntrName, cntrName) |
| Sean McCullough | f5e28f6 | 2025-04-25 10:48:00 -0700 | [diff] [blame] | 383 | sshUserIdentity = cst.userIdentity |
| 384 | sshServerIdentity = cst.serverIdentity |
| Sean McCullough | 7013e9e | 2025-05-14 02:03:58 +0000 | [diff] [blame] | 385 | |
| 386 | // Get the Container CA public key for mutual auth |
| 387 | if cst.containerCAPublicKey != nil { |
| 388 | containerCAPublicKey = ssh.MarshalAuthorizedKey(cst.containerCAPublicKey) |
| Sean McCullough | 7013e9e | 2025-05-14 02:03:58 +0000 | [diff] [blame] | 389 | } |
| 390 | |
| 391 | // Get the host certificate for mutual auth |
| 392 | hostCertificate = cst.hostCertificate |
| 393 | |
| Sean McCullough | f5e28f6 | 2025-04-25 10:48:00 -0700 | [diff] [blame] | 394 | defer func() { |
| 395 | if err := cst.Cleanup(); err != nil { |
| 396 | appendInternalErr(err) |
| 397 | } |
| 398 | }() |
| 399 | } |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 400 | |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 401 | // Tell the sketch container to Init(), which starts the SSH server |
| 402 | // and checks out the right commit. |
| 403 | // TODO: I'm trying to move as much configuration as possible into the command-line |
| 404 | // arguments to avoid splitting them up. "localAddr" is the only difficult one: |
| 405 | // we run (effectively) "docker run -p 0:80 image sketch -flags" and you can't |
| 406 | // get the port Docker chose until after the process starts. The SSH config is |
| 407 | // mostly available ahead of time, but whether it works ("sshAvailable"/"sshErrMsg") |
| 408 | // may also empirically need to be done after the SSH server is up and running. |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 409 | go func() { |
| 410 | // TODO: Why is this called in a goroutine? I have found that when I pull this out |
| 411 | // of the goroutine and call it inline, then the terminal UI clears itself and all |
| 412 | // the scrollback (which is not good, but also not fatal). I can't see why it does this |
| 413 | // though, since none of the calls in postContainerInitConfig obviously write to stdout |
| 414 | // or stderr. |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 415 | if err := postContainerInitConfig(ctx, localAddr, sshAvailable, sshErrMsg, sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate); err != nil { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 416 | slog.ErrorContext(ctx, "LaunchContainer.postContainerInitConfig", slog.String("err", err.Error())) |
| 417 | errCh <- appendInternalErr(err) |
| 418 | } |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 419 | |
| Philip Zeyliger | 6ed6adb | 2025-04-23 19:56:38 -0700 | [diff] [blame] | 420 | // We open the browser after the init config because the above waits for the web server to be serving. |
| Josh Bleecher Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 421 | ps1URL := "http://" + localAddr |
| 422 | if config.SkabandAddr != "" { |
| 423 | ps1URL = fmt.Sprintf("%s/s/%s", config.SkabandAddr, config.SessionID) |
| Philip Zeyliger | 6ed6adb | 2025-04-23 19:56:38 -0700 | [diff] [blame] | 424 | } |
| Josh Bleecher Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 425 | if config.OpenBrowser { |
| 426 | browser.Open(ps1URL) |
| 427 | } |
| 428 | gitSrv.ps1URL.Store(&ps1URL) |
| Philip Zeyliger | 6ed6adb | 2025-04-23 19:56:38 -0700 | [diff] [blame] | 429 | }() |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 430 | |
| 431 | go func() { |
| 432 | cmd := exec.CommandContext(ctx, "docker", "attach", cntrName) |
| 433 | cmd.Stdin = os.Stdin |
| 434 | cmd.Stdout = os.Stdout |
| 435 | cmd.Stderr = os.Stderr |
| 436 | errCh <- run(ctx, "docker attach", cmd) |
| 437 | }() |
| 438 | |
| 439 | defer copyLogs() |
| 440 | |
| 441 | for { |
| 442 | select { |
| 443 | case <-ctx.Done(): |
| 444 | return ctx.Err() |
| 445 | case err := <-errCh: |
| 446 | if err != nil { |
| 447 | return appendInternalErr(fmt.Errorf("container process: %w", err)) |
| 448 | } |
| 449 | return nil |
| 450 | } |
| 451 | } |
| 452 | } |
| 453 | |
| 454 | func combinedOutput(ctx context.Context, cmdName string, args ...string) ([]byte, error) { |
| 455 | cmd := exec.CommandContext(ctx, cmdName, args...) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 456 | start := time.Now() |
| 457 | |
| 458 | out, err := cmd.CombinedOutput() |
| 459 | if err != nil { |
| David Crawshaw | c7e7796 | 2025-05-03 13:20:18 -0700 | [diff] [blame] | 460 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 461 | } else { |
| David Crawshaw | c7e7796 | 2025-05-03 13:20:18 -0700 | [diff] [blame] | 462 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 463 | } |
| 464 | return out, err |
| 465 | } |
| 466 | |
| 467 | func run(ctx context.Context, cmdName string, cmd *exec.Cmd) error { |
| 468 | start := time.Now() |
| 469 | err := cmd.Run() |
| 470 | if err != nil { |
| David Crawshaw | c7e7796 | 2025-05-03 13:20:18 -0700 | [diff] [blame] | 471 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 472 | } else { |
| David Crawshaw | c7e7796 | 2025-05-03 13:20:18 -0700 | [diff] [blame] | 473 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 474 | } |
| 475 | return err |
| 476 | } |
| 477 | |
| 478 | type gitServer struct { |
| 479 | gitLn net.Listener |
| 480 | gitPort string |
| 481 | srv *http.Server |
| Philip Zeyliger | 5e227dd | 2025-04-21 15:55:29 -0700 | [diff] [blame] | 482 | pass string |
| Josh Bleecher Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 483 | ps1URL atomic.Pointer[string] |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 484 | } |
| 485 | |
| 486 | func (gs *gitServer) shutdown(ctx context.Context) { |
| 487 | gs.srv.Shutdown(ctx) |
| 488 | gs.gitLn.Close() |
| 489 | } |
| 490 | |
| 491 | // Serve a git remote from the host for the container to fetch from and push to. |
| 492 | func (gs *gitServer) serve(ctx context.Context) error { |
| 493 | slog.DebugContext(ctx, "starting git server", slog.String("git_remote_addr", "http://host.docker.internal:"+gs.gitPort+"/.git")) |
| 494 | return gs.srv.Serve(gs.gitLn) |
| 495 | } |
| 496 | |
| Josh Bleecher Snyder | 725cfe0 | 2025-07-18 01:31:06 +0000 | [diff] [blame] | 497 | func newGitServer(gitRoot string, configureUpstreamPassthrough bool, upstream string) (*gitServer, error) { |
| Josh Bleecher Snyder | 9f6a998 | 2025-04-22 17:34:15 -0700 | [diff] [blame] | 498 | ret := &gitServer{ |
| 499 | pass: rand.Text(), |
| 500 | } |
| Philip Zeyliger | 5e227dd | 2025-04-21 15:55:29 -0700 | [diff] [blame] | 501 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 502 | gitLn, err := net.Listen("tcp4", ":0") |
| 503 | if err != nil { |
| 504 | return nil, fmt.Errorf("git listen: %w", err) |
| 505 | } |
| 506 | ret.gitLn = gitLn |
| 507 | |
| Josh Bleecher Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 508 | browserC := make(chan bool, 1) // channel of browser open requests |
| 509 | |
| Josh Bleecher Snyder | 3e2111b | 2025-04-30 17:53:28 +0000 | [diff] [blame] | 510 | go func() { |
| Josh Bleecher Snyder | 9957046 | 2025-05-05 10:26:14 -0700 | [diff] [blame] | 511 | for range browserC { |
| 512 | browser.Open(*ret.ps1URL.Load()) |
| Josh Bleecher Snyder | 3e2111b | 2025-04-30 17:53:28 +0000 | [diff] [blame] | 513 | } |
| 514 | }() |
| 515 | |
| Philip Zeyliger | 254c49f | 2025-07-17 17:26:24 -0700 | [diff] [blame] | 516 | var hooksDir string |
| 517 | if configureUpstreamPassthrough { |
| Josh Bleecher Snyder | 725cfe0 | 2025-07-18 01:31:06 +0000 | [diff] [blame] | 518 | hooksDir, err = setupHooksDir(upstream) |
| Philip Zeyliger | 254c49f | 2025-07-17 17:26:24 -0700 | [diff] [blame] | 519 | if err != nil { |
| 520 | return nil, fmt.Errorf("failed to setup hooks directory: %w", err) |
| 521 | } |
| 522 | } |
| 523 | |
| 524 | srv := http.Server{Handler: &gitHTTP{gitRepoRoot: gitRoot, hooksDir: hooksDir, pass: []byte(ret.pass), browserC: browserC}} |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 525 | ret.srv = &srv |
| 526 | |
| 527 | _, gitPort, err := net.SplitHostPort(gitLn.Addr().String()) |
| 528 | if err != nil { |
| 529 | return nil, fmt.Errorf("git port: %w", err) |
| 530 | } |
| 531 | ret.gitPort = gitPort |
| 532 | return ret, nil |
| 533 | } |
| 534 | |
| 535 | func createDockerContainer(ctx context.Context, cntrName, hostPort, relPath, imgName string, config ContainerConfig) error { |
| David Crawshaw | 69c6731 | 2025-04-17 13:42:00 -0700 | [diff] [blame] | 536 | cmdArgs := []string{ |
| 537 | "create", |
| David Crawshaw | 66cf74e | 2025-05-05 08:48:39 -0700 | [diff] [blame] | 538 | "-i", |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 539 | "--name", cntrName, |
| 540 | "-p", hostPort + ":80", // forward container port 80 to a host port |
| David Crawshaw | 3659d87 | 2025-05-05 17:52:23 -0700 | [diff] [blame] | 541 | "-e", "SKETCH_MODEL_API_KEY=" + config.ModelAPIKey, |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 542 | } |
| Philip Zeyliger | 3d2eff0 | 2025-05-27 09:30:31 -0700 | [diff] [blame] | 543 | if !(config.OneShot || !config.TermUI) { |
| David Crawshaw | 66cf74e | 2025-05-05 08:48:39 -0700 | [diff] [blame] | 544 | cmdArgs = append(cmdArgs, "-t") |
| 545 | } |
| Josh Bleecher Snyder | 2772f63 | 2025-05-01 21:42:35 +0000 | [diff] [blame] | 546 | |
| 547 | for _, envVar := range getEnvForwardingFromGitConfig(ctx) { |
| 548 | cmdArgs = append(cmdArgs, "-e", envVar) |
| 549 | } |
| David Crawshaw | 5a7b369 | 2025-05-05 16:49:15 -0700 | [diff] [blame] | 550 | if config.ModelURL != "" { |
| David Crawshaw | 3659d87 | 2025-05-05 17:52:23 -0700 | [diff] [blame] | 551 | cmdArgs = append(cmdArgs, "-e", "SKETCH_MODEL_URL="+config.ModelURL) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 552 | } |
| 553 | if config.SketchPubKey != "" { |
| 554 | cmdArgs = append(cmdArgs, "-e", "SKETCH_PUB_KEY="+config.SketchPubKey) |
| 555 | } |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 556 | if config.SSHPort > 0 { |
| 557 | cmdArgs = append(cmdArgs, "-p", fmt.Sprintf("%d:22", config.SSHPort)) // forward container ssh port to host ssh port |
| 558 | } else { |
| Philip Zeyliger | 87d29ef | 2025-05-16 20:25:28 -0700 | [diff] [blame] | 559 | cmdArgs = append(cmdArgs, "-p", "0:22") // use an ephemeral host port for ssh. |
| Sean McCullough | baa2b59 | 2025-04-23 10:40:08 -0700 | [diff] [blame] | 560 | } |
| Philip Zeyliger | 5e227dd | 2025-04-21 15:55:29 -0700 | [diff] [blame] | 561 | // colima does this by default, but Linux docker seems to need this set explicitly |
| 562 | cmdArgs = append(cmdArgs, "--add-host", "host.docker.internal:host-gateway") |
| Josh Bleecher Snyder | ac761c9 | 2025-05-16 18:58:45 +0000 | [diff] [blame] | 563 | |
| David Crawshaw | 1bd636c | 2025-06-13 19:56:27 +0000 | [diff] [blame] | 564 | // Add seccomp profile to prevent killing PID 1 (the sketch process itself) |
| 565 | // Write the seccomp profile to cache directory if it doesn't exist |
| 566 | seccompPath, err := ensureSeccompProfile(ctx) |
| 567 | if err != nil { |
| 568 | return fmt.Errorf("failed to create seccomp profile: %w", err) |
| 569 | } |
| 570 | cmdArgs = append(cmdArgs, "--security-opt", "seccomp="+seccompPath) |
| 571 | |
| Philip Zeyliger | d4be7a2 | 2025-06-15 09:39:00 -0700 | [diff] [blame] | 572 | // Add subtrace environment variable if token is provided |
| 573 | if config.SubtraceToken != "" { |
| 574 | cmdArgs = append(cmdArgs, "-e", "SUBTRACE_TOKEN="+config.SubtraceToken) |
| 575 | cmdArgs = append(cmdArgs, "-e", "SUBTRACE_HTTP2=1") |
| 576 | } |
| 577 | |
| Josh Bleecher Snyder | ac761c9 | 2025-05-16 18:58:45 +0000 | [diff] [blame] | 578 | // Add volume mounts if specified |
| 579 | for _, mount := range config.Mounts { |
| 580 | if mount != "" { |
| 581 | cmdArgs = append(cmdArgs, "-v", mount) |
| 582 | } |
| 583 | } |
| Philip Zeyliger | d4be7a2 | 2025-06-15 09:39:00 -0700 | [diff] [blame] | 584 | cmdArgs = append(cmdArgs, imgName) |
| 585 | |
| 586 | // Add command: either [sketch] or [subtrace run -- sketch] |
| 587 | if config.SubtraceToken != "" { |
| 588 | cmdArgs = append(cmdArgs, "/usr/local/bin/subtrace", "run", "--", "/bin/sketch") |
| 589 | } else { |
| 590 | cmdArgs = append(cmdArgs, "/bin/sketch") |
| 591 | } |
| 592 | |
| 593 | // Add all sketch arguments |
| 594 | cmdArgs = append(cmdArgs, |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 595 | "-unsafe", |
| 596 | "-addr=:80", |
| 597 | "-session-id="+config.SessionID, |
| Philip Zeyliger | d140295 | 2025-04-23 03:54:37 +0000 | [diff] [blame] | 598 | "-git-username="+config.GitUsername, |
| 599 | "-git-email="+config.GitEmail, |
| Philip Zeyliger | 18532b2 | 2025-04-23 21:11:46 +0000 | [diff] [blame] | 600 | "-outside-hostname="+config.OutsideHostname, |
| 601 | "-outside-os="+config.OutsideOS, |
| 602 | "-outside-working-dir="+config.OutsideWorkingDir, |
| Josh Bleecher Snyder | 33032d3 | 2025-05-30 16:28:21 +0000 | [diff] [blame] | 603 | fmt.Sprintf("-max-dollars=%f", config.MaxDollars), |
| Josh Bleecher Snyder | 3cae7d9 | 2025-04-30 09:54:29 -0700 | [diff] [blame] | 604 | "-open=false", |
| Philip Zeyliger | 613c0f5 | 2025-05-15 16:36:22 -0700 | [diff] [blame] | 605 | "-termui="+fmt.Sprintf("%t", config.TermUI), |
| Philip Zeyliger | cabfa55 | 2025-05-19 16:14:28 -0700 | [diff] [blame] | 606 | "-verbose="+fmt.Sprintf("%t", config.Verbose), |
| Josh Bleecher Snyder | b1cca6f | 2025-05-06 01:52:55 +0000 | [diff] [blame] | 607 | "-x="+config.ExperimentFlag, |
| Philip Zeyliger | be7802a | 2025-06-04 20:15:25 +0000 | [diff] [blame] | 608 | "-branch-prefix="+config.BranchPrefix, |
| philip.zeyliger | 6d3de48 | 2025-06-10 19:38:14 -0700 | [diff] [blame] | 609 | "-link-to-github="+fmt.Sprintf("%t", config.LinkToGitHub), |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 610 | ) |
| philip.zeyliger | 8773e68 | 2025-06-11 21:36:21 -0700 | [diff] [blame] | 611 | // Set SSH connection string based on session ID for SSH Theater |
| 612 | cmdArgs = append(cmdArgs, "-ssh-connection-string=sketch-"+config.SessionID) |
| Josh Bleecher Snyder | a96f9d2 | 2025-07-11 02:47:33 +0000 | [diff] [blame] | 613 | if relPath != "." { |
| 614 | cmdArgs = append(cmdArgs, "-C", relPath) |
| 615 | } |
| David Crawshaw | 5a7b369 | 2025-05-05 16:49:15 -0700 | [diff] [blame] | 616 | if config.Model != "" { |
| 617 | cmdArgs = append(cmdArgs, "-model="+config.Model) |
| 618 | } |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 619 | if config.GitRemoteUrl != "" { |
| 620 | cmdArgs = append(cmdArgs, "-git-remote-url="+config.GitRemoteUrl) |
| 621 | if config.Commit == "" { |
| 622 | panic("Commit should have been set when GitRemoteUrl was set") |
| 623 | } |
| 624 | cmdArgs = append(cmdArgs, "-commit="+config.Commit) |
| Josh Bleecher Snyder | 664404e | 2025-06-04 21:56:42 +0000 | [diff] [blame] | 625 | cmdArgs = append(cmdArgs, "-upstream="+config.Upstream) |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 626 | } |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 627 | if config.OriginalGitOrigin != "" { |
| 628 | cmdArgs = append(cmdArgs, "-original-git-origin="+config.OriginalGitOrigin) |
| 629 | } |
| Philip Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 630 | if config.OutsideHTTP != "" { |
| 631 | cmdArgs = append(cmdArgs, "-outside-http="+config.OutsideHTTP) |
| 632 | } |
| Josh Bleecher Snyder | e3c2f22 | 2025-05-15 20:54:52 +0000 | [diff] [blame] | 633 | cmdArgs = append(cmdArgs, "-skaband-addr="+config.SkabandAddr) |
| Pokey Rule | 0dcebe1 | 2025-04-28 14:51:04 +0100 | [diff] [blame] | 634 | if config.Prompt != "" { |
| 635 | cmdArgs = append(cmdArgs, "-prompt", config.Prompt) |
| 636 | } |
| 637 | if config.OneShot { |
| 638 | cmdArgs = append(cmdArgs, "-one-shot") |
| Philip Zeyliger | b74c4f6 | 2025-04-25 19:18:49 -0700 | [diff] [blame] | 639 | } |
| Josh Bleecher Snyder | 9386009 | 2025-07-23 13:24:14 -0700 | [diff] [blame] | 640 | cmdArgs = append(cmdArgs, "-llm-api-key="+config.ModelAPIKey) |
| Philip Zeyliger | 194bfa8 | 2025-06-24 06:03:06 -0700 | [diff] [blame] | 641 | // Add MCP server configurations |
| 642 | for _, mcpServer := range config.MCPServers { |
| 643 | cmdArgs = append(cmdArgs, "-mcp", mcpServer) |
| 644 | } |
| Philip Zeyliger | 254c49f | 2025-07-17 17:26:24 -0700 | [diff] [blame] | 645 | if config.PassthroughUpstream { |
| 646 | cmdArgs = append(cmdArgs, "-passthrough-upstream") |
| 647 | } |
| Josh Bleecher Snyder | 57afbca | 2025-07-23 13:29:59 -0700 | [diff] [blame] | 648 | if config.DumpLLM { |
| 649 | cmdArgs = append(cmdArgs, "-dump-llm") |
| Josh Bleecher Snyder | e75d0ea | 2025-07-21 23:50:44 +0000 | [diff] [blame] | 650 | } |
| Josh Bleecher Snyder | 1e55167 | 2025-07-30 03:16:54 +0000 | [diff] [blame] | 651 | if !config.FetchOnLaunch { |
| 652 | cmdArgs = append(cmdArgs, "-fetch-on-launch=false") |
| 653 | } |
| Philip Zeyliger | 1dc2137 | 2025-05-05 19:54:44 +0000 | [diff] [blame] | 654 | |
| 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 665 | 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 McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 671 | func getContainerPort(ctx context.Context, cntrName, cntrPort string) (string, error) { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 672 | localAddr := "" |
| Sean McCullough | ae3480f | 2025-04-23 15:28:20 -0700 | [diff] [blame] | 673 | if out, err := combinedOutput(ctx, "docker", "port", cntrName, cntrPort); err != nil { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 674 | 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 Zeyliger | bc8c8dc | 2025-05-21 13:19:13 -0700 | [diff] [blame] | 689 | func postContainerInitConfig(ctx context.Context, localAddr string, sshAvailable bool, sshError string, sshServerIdentity, sshAuthorizedKeys, sshContainerCAKey, sshHostCertificate []byte) error { |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 690 | localURL := "http://" + localAddr |
| Sean McCullough | baa2b59 | 2025-04-23 10:40:08 -0700 | [diff] [blame] | 691 | |
| 692 | initMsg, err := json.Marshal( |
| 693 | server.InitRequest{ |
| Sean McCullough | 7013e9e | 2025-05-14 02:03:58 +0000 | [diff] [blame] | 694 | HostAddr: localAddr, |
| 695 | SSHAuthorizedKeys: sshAuthorizedKeys, |
| 696 | SSHServerIdentity: sshServerIdentity, |
| 697 | SSHContainerCAKey: sshContainerCAKey, |
| 698 | SSHHostCertificate: sshHostCertificate, |
| 699 | SSHAvailable: sshAvailable, |
| 700 | SSHError: sshError, |
| Sean McCullough | baa2b59 | 2025-04-23 10:40:08 -0700 | [diff] [blame] | 701 | }) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 702 | if err != nil { |
| 703 | return fmt.Errorf("init msg: %w", err) |
| 704 | } |
| 705 | |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 706 | // 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 Crawshaw | 99231ba | 2025-05-03 10:48:26 -0700 | [diff] [blame] | 720 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 724 | 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 Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 737 | func 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 742 | } |
| 743 | |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 744 | // 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 751 | if err != nil { |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 752 | return "", fmt.Errorf("failed to get base image ID for %s: %w", baseImage, err) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 753 | } |
| 754 | |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 755 | // 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 761 | |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 762 | // 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 Lackhove | 23772f4 | 2025-06-18 20:28:58 +0200 | [diff] [blame] | 769 | } |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 770 | return imgName, nil |
| David Crawshaw | b5f6a00 | 2025-05-05 08:27:16 -0700 | [diff] [blame] | 771 | } |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 772 | } |
| 773 | |
| Josh Bleecher Snyder | d117143 | 2025-07-18 15:04:05 +0000 | [diff] [blame] | 774 | // 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 Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 786 | 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 |
| 794 | func 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 |
| 812 | func 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 |
| 821 | func createCacheKey(baseImageID, gitRoot string) string { |
| 822 | h := sha256.New() |
| 823 | h.Write([]byte(baseImageID)) |
| 824 | h.Write([]byte(gitRoot)) |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 825 | // one-time cache-busting for the transition from copying git repos to only copying git objects |
| 826 | h.Write([]byte("git-objects")) |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 827 | 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 |
| 831 | func 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 Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 843 | // buildLayeredImage builds a new Docker image by layering the repo on top of the base image. |
| 844 | // |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 845 | // 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 Zeyliger | 882b1d1 | 2025-07-02 20:04:08 -0700 | [diff] [blame] | 848 | // |
| 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 Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 853 | // 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 Snyder | fa424f5 | 2025-07-11 18:43:55 +0000 | [diff] [blame] | 856 | // 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 Snyder | 369f262 | 2025-07-15 00:02:59 +0000 | [diff] [blame] | 859 | // 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 Zeyliger | 882b1d1 | 2025-07-02 20:04:08 -0700 | [diff] [blame] | 861 | // 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 Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 864 | // |
| 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. |
| 872 | func buildLayeredImage(ctx context.Context, imgName, baseImage, gitRoot string, verbose bool) error { |
| Josh Bleecher Snyder | fa424f5 | 2025-07-11 18:43:55 +0000 | [diff] [blame] | 873 | 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 Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 902 | |
| 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 916 | var gitUserEmail, gitUserName string |
| 917 | if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil { |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 918 | 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 Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 919 | } else { |
| 920 | gitUserEmail = strings.TrimSpace(string(out)) |
| 921 | } |
| 922 | if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil { |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 923 | return fmt.Errorf("git user.name is not set. Please run 'git config --global user.name \"Your Name\"' to set your name") |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 924 | } else { |
| 925 | gitUserName = strings.TrimSpace(string(out)) |
| 926 | } |
| 927 | |
| 928 | start := time.Now() |
| Philip Zeyliger | 2343f8a | 2025-06-17 06:16:19 -0700 | [diff] [blame] | 929 | cmdArgs := []string{ |
| 930 | "build", |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 931 | "-t", imgName, |
| 932 | "-f", dockerfilePath, |
| Philip Zeyliger | 2343f8a | 2025-06-17 06:16:19 -0700 | [diff] [blame] | 933 | "--build-arg", "GIT_USER_EMAIL=" + gitUserEmail, |
| 934 | "--build-arg", "GIT_USER_NAME=" + gitUserName, |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 935 | ".", |
| Philip Zeyliger | 2343f8a | 2025-06-17 06:16:19 -0700 | [diff] [blame] | 936 | } |
| 937 | |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 938 | commonDir, err := gitCommonDir(ctx, gitRoot) |
| 939 | if err != nil { |
| 940 | return fmt.Errorf("failed to get git common dir: %w", err) |
| 941 | } |
| 942 | |
| Philip Zeyliger | 2343f8a | 2025-06-17 06:16:19 -0700 | [diff] [blame] | 943 | cmd := exec.CommandContext(ctx, "docker", cmdArgs...) |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 944 | cmd.Dir = commonDir |
| David Crawshaw | 31f1524 | 2025-05-06 16:03:49 -0700 | [diff] [blame] | 945 | // 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 Crawshaw | b5f6a00 | 2025-05-05 08:27:16 -0700 | [diff] [blame] | 948 | cmd.Stdout = os.Stdout |
| 949 | cmd.Stderr = os.Stderr |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 950 | fmt.Printf("🏗️ building docker image %s from base %s...\n", imgName, baseImage) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 951 | |
| 952 | err = run(ctx, "docker build", cmd) |
| 953 | if err != nil { |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 954 | return fmt.Errorf("docker build failed: %v", err) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 955 | } |
| 956 | fmt.Printf("built docker image %s in %s\n", imgName, time.Since(start).Round(time.Millisecond)) |
| Philip Zeyliger | 983b58a | 2025-07-02 19:42:08 -0700 | [diff] [blame] | 957 | return nil |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 958 | } |
| 959 | |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 960 | // requireGitRepo confirms that path is within a git repository. |
| 961 | func requireGitRepo(ctx context.Context, path string) error { |
| 962 | cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-dir") |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 963 | cmd.Dir = path |
| 964 | out, err := cmd.CombinedOutput() |
| 965 | if err != nil { |
| 966 | if strings.Contains(string(out), "not a git repository") { |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 967 | return fmt.Errorf(`sketch needs to run from within a git repo, but %s is not part of a git repo. |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 968 | Consider 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 | |
| 974 | and try running sketch again. |
| 975 | `, path, path) |
| 976 | } |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 977 | 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. |
| 985 | func 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 Ruel | 467c396 | 2025-06-29 13:32:59 -0400 | [diff] [blame] | 990 | return "", fmt.Errorf("git rev-parse --show-toplevel: %s: %w", out, err) |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 991 | } |
| Marc-Antoine Ruel | 467c396 | 2025-06-29 13:32:59 -0400 | [diff] [blame] | 992 | // The returned path is absolute. |
| 993 | return strings.TrimSpace(string(out)), nil |
| Earl Lee | 2e463fb | 2025-04-17 11:22:22 -0700 | [diff] [blame] | 994 | } |
| 995 | |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 996 | // gitCommonDir finds the git common directory for path. |
| 997 | func 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 Snyder | fa424f5 | 2025-07-11 18:43:55 +0000 | [diff] [blame] | 1011 | // goModuleInfo represents a Go module with its file paths and blob SHAs |
| 1012 | type 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. |
| 1022 | func 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 |
| 1057 | func 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 Snyder | 2772f63 | 2025-05-01 21:42:35 +0000 | [diff] [blame] | 1067 | // getEnvForwardingFromGitConfig retrieves environment variables to pass through to Docker |
| 1068 | // from git config using the sketch.envfwd multi-valued key. |
| 1069 | func 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 Zeyliger | 1dc2137 | 2025-05-05 19:54:44 +0000 | [diff] [blame] | 1090 | |
| Josh Bleecher Snyder | 784d5bd | 2025-07-11 00:09:30 +0000 | [diff] [blame] | 1091 | // getOriginalGitOrigin returns the URL of the git remote 'origin' if it exists in the given directory |
| 1092 | func 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 Zeyliger | 1dc2137 | 2025-05-05 19:54:44 +0000 | [diff] [blame] | 1102 | // 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\""] |
| 1110 | func 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 Zeyliger | 4acf006 | 2025-05-22 13:53:46 -0700 | [diff] [blame] | 1167 | |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1168 | // copyEmbeddedLinuxBinaryToContainer copies the embedded linux binary to the container |
| 1169 | func copyEmbeddedLinuxBinaryToContainer(ctx context.Context, containerName string) error { |
| Josh Bleecher Snyder | 5ae245b | 2025-07-08 22:00:24 +0000 | [diff] [blame] | 1170 | 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 Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1177 | if bin == nil { |
| Josh Bleecher Snyder | 5ae245b | 2025-07-08 22:00:24 +0000 | [diff] [blame] | 1178 | return fmt.Errorf("no embedded linux binary for architecture %q", arch) |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1179 | } |
| 1180 | |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 1181 | // Stream a tarball to docker cp. |
| 1182 | pr, pw := io.Pipe() |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1183 | |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 1184 | 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 Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1193 | } |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 1194 | 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 Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1208 | |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 1209 | cmd := exec.CommandContext(ctx, "docker", "cp", "-", containerName+":/") |
| 1210 | cmd.Stdin = pr |
| Josh Bleecher Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1211 | |
| Josh Bleecher Snyder | c9898fd | 2025-07-08 21:09:18 +0000 | [diff] [blame] | 1212 | 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 Snyder | 1c18ec9 | 2025-07-08 10:55:54 -0700 | [diff] [blame] | 1220 | return nil |
| 1221 | } |
| 1222 | |
| David Crawshaw | 1bd636c | 2025-06-13 19:56:27 +0000 | [diff] [blame] | 1223 | const 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. |
| 1241 | func 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 | } |