# 通知設計書 32-Resetting workspace

## 概要

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

### 本通知の処理概要

ワークスペースのリセット処理が開始された際に、処理中であることをユーザーに伝えるための持続的トースト通知を表示する機能である。

**業務上の目的・背景**：OpenCodeのワークスペース（サンドボックス）は、開発作業中に様々な変更が蓄積される。ユーザーがワークスペースをデフォルトブランチの状態にリセットしたい場合、セッションの破棄、インスタンスの廃棄、worktreeのリセットなど複数の処理が必要となり、これには時間がかかる。この通知により、ユーザーは処理が進行中であることを認識でき、処理完了まで待機する必要があることを理解できる。

**通知の送信タイミング**：ユーザーがワークスペースのリセット操作を開始した直後（resetWorkspace関数の実行開始時）に表示される。この通知は「持続的（persistent）」であり、リセット処理が完了するまで自動的には消えない。

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

**通知内容の概要**：タイトルとして「Resetting workspace」（日本語：「ワークスペースをリセット中」）が表示され、説明文として「This may take a minute.」（日本語：「これには少し時間がかかる場合があります。」）が表示される。

**期待されるアクション**：ユーザーは処理が完了するまで待機する。通知は持続的であるため、処理完了時にプログラム側から明示的に削除される。

## 通知種別

トースト通知（アプリ内通知）- 持続的（persistent）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| バリアント | default |
| アイコン | なし |
| 持続性 | **持続（persistent: true）** - 手動で削除されるまで表示 |

### 本文テンプレート

```
タイトル: Resetting workspace
説明: This may take a minute.
```

日本語の場合:
```
タイトル: ワークスペースをリセット中
説明: これには少し時間がかかる場合があります。
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 通知タイトル | i18n: `workspace.resetting.title` | Yes |
| description | 説明文 | i18n: `workspace.resetting.description` | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ワークスペースリセット実行 | 常に表示 | resetWorkspace関数の開始時に表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ルートディレクトリの場合 | `directory === root` の場合はリセット処理自体が実行されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがワークスペースリセットを実行] --> B{ルートディレクトリか?}
    B -->|Yes| C[処理中断・通知なし]
    B -->|No| D[busy状態をON]
    D --> E[showToast - 持続的通知表示]
    E --> F[セッション一覧取得]
    F --> G[ターミナルクリア]
    G --> H[インスタンス破棄]
    H --> I[worktree.reset API呼び出し]
    I --> J{API結果}
    J -->|成功| K[セッションアーカイブ]
    J -->|失敗| L[エラートースト表示]
    K --> M[成功トースト表示]
    L --> N[持続的通知を削除 - dismiss]
    M --> N
    N --> O[busy状態をOFF]
    O --> P[終了]
    C --> P
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | リセット処理中の進行状況表示のため |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| N/A | この通知自体はエラーではなく進行状況表示 | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 進行状況表示のみであり、機密情報は含まれない
- ワークスペースのパスなどの情報は表示しない

## 備考

- この通知は `persistent: true` で表示され、処理完了時に `toaster.dismiss()` で明示的に削除される
- No.33「Failed to reset workspace」またはNo.34「Workspace reset」の通知表示前にこの通知が削除される

---

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

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

### 推奨読解順序

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

トースト通知の持続性オプションを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | ToastOptions の `persistent` プロパティ（114行目）を確認 |
| 1-2 | en.ts | `packages/app/src/i18n/en.ts` | 803-804行目の `workspace.resetting.*` キーを確認 |

**読解のコツ**: `persistent: true` が設定されると、トーストは自動消去されず、`toaster.dismiss(id)` で明示的に削除する必要がある。

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

ワークスペースリセットの処理起点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | resetWorkspace関数（1243-1319行目）がリセット処理の本体 |

**主要処理フロー**:
1. **1244行目**: ルートディレクトリかどうかのガード条件
2. **1245行目**: busy状態の設定
3. **1247-1251行目**: **showToast呼び出し（本通知の発生箇所）** - persistent: true
4. **1252行目**: dismiss関数の定義（後で通知を削除するため）
5. **1254-1257行目**: セッション一覧取得
6. **1259-1263行目**: ターミナルクリア
7. **1264行目**: インスタンス破棄
8. **1266-1275行目**: worktree.reset API呼び出し
9. **1279行目**: 失敗時のdismiss呼び出し
10. **1299行目**: 成功時のdismiss呼び出し（暗黙的、次のトースト表示前）

#### Step 3: トースト表示・削除ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | showToast関数の戻り値がトーストIDであることを確認（120行目） |

**主要処理フロー**:
- **120行目**: `toaster.show()` がトーストIDを返す
- **99行目**: `toaster` オブジェクトがエクスポートされており、`toaster.dismiss(id)` で削除可能

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

```
layout.tsx::resetWorkspace()
    │
    ├─ showToast({ persistent: true }) → トーストID取得
    │
    ├─ globalSDK.client.session.list()
    │
    ├─ clearWorkspaceTerminals()
    │
    ├─ globalSDK.client.instance.dispose()
    │
    ├─ globalSDK.client.worktree.reset()
    │      │
    │      ├─ [失敗時] showToast(エラー) → toaster.dismiss(進行トースト)
    │      │
    │      └─ [成功時] セッションアーカイブ → showToast(成功) → toaster.dismiss(進行トースト)
    │
    └─ toaster.dismiss(進行トーストID)
```

### データフロー図

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

ユーザー操作          resetWorkspace関数                 持続的トースト通知
(リセット実行) ───▶   showToast(persistent) ───▶    「Resetting workspace」表示
                            │                                    │
                      [処理完了後]                          [削除]
                    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` | 設定 | 日本語の国際化メッセージ定義 |
