
Error Handling Patterns
FreeRobust error handling for TypeScript, Python, and Go.
Free · Opens the source repo
What Error Handling Patterns does
The Error Handling Patterns skill provides a comprehensive framework for implementing consistent and robust error handling across applications written in TypeScript, Python, and Go. It covers essential patterns such as typed errors, error boundaries, retry logic, circuit breakers, and user-friendly error messages. This skill is particularly useful for developers looking to enhance the reliability and maintainability of their applications by adopting best practices in error management.
By utilizing this skill, developers can design error types and exception hierarchies that are tailored to their application's needs. It emphasizes the importance of surfacing errors early, using structured error types instead of simple strings, and ensuring that user-facing messages are distinct from developer logs. The provided code examples illustrate how to implement these patterns effectively, making it easier for developers to integrate them into their projects.
This skill is ideal for teams working on production applications who want to avoid silent errors and cascading failures. It helps in creating a clear contract for API errors, ensuring that clients are aware of the potential error codes they might encounter. With this skill, developers can implement robust error handling strategies that improve user experience and application reliability.
When to use it
Use this skill when designing error types for new modules, adding retry logic for unreliable dependencies, or reviewing error handling in API endpoints.
When not to use it
This skill may not be suitable for simple scripts or projects where error handling is not a critical concern.
What you can build with it
Designing Error Types
When creating a new module, use this skill to define a clear hierarchy of error types that suit your application's needs.
Implementing Retry Logic
Incorporate retry logic for unreliable external services to enhance the reliability of your application.
Reviewing API Error Handling
Use this skill to audit existing API endpoints for missing or inconsistent error handling.
How to install Error Handling Patterns
View source1. Install with the skills CLI
npx skills add affaan-m/ecc/error-handling --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by affaan-mエラー処理パターン
本番アプリケーション向けの一貫した堅牢なエラー処理パターン。
アクティベートするタイミング
- 新しいモジュールやサービスのエラー型や例外階層を設計する場合
- 信頼性の低い外部依存関係に対してリトライロジックやサーキットブレーカーを追加する場合
- APIエンドポイントでエラー処理の欠落をレビューする場合
- ユーザー向けエラーメッセージとフィードバックを実装する場合
- カスケード障害やサイレントなエラー飲み込みをデバッグする場合
コア原則
- 早く大きく失敗する — エラーが発生した境界で表面化させる。埋め込まない
- 文字列メッセージより型付きエラー — エラーは構造を持つファーストクラスの値
- ユーザーメッセージ ≠ 開発者メッセージ — ユーザーには親しみやすいテキストを表示し、詳細なコンテキストはサーバー側でログに記録する
- エラーをサイレントに飲み込まない — すべての
catchブロックは処理、再スロー、またはログのいずれかを行う必要がある - エラーはAPIコントラクトの一部 — クライアントが受け取る可能性があるすべてのエラーコードをドキュメント化する
TypeScript / JavaScript
型付きエラークラス
// ドメインのエラー階層を定義する
export class AppError extends Error {
constructor(
message: string,
public readonly code: string,
public readonly statusCode: number = 500,
public readonly details?: unknown,
) {
super(message)
this.name = this.constructor.name
// トランスパイルされたES5 JavaScriptでプロトタイプチェーンを正しく維持する。
// 組み込みのErrorクラスを拡張する際に`instanceof`チェック
// (例: `error instanceof NotFoundError`)が正しく動作するために必要。
Object.setPrototypeOf(this, new.target.prototype)
}
}
export class NotFoundError extends AppError {
constructor(resource: string, id: string) {
super(`${resource} not found: ${id}`, 'NOT_FOUND', 404)
}
}
export class ValidationError extends AppError {
constructor(message: string, details: { field: string; message: string }[]) {
super(message, 'VALIDATION_ERROR', 422, details)
}
}
export class UnauthorizedError extends AppError {
constructor(reason = 'Authentication required') {
super(reason, 'UNAUTHORIZED', 401)
}
}
export class RateLimitError extends AppError {
constructor(public readonly retryAfterMs: number) {
super('Rate limit exceeded', 'RATE_LIMITED', 429)
}
}
Resultパターン(スロー不使用スタイル)
失敗が想定され一般的な操作(パース、外部呼び出し)向け:
type Result<T, E = AppError> =
| { ok: true; value: T }
| { ok: false; error: E }
function ok<T>(value: T): Result<T> {
return { ok: true, value }
}
function err<E>(error: E): Result<never, E> {
return { ok: false, error }
}
// 使用例
async function fetchUser(id: string): Promise<Result<User>> {
try {
const user = await db.users.findUnique({ where: { id } })
if (!user) return err(new NotFoundError('User', id))
return ok(user)
} catch (e) {
return err(new AppError('Database error', 'DB_ERROR'))
}
}
const result = await fetchUser('abc-123')
if (!result.ok) {
// TypeScriptはここでresult.errorを認識する
logger.error('Failed to fetch user', { error: result.error })
return
}
// TypeScriptはここでresult.valueを認識する
console.log(result.value.email)
APIエラーハンドラー(Next.js / Express)
import { NextRequest, NextResponse } from 'next/server'
function handleApiError(error: unknown): NextResponse {
// 既知のアプリケーションエラー
if (error instanceof AppError) {
return NextResponse.json(
{
error: {
code: error.code,
message: error.message,
...(error.details ? { details: error.details } : {}),
},
},
{ status: error.statusCode },
)
}
// Zodバリデーションエラー
if (error instanceof z.ZodError) {
return NextResponse.json(
{
error: {
code: 'VALIDATION_ERROR',
message: 'Request validation failed',
details: error.issues.map(i => ({
field: i.path.join('.'),
message: i.message,
})),
},
},
{ status: 422 },
)
}
// 予期しないエラー — 詳細をログに記録し、汎用メッセージを返す
console.error('Unexpected error:', error)
return NextResponse.json(
{ error: { code: 'INTERNAL_ERROR', message: 'An unexpected error occurred' } },
{ status: 500 },
)
}
export async function POST(req: NextRequest) {
try {
// ... ハンドラーロジック
} catch (error) {
return handleApiError(error)
}
}
ReactエラーバウンダリーII
import { Component, ErrorInfo, ReactNode } from 'react'
interface Props {
fallback: ReactNode
onError?: (error: Error, info: ErrorInfo) => void
children: ReactNode
}
interface State {
hasError: boolean
error: Error | null
}
export class ErrorBoundary extends Component<Props, State> {
state: State = { hasError: false, error: null }
static getDerivedStateFromError(error: Error): State {
return { hasError: true, error }
}
componentDidCatch(error: Error, info: ErrorInfo) {
this.props.onError?.(error, info)
console.error('Unhandled React error:', error, info)
}
render() {
if (this.state.hasError) return this.props.fallback
return this.props.children
}
}
// 使用例
<ErrorBoundary fallback={<p>Something went wrong. Please refresh.</p>}>
<MyComponent />
</ErrorBoundary>
Python
カスタム例外階層
class AppError(Exception):
"""基底アプリケーションエラー。"""
def __init__(self, message: str, code: str, status_code: int = 500):
super().__init__(message)
self.code = code
self.status_code = status_code
class NotFoundError(AppError):
def __init__(self, resource: str, id: str):
super().__init__(f"{resource} not found: {id}", "NOT_FOUND", 404)
class ValidationError(AppError):
def __init__(self, message: str, details: list[dict] | None = None):
super().__init__(message, "VALIDATION_ERROR", 422)
self.details = details or []
FastAPIグローバル例外ハンドラー
from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse
app = FastAPI()
@app.exception_handler(AppError)
async def app_error_handler(request: Request, exc: AppError) -> JSONResponse:
return JSONResponse(
status_code=exc.status_code,
content={"error": {"code": exc.code, "message": str(exc)}},
)
@app.exception_handler(Exception)
async def generic_error_handler(request: Request, exc: Exception) -> JSONResponse:
# 詳細をログに記録し、汎用メッセージを返す
logger.exception("Unexpected error", exc_info=exc)
return JSONResponse(
status_code=500,
content={"error": {"code": "INTERNAL_ERROR", "message": "An unexpected error occurred"}},
)
Go
センチネルエラーとエラーラッピング
package domain
import "errors"
// 型チェック用センチネルエラー
var (
ErrNotFound = errors.New("not found")
ErrUnauthorized = errors.New("unauthorized")
ErrConflict = errors.New("conflict")
)
// コンテキスト付きでエラーをラップする — 元のエラーを失わない
func (r *UserRepository) FindByID(ctx context.Context, id string) (*User, error) {
user, err := r.db.QueryRow(ctx, "SELECT * FROM users WHERE id = $1", id)
if errors.Is(err, sql.ErrNoRows) {
return nil, fmt.Errorf("user %s: %w", id, ErrNotFound)
}
if err != nil {
return nil, fmt.Errorf("querying user %s: %w", id, err)
}
return user, nil
}
// ハンドラーレベルでアンラップしてレスポンスを決定する
func (h *Handler) GetUser(w http.ResponseWriter, r *http.Request) {
user, err := h.service.GetUser(r.Context(), chi.URLParam(r, "id"))
if err != nil {
switch {
case errors.Is(err, domain.ErrNotFound):
writeError(w, http.StatusNotFound, "not_found", err.Error())
case errors.Is(err, domain.ErrUnauthorized):
writeError(w, http.StatusForbidden, "forbidden", "Access denied")
default:
slog.Error("unexpected error", "err", err)
writeError(w, http.StatusInternalServerError, "internal_error", "An unexpected error occurred")
}
return
}
writeJSON(w, http.StatusOK, user)
}
指数バックオフ付きリトライ
interface RetryOptions {
maxAttempts?: number
baseDelayMs?: number
maxDelayMs?: number
retryIf?: (error: unknown) => boolean
}
async function withRetry<T>(
fn: () => Promise<T>,
options: RetryOptions = {},
): Promise<T> {
const {
maxAttempts = 3,
baseDelayMs = 500,
maxDelayMs = 10_000,
retryIf = () => true,
} = options
let lastError: unknown
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
try {
return await fn()
} catch (error) {
lastError = error
if (attempt === maxAttempts || !retryIf(error)) throw error
const jitter = Math.random() * baseDelayMs
const delay = Math.min(baseDelayMs * 2 ** (attempt - 1) + jitter, maxDelayMs)
await new Promise(resolve => setTimeout(resolve, delay))
}
}
throw lastError
}
// 使用例: 一時的なネットワークエラーはリトライ、4xxはリトライしない
const data = await withRetry(() => fetch('/api/data').then(r => r.json()), {
maxAttempts: 3,
retryIf: (error) => !(error instanceof AppError && error.statusCode < 500),
})
ユーザー向けエラーメッセージ
エラーコードを人間が読めるメッセージにマッピングする。技術的な詳細はユーザーに見えるテキストに含めない。
const USER_ERROR_MESSAGES: Record<string, string> = {
NOT_FOUND: 'The requested item could not be found.',
UNAUTHORIZED: 'Please sign in to continue.',
FORBIDDEN: "You don't have permission to do that.",
VALIDATION_ERROR: 'Please check your input and try again.',
RATE_LIMITED: 'Too many requests. Please wait a moment and try again.',
INTERNAL_ERROR: 'Something went wrong on our end. Please try again later.',
}
export function getUserMessage(code: string): string {
return USER_ERROR_MESSAGES[code] ?? USER_ERROR_MESSAGES.INTERNAL_ERROR
}
エラー処理チェックリスト
エラー処理に触れるコードをマージする前に:
- すべての
catchブロックが処理、再スロー、またはログを行っている — サイレントな飲み込みなし - APIエラーが標準エンベロープ
{ error: { code, message } }に従っている - ユーザー向けメッセージにスタックトレースや内部詳細が含まれていない
- サーバー側で完全なエラーコンテキストがログに記録されている
- カスタムエラークラスが
codeフィールドを持つ基底AppErrorを継承している - 非同期関数がエラーを呼び出し元に伝播している — フォールバックなしの fire-and-forget なし
- リトライロジックがリトライ可能なエラーのみをリトライしている(4xxクライアントエラーはリトライしない)
- Reactコンポーネントがレンダリングエラーのために
ErrorBoundaryでラップされている
Frequently asked questions about Error Handling Patterns
Similar skills
Python PyPI Package Builder
Streamline the process of creating and publishing Python packages.
Minecraft Plugin Development
Streamline your Minecraft server plugin creation.
MCP Server Builder
Easily build .NET MCP servers with the latest standards.
CommunityToolkit.Mvvm Messenger
Decoupled communication for ViewModels in .NET applications.
MVVM Toolkit DI
Streamline ViewModel integration with Dependency Injection in .NET.
MCP Apps Builder
Essential guidelines for MCP server development.
