# 通知設計書 38-Failed to create worktree

## 概要

本ドキュメントは、OpenCodeアプリケーションにおける「Failed to create worktree（ワークツリー作成失敗）」トースト通知の設計仕様を定義する。

### 本通知の処理概要

新しいワークスペース（Gitワークツリー）の作成が失敗した際に、ユーザーに対してエラー情報をトースト通知で表示する機能である。

**業務上の目的・背景**：OpenCodeでは、新しいセッションを開始する際に「新しいワークスペースで開始」オプションを選択できる。このオプションを選択すると、バックエンドでGitのworktreeを新規作成し、そのワークスペース内でセッションを実行する。worktreeの作成は、ディスク容量不足、Git設定の問題、権限エラー、同名ワークツリーの存在など様々な理由で失敗する可能性がある。この通知により、ユーザーはワークスペースの作成が失敗したことを認識し、既存のワークスペースを使用するか、問題を解決してから再試行することができる。

**通知の送信タイミング**：ユーザーが「Create new workspace」オプションを選択してプロンプトを送信し、バックエンドAPI（`worktree.create`）の呼び出しが失敗した時点で通知が発生する。また、APIは成功したがディレクトリが返されなかった場合も通知される。

**通知の受信者**：プロンプト送信を試みたユーザー本人のみが受信する。アプリ内のトースト通知であり、外部への送信は行わない。

**通知内容の概要**：タイトルとして「Failed to create worktree」（日本語：「ワークツリーの作成に失敗しました」）が表示され、説明文としてエラーの詳細メッセージ（APIから返却されたエラーメッセージ、または汎用の「Request failed」メッセージ）が表示される。

**期待されるアクション**：ユーザーはエラー内容を確認し、既存のワークスペースを使用するか、問題（ディスク容量、Git設定など）を解決してから再度プロンプト送信を試みる。

## 通知種別

トースト通知（アプリ内通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッド上で即時表示） |
| 優先度 | 中 |
| リトライ | 無し（UIトーストのため） |

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

操作を実行したユーザーのブラウザ/デスクトップアプリ画面に表示される。特別な送信先決定ロジックは不要。

## 通知テンプレート

### トースト通知の場合

| 項目 | 内容 |
|-----|------|
| バリアント | default |
| アイコン | なし |
| 持続性 | 非持続（自動消去） |

### 本文テンプレート

```
タイトル: Failed to create worktree
説明: {エラーメッセージ}
```

日本語の場合:
```
タイトル: ワークツリーの作成に失敗しました
説明: {エラーメッセージ}
```

### 添付ファイル

なし（トースト通知のため添付ファイルは非対応）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 通知タイトル | i18n: `prompt.toast.worktreeCreateFailed.title` | Yes |
| description | エラー詳細 | APIエラーレスポンス または `common.requestFailed` | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | プロンプト送信（新ワークスペースオプション選択時） | API失敗またはディレクトリ未取得 | `worktree.create` APIが失敗、または結果にディレクトリがない場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| worktreeSelection !== "create" | 新しいワークスペース作成を選択していない場合は処理されない |
| API成功かつディレクトリあり | worktree作成が成功した場合は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがプロンプト送信を実行] --> B{worktreeSelection === "create"?}
    B -->|No| C[既存ワークスペース使用]
    B -->|Yes| D[worktree.create API呼び出し]
    D --> E{API結果}
    E -->|成功| F{directory取得成功?}
    E -->|失敗 - catch| G[showToast - エラー通知1]
    F -->|Yes| H[正常処理へ - セッション作成]
    F -->|No| I[showToast - エラー通知2]
    G --> J[return - 処理中断]
    I --> J
    C --> K[終了]
    H --> K
    J --> K
