# 機能設計書 45-@jest/source-map

## 概要

本ドキュメントは、@jest/source-mapパッケージの機能設計について記載する。@jest/source-mapは、ソースマップの処理機能を提供し、スタックトレースの元ソース位置への変換を行う。

### 本機能の処理概要

@jest/source-mapは、トランスパイルされたコードのスタックトレースを元のソースコードの位置にマッピングする機能を提供する。これにより、TypeScriptやBabelでトランスパイルされたコードのエラー位置を正確に特定できる。

**業務上の目的・背景**：モダンなJavaScript/TypeScript開発では、ソースコードはBabelやTypeScriptコンパイラによってトランスパイルされる。エラーが発生した際、トランスパイル後のコードの行番号ではなく、元のソースコードの行番号を表示することで、デバッグが容易になる。@jest/source-mapは、この変換を透過的に行い、開発者体験を向上させる。

**機能の利用シーン**：テスト実行時にエラーが発生した際、スタックトレースの行番号を元のソースコードの位置に変換するために使用される。jest-message-utilパッケージと連携してエラーメッセージを整形する際に活用される。

**主要な処理内容**：
1. getCallsite: コールスタックから特定レベルの呼び出し位置を取得
2. ソースマップ読み込み: ソースマップファイルを読み込みパース
3. 位置変換: @jridgewell/trace-mappingを使用してトランスパイル後の位置を元の位置に変換
4. callsitesライブラリ: V8のスタックトレースAPIをラップして呼び出し位置を取得

**関連システム・外部連携**：@jridgewell/trace-mappingパッケージ（ソースマップ解析）、callsitesパッケージ（コールスタック取得）、graceful-fs（ファイル読み込み）を使用。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLIのみで使用される機能のため関連画面なし |

## 機能種別

ソースマップ処理 / 位置変換

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| level | number | Yes | 取得するスタックの深さ（0が現在の関数） | 0以上 |
| sourceMaps | SourceMapRegistry \| null | No | ソースマップファイルパスのマップ | - |

### 入力データソース

- コールスタック（V8 API）
- ソースマップファイル（.map）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| callsite | CallSite | 呼び出し位置情報（行番号、列番号、ファイル名等） |

### 出力先

- 呼び出し元への戻り値

## 処理フロー

### 処理シーケンス

```
1. getCallsite呼び出し
   └─ levelとsourceMapsを受け取る
2. コールスタック取得
   └─ callsites()でスタック配列を取得
3. 対象レベルのCallSite取得
   └─ level + 1（自身を除く）のインデックスで取得
4. ソースマップ検索
   └─ ファイル名からソースマップパスを取得
5. ソースマップ読み込み
   └─ readFileSyncでソースマップJSONを読み込み
6. TraceMap作成
   └─ @jridgewell/trace-mappingでパース
7. CallSiteの拡張
   └─ getLineNumber/getColumnNumberを元の位置に置き換え
8. 結果返却
   └─ 拡張されたCallSiteを返却
```

### フローチャート

```mermaid
flowchart TD
    A[getCallsite開始] --> B[callsites取得]
    B --> C[levelでCallSite選択]
    C --> D{sourceMaps存在?}
    D -->|Yes| E[ソースマップパス検索]
    E --> F{パス見つかった?}
    F -->|Yes| G[ソースマップ読み込み]
    G --> H[TraceMap作成]
    H --> I[addSourceMapConsumer実行]
    I --> J[CallSite拡張]
    F -->|No| K[そのまま返却]
    D -->|No| K
    J --> K
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-45-01 | レベル調整 | 実際のlevelはlevel + 1（getCallsite自身を除外） | 常時 |
| BR-45-02 | フォールバック | ソースマップで位置が取得できない場合、元の値を使用 | 変換失敗時 |
| BR-45-03 | エラー無視 | ソースマップ読み込みエラーは無視して続行 | try-catch |

### 計算ロジック

位置変換ロジック:
```
position = originalPositionFor(tracer, {
  column: getColumnNumber() ?? -1,
  line: getLineNumber() ?? -1
})

