Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions Sources/AppDelegate+SessionScrollbackCheckpoint.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import AppKit
import CmuxTerminal
import CmuxWorkspaces
import Foundation

extension AppDelegate {
/// Live terminals a scrollback checkpoint may capture: the same panels the
/// session snapshot walks (registered windows, their docks, and windowless
/// routes that still fit the persisted window budget).
func sessionScrollbackCheckpointCandidates() -> [SessionScrollbackCheckpointCoordinator.Candidate] {
var candidates: [SessionScrollbackCheckpointCoordinator.Candidate] = []
var seen = Set<UUID>()
let restorePolicy = Workspace.makeSessionRestorePolicyService()

func append(
panelId: UUID,
terminal: TerminalPanel,
shellActivityState: PanelShellActivityState?
) {
guard seen.insert(panelId).inserted else { return }
// Mirrors the snapshot gates: a running command or a hibernated
// agent does not persist scrollback (see `sessionPanelSnapshot`).
// `snapshotNeedsConfirmClose` is the lock-free variant (#6381).
let closeConfirmationRequired = Workspace.resolveCloseConfirmation(
shellActivityState: shellActivityState,
fallbackNeedsConfirmClose: terminal.surface.snapshotNeedsConfirmClose()
)
let isEligible = restorePolicy
.shouldPersistSessionScrollback(closeConfirmationRequired: closeConfirmationRequired)
&& terminal.agentHibernationState == nil
candidates.append(SessionScrollbackCheckpointCoordinator.Candidate(
panelId: panelId,
surfaceId: terminal.surface.id,
isEligible: isEligible,
capture: { [weak terminal] in
guard let terminal else { return nil }
// Same capture the quit path uses for each terminal.
return TerminalController.shared.readTerminalTextForSnapshot(
terminalPanel: terminal,
includeScrollback: true,
lineLimit: SessionPersistencePolicy.maxScrollbackLinesPerTerminal
)
}
))
}
func appendTerminals(from dock: DockSplitStore) {
for (panelId, panel) in dock.panels {
guard let terminal = panel as? TerminalPanel else { continue }
append(panelId: panelId, terminal: terminal, shellActivityState: terminal.shellActivity.state)
}
}
func appendTerminals(from manager: TabManager) {
for workspace in manager.tabs {
let shellActivityStates = workspace.panelShellActivityStates
for (panelId, panel) in workspace.panels {
guard let terminal = panel as? TerminalPanel else { continue }
append(panelId: panelId, terminal: terminal, shellActivityState: shellActivityStates[panelId])
}
if let dock = workspace._dockSplit {
appendTerminals(from: dock)
}
}
}

for context in mainWindowContexts.values {
appendTerminals(from: context.tabManager)
if let dock = context.existingWindowDock() {
appendTerminals(from: dock)
}
}
for route in mainWindowLifecycleCoordinator.eligibleOrphanedRoutesForPersistence() {
guard let manager = route.tabManager else { continue }
appendTerminals(from: manager)
if case .live(let dock)? = route.windowDock {
appendTerminals(from: dock)
}
}
return candidates
}
}
59 changes: 58 additions & 1 deletion Sources/AppDelegate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1265,6 +1265,12 @@ final class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCent
qos: .utility
)
private var todoStatePersistenceCoordinator: SessionTodoStatePersistenceCoordinator?
/// Crash-safe scrollback checkpoints; see `SessionScrollbackCheckpoint.swift`.
private var sessionScrollbackCheckpointCoordinator: SessionScrollbackCheckpointCoordinator?
private let sessionScrollbackCheckpointQueue = DispatchQueue(
label: "com.cmuxterm.app.sessionScrollbackCheckpoint",
qos: .utility
)
/// Session snapshot persistence (CmuxSession); composition-root owned.
/// `nonisolated` because the autosave write block runs on `sessionPersistenceQueue`.
nonisolated let sessionSnapshotStore: any SessionSnapshotStoring<AppSessionSnapshot> = SessionSnapshotRepository(
Expand Down Expand Up @@ -3624,7 +3630,16 @@ final class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCent
let sanitizedStartupSnapshot = loadStartupSessionSnapshotPruningCrashDiagnostics()
guard SessionRestorePolicy.shouldAttemptRestore(),
!didHandleExplicitOpenIntentAtStartup else { return }
startupSessionSnapshot = sanitizedStartupSnapshot
// After a crash the primary snapshot comes from the 8 s autosave, which
// never carries scrollback; recover it from the latest checkpoints. A
// clean exit already wrote scrollback, so checkpoints are ignored.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
if previousSessionLaunchWasUnclean,
let sanitizedStartupSnapshot,
let checkpointStore = sessionScrollbackCheckpointStore() {
startupSessionSnapshot = checkpointStore.merging(into: sanitizedStartupSnapshot)
} else {
startupSessionSnapshot = sanitizedStartupSnapshot
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
}

private func resumeDeferredInitialMainWindowBootstrapIfNeeded() {
Expand Down Expand Up @@ -4291,9 +4306,51 @@ final class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCent
return
}
self.runSessionAutosaveTick(source: "timer")
self.sessionScrollbackCheckpointCoordinator?.tickIfDue()
}
sessionAutosaveTimer = timer
timer.resume()
startSessionScrollbackCheckpointsIfNeeded(environment: env)
}

private func sessionScrollbackCheckpointStore() -> SessionScrollbackCheckpointStore? {
sessionSnapshotStore.defaultSnapshotFileURL().map {
SessionScrollbackCheckpointStore(primarySnapshotURL: $0)
}
}

private func startSessionScrollbackCheckpointsIfNeeded(environment: [String: String]) {
guard sessionScrollbackCheckpointCoordinator == nil,
SessionScrollbackCheckpointPolicy.isEnabled(environment: environment),
let store = sessionScrollbackCheckpointStore() else { return }
let queue = sessionScrollbackCheckpointQueue
sessionScrollbackCheckpointCoordinator = SessionScrollbackCheckpointCoordinator(
environment: SessionScrollbackCheckpointCoordinator.Environment(
uptime: { ProcessInfo.processInfo.systemUptime },
wallClock: { Date().timeIntervalSince1970 },
canCheckpoint: { [weak self] in
guard let self else { return false }
return !self.isTerminatingApp
&& self.didAttemptStartupSessionRestore
&& !self.isApplyingSessionRestore
},
secondsSinceTyping: { [weak self] in
guard let self, self.lastTypingActivityAt > 0 else { return nil }
return ProcessInfo.processInfo.systemUptime - self.lastTypingActivityAt
},
candidates: { [weak self] in
self?.sessionScrollbackCheckpointCandidates() ?? []
},
scheduleNextCapture: { work in
DispatchQueue.main.async {
MainActor.assumeIsolated { work() }
}
},
persist: { batch in
queue.async { store.apply(batch) }
}
)
)
}

private func stopSessionAutosaveTimer() {
Expand Down
Loading
Loading