# 機能設計書 49-@jest/create-cache-key-function

## 概要

本ドキュメントは、@jest/create-cache-key-functionパッケージの機能設計について記載する。このパッケージは、トランスフォーマー用のキャッシュキー生成関数を提供する。

### 本機能の処理概要

@jest/create-cache-key-functionは、Jestのコード変換（トランスフォーム）処理においてキャッシュキーを生成するための関数を提供する。このキャッシュキーは、変換結果をキャッシュする際の一意識別子として使用される。

**業務上の目的・背景**：Jestは、テスト実行のパフォーマンスを向上させるために、トランスパイルされたコードをキャッシュする。しかし、ソースコードやトランスフォーマーの設定が変更された場合、キャッシュを無効化して再変換する必要がある。@jest/create-cache-key-functionは、ソースコード、トランスフォーマー、設定などの要素からキャッシュキーを生成し、適切なキャッシュ管理を実現する。

**機能の利用シーン**：カスタムトランスフォーマーを作成する際に、getCacheKey関数の実装に使用される。babel-jestやts-jestなどのトランスフォーマーで活用される。

**主要な処理内容**：
1. createCacheKey: キャッシュキー生成関数を作成するファクトリ関数
2. getGlobalCacheKey: 環境変数とファイル内容からグローバルキャッシュキーを生成
3. getCacheKeyFunction: ソースコード固有のキャッシュキーを生成する関数を返却
4. SHA-1ハッシュ: crypto.createHashを使用してハッシュを計算

**関連システム・外部連携**：Node.jsのcryptoモジュール（SHA-1ハッシュ）、fs（ファイル読み込み）、@jest/typesを使用。

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

## 関連画面

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

## 機能種別

キャッシュ管理 / ハッシュ生成

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| files | Array<string> | No | キャッシュキーに含めるファイルパス | 有効なファイルパス |
| values | Array<string> | No | キャッシュキーに含める値 | - |
| length | number | No | キャッシュキーの長さ（デフォルト: 32、Windowsは16） | - |
| sourceText | string | Yes | ソースコード | - |
| sourcePath | string | Yes | ソースファイルパス | - |
| options | TransformOptions | Yes | 変換オプション（config、instrument等） | - |

### 入力データソース

- トランスフォーマー設定ファイル
- ソースコード
- 環境変数（NODE_ENV、BABEL_ENV）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| getCacheKey | function | キャッシュキー生成関数 |
| cacheKey | string | 生成されたキャッシュキー（16進数文字列） |

### 出力先

- 呼び出し元への戻り値

## 処理フロー

### 処理シーケンス

```
1. createCacheKey呼び出し
   └─ files、values、lengthを受け取る
2. getGlobalCacheKey生成
   └─ NODE_ENV、BABEL_ENV、values、filesの内容をSHA-1でハッシュ
3. getCacheKeyFunction返却
   └─ クロージャでglobalCacheKeyを保持
4. getCacheKey呼び出し（変換時）
   └─ globalCacheKey + sourceText + sourcePath + instrumentフラグをSHA-1でハッシュ
5. キャッシュキー返却
   └─ 指定長のhex文字列を返却
```

### フローチャート

```mermaid
flowchart TD
    A[createCacheKey呼び出し] --> B[getGlobalCacheKey]
    B --> C[SHA-1ハッシュ作成]
    C --> D[NODE_ENV追加]
    D --> E[BABEL_ENV追加]
    E --> F[values追加]
    F --> G[files内容追加]
    G --> H[ダイジェスト生成]
    H --> I[getCacheKeyFunction返却]
    I --> J[getCacheKey呼び出し]
    J --> K[SHA-1ハッシュ作成]
    K --> L[globalCacheKey追加]
    L --> M[sourceText追加]
    M --> N[relativePath追加]
    N --> O[instrumentフラグ追加]
    O --> P[ダイジェスト生成]
    P --> Q[cacheKey返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-49-01 | デフォルト長 | Windowsは16、それ以外は32 | length未指定時 |
| BR-49-02 | 相対パス使用 | rootDirがある場合、sourcePathを相対パスに変換 | キャッシュキー生成時 |
| BR-49-03 | ヌル区切り | 各要素間に\0を挿入してハッシュに追加 | ハッシュ計算時 |
| BR-49-04 | Jest 27互換 | 旧APIと新APIの両方をサポート | 常時 |

### 計算ロジック

キャッシュキー計算:
```
globalCacheKey = sha1(NODE_ENV + \0 + BABEL_ENV + \0 + ...values + \0 + ...files内容)

