# 通知設計書 22-Slack通知

## 概要

本ドキュメントは、InvenTreeシステムにおけるSlack通知機能の設計について記述します。InvenTreeSlackNotificationsプラグインは、システム内で発生する各種イベントに対する通知をSlackチャンネルに送信するコア機能を提供します。

### 本通知の処理概要

Slack通知プラグインは、InvenTreeの通知フレームワークを利用して、各種イベント発生時にSlackのWebhookを通じてチャンネルに通知メッセージを送信します。

**業務上の目的・背景**：現代の業務環境では、チームコラボレーションツールとしてSlackが広く利用されています。在庫管理システムの重要イベント（購買発注、販売発注、製造指示、在庫アラートなど）をSlackチャンネルに通知することで、チーム全体がリアルタイムで情報を共有でき、迅速な意思決定と対応が可能になります。メール通知と異なり、即時性が高く、チーム全体での情報の可視化に適しています。

**通知の送信タイミング**：各種イベント（新規発注作成、発注キャンセル、期限超過、在庫不足など）が発生した際に、`trigger_notification`関数が呼び出され、登録されたNotificationMixinを持つプラグインに対して通知送信が要求されます。Slack通知プラグインは、Webhook URLが設定されている場合にSlackへ通知を送信します。

**通知の受信者**：Slack通知はWebhook URLで指定されたチャンネル全体に送信されます。個別ユーザーへの送信ではなく、設定されたチャンネルに所属する全メンバーが通知を受信します。ユーザーごとの設定は存在せず、グローバル設定のWebhook URLに基づいて送信されます。

**通知内容の概要**：Slack Block Kit形式でメッセージが構築されます。通知名をプレーンテキストで、通知メッセージをMarkdown形式で表示し、関連オブジェクトへのリンクボタンが付与されます。

**期待されるアクション**：チームメンバーはSlackチャンネルで通知を確認し、「Open link」ボタンをクリックしてInvenTreeシステムに直接アクセスし、適切な対応（承認、在庫補充、出荷準備など）を行います。

## 通知種別

Slack（Incoming Webhook）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（requests.post） |
| 優先度 | 通常 |
| リトライ | なし（単発送信） |

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

1. `NOTIFICATION_SLACK_URL`設定からWebhook URLを取得
2. URLが設定されていない場合は送信をスキップ
3. URLが設定されている場合は、指定されたチャンネルに送信（ユーザー個別の設定なし）

## 通知テンプレート

### Slack通知の場合

| 項目 | 内容 |
|-----|------|
| Webhook URL | `NOTIFICATION_SLACK_URL`設定値 |
| メッセージ形式 | Slack Block Kit（JSON） |
| フォールバックテキスト | context['message'] |

### 本文テンプレート

Slack Block Kit形式でメッセージが構築されます：

