Files
orca/src/shared/markdown-document-listing-limits.test.ts
T
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

84 lines
3.0 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import type { MarkdownDocument } from './filesystem-entry-types'
import {
assertMarkdownDocumentsWithinLimit,
createMarkdownDocumentListingBudget,
isMarkdownDocumentListingCapacityError,
MARKDOWN_DOCUMENT_LISTING_ERROR_CODE,
MARKDOWN_DOCUMENT_LISTING_ERROR_MESSAGE,
MarkdownDocumentListingCapacityError,
retainMarkdownDocument,
visitMarkdownDocumentListingEntry
} from './markdown-document-listing-limits'
function document(path: string): MarkdownDocument {
return {
filePath: `/repo/${path}`,
relativePath: path,
basename: path,
name: path
}
}
describe('Markdown document listing limits', () => {
it('preserves an under-limit listing and reports its retained estimate', () => {
const documents = [document('README.md'), document('docs/guide.mdx')]
expect(assertMarkdownDocumentsWithinLimit(documents)).toBeGreaterThan(0)
})
it('rejects the first document beyond the count limit with a typed error', () => {
const budget = createMarkdownDocumentListingBudget({ maxDocuments: 2 })
retainMarkdownDocument(budget, document('one.md'))
retainMarkdownDocument(budget, document('two.md'))
expect(() => retainMarkdownDocument(budget, document('three.md'))).toThrow(
MarkdownDocumentListingCapacityError
)
expect(() => retainMarkdownDocument(budget, document('three.md'))).toThrow(
expect.objectContaining({ code: MARKDOWN_DOCUMENT_LISTING_ERROR_CODE })
)
})
it('rejects aggregate metadata, visited-entry, path, and depth overflow', () => {
expect(() =>
assertMarkdownDocumentsWithinLimit([document('a'.repeat(100))], {
maxMetadataBytes: 100
})
).toThrow(MarkdownDocumentListingCapacityError)
const visited = createMarkdownDocumentListingBudget({
maxVisitedEntries: 1,
maxPathBytes: 4,
maxDepth: 1
})
visitMarkdownDocumentListingEntry(visited, 'a', 1)
expect(() => visitMarkdownDocumentListingEntry(visited, 'b', 1)).toThrow(
MarkdownDocumentListingCapacityError
)
const path = createMarkdownDocumentListingBudget({ maxPathBytes: 4 })
expect(() => visitMarkdownDocumentListingEntry(path, 'ééé', 1)).toThrow(
MarkdownDocumentListingCapacityError
)
const depth = createMarkdownDocumentListingBudget({ maxDepth: 1 })
expect(() => visitMarkdownDocumentListingEntry(depth, 'a/b', 2)).toThrow(
MarkdownDocumentListingCapacityError
)
})
it('recognizes structured runtime and Electron-wrapped capacity failures', () => {
const structured = Object.assign(new Error('remote listing rejected'), {
code: MARKDOWN_DOCUMENT_LISTING_ERROR_CODE
})
const electronWrapped = new Error(
`Error invoking remote method 'fs:listMarkdownDocuments': Error: ${MARKDOWN_DOCUMENT_LISTING_ERROR_MESSAGE}`
)
expect(isMarkdownDocumentListingCapacityError(structured)).toBe(true)
expect(isMarkdownDocumentListingCapacityError(electronWrapped)).toBe(true)
expect(isMarkdownDocumentListingCapacityError(new Error('unrelated failure'))).toBe(false)
})
})