Repository navigation
Hold workspace handoff until incoming terminals are presentable (#1291) #10868
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| import AppKit | ||
| import CmuxFoundation | ||
| import CmuxTerminal | ||
|
|
||
| /// Completes a workspace handoff when every incoming visible terminal is | ||
| /// presentable, so hiding the retiring workspace's content can never expose a | ||
| /// blank frame (#1291). | ||
| /// | ||
| /// Presentable means the hosted view is revealed (unhidden, in a window) and | ||
| /// the terminal layer holds pixels (`layer.contents != nil`). A warm surface | ||
| /// keeps its last IOSurface across hides, so it is presentable the moment the | ||
| /// portal reveals it; a surface whose renderer was reclaimed becomes | ||
| /// presentable when the rebuilt renderer publishes its first IOSurface. Both | ||
| /// transitions are observed (portal visibility notification, `isHidden` and | ||
| /// `contents` KVO); the caller's timeout stays the liveness backstop. | ||
| @MainActor | ||
| final class WorkspaceHandoffFrameWatcher { | ||
| struct Target { | ||
| let surface: TerminalSurface | ||
| let hostedView: GhosttySurfaceScrollView | ||
| } | ||
|
|
||
| private var targets: [Target] = [] | ||
| private var observers: [NSObjectProtocol] = [] | ||
| private var kvoObservations: [NSKeyValueObservation] = [] | ||
| private var onReady: (() -> Void)? | ||
| private var workspaceId: UUID? | ||
| private let recheckScheduler = MainActorDeferredActionScheduler() | ||
|
|
||
| /// CALayer contents changes bypass KVO for the core-owned terminal layer, | ||
| /// so cold reveals (reclaimed renderer republishing its IOSurface) are | ||
| /// re-checked on a short bounded cadence. The handoff's timeout ends the | ||
| /// loop; completion or cancel stops it earlier. | ||
| private static let recheckInterval: Duration = .milliseconds(32) | ||
|
|
||
| /// True while incoming terminals are not yet presentable. Focus-driven | ||
| /// handoff completions defer to this so focus arriving ahead of pixels | ||
| /// cannot re-expose the blank transition (#1291). | ||
| var isPending: Bool { onReady != nil } | ||
|
|
||
| /// Starts watching. With no targets this never fires `onReady`; callers | ||
| /// complete such handoffs through the immediate path instead. | ||
| func begin( | ||
| workspaceId: UUID, | ||
| targets: [Target], | ||
| onReady: @escaping () -> Void | ||
| ) { | ||
| cancel() | ||
| guard !targets.isEmpty else { return } | ||
| #if DEBUG | ||
| cmuxDebugLog( | ||
| "ws.handoff.frameWatch.begin ws=\(workspaceId.uuidString.prefix(5)) expected=\(targets.count)" | ||
| ) | ||
| #endif | ||
| self.workspaceId = workspaceId | ||
| self.targets = targets | ||
| self.onReady = onReady | ||
|
|
||
| observers.append(NotificationCenter.default.addObserver( | ||
| forName: .terminalPortalVisibilityDidChange, | ||
| object: nil, | ||
| queue: .main | ||
| ) { [weak self] _ in | ||
| self?.completeIfReady() | ||
| }) | ||
| for target in targets { | ||
| // The portal reveal path can unhide a hosted view without posting | ||
| // a visibility notification; observe the hidden bit directly. | ||
| kvoObservations.append(target.hostedView.observe( | ||
| \.isHidden, options: [.new] | ||
| ) { [weak self] _, _ in | ||
| Task { @MainActor [weak self] in | ||
| self?.completeIfReady() | ||
| } | ||
| }) | ||
| // A reclaimed renderer publishes its first IOSurface by setting | ||
| // the terminal layer's contents; observe that for cold reveals. | ||
| if let layer = target.hostedView.surfaceView.layer { | ||
| kvoObservations.append(layer.observe( | ||
| \.contents, options: [.new] | ||
| ) { [weak self] _, _ in | ||
| Task { @MainActor [weak self] in | ||
| self?.completeIfReady() | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| // The reveal may already be complete (cycle-hot warm pair). | ||
| completeIfReady() | ||
| if isPending { scheduleRecheck() } | ||
| } | ||
|
|
||
| private func scheduleRecheck() { | ||
| recheckScheduler.schedule(after: Self.recheckInterval) { [weak self] in | ||
| guard let self, self.isPending else { return } | ||
| self.completeIfReady() | ||
| if self.isPending { self.scheduleRecheck() } | ||
| } | ||
| } | ||
|
|
||
| func cancel() { | ||
| #if DEBUG | ||
| if onReady != nil { | ||
| for target in targets { | ||
| let view = target.hostedView | ||
| let layer = view.surfaceView.layer | ||
| cmuxDebugLog( | ||
| "ws.handoff.frameWatch.state surface=\(target.surface.id.uuidString.prefix(5)) " + | ||
| "hidden=\(view.isHidden ? 1 : 0) inWindow=\(view.window != nil ? 1 : 0) " + | ||
| "layer=\(layer.map { String(describing: type(of: $0)) } ?? "nil") " + | ||
| "contents=\((layer?.presentation() ?? layer)?.contents != nil ? 1 : 0)" | ||
| ) | ||
| } | ||
| } | ||
| #endif | ||
| recheckScheduler.cancel() | ||
| observers.forEach { NotificationCenter.default.removeObserver($0) } | ||
| observers = [] | ||
| kvoObservations.forEach { $0.invalidate() } | ||
| kvoObservations = [] | ||
| targets = [] | ||
| onReady = nil | ||
| workspaceId = nil | ||
| } | ||
|
Comment on lines
+101
to
+124
There was a problem hiding this comment. 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win Release the observers in
Add a 🧹 Proposed cleanup path func cancel() {Add this member to the class: deinit {
recheckScheduler.cancel()
observers.forEach { NotificationCenter.default.removeObserver($0) }
kvoObservations.forEach { $0.invalidate() }
}🤖 Prompt for AI AgentsSource: Linters/SAST tools |
||
|
|
||
| private func isPresentable(_ target: Target) -> Bool { | ||
| let view = target.hostedView | ||
| guard !view.isHidden, view.window != nil else { return false } | ||
| // The core publishes IOSurface contents off the main thread; the model | ||
| // layer can read nil while the presentation copy already has pixels | ||
| // (same idiom as the debug present-stats reader). | ||
| guard let layer = view.surfaceView.layer else { return false } | ||
| return (layer.presentation() ?? layer).contents != nil | ||
| } | ||
|
|
||
| private func completeIfReady() { | ||
| guard onReady != nil else { return } | ||
| guard targets.allSatisfy(isPresentable) else { return } | ||
| #if DEBUG | ||
| cmuxDebugLog( | ||
| "ws.handoff.frameWatch.presentable ws=\(workspaceId?.uuidString.prefix(5) ?? "nil") targets=\(targets.count)" | ||
| ) | ||
| #endif | ||
| let ready = onReady | ||
| cancel() | ||
| // One main-queue turn so any contents commit queued behind this event | ||
| // lands before the retiring content is hidden. | ||
| DispatchQueue.main.async { ready?() } | ||
|
There was a problem hiding this comment.
During rapid workspace switching, readiness for A→B can reach this line and enqueue its callback, then B→C can begin and cancel/start the watcher before the queued callback executes. Because the closure has already been copied out and carries no workspace or generation check, the stale A→B callback completes the current B→C handoff, cancels its watcher, and hides B before C has pixels. Guard the deferred callback with the watched workspace/request generation or make its cancellation ownership persist through this queue turn. Useful? React with 👍 / 👎. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Update the downstream default contract.
Line [103] changes
rendererRealizationMaxWarmRenderers.defaultValueto4, butPackages/macOS/CmuxSettings/Tests/CmuxSettingsTests/RendererRealizationDefaultsTests.swiftLines [7-13] still expect1and describe the old behavior. That test will fail when this package test runs. Update the assertion and description to4, or keep this default at1if the behavior change is not intended.🤖 Prompt for AI Agents