```json
{
    "text": "{message}",
    "blocks": [
        {
            "type": "section",
            "text": {
                "type": "plain_text",
                "text": "{name}"
            }
        },
        {
            "type": "section",
            "text": {
                "type": "mrkdwn",
                "text": "{message}"
            },
            "accessory": {
                "type": "button",
                "text": {
                    "type": "plain_text",
                    "text": "Open link",
                    "emoji": true
                },
                "value": "{category}_{target.pk}",
                "url": "{link}",
                "action_id": "button-action"
            }
        }
    ]
}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | Slack Webhookは添付ファイル非対応 |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| name | 通知名（タイトル） | context['name'] | Yes |
| message | 通知メッセージ本文 | context['message'] | Yes |
| link | 関連オブジェクトへのURL | context['link'] | Yes |
| category | 通知カテゴリ | trigger_notification引数 | No |
| target.pk | 対象オブジェクトのID | target Model | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作/API | 発注作成・キャンセル等 | trigger_notification呼び出し時 | 各モデルの操作時に発火 |
| スケジュール | 期限超過チェック | 日次バッチ処理 | notify_overdue_*関数 |
| システムイベント | 在庫アラート | 閾値到達時 | notify_low_stock等 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| NOTIFICATION_SLACK_URL未設定 | Webhook URLが空の場合 |
| HTTP POSTエラー | Slack APIへのリクエストが失敗した場合 |
| 最近送信済み | 同一カテゴリ・オブジェクトに24時間以内に送信済みの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[イベント発生] --> B[trigger_notification呼び出し]
    B --> C[ターゲットユーザー解決]
    C --> D[NotificationEntryで重複チェック]
    D -->|24時間以内に送信済み| E[送信スキップ]
    D -->|送信可能| F[プラグインループ]
    F --> G[InvenTreeSlackNotifications.send_notification]
    G --> H{NOTIFICATION_SLACK_URLあり?}
    H -->|No| I[return False]
    H -->|Yes| J[Block Kit JSON構築]
    J --> K[requests.post実行]
    K --> L{レスポンスOK?}
    L -->|No| M[return False]
    L -->|Yes| N[return True]
    N --> O[NotificationEntry記録]
    O --> P[終了]
    E --> P
    I --> P
    M --> P
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| plugin_pluginsetting | NOTIFICATION_SLACK_URL取得 | プラグイン設定 |
| common_notificationentry | 重複送信チェック | 24時間以内の送信履歴 |

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

#### plugin_pluginsetting

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| value | Webhook URL | key='NOTIFICATION_SLACK_URL' |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| common_notificationentry | INSERT/UPDATE | 送信履歴の記録 |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT/UPDATE | key | カテゴリ名 | 通知カテゴリ |
| INSERT/UPDATE | uid | オブジェクトID | 対象オブジェクトのPK |
| INSERT/UPDATE | updated | 現在時刻 | 自動更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | Slack API接続エラー | requests例外、return False |
| 認証エラー | 無効なWebhook URL | HTTP 4xx/5xx、ret.ok=False |
| ネットワークエラー | タイムアウト等 | requests例外、ログ出力 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（単発送信） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | Slack API制限に依存（通常1秒1リクエスト） |
| 1日あたり上限 | 設定なし |

### 配信時間帯

制限なし（イベント発生時に即時送信）

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

- Webhook URLは`protected: True`設定でUI上マスク表示
- Slack Webhook URLはランダム生成されたトークンを含み、URL自体が認証の役割を果たす
- HTTPS通信によりデータ暗号化
- 通知内容にはチャンネルにアクセスできるメンバー全員が閲覧可能な情報のみ含めるべき

## 備考

- プラグインはINVENTREE組み込みプラグイン（ビルトイン）だがMANDATORYではない
- プラグインスラッグ: `inventree-slack-notification`
- バージョン: 1.0.0
- requestsライブラリを使用してHTTP POSTを実行

---

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

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

### 推奨読解順序

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

まず、通知で受け渡されるデータ構造とSlack Block Kit形式を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notifications.py | `src/backend/InvenTree/common/notifications.py` | NotificationBody dataclass（26-47行目）で通知の基本構造を理解 |
| 1-2 | core_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/core_notifications.py` | SETTINGS辞書（129-135行目）でWebhook URL設定を理解 |

**読解のコツ**: Slack通知はcontext辞書から`name`, `message`, `link`を取得してBlock Kit JSON形式に変換します。

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

処理の起点となる`trigger_notification`関数を特定します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | notifications.py | `src/backend/InvenTree/common/notifications.py` | trigger_notification関数（87-218行目）が全ての通知の起点 |

**主要処理フロー**:
1. **87-98行目**: 関数シグネチャとデータインポート中チェック
2. **100-107行目**: 引数の取得（targets, context, delivery_methods等）
3. **126-137行目**: NotificationEntryによる重複送信チェック（24時間以内）
4. **191-214行目**: 登録プラグインへの通知ディスパッチ

#### Step 3: Slack通知プラグインを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | core_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/core_notifications.py` | InvenTreeSlackNotifications（119-174行目）がSlack送信の実装 |

**主要処理フロー**:
- **119-135行目**: クラス定義とSETTINGS（NOTIFICATION_SLACK_URL）
- **137-174行目**: send_notification実装
  - **141-144行目**: Webhook URL取得と存在チェック
  - **146-172行目**: requests.postでSlack APIにJSON送信
  - **148-149行目**: `text`フィールド（フォールバック用）
  - **150-170行目**: `blocks`配列（Block Kit形式）
    - **151-154行目**: 第1 section - 通知名（plain_text）
    - **155-170行目**: 第2 section - メッセージ（mrkdwn）+ リンクボタン
  - **174行目**: ret.okで成功判定

#### Step 4: プラグイン設定の仕組みを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | SettingsMixin.py | `src/backend/InvenTree/plugin/base/integration/SettingsMixin.py` | get_setting()メソッドの実装 |

**主要処理フロー**:
- `self.get_setting('NOTIFICATION_SLACK_URL')`でPluginSettingモデルから値を取得
- `protected: True`設定によりUI上でマスク表示

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

```
trigger_notification() [common/notifications.py:87]
    │
    ├─ NotificationEntry.check_recent() [common/models.py:1637]
    │      └─ 24時間以内の送信履歴チェック
    │
    ├─ ターゲット解決処理
    │      ├─ User → 直接追加
    │      ├─ Group → Group.usersを展開
    │      └─ Owner → get_related_owners()で展開
    │
    ├─ registry.with_mixin(NOTIFICATION) でプラグイン取得
    │
    └─ plugin.send_notification() [各プラグイン]
           │
           └─ InvenTreeSlackNotifications.send_notification()
                  [plugin/builtin/integration/core_notifications.py:137]
                  │
                  ├─ get_setting('NOTIFICATION_SLACK_URL')
                  │
                  ├─ Block Kit JSON構築
                  │      ├─ text: フォールバックメッセージ
                  │      └─ blocks[]:
                  │           ├─ section: 通知名（plain_text）
                  │           └─ section: メッセージ（mrkdwn）+ ボタン
                  │
                  └─ requests.post(url, json={...})
                         │
                         └─ Slack Incoming Webhook
```

### データフロー図

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

イベント発生        ───▶ trigger_notification()      ───▶ NotificationEntry記録
(model操作等)              │
                           │
context:                   ▼
  - name             プラグインディスパッチ
  - message                │
  - link                   │
                           ▼
                    InvenTreeSlackNotifications
                    .send_notification()
                           │
                           ▼
                    ┌──────────────────┐
                    │ get_setting()    │
                    │ SLACK_URL取得    │
                    └────────┬─────────┘
                             │
                             ▼
                    ┌──────────────────┐
                    │ Block Kit JSON   │
                    │ 構築             │
                    │ - text           │
                    │ - blocks[]       │
                    └────────┬─────────┘
                             │
                             ▼
                    requests.post()    ───▶ Slack Webhook
                             │
                             ▼
                      ret.ok 確認      ───▶ Slackチャンネル
                                            へメッセージ投稿
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | 通知フレームワークのコア |
| core_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/core_notifications.py` | ソース | Slack通知プラグイン実装 |
| NotificationMixin.py | `src/backend/InvenTree/plugin/base/integration/NotificationMixin.py` | ソース | 通知プラグインの基底クラス |
| SettingsMixin.py | `src/backend/InvenTree/plugin/base/integration/SettingsMixin.py` | ソース | プラグイン設定管理 |
| models.py | `src/backend/InvenTree/common/models.py` | ソース | NotificationEntry |
| registry.py | `src/backend/InvenTree/plugin/registry.py` | ソース | プラグインレジストリ（Slack通知はビルトイン） |
| test_api.py | `src/backend/InvenTree/plugin/test_api.py` | テスト | プラグインアンインストールテスト含む |
| pui_settings.spec.ts | `src/frontend/tests/pui_settings.spec.ts` | テスト | フロントエンド設定テスト |
