Skip to content

chore(cli): migrate @fern-api/cli to use CliError#14753

Merged
FedeZara merged 4 commits intomainfrom
FedeZara/refactor/cli-error-cli
Apr 14, 2026
Merged

chore(cli): migrate @fern-api/cli to use CliError#14753
FedeZara merged 4 commits intomainfrom
FedeZara/refactor/cli-error-cli

Conversation

@FedeZara
Copy link
Copy Markdown
Contributor

@FedeZara FedeZara commented Apr 8, 2026

Description

Migrates @fern-api/cli (the main CLI package) to use explicit CliError error codes on every failAndThrow / failWithoutThrowing call site.

This is one of ~35 package migration PRs that follow the error classification system introduced in #14749.

Changes Made

Assigned typed error codes across 42 files in packages/cli/cli/src/, covering every failAndThrow and failWithoutThrowing invocation (excluding generic catch blocks where resolveErrorCode auto-extracts codes from CliError instances).

Error codes used

Code Usage
CONFIG_ERROR Missing config, invalid flags, bad file paths, missing generators.yml, unknown group/generator names, missing docs.yml
AUTH_ERROR Authentication failures (fern login required, token creation)
NETWORK_ERROR HTTP/API call failures, translation service errors, generation task polling failures
VALIDATION_ERROR Schema validation failures, broken-link checks, workspace validation
PARSE_ERROR Malformed YAML/JSON, invalid IR files, export schema issues
VERSION_ERROR Invalid semver, version already registered, generator version incompatibility
ENVIRONMENT_ERROR Missing environment prerequisites, self-update failures, dependency installation
INTERNAL_ERROR Unexpected states that indicate bugs, failed reruns, missing IR fields

Files touched (grouped by area)

  • Top-level CLI: cli.ts, cliV2.ts, rerunFernCliAtVersion.ts, resolveGroupGithubConfig.ts
  • Generate commands: generateAPIWorkspace.ts, generateAPIWorkspaces.ts, generateDocsWorkspace.ts
  • Docs commands: docsDiff.ts, generateLibraryDocs.ts, listDocsPreview.ts, deleteDocsPreview.ts
  • SDK commands: sdkDiffCommand.ts, sdkPreview.ts
  • Diff: diff.ts
  • Validation: validateWorkspaces.ts, validateDocsBrokenLinks.ts, validateDocsWorkspaceAndLogIssues.ts
  • Upgrade/Downgrade: upgrade.ts, upgradeGenerator.ts, downgrade.ts
  • Self-update: selfUpdate.ts
  • Export: servicesConverter.ts, typeConverter.ts, security.ts
  • Other: token.ts, testOutput.ts, mockServer.ts, mergeOpenAPIWithOverrides.ts, compareOpenAPISpecs.ts, writeOverridesForWorkspaces.ts, getGeneratorList.ts, getOrganization.ts, installDependencies.ts, registerWorkspacesV1.ts

Testing

  • Existing tests pass

@FedeZara FedeZara self-assigned this Apr 8, 2026
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 8, 2026

🌱 Seed Test Selector

Select languages to run seed tests for:

  • Python
  • TypeScript
  • Java
  • Go
  • Ruby
  • C#
  • PHP
  • Swift
  • Rust
  • OpenAPI
  • Postman

How to use: Click the ⋯ menu above → "Edit" → check the boxes you want → click "Update comment". Tests will run automatically and snapshots will be committed to this PR.

