Files
orca/src/main/ipc/worktree-git-common-watch.test.ts
T
Brennan Benson f8b9c2984d fix(watcher): host macOS git-common narrow watch in the watcher child (#9091)
* fix(watcher): host macOS git-common narrow watch in the watcher child

The darwin-only .git/worktrees narrow stream was the last production
path loading @parcel/watcher's native module inside the Electron main
process. watcher.node 2.5.6 has unsynchronized cross-thread access to
watcher state during unsubscribe/root-deletion (FSEventsBackend.cc:60/
64 vs :336, :250 vs :262, and the deletedRoot double-stopStream) that
corrupts the hosting process heap; `git worktree prune` deleting an
empty worktrees dir makes that overlap routine, and the resulting
PartitionAlloc trap killed the whole app (issue #8732, EXC_BREAKPOINT
on the FSEvents thread in Watcher::isIgnored).

Route the subscription through the existing crash-isolated watcher
child supervisor instead, matching every other native watch (#7547).
Error and root-deletion teardown/re-arm semantics are unchanged; a
watcher-child interruption now reports a structural change so the
worktree list re-syncs across the resubscribe gap.

Fixes #8732

* fix(watcher): ignore callbacks from replaced git-common watches
2026-07-16 18:02:51 -07:00

190 lines
6.9 KiB
TypeScript

import { afterEach, describe, expect, it, vi } from 'vitest'
import { mkdtemp, mkdir, realpath, rm } from 'node:fs/promises'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { subscribeViaWatcherProcess } from './parcel-watcher-process'
import type {
WatcherProcessCallback,
WatcherProcessHooks
} from './parcel-watcher-process-subscription'
import type { WorktreeBaseWatchTarget } from './worktree-base-directory-event-filter'
import type { WorktreeBasePollEvent } from './worktree-base-directory-poller'
import { startGitCommonWatch } from './worktree-git-common-watch'
vi.mock('./parcel-watcher-process', () => ({
subscribeViaWatcherProcess: vi.fn()
}))
const POLL_MS = 25
type ChildSubscription = {
dir: string
callback: WatcherProcessCallback
hooks: WatcherProcessHooks
unsubscribe: ReturnType<typeof vi.fn>
}
describe('worktree git-common narrow watch (darwin)', () => {
const cleanups: (() => Promise<void>)[] = []
const subscribeMock = vi.mocked(subscribeViaWatcherProcess)
let childSubscriptions: ChildSubscription[] = []
afterEach(async () => {
await Promise.all(cleanups.splice(0).map((cleanup) => cleanup()))
childSubscriptions = []
subscribeMock.mockReset()
})
function installSubscribeMock(): void {
subscribeMock.mockImplementation(async (dir, callback, _opts, hooks = {}) => {
const unsubscribe = vi.fn(async () => {})
childSubscriptions.push({ dir, callback, hooks, unsubscribe })
return { unsubscribe }
})
}
async function makeCommonDir(withWorktrees: boolean): Promise<string> {
const root = await mkdtemp(join(tmpdir(), 'orca-git-common-watch-'))
cleanups.push(() => rm(root, { recursive: true, force: true }))
const commonDir = await realpath(root)
if (withWorktrees) {
await mkdir(join(commonDir, 'worktrees'))
}
return commonDir
}
function makeTarget(path: string): WorktreeBaseWatchTarget {
return {
key: `git-common:local:${path}`,
kind: 'git-common',
path,
repos: new Map([['repo-1', { repoId: 'repo-1', repoName: 'project', nestWorkspaces: false }]])
}
}
async function startWatch(commonDir: string, received: WorktreeBasePollEvent[][]): Promise<void> {
const watch = await startGitCommonWatch(
makeTarget(commonDir),
(events) => received.push(events),
POLL_MS,
'darwin'
)
cleanups.push(() => watch.unsubscribe())
}
it('hosts the narrow stream in the watcher child, not in-process', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(true)
const received: WorktreeBasePollEvent[][] = []
await startWatch(commonDir, received)
expect(subscribeMock).toHaveBeenCalledTimes(1)
const [dir, , opts] = subscribeMock.mock.calls[0]
expect(dir).toBe(join(commonDir, 'worktrees'))
expect(opts).toEqual({})
const entryPath = join(commonDir, 'worktrees', 'wt-a')
childSubscriptions[0].callback(null, [{ type: 'create', path: entryPath }])
expect(received.flat()).toContainEqual({ type: 'create', path: entryPath })
})
it('tears down and re-arms when the watched root is deleted', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(true)
const worktreesDir = join(commonDir, 'worktrees')
const received: WorktreeBasePollEvent[][] = []
await startWatch(commonDir, received)
await rm(worktreesDir, { recursive: true, force: true })
childSubscriptions[0].callback(null, [{ type: 'delete', path: worktreesDir }])
await vi.waitFor(() => {
expect(childSubscriptions[0].unsubscribe).toHaveBeenCalledTimes(1)
})
expect(received.flat()).toContainEqual({ type: 'delete', path: worktreesDir })
// The existence poll re-subscribes once a new first worktree recreates it.
await mkdir(worktreesDir)
await vi.waitFor(() => {
expect(subscribeMock).toHaveBeenCalledTimes(2)
})
expect(received.flat()).toContainEqual({ type: 'create', path: worktreesDir })
})
it('tears down and re-arms on watcher errors', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(true)
const worktreesDir = join(commonDir, 'worktrees')
const received: WorktreeBasePollEvent[][] = []
await startWatch(commonDir, received)
childSubscriptions[0].callback(new Error('watcher child reported failure'), [])
await vi.waitFor(() => {
expect(childSubscriptions[0].unsubscribe).toHaveBeenCalledTimes(1)
})
// The error is surfaced as a structural change so worktrees re-sync.
expect(received.flat()).toContainEqual({ type: 'update', path: worktreesDir })
// The dir still exists, so the existence poll re-subscribes.
await vi.waitFor(() => {
expect(subscribeMock).toHaveBeenCalledTimes(2)
})
const receivedAfterRearm = received.length
childSubscriptions[0].callback(new Error('late error from replaced watcher'), [])
childSubscriptions[0].callback(null, [
{ type: 'create', path: join(worktreesDir, 'late-old-event') }
])
childSubscriptions[0].hooks.onInterruption?.()
// A replaced watch cannot tear down its successor or report stale events.
expect(received).toHaveLength(receivedAfterRearm)
expect(childSubscriptions[1].unsubscribe).not.toHaveBeenCalled()
})
it('reports a structural change after a watcher-child interruption', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(true)
const worktreesDir = join(commonDir, 'worktrees')
const received: WorktreeBasePollEvent[][] = []
await startWatch(commonDir, received)
childSubscriptions[0].hooks.onInterruption?.()
expect(received.flat()).toContainEqual({ type: 'update', path: worktreesDir })
// The supervisor resubscribed the same record; no teardown should happen.
expect(childSubscriptions[0].unsubscribe).not.toHaveBeenCalled()
})
it('arms via existence polling when the worktrees dir appears later', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(false)
const received: WorktreeBasePollEvent[][] = []
await startWatch(commonDir, received)
expect(subscribeMock).not.toHaveBeenCalled()
await mkdir(join(commonDir, 'worktrees'))
await vi.waitFor(() => {
expect(subscribeMock).toHaveBeenCalledTimes(1)
})
})
it('stops forwarding events and unsubscribes the child on dispose', async () => {
installSubscribeMock()
const commonDir = await makeCommonDir(true)
const received: WorktreeBasePollEvent[][] = []
const watch = await startGitCommonWatch(
makeTarget(commonDir),
(events) => received.push(events),
POLL_MS,
'darwin'
)
await watch.unsubscribe()
expect(childSubscriptions[0].unsubscribe).toHaveBeenCalledTimes(1)
received.length = 0
childSubscriptions[0].callback(null, [
{ type: 'create', path: join(commonDir, 'worktrees', 'late') }
])
expect(received).toHaveLength(0)
})
})