cacheKey = sha1(globalCacheKey + \0 + sourceText + \0 + relativePath + \0 + instrument?)
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | ファイル読み込み失敗 | 有効なファイルパスを指定 |

### リトライ仕様

該当なし

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

該当なし

## パフォーマンス要件

- ハッシュ計算: ミリ秒単位

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

- ファイルシステムからファイルを読み込むため、信頼できるパスのみを使用

## 備考

- SHA-1を使用（暗号学的な強度は不要、高速性を重視）
- Windowsでは短いキー長を使用（ファイルパス長の制限に対応）

---

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

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

### 推奨読解順序

#### Step 1: 型定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | index.ts | `packages/jest-create-cache-key-function/src/index.ts` | 型定義（14-41行目） |

**読解のコツ**: OldCacheKeyOptionsとNewCacheKeyOptionsの違いを理解。Jest 27で引数形式が変更された。

#### Step 2: getGlobalCacheKeyを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.ts | `packages/jest-create-cache-key-function/src/index.ts` | グローバルキー生成（45-62行目） |

**主要処理フロー**:
- **43行目**: NODE_ENV、BABEL_ENVを取得
- **50-55行目**: 各要素を\0区切りでハッシュに追加
- **58-61行目**: ダイジェスト生成とslice

#### Step 3: getCacheKeyFunctionを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.ts | `packages/jest-create-cache-key-function/src/index.ts` | キャッシュキー関数生成（64-85行目） |

**主要処理フロー**:
- **68-71行目**: Jest 27互換 - configStringとoptionsの両対応
- **74-83行目**: SHA-1ハッシュ計算
- **79行目**: rootDir相対パスの使用

#### Step 4: createCacheKeyを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | index.ts | `packages/jest-create-cache-key-function/src/index.ts` | メインファクトリ関数（87-102行目） |

**主要処理フロー**:
- **95-98行目**: JSDocコメント - パラメータ説明
- **100行目**: getCacheKeyFunctionを呼び出して返却

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

```
createCacheKey(files?, values?, length?)
    │
    └─ getCacheKeyFunction(globalCacheKey, length)
           │
           ├─ getGlobalCacheKey(files, values, length)
           │      │
           │      ├─ createHash('sha1')
           │      ├─ hash.update(NODE_ENV)
           │      ├─ hash.update(BABEL_ENV)
           │      ├─ hash.update(...values)
           │      ├─ hash.update(...readFileSync(files))
           │      └─ hash.digest('hex').slice(0, length)
           │
           └─ 返却: (sourceText, sourcePath, options) => {
                  │
                  ├─ createHash('sha1')
                  ├─ hash.update(globalCacheKey)
                  ├─ hash.update(sourceText)
                  ├─ hash.update(relative(rootDir, sourcePath))
                  ├─ hash.update(instrument ? 'instrument' : '')
                  └─ hash.digest('hex').slice(0, length)
              }
```

### データフロー図

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

files[] ──────────────────┐
values[] ─────────────────┼──▶ getGlobalCacheKey ───────▶ globalCacheKey
NODE_ENV/BABEL_ENV ───────┘         │
                                    └─ SHA-1ハッシュ

globalCacheKey ───────────┐
sourceText ───────────────┼──▶ getCacheKey ─────────────▶ cacheKey
sourcePath ───────────────┤         │
options.instrument ───────┘         └─ SHA-1ハッシュ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.ts | `packages/jest-create-cache-key-function/src/index.ts` | ソース | メイン処理 |
| __tests__/index.test.ts | `packages/jest-create-cache-key-function/src/__tests__/index.test.ts` | テスト | ユニットテスト |
