# 通知設計書 40-Failed to send shell command

## 概要

本ドキュメントは、OpenCodeアプリケーションにおける「Failed to send shell command（シェルコマンド送信失敗）」トースト通知の設計仕様を定義する。

### 本通知の処理概要

シェルモードでコマンドを送信した際にAPI呼び出しが失敗した場合に、ユーザーに対してエラー情報をトースト通知で表示する機能である。

**業務上の目的・背景**：OpenCodeでは、通常のAIプロンプト送信に加えて、シェルモードでコマンドを直接実行することができる。ユーザーが `mode === "shell"` の状態でコマンドを入力し送信すると、バックエンドの `session.shell` APIが呼び出され、ターミナルでコマンドが実行される。このAPI呼び出しは、ネットワークの問題、セッションの状態、サーバーの負荷など様々な理由で失敗する可能性がある。この通知により、ユーザーはコマンド送信の失敗を認識し、再試行や問題の確認を行うことができる。

**通知の送信タイミング**：ユーザーがシェルモードでコマンドを送信し、バックエンドAPI（`session.shell`）の呼び出しが失敗した時点で通知が発生する。

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

**通知内容の概要**：タイトルとして「Failed to send shell command」（日本語：「シェルコマンドの送信に失敗しました」）が表示され、説明文としてエラーの詳細メッセージ（APIから返却されたエラーメッセージ）が表示される。

**期待されるアクション**：ユーザーはエラー内容を確認し、コマンドの再入力を試みる（入力内容は自動的に復元される）。また、サーバーの状態や接続を確認する場合もある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
タイトル: Failed to send shell command
説明: {エラーメッセージ}
```

日本語の場合:
```
タイトル: シェルコマンドの送信に失敗しました
説明: {エラーメッセージ}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 通知タイトル | i18n: `prompt.toast.shellSendFailed.title` | Yes |
| description | エラー詳細 | APIエラーレスポンス（errorMessage関数で抽出） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | シェルモードでコマンド送信 | API失敗 | `session.shell` APIが例外をスローした場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| mode !== "shell" | シェルモードでない場合は処理されない |
| API成功 | シェルコマンド送信が成功した場合は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがコマンド送信を実行] --> B{mode === "shell"?}
    B -->|No| C[通常プロンプト処理へ]
    B -->|Yes| D[clearInput - 入力クリア]
    D --> E[session.shell API呼び出し]
    E --> F{API結果}
    F -->|成功| G[終了]
    F -->|失敗 - catch| H[showToast - エラー通知]
    H --> I[restoreInput - 入力復元]
    I --> J[終了]
    C --> J
    G --> J
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | バックエンドのシェルコマンド実行処理が行われる |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ネットワークエラー | サーバーとの通信失敗 | エラーメッセージを表示、入力を復元 |
| セッションエラー | セッションが無効な状態 | エラーメッセージを表示 |
| サーバーエラー | バックエンドの内部エラー | エラーメッセージを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- シェルモードでのコマンド送信失敗時は `restoreInput()` が呼ばれ、ユーザーの入力が復元される
- これにより、ユーザーは入力し直す必要なく再送信を試みることができる
- シェルコマンドはセッションのコンテキスト内で実行され、結果はターミナルに表示される

---

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

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

### 推奨読解順序

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

プロンプト送信処理のモード構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | submit.ts | `packages/app/src/components/prompt-input/submit.ts` | input.mode() の使用と "shell" モード（121行目、240行目） |
| 1-2 | en.ts | `packages/app/src/i18n/en.ts` | 284行目の `prompt.toast.shellSendFailed.title` キーを確認 |

**読解のコツ**: `mode` は `"normal"` または `"shell"` の2つの値を取る。シェルモードでは通常のAIプロンプトではなく、直接シェルコマンドが実行される。

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

プロンプト送信処理のシェルモード部分を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | submit.ts | `packages/app/src/components/prompt-input/submit.ts` | handleSubmit関数内のシェルモード処理（240-257行目） |

**主要処理フロー**:
1. **240行目**: `mode === "shell"` のチェック
2. **241行目**: `clearInput()` - 入力をクリア
3. **242-248行目**: session.shell API呼び出し
4. **249-255行目**: **catchブロック内のshowToastとrestoreInput（本通知の発生箇所）**
5. **256行目**: return - シェルモード処理の終了

#### Step 3: 入力復元処理を理解する

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

**主要処理フロー**:
- **221-225行目**: `clearInput()` - プロンプトをリセット、モードをnormalに戻す
- **227-238行目**: `restoreInput()` - 元のプロンプトとモードを復元、エディタにフォーカス

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

```
submit.ts::createPromptSubmit()
    │
    └─ handleSubmit(event)
           │
           └─ [mode === "shell"]
                  │
                  ├─ clearInput() → 入力クリア
                  │
                  └─ client.session.shell({
                         sessionID,
                         agent,
                         model,
                         command: text
                     })
                         │
                         └─ catch(err)
                                │
                                ├─ showToast({
                                │      title: "prompt.toast.shellSendFailed.title",
                                │      description: errorMessage(err)
                                │  })
                                │
                                └─ restoreInput() → 入力復元
```

### データフロー図

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

シェルコマンド          handleSubmit関数                 エラートースト通知
送信 ─────────▶    clearInput() ───▶               [失敗時]
                    session.shell API                    │
                            │                            ▼
                      [失敗時]                    showToast()
                            │                    「Failed to send shell command」
                            ▼
                    restoreInput() ───────────▶ 入力復元
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| submit.ts | `packages/app/src/components/prompt-input/submit.ts` | ソース | プロンプト送信処理とシェルコマンド実行 |
| 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` | 設定 | 日本語の国際化メッセージ定義 |
