# 機能設計書 35-通知フィルタリング

## 概要

本ドキュメントは、Wikipedia iOSアプリにおける通知センターのフィルタリング機能について、その設計仕様を詳細に記載したものである。

### 本機能の処理概要

通知フィルタリング機能は、通知センターに表示される通知を種類別（typeFilter）およびプロジェクト別（projectFilter）に絞り込む機能である。

**業務上の目的・背景**：Wikipediaユーザーは複数のプロジェクト（言語版）で活動し、多様な種類の通知を受け取る。フィルタリング機能により、ユーザーは関心のある通知のみを表示し、効率的に情報を確認できる。

**機能の利用シーン**：
- 特定の種類の通知（例：トークページの返信のみ）を確認したい場合
- 特定のプロジェクト（例：日本語版Wikipediaのみ）の通知を確認したい場合
- 未読通知のみを表示したい場合

**主要な処理内容**：
1. 通知種類によるフィルタリング（タイプフィルター）
2. Wikipediaプロジェクトによるフィルタリング（プロジェクトフィルター/インボックス）
3. 既読/未読状態によるフィルタリング
4. フィルター状態の保存と復元
5. フィルター適用時のUI更新

**関連システム・外部連携**：RemoteNotificationsControllerを介してフィルター状態を管理。

**権限による制御**：ログイン済みユーザーのみ利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | NotificationsCenterViewController | 主画面 | フィルターボタン表示、フィルター適用結果表示 |
| - | NotificationsCenterFilterView | フィルター設定画面 | 通知種類でのフィルタリング設定 |
| - | NotificationsCenterInboxView | インボックス画面 | プロジェクト別フィルタリング設定 |

## 機能種別

データフィルタリング / UIインタラクション

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| offTypes | Set<RemoteNotificationType> | No | 非表示にする通知種類 | - |
| offProjects | Set<WikimediaProject> | No | 非表示にするプロジェクト | - |
| readStatus | RemoteNotificationsFilterState.ReadStatus | No | 既読/未読フィルター | all, read, unread |

### 入力データソース

- 画面入力：フィルター画面でのユーザー選択
- システム内部：保存されたフィルター状態

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| filterState | RemoteNotificationsFilterState | 適用されたフィルター状態 |
| filteredNotifications | [RemoteNotification] | フィルタリング後の通知配列 |

### 出力先

- 画面表示（フィルタリングされた通知一覧）
- ステータスバー（フィルター状態の表示）

## 処理フロー

### 処理シーケンス

```
1. ユーザーがフィルターボタンをタップ
   └─ userDidTapTypeFilterButton() / userDidTapProjectFilterButton()
2. フィルター画面を表示
   └─ presentFiltersViewController() / presentInboxViewController()
3. ユーザーがフィルター条件を選択
   └─ NotificationsCenterFilterView / NotificationsCenterInboxView
4. フィルター状態を更新
   └─ RemoteNotificationsController.updateFilterState()
5. フィルター変更通知を発行
   └─ RemoteNotificationsController.didUpdateFilterStateNotification
6. 通知一覧をリセットして再取得
   └─ NotificationsCenterViewModel.resetAndRefreshData()
7. フィルタリングされた結果を表示
   └─ applySnapshot()
```

### フローチャート

