| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- /**
- * Native picker tier selection and the execFile adapter: the Win32 dialog
- * primary (failures surface as-is, no fallback tier), the abort rule, and
- * the POSIX command tiers (osascript, Zenity → KDialog).
- */
- type ExecFileCallback = (
- error: (Error & { code?: string | number }) | null,
- stdout: string,
- stderr: string,
- ) => void
- type ExecFileMock = (
- command: string,
- args: readonly string[],
- options: { encoding: string; signal: AbortSignal; windowsHide: boolean },
- callback: ExecFileCallback,
- ) => void
- const { execFileMock } = vi.hoisted(() => ({ execFileMock: vi.fn<ExecFileMock>() }))
- vi.mock('node:child_process', () => ({ execFile: execFileMock }))
- import { describe, expect, it, vi } from 'vitest'
- import { pickNativeDirectory, type DirectoryPickerRunner } from '../src/native-picker.ts'
- function failure(code: string | number, stderr = ''): Error {
- return Object.assign(new Error(`command failed: ${String(code)}`), { code, stderr })
- }
- const signal = () => new AbortController().signal
- /** A Win32 dialog that always fails — the no-fallback case. */
- const noDialog = async (): Promise<string | null> => { throw new Error('dialog unavailable') }
- describe('native directory picker', () => {
- it('uses the macOS folder chooser and maps user cancellation to null', async () => {
- const run = vi.fn<DirectoryPickerRunner>(async () => ({ stdout: '/Users/test/project/\n', stderr: '' }))
- await expect(pickNativeDirectory(signal(), { platform: 'darwin', run })).resolves.toBe('/Users/test/project/')
- expect(run).toHaveBeenCalledWith('osascript', expect.arrayContaining(['POSIX path of selectedFolder']), expect.any(AbortSignal))
- run.mockRejectedValueOnce(failure(1, 'execution error: User canceled. (-128)'))
- await expect(pickNativeDirectory(signal(), { platform: 'darwin', run })).resolves.toBeNull()
- run.mockRejectedValueOnce(failure(2, 'permission denied'))
- await expect(pickNativeDirectory(signal(), { platform: 'darwin', run })).rejects.toThrow('command failed')
- })
- it.each([
- ['a primitive error', 'failed'],
- ['an invalid code type', { code: true }],
- ['a missing stderr property', { code: 1 }],
- ['a non-string stderr property', { code: 1, stderr: 42 }],
- ])('does not mistake %s for macOS cancellation', async (_label, reason) => {
- const run = vi.fn<DirectoryPickerRunner>(async () => { throw reason })
- await expect(pickNativeDirectory(signal(), { platform: 'darwin', run })).rejects.toBe(reason)
- })
- it('uses the Win32 dialog and never spawns a command when it answers', async () => {
- const run = vi.fn<DirectoryPickerRunner>()
- const pickWin32Dialog = vi.fn(async (): Promise<string | null> => 'C:\\work\\selected')
- await expect(pickNativeDirectory(signal(), { platform: 'win32', run, pickWin32Dialog })).resolves.toBe('C:\\work\\selected')
- pickWin32Dialog.mockResolvedValueOnce(null)
- await expect(pickNativeDirectory(signal(), { platform: 'win32', run, pickWin32Dialog })).resolves.toBeNull()
- expect(run).not.toHaveBeenCalled()
- })
- it('surfaces the Win32 dialog failure with no fallback', async () => {
- const run = vi.fn<DirectoryPickerRunner>()
- await expect(pickNativeDirectory(signal(), { platform: 'win32', run, pickWin32Dialog: noDialog }))
- .rejects.toThrow('dialog unavailable')
- expect(run).not.toHaveBeenCalled()
- })
- it('wires the real Win32 dialog as the default tier', async () => {
- // A pre-aborted signal makes the DEFAULT dialog deterministic on every
- // host: pickWin32Directory throws before spawning any worker or window.
- const abort = new AbortController()
- abort.abort()
- const run = vi.fn<DirectoryPickerRunner>()
- await expect(pickNativeDirectory(abort.signal, { platform: 'win32', run }))
- .rejects.toThrow('native directory picker aborted')
- expect(run).not.toHaveBeenCalled()
- })
- it('does not fall back when the caller aborted the dialog', async () => {
- const abort = new AbortController()
- abort.abort(new Error('closed'))
- const run = vi.fn<DirectoryPickerRunner>()
- await expect(pickNativeDirectory(abort.signal, { platform: 'win32', run, pickWin32Dialog: noDialog })).rejects.toThrow('dialog unavailable')
- expect(run).not.toHaveBeenCalled()
- })
- it('runs the default command adapter without a shell and preserves command failures', async () => {
- execFileMock.mockImplementationOnce((_command, _args, _options, callback) => {
- callback(null, '/home/test/project\n', '')
- })
- await expect(pickNativeDirectory(signal(), { platform: 'linux' })).resolves.toBe('/home/test/project')
- const [command, args, options] = execFileMock.mock.calls[0]!
- expect(command).toBe('zenity')
- expect(args).toEqual(expect.arrayContaining(['--file-selection', '--directory']))
- expect(options.encoding).toBe('utf8')
- expect(options.windowsHide).toBe(true)
- expect(options.signal).toBeInstanceOf(AbortSignal)
- // A non-cancellation command failure surfaces as-is with its cause and
- // captured stdio attached; no tier masks or rewraps it.
- execFileMock.mockImplementationOnce((_command, _args, _options, callback) => {
- callback(Object.assign(new Error('zenity failed'), { code: 7 }), 'partial output', 'failure details')
- })
- const surfaced = await pickNativeDirectory(signal(), { platform: 'linux' })
- .then(() => { throw new Error('expected rejection') }, (error: unknown) => error as Error)
- expect(surfaced).toMatchObject({
- message: 'zenity failed', code: 7,
- stdout: 'partial output', stderr: 'failure details',
- })
- expect((surfaced as { cause?: unknown }).cause).toBeInstanceOf(Error)
- })
- it('uses the current process platform when no platform override is supplied', async () => {
- // Deterministic on every host: the win32 tier answers from the dialog,
- // the POSIX tiers from the command runner.
- const run = vi.fn<DirectoryPickerRunner>(async () => ({ stdout: '/default/platform\n', stderr: '' }))
- const pickWin32Dialog = async (): Promise<string | null> => 'C:\\default\\platform'
- const expected = process.platform === 'win32' ? 'C:\\default\\platform' : '/default/platform'
- await expect(pickNativeDirectory(signal(), { run, pickWin32Dialog })).resolves.toBe(expected)
- })
- it('maps empty command output to cancellation', async () => {
- const run = vi.fn<DirectoryPickerRunner>(async () => ({ stdout: '', stderr: '' }))
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run })).resolves.toBeNull()
- })
- it('uses Zenity on Linux and falls back to KDialog only when Zenity is missing', async () => {
- const run = vi.fn<DirectoryPickerRunner>()
- .mockRejectedValueOnce(failure('ENOENT'))
- .mockResolvedValueOnce({ stdout: '/home/test/project\n', stderr: '' })
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run })).resolves.toBe('/home/test/project')
- expect(run.mock.calls.map(call => call[0])).toEqual(['zenity', 'kdialog'])
- const zenity = vi.fn<DirectoryPickerRunner>(async () => ({ stdout: '/home/test/direct\n', stderr: '' }))
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: zenity }))
- .resolves.toBe('/home/test/direct')
- expect(zenity).toHaveBeenCalledOnce()
- })
- it('maps Linux cancellation to null and reports a missing desktop picker', async () => {
- const cancelled = vi.fn<DirectoryPickerRunner>(async () => { throw failure(1) })
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: cancelled })).resolves.toBeNull()
- const missing = vi.fn<DirectoryPickerRunner>(async () => { throw failure('ENOENT') })
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: missing }))
- .rejects.toThrow('install zenity or kdialog')
- const kdialogCancelled = vi.fn<DirectoryPickerRunner>()
- .mockRejectedValueOnce(failure('ENOENT'))
- .mockRejectedValueOnce(failure(1))
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: kdialogCancelled }))
- .resolves.toBeNull()
- const zenityFailed = vi.fn<DirectoryPickerRunner>(async () => { throw failure(2) })
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: zenityFailed }))
- .rejects.toThrow('command failed')
- const kdialogFailed = vi.fn<DirectoryPickerRunner>()
- .mockRejectedValueOnce(failure('ENOENT'))
- .mockRejectedValueOnce(failure(2))
- await expect(pickNativeDirectory(signal(), { platform: 'linux', run: kdialogFailed }))
- .rejects.toThrow('command failed')
- })
- it('does not convert caller aborts into user cancellation', async () => {
- const abort = new AbortController()
- abort.abort(new Error('closed'))
- const run = vi.fn<DirectoryPickerRunner>(async () => { throw failure('ABORT_ERR') })
- await expect(pickNativeDirectory(abort.signal, { platform: 'linux', run })).rejects.toThrow('command failed')
- })
- it('reports unsupported platforms', async () => {
- await expect(pickNativeDirectory(signal(), { platform: 'aix' })).rejects.toThrow('unsupported on aix')
- })
- })
|