Files
orca/src/preload/ssh-authority-forwarding.test.ts
Neil 77f23b013f refactor(shared): drop the shared/types barrel and import from the real modules (#14447)
#14397 split `shared/types.ts` into 46 per-domain modules but kept the path as
a re-export barrel so the import sites did not have to change. This removes
the barrel: every consumer now imports from the module that actually declares
the type, and `src/shared/types.ts` is deleted.

Barrels hide where a type lives, make every consumer look like it depends on
the whole domain, and let an unrelated edit invalidate a module that ~2,000
files transitively import.

2,323 import declarations across 2,321 files. Rewritten mechanically: each
specifier was resolved to an absolute path via the TypeScript AST and
recomputed, rather than string-substituted, so alias forms (`@/../../shared/
types`) and per-specifier `type` modifiers survive.

Four cases the mechanical pass had to handle, each found by a gate rather than
by reading the diff:

- Modules inside `src/shared` import the barrel as `./types`, not
  `shared/types`. A pre-filter on the latter string skipped 176 of them and
  left imports dangling at a deleted file, which surfaced as confusing
  `Property 'x' is optional in type 'Repo' but required in Pick<Repo, ...>`
  errors rather than "module not found".
- The barrel RENAMED one type on the way through
  (`WorkspaceSource as WorkspaceCreateTelemetrySource`), so the original name
  in the owning module has to be re-aliased at each consumer.
- Three test files put `;(globalThis as ...)` on the line after the import.
  TypeScript parses that `;` as the import statement's terminator, so
  replacing through `statement.getEnd()` deletes it and breaks ASI. The
  rewrite now stops at the module specifier.
- A file that already imported directly from a module got a SECOND import
  from it, because the barrel re-exported those same names — which trips
  `import/no-duplicates` under `--deny-warnings`. A post-pass merges
  declarations sharing a specifier and type-only-ness; the `import type` plus
  `import` pair from one module is left alone, since that form is allowed.

Splitting one barrel import into several genuinely adds lines, which pushed
`terminal-layout-pty-ownership.ts` to 301 counted lines: its 107-character
import must wrap, and neither local type collapses onto one line (101 and 116
characters). Rather than contort a type declaration to fit a line budget,
`collectLeafIds` and `pruneLeaves` move to `terminal-pane-layout-tree.ts` —
they are pure structural operations on the layout tree and independent of PTY
ownership. `visible-worktrees.ts` similarly loses its own mini-barrel
re-export of `isDefaultBranchWorkspace`, with the four real consumers
repointed at the declaring module. No `max-lines` bypass added.

Verified: cold `tsc --noEmit` green on node, cli, and web (buildinfo deleted
first — these projects are `composite: true` and reuse stale caches); the full
`pnpm lint` green, not just bare oxlint — the narrower local check is what let
the duplicate imports reach CI; max-lines ratchet OK at 344.
2026-08-13 22:48:24 -07:00

189 lines
6.3 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, expectTypeOf, it, vi } from 'vitest'
import type { PreloadApi } from './api-types'
import type { SshConnectionState, SshProviderEpoch } from '../shared/ssh-types'
import type {
HostQualifiedDetectedWorktreeResult,
ListDetectedWorktreesArgs
} from '../shared/detected-worktree-provider-contract'
import type { DetectedWorktreeListResult } from '../shared/worktree/types'
function listDetectedVariableTypeProbe(api: PreloadApi, args: ListDetectedWorktreesArgs) {
return api.worktrees.listDetected(args)
}
const { exposeInMainWorld, invoke, on, removeListener, send, sendSync } = vi.hoisted(() => ({
exposeInMainWorld: vi.fn(),
invoke: vi.fn(),
on: vi.fn(),
removeListener: vi.fn(),
send: vi.fn(),
sendSync: vi.fn()
}))
vi.mock('electron', () => ({
contextBridge: { exposeInMainWorld },
ipcRenderer: { invoke, on, removeListener, send, sendSync },
webFrame: {
getZoomFactor: vi.fn(() => 1),
setZoomFactor: vi.fn(),
setVisualZoomLevelLimits: vi.fn()
},
webUtils: { getPathForFile: vi.fn(() => '') }
}))
vi.mock('@electron-toolkit/preload', () => ({ electronAPI: {} }))
describe('native preload SSH authority forwarding', () => {
const originalContextIsolated = Object.getOwnPropertyDescriptor(process, 'contextIsolated')
beforeEach(() => {
vi.resetModules()
exposeInMainWorld.mockReset()
invoke.mockReset()
on.mockReset()
removeListener.mockReset()
send.mockReset()
sendSync.mockReset()
Object.defineProperty(process, 'contextIsolated', { configurable: true, value: true })
vi.stubGlobal('window', {
addEventListener: vi.fn(),
dispatchEvent: vi.fn(),
removeEventListener: vi.fn()
})
vi.stubGlobal('document', { addEventListener: vi.fn() })
})
afterEach(() => {
vi.unstubAllGlobals()
if (originalContextIsolated) {
Object.defineProperty(process, 'contextIsolated', originalContextIsolated)
} else {
Reflect.deleteProperty(process, 'contextIsolated')
}
})
it('retains host-qualified outcomes for variable-form detected-worktree requests', () => {
expectTypeOf(listDetectedVariableTypeProbe).returns.toEqualTypeOf<
Promise<HostQualifiedDetectedWorktreeResult | DetectedWorktreeListResult>
>()
})
it('forwards host-qualified metadata-only worktree reads', async () => {
await import('./index')
const api = exposeInMainWorld.mock.calls.find(([name]) => name === 'api')?.[1] as PreloadApi
const args = { repoId: 'repo-1', executionHostId: 'ssh:ssh-1' as const }
await api.worktrees.listKnownForExecutionHost?.(args)
expect(invoke).toHaveBeenCalledWith('worktrees:listKnownForExecutionHost', args)
})
it('forwards metadata retirement for authoritatively removed worktrees', async () => {
await import('./index')
const api = exposeInMainWorld.mock.calls.find(([name]) => name === 'api')?.[1] as PreloadApi
const args = {
repoId: 'repo-1',
executionHostId: 'ssh:ssh-1' as const,
worktreeIds: ['repo-1::/remote/deleted']
}
await api.worktrees.forgetRemovedForExecutionHost?.(args)
expect(invoke).toHaveBeenCalledWith('worktrees:forgetRemovedForExecutionHost', args)
})
it('forwards full-pair get and push states without cloning away authority', async () => {
const state: SshConnectionState = {
targetId: 'ssh-1',
status: 'connected',
error: null,
reconnectAttempt: 0,
providerEpoch: 'native-provider-epoch' as SshProviderEpoch,
connectionGeneration: 29
}
invoke.mockResolvedValueOnce(state)
await import('./index')
const api = exposeInMainWorld.mock.calls.find(([name]) => name === 'api')?.[1] as PreloadApi
await expect(api.ssh.getState({ targetId: 'ssh-1' })).resolves.toEqual(state)
expect(invoke).toHaveBeenCalledWith('ssh:getState', { targetId: 'ssh-1' })
const onStateChanged = vi.fn()
api.ssh.onStateChanged(onStateChanged)
const listener = on.mock.calls.find(([channel]) => channel === 'ssh:state-changed')?.[1] as (
event: unknown,
data: { targetId: string; state: SshConnectionState }
) => void
listener({}, { targetId: 'ssh-1', state })
expect(onStateChanged).toHaveBeenCalledWith({ targetId: 'ssh-1', state })
expect(onStateChanged.mock.calls[0]?.[0].state).toEqual(state)
})
it('normalizes partial compatibility authority to unknown for reconciliation', async () => {
const partialState = {
targetId: 'ssh-1',
status: 'connected',
error: null,
reconnectAttempt: 0,
providerEpoch: 'partial-provider-epoch'
} as SshConnectionState
invoke.mockResolvedValueOnce(partialState)
await import('./index')
const api = exposeInMainWorld.mock.calls.find(([name]) => name === 'api')?.[1] as PreloadApi
const returned = await api.ssh.getState({ targetId: 'ssh-1' })
expect(returned).toEqual({
targetId: 'ssh-1',
status: 'connected',
error: null,
reconnectAttempt: 0,
providerEpoch: null
})
const onStateChanged = vi.fn()
api.ssh.onStateChanged(onStateChanged)
const listener = on.mock.calls.find(([channel]) => channel === 'ssh:state-changed')?.[1] as (
event: unknown,
data: { targetId: string; state: SshConnectionState }
) => void
listener({}, { targetId: 'ssh-1', state: partialState })
expect(onStateChanged.mock.calls[0]?.[0].state).toEqual({
targetId: 'ssh-1',
status: 'connected',
error: null,
reconnectAttempt: 0,
providerEpoch: null
})
})
it('drops malformed full authority before it reaches the renderer', async () => {
await import('./index')
const api = exposeInMainWorld.mock.calls.find(([name]) => name === 'api')?.[1] as PreloadApi
const onStateChanged = vi.fn()
api.ssh.onStateChanged(onStateChanged)
const listener = on.mock.calls.find(([channel]) => channel === 'ssh:state-changed')?.[1] as (
event: unknown,
data: { targetId: string; state: SshConnectionState }
) => void
listener(
{},
{
targetId: 'ssh-1',
state: {
targetId: 'ssh-1',
status: 'connected',
error: null,
reconnectAttempt: 0,
providerEpoch: '' as SshProviderEpoch,
connectionGeneration: 29
}
}
)
expect(onStateChanged).not.toHaveBeenCalled()
})
})