From 6573ce616140800a42e128f851dc89ff4f7806e0 Mon Sep 17 00:00:00 2001 From: Brennan Benson <79079362+brennanb2025@users.noreply.github.com> Date: Thu, 12 Nov 2026 06:03:40 -0800 Subject: [PATCH] fix(worktrees): keep strict true-empty listing behind the mockable lister Co-Authored-By: Claude Opus 5.5 (1M context) --- .../strict-true-empty-worktree-listing.ts | 18 ++++++++++++++++++ .../git/worktrees/catalog/worktree-listing.ts | 17 +---------------- .../worktrees/catalog/worktree-scan-cache.ts | 4 ++-- ...orktree-catalog-observation-hygiene.test.ts | 2 ++ .../worktree-catalog-observation-hygiene.ts | 18 +++++------------- .../worktree-catalog-prune-authority.test.ts | 3 +++ ...paired-client-discovery.integration.test.ts | 4 +--- .../runtime-managed-worktree-queries.test.ts | 1 + .../catalog/runtime-witnessed-worktree-scan.ts | 4 +--- ...orktree-scan-admin-fingerprint-gate.test.ts | 4 +--- .../repo-worktree-catalog-observation.ts | 5 ++++- .../repo-worktree-catalog-owner.test.ts | 8 +++++++- .../catalog/repo-worktree-catalog-owner.ts | 7 ++++++- 13 files changed, 52 insertions(+), 43 deletions(-) create mode 100644 src/main/git/worktrees/catalog/strict-true-empty-worktree-listing.ts diff --git a/src/main/git/worktrees/catalog/strict-true-empty-worktree-listing.ts b/src/main/git/worktrees/catalog/strict-true-empty-worktree-listing.ts new file mode 100644 index 00000000000..1f6433f1e02 --- /dev/null +++ b/src/main/git/worktrees/catalog/strict-true-empty-worktree-listing.ts @@ -0,0 +1,18 @@ +import type { GitWorktreeInfo } from '../../../../shared/worktree/types' +import type { GitWorktreeExecOptions } from '../worktree-operation-options' +import { isTrueEmptyWorktreeListing, listWorktreesStrict } from './worktree-listing' + +/** Reject scan failures to prevent pruning valid worktrees and tabs; confirmed missing/non-repos return []. */ +export async function listWorktreesStrictAllowingTrueEmpty( + repoPath: string, + options: GitWorktreeExecOptions = {} +): Promise { + try { + return await listWorktreesStrict(repoPath, options) + } catch (err) { + if (await isTrueEmptyWorktreeListing(repoPath, err)) { + return [] + } + throw err + } +} diff --git a/src/main/git/worktrees/catalog/worktree-listing.ts b/src/main/git/worktrees/catalog/worktree-listing.ts index 44f9dcc97d2..d00872da5ca 100644 --- a/src/main/git/worktrees/catalog/worktree-listing.ts +++ b/src/main/git/worktrees/catalog/worktree-listing.ts @@ -68,7 +68,7 @@ export async function listWorktreesUnshared( } /** Only a missing path or confirmed non-repo permits an authoritative empty listing. */ -async function isTrueEmptyWorktreeListing(repoPath: string, err: unknown): Promise { +export async function isTrueEmptyWorktreeListing(repoPath: string, err: unknown): Promise { if (getErrorCode(err) === 'ENOENT') { try { await stat(repoPath) @@ -96,21 +96,6 @@ export async function listWorktreesStrict( return annotateSparseCheckoutStatus(repoPath, visibleWorktrees, options) } -/** Reject scan failures to prevent pruning valid worktrees and tabs; confirmed missing/non-repos return []. */ -export async function listWorktreesStrictAllowingTrueEmpty( - repoPath: string, - options: GitWorktreeExecOptions = {} -): Promise { - try { - return await listWorktreesStrict(repoPath, options) - } catch (err) { - if (await isTrueEmptyWorktreeListing(repoPath, err)) { - return [] - } - throw err - } -} - export async function annotateSparseCheckoutStatus( repoPath: string, worktrees: GitWorktreeInfo[], diff --git a/src/main/git/worktrees/catalog/worktree-scan-cache.ts b/src/main/git/worktrees/catalog/worktree-scan-cache.ts index 2d351a5d19b..07d08ef3335 100644 --- a/src/main/git/worktrees/catalog/worktree-scan-cache.ts +++ b/src/main/git/worktrees/catalog/worktree-scan-cache.ts @@ -2,9 +2,9 @@ import type { GitWorktreeInfo } from '../../../../shared/worktree/types' import { annotateSparseCheckoutStatus, listWorktreeGraph as listWorktreeGraphUnshared, - listWorktreesStrict as listWorktreesStrictUnshared, - listWorktreesStrictAllowingTrueEmpty as listWorktreesStrictAllowingTrueEmptyUnshared + listWorktreesStrict as listWorktreesStrictUnshared } from './worktree-listing' +import { listWorktreesStrictAllowingTrueEmpty as listWorktreesStrictAllowingTrueEmptyUnshared } from './strict-true-empty-worktree-listing' import type { GitWorktreeExecOptions } from '../worktree-operation-options' import { WORKTREE_LIST_TIMEOUT_MS } from '../worktree-operation-options' import { resolveGitAdmissionTier } from '../../command-runner/admission/git-operation-executor' diff --git a/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.test.ts b/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.test.ts index 02767a97725..2369a2d3302 100644 --- a/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.test.ts +++ b/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.test.ts @@ -15,9 +15,11 @@ vi.mock('../removal/registered-worktree-roots-cache', () => ({ registerWorktreeRootsForRepo: vi.fn() })) +// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the owner and hygiene plan read only these repo fields. const repo = { id: 'repo-1', path: '/repos/app', kind: 'git' } as Repo async function readFailing(times: number, claimsHygiene: boolean) { + // oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the expectation is only carried, never read, when every scan fails. const capture = vi.fn(() => ({}) as never) const store = { captureNativeLocalWorktreeMetadataScanExpectation: capture } for (let read = 0; read < times; read += 1) { diff --git a/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.ts b/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.ts index dc87be127c2..0bcbadd858b 100644 --- a/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.ts +++ b/src/main/ipc/worktrees/listing/worktree-catalog-observation-hygiene.ts @@ -18,14 +18,6 @@ import { registerWorktreeRootsForRepo } from '../removal/registered-worktree-roots-cache' -type HygieneStore = Pick - -export type WorktreeCatalogHygieneWitness = WorktreeCatalogWitness & { - readonly expectation?: NativeLocalWorktreeMetadataScanExpectation - /** Roots revision after this observation registered its roots; later side effects fence on it. */ - rootsRevision: number -} - export type WorktreeCatalogHygieneClaim = Readonly<{ generation: number authorizedRootsRevision: number @@ -35,7 +27,7 @@ export type WorktreeCatalogHygieneClaim = Readonly<{ /** Pre-scan facts for every flight; only readers that prune claim the evidence gate (#17775). */ export function worktreeCatalogHygienePlan( - store: Store | HygieneStore, + store: Store, repo: Repo, gitOptions: { wslDistro?: string }, claimsHygiene: boolean @@ -54,7 +46,7 @@ export function worktreeCatalogHygienePlan( hygieneDue && !gitOptions.wslDistro ? store.captureNativeLocalWorktreeMetadataScanExpectation?.(repo) : undefined - const witness: WorktreeCatalogHygieneWitness = { + const witness: WorktreeCatalogWitness = { authorizedRootsRevision, hygieneDue, ...(expectation ? { expectation } : {}), @@ -74,7 +66,7 @@ export function worktreeCatalogHygienePlan( repo.id, worktrees.map((worktree) => worktree.path) ) - const witness = observation.witness as WorktreeCatalogHygieneWitness | undefined + const witness = observation.witness if ( !witness || getRepoExecutionHostId(repo) !== LOCAL_EXECUTION_HOST_ID || @@ -84,7 +76,7 @@ export function worktreeCatalogHygienePlan( } // Reuse listing roots for authorization to avoid another Git scan and macOS folder-permission prompts. registerWorktreeRootsForRepo( - store as Store, + store, repo, [repo.path, ...worktrees.map((worktree) => worktree.path)], gitOptions @@ -98,7 +90,7 @@ export function worktreeCatalogHygienePlan( export function claimWorktreeCatalogHygiene( observation: WorktreeCatalogObservation ): WorktreeCatalogHygieneClaim | null { - const witness = observation.witness as WorktreeCatalogHygieneWitness | undefined + const witness = observation.witness if (!witness) { return null } diff --git a/src/main/ipc/worktrees/listing/worktree-catalog-prune-authority.test.ts b/src/main/ipc/worktrees/listing/worktree-catalog-prune-authority.test.ts index 6eb691f9d04..b15447b3fbc 100644 --- a/src/main/ipc/worktrees/listing/worktree-catalog-prune-authority.test.ts +++ b/src/main/ipc/worktrees/listing/worktree-catalog-prune-authority.test.ts @@ -8,6 +8,7 @@ import { import { setWorktreeCatalogRouteResolver } from '../../../workspaces/catalog/repo-worktree-catalog-route' import { pruneMetadataMissingFromAuthoritativeLocalScan } from './authoritative-local-worktree-metadata-pruning' +// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the owner and pruning read only these repo fields. const repo = { id: 'repo-1', path: '/repos/app', kind: 'git' } as Repo const goneWorktreeId = 'repo-1::/repos/app-gone' @@ -38,6 +39,7 @@ describe('metadata pruning under catalog owner authority', () => { let releaseProbe: (() => void) | undefined const pruneMissing = vi.fn(() => [goneWorktreeId]) const pruning = pruneMetadataMissingFromAuthoritativeLocalScan({ + // oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the helper reads only these store members. store: { getRepos: () => [repo], pruneSessionlessMissingLocalWorktreeMetadataForRepo: pruneMissing, @@ -47,6 +49,7 @@ describe('metadata pruning under catalog owner authority', () => { gitWorktrees: [ { path: repo.path, head: 'abc', branch: 'main', isBare: false, isMainWorktree: true } ], + // oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: pruning compares only the repo identity and metadata ids. scan: { repo: { id: repo.id, path: repo.path }, metadata: [{ worktreeId: goneWorktreeId }] diff --git a/src/main/runtime/workspaces/catalog/external-worktree-paired-client-discovery.integration.test.ts b/src/main/runtime/workspaces/catalog/external-worktree-paired-client-discovery.integration.test.ts index e26a983e661..035288f637b 100644 --- a/src/main/runtime/workspaces/catalog/external-worktree-paired-client-discovery.integration.test.ts +++ b/src/main/runtime/workspaces/catalog/external-worktree-paired-client-discovery.integration.test.ts @@ -35,9 +35,7 @@ vi.mock('../../../git/worktrees/catalog/worktree-listing', async (importOriginal const facade = getWorktreeListingMocks() return { ...(await importOriginal()), - listWorktreesStrict: facade.listWorktreesStrict, - // Runtime scans share the strict, true-empty-aware reader with desktop scans. - listWorktreesStrictAllowingTrueEmpty: facade.listWorktreesStrict + listWorktreesStrict: facade.listWorktreesStrict } }) diff --git a/src/main/runtime/workspaces/catalog/runtime-managed-worktree-queries.test.ts b/src/main/runtime/workspaces/catalog/runtime-managed-worktree-queries.test.ts index 6737a96d397..9fb41be5d5c 100644 --- a/src/main/runtime/workspaces/catalog/runtime-managed-worktree-queries.test.ts +++ b/src/main/runtime/workspaces/catalog/runtime-managed-worktree-queries.test.ts @@ -345,6 +345,7 @@ describe('RuntimeManagedWorktreeQueries.listDetected overtaken scan', () => { scan: async () => ({ kind: 'rows', worktrees: rows([repo.path]) }), // The observation carries the pre-scan hygiene claim a pruning listing consumes. captureWitness: () => + // oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the mocked prune reads only the expectation's presence. ({ authorizedRootsRevision: 0, rootsRevision: 0, diff --git a/src/main/runtime/workspaces/catalog/runtime-witnessed-worktree-scan.ts b/src/main/runtime/workspaces/catalog/runtime-witnessed-worktree-scan.ts index 6f81938ea8c..bbd09c91b0f 100644 --- a/src/main/runtime/workspaces/catalog/runtime-witnessed-worktree-scan.ts +++ b/src/main/runtime/workspaces/catalog/runtime-witnessed-worktree-scan.ts @@ -71,9 +71,7 @@ async function scanRuntimeWorktreesWithMutationWitness( isLocalWorktreeScanGenerationCurrent(repo.id, scanGeneration) && authorityCurrent() ? claimWorktreeCatalogHygiene(observation) : null - metadataPruneExpectation = claim?.expectation as - | NativeLocalWorktreeMetadataScanExpectation - | undefined + metadataPruneExpectation = claim?.expectation lineagePrune = claimRuntimeLineagePrune(scan) } else { metadataPruneExpectation = captureLocalMetadataPruneExpectation(store, repo) diff --git a/src/main/runtime/workspaces/catalog/worktree-scan-admin-fingerprint-gate.test.ts b/src/main/runtime/workspaces/catalog/worktree-scan-admin-fingerprint-gate.test.ts index 17d3024a42f..218dfaf6d1e 100644 --- a/src/main/runtime/workspaces/catalog/worktree-scan-admin-fingerprint-gate.test.ts +++ b/src/main/runtime/workspaces/catalog/worktree-scan-admin-fingerprint-gate.test.ts @@ -17,9 +17,7 @@ const electronMocks = vi.hoisted(() => { vi.mock('../../../git/worktrees/catalog/worktree-listing', async (importOriginal) => { return { ...(await importOriginal()), - listWorktreesStrict: listWorktreesStrictMock, - // Runtime scans share the strict, true-empty-aware reader with desktop scans. - listWorktreesStrictAllowingTrueEmpty: listWorktreesStrictMock + listWorktreesStrict: listWorktreesStrictMock } }) diff --git a/src/main/workspaces/catalog/repo-worktree-catalog-observation.ts b/src/main/workspaces/catalog/repo-worktree-catalog-observation.ts index 67b5329c302..fb6082c5f2b 100644 --- a/src/main/workspaces/catalog/repo-worktree-catalog-observation.ts +++ b/src/main/workspaces/catalog/repo-worktree-catalog-observation.ts @@ -1,4 +1,5 @@ import type { GitWorktreeInfo } from '../../../shared/worktree/types' +import type { NativeLocalWorktreeMetadataScanExpectation } from '../../persistence/tracking-repos/missing-local-worktree-metadata-pruning' /** One `git worktree list`; a confirmed missing/non-repo stays distinct from a failed run. */ export type WorktreeCatalogOutcome = @@ -9,8 +10,10 @@ export type WorktreeCatalogOutcome = /** Captured before Git runs; destructive consumers claim it at most once. */ export type WorktreeCatalogWitness = { readonly authorizedRootsRevision: number + /** Roots revision after this observation registered its roots; later side effects fence on it. */ + rootsRevision: number readonly hygieneDue: boolean - readonly expectation?: unknown + readonly expectation?: NativeLocalWorktreeMetadataScanExpectation /** Returns an unconsumed claim so the evidence gate can re-arm. */ readonly release: () => void } diff --git a/src/main/workspaces/catalog/repo-worktree-catalog-owner.test.ts b/src/main/workspaces/catalog/repo-worktree-catalog-owner.test.ts index 0920eee7ee1..ed811fd9b30 100644 --- a/src/main/workspaces/catalog/repo-worktree-catalog-owner.test.ts +++ b/src/main/workspaces/catalog/repo-worktree-catalog-owner.test.ts @@ -17,6 +17,7 @@ import type { WorktreeCatalogOutcome } from './repo-worktree-catalog-observation' +// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the owner reads only these repo fields. const repo = { id: 'repo-1', path: '/repos/app', kind: 'git' } as Repo const row = (path: string): GitWorktreeInfo => ({ path, @@ -238,7 +239,12 @@ describe('repo worktree catalog owner', () => { const release = vi.fn() const plan = { ...scanner([rows('/repos/app')]), - captureWitness: () => ({ authorizedRootsRevision: 1, hygieneDue: true, release }) + captureWitness: () => ({ + authorizedRootsRevision: 1, + rootsRevision: 1, + hygieneDue: true, + release + }) } await readWorktreeCatalog(repo, 'local:default', desktop, plan) invalidateWorktreeCatalogForRepo(repo.id) diff --git a/src/main/workspaces/catalog/repo-worktree-catalog-owner.ts b/src/main/workspaces/catalog/repo-worktree-catalog-owner.ts index 5905439d910..4d6e163a0bd 100644 --- a/src/main/workspaces/catalog/repo-worktree-catalog-owner.ts +++ b/src/main/workspaces/catalog/repo-worktree-catalog-owner.ts @@ -15,7 +15,10 @@ import { isLocalWorktreeScanGenerationCurrent, onWorktreeRouteInputsChanged } from './local-worktree-scan-generation' -import { isLiveWorktreeCatalogRoute } from './repo-worktree-catalog-route' +import { + isLiveWorktreeCatalogRoute, + setWorktreeCatalogRouteResolver +} from './repo-worktree-catalog-route' import { verify } from './repo-worktree-catalog-verification' import { onWslDiscoveryChanged } from '../../wsl/discovery/wsl-discovery-change' @@ -309,6 +312,8 @@ export function retireObsoleteWorktreeCatalogs(): void { } export function _resetWorktreeCatalogOwnerForTests(): void { + // Shared test workers outlive the runtime whose store registered the resolver. + setWorktreeCatalogRouteResolver(null) for (const [key, entry] of entries) { retireEntry(key, entry) }