```

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

### 参照テーブル一覧

本通知はフロントエンド側のUI通知であり、直接的なデータベース参照は行わない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | バックエンドのworktree作成処理がGit操作を行う |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| N/A | - | 通知表示自体はデータベース更新を伴わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API例外 | worktree.createのcatchブロック | エラーメッセージを表示、undefined返却 |
| ディレクトリ未取得 | createdWorktree?.directoryがfalsy | 汎用エラーメッセージを表示 |
| ディスク容量不足 | バックエンドでのGit操作失敗 | エラーメッセージを表示 |
| 権限エラー | ファイルシステム権限不足 | エラーメッセージを表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（ユーザー操作に応じて即時表示）

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

- エラーメッセージにはファイルパス情報が含まれる可能性があるが、ユーザー本人の操作に対する結果表示のため問題なし
- サーバー内部のスタックトレースなど詳細なシステム情報は表示しない

## 備考

- worktreeSelection の値:
  - `"main"`: メインワークスペース使用
  - `"create"`: 新しいワークスペース作成（本通知の対象）
  - その他: 既存のワークスペースディレクトリパス
- 通知後は `return` で処理が中断され、プロンプトは送信されない

---

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

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

### 推奨読解順序

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

プロンプト送信処理のworktree選択オプションを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | submit.ts | `packages/app/src/components/prompt-input/submit.ts` | input.newSessionWorktree の使用（143行目） |
| 1-2 | en.ts | `packages/app/src/i18n/en.ts` | 282行目の `prompt.toast.worktreeCreateFailed.title` キーを確認 |

**読解のコツ**: `worktreeSelection` は `"main"`、`"create"`、または既存ワークスペースのディレクトリパスの3種類の値を取る。

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

プロンプト送信処理のworktree作成部分を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | submit.ts | `packages/app/src/components/prompt-input/submit.ts` | handleSubmit関数内のworktree作成処理（148-170行目） |

**主要処理フロー**:
1. **148行目**: `isNewSession` かつ `worktreeSelection === "create"` のチェック
2. **149行目**: `worktreeSelection === "create"` の場合の分岐
3. **150-159行目**: worktree.create API呼び出しとcatchブロック
4. **154-158行目**: **catchブロック内のshowToast呼び出し（エラー通知1）**
5. **161-166行目**: **ディレクトリ未取得時のshowToast呼び出し（エラー通知2）**

#### Step 3: エラーメッセージ処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | submit.ts | `packages/app/src/components/prompt-input/submit.ts` | errorMessage関数（64-71行目） |

**主要処理フロー**:
- **65-68行目**: APIエラーレスポンスからメッセージ抽出
- **69行目**: Errorオブジェクトのmessage使用
- **70行目**: フォールバックとして `common.requestFailed` 使用

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

```
submit.ts::createPromptSubmit()
    │
    └─ handleSubmit(event)
           │
           ├─ [isNewSession && worktreeSelection === "create"]
           │      │
           │      └─ client.worktree.create()
           │             │
           │             ├─ catch(err)
           │             │      └─ showToast({
           │             │             title: "prompt.toast.worktreeCreateFailed.title",
           │             │             description: errorMessage(err)
           │             │         })
           │             │         return undefined
           │             │
           │             └─ [createdWorktree?.directory がfalsyの場合]
           │                    └─ showToast({
           │                           title: "prompt.toast.worktreeCreateFailed.title",
           │                           description: "common.requestFailed"
           │                       })
           │                       return
           │
           └─ [成功時] sessionDirectory = createdWorktree.directory
```

### データフロー図

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

プロンプト送信          handleSubmit関数                 エラートースト通知
(create選択) ───▶    worktree.create API ───▶    [失敗時] showToast()
                            │                    「Failed to create worktree」
                            │
                      [成功 & directory なし]
                            │
                            ▼
                      showToast()
                      「Failed to create worktree」
                      "Request failed"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| submit.ts | `packages/app/src/components/prompt-input/submit.ts` | ソース | プロンプト送信処理とworktree作成 |
| toast.tsx | `packages/ui/src/components/toast.tsx` | ソース | showToast関数 |
| en.ts | `packages/app/src/i18n/en.ts` | 設定 | 英語の国際化メッセージ定義 |
| ja.ts | `packages/app/src/i18n/ja.ts` | 設定 | 日本語の国際化メッセージ定義 |
