# 通知設計書 24-merged_merge_request_email

## 概要

本ドキュメントは、Merge Requestがマージされた際に、関係者へ通知するメール送信機能の設計を記載する。

### 本通知の処理概要

Merge Requestがマージされたことを、関係者にメールで通知する機能である。

**業務上の目的・背景**：Merge Requestのマージは、コード変更がターゲットブランチに統合された重要なイベントである。マージが完了すると、関連するIssueのクローズ、デプロイの準備、次のタスクへの移行など、後続の作業が発生する。本通知により、関係者はコード統合の完了を即座に把握し、次のアクションを取ることができる。

**通知の送信タイミング**：Merge Requestがマージされた時点で送信される。具体的には、NotificationServiceのmerge_mrメソッドが呼び出された際にトリガーされる。

**通知の受信者**：Merge Requestの作成者（author）、アサインされたユーザー（assignees）、レビュアー（reviewers）、プロジェクトのWatch設定ユーザー、カスタム通知設定で「merge_merge_request」を有効にしているユーザー、Merge Requestを購読しているユーザーが受信対象となる。auto_merge_enabled（自動マージ）の場合は、操作者本人にも通知が送信される。

**通知内容の概要**：Merge Requestがマージされたこと、対象Merge RequestのURL、Merge Requestのタイトル、参照番号、作成者名、アサイン先、レビュアーが含まれる。

**期待されるアクション**：受信者は、マージ完了を確認し、必要に応じてデプロイの実行、関連ドキュメントの更新、関連するIssueの確認、次の開発タスクへの移行を行うことが期待される。

## 通知種別

メール

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（deliver_later） |
| 優先度 | 中 |
| リトライ | Sidekiqの標準リトライ設定に準拠 |

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

NotificationRecipients::BuildService.build_recipientsを使用して受信者を決定する。action: "merge"が指定される。以下の条件に該当するユーザーが対象となる：

1. Merge Requestの参加者（participants）
2. プロジェクトのWatch設定ユーザー
3. カスタム通知レベルで対象イベントを有効にしているユーザー
4. Merge Requestの購読者

**特記事項**: auto_merge_enabled（自動マージ）の場合は、skip_current_userがfalseになり、操作者本人にも通知が送信される。通常のマージでは操作者は送信対象から除外される。

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | GitLabの設定に基づくシステムメールアドレス |
| 送信元名称 | 操作実行者の名前（user_name (user_reference)形式） |
| 件名 | Re: {project_name} \| {merge_request_title} ({merge_request_reference}) |
| 形式 | HTML/テキスト両対応 |

### 本文テンプレート

**テキスト形式**:
```
Merge request {merge_request_reference} was merged

Merge request URL: {merge_request_url}

{source_branch} -> {target_branch}

Author: {author_name}
Assignees: {assignees}
Reviewers: {reviewers}
```

