# 通知設計書 14-Failed to list files

## 概要

本ドキュメントは、OpenCodeアプリケーションにおける「Failed to list files」トースト通知の設計仕様を記載する。この通知はファイル一覧の取得に失敗したときにユーザーに表示される。

### 本通知の処理概要

この通知は、ファイルツリーでディレクトリを展開したり、ファイル一覧を取得しようとしたときに、ディレクトリ内のファイル一覧取得に失敗した場合に表示されるエラー通知である。

**業務上の目的・背景**：OpenCodeにはプロジェクト内のファイルをツリー形式で表示するファイルエクスプローラー機能がある。ディレクトリの展開やファイル検索時に、サーバーからファイル一覧を取得する。この取得に失敗した場合、ユーザーにエラーを通知することで、ネットワーク問題やアクセス権限問題などの原因調査を促す。

**通知の送信タイミング**：ディレクトリのファイル一覧取得API（sdk.client.file.list）が例外をスローしたときに表示される。

**通知の受信者**：ファイル一覧を取得しようとしたユーザー自身。アプリケーション画面上にトースト通知として表示される。

**通知内容の概要**：タイトルとして「Failed to list files」が表示され、説明としてエラーメッセージが表示される。

**期待されるアクション**：ユーザーはエラーメッセージを確認し、ディレクトリパスの確認、ネットワーク接続の確認、アクセス権限の確認などを行う。問題が解決したら再度ディレクトリを展開する操作を試みる。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時表示） |
| 優先度 | 高 |
| リトライ | 無し |

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

ファイル一覧取得を試みたユーザーのアプリケーション画面に直接表示される。

## 通知テンプレート

### トースト通知

| 項目 | 内容 |
|-----|------|
| タイトル | Failed to list files |
| 説明 | {エラーメッセージ} |
| バリアント | error |

### 本文テンプレート

```
タイトル: {toast.file.listFailed.title}
説明: {エラーメッセージ（動的）}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| toast.file.listFailed.title | 通知タイトル | i18n翻訳ファイル（en.ts） | Yes |
| message | エラーメッセージ | 例外オブジェクトのmessageプロパティ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | sdk.client.file.list失敗 | 例外がスローされたとき | ディレクトリ一覧取得APIのエラー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ファイル一覧取得成功 | 正常にファイル一覧が取得された場合 |
| スコープ変更後 | ディレクトリ変更により現在のスコープと異なる場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ディレクトリ展開/一覧取得] --> B[sdk.client.file.list呼び出し]
    B --> C{取得成功?}
    C -->|Yes| D[ファイルツリー更新]
    C -->|No - 例外発生| E[onError コールバック呼び出し]
    E --> F[showToast: error variant]
    F --> G[トースト表示]
    G --> H[処理終了]
    D --> H
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | APIを通じてファイルシステムから直接取得 |

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ディレクトリストア（メモリ） | UPDATE | ディレクトリ状態にエラー情報を設定 |

#### ディレクトリストア

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | loading | false | 読み込み中フラグをオフ |
| UPDATE | error | エラーメッセージ | エラー情報を設定 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル一覧取得失敗 | sdk.client.file.listが例外をスロー | トースト通知を表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作起点のため）

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

- エラーメッセージにディレクトリパスが含まれる可能性があるが、ローカルアプリケーションのため問題なし
- 機密ディレクトリのパスが表示される可能性があるが、操作者本人のみが閲覧可能

## 備考

- ファイル一覧取得は非同期で行われる
- スコープ（プロジェクトディレクトリ）が変更された場合、進行中の取得結果は破棄される
- ディレクトリの展開・折りたたみ状態は別途管理される

---

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

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

### 推奨読解順序

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

通知に関連するi18nキーとディレクトリ状態の構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | en.ts | `packages/app/src/i18n/en.ts` | L414: toast.file.listFailed.titleの定義 |
| 1-2 | tree-store.ts | `packages/app/src/context/file/tree-store.ts` | L4-9: DirectoryState型の構造を確認 |

**読解のコツ**: DirectoryState型にはexpanded, loaded, loading, error, childrenなどのプロパティがあり、ディレクトリの展開状態と読み込み状態を管理している。

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

ファイル一覧取得とエラーハンドリングの起点を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | file.tsx | `packages/app/src/context/file.tsx` | L73-84: createFileTreeStoreの初期化とonErrorコールバック |
| 2-2 | tree-store.ts | `packages/app/src/context/file/tree-store.ts` | L42-128: listDir関数のエラーハンドリング |

**主要処理フロー**:
1. **L73-84 (file.tsx)**: createFileTreeStore初期化時にonErrorコールバックを登録
2. **L77-83 (file.tsx)**: onErrorでshowToast呼び出し
3. **L110-121 (tree-store.ts)**: catchブロックでoptions.onError呼び出し

#### Step 3: ファイルツリーストアの詳細を理解する

ディレクトリ一覧取得の詳細な処理フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | tree-store.ts | `packages/app/src/context/file/tree-store.ts` | L42-128: listDir関数全体 |

**主要処理フロー**:
- **L42-47**: 重複リクエスト防止と初期チェック
- **L52-59**: loading状態の設定
- **L63-108**: APIコールと成功時の処理
- **L110-121**: catchブロックでのエラー処理とonError呼び出し

#### Step 4: トースト表示の実装を理解する

showToast関数の実装詳細を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | toast.tsx | `packages/ui/src/components/toast.tsx` | L118-158: showToast関数の実装 |

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

```
FileProvider (file.tsx)
    │
    ├─ createFileTreeStore (L73-84)
    │      │
    │      └─ onError コールバック
    │             │
    │             └─ showToast (L77-83)
    │                    └─ variant: "error"
    │
    └─ tree.listDir (tree-store.ts L42-128)
           │
           ├─ options.list (sdk.client.file.list)
           │
           └─ [エラー時] catch (L110-121)
                  │
                  ├─ setTree (ディレクトリ状態更新)
                  │
                  └─ options.onError (file.tsx L77-83)
```

### データフロー図

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

ディレクトリパス      sdk.client.file.list            トースト通知
    │                      │                              │
    ▼                      ▼                              ▼
listDir()呼び出し ───▶  APIエラー発生     ───▶    showToast
                           │                      title: "Failed to list files"
                           ▼                      description: エラーメッセージ
                    options.onError              variant: "error"
                    (ストア更新)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| file.tsx | `packages/app/src/context/file.tsx` | ソース | ファイルコンテキスト（ツリーストア初期化） |
| tree-store.ts | `packages/app/src/context/file/tree-store.ts` | ソース | ファイルツリーストア |
| toast.tsx | `packages/ui/src/components/toast.tsx` | ソース | トースト通知コンポーネント |
| en.ts | `packages/app/src/i18n/en.ts` | 設定 | 英語翻訳テキスト |
