# 通知設計書 30-Failed to create workspace

## 概要

本ドキュメントは、OpenCodeアプリケーションにおける「Failed to create workspace」トースト通知の設計を定義する。

### 本通知の処理概要

この通知は、ワークスペース（worktree）の作成に失敗した場合に表示されるエラー通知である。

**業務上の目的・背景**：OpenCodeはGitのworktree機能を活用して、複数のブランチを同時に作業できるワークスペース機能を提供している。ワークスペース作成はファイルシステム操作やGit操作を伴うため、ディスク容量不足やGitエラー等により失敗する可能性がある。失敗時にエラーを通知することで、ユーザーは問題を認識し、対処できる。

**通知の送信タイミング**：サイドバーからワークスペース作成を実行し、`globalSDK.client.worktree.create`のPromiseがrejectされた場合に表示される。

**通知の受信者**：ワークスペース作成を試みたユーザー本人。

**通知内容の概要**：「Failed to create workspace」というタイトルと、エラーメッセージを含む説明文が表示される。

**期待されるアクション**：ユーザーは通知を確認し、ディスク容量の確認やGitの状態を確認した上で再試行する。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッドで即時表示） |
| 優先度 | 高 |
| リトライ | なし（通知のリトライなし、操作は手動で再試行） |

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

現在アクティブなアプリケーションウィンドウ内でトースト通知として表示。ワークスペース作成を試みたユーザーに対してのみ表示。

## 通知テンプレート

### トースト通知

| 項目 | 内容 |
|-----|------|
| タイトル | `workspace.create.failed.title` |
| 説明 | エラーメッセージ（動的） |
| アイコン | なし（デフォルト） |
| バリアント | default |

### 本文テンプレート

```
タイトル: Failed to create workspace
説明: {{errorMessage}}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| errorMessage | エラーの詳細メッセージ | `errorMessage(err, language.t("common.requestFailed"))` | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムエラー | worktree.create API失敗 | catchブロック実行時 | ワークスペース作成失敗 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 作成成功 | worktree.createが正常終了した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ワークスペース作成操作] --> B[clearSidebarHoverState]
    B --> C[globalSDK.client.worktree.create呼び出し]
    C --> D{成功?}
    D -->|成功| E[setWorkspaceName]
    E --> F[setBusy / WorktreeState.pending]
    F --> G[setStore workspaceExpanded]
    G --> H[終了]
    D -->|失敗| I[showToastエラー通知]
    I --> J[return undefined]
    J --> H
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | なし | クライアントサイド処理のみ |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | なし | ファイルシステム操作のみ、失敗時は更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ディスク容量不足 | worktree作成に必要な容量がない | エラーメッセージを表示し、ディスク整理を促す |
| Gitエラー | ブランチ競合やロックファイル等 | エラーメッセージを表示し、Git状態の確認を促す |
| 権限エラー | ディレクトリへの書き込み権限がない | エラーメッセージを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間表示可能）

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

- エラーメッセージにはファイルパスが含まれる可能性があるが、これはローカルパスのため問題なし
- 認証情報等は含まない

## 備考

- 国際化対応（i18n）済み（タイトルのみ、説明はエラーメッセージそのまま）
- 日本語: タイトル「ワークスペースの作成に失敗しました」
- 失敗時はundefinedを返し、後続の処理は実行されない
- エラーメッセージが取得できない場合は`common.requestFailed`がフォールバックとして使用される

---

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

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

### 推奨読解順序

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

ワークスペース作成のレスポンスを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | createWorkspace関数の戻り値の型 |

**読解のコツ**: worktree.createはdirectoryとbranchを含むオブジェクトを返す。

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

通知がトリガーされる場所。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | createWorkspace関数 |

**主要処理フロー（layout.tsx）**:
1. **行1595-1629**: createWorkspace関数の定義
2. **行1597-1606**: worktree.create呼び出しとcatch処理
3. **行1600-1605**: catchブロック内でのshowToast呼び出し

#### Step 3: 国際化リソースを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | en.ts | `packages/app/src/i18n/en.ts` | `workspace.create.failed.title`キーの定義を確認 |
| 3-2 | ja.ts | `packages/app/src/i18n/ja.ts` | 日本語翻訳を確認 |

**主要処理フロー**:
- **en.ts 行801**: `workspace.create.failed.title`
- **ja.ts 行717**: 日本語翻訳

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

```
Layout (layout.tsx)
    │
    └─ Sidebar / WorkspaceList
           │
           └─ CreateWorkspaceButton onClick
                  │
                  └─ createWorkspace(project)
                         │
                         ├─ clearSidebarHoverState()
                         │
                         └─ globalSDK.client.worktree.create({
                              directory: project.worktree
                            })
                              │
                              ├─ .then(x => x.data)
                              │
                              └─ .catch(err => {
                                   showToast({
                                     title: i18n("workspace.create.failed.title"),
                                     description: errorMessage(err, i18n("common.requestFailed"))
                                   })
                                   return undefined
                                 })
```

### データフロー図

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

LocalProject
    │
    ▼
clearSidebarHoverState()
    │
    ▼
globalSDK.client.worktree.create({
  directory: project.worktree
})
    │
    ▼
API呼び出し失敗
    │
    ▼
showToast({
  title: "Failed to create workspace",
  description: errorMessage(err)
})
    │
    ▼
return undefined
    │
    ▼
[エラートースト通知表示]
[後続処理はスキップ]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| layout.tsx | `packages/app/src/pages/layout.tsx` | ソース | レイアウト・サイドバー（通知トリガー元） |
| toast.tsx | `packages/ui/src/components/toast.tsx` | ソース | トースト通知コンポーネント |
| en.ts | `packages/app/src/i18n/en.ts` | 設定 | 英語メッセージ定義 |
| ja.ts | `packages/app/src/i18n/ja.ts` | 設定 | 日本語メッセージ定義 |