**HTML形式**:
```html
<p>Merge request {merge_request_link} was merged</p>
<p>{source_branch} -> {target_branch}</p>
<div>Author: {author_name}</div>
<div>Assignees: {assignees}</div>
<div>Reviewers: {reviewers}</div>
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本通知に添付ファイルはない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| @merge_request | 対象のMerge Request | MergeRequest.find(merge_request_id) | Yes |
| @project | 対象プロジェクト | @merge_request.project | Yes |
| @target_url | Merge RequestのURL | project_merge_request_url | Yes |
| @recipient | 受信者 | User.find(recipient_id) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | Merge Requestのマージボタン押下 | MRがマージ可能状態でマージ実行された場合 | UIからのマージ操作 |
| API | MergeRequest マージAPI | マージが正常に完了した場合 | REST/GraphQL API経由でのマージ |
| 自動処理 | Merge When Pipeline Succeeds | パイプライン成功時の自動マージ | 自動マージ設定による自動実行 |
| 自動処理 | Merge Train | マージトレインによる自動マージ | Enterprise機能 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| プロジェクトのメール通知無効 | project.emails_disabled?がtrueの場合 |
| ユーザーの通知設定 | 受信者の通知レベルがDisabledの場合 |
| 操作実行者への送信抑止 | 手動マージの場合のみ。自動マージ時は操作者にも送信 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[MRマージイベント] --> B[NotificationService.merge_mr]
    B --> C{auto_merge_enabled?}
    C -->|Yes| D[skip_current_user: false]
    C -->|No| E[skip_current_user: true]
    D --> F[close_resource_email]
    E --> F
    F --> G[NotificationRecipients::BuildService.build_recipients]
    G --> H{受信者が存在?}
    H -->|Yes| I[各受信者へメール送信]
    H -->|No| J[終了]
    I --> K[Notify.merged_merge_request_email]
    K --> L[setup_merge_request_mail]
    L --> M[mail_answer_thread]
    M --> N[deliver_later]
    N --> O[Sidekiqキュー登録]
    O --> P[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| merge_requests | 対象MR情報取得 | merge_request_id指定 |
| users | 受信者・操作者・作成者情報 | recipient_id, updated_by_user_id, author_id |
| projects | プロジェクト情報 | merge_request.project |
| notification_settings | 通知設定確認 | 受信者決定時 |
| merge_request_assignees | アサイン先情報 | assignees取得 |
| merge_request_reviewers | レビュアー情報 | reviewers取得 |

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

#### merge_requests

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | MR識別 | WHERE id = merge_request_id |
| title | メール件名 | - |
| iid | MR参照番号 | to_reference用 |
| project_id | プロジェクト取得 | - |
| author_id | 作成者情報 | - |
| source_branch | ソースブランチ | merge_path_description用 |
| target_branch | ターゲットブランチ | merge_path_description用 |
| auto_merge_enabled | 自動マージ設定 | skip_current_user判定用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| sent_notifications | INSERT | 送信通知の記録 |

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

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | noteable_type | 'MergeRequest' | 対象種別 |
| INSERT | noteable_id | merge_request_id | 対象ID |
| INSERT | recipient_id | recipient_id | 受信者ID |
| INSERT | reply_key | 生成されたキー | 返信用キー |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | SMTPエラー | Sidekiqによる自動リトライ |
| MR未存在 | 削除済みMR | ActiveRecord::RecordNotFoundで処理中断 |
| ユーザー未存在 | 削除済みユーザー | 該当ユーザーをスキップ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Sidekiqデフォルト（25回） |
| リトライ間隔 | 指数バックオフ |
| リトライ対象エラー | 一時的なネットワークエラー、SMTPタイムアウト |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | Gitlab::ApplicationRateLimiter設定に準拠 |
| 1日あたり上限 | 設定なし |

### 配信時間帯

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

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

- 受信者はMerge Requestの閲覧権限を持つユーザーに限定される
- ユーザー名はsanitize_nameでサニタイズされて表示される
- Reply-Toにはpartitioned_reply_keyを使用し、返信の認証に利用

## 備考

- merge_mrメソッドは内部でclose_resource_emailを呼び出し、action: "merge"を指定している
- auto_merge_enabled（自動マージ）の場合、操作者本人にも通知が送信されるのは、自動で実行されたことを操作者に知らせるため
- クローズとは異なり、merged_merge_request_emailという専用のテンプレートが使用される

---

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

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

### 推奨読解順序

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

まず、通知の対象となるMerge Requestのマージ状態管理を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | merge_request.rb | `app/models/merge_request.rb` | MergeRequestモデルのauto_merge_enabledフラグ |

**読解のコツ**: auto_merge_enabledは「Merge When Pipeline Succeeds」等の自動マージ機能が有効かを示すフラグ。

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

処理の起点となるNotificationServiceを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | notification_service.rb | `app/services/notification_service.rb` | merge_mrメソッド（431-438行目） |

**主要処理フロー**:
1. **431-438行目**: merge_mrメソッドの定義
2. **432-437行目**: close_resource_emailを呼び出し
3. **435行目**: :merged_merge_request_emailを指定
4. **436行目**: skip_current_user判定 - auto_merge_enabled?の逆（自動マージ時は操作者にも通知）

#### Step 3: 受信者決定ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | notification_service.rb | `app/services/notification_service.rb` | close_resource_emailメソッド（832-845行目） |
| 3-2 | build_service.rb | `app/services/notification_recipients/build_service.rb` | build_recipientsメソッド |
| 3-3 | default.rb | `app/services/notification_recipients/builder/default.rb` | Defaultビルダーの実装 |

**主要処理フロー**:
- **close_resource_email 833行目**: action判定（mergeの場合は"merge"）
- **default.rb 27-58行目**: build!メソッドで参加者、Watcher、カスタム通知、購読者を収集

#### Step 4: メール送信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | merge_requests.rb | `app/mailers/emails/merge_requests.rb` | merged_merge_request_emailメソッド（134-138行目） |
| 4-2 | notify.rb | `app/mailers/notify.rb` | 基底クラスとメール送信共通処理 |

**主要処理フロー**:
- **134-138行目**: setup_merge_request_mailでMR情報をセットアップ
- **137行目**: mail_answer_threadでメール送信

#### Step 5: テンプレートを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | merged_merge_request_email.text.haml | `app/views/notify/merged_merge_request_email.text.haml` | テキストメール本文 |
| 5-2 | merged_merge_request_email.html.haml | `app/views/notify/merged_merge_request_email.html.haml` | HTMLメール本文 |

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

```
NotificationService.merge_mr(merge_request, current_user)
    │
    └─ close_resource_email(merge_request, current_user, :merged_merge_request_email,
                            skip_current_user: !merge_request.auto_merge_enabled?)
           │
           ├─ NotificationRecipients::BuildService.build_recipients
           │      ├─ action: "merge"
           │      ├─ skip_current_user: (auto_merge ? false : true)
           │      ├─ Builder::Default.new(...)
           │      │      ├─ add_participants
           │      │      ├─ add_project_watchers
           │      │      ├─ add_custom_notifications
           │      │      └─ add_subscribed_users
           │      └─ filter! (notifiable?チェック)
           │
           └─ Notify.merged_merge_request_email
                  ├─ setup_merge_request_mail
                  │      ├─ MergeRequest.find
                  │      ├─ User.find(recipient_id)
                  │      └─ SentNotification.record
                  └─ mail_answer_thread
                         └─ deliver_later
