# 通知設計書 17-在庫不足通知

## 概要

本ドキュメントは、InvenTreeシステムにおける「在庫不足通知」の設計仕様を定義する。パーツの在庫が設定された最小在庫数量を下回った際に、購読者へ通知を送信する機能について詳述する。

### 本通知の処理概要

在庫不足通知は、パーツの利用可能在庫が設定された最小在庫数量（minimum_stock）を下回った際に、パーツの購読者に自動的に通知を送信する機能である。

**業務上の目的・背景**：在庫管理において、パーツの在庫不足は製造遅延や顧客への納品遅延につながる重大な問題である。最小在庫を下回った時点で通知することにより、購買担当者は早期に補充発注を行い、在庫切れを防止できる。また、安全在庫の維持により、サプライチェーンの安定性を確保する。

**通知の送信タイミング**：在庫アイテム（StockItem）が変更された際に、`notify_low_stock_if_required`タスクがオフロードされ、パーツの在庫状況をチェックする。パーツおよびその祖先パーツの在庫が最小値を下回っている場合に通知が送信される。

**通知の受信者**：在庫不足となったパーツの購読者（part.get_subscribers()）が受信対象となる。

**通知内容の概要**：パーツの在庫が最小在庫を下回ったことを通知する。パーツの詳細（パーツ名、総在庫、利用可能在庫、最小在庫数量）およびパーツ詳細ページへのリンクを含む。

**期待されるアクション**：受信者は在庫状況を確認し、補充発注の手配、優先度の高い製造指示への在庫確保、代替パーツの検討などの対応を行う。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（offload_taskによるバックグラウンド実行） |
| 優先度 | 中 |
| リトライ | 無（通知送信失敗時はログ記録のみ） |

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

1. パーツの購読者（part.get_subscribers()）をターゲット関数として設定
2. `trigger_notification()`関数を使用し、target_fncパラメータで動的にターゲットを取得
3. 非アクティブなパーツには通知を送信しない

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | [INVENTREE_INSTANCE] |
| 件名 | Low stock 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>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.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.</em></p>
{% endblock footer_prefix %}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| part | パーツオブジェクト | Part instance | Yes |
| name | 通知名（"Low stock notification"） | 定数 | Yes |
| message | 通知メッセージ | "The available stock for {part.name} has fallen below the configured minimum level" | Yes |
| link | パーツ詳細ページへのリンク | construct_absolute_url(part.get_absolute_url()) | Yes |
| template | メールテンプレート情報 | {'html': 'email/low_stock_notification.html', 'subject': name} | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 非同期タスク | notify_low_stock_if_required | is_part_low_on_stock() == True | 在庫変更後にオフロード |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| パーツが非アクティブ | part.active == False の場合は通知しない |
| 在庫が最小値以上 | is_part_low_on_stock() == False の場合は通知不要 |
| minimum_stock未設定 | minimum_stock == 0 の場合は在庫不足にならない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[StockItem変更] --> B[offload_task: notify_low_stock_if_required]
    B --> C[Part取得]
    C --> D{Part存在?}
    D -->|No| E[終了]
    D -->|Yes| F[祖先パーツ取得]
    F --> G[各パーツに対してループ]
    G --> H{part.active?}
    H -->|No| I[次のパーツへ]
    H -->|Yes| J{is_part_low_on_stock?}
    J -->|No| I
    J -->|Yes| K[offload_task: notify_low_stock]
    K --> I
    I --> G
    I --> E