@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 75d665e to 16fa7e1 Compare April 8, 2026 16:00
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from 43e3daf to fd89650 Compare April 9, 2026 14:00
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch 2 times, most recently from 2f89572 to b0ba301 Compare April 9, 2026 22:38
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from fd89650 to 6e6d684 Compare April 9, 2026 22:38
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from b0ba301 to c1dbed3 Compare April 9, 2026 23:14
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch 2 times, most recently from ab973cc to fd585dd Compare April 10, 2026 12:18
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch 2 times, most recently from 55ea24d to 3f29671 Compare April 10, 2026 12:43
});
} catch (error) {
throw new CliError({
message: `Failed to resolve latest CLI version: ${error instanceof Error ? error.message : String(error)}`,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there should be a helper in the codebase already to do error instanceof Error ? ...

@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from fd585dd to 630e15e Compare April 10, 2026 14:44
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 3f29671 to 6d84398 Compare April 10, 2026 14:44
Comment on lines +1 to +17
@@ -10,12 +10,13 @@ export const CliErrorCode = {
ValidationError: "VALIDATION_ERROR",
NetworkError: "NETWORK_ERROR",
AuthError: "AUTH_ERROR",
ConfigError: "CONFIG_ERROR"
ConfigError: "CONFIG_ERROR",
Unclassified: "UNCLASSIFIED"
} as const;

export type CliErrorCode = (typeof CliErrorCode)[keyof typeof CliErrorCode];
export type CliError.Code = (typeof CliError.Code)[keyof typeof CliError.Code];
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Invalid TypeScript syntax: Cannot use dot notation in export declarations. The syntax export const CliError.Code and export type CliError.Code is not valid TypeScript and will cause compilation errors.

// Fix: Use namespace syntax instead
export namespace CliError {
    export const Code = {
        InternalError: "INTERNAL_ERROR",
        // ... rest of codes
    } as const;
    
    export type Code = (typeof Code)[keyof typeof Code];
}

This will break compilation across all files importing CliError.Code.

Suggested change
export namespace CliError {
export const Code = {
InternalError: "INTERNAL_ERROR",
ResolutionError: "RESOLUTION_ERROR",
IrConversionError: "IR_CONVERSION_ERROR",
ValidationError: "VALIDATION_ERROR",
NetworkError: "NETWORK_ERROR",
AuthError: "AUTH_ERROR",
ConfigError: "CONFIG_ERROR",
Unclassified: "UNCLASSIFIED"
} as const;
export type Code = (typeof Code)[keyof typeof Code];
}

Spotted by Graphite

Fix in Graphite


Is this helpful? React 👍 or 👎 to let us know.

@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch 2 times, most recently from 4e486c6 to 2c0f53a Compare April 10, 2026 15:23
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch 3 times, most recently from 0549359 to 813f087 Compare April 10, 2026 17:09
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 2c0f53a to db46c2e Compare April 10, 2026 17:09
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from 0b71fc4 to dc33e43 Compare April 10, 2026 19:42
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch 2 times, most recently from 5b1fcc8 to bd4e902 Compare April 10, 2026 19:45
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from dc33e43 to 7a7c757 Compare April 10, 2026 21:55
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from bd4e902 to 5c06aec Compare April 10, 2026 21:55
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from 7a7c757 to f473624 Compare April 10, 2026 22:16
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 5c06aec to 468f00f Compare April 10, 2026 22:17
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from f473624 to 41d0da0 Compare April 10, 2026 22:24
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 468f00f to 4045c68 Compare April 10, 2026 22:26
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch from 41d0da0 to f45d891 Compare April 14, 2026 18:22
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 4045c68 to 1c32ff6 Compare April 14, 2026 18:22
FedeZara added a commit that referenced this pull request Apr 14, 2026
…entry routing (#14749)

## Description

Introduces a structured `CliError` class in `@fern-api/task-context` with typed error codes and automatic Sentry routing. This replaces the ad-hoc `new Error(...)` pattern throughout the CLI with a system that categorizes errors into user-facing codes (e.g. `CONFIG_ERROR`, `AUTH_ERROR`) vs internal errors that should be reported to Sentry. It also simplifies error handling by removing redundant error classes and unifying the ones we already have.

> **Recommended review approach:** commit-by-commit. Each commit is self-contained and builds on the previous one.

### Prerequisite PRs

- #14746 — rename `FernCliError` to `TaskAbortSignal` (clears the naming space)
- #14747 — make CLI v1 telemetry synchronous (so `failWithoutThrowing` can report errors)
- #14748 — make CLI v2 telemetry synchronous (same, for CLI v2)

### Follow-up PRs

- #14750 — temporarily disable Sentry for unclassified errors (safety net while migrating)
- #14753 — migrate `@fern-api/cli` package (example of a package migration PR)
- ~34 more package migration PRs (one per package, converting `new Error(...)` → `new CliError(...)` and adding error codes to `failAndThrow` and `failWithoutThrowing` calls)
- #14752 — re-enable Sentry for unclassified errors (merge last, after all migrations)

## Design Decisions

### Two ways to trigger and track errors

There are two paths through which errors are captured and reported:

1. **Throwing `CliError` directly.** Code anywhere in the CLI can `throw new CliError({ message, code })`. The top-level catch handler in each CLI entry point (CLI v1's `runCli` catch in `cli.ts`, CLI v2's `withContext` catch in `withContext.ts`) intercepts it, resolves the error code, and routes it to Sentry and/or PostHog.

2. **Calling `failAndThrow` / `failWithoutThrowing` on the task context.** These methods log the error, resolve the code (explicit override > `CliError.code` > fallback), and report to Sentry if the code is Sentry-reportable. `failAndThrow` then throws a `TaskAbortSignal` to unwind the stack; `failWithoutThrowing` marks the task as failed and returns. This is the preferred path when the caller needs control over what happens after the error — for example, to continue processing other tasks or to clean up resources before aborting. It also adapts naturally to the existing error-handling patterns already used throughout the codebase.

Both paths converge on the same code-resolution logic (`resolveErrorCode`) and Sentry-routing rules (`shouldReportToSentry`), so tracking is consistent regardless of which path is used.

### Default behavior: unclassified errors are internal

Any error that doesn't carry a `CliError.Code` (i.e. a plain `new Error(...)`) is treated as `INTERNAL_ERROR` at the top-level catch boundaries — and therefore reported to Sentry. The assumption is that if nobody explicitly categorized an error as user-facing, it's likely an internal bug.

**Temporary exception:** the follow-up PR #14750 temporarily downgrades this so unclassified errors skip Sentry during the migration period, to avoid noise from the ~34 packages that haven't been migrated yet. Once all migrations land, #14752 re-enables it.

### Error code taxonomy

Errors are classified into 12 typed codes:

| Code | Sentry? | Description |
|------|---------|-------------|
| `INTERNAL_ERROR` | Yes | Unexpected bugs — should be investigated |
| `RESOLUTION_ERROR` | Yes | Type/reference resolution failures (likely IR bugs) |
| `IR_CONVERSION_ERROR` | Yes | IR generation failures |
| `CONTAINER_ERROR` | Yes | Docker container failures |
| `VERSION_ERROR` | Yes | Version parsing/compatibility issues |
| `PARSE_ERROR` | No | Malformed user input (YAML, OpenAPI, etc.) |
| `ENVIRONMENT_ERROR` | No | Missing env vars, wrong Node version, etc. |
| `REFERENCE_ERROR` | No | Dangling references in user config |
| `VALIDATION_ERROR` | No | Schema/rule validation failures |
| `NETWORK_ERROR` | No | HTTP failures, timeouts |
| `AUTH_ERROR` | No | Authentication/authorization issues |
| `CONFIG_ERROR` | No | Invalid generators.yml, fern.config.json, etc. |

Only the first 5 codes are Sentry-reportable — they indicate bugs in Fern itself. The rest are user-actionable and would just create noise in Sentry.

### Simplifying error handling by removing redundant classes

- **Unified `CliError` across CLI v1 and v2.** CLI v2 had its own `CliError` class in `packages/cli/cli-v2/src/errors/CliError.ts`. This PR deletes it and makes both CLIs share the single `CliError` from `@fern-api/task-context`, ensuring consistent error codes and Sentry routing regardless of which CLI entry point is used.

- **Existing error classes now extend `CliError`.** `ValidationError`, `SourcedValidationError`, and `KeyringUnavailableError` now extend `CliError` with their appropriate codes (`VALIDATION_ERROR` and `AUTH_ERROR`). This means `resolveErrorCode()` handles them automatically — no special-casing needed in every catch block.

- **Removed `LoggableFernCliError`.** This was a wrapper that carried a log message alongside an error. With `CliError` now carrying a `message` field (it extends `Error`), the wrapper is redundant. All former `LoggableFernCliError` usages are replaced with `CliError`.

### `reportError` — single error reporting path (CLI v2)

CLI v2's `withContext.ts` previously had separate `shouldReportToSentry` and `extractErrorCode` functions. These are consolidated into a single `reportError(context, error, options?)` function that:
1. Skips `TaskAbortSignal` (already logged)
2. Resolves the error code via `resolveErrorCode()` (explicit override > `CliError.code` > fallback to `INTERNAL_ERROR`)
3. Reports to Sentry if the code is in `SENTRY_REPORTABLE_CODES`
4. Always reports to PostHog with the error code as a property

### Sentry tags

Error codes are now passed as Sentry tags (`errorCode`) on captured exceptions, making it possible to filter and alert on specific error categories in the Sentry dashboard.

## Commits (review in order)

1. **`add shared CliError class`** — introduces `CliError` in `@fern-api/task-context` with the code taxonomy, `shouldReportToSentry`, `resolveErrorCode`, and static factory methods
2. **`unify CLI v2 CliError`** — deletes CLI v2's local `CliError`, switches to shared one, introduces `reportError` in `withContext.ts`
3. **`clean up imports`** — mechanical import reordering for consistency
4. **`make error classes extend CliError`** — `ValidationError`, `SourcedValidationError`, `KeyringUnavailableError` now extend `CliError`
5. **`pass error code as Sentry tag`** — adds `errorCode` tag to `captureException` calls
6. **`remove LoggableFernCliError`** — replaces all usages with `CliError`, deletes the class

## Testing

- [x] Updated test helpers and mocks for new `CliError` / `MockTaskContext` signatures
- [x] Existing CLI v1 and v2 tests pass

<!-- devin-review-badge-begin -->

---

<a href="https://app.devin.ai/review/fern-api/fern/pull/14749" target="_blank">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1">
    <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open with Devin">
  </picture>
</a>
<!-- devin-review-badge-end -->
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-disable-uncategorized-sentry branch 2 times, most recently from b49bf53 to a00c1d7 Compare April 14, 2026 18:43
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 1c32ff6 to eaf55a4 Compare April 14, 2026 18:43
@FedeZara FedeZara changed the base branch from FedeZara/refactor/cli-error-disable-uncategorized-sentry to graphite-base/14753 April 14, 2026 18:51
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from eaf55a4 to 9b22813 Compare April 14, 2026 18:52
@FedeZara FedeZara force-pushed the graphite-base/14753 branch from a00c1d7 to 063113b Compare April 14, 2026 18:52
@graphite-app graphite-app Bot changed the base branch from graphite-base/14753 to main April 14, 2026 18:53
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 9b22813 to f975863 Compare April 14, 2026 18:53
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from f975863 to 6b5f2a3 Compare April 14, 2026 19:20
@FedeZara FedeZara force-pushed the FedeZara/refactor/cli-error-cli branch from 6b5f2a3 to 83da238 Compare April 14, 2026 19:23
@FedeZara FedeZara merged commit 29b6e6a into main Apr 14, 2026
58 checks passed
Copy link
Copy Markdown
Contributor Author

Merge activity

@FedeZara FedeZara deleted the FedeZara/refactor/cli-error-cli branch April 14, 2026 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants