# 通知設計書 19-パーツ変更通知

## 概要

本ドキュメントは、InvenTreeシステムにおける「パーツ変更通知」の設計仕様を定義する。パーツに変更が加えられた際に、購読者へ通知を送信するプラグイン機能について詳述する。

### 本通知の処理概要

パーツ変更通知は、PartNotificationsPluginプラグインによって提供される機能であり、パーツオブジェクトに対するCRUD操作（作成、更新、削除など）が発生した際に、購読者に自動的に通知を送信する。

**業務上の目的・背景**：パーツはInvenTreeの中核オブジェクトであり、設計変更、仕様更新、廃止などの変更は製造プロセス全体に影響を与える。パーツの変更をリアルタイムに通知することで、設計者、製造担当者、購買担当者などの関係者は変更内容を把握し、必要な対応（BOM更新、発注見直し、在庫調整など）を迅速に行うことができる。

**通知の送信タイミング**：パーツに対するイベント（part_part.created、part_part.saved、part_part.deletedなど）が発生した際に、PartNotificationsPluginのprocess_event()メソッドがトリガーされ、ENABLE_PART_NOTIFICATIONS設定が有効な場合に通知が送信される。

**通知の受信者**：変更されたパーツの購読者（part.get_subscribers()）が受信対象となる。パーツが属するカテゴリの購読者も含まれる。

**通知内容の概要**：パーツに対してどのような変更が発生したかを通知する。パーツの詳細（パーツ名、カテゴリ、在庫情報）およびパーツ詳細ページへのリンクを含む。

**期待されるアクション**：受信者は変更内容を確認し、必要に応じてBOMの更新、製造指示の見直し、発注計画の調整などの対応を行う。

## 通知種別

- メール通知（InvenTreeEmailNotifications経由）
- UI通知（InvenTreeUINotifications経由）
- Slack通知（InvenTreeSlackNotifications経由、設定時）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | イベント駆動（プラグインイベントハンドラ） |
| 優先度 | 中 |
| リトライ | 無（通知送信失敗時はログ記録のみ） |

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

1. パーツの購読者（part.get_subscribers()）をターゲット関数として設定
2. `trigger_notification()`関数を使用し、target_fncパラメータで動的にターゲットを取得
3. check_recent=Falseにより、短期間での複数通知も許可

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | [INVENTREE_INSTANCE] |
| 件名 | Changed part notification |
| 形式 | HTML |

### 本文テンプレート

```html
{% extends "email/email.html" %}

{% block title %}
{{ message }}
{% if link %}
<p>Click on the following link to view this part: <a href="{{ link }}">{{ link }}</a></p>
{% endif %}
{% endblock title %}

{% block body %}
<tr style="height: 3rem; border-bottom: 1px solid">
    <th>Part</th>
    <th>Part Category</th>
    <th>Total Stock</th>
    <th>Available</th>
    <th>Minimum Quantity</th>
</tr>
<tr style="height: 3rem">
    <td style="text-align: center;">{{ part.full_name }}</td>
    <td style="text-align: center;">{{ part.category_path }}</td>
    <td style="text-align: center;">{{ part.total_stock }}</td>
    <td style="text-align: center;">{{ part.available_stock }}</td>
    <td style="text-align: center;">{{ part.minimum_stock }}</td>
</tr>
{% endblock body %}

{% block footer_prefix %}
<p><em>You are receiving this email because you are subscribed to notifications for this part or a category that it is part of.</em></p>
{% endblock footer_prefix %}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| part | パーツオブジェクト | Part instance | Yes |
| name | 通知名（"Changed part notification"） | 定数 | Yes |
| message | 通知メッセージ | "The part `{part.name}` has been triggered with a `{action}` event" | Yes |
| link | パーツ詳細ページへのリンク | construct_absolute_url(part.get_absolute_url()) | Yes |
| template | メールテンプレート情報 | {'html': 'email/part_event_notification.html', 'subject': name} | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| イベント | part_part.created | ENABLE_PART_NOTIFICATIONS=True | パーツ作成時 |
| イベント | part_part.saved | ENABLE_PART_NOTIFICATIONS=True | パーツ保存時 |
| イベント | part_part.deleted | ENABLE_PART_NOTIFICATIONS=True | パーツ削除時 |
| イベント | part_part.* | ENABLE_PART_NOTIFICATIONS=True | その他パーツイベント |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| プラグイン設定無効 | ENABLE_PART_NOTIFICATIONS=False の場合は処理終了 |
| イベント種別不一致 | 'part_part.'で始まらないイベントは対象外 |
| 購読者なし | パーツに購読者がいない場合は通知なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[パーツイベント発生] --> B[trigger_event呼び出し]
    B --> C[PartNotificationsPlugin.wants_process_event]
    C --> D{event.startswith 'part_part.'?}
    D -->|No| E[スキップ]
    D -->|Yes| F[process_event呼び出し]
    F --> G{ENABLE_PART_NOTIFICATIONS?}
    G -->|No| E
    G -->|Yes| H[Part取得]
    H --> I[イベントアクション抽出]
    I --> J[コンテキスト構築]
    J --> K[trigger_notification]
    K --> L[各プラグインで送信]
    L --> M[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| part_part | パーツ情報取得 | イベント対象パーツ |
| part_partcategory | カテゴリ情報 | 表示用、購読者取得 |
| stock_stockitem | 在庫情報 | 表示用（計算値） |
| plugin_pluginconfig | プラグイン設定 | ENABLE_PART_NOTIFICATIONS |

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

#### part_part

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | パーツ名 | 表示・メッセージ用 |
| category | カテゴリ参照 | 表示用 |
| total_stock | 総在庫 | 表示用（計算値） |
| available_stock | 利用可能在庫 | 表示用（計算値） |
| minimum_stock | 最小在庫 | 表示用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| common_notificationentry | INSERT/UPDATE | 通知送信記録 |
| common_notificationmessage | INSERT | UI通知メッセージ |

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

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT/UPDATE | key | 'part.notification' | 通知カテゴリ |
| INSERT/UPDATE | uid | Part.pk | 対象オブジェクトID |
| INSERT/UPDATE | updated | 現在日時 | 最終送信日時 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Part.DoesNotExist | パーツが削除された | 処理終了（deletedイベント時は正常） |
| 送信失敗 | メール送信エラー | ログ記録、処理続行 |
| テンプレートエラー | テンプレート変数不正 | ログ記録、処理続行 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | check_recent=False のため、イベントごとに通知送信 |

### 配信時間帯

制限なし（イベント発生時にリアルタイム送信）

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

- 通知を受信できるのは、該当するパーツに購読しているユーザーのみ
- メール本文にはパーツの基本情報（パーツ名、カテゴリ、在庫情報）を含む
- NOTIFY_BY_EMAILユーザー設定によりメール通知の受信可否を制御可能
- プラグイン設定（ENABLE_PART_NOTIFICATIONS）で機能全体の有効/無効を制御

## 備考

- PartNotificationsPluginはプラグインとして実装されており、有効/無効の切り替えが可能
- デフォルトではENABLE_PART_NOTIFICATIONS=Falseで無効化されている
- イベント種別（created、saved、deletedなど）がメッセージに含まれる
- check_recent=Falseにより、同一パーツへの複数変更も個別に通知

---

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

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

### 推奨読解順序

#### Step 1: プラグイン構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | part_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/part_notifications.py` | PartNotificationsPluginクラス全体（行16-65） |

