# 通知設計書 16-Session shared

## 概要

本ドキュメントは、OpenCodeアプリケーションにおける「Session shared」トースト通知の設計仕様を記載する。この通知はセッションの共有に成功したときにユーザーに表示される。

### 本通知の処理概要

この通知は、ユーザーがセッションを公開共有し、共有URLがクリップボードにコピーされたときに表示される成功通知である。

**業務上の目的・背景**：OpenCodeでは、AIエージェントとの対話セッションをWeb上で公開共有できる機能がある。これにより、ユーザーは他の人と対話内容を共有したり、チームメンバーとコードレビューの文脈を共有したりできる。共有が成功したことと、URLがコピーされたことをユーザーに伝えることで、次のアクション（URLの共有）がスムーズに行える。

**通知の送信タイミング**：ユーザーが/shareコマンドを実行し、sdk.client.session.share APIが成功した後、URLがクリップボードにコピーされたときに表示される。

**通知の受信者**：操作を実行したユーザー自身。アプリケーション画面上にトースト通知として表示される。

**通知内容の概要**：タイトルとして「Session shared」（または既存の共有URLの場合「Copied」）、説明として「Share URL copied to clipboard!」が表示され、共有が成功しURLがコピーされたことを伝える。

**期待されるアクション**：ユーザーはクリップボードにコピーされたURLをメール、チャット、ドキュメントなどに貼り付けて共有する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

操作を実行したユーザーのアプリケーション画面に直接表示される。

## 通知テンプレート

### トースト通知

| 項目 | 内容 |
|-----|------|
| タイトル | Session shared（新規共有時）/ Copied（既存共有URLコピー時） |
| 説明 | Share URL copied to clipboard! |
| バリアント | success |

### 本文テンプレート

```
タイトル（新規）: {toast.session.share.success.title}
タイトル（既存）: {session.share.copy.copied}
説明: {toast.session.share.success.description}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| toast.session.share.success.title | 通知タイトル（新規共有時） | i18n翻訳ファイル（en.ts） | Yes |
| session.share.copy.copied | 通知タイトル（既存共有URLコピー時） | i18n翻訳ファイル（en.ts） | Yes |
| toast.session.share.success.description | 通知説明文 | i18n翻訳ファイル（en.ts） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | /shareコマンド実行（新規共有） | API成功かつクリップボードコピー成功 | 新規にセッションを共有 |
| 画面操作 | /shareコマンド実行（既存共有URLコピー） | クリップボードコピー成功 | 既存の共有URLをコピー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| クリップボードコピー失敗 | copyFailed通知が代わりに表示される |
| API失敗 | failed通知が代わりに表示される |
| share機能が無効 | sync.data.config.share === "disabled"の場合、コマンド自体が表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザー操作: /share] --> B{既存の共有URLがあるか?}
    B -->|Yes| C[既存URLをコピー]
    B -->|No| D[sdk.client.session.share呼び出し]
    D --> E{API成功?}
    E -->|No| F[showToast: share.failed]
    E -->|Yes| G[新しいURLをコピー]
    C --> H{コピー成功?}
    G --> H
    H -->|No| I[showToast: copyFailed]
    H -->|Yes| J{既存URLだったか?}
    J -->|Yes| K[showToast: copied]
    J -->|No| L[showToast: success]
    K --> M[トースト表示]
    L --> M
    F --> M
    I --> M
    M --> N[処理終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| セッション情報（メモリ） | 既存共有URLの確認 | info()?.share?.urlで参照 |
| 設定（メモリ） | 共有機能の有効/無効確認 | sync.data.config.shareで参照 |

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

#### セッション情報

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| share.url | 既存の共有URL | セッションIDで取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| セッション情報（サーバー） | UPDATE | 共有状態を更新（API経由） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API失敗 | sdk.client.session.shareが例外をスロー | failed通知を表示 |
| クリップボードコピー失敗 | navigator.clipboard.writeTextが失敗 | copyFailed通知を表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 共有URLは認証なしでアクセス可能なため、機密情報を含むセッションの共有には注意が必要
- 共有設定はサーバー側の設定（config.share）で無効化可能

## 備考

- 共有機能はサーバー設定で無効化可能
- 共有URLは一度生成されると、unshareするまで有効
- クリップボードコピーはdocument.execCommandとnavigator.clipboardの両方をフォールバックとして実装

---

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

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

### 推奨読解順序

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

通知に関連するi18nキーを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | en.ts | `packages/app/src/i18n/en.ts` | L420-421: share.success関連のi18nキー定義 |
| 1-2 | en.ts | `packages/app/src/i18n/en.ts` | L548: session.share.copy.copied定義 |

**読解のコツ**: `toast.session.share`で始まるi18nキーを検索すると、セッション共有に関連する全テキストを特定できる。

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

ユーザー操作からトースト表示までの起点となるファイルを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | use-session-commands.tsx | `packages/app/src/pages/session/use-session-commands.tsx` | L373-479: shareCommandsの定義 |

**主要処理フロー**:
1. **L373-374**: share機能の有効/無効チェック
2. **L376-378**: コマンドの基本定義（タイトルは既存URLの有無で変化）
3. **L384-450**: onSelectハンドラ内の処理
4. **L387-409**: write関数（クリップボードコピーのフォールバック実装）
5. **L411-428**: copy関数（コピー成功/失敗時のトースト表示）
6. **L430-449**: APIコールとトースト表示

#### Step 3: クリップボードコピーの詳細を理解する

write関数とcopy関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | use-session-commands.tsx | `packages/app/src/pages/session/use-session-commands.tsx` | L387-428: write関数とcopy関数 |

**主要処理フロー**:
- **L387-409**: write関数 - document.execCommandとnavigator.clipboardのフォールバック
- **L411-428**: copy関数 - コピー成功時にshowToast呼び出し

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

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

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

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

```
useSessionCommands (use-session-commands.tsx)
    │
    ├─ shareCommands (L373-479)
    │      │
    │      └─ session.share.onSelect (L384-450)
    │             │
    │             ├─ [既存URLあり] copy(existing, true) (L431-433)
    │             │      │
    │             │      └─ showToast: copied (L421-424)
    │             │
    │             └─ [既存URLなし]
    │                    │
    │                    ├─ sdk.client.session.share (L436-439)
    │                    │
    │                    ├─ [成功] copy(url, false) (L449)
    │                    │      │
    │                    │      └─ showToast: success (L421-427)
    │                    │
    │                    └─ [失敗] showToast: failed (L441-445)
    │
    └─ language.t (翻訳テキスト取得)
           └─ i18n/en.ts
```

### データフロー図

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

ユーザー操作        sdk.client.session.share         トースト通知
(/share)      ───▶  + クリップボードコピー    ───▶   showToast
                           │                         variant: "success"
                           ▼                         title + description
                    セッション共有状態更新                  │
                    (サーバーサイド)                       ▼
                                                   画面上にトースト表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| use-session-commands.tsx | `packages/app/src/pages/session/use-session-commands.tsx` | ソース | コマンド定義とトースト呼び出し |
| toast.tsx | `packages/ui/src/components/toast.tsx` | ソース | トースト通知コンポーネント |
| en.ts | `packages/app/src/i18n/en.ts` | 設定 | 英語翻訳テキスト |
