# 通知設計書 33-Failed to reset workspace

## 概要

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

### 本通知の処理概要

ワークスペースのリセット操作が失敗した際に、ユーザーに対してエラー情報をトースト通知で表示する機能である。

**業務上の目的・背景**：OpenCodeではワークスペース（サンドボックス）をデフォルトブランチの状態にリセットする機能がある。このリセット処理は内部でGitのworktreeリセット操作を行うが、ファイルシステムの問題、Git操作のエラー、ネットワーク障害などによって失敗することがある。この通知により、ユーザーはリセット操作が正常に完了しなかったことを即座に把握でき、適切な対処（再試行や手動での対応）を行うことができる。

**通知の送信タイミング**：ユーザーがワークスペースのリセットを実行し、バックエンドAPI（`worktree.reset`）の呼び出しが失敗（例外発生またはエラーレスポンス）した時点で通知が発生する。なお、この通知の表示前に、No.32「Resetting workspace」の持続的通知が削除される。

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

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

**期待されるアクション**：ユーザーはエラー内容を確認し、必要に応じて再度リセットを試みるか、ワークスペースの状態を確認する。Gitの競合や未コミット変更がある場合は、それらを解決してから再度リセットを試みる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

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

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ワークスペースリセット実行 | API呼び出しが失敗した場合 | `worktree.reset` APIが例外をスローした場合にトースト表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ルートディレクトリの場合 | `directory === root` の場合はリセット処理自体が実行されない |
| API成功時 | リセットが成功した場合は通知されない（代わりにNo.34「Workspace reset」が表示） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがワークスペースリセットを実行] --> B[Resetting workspace通知表示]
    B --> C[各種リセット前処理実行]
    C --> D[worktree.reset API呼び出し]
    D --> E{API結果}
    E -->|成功| F[No.34 Workspace reset通知へ]
    E -->|失敗| G[showToast - エラー通知表示]
    G --> H[Resetting workspace通知を削除]
    H --> I[busy状態をOFF]
    I --> J[終了]
    F --> J
```

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

### 参照テーブル一覧

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

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ネットワークエラー | サーバーとの通信失敗 | エラーメッセージを表示、ユーザーに再試行を促す |
| Gitエラー | worktreeのリセット操作失敗 | エラーメッセージを表示 |
| ファイルシステムエラー | ファイル操作の失敗 | エラーメッセージを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- この通知はNo.32「Resetting workspace」の持続的通知と連動しており、エラー発生時には持続的通知が削除される
- ルートディレクトリ（メインのworktree）はリセットできない設計となっている

---

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

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

### 推奨読解順序

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

トースト通知のオプション構造と国際化キーを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | ToastOptions インターフェース（108-116行目）を確認 |
| 1-2 | en.ts | `packages/app/src/i18n/en.ts` | 805行目の `workspace.reset.failed.title` キーを確認 |

**読解のコツ**: エラー通知は通常のToastOptionsで表示され、variantの指定はない。

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

ワークスペースリセットの処理とエラーハンドリングを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | resetWorkspace関数内のcatchブロック（1269-1275行目） |

**主要処理フロー**:
1. **1266行目**: worktree.reset API呼び出し
2. **1269-1275行目**: catchブロックでエラーをキャッチ
3. **1270-1273行目**: **showToast呼び出し（本通知の発生箇所）**
4. **1274行目**: falseを返してエラーを示す
5. **1277-1280行目**: resultがfalseの場合、busy状態をOFF、進行通知を削除

#### Step 3: 進行通知との連携を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | dismiss関数の定義（1252行目）と呼び出し（1279行目） |

**主要処理フロー**:
- **1252行目**: `const dismiss = () => toaster.dismiss(progress)` - 進行通知削除関数の定義
- **1279行目**: エラー時のdismiss呼び出し

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

```
layout.tsx::resetWorkspace()
    │
    ├─ showToast({ persistent: true }) → progress（トーストID）
    │
    ├─ [前処理...]
    │
    ├─ globalSDK.client.worktree.reset()
    │      │
    │      └─ catch() → showToast(エラー) → return false
    │
    └─ [result === false の場合]
           ├─ setBusy(false)
           └─ dismiss() → 進行通知削除
```

### データフロー図

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

worktree.reset          resetWorkspace関数                エラートースト通知
API失敗 ─────────▶    catch() → showToast() ───────▶   「Failed to reset...」表示
                            │
                      toaster.dismiss() ───────────▶   進行通知の削除
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| layout.tsx | `packages/app/src/pages/layout.tsx` | ソース | resetWorkspace関数のエラーハンドリング |
| toast.tsx | `packages/ui/src/components/toast.tsx` | ソース | showToast関数とtoasterオブジェクト |
| en.ts | `packages/app/src/i18n/en.ts` | 設定 | 英語の国際化メッセージ定義 |
| ja.ts | `packages/app/src/i18n/ja.ts` | 設定 | 日本語の国際化メッセージ定義 |
