|
| 1 | +// |
| 2 | +// WelcomeWindowSuppressionTests.swift |
| 3 | +// TableProTests |
| 4 | +// |
| 5 | +// Regression tests for the welcome window suppression logic in AppDelegate+WindowConfig. |
| 6 | +// Covers the fix where double-clicking .duckdb files from Finder caused the app to freeze |
| 7 | +// because suppression gave up too early and welcome was closed instead of hidden. |
| 8 | +// |
| 9 | + |
| 10 | +import AppKit |
| 11 | +import Foundation |
| 12 | +import Testing |
| 13 | +@testable import TablePro |
| 14 | + |
| 15 | +@Suite("Welcome Window Suppression") |
| 16 | +@MainActor |
| 17 | +struct WelcomeWindowSuppressionTests { |
| 18 | + /// Create a fresh AppDelegate for each test — avoids relying on NSApp.delegate |
| 19 | + /// which may not be our AppDelegate in parallel test runner processes. |
| 20 | + private func makeAppDelegate() -> AppDelegate { |
| 21 | + AppDelegate() |
| 22 | + } |
| 23 | + |
| 24 | + private func makeWindow(identifier: String) -> NSWindow { |
| 25 | + let window = NSWindow() |
| 26 | + window.identifier = NSUserInterfaceItemIdentifier(identifier) |
| 27 | + return window |
| 28 | + } |
| 29 | + |
| 30 | + // MARK: - Window Identification |
| 31 | + |
| 32 | + @Test("isMainWindow — exact identifier 'main'") |
| 33 | + func isMainWindowExact() { |
| 34 | + let delegate = makeAppDelegate() |
| 35 | + let window = makeWindow(identifier: "main") |
| 36 | + #expect(delegate.isMainWindow(window)) |
| 37 | + } |
| 38 | + |
| 39 | + @Test("isMainWindow — prefixed identifier 'main-123'") |
| 40 | + func isMainWindowPrefixed() { |
| 41 | + let delegate = makeAppDelegate() |
| 42 | + let window = makeWindow(identifier: "main-123") |
| 43 | + #expect(delegate.isMainWindow(window)) |
| 44 | + } |
| 45 | + |
| 46 | + @Test("isMainWindow — returns false for nil identifier") |
| 47 | + func isMainWindowNilIdentifier() { |
| 48 | + let delegate = makeAppDelegate() |
| 49 | + let window = NSWindow() |
| 50 | + window.identifier = nil |
| 51 | + #expect(!delegate.isMainWindow(window)) |
| 52 | + } |
| 53 | + |
| 54 | + @Test("isMainWindow — returns false for 'welcome'") |
| 55 | + func isMainWindowUnrelated() { |
| 56 | + let delegate = makeAppDelegate() |
| 57 | + let window = makeWindow(identifier: "welcome") |
| 58 | + #expect(!delegate.isMainWindow(window)) |
| 59 | + } |
| 60 | + |
| 61 | + @Test("isMainWindow — returns false for 'mainExtra' (no dash separator)") |
| 62 | + func isMainWindowNoDash() { |
| 63 | + let delegate = makeAppDelegate() |
| 64 | + let window = makeWindow(identifier: "mainExtra") |
| 65 | + #expect(!delegate.isMainWindow(window)) |
| 66 | + } |
| 67 | + |
| 68 | + @Test("isWelcomeWindow — exact identifier 'welcome'") |
| 69 | + func isWelcomeWindowExact() { |
| 70 | + let delegate = makeAppDelegate() |
| 71 | + let window = makeWindow(identifier: "welcome") |
| 72 | + #expect(delegate.isWelcomeWindow(window)) |
| 73 | + } |
| 74 | + |
| 75 | + @Test("isWelcomeWindow — prefixed identifier 'welcome-abc'") |
| 76 | + func isWelcomeWindowPrefixed() { |
| 77 | + let delegate = makeAppDelegate() |
| 78 | + let window = makeWindow(identifier: "welcome-abc") |
| 79 | + #expect(delegate.isWelcomeWindow(window)) |
| 80 | + } |
| 81 | + |
| 82 | + @Test("isWelcomeWindow — returns false for nil identifier") |
| 83 | + func isWelcomeWindowNilIdentifier() { |
| 84 | + let delegate = makeAppDelegate() |
| 85 | + let window = NSWindow() |
| 86 | + window.identifier = nil |
| 87 | + #expect(!delegate.isWelcomeWindow(window)) |
| 88 | + } |
| 89 | + |
| 90 | + @Test("isWelcomeWindow — returns false for 'main'") |
| 91 | + func isWelcomeWindowNotMain() { |
| 92 | + let delegate = makeAppDelegate() |
| 93 | + let window = makeWindow(identifier: "main") |
| 94 | + #expect(!delegate.isWelcomeWindow(window)) |
| 95 | + } |
| 96 | + |
| 97 | + @Test("isWelcomeWindow — returns false for 'welcomeExtra' (no dash separator)") |
| 98 | + func isWelcomeWindowNoDash() { |
| 99 | + let delegate = makeAppDelegate() |
| 100 | + let window = makeWindow(identifier: "welcomeExtra") |
| 101 | + #expect(!delegate.isWelcomeWindow(window)) |
| 102 | + } |
| 103 | + |
| 104 | + // MARK: - suppressWelcomeWindow State |
| 105 | + |
| 106 | + @Test("suppressWelcomeWindow — sets isHandlingFileOpen to true") |
| 107 | + func suppressSetsFlag() { |
| 108 | + let delegate = makeAppDelegate() |
| 109 | + delegate.suppressWelcomeWindow() |
| 110 | + #expect(delegate.isHandlingFileOpen == true) |
| 111 | + } |
| 112 | + |
| 113 | + @Test("suppressWelcomeWindow — increments fileOpenSuppressionCount") |
| 114 | + func suppressIncrementsCount() { |
| 115 | + let delegate = makeAppDelegate() |
| 116 | + delegate.suppressWelcomeWindow() |
| 117 | + #expect(delegate.fileOpenSuppressionCount == 1) |
| 118 | + |
| 119 | + delegate.suppressWelcomeWindow() |
| 120 | + #expect(delegate.fileOpenSuppressionCount == 2) |
| 121 | + } |
| 122 | + |
| 123 | + @Test("suppressWelcomeWindow — hides existing welcome windows via orderOut") |
| 124 | + func suppressHidesWelcomeWindows() { |
| 125 | + let delegate = makeAppDelegate() |
| 126 | + |
| 127 | + let welcome = makeWindow(identifier: "welcome") |
| 128 | + welcome.orderFront(nil) |
| 129 | + defer { welcome.close() } |
| 130 | + |
| 131 | + #expect(welcome.isVisible) |
| 132 | + |
| 133 | + delegate.suppressWelcomeWindow() |
| 134 | + |
| 135 | + #expect(!welcome.isVisible) |
| 136 | + } |
| 137 | + |
| 138 | + // MARK: - windowDidBecomeKey Suppression Behavior |
| 139 | + |
| 140 | + @Test("windowDidBecomeKey — welcome hides (orderOut) when file open and no main window") |
| 141 | + func windowDidBecomeKeyHidesWelcomeWhenNoMain() { |
| 142 | + let delegate = makeAppDelegate() |
| 143 | + delegate.isHandlingFileOpen = true |
| 144 | + |
| 145 | + let welcome = makeWindow(identifier: "welcome") |
| 146 | + welcome.orderFront(nil) |
| 147 | + defer { welcome.close() } |
| 148 | + |
| 149 | + #expect(welcome.isVisible) |
| 150 | + |
| 151 | + let notification = Notification(name: NSWindow.didBecomeKeyNotification, object: welcome) |
| 152 | + delegate.windowDidBecomeKey(notification) |
| 153 | + |
| 154 | + // Key regression fix: welcome should be hidden (not closed) so it can reappear |
| 155 | + // when the main window is ready — prevents "no visible windows" freeze |
| 156 | + #expect(!welcome.isVisible) |
| 157 | + } |
| 158 | + |
| 159 | + @Test("windowDidBecomeKey — welcome closes when file open and main window exists") |
| 160 | + func windowDidBecomeKeyClosesWelcomeWhenMainExists() { |
| 161 | + let delegate = makeAppDelegate() |
| 162 | + delegate.isHandlingFileOpen = true |
| 163 | + |
| 164 | + let mainWin = makeWindow(identifier: "main") |
| 165 | + mainWin.orderFront(nil) |
| 166 | + defer { mainWin.close() } |
| 167 | + |
| 168 | + let welcome = makeWindow(identifier: "welcome") |
| 169 | + welcome.orderFront(nil) |
| 170 | + defer { welcome.close() } |
| 171 | + |
| 172 | + let notification = Notification(name: NSWindow.didBecomeKeyNotification, object: welcome) |
| 173 | + delegate.windowDidBecomeKey(notification) |
| 174 | + |
| 175 | + #expect(!welcome.isVisible) |
| 176 | + } |
| 177 | + |
| 178 | + @Test("windowDidBecomeKey — welcome not suppressed when isHandlingFileOpen is false") |
| 179 | + func windowDidBecomeKeyNoSuppressionWhenNotHandlingFile() { |
| 180 | + let delegate = makeAppDelegate() |
| 181 | + delegate.isHandlingFileOpen = false |
| 182 | + |
| 183 | + let welcome = makeWindow(identifier: "welcome") |
| 184 | + welcome.orderFront(nil) |
| 185 | + defer { welcome.close() } |
| 186 | + |
| 187 | + let notification = Notification(name: NSWindow.didBecomeKeyNotification, object: welcome) |
| 188 | + delegate.windowDidBecomeKey(notification) |
| 189 | + |
| 190 | + #expect(welcome.isVisible) |
| 191 | + } |
| 192 | + |
| 193 | + @Test("windowDidBecomeKey — non-welcome window is not affected by suppression") |
| 194 | + func windowDidBecomeKeyIgnoresNonWelcome() { |
| 195 | + let delegate = makeAppDelegate() |
| 196 | + delegate.isHandlingFileOpen = true |
| 197 | + |
| 198 | + let other = makeWindow(identifier: "settings") |
| 199 | + other.orderFront(nil) |
| 200 | + defer { other.close() } |
| 201 | + |
| 202 | + let notification = Notification(name: NSWindow.didBecomeKeyNotification, object: other) |
| 203 | + delegate.windowDidBecomeKey(notification) |
| 204 | + |
| 205 | + #expect(other.isVisible) |
| 206 | + } |
| 207 | + |
| 208 | + // MARK: - Suppression Count State |
| 209 | + |
| 210 | + @Test("Multiple suppress calls — count increments independently") |
| 211 | + func multipleSuppressionCountsStack() { |
| 212 | + let delegate = makeAppDelegate() |
| 213 | + delegate.suppressWelcomeWindow() |
| 214 | + delegate.suppressWelcomeWindow() |
| 215 | + delegate.suppressWelcomeWindow() |
| 216 | + |
| 217 | + #expect(delegate.fileOpenSuppressionCount == 3) |
| 218 | + #expect(delegate.isHandlingFileOpen == true) |
| 219 | + } |
| 220 | + |
| 221 | + @Test("fileOpenSuppressionCount decrement to zero resets isHandlingFileOpen") |
| 222 | + func countZeroResetsFlag() { |
| 223 | + let delegate = makeAppDelegate() |
| 224 | + delegate.isHandlingFileOpen = true |
| 225 | + delegate.fileOpenSuppressionCount = 1 |
| 226 | + |
| 227 | + // Simulate what scheduleWelcomeWindowSuppression does at the end |
| 228 | + delegate.fileOpenSuppressionCount = max(0, delegate.fileOpenSuppressionCount - 1) |
| 229 | + if delegate.fileOpenSuppressionCount == 0 { |
| 230 | + delegate.isHandlingFileOpen = false |
| 231 | + } |
| 232 | + |
| 233 | + #expect(delegate.fileOpenSuppressionCount == 0) |
| 234 | + #expect(delegate.isHandlingFileOpen == false) |
| 235 | + } |
| 236 | + |
| 237 | + @Test("fileOpenSuppressionCount decrement keeps flag true while count > 0") |
| 238 | + func countPositiveKeepsFlag() { |
| 239 | + let delegate = makeAppDelegate() |
| 240 | + delegate.isHandlingFileOpen = true |
| 241 | + delegate.fileOpenSuppressionCount = 2 |
| 242 | + |
| 243 | + // Simulate one decrement |
| 244 | + delegate.fileOpenSuppressionCount = max(0, delegate.fileOpenSuppressionCount - 1) |
| 245 | + if delegate.fileOpenSuppressionCount == 0 { |
| 246 | + delegate.isHandlingFileOpen = false |
| 247 | + } |
| 248 | + |
| 249 | + #expect(delegate.fileOpenSuppressionCount == 1) |
| 250 | + #expect(delegate.isHandlingFileOpen == true) |
| 251 | + } |
| 252 | +} |
0 commit comments