// positionが有効な場合のみ使用、そうでなければ元の値
return position.line ?? getLineNumber()
return position.column ?? getColumnNumber()
```

## データベース操作仕様

### 操作別データベース影響一覧

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 無視 | ソースマップファイル読み込み失敗 | 元の位置情報を使用 |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

- ソースマップ読み込み: 数ミリ秒〜数十ミリ秒
- 位置変換: ミリ秒以下

## セキュリティ考慮事項

- ファイルシステムからソースマップを読み込むため、信頼できるパスのみを使用する必要がある

## 備考

- @jridgewell/trace-mappingは高速なソースマップ解析ライブラリ
- callsitesパッケージはV8のprepareStackTraceをフックしてCallSiteオブジェクトを取得

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

ソースマップレジストリの型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.ts | `packages/jest-source-map/src/types.ts` | SourceMapRegistry型（Map<string, string>） |

**読解のコツ**: SourceMapRegistryはファイルパスからソースマップパスへのマッピング。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/jest-source-map/src/index.ts` | エクスポート構造 |

**主要処理フロー**:
- **8行目**: getCallsiteをエクスポート
- **9行目**: SourceMapRegistry型をエクスポート

#### Step 3: getCallsite関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | getCallsite.ts | `packages/jest-source-map/src/getCallsite.ts` | メイン処理ロジック |

**主要処理フロー**:
1. **50-56行目**: getCallsite関数 - levelとsourceMapsを受け取る
2. **54行目**: level + 1でcallsites()から対象スタックを取得
3. **56行目**: ファイル名からソースマップパスを検索
4. **58-64行目**: ソースマップを読み込みaddSourceMapConsumerを呼び出し

#### Step 4: addSourceMapConsumer関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | getCallsite.ts | `packages/jest-source-map/src/getCallsite.ts` | CallSite拡張ロジック |

**主要処理フロー**:
- **14-17行目**: addSourceMapConsumer - callsiteとtracerを受け取る
- **18-19行目**: getLineNumber/getColumnNumberをバインド
- **22-28行目**: getPosition - originalPositionForで元の位置を取得
- **31-47行目**: Object.definePropertiesでgetLineNumber/getColumnNumberを上書き

### プログラム呼び出し階層図

```
getCallsite(level, sourceMaps)
    │
    ├─ callsites() → スタック配列取得
    │
    ├─ sourceMaps?.get(fileName) → ソースマップパス取得
    │
    └─ (ソースマップがある場合)
           ├─ readFileSync(sourceMapFileName) → ソースマップJSON読み込み
           │
           └─ addSourceMapConsumer(stack, new TraceMap(sourceMap))
                  │
                  ├─ originalPositionFor(tracer, {line, column})
                  │
                  └─ Object.defineProperties(callsite, {...})
                         ├─ getLineNumber: () => position.line
                         └─ getColumnNumber: () => position.column
```

### データフロー図

```
[入力]                    [処理]                         [出力]

level ───────────────────▶ callsites()[level + 1] ──────▶ CallSite

sourceMaps ──────────────▶ sourceMaps.get(fileName) ───▶ sourceMapPath
                              │
                              ▼
                         readFileSync(sourceMapPath)
                              │
                              ▼
                         new TraceMap(sourceMap)
                              │
                              ▼
                         originalPositionFor()
                              │
                              ▼
                         拡張されたCallSite ─────────────▶ callsites.CallSite
                         (getLineNumber, getColumnNumber)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/jest-source-map/src/index.ts` | ソース | エントリーポイント |
| types.ts | `packages/jest-source-map/src/types.ts` | ソース | 型定義 |
| getCallsite.ts | `packages/jest-source-map/src/getCallsite.ts` | ソース | メイン処理 |
| __tests__/getCallsite.test.ts | `packages/jest-source-map/src/__tests__/getCallsite.test.ts` | テスト | ユニットテスト |
