Files
orca/src/main/gitlab/glab-error-classification.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

100 lines
4.6 KiB
TypeScript

import type { ClassifiedError } from '../../shared/classified-error'
import { GlabNonListResponseError } from './glab-api-response'
// Why: glab CLI surfaces API errors as unstructured stderr. Map known
// patterns to typed errors so callers can show user-friendly messages.
export function classifyGlabError(stderr: string): ClassifiedError {
const s = stderr.toLowerCase()
if (s.includes('http 403') || s.includes('forbidden') || s.includes('insufficient_scope')) {
return {
type: 'permission_denied',
message: "You don't have permission to edit this issue. Check your GitLab token scopes."
}
}
if (s.includes('http 404') || s.includes('project not found')) {
return { type: 'not_found', message: 'Issue not found — it may have been deleted.' }
}
if (s.includes('http 422') || s.includes('unprocessable')) {
return { type: 'validation_error', message: `Invalid update — ${stderr.trim()}` }
}
if (s.includes('rate limit') || s.includes('http 429')) {
return {
type: 'rate_limited',
message: 'GitLab rate limit hit. Try again in a few minutes.'
}
}
if (
s.includes('timeout') ||
s.includes('no such host') ||
s.includes('network') ||
s.includes('could not resolve host')
) {
return { type: 'network_error', message: 'Network error — check your connection.' }
}
return { type: 'unknown', message: `Failed to update issue: ${stderr.trim()}` }
}
const LIST_READ_FAILURE = 'Failed to load issues'
// Why: classifyGlabError's copy is phrased for edit/update operations; list
// issues is a read op, so rewrite messages for read-context banners.
export function classifyListIssuesError(stderr: string): ClassifiedError {
const c = classifyGlabError(stderr)
const trimmed = stderr.trim()
const readMessages: Record<ClassifiedError['type'], string> = {
permission_denied:
"You don't have permission to read issues for this project. Check your GitLab token scopes.",
not_found: 'Project not found.',
issues_disabled: 'Issues are disabled on this project.',
validation_error: `Invalid request — ${trimmed}`,
rate_limited: 'GitLab rate limit hit. Try again in a few minutes.',
network_error: 'Network error — check your connection.',
unknown: `${LIST_READ_FAILURE}: ${trimmed}`
}
return { type: c.type, message: readMessages[c.type] }
}
// Why: an opaque response body is content, not a diagnostic — substring-matching it would render
// an MR titled "fix network timeout" as "check your connection" and discard the body.
export function classifyListFetchError(err: unknown): ClassifiedError {
if (err instanceof GlabNonListResponseError) {
return { type: 'unknown', message: `${LIST_READ_FAILURE}: ${err.message}` }
}
return classifyListIssuesError(err instanceof Error ? err.message : String(err))
}
// Why: a job trace is a read on a pipeline job, so classifyGlabError's issue-edit
// copy ("permission to edit this issue") would land verbatim on a Checks row.
export function classifyJobLogError(stderr: string): ClassifiedError {
const c = classifyGlabError(stderr)
const trimmed = stderr.trim()
const logMessages: Record<ClassifiedError['type'], string> = {
permission_denied:
"You don't have permission to read this job's log. Check your GitLab token scopes.",
// A missing log is already reported as an empty log, so a 404 that reaches here
// means the project itself is gone or invisible to this token.
not_found: "Could not find this job's GitLab project.",
issues_disabled: `Failed to load the job log: ${trimmed}`,
validation_error: `Invalid request — ${trimmed}`,
rate_limited: 'GitLab rate limit hit. Try again in a few minutes.',
network_error: 'Network error — check your connection.',
unknown: `Failed to load the job log: ${trimmed}`
}
return { type: c.type, message: logMessages[c.type] }
}
/**
* Whether a failed trace fetch means "this job has no log", not "the fetch broke".
*
* GitLab 404s the trace endpoint for a job canceled before it started and for a log
* that was erased or expired. A missing *project* is a real failure, and GitLab also
* masks unauthorized projects as 404, so keep that one an error.
*
* Deliberately broad: GitLab returns the same bare 404 for an unknown job id, so a
* stale/foreign id reads as an empty log rather than an error. Losing that diagnostic
* beats pinning "not found" on every job that was canceled before it produced a log.
*/
export function isMissingJobLogError(stderr: string): boolean {
return classifyGlabError(stderr).type === 'not_found' && !/project\s+not\s+found/i.test(stderr)
}