```

### データフロー図

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

MergeRequest ───────────▶ NotificationService.merge_mr
                              │
current_user ───────────▶     │
                              │
auto_merge_enabled? ────▶     │ (skip_current_user判定)
                              ▼
                         close_resource_email
                              │
                              ▼
                         BuildService.build_recipients ──▶ recipients[]
                              │
                              ▼
                         Notify.merged_merge_request_email
                              │
                              ▼
                         mail_answer_thread ─────────────▶ Email送信
                              │
                              ▼
                         SentNotification.record ────────▶ sent_notifications
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| notification_service.rb | `app/services/notification_service.rb` | ソース | 通知サービスのエントリーポイント |
| build_service.rb | `app/services/notification_recipients/build_service.rb` | ソース | 受信者決定サービス |
| default.rb | `app/services/notification_recipients/builder/default.rb` | ソース | デフォルト受信者ビルダー |
| base.rb | `app/services/notification_recipients/builder/base.rb` | ソース | ビルダー基底クラス |
| merge_requests.rb | `app/mailers/emails/merge_requests.rb` | ソース | MR関連メールメソッド定義 |
| notify.rb | `app/mailers/notify.rb` | ソース | メーラー基底クラス |
| merged_merge_request_email.text.haml | `app/views/notify/merged_merge_request_email.text.haml` | テンプレート | テキストメール本文 |
| merged_merge_request_email.html.haml | `app/views/notify/merged_merge_request_email.html.haml` | テンプレート | HTMLメール本文 |