```mermaid
flowchart TD
    A[フィルターボタンタップ] --> B{タイプ or プロジェクト?}
    B -->|タイプ| C[フィルター画面表示]
    B -->|プロジェクト| D[インボックス画面表示]
    C --> E[フィルター条件選択]
    D --> F[プロジェクト選択]
    E --> G[フィルター状態更新]
    F --> G
    G --> H{状態変更あり?}
    H -->|Yes| I[データリセット]
    I --> J[フィルタリングして再取得]
    J --> K[UI更新]
    H -->|No| L[画面閉じる]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-35-01 | フィルター状態永続化 | フィルター状態はアプリ再起動後も維持 | 常時 |
| BR-35-02 | 複数フィルター併用 | タイプフィルターとプロジェクトフィルターは同時適用可能 | 常時 |
| BR-35-03 | フィルター適用表示 | フィルター適用時はツールバーアイコンが変化 | フィルター適用時 |
| BR-35-04 | 空状態表示 | すべてフィルターで除外された場合は空状態メッセージを表示 | 結果が0件の場合 |
| BR-35-05 | フィルター変更時リセット | フィルター変更時は最初のページから再取得 | フィルター変更時 |

### 計算ロジック

**フィルター適用判定**:
```
areFiltersApplied = offTypes.count > 0 || readStatus != .all
```

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| フィルター取得 | NSPredicate生成 | - | Core Dataクエリにフィルター条件を適用 |

### テーブル別操作詳細

フィルター状態自体はUserDefaultsまたはメモリ内で管理。Core Dataへのクエリ時にNSPredicateとして適用。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 該当なし | - | - |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

フィルター変更時の再取得は非同期で実行し、UIをブロックしない。

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

特になし

## 備考

- フィルター画面はSwiftUIで実装
- 既読/未読フィルターは3状態（すべて、既読のみ、未読のみ）
- プロジェクトフィルターはユーザーが参加しているすべてのプロジェクトを表示

---

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

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

### 推奨読解順序

#### Step 1: フィルター状態の定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | NotificationsCenterViewModel.swift | `Wikipedia/Code/NotificationsCenterViewModel.swift` | フィルター関連プロパティ |

**主要処理フロー**:
- **341-343行目**: typeFilterButtonImageでフィルター適用状態を反映
- **357-359行目**: projectFilterButtonImageでプロジェクトフィルター状態を反映
- **361-363行目**: areFiltersAppliedでフィルター適用判定

#### Step 2: ツールバーボタンの動作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterViewController.swift | `Wikipedia/Code/NotificationsCenterViewController.swift` | フィルターボタン処理 |

**主要処理フロー**:
- **33-34行目**: typeFilterButton, projectFilterButtonの定義
- **982-988行目**: userDidTapTypeFilterButton(), userDidTapProjectFilterButton()
- **497-510行目**: presentFiltersViewController()
- **512-525行目**: presentInboxViewController()

#### Step 3: フィルター画面のUI実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | NotificationsCenterFilterView.swift | `Wikipedia/Code/NotificationsCenterFilterView.swift` | SwiftUIフィルター画面 |
| 3-2 | NotificationsCenterInboxView.swift | `Wikipedia/Code/NotificationsCenterInboxView.swift` | SwiftUIインボックス画面 |

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

```
NotificationsCenterViewController
    │
    ├─ userDidTapTypeFilterButton()
    │      └─ presentFiltersViewController()
    │              └─ NotificationsCenterFilterView (SwiftUI)
    │                      └─ RemoteNotificationsController.updateFilterState()
    │
    ├─ userDidTapProjectFilterButton()
    │      └─ presentInboxViewController()
    │              └─ NotificationsCenterInboxView (SwiftUI)
    │                      └─ RemoteNotificationsController.updateFilterState()
    │
    └─ willDisappearCallback
           └─ viewModel.resetAndRefreshData()
                   └─ fetchFirstPage()
```

### データフロー図

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

フィルター選択 ───────────▶  RemoteNotificationsController      ▶ filterState
                           ┌─────────────────────────────┐
現在の状態 ────────────────▶│  filterState更新             │  ▶ NSPredicate
                           │  ・offTypes設定              │
                           │  ・offProjects設定           │  ▶ 通知再取得
                           │  ・readStatus設定            │
                           └─────────────────────────────┘  ▶ UI更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| NotificationsCenterViewController.swift | `Wikipedia/Code/NotificationsCenterViewController.swift` | ソース | フィルターボタンとモーダル表示 |
| NotificationsCenterViewModel.swift | `Wikipedia/Code/NotificationsCenterViewModel.swift` | ソース | フィルター状態のプロパティ計算 |
| NotificationsCenterFilterView.swift | `Wikipedia/Code/NotificationsCenterFilterView.swift` | ソース | タイプフィルター画面（SwiftUI） |
| NotificationsCenterFiltersViewModel.swift | `Wikipedia/Code/NotificationsCenterFiltersViewModel.swift` | ソース | フィルター画面のビューモデル |
| NotificationsCenterInboxView.swift | `Wikipedia/Code/NotificationsCenterInboxView.swift` | ソース | インボックス画面（SwiftUI） |
| NotificationsCenterInboxViewModel.swift | `Wikipedia/Code/NotificationsCenterInboxViewModel.swift` | ソース | インボックス画面のビューモデル |
| RemoteNotificationsFilterState.swift | `WMF Framework/Remote Notifications/RemoteNotificationsFilterState.swift` | ソース | フィルター状態モデル |
