The koffi redesign moved the dialog from a spawned child process (which inherits a foreground-activation right from the spawning app) onto a worker thread of the same process, so Windows shows the dialog without activating it — it opens behind the app with a taskbar flash. The app has no native HWND to hand the seam, so raise from the driver: on the 'showing' notice (the worker posts it right before Show, before the dialog window exists), attach this thread's input queue to the dialog thread's, call SetForegroundWindow on its top-level window, and detach — retried on the close cadence until the window appears, stopped on settle/abort/success, never blocking the pick. Injectable seam mirrors closeThreadWindows; driver tests pin the raise and its retry; the in-process note records the mechanism (both languages, pairing re-recorded).
191 lines
7.4 KiB
TypeScript
191 lines
7.4 KiB
TypeScript
/**
|
|
* Main-thread driver for the Win32 folder dialog: spawns the dialog worker
|
|
* (which blocks inside the modal `Show`), maps its message protocol onto a
|
|
* promise, and services aborts by posting `WM_CLOSE` to the dialog thread's
|
|
* windows until the worker reports back. The real worker/window surface is
|
|
* injectable so every driver path is testable on any platform.
|
|
*/
|
|
|
|
import {
|
|
closeThreadWindows as hostCloseThreadWindows,
|
|
raiseDialogWindow as hostRaiseDialogWindow,
|
|
spawnDialogWorker,
|
|
} from './win32-dialog-host.ts'
|
|
import type { Win32DialogWorkerData, Win32DialogWorkerMessage } from './win32-dialog-worker.ts'
|
|
|
|
/** The worker surface the driver drives (satisfied by `node:worker_threads`). */
|
|
export interface Win32DialogWorkerLike {
|
|
/**
|
|
* Subscribe to a worker event.
|
|
* @param event - `message`, `error`, or `exit`.
|
|
* @param listener - the event consumer.
|
|
*/
|
|
on(event: 'message', listener: (message: Win32DialogWorkerMessage) => void): unknown
|
|
on(event: 'error', listener: (error: Error) => void): unknown
|
|
on(event: 'exit', listener: (code: number) => void): unknown
|
|
/**
|
|
* Force-stop the worker; the abort path's last resort when `WM_CLOSE`
|
|
* never lands (e.g. the dialog window was never created).
|
|
* @returns settles when the thread is gone.
|
|
*/
|
|
terminate(): Promise<number>
|
|
/**
|
|
* Release the event-loop reference. Called once the pick settles so a
|
|
* worker stuck in the native modal call (terminate cannot interrupt
|
|
* native code) never blocks process exit.
|
|
*/
|
|
unref?(): void
|
|
}
|
|
|
|
/** Injectable process surface for deterministic driver tests. */
|
|
export interface Win32DialogInternals {
|
|
/** Replaces the real worker spawn (`win32-dialog-host.ts`). */
|
|
spawnWorker?: (data: Win32DialogWorkerData) => Win32DialogWorkerLike
|
|
/** Replaces the real `WM_CLOSE` poster (`win32-dialog-host.ts`). */
|
|
closeThreadWindows?: (threadId: number) => Promise<void>
|
|
/** Replaces the real foreground raise (`win32-dialog-host.ts`). */
|
|
raiseDialogWindow?: (threadId: number) => Promise<boolean>
|
|
/** Abort-service cadence override so tests never wait wall-clock time. */
|
|
closeRetryMs?: number
|
|
}
|
|
|
|
/** The dialog title every host shows. */
|
|
export const DIALOG_TITLE = 'Select Workspace Directory'
|
|
|
|
/** `WM_CLOSE` re-post cadence while an abort waits for the worker to unwind. */
|
|
const CLOSE_RETRY_MS = 150
|
|
/** Abort-service attempts before force-terminating the worker. */
|
|
const CLOSE_MAX_ATTEMPTS = 20
|
|
|
|
/** Fail loudly if the closed worker-to-driver union gains an unhandled member. */
|
|
/* v8 ignore start -- closed-union backstop; unreachable without a TypeScript contract violation */
|
|
function assertNever(value: never): never {
|
|
throw new TypeError(`unknown win32 dialog worker message kind: ${String(value)}`)
|
|
}
|
|
/* v8 ignore stop */
|
|
|
|
/**
|
|
* Open the modern Win32 folder picker off the event loop.
|
|
* @param signal - caller lifetime; abort closes the dialog and rejects.
|
|
* @param internals - worker/window seams for deterministic tests.
|
|
* @returns the selected path, or null when the user cancels.
|
|
*/
|
|
export async function pickWin32Directory(
|
|
signal: AbortSignal,
|
|
internals: Win32DialogInternals = {},
|
|
): Promise<string | null> {
|
|
if (signal.aborted) throw new Error('native directory picker aborted')
|
|
const spawnWorker = internals.spawnWorker ?? spawnDialogWorker
|
|
const closeWindows = internals.closeThreadWindows ?? hostCloseThreadWindows
|
|
const raiseWindow = internals.raiseDialogWindow ?? hostRaiseDialogWindow
|
|
const closeRetryMs = internals.closeRetryMs ?? CLOSE_RETRY_MS
|
|
|
|
const worker = spawnWorker({ title: DIALOG_TITLE })
|
|
let dialogThreadId: number | undefined
|
|
let closeTimer: NodeJS.Timeout | undefined
|
|
let raiseTimer: NodeJS.Timeout | undefined
|
|
let settled = false
|
|
|
|
return await new Promise<string | null>((resolve, reject) => {
|
|
const settle = (outcome: () => void): void => {
|
|
if (settled) return
|
|
settled = true
|
|
if (closeTimer !== undefined) clearInterval(closeTimer)
|
|
if (raiseTimer !== undefined) clearInterval(raiseTimer)
|
|
signal.removeEventListener('abort', onAbort)
|
|
worker.unref?.()
|
|
outcome()
|
|
}
|
|
|
|
const postClose = (): void => {
|
|
// Before `showing` there is no window to close; the budget below still
|
|
// runs so a worker that never reports cannot dangle the pick. A
|
|
// rejected close attempt (EnumThreadWindows/PostMessageW refusing) is
|
|
// discarded: the interval retries it and terminate is the backstop.
|
|
if (dialogThreadId !== undefined) void closeWindows(dialogThreadId).catch(() => undefined)
|
|
}
|
|
|
|
// The `showing` notice precedes the blocking `Show`, so the dialog
|
|
// window does not exist yet; re-enumerate on the close cadence until it
|
|
// does and raise it — a window on a worker input queue is otherwise
|
|
// shown without activation. Stops on settle, abort, or a successful
|
|
// raise; a failing raise (e.g. koffi absent) never blocks the pick.
|
|
const startRaise = (): void => {
|
|
const attempt = (): void => {
|
|
if (settled || signal.aborted || dialogThreadId === undefined) return
|
|
void raiseWindow(dialogThreadId)
|
|
.then((raised) => {
|
|
if (raised || settled || signal.aborted) {
|
|
if (raiseTimer !== undefined) clearInterval(raiseTimer)
|
|
}
|
|
})
|
|
.catch(() => undefined)
|
|
}
|
|
attempt()
|
|
raiseTimer = setInterval(attempt, closeRetryMs)
|
|
}
|
|
|
|
// Sole caller: the once-registered abort listener, so no re-entry guard.
|
|
const serviceAbort = (): void => {
|
|
let attempts = 0
|
|
// The `showing` notice precedes the blocking `Show`, so the very first
|
|
// WM_CLOSE can race the window's creation; re-post until the worker
|
|
// reports back, then force-terminate as a last resort. The budget is
|
|
// unconditional — an abort before `showing` (worker hung in koffi or
|
|
// COM init) still ends in terminate instead of a dangling promise.
|
|
closeTimer = setInterval(() => {
|
|
attempts += 1
|
|
if (attempts > CLOSE_MAX_ATTEMPTS) {
|
|
settle(() => {
|
|
void worker.terminate()
|
|
reject(new Error('native directory picker aborted (dialog unresponsive; worker terminated)'))
|
|
})
|
|
return
|
|
}
|
|
postClose()
|
|
}, closeRetryMs)
|
|
postClose()
|
|
}
|
|
|
|
const onAbort = (): void => {
|
|
serviceAbort()
|
|
}
|
|
signal.addEventListener('abort', onAbort, { once: true })
|
|
|
|
worker.on('message', (message: Win32DialogWorkerMessage) => {
|
|
switch (message.kind) {
|
|
case 'showing':
|
|
dialogThreadId = message.threadId
|
|
// An abort that raced ahead of this notice now has a window to hit.
|
|
if (signal.aborted) postClose()
|
|
else startRaise()
|
|
return
|
|
case 'done':
|
|
settle(() => {
|
|
if (signal.aborted) reject(new Error('native directory picker aborted'))
|
|
else resolve(message.path)
|
|
})
|
|
return
|
|
case 'error':
|
|
settle(() => {
|
|
reject(new Error(`win32 folder dialog failed: ${message.message}`))
|
|
})
|
|
return
|
|
/* v8 ignore next 2 -- closed worker-owned union; a fourth kind becomes a compile error */
|
|
default:
|
|
assertNever(message)
|
|
}
|
|
})
|
|
worker.on('error', (error: Error) => {
|
|
settle(() => {
|
|
reject(error)
|
|
})
|
|
})
|
|
worker.on('exit', () => {
|
|
settle(() => {
|
|
reject(new Error('win32 folder dialog worker exited before reporting a result'))
|
|
})
|
|
})
|
|
})
|
|
}
|