**読解のコツ**: PartNotificationsPluginはEventMixinとSettingsMixinを継承し、イベント駆動で動作する。ENABLE_PART_NOTIFICATIONS設定で機能の有効/無効を制御する。

#### Step 2: イベント判定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | part_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/part_notifications.py` | wants_process_event()（行34-36） |

**主要処理フロー**:
- event.startswith('part_part.')でパーツ関連イベントのみを処理対象とする

#### Step 3: 通知送信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | part_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/part_notifications.py` | process_event()（行38-65） |

**主要処理フロー**:
1. **行40-41**: ENABLE_PART_NOTIFICATIONS設定チェック
2. **行42**: Part取得（kwargs['id']）
3. **行43**: イベントアクション抽出（event.split('.')[-1]）
4. **行45**: 通知名設定
5. **行46-65**: trigger_notification呼び出し（check_recent=False）

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

```
Part.save() / Part.delete() / etc.
    │
    └─ trigger_event('part_part.{action}', id=part.pk)
           │
           └─ PartNotificationsPlugin.wants_process_event(event)
                  │
                  ├─ event.startswith('part_part.') → True
                  │
                  └─ PartNotificationsPlugin.process_event(event, **kwargs)
                         │
                         ├─ get_setting('ENABLE_PART_NOTIFICATIONS') チェック
                         │
                         ├─ Part.objects.get(pk=kwargs['id'])
                         │
                         ├─ part_action = event.split('.')[-1]
                         │
                         └─ trigger_notification() [common/notifications.py]
                                │
                                ├─ target_fnc=part.get_subscribers
                                │
                                └─ check_recent=False
```

### データフロー図

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

パーツ操作 ───▶ trigger_event() ───▶ PartNotificationsPlugin
                                           │
                                           ├─ 設定チェック
                                           │
                                           ├─ Part取得
                                           │
                                           └─ trigger_notification ───▶ 通知送信
                                                       │
                                                       ├─ target_fnc実行
                                                       │
                                                       └─ 各プラグインで送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| part_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/part_notifications.py` | ソース | PartNotificationsPluginプラグイン |
| models.py | `src/backend/InvenTree/part/models.py` | ソース | Partモデル、get_subscribers() |
| events.py | `src/backend/InvenTree/plugin/events.py` | ソース | trigger_event関数 |
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | trigger_notification関数 |
| part_event_notification.html | `src/backend/InvenTree/templates/email/part_event_notification.html` | テンプレート | メール本文テンプレート |
