# 通知設計書 34-Workspace reset

## 概要

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

### 本通知の処理概要

ワークスペースのリセット処理が正常に完了した際に、成功をユーザーに通知し、次のアクションを促すトースト通知を表示する機能である。

**業務上の目的・背景**：OpenCodeではワークスペース（サンドボックス）をデフォルトブランチの状態にリセットする機能がある。リセット処理が成功した場合、ユーザーにその結果を明確に伝え、新しいセッションの開始など次のアクションへスムーズに移行できるようにする必要がある。この通知により、ユーザーはリセットが完了したことを確認でき、提供されるアクションボタンから直接新しいセッションを開始できる。

**通知の送信タイミング**：ワークスペースリセット処理（worktree.reset API呼び出し、セッションアーカイブ処理）がすべて正常に完了した後に表示される。No.32「Resetting workspace」の持続的通知が削除された後に表示される。

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

**通知内容の概要**：タイトルとして「Workspace reset」（日本語：「ワークスペースをリセットしました」）が表示され、説明文として「Workspace now matches the default branch.」（日本語：「ワークスペースはデフォルトブランチと一致しています。」）が表示される。また、「New session」と「Dismiss」の2つのアクションボタンが提供される。

**期待されるアクション**：ユーザーは「New session」ボタンをクリックして新しいセッションを開始するか、「Dismiss」ボタンでトーストを閉じる。

## 通知種別

トースト通知（アプリ内通知）- アクションボタン付き

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| バリアント | default |
| アイコン | なし |
| 持続性 | 非持続（自動消去）※ただしアクションボタンあり |

### 本文テンプレート

```
タイトル: Workspace reset
説明: Workspace now matches the default branch.
アクション1: [New session] - 新しいセッションを開始
アクション2: [Dismiss] - 通知を閉じる
```

日本語の場合:
```
タイトル: ワークスペースをリセットしました
説明: ワークスペースはデフォルトブランチと一致しています。
アクション1: [新しいセッション] - 新しいセッションを開始
アクション2: [閉じる] - 通知を閉じる
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 通知タイトル | i18n: `workspace.reset.success.title` | Yes |
| description | 説明文 | i18n: `workspace.reset.success.description` | Yes |
| action1.label | 新しいセッションボタン | i18n: `command.session.new` | Yes |
| action2.label | 閉じるボタン | i18n: `common.dismiss` | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ワークスペースリセット完了 | リセット処理が正常に完了した場合 | worktree.reset成功後、セッションアーカイブ完了後に表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| リセット失敗時 | API呼び出しが失敗した場合は通知されない（代わりにNo.33「Failed to reset workspace」が表示） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[worktree.reset API成功] --> B[セッションアーカイブ処理]
    B --> C[busy状態をOFF]
    C --> D[Resetting workspace通知を削除]
    D --> E[showToast - 成功通知表示]
    E --> F{ユーザーアクション}
    F -->|New session| G[新しいセッション画面へナビゲーション]
    F -->|Dismiss| H[トースト閉じる]
    G --> I[終了]
    H --> I
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | 成功通知表示のため |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| N/A | この通知は成功時にのみ表示される | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 成功通知のみであり、機密情報は含まれない
- 新しいセッションへのナビゲーションはワークスペースのディレクトリ情報をBase64エンコードしてURLに含める

## 備考

- この通知はNo.32「Resetting workspace」の持続的通知と連動しており、成功時には持続的通知が削除された後に表示される
- アクションボタン「New session」をクリックすると、リセットされたワークスペースで新しいセッションが開始される
- アクションボタン「Dismiss」はトーストを閉じるだけで、特別な処理は行わない

---

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

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

### 推奨読解順序

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

トースト通知のアクションオプションを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | ToastAction インターフェース（103-106行目）を確認 |
| 1-2 | toast.tsx | `packages/ui/src/components/toast.tsx` | ToastOptions の `actions` プロパティ（115行目）を確認 |
| 1-3 | en.ts | `packages/app/src/i18n/en.ts` | 806-807行目の `workspace.reset.success.*` キーを確認 |

**読解のコツ**: ToastActionの `onClick` は `"dismiss"` 文字列またはコールバック関数を受け取る。`"dismiss"` の場合はトーストを閉じるだけ。

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

ワークスペースリセット成功時の処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | layout.tsx | `packages/app/src/pages/layout.tsx` | resetWorkspace関数の成功パス（1283-1318行目） |

**主要処理フロー**:
1. **1283-1296行目**: セッションのアーカイブ処理
2. **1298行目**: busy状態をOFF
3. **1299行目**: dismiss() - 進行通知を削除
4. **1301-1318行目**: **showToast呼び出し（本通知の発生箇所）**
5. **1304-1311行目**: 「New session」アクションの定義（ナビゲーション処理）
6. **1312-1315行目**: 「Dismiss」アクションの定義

#### Step 3: アクションボタンの動作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | アクションボタンのクリック処理（142-147行目） |

**主要処理フロー**:
- **142-147行目**: onClick が関数の場合は実行、その後 `toaster.dismiss(props.toastId)` でトーストを閉じる
- 「New session」クリック時: `navigate()` でセッション画面へ遷移 → トースト閉じる
- 「Dismiss」クリック時: `"dismiss"` なので何もせずトースト閉じる

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

```
layout.tsx::resetWorkspace()
    │
    ├─ [worktree.reset成功後]
    │
    ├─ セッションアーカイブ処理
    │
    ├─ setBusy(false)
    │
    ├─ dismiss() → 進行通知削除
    │
    └─ showToast({ actions: [...] })
           │
           ├─ action[0]: "New session"
           │      └─ onClick: navigate(`/${base64Encode(directory)}/session`)
           │
           └─ action[1]: "Dismiss"
                  └─ onClick: "dismiss"
```

### データフロー図

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

worktree.reset          resetWorkspace関数                成功トースト通知
API成功 ─────────▶    showToast({ actions }) ───────▶   「Workspace reset」表示
                            │                              ├─ [New session]
                            │                              └─ [Dismiss]
                            │
                      [ユーザーアクション]
                            │
              ┌─────────────┴─────────────┐
              ▼                           ▼
    navigate(セッション画面)        toaster.dismiss()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| layout.tsx | `packages/app/src/pages/layout.tsx` | ソース | resetWorkspace関数の成功ハンドリング |
| 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` | 設定 | 日本語の国際化メッセージ定義 |