```

### notify_low_stockの処理フロー

```mermaid
flowchart TD
    A[notify_low_stock呼び出し] --> B{part.active?}
    B -->|No| C[終了]
    B -->|Yes| D[コンテキスト構築]
    D --> E[trigger_notification]
    E --> F[各プラグインで送信]
    F --> G[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| part_part | パーツ情報取得 | 在庫状況、最小在庫 |
| stock_stockitem | 在庫情報 | 在庫数量計算 |
| users_owner | 購読者情報 | 通知先決定 |
| auth_user | ユーザー情報 | 送信先ユーザー |

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

#### part_part

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| minimum_stock | 最小在庫数量 | 不足判定基準 |
| active | アクティブ状態 | 非アクティブは除外 |
| total_stock | 総在庫数量 | 表示用（計算値） |
| available_stock | 利用可能在庫 | 表示用（計算値） |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 同一パーツに対し1日1回（check_recent機能） |

### 配信時間帯

制限なし（在庫変更時に非同期実行）

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

- 通知を受信できるのは、該当するパーツに購読しているユーザーのみ
- メール本文にはパーツ名と在庫数量情報を含むが、価格情報は含まない
- NOTIFY_BY_EMAILユーザー設定によりメール通知の受信可否を制御可能

## 備考

- 祖先パーツに対しても在庫チェックを行い、階層的な在庫管理をサポート
- is_part_low_on_stock()メソッドで在庫不足判定を一元化
- パーツ単位でのcheck_recent機能により、短期間での重複通知を防止

---

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

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

### 推奨読解順序

#### Step 1: タスクのトリガーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | models.py | `src/backend/InvenTree/stock/models.py` | StockItem変更時のnotify_low_stock_if_requiredオフロード |

**読解のコツ**: StockItemの保存後やトランザクション完了後に、notify_low_stock_if_requiredタスクがオフロードされる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | tasks.py | `src/backend/InvenTree/part/tasks.py` | notify_low_stock_if_required()（行134-155） |
| 2-2 | tasks.py | `src/backend/InvenTree/part/tasks.py` | notify_low_stock()（行29-55） |

**主要処理フロー**:

**notify_low_stock_if_required():**
1. **行142-148**: パーツ取得、存在チェック
2. **行151**: 祖先パーツ取得（自身を含む、昇順）
3. **行153-155**: 各パーツに対してアクティブかつ在庫不足の場合にnotify_low_stockをオフロード

**notify_low_stock():**
1. **行37-39**: 非アクティブパーツのスキップ
2. **行41-42**: 通知名・メッセージ設定
3. **行45-50**: コンテキスト構築
4. **行52-55**: trigger_notification呼び出し（target_fnc使用）

#### Step 3: 在庫不足判定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | models.py | `src/backend/InvenTree/part/models.py` | Part.is_part_low_on_stock()メソッド |

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

```
StockItem変更 → offload_task
    │
    └─ notify_low_stock_if_required(part_id) [part/tasks.py:134]
           │
           ├─ Part.objects.get(pk=part_id)
           │
           ├─ part.get_ancestors(include_self=True, ascending=True)
           │
           └─ for p in parts:
                  │
                  ├─ part.active チェック
                  │
                  ├─ p.is_part_low_on_stock() チェック
                  │
                  └─ [低在庫の場合] offload_task(notify_low_stock, p)
                         │
                         └─ notify_low_stock(part) [part/tasks.py:29]
                                │
                                ├─ part.active チェック
                                │
                                ├─ context構築
                                │
                                └─ trigger_notification()
                                       │
                                       └─ target_fnc=part.get_subscribers
```

### データフロー図

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

StockItem変更 ───▶ notify_low_stock_if_required()
                              │
                              ├─ 祖先パーツ取得
                              │
                              ├─ 各パーツの在庫チェック
                              │      │
                              │      └─ is_part_low_on_stock()
                              │
                              └─ 低在庫パーツに対してnotify_low_stock()
                                        │
                                        └─ trigger_notification ───▶ 通知送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| tasks.py | `src/backend/InvenTree/part/tasks.py` | ソース | notify_low_stock、notify_low_stock_if_required実装 |
| models.py | `src/backend/InvenTree/part/models.py` | ソース | Part.is_part_low_on_stock()、get_subscribers() |
| models.py | `src/backend/InvenTree/stock/models.py` | ソース | StockItem、タスクオフロードトリガー |
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | trigger_notification関数 |
| low_stock_notification.html | `src/backend/InvenTree/templates/email/low_stock_notification.html` | テンプレート | メール本文テンプレート |
