# 通知設計書 37-base64 encode error

## 概要

本ドキュメントは、CoffeeScriptコンパイラでインラインソースマップのBase64エンコードに失敗した場合に発生するエラー通知「base64 encode error」の設計仕様を記載する。

### 本通知の処理概要

CoffeeScriptのコンパイル処理で`--inline-map`オプションを使用した際、ソースマップをBase64エンコードしてJavaScript出力に埋め込む処理がある。この処理でNode.jsの`Buffer`クラスもブラウザの`btoa`関数も利用できない環境で実行された場合に、エラーをスローする通知機能である。

**業務上の目的・背景**：インラインソースマップは、ソースマップを別ファイルではなくJavaScriptファイル内にData URIとして埋め込む機能である。この埋め込みにはBase64エンコードが必要だが、特殊な実行環境ではエンコード機能が利用できない場合がある。このエラー通知により、ユーザーは環境の制約を認識し、別の方法（外部ソースマップファイル）を選択できる。

**通知の送信タイミング**：`compile`関数内で`base64encode`ヘルパー関数が呼び出された際、`Buffer`も`btoa`も利用できない場合にErrorがスローされる。

**通知の受信者**：CoffeeScriptコンパイラを実行しているアプリケーションまたは開発者。例外としてスローされるため、呼び出し元でキャッチされない場合はプロセスがクラッシュする。

**通知内容の概要**：「Unable to base64 encode inline sourcemap.」という固定メッセージのErrorオブジェクトがスローされる。

**期待されるアクション**：ユーザーは以下のいずれかの対応を行うことが期待される：
1. Node.js環境で実行する（Bufferが利用可能）
2. ブラウザ環境で実行する（btoaが利用可能）
3. `--map`オプションを使用して外部ソースマップファイルを生成する
4. ソースマップ機能を使用しない

## 通知種別

例外スロー（Errorオブジェクト）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（throw） |
| 優先度 | 高 |
| リトライ | 無し |

### 送信先決定ロジック

例外としてスローされるため、呼び出し元のtry-catchで捕捉される。CLIからの実行の場合は最終的にprocess.exit(1)で終了する。

## 通知テンプレート

### 例外の場合

| 項目 | 内容 |
|-----|------|
| 型 | Error |
| 形式 | テキスト |

### 本文テンプレート

```
Unable to base64 encode inline sourcemap.
```

### 添付ファイル

なし

## テンプレート変数

なし（固定メッセージ）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | base64encode関数のswitch default | Buffer も btoa も undefined | エンコード機能なし |

### 前提条件

| 条件 | 説明 |
|-----|------|
| options.inlineMap === true | --inline-mapオプションが指定されている |

### 環境判定ロジック

| 条件 | 判定方法 | 結果 |
|-----|---------|------|
| Node.js環境 | `typeof Buffer is 'function'` | Buffer.from().toString('base64')を使用 |
| ブラウザ環境 | `typeof btoa is 'function'` | btoaを使用（UTF-8対応処理付き） |
| その他環境 | 上記以外 | Errorをスロー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Buffer利用可能 | Node.js環境で正常にエンコード |
| btoa利用可能 | ブラウザ環境で正常にエンコード |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[compile with inlineMap] --> B[base64encode関数呼び出し]
    B --> C{typeof Buffer is function?}
    C -->|Yes| D[Buffer.from src .toString base64]
    C -->|No| E{typeof btoa is function?}
    E -->|Yes| F[btoa with UTF-8 encoding]
    E -->|No| G[throw new Error Unable to base64 encode...]
    D --> H[正常終了]
    F --> H
```

## データベース参照・更新仕様

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 環境不適合 | BufferもbtoaもuseできないJS環境 | Errorをスロー |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

なし（コンパイル処理ごとに発生）

### 配信時間帯

制限なし

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

- 固定メッセージのため、機密情報の漏洩リスクはない
- このエラーは実行環境の機能制約を示すものであり、セキュリティ上の問題ではない

## 備考

- ブラウザ環境でのbtoa使用時は、UTF-16エンコーディングの制限を回避するためにencodeURIComponentを使用した変換が行われる
- このエラーは理論上の環境（BufferもbtoaもないJavaScript環境）でのみ発生し、通常のNode.jsやブラウザでは発生しない
- `--inline-map`オプションを使用しない場合（`--map`のみ）、このエラーは発生しない

---

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

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

### 推奨読解順序

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

Base64エンコード関連の処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | coffeescript.coffee | `src/coffeescript.coffee` | base64encode関数（29-40行目）を確認 |

**読解のコツ**: switch文で環境判定を行い、適切なエンコード方法を選択していることを理解する。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | coffeescript.coffee | `src/coffeescript.coffee` | compile関数（62-180行目）でinlineMap処理を確認 |
| 2-2 | coffeescript.coffee | `src/coffeescript.coffee` | 165-169行目でbase64encode呼び出しを確認 |

**主要処理フロー**:
1. **165行目**: `if options.inlineMap`でインラインマップ処理開始
2. **166行目**: `encoded = base64encode JSON.stringify v3SourceMap`
3. **167行目**: `sourceMapDataURI`の生成
4. **169行目**: JavaScriptにソースマップを埋め込み

#### Step 3: Base64エンコード処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | coffeescript.coffee | `src/coffeescript.coffee` | base64encode関数（29-40行目）の環境判定ロジック |

**主要処理フロー**:
- **29行目**: `base64encode = (src) -> switch`
- **30-31行目**: Node.js環境（Buffer使用）
- **32-38行目**: ブラウザ環境（btoa使用、UTF-8対応）
- **39-40行目**: その他環境（Errorスロー）

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

```
compile (coffeescript.coffee:62)
    │
    └─ [options.inlineMap === true]
           │
           └─ base64encode (coffeescript.coffee:29)
                  │
                  ├─ [Buffer available] → Buffer.from().toString('base64')
                  │
                  ├─ [btoa available] → btoa(encodeURIComponent())
                  │
                  └─ [neither] → throw new Error('Unable to base64 encode...')
```

### データフロー図

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

v3SourceMap ───▶ JSON.stringify() ───▶ base64encode()
                                              │
                              ┌───────────────┼───────────────┐
                              │               │               │
                              ▼               ▼               ▼
                         [Node.js]      [Browser]       [Other]
                              │               │               │
                              ▼               ▼               ▼
                        Buffer.from()    btoa()        throw Error
                              │               │
                              └───────┬───────┘
                                      ▼
                              Base64文字列
                                      │
                                      ▼
                              Data URI生成
                                      │
                                      ▼
                              JS出力に埋め込み
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| coffeescript.coffee | `src/coffeescript.coffee` | ソース | コンパイル処理、Base64エンコード |
| command.coffee | `src/command.coffee` | ソース | --inline-mapオプション処理 |
