fix(ssh): improve embedded tmux readiness

Author: acmore

cmd/okdev-sshd/main.go

@@ -152,7 +152,7 @@ func buildInteractiveLoginScript(sessionEnv map[string]string, shell, workspace,
 func embeddedTmuxBootstrapScript() string {
 	return strings.Join([]string{
 		`if [ "${TERM:-}" = "xterm-ghostty" ]; then export TERM=xterm-256color; fi`,
-		`if command -v tmux >/dev/null 2>&1; then exec tmux new-session -A -s okdev; fi`,
+		`if command -v tmux >/dev/null 2>&1; then if [ -f /var/okdev/embedded.tmux.conf ]; then exec tmux -f /var/okdev/embedded.tmux.conf new-session -A -s okdev; fi; exec tmux new-session -A -s okdev; fi`,
 		`echo 'warning: tmux not available in dev container; continuing without tmux' >&2`,
 	}, "; ")
 }

cmd/okdev-sshd/main_test.go

@@ -10,6 +10,7 @@ func TestBuildInteractiveLoginScriptIncludesEmbeddedTmuxBootstrap(t *testing.T)
 
 	for _, want := range []string{
 		"/workspace/.okdev/post-attach.sh",
+		"/var/okdev/embedded.tmux.conf",
 		"exec tmux new-session -A -s okdev",
 	} {
 		if !strings.Contains(script, want) {

infra/sidecar/Dockerfile

@@ -35,6 +35,7 @@ COPY --from=builder /okdev-sshd /usr/local/bin/okdev-sshd
 
 COPY infra/sidecar/sshd_config /etc/ssh/sshd_config
 COPY infra/sidecar/tmux.conf /root/.tmux.conf
+COPY infra/sidecar/embedded-tmux.conf /etc/okdev-embedded.tmux.conf
 COPY infra/sidecar/entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 

infra/sidecar/embedded-tmux.conf

@@ -0,0 +1,22 @@
+# okdev default tmux profile for embedded SSH sessions in the dev container.
+
+set -g history-limit 200000
+set -g mouse on
+set -g renumber-windows on
+set -g base-index 1
+setw -g pane-base-index 1
+set -g detach-on-destroy off
+
+set -g escape-time 0
+set -g focus-events on
+set -g set-clipboard on
+set -g default-terminal "tmux-256color"
+
+setw -g mode-keys vi
+
+set -g status-position bottom
+set -g status-interval 5
+set -g status-left-length 40
+set -g status-right-length 120
+set -g status-left "#[fg=cyan,bold]#S  "
+set -g status-right "#[fg=colour245]#{pane_current_path} #[fg=cyan]%Y-%m-%d %H:%M"

infra/sidecar/entrypoint.sh

@@ -186,6 +186,8 @@ if [ "$OKDEV_SSH_MODE" = "embedded" ]; then
   mkdir -p /var/okdev
   cp /usr/local/bin/okdev-sshd /var/okdev/okdev-sshd
   chmod +x /var/okdev/okdev-sshd
+  cp /etc/okdev-embedded.tmux.conf /var/okdev/embedded.tmux.conf
+  chmod 644 /var/okdev/embedded.tmux.conf
 fi
 
 # Start syncthing in background (run as root for workspace access)

internal/cli/ssh.go

@@ -370,6 +370,8 @@ fi
 if ps | grep '[o]kdev-sshd' >/dev/null 2>&1; then
   exit 0
 fi
+export OKDEV_WORKSPACE="${OKDEV_WORKSPACE:-/workspace}"
+export OKDEV_TMUX="${OKDEV_TMUX:-0}"
 nohup /var/okdev/okdev-sshd --port 2222 --authorized-keys "$HOME/.ssh/authorized_keys" >/var/okdev/okdev-sshd.log 2>&1 </dev/null &
 `
 

internal/cli/ssh_embedded_test.go

@@ -19,6 +19,8 @@ func TestEnsureEmbeddedSSHDRunning(t *testing.T) {
 	for _, want := range []string{
 		"/var/okdev/okdev-sshd",
 		"$HOME/.ssh/authorized_keys",
+		`export OKDEV_TMUX="${OKDEV_TMUX:-0}"`,
+		`export OKDEV_WORKSPACE="${OKDEV_WORKSPACE:-/workspace}"`,
 		"nohup /var/okdev/okdev-sshd",
 	} {
 		if !strings.Contains(fake.lastScript, want) {

internal/cli/up.go

@@ -175,41 +175,28 @@ func newUpCmd(opts *Options) *cobra.Command {
 			}
 			ui.stepDone("pod readiness", "ready")
 
-			if err := session.SaveActiveSession(sn); err != nil {
-				return err
-			}
-			ui.stepDone("active session", sn)
-			if err := session.ClearShutdownRequest(sn); err != nil {
-				ui.warnf("failed to clear prior shutdown request: %v", err)
-			}
-
 			ui.section("Setup")
 			sshSummary := "disabled"
 			effectiveSSHPort := sshRemotePortForMode(cfg, sshMode)
 			if effectiveSSHPort > 0 {
 				keyPath, keyErr := defaultSSHKeyPath(cfg)
 				if keyErr != nil {
-					ui.warnf("failed to resolve SSH key path: %v", keyErr)
-					sshSummary = "degraded (key path error)"
+					return fmt.Errorf("resolve SSH key path: %w", keyErr)
 				} else {
 					if err := ensureSSHKeyOnPod(opts, cfg, ns, pod, keyPath, sshMode); err != nil {
-						ui.warnf("failed to setup SSH key in pod: %v", err)
-						sshSummary = "degraded (key setup failed)"
+						return fmt.Errorf("setup SSH key in pod: %w", err)
 					}
-					if err := waitForSSHDReady(opts, cfg, ns, pod, sshMode, 20*time.Second); err != nil {
-						ui.warnf("sshd not ready yet: %v", err)
-						sshSummary = "degraded (sshd not ready)"
+					if err := waitForSSHDReady(opts, cfg, ns, pod, sshMode, waitTimeout); err != nil {
+						return fmt.Errorf("wait for SSH service: %w", err)
 					}
 					alias := sshHostAlias(sn)
 					if _, cfgErr := ensureSSHConfigEntry(alias, sn, ns, cfg.Spec.SSH.User, effectiveSSHPort, keyPath, cfgPath, cfg.Spec.Ports); cfgErr != nil {
-						ui.warnf("failed to update ~/.ssh/config: %v", cfgErr)
-						sshSummary = "degraded (ssh config update failed)"
+						return fmt.Errorf("update ~/.ssh/config: %w", cfgErr)
 					} else {
 						// Force-refresh managed master so forward rules are always current after `okdev up`.
 						_ = stopManagedSSHForward(alias)
 						if err := startManagedSSHForwardWithForwards(alias, cfg.Spec.Ports, cfg.Spec.SSH); err != nil {
-							ui.warnf("failed to start managed SSH/port-forwards: %v", err)
-							sshSummary = "degraded (managed forward failed)"
+							return fmt.Errorf("start managed SSH/port-forwards: %w", err)
 						} else {
 							sshSummary = "ssh " + alias
 							ui.stepDone("ssh", sshSummary)
@@ -223,8 +210,7 @@ func newUpCmd(opts *Options) *cobra.Command {
 			if cfg.Spec.Sync.Engine == "" || cfg.Spec.Sync.Engine == "syncthing" {
 				logPath, started, err := startDetachedSyncthingSync(opts, upDefaultSyncMode, sn, ns, cfgPath)
 				if err != nil {
-					ui.warnf("failed to start syncthing background sync: %v", err)
-					syncSummary = "degraded (start failed)"
+					return fmt.Errorf("start syncthing background sync: %w", err)
 				} else {
 					syncModeSymbol = modeSymbol(upDefaultSyncMode)
 					syncPathSummary := syncPairsSummary(syncPairs, syncModeSymbol)
@@ -289,6 +275,13 @@ func newUpCmd(opts *Options) *cobra.Command {
 					}
 				}
 			}
+			if err := session.SaveActiveSession(sn); err != nil {
+				return err
+			}
+			ui.stepDone("active session", sn)
+			if err := session.ClearShutdownRequest(sn); err != nil {
+				ui.warnf("failed to clear prior shutdown request: %v", err)
+			}
 
 			ui.printWarnings()
 			ui.printReadyCard(sn, ns, pod, sshSummary, syncSummary, cfg.Spec.Ports, syncPairs, syncModeSymbol)

internal/kube/podspec.go

@@ -63,6 +63,12 @@ func PreparePodSpec(podSpec corev1.PodSpec, volumes []corev1.Volume, workspaceMo
 				Name:  "OKDEV_CONTAINER_ROLE",
 				Value: "dev",
 			})
+			if tmux {
+				spec.Containers[i].Env = ensureEnvVar(spec.Containers[i].Env, corev1.EnvVar{
+					Name:  "OKDEV_TMUX",
+					Value: "1",
+				})
+			}
 		}
 	}
 

internal/kube/podspec_test.go

@@ -174,3 +174,20 @@ func TestPreparePodSpecEmbeddedSSHMode(t *testing.T) {
 		}
 	})
 }
+
+func TestPreparePodSpecSetsDevTmuxEnvWhenEnabled(t *testing.T) {
+	spec, err := PreparePodSpec(corev1.PodSpec{}, nil, "/workspace", "ghcr.io/acmore/okdev-sidecar:edge", true, true, "")
+	if err != nil {
+		t.Fatal(err)
+	}
+	dev := findContainer(spec.Containers, "dev")
+	if dev == nil {
+		t.Fatal("dev container not found")
+	}
+	for _, env := range dev.Env {
+		if env.Name == "OKDEV_TMUX" && env.Value == "1" {
+			return
+		}
+	}
+	t.Fatal("expected OKDEV_TMUX=1 on dev container when tmux is enabled")
+}